diff --git a/reference/apcu/apcuiterator.xml b/reference/apcu/apcuiterator.xml deleted file mode 100644 index 45f08a86af..0000000000 --- a/reference/apcu/apcuiterator.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - La classe APCUIterator - APCUIterator - - - - -
- &reftitle.intro; - - La classe APCUIterator facilite le parcours des - caches APCu de grandes tailles. Cela est utile car elle permet de les parcourir - par étapes, tout en récupérant un nombre défini d'entrées par instance de - verrouillage. Ainsi, cela libère les verrous de cache pour d'autres activités - au lieu de bloquer tout le cache pour récupérer 100 entrées (par défaut). - D'autre part, le filtrage par expressions régulières est plus efficace - car leur manipulation a été déplacée au niveau du C. - -
- - -
- &reftitle.classsynopsis; - - - - APCUIterator - - - - - APCUIterator - - - - Iterator - - - - - - &Methods; - - - - - - - - - - -
- - - - &reference.apcu.entities.apcuiterator; - - - diff --git a/reference/apcu/apcuiterator/construct.xml b/reference/apcu/apcuiterator/construct.xml deleted file mode 100644 index 9326bf4553..0000000000 --- a/reference/apcu/apcuiterator/construct.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - APCUIterator::__construct - Construit un objet itérateur de la classe APCUIterator - - - - &reftitle.description; - - public APCUIterator::__construct - arraystringnullsearch&null; - intformatAPC_ITER_ALL - intchunk_size100 - intlistAPC_LIST_ACTIVE - - - Construit un object de la classe APCUIterator. - - - - - &reftitle.parameters; - - - search - - - Soit une expression régulière PCRE qui - filtre le nom des clés APCu, donnée sous la forme d'une &string;. - Soit un &array; de &string; contenant des noms de clés APCu. - Ou, bien éventuellement, la valeur &null;, pour sauter l'étape de recherche. - - - - - format - - - Le format souhaité, configuré avec une ou plusieurs des constantes prédéfinies - APC_ITER_*. - - - - - chunk_size - - - La taille d'un tronçon. La valeur de ce paramètre doit être plus grande que 0. - La valeur par défaut est 100. - - - - - list - - - Le type de liste. Le paramètre peut prendre soit la valeur APC_LIST_ACTIVE - soit la valeur APC_LIST_DELETED. - - - - - - - - &reftitle.examples; - - Un exemple avec <function>APCUIterator::__construct</function> - - -]]> - - - - - - &reftitle.seealso; - - apcu_exists - apcu_cache_info - - - - - diff --git a/reference/apcu/apcuiterator/current.xml b/reference/apcu/apcuiterator/current.xml deleted file mode 100644 index 5f977f83d9..0000000000 --- a/reference/apcu/apcuiterator/current.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - APCUIterator::current - Retourne l'élément courant - - - - &reftitle.description; - - public mixedAPCUIterator::current - - - - Retourne l'élément courant de la liste de APCUIterator. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'élément courant en cas de succès ou bien la valeur &false; s'il n'y - a plus d'éléments, ou en cas d'échec. - - - - - &reftitle.seealso; - - APCUIterator::next - Iterator::current - - - - - diff --git a/reference/apcu/apcuiterator/gettotalcount.xml b/reference/apcu/apcuiterator/gettotalcount.xml deleted file mode 100644 index cad43557b5..0000000000 --- a/reference/apcu/apcuiterator/gettotalcount.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - APCUIterator::getTotalCount - Retourne le compte total - - - - &reftitle.description; - - public intAPCUIterator::getTotalCount - - - - Retourne le compte total. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le compte total. - - - - - &reftitle.seealso; - - APCUIterator::getTotalHits - APCUIterator::getTotalSize - apcu_cache_info - - - - - diff --git a/reference/apcu/apcuiterator/gettotalhits.xml b/reference/apcu/apcuiterator/gettotalhits.xml deleted file mode 100644 index 1284891fc1..0000000000 --- a/reference/apcu/apcuiterator/gettotalhits.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - APCUIterator::getTotalHits - Retourne le nombre total d'accès au cache - - - - &reftitle.description; - - public intAPCUIterator::getTotalHits - - - - Retourne le nombre total d'accès au cache. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le nombre total d'accès au cache en cas de succès - ou &false; en cas d'échec. - - - - - &reftitle.seealso; - - APCUIterator::getTotalCount - APCUIterator::getTotalSize - apcu_cache_info - - - - - diff --git a/reference/apcu/apcuiterator/gettotalsize.xml b/reference/apcu/apcuiterator/gettotalsize.xml deleted file mode 100644 index d1b812603e..0000000000 --- a/reference/apcu/apcuiterator/gettotalsize.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - APCUIterator::getTotalSize - Retourne la taille totale du cache - - - - &reftitle.description; - - public intAPCUIterator::getTotalSize - - - - Retourne la taille totale du cache. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La taille totale du cache. - - - - - &reftitle.seealso; - - APCUIterator::getTotalCount - APCUIterator::getTotalHits - apc_cache_info - - - - - diff --git a/reference/apcu/apcuiterator/key.xml b/reference/apcu/apcuiterator/key.xml deleted file mode 100644 index 2b9c89f378..0000000000 --- a/reference/apcu/apcuiterator/key.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - APCUIterator::key - Retourne la clé de l'élément courant - - - - &reftitle.description; - - public stringAPCUIterator::key - - - - Retourne la clé de l'élément courant. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la clé en cas de succès ou &false; en cas d'échec. - - - - - &reftitle.seealso; - - APCUIterator::current - Iterator::key - - - - - diff --git a/reference/apcu/apcuiterator/next.xml b/reference/apcu/apcuiterator/next.xml deleted file mode 100644 index 7375193874..0000000000 --- a/reference/apcu/apcuiterator/next.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - APCUIterator::next - Déplace le pointeur sur l'élément suivant - - - - &reftitle.description; - - public boolAPCUIterator::next - - - - Déplace le pointeur de l'itérateur sur l'élément suivant. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - APCUIterator::current - APCUIterator::rewind - Iterator::next - - - - - diff --git a/reference/apcu/apcuiterator/rewind.xml b/reference/apcu/apcuiterator/rewind.xml deleted file mode 100644 index e51ad697fb..0000000000 --- a/reference/apcu/apcuiterator/rewind.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - APCUIterator::rewind - Repositionne l'itérateur sur le premier élément - - - - &reftitle.description; - - public voidAPCUIterator::rewind - - - - Repositionne l'itérateur sur le premier élément. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - APCUIterator::next - Iterator::next - - - - - diff --git a/reference/apcu/apcuiterator/valid.xml b/reference/apcu/apcuiterator/valid.xml deleted file mode 100644 index b2abbf55fc..0000000000 --- a/reference/apcu/apcuiterator/valid.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - APCUIterator::valid - Vérifie si la position courante est valide - - - - &reftitle.description; - - public boolAPCUIterator::valid - - - - Vérifie si la position courante de l'itérateur est valide. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la valeur &true; si la position courante de l'itérateur est valide, sinon - retourne &false;. - - - - - &reftitle.seealso; - - APCUIterator::current - Iterator::valid - - - - - diff --git a/reference/apcu/book.xml b/reference/apcu/book.xml deleted file mode 100644 index 07c2e23261..0000000000 --- a/reference/apcu/book.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - APC User Cache - APCu - - - &reftitle.intro; - - APCu est un tableau associatif stocké en mémoire pour PHP. - Les clés sont de type &string; et les valeurs sont des variables PHP de tout type. - APCu ne gère que la mise en cache de variables de l'espace utilisateur. - - - Le cache APCu est par processus sous Windows, donc lors de l'utilisation d'un SAPI - basé sur les processus (plutôt que sur les threads), il ne sera pas partagé entre - différents processus. - - - APCu, c'est APC sans la mise en cache du code opération. - - - La première version est 4.0.0, ce fut un embranchement logiciel de la - tête de la branche maître d'APC de l'époque. - La prise en charge de PHP 7 est disponible à partir d'APCu 5.0.0. - La prise en charge de PHP 8 est disponible à partir d'APCu 5.1.19. - - - - &reference.apcu.setup; - &reference.apcu.constants; - &reference.apcu.reference; - &reference.apcu.apcuiterator; - - - diff --git a/reference/apcu/constants.xml b/reference/apcu/constants.xml deleted file mode 100644 index de4dc6887b..0000000000 --- a/reference/apcu/constants.xml +++ /dev/null @@ -1,238 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - APC_ITER_ALL - (int) - - - - - - - - - - APC_ITER_ATIME - (int) - - - - - - - - - - APC_ITER_CTIME - (int) - - - - - - - - - - APC_ITER_DEVICE - (int) - - - - - - - - - - APC_ITER_DTIME - (int) - - - - - - - - - - APC_ITER_FILENAME - (int) - - - - - - - - - - APC_ITER_INODE - (int) - - - - - - - - - - APC_ITER_KEY - (int) - - - - - - - - - - APC_ITER_MD5 - (int) - - - - - - - - - - APC_ITER_MEM_SIZE - (int) - - - - - - - - - - APC_ITER_MTIME - (int) - - - - - - - - - - APC_ITER_NONE - (int) - - - - - - - - - - APC_ITER_NUM_HITS - (int) - - - - - - - - - - APC_ITER_REFCOUNT - (int) - - - - - - - - - - APC_ITER_TTL - (int) - - - - - - - - - - APC_ITER_TYPE - (int) - - - - - - - - - - APC_ITER_VALUE - (int) - - - - - - - - - - APC_LIST_ACTIVE - (int) - - - - - - - - - - APC_LIST_DELETED - (int) - - - - - - - - - diff --git a/reference/apcu/functions/apcu-add.xml b/reference/apcu/functions/apcu-add.xml deleted file mode 100644 index a8b2c36371..0000000000 --- a/reference/apcu/functions/apcu-add.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - apcu_add - - Met en cache une nouvelle variable dans le dépôt de données - - - - &reftitle.description; - - boolapcu_add - stringkey - mixedvar - intttl0 - - - arrayapcu_add - arrayvalues - mixedunusedNULL - intttl0 - - - Met en cache une variable dans le dépôt de données, seulement si elle n'a pas été déjà stockée. - - - - Contrairement à de nombreux autres mécanismes dans PHP, les variables stockées - utilisant apcu_add persisteront entre les requêtes (jusqu'à ce - que leurs valeurs soient retirées du cache). - - - - - &reftitle.parameters; - - - key - - - Stocke la variable en utilisant ce nom de clé. Chaque clé est unique dans le cache, - essayer d'utiliser apcu_add pour stocker une donnée avec une - valeur du paramètre key déjà existante n'écrasera pas la - donnée existante mais retournera &false;. (C'est l'unique différence entre - les fonctions apcu_add et apcu_store.) - - - - - var - - - La variable à stocker. - - - - - ttl - - - Durée de vie; stocke la variable var dans le cache pour - une durée de ttl secondes. Après l'expiration de - ttl, la variable stockée sera retirée du cache (à la - prochaine requête). Si aucune valeur n'est passée à - ttl (ou si la valeur de ttl est - 0), la variable persistera jusqu'à ce qu'elle soit retirée - manuellement du cache, ou, sinon, cesse d'exister dans le cache (vidage, - redémarrage, etc.). - - - - - values - - - Les noms sont fournis par les clés du tableau values, - les variables par les valeurs. - - - - - - - &reftitle.returnvalues; - - Retourne &true; si une variable a effectivement été ajoutée au cache, &false; sinon. - La seconde syntaxe retourne un tableau avec les clés erronées. - - - - - &reftitle.examples; - - Un exemple avec <function>apcu_add</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - apcu_store - apcu_fetch - apcu_delete - - - - - diff --git a/reference/apcu/functions/apcu-cache-info.xml b/reference/apcu/functions/apcu-cache-info.xml deleted file mode 100644 index 59ac86a94c..0000000000 --- a/reference/apcu/functions/apcu-cache-info.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - apcu_cache_info - - Récupère les informations mises en cache dans le dépôt de données d'APCu - - - - &reftitle.description; - - arrayfalseapcu_cache_info - boollimited&false; - - - Récupère les informations et les méta-données mises en cache dans le dépôt de données d'APCu. - - - - - &reftitle.parameters; - - - limited - - - Si la valeur de limited est &true;, la valeur retournée - exclura la liste individuelle des entrées du cache. Cela est utile lorsqu'une - optimisation des appels à des fins statistiques est tentée. - - - - - - - - &reftitle.returnvalues; - - Tableau des données (et méta-données) mises en cache, &return.falseforfailure; - - - - apcu_cache_info émettra un avertissement s'il est - incapable de retrouver les données du cache APCu. Cela se produit - typiquement lorsqu'APCu n'est pas activé. - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL apcu 3.0.11 - - Le paramètre limited a été introduit. - - - - PECL apcu 3.0.16 - - L'option "filehits" pour le paramètre - cache_type a été introduite. - - - - - - - - - &reftitle.examples; - - Un exemple avec <function>apcu_cache_info</function> - - -]]> - - &example.outputs.similar; - - 2000 - [ttl] => 0 - [num_hits] => 9 - [num_misses] => 3 - [start_time] => 1123958803 - [cache_list] => Array - ( - [0] => Array - ( - [filename] => /path/to/apcu_test.php - [device] => 29954 - [inode] => 1130511 - [type] => file - [num_hits] => 1 - [mtime] => 1123960686 - [creation_time] => 1123960696 - [deletion_time] => 0 - [access_time] => 1123962864 - [ref_count] => 1 - [mem_size] => 677 - ) - [1] => Array (...itère pour chaque fichier mis en cache) -) -]]> - - - - - - &reftitle.seealso; - - Directives de configuration d'APCu - APCUIterator::getTotalSize - APCUIterator::getTotalHits - APCUIterator::getTotalCount - - - - - diff --git a/reference/apcu/functions/apcu-cas.xml b/reference/apcu/functions/apcu-cas.xml deleted file mode 100644 index 300c2de83c..0000000000 --- a/reference/apcu/functions/apcu-cas.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - apcu_cas - Met à jour une ancienne valeur avec une nouvelle - - - - &reftitle.description; - - boolapcu_cas - stringkey - intold - intnew - - - apcu_cas remplace une valeur entière déjà existante, si la - valeur du paramètre old correspond à celle actuellement - stockée, par la valeur du paramètre new. - - - - - &reftitle.parameters; - - - key - - - La clé de la valeur à remplacer. - - - - - old - - - L'ancienne valeur (la valeur actuellement stockée). - - - - - new - - - La nouvelle valeur. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Un exemple avec <function>apcu_cas</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - apcu_dec - apcu_store - - - - - diff --git a/reference/apcu/functions/apcu-clear-cache.xml b/reference/apcu/functions/apcu-clear-cache.xml deleted file mode 100644 index 688801f758..0000000000 --- a/reference/apcu/functions/apcu-clear-cache.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - apcu_clear_cache - - Efface le cache APCu - - - - &reftitle.description; - - boolapcu_clear_cache - - - - Efface le cache. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne toujours la valeur &true;. - - - - - &reftitle.seealso; - - apcu_cache_info - - - - - diff --git a/reference/apcu/functions/apcu-dec.xml b/reference/apcu/functions/apcu-dec.xml deleted file mode 100644 index 85ad14ac60..0000000000 --- a/reference/apcu/functions/apcu-dec.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - apcu_dec - Décrémente un nombre stocké - - - - &reftitle.description; - - intfalseapcu_dec - stringkey - intstep1 - boolsuccess - intttl0 - - - Décrémente une valeur entière stockée. - - - - - &reftitle.parameters; - - - key - - - La clé de la valeur qui doit être décrémentée. - - - - - step - - - Le pas de décrémentation ou la valeur à soustraire. - - - - - success - - - Optionnel, passe la valeur booléenne succès ou échec à la variable - référencée. - - - - - ttl - - - Durée de vie à utiliser si la fonction insère une nouvelle variable (au lieu de décrémenter - une variable existante). - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur courante associée à la clé key en cas de succès, - &return.falseforfailure; - - - - - &reftitle.examples; - - Un exemple avec <function>apcu_dec</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - apcu_inc - - - - - diff --git a/reference/apcu/functions/apcu-delete.xml b/reference/apcu/functions/apcu-delete.xml deleted file mode 100644 index c6bd3585bc..0000000000 --- a/reference/apcu/functions/apcu-delete.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - apcu_delete - - Retire une variable stockée du cache - - - - &reftitle.description; - - mixedapcu_delete - mixedkey - - - Retire une variable stockée du cache. - - - - &reftitle.parameters; - - - key - - - Le paramètre key peut être soit une - string pour une seule clé, - soit un array de chaînes de caractères pour plusieurs clés, - soit un object de la classe APCUIterator. - - - - - - - &reftitle.returnvalues; - - Si le paramètre key est un &array;, alors la valeur - retournée est le &array; indexé des clés. - Sinon la valeur &true; est retournée en cas de succès, ou &false; en cas d'échec. - - - - - &reftitle.examples; - - Un exemple avec <function>apcu_delete</function> - - -]]> - - - - - - &reftitle.seealso; - - apcu_store - apcu_fetch - apcu_clear_cache - APCUIterator - - - - - diff --git a/reference/apcu/functions/apcu-enabled.xml b/reference/apcu/functions/apcu-enabled.xml deleted file mode 100644 index bdd4f7e2ec..0000000000 --- a/reference/apcu/functions/apcu-enabled.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - apcu_enabled - Vérifie si APCu est utilisable dans l'environnement courant - - - - &reftitle.description; - - boolapcu_enabled - - - - Vérifie si APCu est utilisable dans l'environnement courant. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la valeur &true; si APCu est utilisable dans l'environnement courant, ou &false; sinon. - - - - - diff --git a/reference/apcu/functions/apcu-entry.xml b/reference/apcu/functions/apcu-entry.xml deleted file mode 100644 index 840a40d2cb..0000000000 --- a/reference/apcu/functions/apcu-entry.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - apcu_entry - - Récupère atomiquement ou génère une entrée de cache - - - - &reftitle.description; - - mixedapcu_entry - stringkey - callablecallback - intttl0 - - - Tente de récupérer atomiquement la valeur indexée par la clé key - dans le cache. Si elle ne peut pas être récupérée, la fonction passée à - callback est appelée, avec pour unique argument - key. La valeur de retour de l'appel est - ensuite mise en cache avec le paramètre optionnel ttl, - puis le résultat est retourné. - - - - Lorsque le contrôle entre dans apcu_entry le verrou du cache est - acquis de façon exclusive. Il est libéré lorsque le contrôle quitte - apcu_entry : plus précisément, le corps de la fonction passée à - callback devient une section critique, ce qui interdit à - deux processus d'exécuter la même partie du code concurrentiellement. En outre, il - interdit l'exécution concurrentielle de toute autre fonction APCu, puisqu'elle acquerra - le même verrou. - - - - - La seule fonction APCu qui peut être appelée en toute sécurité par callback - est apcu_entry. - - - - - &reftitle.parameters; - - - key - - - Clé d'une entrée de cache. - - - - - callback - - - Un paramètre de type callable qui prend key pour unique argument - et retourne la valeur à mettre en cache. - - - - - ttl - - - Durée de vie; stocke le retour de callback en cache pour - une durée de ttl secondes. Après l'expiration de - ttl, l'entrée stockée sera retirée du cache (à la - prochaine requête). Si aucune valeur n'est passée au paramètre - ttl (ou si la valeur de ttl est - 0), la variable persistera jusqu'à ce qu'elle soit retirée - manuellement du cache, ou, sinon, cesse d'exister dans le cache (vidage, - redémarrage, etc.). - - - - - - - &reftitle.returnvalues; - - Retourne la valeur mise en cache. - - - - - &reftitle.examples; - - Un exemple avec <function>apcu_entry</function> - - apcu_entry("config.fruit", function($key){ - return [ - "apples", - "pears" - ]; - }), - "people" => apcu_entry("config.people", function($key){ - return [ - "bob", - "joe", - "niki" - ]; - }) - ]; -}); - -var_dump($config); -?> -]]> - - &example.outputs; - - - array(2) { - [0]=> - string(6) "apples" - [1]=> - string(5) "pears" - } - ["people"]=> - array(3) { - [0]=> - string(3) "bob" - [1]=> - string(3) "joe" - [2]=> - string(4) "niki" - } -} -]]> - - - - - - &reftitle.seealso; - - apcu_store - apcu_fetch - apcu_delete - - - - - diff --git a/reference/apcu/functions/apcu-exists.xml b/reference/apcu/functions/apcu-exists.xml deleted file mode 100644 index 8320f3af62..0000000000 --- a/reference/apcu/functions/apcu-exists.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - apcu_exists - Vérifie si une entrée existe - - - - &reftitle.description; - - boolarrayapcu_exists - stringarraykeys - - - Vérifie si une ou plusieurs entrées APCu existent. - - - - - &reftitle.parameters; - - - keys - - - Une string ou un array de - chaînes de caractères qui contient les clés. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur &true; si la clé existe, ou &false; sinon. - Ou bien, si un array a été passé à keys, - alors la valeur retournée est un tableau contenant toutes les clés - existantes, ou un tableau vide si aucune n'existe. - - - - - &reftitle.examples; - - Un exemple avec <function>apcu_exists</function> - - -]]> - - &example.outputs.similar; - - - bool(true) - ["bar"]=> - bool(true) -} -]]> - - - - - - &reftitle.seealso; - - apcu_cache_info - apcu_fetch - - - - diff --git a/reference/apcu/functions/apcu-fetch.xml b/reference/apcu/functions/apcu-fetch.xml deleted file mode 100644 index 3b2d7c2978..0000000000 --- a/reference/apcu/functions/apcu-fetch.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - apcu_fetch - - Récupère une variable stockée dans le cache - - - - &reftitle.description; - - mixedapcu_fetch - mixedkey - boolsuccess - - - Récupère une entrée du cache. - - - - &reftitle.parameters; - - - key - - - La clé key utilisée pour stocker la valeur - (avec apcu_store). Si un tableau est passé - alors chaque élément est récupéré et retourné. - - - - - success - - - Défini par la valeur &true; en cas de succès et &false; en cas d'échec. - - - - - - - &reftitle.returnvalues; - - La variable ou le tableau de variables stocké en cas de succès; - &false; en cas d'échec. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL apcu 3.0.17 - - Le paramètre success a été ajouté. - - - - - - - - - &reftitle.examples; - - Un exemple avec <function>apcu_fetch</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - apcu_store - apcu_delete - APCUIterator - - - - - diff --git a/reference/apcu/functions/apcu-inc.xml b/reference/apcu/functions/apcu-inc.xml deleted file mode 100644 index bbd6e2d621..0000000000 --- a/reference/apcu/functions/apcu-inc.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - apcu_inc - Incrémente un nombre stocké - - - - &reftitle.description; - - intfalseapcu_inc - stringkey - intstep1 - boolsuccess - intttl0 - - - Incrémente un nombre stocké. - - - - - &reftitle.parameters; - - - key - - - La clé de la valeur qui doit être incrémentée. - - - - - step - - - Le pas d'incrémentation ou la valeur à ajouter. - - - - - success - - - Optionnel, passe la valeur booléenne succès ou échec à la variable - référencée. - - - - - ttl - - - Durée de vie à utiliser si la fonction insère une nouvelle variable (au lieu d'incrémenter - une variable existante). - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur courante associée à la clé key en cas de succès, - &return.falseforfailure; - - - - - &reftitle.examples; - - Un exemple avec <function>apcu_inc</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - apcu_dec - - - - - diff --git a/reference/apcu/functions/apcu-key-info.xml b/reference/apcu/functions/apcu-key-info.xml deleted file mode 100644 index fee452c167..0000000000 --- a/reference/apcu/functions/apcu-key-info.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - apcu_key_info - - Retourne des informations détaillées sur la clé de cache - - - - - &reftitle.description; - - arraynullapcu_key_info - stringkey - - - Retourne des informations détaillées sur la clé de cache. - - - - - &reftitle.parameters; - - - key - - - Nom de la clé. - - - - - - - - &reftitle.returnvalues; - - Un tableau contenant des informations détaillées sur la clé de cache, - ou la valeur &null; si la clé n'existe pas. - - - - - &reftitle.examples; - - Un exemple avec <function>apcu_key_info</function> - - -]]> - - &example.outputs; - - - int(0) - ["access_time"]=> - int(1606701783) - ["mtime"]=> - int(1606701783) - ["creation_time"]=> - int(1606701783) - ["deletion_time"]=> - int(0) - ["ttl"]=> - int(0) - ["refs"]=> - int(0) -} -]]> - - - - - - &reftitle.seealso; - - apcu_store - apcu_fetch - apcu_delete - - - - - diff --git a/reference/apcu/functions/apcu-sma-info.xml b/reference/apcu/functions/apcu-sma-info.xml deleted file mode 100644 index 90b7288483..0000000000 --- a/reference/apcu/functions/apcu-sma-info.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - apcu_sma_info - - Retourne des informations sur l'allocation de mémoire partagée d'APCu - - - - &reftitle.description; - - arrayfalseapcu_sma_info - boollimited&false; - - - Retourne des informations sur l'allocation de mémoire partagée d'APCu. - - - - - &reftitle.parameters; - - - limited - - - Lorsque la valeur &false; est passée (par défaut) à ce paramètre, la - fonction apcu_sma_info retourne des informations - détaillées sur chaque segment. - - - - - - - - &reftitle.returnvalues; - - Un tableau de données sur l'allocation de mémoire partagée ; - &false; en cas d'échec. - - - - - &reftitle.examples; - - Un exemple avec <function>apcu_sma_info</function> - - -]]> - - &example.outputs.similar; - - 1 - [seg_size] => 31457280 - [avail_mem] => 31448408 - [block_lists] => Array - ( - [0] => Array - ( - [0] => Array - ( - [size] => 31448408 - [offset] => 8864 - ) - - ) - - ) - -) -]]> - - - - - - &reftitle.seealso; - - - Directives de configuration d'APCu - - - - - - diff --git a/reference/apcu/functions/apcu-store.xml b/reference/apcu/functions/apcu-store.xml deleted file mode 100644 index 8041b740c4..0000000000 --- a/reference/apcu/functions/apcu-store.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - apcu_store - - Met en cache une variable dans le dépôt de données - - - - &reftitle.description; - - boolapcu_store - stringkey - mixedvar - intttl0 - - - arrayapcu_store - arrayvalues - mixedunusedNULL - intttl0 - - - Met en cache une variable dans le dépôt de données. - - - - Contrairement à de nombreux autres mécanismes dans PHP, les variables stockées - utilisant apcu_store persisteront entre les requêtes (jusqu'à ce - que leurs valeurs soient retirées du cache). - - - - - &reftitle.parameters; - - - key - - - Stocke la variable en utilisant ce nom de clé. Chaque clé est unique dans le cache, - stocker une seconde valeur avec le même paramètre key - écrasera la valeur originale. - - - - - var - - - La variable à stocker. - - - - - ttl - - - Durée de vie; stocke la variable var dans le cache pour - une durée de ttl secondes. Après l'expiration de - ttl, la variable stockée sera retirée du cache (à la - prochaine requête). Si aucune valeur n'est passée au paramètre - ttl (ou si la valeur de ttl est - 0), la variable persistera jusqu'à ce qu'elle soit retirée - manuellement du cache, ou, sinon, elle échouera à sortir du cache (lors d'un - effacement, redémarrage, etc.). - - - - - values - - - Les noms sont fournis par les clés du tableau values, - les variables par les valeurs. - - - - - - - &reftitle.returnvalues; - - &return.success; - La seconde syntaxe retourne un tableau avec les clés erronées. - - - - - &reftitle.examples; - - Un exemple avec <function>apcu_store</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - apcu_add - apcu_fetch - apcu_delete - - - - - diff --git a/reference/apcu/ini.xml b/reference/apcu/ini.xml deleted file mode 100644 index dabdaa0204..0000000000 --- a/reference/apcu/ini.xml +++ /dev/null @@ -1,388 +0,0 @@ - - - -
- &reftitle.runtime; - &extension.runtime; - - Bien que les réglages par défaut d'APCu fonctionnent correctement sur de nombreuses - installations, il est utile de penser à ajuster ces paramètres de configuration. - - - Une question importante pour la configuration d'APCu est - quelle est la taille adéquate qui doit être allouée dans la mémoire à APCu. - La directive ini qui contrôle ce paramètre est apc.shm_size. - Le paragraphe ci-dessous est important pour répondre à cette question. - - - Une fois le serveur lancé, le script apc.php, disponible avec - l'extension, peut être copié dans le répertoire racine du serveur web et exécuté par le - navigateur. Ce script fournit une analyse détaillée du fonctionnement interne - d'APCu. Si la bibliothèque GD est activée dans PHP alors le script peut afficher - des graphiques pertinents. - - - Si APCu fonctionne, le nombre de Cache full count (à gauche) - affichera le nombre de fois où le cache a atteint sa capacité maximale et a dû - évacuer des entrées pour libérer de la mémoire. Pendant l'évacuation, si - apc.ttl a été spécifié, APCu essaiera d'abord de supprimer les - entrées expirées, c'est-à-dire les entrées dont le TTL a expiré ou les entrées - qui n'ont pas de TTL défini et qui n'ont pas été consultées au cours des dernières - apc.ttl secondes. Si apc.ttl n'a pas été - défini ou si la suppression des entrées expirées n'a pas libéré suffisamment - d'espace, APCu effacera l'intégralité du cache. - - - Le nombre d'évictions devrait être minimal dans un cache bien configuré. Si le - cache est constamment rempli et donc libéré de force, le brassage résultant aura - des effets préjudiciables sur les performances du script. Le moyen le plus simple - de réduire ce nombre est d'allouer plus de mémoire à APCu. - - - Lorsque APCu est compilé avec mmap (Memory Mapping), il n'utilisera qu'un seul - segment de mémoire, contrairement au cas où APCu est construit avec - SHM (SysV Shared Memory) qui utilise plusieurs segments de mémoire. MMAP n'a - pas de limite maximale comme SHM dans /proc/sys/kernel/shmmax. - En général, l'utilisation de MMAP est recommandée car il réclame la mémoire - plus vite lorsque le serveur web est redémarré et réduit l'impact sur - l'allocation de mémoire au démarrage. - - - - Options de configuration d'APCu - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - apc.enabled - 1 - INI_SYSTEM - - - - apc.shm_segments - 1 - INI_SYSTEM - - - - apc.shm_size - "32M" - INI_SYSTEM - - - - apc.entries_hint - 512 * apc.shm_size - INI_SYSTEM - Antérieurement à APCu 5.1.25, la valeur par défaut était 4096 - - - apc.ttl - 0 - INI_SYSTEM - - - - apc.gc_ttl - 3600 - INI_SYSTEM - - - - apc.mmap_file_mask - NULL - INI_SYSTEM - - - - apc.slam_defense - 0 - INI_SYSTEM - - - - apc.enable_cli - 0 - INI_SYSTEM - - - - apc.use_request_time - 0 - INI_ALL - Antérieurement à APCu 5.1.19, la valeur par défaut était 1. - - - apc.serializer - "php" - INI_SYSTEM - Antérieurement à APCu 5.1.15, la valeur par défaut était "default". - - - apc.coredump_unmap - 0 - INI_SYSTEM - - - - apc.preload_path - NULL - INI_SYSTEM - - - - -
- &ini.php.constants; - - - &ini.descriptions.title; - - - - - apc.enabled - bool - - - - apc.enabled peut être mis à 0 pour désactiver APC. - Cela peut s'avérer utile lorsqu'APC est compilé statiquement dans PHP - puisqu'il n'y a pas d'autre moyen de le désactiver (lorsque APC est - compilé en tant que DSO, la ligne extension - dans le fichier php.ini peut simplement être mise en - commentaire). - - - - - - apc.shm_segments - int - - - - Le nombre de segments de mémoire partagée à allouer au cache de compilation. - Si APC manque de mémoire partagée mais que apc.shm_size - est mis à la valeur maximale autorisée par le système, alors augmenter - cette valeur peut empêcher APC d'épuiser sa mémoire. - - - - - - apc.shm_size - string - - - - La taille de chaque segment de mémoire partagée donnée en notation abrégée - comme indiqué dans cette FAQ. - Par défaut, certains systèmes (dont la plupart des variantes de BSD) - ont une limite très basse pour la taille d'un segment de mémoire partagée. - - - - - - apc.entries_hint - int - - - - Un "indice" sur le nombre de variables distinctes qui peuvent être stockées. - Mettre à zéro ou, dans le doute, omettre. - - - - - - apc.ttl - int - - - - Considérer que les entrées de cache sans TTL explicite sont expirées si elles - n'ont pas été consultées depuis autant de secondes. En effet, cela permet à ces - entrées d'être opportunément supprimées lors d'une insertion dans le cache, - ou avant une suppression complète. Il est à noter que parce que la suppression est - opportuniste, les entrées peuvent toujours être lisibles même si elles sont - plus anciennes que apc.ttl secondes. Ce paramètre n'a aucun - effet sur les entrées de cache pour lesquelles un TTL explicite est spécifié. - - - - - - apc.gc_ttl - int - - - - Le nombre de secondes pendant lesquelles une entrée de cache peut - rester sur la liste de collecte des ordures après avoir été retirée ou invalidée. - Les entrées sont éligibles à la suppression si leur nombre de références est zéro, ou si elles dépassent cette limite de temps. - Si défini à 0, le nettoyage basé sur le temps est désactivé, - et les entrées ne sont supprimées que lorsque leur nombre de références tombe à zéro. - - - - - - apc.mmap_file_mask - string - - - - Si APCu a été compilé avec l'option MMAP en utilisant - --enable-mmap, ce paramètre reçoit le masque de - fichier de type mktemp à passer au module mmap pour déterminer - si la région de la mémoire utilisant mmap sera sauvegardée par le biais - d'un fichier ou par celui de la mémoire partagée. - Dans le cas où la sauvegarde se fait par le biais d'un fichier, - le masque sera de la forme /tmp/apc.XXXXXX - (avec exactement 6 X). - Pour utiliser shm_open/mmap de la norme POSIX, le masque doit contenir - .shm, comme dans l'exemple suivant : - /apc.shm.XXXXXX. Ce paramètre peut être défini par - /dev/zero pour utiliser l'interface - /dev/zero du noyau avec une mémoire utilisant mmap - anonymement. Laisser ce paramètre indéfini forcera un mmap anonyme. - - - - - - apc.slam_defense - bool - - - - Au démarrage ou lors de la modification d'un fichier dans un serveur - très occupé, plusieurs processus peuvent entrer en compétition - pour mettre en cache un même fichier en même temps. - Configurer apc.slam_defense sur 1 - peut aider à empêcher plusieurs processus de mettre en cache - le même fichier simultanément en introduisant un mécanisme - de probabilité. Si la même clé est tentée d'être mise en cache - dans un court laps de temps par différents processus, elle saute - la mise en cache pour le processus actuel pour atténuer les éventuels - problèmes de mise en cache. - - - - - - apc.enable_cli - int - - - - Principalement utilisé pour les tests et le débogage. Définir ce - paramètre permet d'activer APC dans la version CLI de PHP. - En temps normal, il n'est pas idéal de créer, alimenter et - détruire le cache APC à chaque requête CLI. Cependant, dans de - nombreux scénarios de test il est utile de pouvoir activer - facilement APC dans la version CLI de PHP. - - - - - - apc.serializer - string - - - - Ce paramètre permet à APC d'utiliser un sérialiseur tiers. - - - - - - apc.coredump_unmap - bool - - - - Active la gestion par APC de signaux, tels que SIGSEGV, qui provoquent - l'écriture de fichiers core dump lorsqu'ils sont reçus. Quand ces - signaux sont reçus, APC essaiera de désallouer le segment de mémoire - partagée réservé à mmap dans le but de l'exclure du fichier core - dump. Cette option peut améliorer la stabilité du système lorsque - des signaux fatals sont reçus et qu'APC est configuré avec un long - segment de mémoire partagée. - - - - Cette option est potentiellement dangereuse. Désallouer un segment de - mémoire partagée utilisé par mmap dans le gestionnaire de signaux - fatals peut causer un comportement imprévisible si une erreur fatale - survient. - - - - - Bien que certains noyaux puissent fournir la possibilité d'ignorer - de nombreux types de mémoire partagée lorsqu'ils génèrent un fichier - core dump, ces implémentations peuvent aussi ignorer d'importants - segments de mémoire partagée tels que le tableau de bord d'Apache. - - - - - - - apc.preload_path - string - - - - Optionnel, définit un chemin vers le répertoire où APC chargera - les données du cache au démarrage. - - - - - - - apc.use_request_time - bool - - - - Utilise l'heure de début de la requête SAPI - pour la durée de vie (TTL). - - - - -
- diff --git a/reference/apcu/reference.xml b/reference/apcu/reference.xml deleted file mode 100644 index 80641bc407..0000000000 --- a/reference/apcu/reference.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - APCu &Functions; - - &reference.apcu.entities.functions; - - - - - diff --git a/reference/apcu/setup.xml b/reference/apcu/setup.xml deleted file mode 100644 index da914d1c3b..0000000000 --- a/reference/apcu/setup.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;apcu. - - - - PHP 7 a un module séparé (apcu-bc) pour des raisons de - rétrocompatibilité avec APC. - - - En mode rétrocompatibilité, APCu enregistre les fonctions APC applicables avec des - prototypes rétrocompatibles. - - - Lorsqu'une fonction APC accepte le paramètre cache_type, ce dernier est - ignoré par la version rétrocompatible de la fonction et omis du prototype de la version APCu. - - - - - À partir de PHP 8.0.0, apcu-bc n'est plus accepté. - - - - - Avec Windows, APCu a besoin d'un chemin temporaire dans lequel le serveur web est autorisé à - écrire. Il vérifie successivement les variables d'environnement TMP, TEMP et USERPROFILE dans - cet ordre et termine en essayant le répertoire WINDOWS si aucune de ces variables n'a été - définie. - - - - - Pour plus de détails techniques approfondis sur l'implémentation, consulter le - - fichier TECHNOTES fourni par les développeurs - . - - - - Les sources d'APCu sont disponibles ici. - -
- - &reference.apcu.ini; - - - diff --git a/reference/cmark/book.xml b/reference/cmark/book.xml deleted file mode 100644 index 122d7abb64..0000000000 --- a/reference/cmark/book.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - CommonMark - CommonMark - - - &reftitle.intro; - - Cette extension fournit un accès à l'implémentation de référence de CommonMark, une version rationalisée de la syntaxe Markdown avec une spécification. - - - Parsing: - - L'extension CommonMark fournit une API d'analyse simple: - - - - - Rendering: - - L'extension CommonMark fournit une API de rendu simple qui prend en charge plusieurs formats: - - - - - - - - - AST: - - L'extension CommonMark implémente le patron de visite pour les objets CommonMark\Node : - - - - - CQL: - - L'extension CommonMark fournit une interface à CQL, CommonMark Query Language: - - - - - - &reference.cmark.setup; - &reference.cmark.constants; - &reference.cmark.commonmark.node.document; - &reference.cmark.commonmark.node.heading; - &reference.cmark.commonmark.node.paragraph; - &reference.cmark.commonmark.node.blockquote; - &reference.cmark.commonmark.node.bulletlist; - &reference.cmark.commonmark.node.orderedlist; - &reference.cmark.commonmark.node.item; - &reference.cmark.commonmark.node.text; - &reference.cmark.commonmark.node.text.strong; - &reference.cmark.commonmark.node.text.emphasis; - &reference.cmark.commonmark.node.thematicbreak; - &reference.cmark.commonmark.node.softbreak; - &reference.cmark.commonmark.node.linebreak; - &reference.cmark.commonmark.node.code; - &reference.cmark.commonmark.node.codeblock; - &reference.cmark.commonmark.node.htmlblock; - &reference.cmark.commonmark.node.htmlinline; - &reference.cmark.commonmark.node.image; - &reference.cmark.commonmark.node.link; - &reference.cmark.commonmark.node.customblock; - &reference.cmark.commonmark.node.custominline; - &reference.cmark.commonmark.node; - &reference.cmark.commonmark.interfaces.ivisitor; - &reference.cmark.commonmark.interfaces.ivisitable; - &reference.cmark.commonmark.parser; - &reference.cmark.commonmark.cql; - &reference.cmark.reference; - - - diff --git a/reference/cmark/commonmark.cql.xml b/reference/cmark/commonmark.cql.xml deleted file mode 100644 index 1facf3677d..0000000000 --- a/reference/cmark/commonmark.cql.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - La classe CommonMark\CQL - CommonMark\CQL - - - - -
- &reftitle.intro; - - Le CommonMark Query Language est un DSL pour décrire comment voyager à travers un arbre de nœuds CommonMark implémenté comme un analyseur et un compilateur pour un petit ensemble d'instructions, et une machine virtuelle pour exécuter ces instructions. - - - Chemins : - - Dans sa forme la plus simpliste, une requête CQL combine les chemins suivants et / pour décrire comment voyager à travers un arbre : - - firstChild - lastChild - previous - next - parent - - Par exemple, /firstChild/lastChild voyage au dernier nœud enfant du premier nœud enfant. - - - - Boucles - - CQL peut effectuer des boucles, par exemple à travers les enfants ou les frères et sœurs d'un nœud particulier, en utilisant le chemin children, ou siblings. Par exemple, /firstChild/children parcourra tous les enfants du premier nœud enfant. - - - - Sous-requêtes - - CQL peut être instruit de voyager en utilisant une sous-requête comme [/firstChild]. Par exemple, /firstChild/children[/firstChild] voyagera au premier nœud enfant de tous les enfants du premier nœud enfant. - - - - Contraintes de boucle - - En bouclant, CQL peut être instruit de restreindre le chemin parcouru aux nœuds d'un type particulier. Par exemple /children(BlockQuote) voyagera aux enfants d'un nœud où le type est BlockQuote. Les types suivants sont reconnus (insensibles à la casse) : - - BlockQuote - List - Item - CodeBlock - HtmlBlock - CustomBlock - Paragraph - Heading - ThematicBreak - Text - SoftBreak - LineBreak - Code - HtmlInline - CustomInline - Emphasis - Strong - Link - Image - - Les types peuvent être utilisés comme une union, par exemple /children(BlockQuote|List) voyagera aux enfants d'un nœud où le type est BlockQuote ou List. Les types, ou unions de types, peuvent également être niés. Par exemple /children(~BlockQuote) voyagera aux enfants d'un nœud où le type n'est pas BlockQuote, et /children(~BlockQuote|Paragraph) voyagera aux enfants d'un nœud où le type n'est pas BlockQuote ou Paragraph. - - - - Contraintes de chemins - - CQL peut être instruit de créer une boucle pour voyager à un nœud d'un type particulier, à un chemin particulier. Par exemple, /firstChild(BlockQuote) voyagera au premier nœud enfant où le type est BlockQuote. Il est à noter que comme d'autres boucles pour children et siblings, ce type de chemin ne peut être suivi que par une sous-requête. - - - - Notes d'implémentation - - Bien que CQL ait été implémenté en tant que partie de l'extension PHP CommonMark, il est séparé de PHP et n'utilise pas la machine virtuelle de PHP ou la représentation interne des valeurs. - - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\CQL - - - - - CommonMark\CQL - - - - - &Constructor; - - - &Methods; - - - - -
- - - - &reference.cmark.commonmark.cql.construct; - &reference.cmark.commonmark.cql.invoke; - - - diff --git a/reference/cmark/commonmark.interfaces.ivisitable.xml b/reference/cmark/commonmark.interfaces.ivisitable.xml deleted file mode 100644 index 6fb9394c71..0000000000 --- a/reference/cmark/commonmark.interfaces.ivisitable.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - L'interface CommonMark\Interfaces\IVisitable - CommonMark\Interfaces\IVisitable - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\Interfaces\IVisitable - - - - - final - CommonMark\Interfaces\IVisitable - - - - - - - - -
- - - - &reference.cmark.commonmark.interfaces.ivisitable.accept; - - - diff --git a/reference/cmark/commonmark.interfaces.ivisitor.xml b/reference/cmark/commonmark.interfaces.ivisitor.xml deleted file mode 100644 index 79c9dc5765..0000000000 --- a/reference/cmark/commonmark.interfaces.ivisitor.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - L'interface CommonMark\Interfaces\IVisitor - CommonMark\Interfaces\IVisitor - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\Interfaces\IVisitor - - - - - final - CommonMark\Interfaces\IVisitor - - - - &Constants; - - const - int - CommonMark\Interfaces\IVisitor::Done - - - const - int - CommonMark\Interfaces\IVisitor::Enter - - - const - int - CommonMark\Interfaces\IVisitor::Leave - - - &Methods; - - - - -
- - - - &reference.cmark.commonmark.interfaces.ivisitor.enter; - &reference.cmark.commonmark.interfaces.ivisitor.leave; - - - diff --git a/reference/cmark/commonmark.node.blockquote.xml b/reference/cmark/commonmark.node.blockquote.xml deleted file mode 100644 index 7139ce82f4..0000000000 --- a/reference/cmark/commonmark.node.blockquote.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - BlockQuote CommonMark\Node concret - CommonMark\Node\BlockQuote - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\BlockQuote - - - - - final - CommonMark\Node\BlockQuote - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.bulletlist.xml b/reference/cmark/commonmark.node.bulletlist.xml deleted file mode 100644 index 89253f9997..0000000000 --- a/reference/cmark/commonmark.node.bulletlist.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - BulletList CommonMark\Node concret - CommonMark\Node\BulletList - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\BulletList - - - - - final - CommonMark\Node\BulletList - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &InheritedProperties; - - - &Properties; - - public - bool - tight - - - public - int - delimiter - - -&Constructor; - - - &InheritedMethods; - - - - - -
- - - - &reference.cmark.commonmark.node.bulletlist.construct; - - - - diff --git a/reference/cmark/commonmark.node.code.xml b/reference/cmark/commonmark.node.code.xml deleted file mode 100644 index 76581032f1..0000000000 --- a/reference/cmark/commonmark.node.code.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Code CommonMark\Node concret - CommonMark\Node\Code - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Code - - - - - final - CommonMark\Node\Code - - - - extends - CommonMark\Node\Text - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - - &Constructor; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.codeblock.xml b/reference/cmark/commonmark.node.codeblock.xml deleted file mode 100644 index 96885b91ec..0000000000 --- a/reference/cmark/commonmark.node.codeblock.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CodeBlock CommonMark\Node concret - CommonMark\Node\CodeBlock - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\CodeBlock - - - - - final - CommonMark\Node\CodeBlock - - - - extends - CommonMark\Node\Text - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - - &Properties; - - public - stringnull - fence - - - &Constructor; - - - - &InheritedMethods; - - - - - -
- - - - - &reference.cmark.commonmark.node.codeblock.construct; - - - - diff --git a/reference/cmark/commonmark.node.customblock.xml b/reference/cmark/commonmark.node.customblock.xml deleted file mode 100644 index 03a3025485..0000000000 --- a/reference/cmark/commonmark.node.customblock.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - CustomBlock CommonMark\Node concret - CommonMark\Node\CustomBlock - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\CustomBlock - - - - - final - CommonMark\Node\CustomBlock - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - onEnter - - - public - stringnull - onLeave - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.custominline.xml b/reference/cmark/commonmark.node.custominline.xml deleted file mode 100644 index 718579825c..0000000000 --- a/reference/cmark/commonmark.node.custominline.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - CustomInline CommonMark\Node concret - CommonMark\Node\CustomInline - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\CustomInline - - - - - final - CommonMark\Node\CustomInline - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - onEnter - - - public - stringnull - onLeave - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.document.xml b/reference/cmark/commonmark.node.document.xml deleted file mode 100644 index a5ebb226cf..0000000000 --- a/reference/cmark/commonmark.node.document.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Document CommonMark\Node concret - CommonMark\Node\Document - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Document - - - - - final - CommonMark\Node\Document - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.heading.xml b/reference/cmark/commonmark.node.heading.xml deleted file mode 100644 index f43519975b..0000000000 --- a/reference/cmark/commonmark.node.heading.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Heading CommonMark\Node concret - CommonMark\Node\Heading - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Heading - - - - - final - CommonMark\Node\Heading - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &InheritedProperties; - - - &Properties; - - public - int - level - - - &Constructor; - - - &InheritedMethods; - - - - - -
- - - - &reference.cmark.commonmark.node.heading.construct; - - - diff --git a/reference/cmark/commonmark.node.htmlblock.xml b/reference/cmark/commonmark.node.htmlblock.xml deleted file mode 100644 index ecfdaf6836..0000000000 --- a/reference/cmark/commonmark.node.htmlblock.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - HTMLBlock CommonMark\Node concret - CommonMark\Node\HTMLBlock - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\HTMLBlock - - - - - final - CommonMark\Node\HTMLBlock - - - - extends - CommonMark\Node\Text - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - - &Constructor; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.htmlinline.xml b/reference/cmark/commonmark.node.htmlinline.xml deleted file mode 100644 index 3adf280aaa..0000000000 --- a/reference/cmark/commonmark.node.htmlinline.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - HTMLInline CommonMark\Node concret - CommonMark\Node\HTMLInline - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\HTMLInline - - - - - final - CommonMark\Node\HTMLInline - - - - extends - CommonMark\Node\Text - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - -&Constructor; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.image.xml b/reference/cmark/commonmark.node.image.xml deleted file mode 100644 index 25125f4148..0000000000 --- a/reference/cmark/commonmark.node.image.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Image CommonMark\Node concret - CommonMark\Node\Image - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Image - - - - - final - CommonMark\Node\Image - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - url - - - public - stringnull - title - - - &Constructor; - - - &InheritedMethods; - - - - - -
- - - &reference.cmark.commonmark.node.image.construct; - - - - diff --git a/reference/cmark/commonmark.node.item.xml b/reference/cmark/commonmark.node.item.xml deleted file mode 100644 index 7a59f86d35..0000000000 --- a/reference/cmark/commonmark.node.item.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Item CommonMark\Node concret - CommonMark\Node\Item - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Item - - - - - final - CommonMark\Node\Item - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.linebreak.xml b/reference/cmark/commonmark.node.linebreak.xml deleted file mode 100644 index 63b38e2d9c..0000000000 --- a/reference/cmark/commonmark.node.linebreak.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - LineBreak CommonMark\Node concret - CommonMark\Node\LineBreak - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\LineBreak - - - - - final - CommonMark\Node\LineBreak - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.link.xml b/reference/cmark/commonmark.node.link.xml deleted file mode 100644 index b58264e1b7..0000000000 --- a/reference/cmark/commonmark.node.link.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Link CommonMark\Node concret - CommonMark\Node\Link - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Link - - - - - final - CommonMark\Node\Link - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - url - - - public - stringnull - title - - - &Constructor; - - - &InheritedMethods; - - - - - -
- - - - &reference.cmark.commonmark.node.link.construct; - - - - diff --git a/reference/cmark/commonmark.node.orderedlist.xml b/reference/cmark/commonmark.node.orderedlist.xml deleted file mode 100644 index b8f9551148..0000000000 --- a/reference/cmark/commonmark.node.orderedlist.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - OrderedList CommonMark\Node concret - CommonMark\Node\OrderedList - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\OrderedList - - - - - final - CommonMark\Node\OrderedList - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &Properties; - - public - bool - tight - - - public - int - delimiter - - - public - int - start - - - &Constructor; - - - &InheritedMethods; - - - - - -
- - - - &reference.cmark.commonmark.node.orderedlist.construct; - - - - diff --git a/reference/cmark/commonmark.node.paragraph.xml b/reference/cmark/commonmark.node.paragraph.xml deleted file mode 100644 index 88d4d7d1a6..0000000000 --- a/reference/cmark/commonmark.node.paragraph.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Paragraph CommonMark\Node concret - CommonMark\Node\Paragraph - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Paragraph - - - - - final - CommonMark\Node\Paragraph - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.softbreak.xml b/reference/cmark/commonmark.node.softbreak.xml deleted file mode 100644 index debc9b6e05..0000000000 --- a/reference/cmark/commonmark.node.softbreak.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - SoftBreak CommonMark\Node concret - CommonMark\Node\SoftBreak - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\SoftBreak - - - - - final - CommonMark\Node\SoftBreak - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.text.emphasis.xml b/reference/cmark/commonmark.node.text.emphasis.xml deleted file mode 100644 index fd941e84f0..0000000000 --- a/reference/cmark/commonmark.node.text.emphasis.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Emphasis CommonMark\Node concret - CommonMark\Node\Text\Emphasis - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Text\Emphasis - - - - - final - CommonMark\Node\Text\Emphasis - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.text.strong.xml b/reference/cmark/commonmark.node.text.strong.xml deleted file mode 100644 index d2c00f8ef5..0000000000 --- a/reference/cmark/commonmark.node.text.strong.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Strong CommonMark\Node concret - CommonMark\Node\Text\Strong - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Text\Strong - - - - - final - CommonMark\Node\Text\Strong - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.text.xml b/reference/cmark/commonmark.node.text.xml deleted file mode 100644 index c2ffc430ae..0000000000 --- a/reference/cmark/commonmark.node.text.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Text CommonMark\Node concret - CommonMark\Node\Text - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Text - - - - - final - CommonMark\Node\Text - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - literal - - - &Constructor; - - - &InheritedMethods; - - - - - -
- - - - &reference.cmark.commonmark.node.text.construct; - - - - diff --git a/reference/cmark/commonmark.node.thematicbreak.xml b/reference/cmark/commonmark.node.thematicbreak.xml deleted file mode 100644 index 0b98cc867b..0000000000 --- a/reference/cmark/commonmark.node.thematicbreak.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ThematicBreak CommonMark\Node concret - CommonMark\Node\ThematicBreak - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\ThematicBreak - - - - - final - CommonMark\Node\ThematicBreak - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.xml b/reference/cmark/commonmark.node.xml deleted file mode 100644 index ce4c347ccf..0000000000 --- a/reference/cmark/commonmark.node.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - CommonMark\Node abstrait - CommonMark\Node - - - - -
- &reftitle.intro; - - Représente un nœud abstrait, cette classe abstraite finale n'est pas destinée à être utilisée directement par le développeur. - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\Node - - - - - final - abstract - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &Properties; - - public - readonly - Nodenull - parent - - - public - readonly - Nodenull - previous - - - public - readonly - Nodenull - next - - - public - readonly - Nodenull - lastChild - - - public - readonly - Nodenull - firstChild - - - public - readonly - int - startLine - - - public - readonly - int - endLine - - - public - readonly - int - startColumn - - - public - readonly - int - endColumn - - - &Methods; - - - - -
- - - - - &reference.cmark.commonmark.node.appendchild; - &reference.cmark.commonmark.node.prependchild; - &reference.cmark.commonmark.node.insertafter; - &reference.cmark.commonmark.node.insertbefore; - &reference.cmark.commonmark.node.replace; - &reference.cmark.commonmark.node.unlink; - &reference.cmark.commonmark.node.accept; - - - diff --git a/reference/cmark/commonmark.parser.xml b/reference/cmark/commonmark.parser.xml deleted file mode 100644 index 3d4a5a6695..0000000000 --- a/reference/cmark/commonmark.parser.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - La classe CommonMark\Parser - CommonMark\Parser - - - - -
- &reftitle.intro; - - Fournit un analyseur incrémental en alternative à la simple fonction d'analyse de l'API Parsing - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\Parser - - - - - final - CommonMark\Parser - - - - - &Constructor; - - - &Methods; - - - - -
- - - - &reference.cmark.commonmark.parser.construct; - &reference.cmark.commonmark.parser.parse; - &reference.cmark.commonmark.parser.finish; - - - diff --git a/reference/cmark/commonmark/cql/construct.xml b/reference/cmark/commonmark/cql/construct.xml deleted file mode 100644 index ed18cd0dd4..0000000000 --- a/reference/cmark/commonmark/cql/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - CommonMark\CQL::__construct - Construction de CQL - - - - &reftitle.description; - - public CommonMark\CQL::__construct - stringquery - - - - - - - - - &reftitle.parameters; - - - query - - - Une chaîne de caractères CQL. - - - - - - - - diff --git a/reference/cmark/commonmark/cql/invoke.xml b/reference/cmark/commonmark/cql/invoke.xml deleted file mode 100644 index 9954605152..0000000000 --- a/reference/cmark/commonmark/cql/invoke.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - CommonMark\CQL::__invoke - Exécution de CQL - - - - &reftitle.description; - - public CommonMark\CQL::__invoke - CommonMark\Noderoot - callablehandler - - - Doit invoquer la fonction CQL courante sur le root donné, - exécutant le handler donné à l'entrée d'un CommonMark\Node - - - - - - &reftitle.parameters; - - - root - - le nœud racine d'un arbre - - - - handler - - - Doit avoir le prototype: - - boolnullhandler - CommonMark\Noderoot - CommonMark\Nodeentering - - - Si handler ne retourne pas (void), ou retourne null, le CQL continuera de s'exécuter - Si le gestionnaire retourne une valeur vraie, le CQL continuera de s'exécuter - Si le gestionnaire retourne une valeur fausse, le CQL s'arrêtera - - - - - - - - - diff --git a/reference/cmark/commonmark/interfaces/ivisitable/accept.xml b/reference/cmark/commonmark/interfaces/ivisitable/accept.xml deleted file mode 100644 index d8c789c2aa..0000000000 --- a/reference/cmark/commonmark/interfaces/ivisitable/accept.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - CommonMark\Interfaces\IVisitable::accept - Visitation - - - - &reftitle.description; - - abstract public voidCommonMark\Interfaces\IVisitable::accept - CommonMark\Interfaces\IVisitorvisitor - - - - - - &reftitle.parameters; - - - visitor - - - Un objet qui implémente CommonMark\Interfaces\IVisitor - - - - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/cmark/commonmark/interfaces/ivisitor/enter.xml b/reference/cmark/commonmark/interfaces/ivisitor/enter.xml deleted file mode 100644 index 143e0bdfda..0000000000 --- a/reference/cmark/commonmark/interfaces/ivisitor/enter.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - CommonMark\Interfaces\IVisitor::enter - Visitation - - - - &reftitle.description; - - abstract public intIVisitablenullCommonMark\Interfaces\IVisitor::enter - IVisitablevisitable - - - - - - &reftitle.parameters; - - - visitable - - - Le CommonMark\Interfaces\IVisitable actuel en cours d'entrée - - - - - - - - &reftitle.returnvalues; - - Retourner CommonMark\Interfaces\IVisitor::Done entraînera la sortie de l'itérateur sous-jacent. - - - Retourner CommonMark\Interfaces\IVisitor::Enter réinitialisera l'itérateur sous-jacent en entrant dans le IVisitable actuel - - - Retourner CommonMark\Interfaces\IVisitor::Leave réinitialisera l'itérateur sous-jacent en sortant de l'actuel IVisitable - - - Retourner un IVisitable réinitialisera l'itérateur sous-jacent en entrant dans le IVisitable donné - - - Ne rien retourner permettra à l'itérateur sous-jacent de continuer - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/cmark/commonmark/interfaces/ivisitor/leave.xml b/reference/cmark/commonmark/interfaces/ivisitor/leave.xml deleted file mode 100644 index 6f0edc1a36..0000000000 --- a/reference/cmark/commonmark/interfaces/ivisitor/leave.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - CommonMark\Interfaces\IVisitor::leave - Visitation - - - - &reftitle.description; - - abstract public intIVisitablenullCommonMark\Interfaces\IVisitor::leave - IVisitablevisitable - - - - - - &reftitle.parameters; - - - visitable - - - Le CommonMark\Interfaces\IVisitable actuel en cours de sortie - - - - - - - - &reftitle.returnvalues; - - Retourner CommonMark\Interfaces\IVisitor::Done entraînera la sortie de l'itérateur sous-jacent. - - - Retourner CommonMark\Interfaces\IVisitor::Enter réinitialisera l'itérateur sous-jacent en entrant dans le IVisitable actuel - - - Retourner CommonMark\Interfaces\IVisitor::Leave réinitialisera l'itérateur sous-jacent en sortant de l'actuel IVisitable - - - Retourner un IVisitable réinitialisera l'itérateur sous-jacent en sortant du IVisitable donné - - - Ne rien retourner permettra à l'itérateur sous-jacent de continuer - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/cmark/commonmark/node/accept.xml b/reference/cmark/commonmark/node/accept.xml deleted file mode 100644 index 93a9f97c9c..0000000000 --- a/reference/cmark/commonmark/node/accept.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - CommonMark\Node::accept - Visitation - - - - &reftitle.description; - - public voidCommonMark\Node::accept - CommonMark\Interfaces\IVisitorvisitor - - - - - - &reftitle.parameters; - - - visitor - - - Un objet implémentant CommonMark\Interfaces\IVisitor - - - - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/cmark/commonmark/node/appendchild.xml b/reference/cmark/commonmark/node/appendchild.xml deleted file mode 100644 index d6f2f4e946..0000000000 --- a/reference/cmark/commonmark/node/appendchild.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - CommonMark\Node::appendChild - Manipulation de l'AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::appendChild - CommonMark\Nodechild - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - child - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/commonmark/node/bulletlist/construct.xml b/reference/cmark/commonmark/node/bulletlist/construct.xml deleted file mode 100644 index 5f9f513c34..0000000000 --- a/reference/cmark/commonmark/node/bulletlist/construct.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - CommonMark\Node\BulletList::__construct - Construction de BulletList - - - - &reftitle.description; - - public CommonMark\Node\BulletList::__construct - - - - public CommonMark\Node\BulletList::__construct - inttight - - - public CommonMark\Node\BulletList::__construct - inttight - intdelimiter - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - diff --git a/reference/cmark/commonmark/node/codeblock/construct.xml b/reference/cmark/commonmark/node/codeblock/construct.xml deleted file mode 100644 index 174b58463b..0000000000 --- a/reference/cmark/commonmark/node/codeblock/construct.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - CommonMark\Node\CodeBlock::__construct - Construction de CodeBlock - - - - &reftitle.description; - - public CommonMark\Node\CodeBlock::__construct - stringfence - stringliteral - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fence - - - - - - - - literal - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/heading/construct.xml b/reference/cmark/commonmark/node/heading/construct.xml deleted file mode 100644 index 04eb13c1d2..0000000000 --- a/reference/cmark/commonmark/node/heading/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - CommonMark\Node\Heading::__construct - Construction d'Heading - - - - &reftitle.description; - - public CommonMark\Node\Heading::__construct - - - - public CommonMark\Node\Heading::__construct - intlevel - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - diff --git a/reference/cmark/commonmark/node/image/construct.xml b/reference/cmark/commonmark/node/image/construct.xml deleted file mode 100644 index 5babd7c4f0..0000000000 --- a/reference/cmark/commonmark/node/image/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CommonMark\Node\Image::__construct - Construction d'Image - - - - &reftitle.description; - - public CommonMark\Node\Image::__construct - - - - public CommonMark\Node\Image::__construct - stringurl - - - public CommonMark\Node\Image::__construct - stringurl - stringtitle - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - url - - - - - - - - title - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/insertafter.xml b/reference/cmark/commonmark/node/insertafter.xml deleted file mode 100644 index ca593ad2c8..0000000000 --- a/reference/cmark/commonmark/node/insertafter.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - CommonMark\Node::insertAfter - Manipulation de l'AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::insertAfter - CommonMark\Nodesibling - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - sibling - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/commonmark/node/insertbefore.xml b/reference/cmark/commonmark/node/insertbefore.xml deleted file mode 100644 index fc62e8aff4..0000000000 --- a/reference/cmark/commonmark/node/insertbefore.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - CommonMark\Node::insertBefore - Manipulation de l'AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::insertBefore - CommonMark\Nodesibling - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - sibling - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/commonmark/node/link/construct.xml b/reference/cmark/commonmark/node/link/construct.xml deleted file mode 100644 index 5b88e58e2b..0000000000 --- a/reference/cmark/commonmark/node/link/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CommonMark\Node\Link::__construct - Construction de Link - - - - &reftitle.description; - - public CommonMark\Node\Link::__construct - - - - public CommonMark\Node\Link::__construct - stringurl - - - public CommonMark\Node\Link::__construct - stringurl - stringtitle - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - url - - - - - - - - title - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/orderedlist/construct.xml b/reference/cmark/commonmark/node/orderedlist/construct.xml deleted file mode 100644 index 171e7d0e51..0000000000 --- a/reference/cmark/commonmark/node/orderedlist/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - CommonMark\Node\OrderedList::__construct - Construction d'OrderedList - - - - &reftitle.description; - - public CommonMark\Node\OrderedList::__construct - - - - public CommonMark\Node\OrderedList::__construct - inttight - - - public CommonMark\Node\OrderedList::__construct - inttight - intdelimiter - - - public CommonMark\Node\OrderedList::__construct - inttight - intdelimiter - intstart - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - tight - - - - - - - - delimiter - - - - - - - - start - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/prependchild.xml b/reference/cmark/commonmark/node/prependchild.xml deleted file mode 100644 index d1975e4f72..0000000000 --- a/reference/cmark/commonmark/node/prependchild.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - CommonMark\Node::prependChild - Manipulation de l'AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::prependChild - CommonMark\Nodechild - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - child - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/commonmark/node/replace.xml b/reference/cmark/commonmark/node/replace.xml deleted file mode 100644 index ae2b2ee663..0000000000 --- a/reference/cmark/commonmark/node/replace.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - CommonMark\Node::replace - Manipulation de l'AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::replace - CommonMark\Nodetarget - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - target - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/commonmark/node/text/construct.xml b/reference/cmark/commonmark/node/text/construct.xml deleted file mode 100644 index 24ae12b720..0000000000 --- a/reference/cmark/commonmark/node/text/construct.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - CommonMark\Node\Text::__construct - Construction de Text - - - - &reftitle.description; - - public CommonMark\Node\Text::__construct - - - - public CommonMark\Node\Text::__construct - stringliteral - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - literal - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/unlink.xml b/reference/cmark/commonmark/node/unlink.xml deleted file mode 100644 index 6e7524e813..0000000000 --- a/reference/cmark/commonmark/node/unlink.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - CommonMark\Node::unlink - Manipulation de l'AST - - - - &reftitle.description; - - public voidCommonMark\Node::unlink - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/commonmark/parser/construct.xml b/reference/cmark/commonmark/parser/construct.xml deleted file mode 100644 index b15ad2b7f6..0000000000 --- a/reference/cmark/commonmark/parser/construct.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - CommonMark\Parser::__construct - Analyse - - - - &reftitle.description; - - public CommonMark\Parser::__construct - intoptions - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - options - - - Un masque de: - - - - - CommonMark\Parser\Normal - (int) - - - - - - - - - CommonMark\Parser\Normalize - (int) - - - - - - - - - CommonMark\Parser\ValidateUTF8 - (int) - - - - - - - - - CommonMark\Parser\Smart - (int) - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/parser/finish.xml b/reference/cmark/commonmark/parser/finish.xml deleted file mode 100644 index 7f4eb9abb4..0000000000 --- a/reference/cmark/commonmark/parser/finish.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - CommonMark\Parser::finish - Analyse - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Parser::finish - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/commonmark/parser/parse.xml b/reference/cmark/commonmark/parser/parse.xml deleted file mode 100644 index e2ecbb95ff..0000000000 --- a/reference/cmark/commonmark/parser/parse.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - CommonMark\Parser::parse - Analyse - - - - &reftitle.description; - - public voidCommonMark\Parser::parse - stringbuffer - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - buffer - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/configure.xml b/reference/cmark/configure.xml deleted file mode 100644 index f66e0b7b59..0000000000 --- a/reference/cmark/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
- &reftitle.install; - - - Utiliser lors de la compilation PHP. - - - - Les utilisateurs de Windows devraient inclure php_cmark.dll dans &php.ini;. - - -
- diff --git a/reference/cmark/constants.xml b/reference/cmark/constants.xml deleted file mode 100644 index ad2779ecf6..0000000000 --- a/reference/cmark/constants.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - &reftitle.constants; - - - - CommonMark\Parser\Normal - (int) - - - - - - - - - CommonMark\Parser\Normalize - (int) - - - - - - - - - CommonMark\Parser\Smart - (int) - - - - - - - - - CommonMark\Parser\ValidateUTF8 - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - diff --git a/reference/cmark/functions/commonmark.parse.xml b/reference/cmark/functions/commonmark.parse.xml deleted file mode 100644 index a6abe37fdd..0000000000 --- a/reference/cmark/functions/commonmark.parse.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - CommonMark\Parse - Analyse - - - - &reftitle.description; - - CommonMark\NodeCommonMark\Parse - stringcontent - intoptions - - - Analyse content - - - - - - &reftitle.parameters; - - - content - - - Une chaîne de caractères markdown - - - - - options - - - Un masque de: - - - - - CommonMark\Parser\Normal - (int) - - - - - - - - - CommonMark\Parser\Normalize - (int) - - - - - - - - - CommonMark\Parser\ValidateUTF8 - (int) - - - - - - - - - CommonMark\Parser\Smart - (int) - - - - - - - - - - - - - - &reftitle.returnvalues; - - Retourne le nœud racine CommonMark\Node - - - - - - diff --git a/reference/cmark/functions/commonmark.render.html.xml b/reference/cmark/functions/commonmark.render.html.xml deleted file mode 100644 index 14946851bb..0000000000 --- a/reference/cmark/functions/commonmark.render.html.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - CommonMark\Render\HTML - Génère un rendu - - - - &reftitle.description; - - stringCommonMark\Render\HTML - CommonMark\Nodenode - intoptions - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Un masque de: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.latex.xml b/reference/cmark/functions/commonmark.render.latex.xml deleted file mode 100644 index 76dfeccbc7..0000000000 --- a/reference/cmark/functions/commonmark.render.latex.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - CommonMark\Render\Latex - Génère un rendu - - - - &reftitle.description; - - stringCommonMark\Render\Latex - CommonMark\Nodenode - intoptions - intwidth - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Un masque de: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.man.xml b/reference/cmark/functions/commonmark.render.man.xml deleted file mode 100644 index 957e353ed4..0000000000 --- a/reference/cmark/functions/commonmark.render.man.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - CommonMark\Render\Man - Génère un rendu - - - - &reftitle.description; - - stringCommonMark\Render\Man - CommonMark\Nodenode - intoptions - intwidth - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Un masque de: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.xml b/reference/cmark/functions/commonmark.render.xml deleted file mode 100644 index 2a38881054..0000000000 --- a/reference/cmark/functions/commonmark.render.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - CommonMark\Render - Génère un rendu - - - - &reftitle.description; - - stringCommonMark\Render - CommonMark\Nodenode - intoptions - intwidth - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Un masque de: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.xml.xml b/reference/cmark/functions/commonmark.render.xml.xml deleted file mode 100644 index 74dbe068fd..0000000000 --- a/reference/cmark/functions/commonmark.render.xml.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - CommonMark\Render\XML - Génère un rendu - - - - &reftitle.description; - - stringCommonMark\Render\XML - CommonMark\Nodenode - intoptions - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Un masque de: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/reference.xml b/reference/cmark/reference.xml deleted file mode 100644 index 1a91bb54f9..0000000000 --- a/reference/cmark/reference.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - &Functions; de CommonMark - - &reference.cmark.functions.commonmark.parse; - &reference.cmark.functions.commonmark.render; - &reference.cmark.functions.commonmark.render.html; - &reference.cmark.functions.commonmark.render.latex; - &reference.cmark.functions.commonmark.render.man; - &reference.cmark.functions.commonmark.render.xml; - - - - diff --git a/reference/cmark/setup.xml b/reference/cmark/setup.xml deleted file mode 100644 index 2393520440..0000000000 --- a/reference/cmark/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - L'extension CommonMark nécessite l'implémentation de référence (C) de cmark. - -
- -
- &reftitle.install; - - Les versions de l'extension CommonMark sont hébergées par PECL et le code source est hébergé sur - github, - le chemin d'installation le plus simple est la route PECL normale : - &url.pecl.package;cmark. - - - Les utilisateurs de Windows peuvent télécharger des binaires de version précompilés depuis le site PECL. - - - - Les utilisateurs de Windows doivent prendre la mesure supplémentaire d'ajouter cmark.dll (distribué avec les versions Windows) à leur PATH. - - - -
- - - diff --git a/reference/componere/book.xml b/reference/componere/book.xml deleted file mode 100644 index 60c8b642a7..0000000000 --- a/reference/componere/book.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Componere - Componere - - - &reftitle.intro; - - Componere (latin, anglais : compose) cible les environnements de production et fournit une API pour - la composition de classes, le patching et la conversion de type. - - - Composition: - - Componere\Definition est utilisée pour définir (ou redéfinir) une classe à l'exécution; - La classe peut ensuite être enregistrée, et dans le cas d'une redéfinition, elle remplace la classe d'origine - tant que Componere\Definition existe. - - - - - - Patching: - - Componere\Patch est utilisée pour changer la classe d'une instance spécifique d'un objet à l'exécution; - Le patch reste appliqué tant que Componere\Patch existe, et peut être révoqué explicitement. - - - - - - Conversion de type: - - Les fonctions de conversion de type Componere\ peuvent effectuer des conversions parmi les types compatibles définis par l'utilisateur; - Où compatible signifie que Type est sous ou sur le type de object. - - - - - - - - &reference.componere.setup; - &reference.componere.componere.abstract.definition; - &reference.componere.componere.definition; - &reference.componere.componere.patch; - &reference.componere.componere.method; - &reference.componere.componere.value; - &reference.componere.reference; - - diff --git a/reference/componere/componere.abstract.definition.xml b/reference/componere/componere.abstract.definition.xml deleted file mode 100644 index 34e7fb30e5..0000000000 --- a/reference/componere/componere.abstract.definition.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - La classe Componere\Abstract\Definition - Componere\Abstract\Definition - - - - -
- &reftitle.intro; - - La classe abstraite finale représente une entrée de classe, et ne devrait pas être utilisée par le développeur. - -
- - -
- &reftitle.classsynopsis; - - - - Componere\Abstract\Definition - - - - - final - abstract - Componere\Abstract\Definition - - - - - &Methods; - - - - -
- - - - &reference.componere.componere.abstract.entities.definition; - - - diff --git a/reference/componere/componere.definition.xml b/reference/componere/componere.definition.xml deleted file mode 100644 index e17dfd3df7..0000000000 --- a/reference/componere/componere.definition.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - La classe Componere\Definition - Componere\Definition - - - - -
- &reftitle.intro; - - La classe Definition permet au développeur de construire et d'enregistrer un type à l'exécution. - - - Une définition remplace une classe existante, la classe existante sera restaurée lorsque la définition sera détruite. - -
- - -
- &reftitle.classsynopsis; - - - - - Componere\Definition - - - - - - final - Componere\Definition - - - - extends - Componere\Abstract\Definition - - - - - Constructeurs - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.componere.componere.definition.construct; - &reference.componere.componere.definition.addconstant; - &reference.componere.componere.definition.addproperty; - &reference.componere.componere.definition.register; - &reference.componere.componere.definition.isregistered; - &reference.componere.componere.definition.getclosure; - &reference.componere.componere.definition.getclosures; - - diff --git a/reference/componere/componere.method.xml b/reference/componere/componere.method.xml deleted file mode 100644 index 66b6c7fda8..0000000000 --- a/reference/componere/componere.method.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - La classe Componere\Method - Componere\Method - - - - -
- &reftitle.intro; - - Une Method représente une fonction avec des drapeaux d'accessibilité modifiables - -
- - -
- &reftitle.classsynopsis; - - - - Componere\Method - - - - - final - Componere\Method - - - - - Constructeur - - - &Methods; - - - - -
- - - - &reference.componere.componere.method.construct; - &reference.componere.componere.method.setprivate; - &reference.componere.componere.method.setprotected; - &reference.componere.componere.method.setstatic; - &reference.componere.componere.method.getreflector; - - - diff --git a/reference/componere/componere.patch.xml b/reference/componere/componere.patch.xml deleted file mode 100644 index 10363e635f..0000000000 --- a/reference/componere/componere.patch.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - La classe Componere\Patch - Componere\Patch - - - - -
- &reftitle.intro; - - La classe Patch permet au développeur de changer le type d'une instance à l'exécution sans enregistrer une nouvelle Définition - - - Lorsqu'un Patch est détruit, il est révoqué, de sorte que les instances qui ont été patchées pendant la durée de vie du Patch sont restaurées à leur type formel. - -
- - -
- &reftitle.classsynopsis; - - - - Componere\Patch - - - - - final - Componere\Patch - - - - extends - Componere\Abstract\Definition - - - - - Constructeurs - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.componere.componere.patch.construct; - &reference.componere.componere.patch.apply; - &reference.componere.componere.patch.revert; - &reference.componere.componere.patch.isapplied; - &reference.componere.componere.patch.derive; - &reference.componere.componere.patch.getclosure; - &reference.componere.componere.patch.getclosures; - - - diff --git a/reference/componere/componere.value.xml b/reference/componere/componere.value.xml deleted file mode 100644 index 741c90f594..0000000000 --- a/reference/componere/componere.value.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - La classe Componere\Value - Componere\Value - - - - -
- &reftitle.intro; - - La classe Value représente une variable PHP de tous types, y compris indéfinie - -
- - -
- &reftitle.classsynopsis; - - - - Componere\Value - - - - - final - Componere\Value - - - - - Constructeur - - - &Methods; - - - - -
- - - - &reference.componere.componere.value.construct; - &reference.componere.componere.value.setprivate; - &reference.componere.componere.value.setprotected; - &reference.componere.componere.value.setstatic; - &reference.componere.componere.value.isprivate; - &reference.componere.componere.value.isprotected; - &reference.componere.componere.value.isstatic; - &reference.componere.componere.value.hasdefault; - - - diff --git a/reference/componere/componere/abstract/definition/addinterface.xml b/reference/componere/componere/abstract/definition/addinterface.xml deleted file mode 100644 index 6db39622a0..0000000000 --- a/reference/componere/componere/abstract/definition/addinterface.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Componere\Abstract\Definition::addInterface - Ajoute une interface - - - - &reftitle.description; - - public DefinitionComponere\Abstract\Definition::addInterface - stringinterface - - - Ajoute l'interface donnée à la définition courante - - - - - - &reftitle.parameters; - - - interface - - - Le nom insensible à la casse d'une interface - - - - - - - - &reftitle.returnvalues; - - La définition courante - - - - - Exceptions - - - Lancera une RuntimeException si la Definition a été enregistrée - - - - - - diff --git a/reference/componere/componere/abstract/definition/addmethod.xml b/reference/componere/componere/abstract/definition/addmethod.xml deleted file mode 100644 index c3ac430f46..0000000000 --- a/reference/componere/componere/abstract/definition/addmethod.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Componere\Abstract\Definition::addMethod - Ajoute une méthode - - - - &reftitle.description; - - public DefinitionComponere\Abstract\Definition::addMethod - stringname - Componere\Methodmethod - - - Crée ou remplace une méthode sur la définition courante. - - - - - - &reftitle.parameters; - - - name - - - Le nom insensible à la casse d'une méthode - - - - - method - - - Une Componere\Method non précédemment ajoutée à une autre Definition - - - - - - - - &reftitle.returnvalues; - - La Definition courante - - - - - Exceptions - - - Lancera une RuntimeException si la Definition a été enregistrée - - - - - Lancera une RuntimeException si la méthode a été ajoutée à une autre Definition - - - - - - - diff --git a/reference/componere/componere/abstract/definition/addtrait.xml b/reference/componere/componere/abstract/definition/addtrait.xml deleted file mode 100644 index f1b2995183..0000000000 --- a/reference/componere/componere/abstract/definition/addtrait.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Componere\Abstract\Definition::addTrait - Ajoute un trait - - - - &reftitle.description; - - public DefinitionComponere\Abstract\Definition::addTrait - stringtrait - - - Utilise le trait pour la définition courante - - - - - - &reftitle.parameters; - - - trait - - - Le nom insensible à la casse d'un trait - - - - - - - - &reftitle.returnvalues; - - La définition courante - - - - - Exceptions - - - Lancera une RuntimeException si la Definition a été enregistrée - - - - - - - diff --git a/reference/componere/componere/abstract/definition/getreflector.xml b/reference/componere/componere/abstract/definition/getreflector.xml deleted file mode 100644 index 736b0fbccb..0000000000 --- a/reference/componere/componere/abstract/definition/getreflector.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - Componere\Abstract\Definition::getReflector - Reflection - - - - &reftitle.description; - - public ReflectionClassComponere\Abstract\Definition::getReflector - - - - Crée ou retourne une ReflectionClass - - - - - - &reftitle.returnvalues; - - Une ReflectionClass pour la définition courante (mise en cache) - - - - - - diff --git a/reference/componere/componere/definition/addconstant.xml b/reference/componere/componere/definition/addconstant.xml deleted file mode 100644 index 08734e4325..0000000000 --- a/reference/componere/componere/definition/addconstant.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Componere\Definition::addConstant - Ajoute une constante - - - - &reftitle.description; - - public DefinitionComponere\Definition::addConstant - stringname - Componere\Valuevalue - - - Déclare une constante de classe sur la définition actuelle - - - - - &reftitle.parameters; - - - name - - - Le nom sensible à la casse de la constante - - - - - value - - - La valeur de la constante, ne doit pas être indéfinie ou statique - - - - - - - - &reftitle.returnvalues; - - La définition actuelle - - - - - Exceptions - - - Lance une RuntimeException si la Definition a été enregistrée - - - - - Lance une RuntimeException si name est déjà déclaré comme une constante - - - - - Lance une RuntimeException si value est statique - - - - - Lance une RuntimeException si value est indéfinie - - - - - - diff --git a/reference/componere/componere/definition/addproperty.xml b/reference/componere/componere/definition/addproperty.xml deleted file mode 100644 index ac248fc5d9..0000000000 --- a/reference/componere/componere/definition/addproperty.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Componere\Definition::addProperty - Ajoute une propriété - - - - &reftitle.description; - - public DefinitionComponere\Definition::addProperty - stringname - Componere\Valuevalue - - - Déclare une propriété de classe sur la définition actuelle - - - - - - &reftitle.parameters; - - - name - - - Le nom sensible à la casse de la propriété - - - - - value - - - La valeur par défaut de la propriété. - - - - - - - - &reftitle.returnvalues; - - La définition actuelle - - - - - Exceptions - - - Lance une RuntimeException si la Definition a été enregistrée - - - - - Lance une RuntimeException si name est déjà déclaré comme propriété - - - - - - diff --git a/reference/componere/componere/definition/construct.xml b/reference/componere/componere/definition/construct.xml deleted file mode 100644 index 579e2be80f..0000000000 --- a/reference/componere/componere/definition/construct.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Componere\Definition::__construct - Constructeurs de Definition - - - - &reftitle.description; - - public Componere\Definition::__construct - stringname - - - - public Componere\Definition::__construct - stringname - stringparent - - - - public Componere\Definition::__construct - stringname - arrayinterfaces - - - - public Componere\Definition::__construct - stringname - stringparent - arrayinterfaces - - - - - - &reftitle.parameters; - - - name - - - Un nom de classe insensible à la casse - - - - - parent - - - Un nom de classe insensible à la casse - - - - - interfaces - - - Un tableau de noms de classes insensibles à la casse - - - - - - - - Exceptions - - - Lance une InvalidArgumentException si une tentative est faite pour remplacer une classe interne - - - - - Lance une InvalidArgumentException si une tentative est faite pour remplacer une interface - - - - - Lance une InvalidArgumentException si une tentative est faite pour remplacer un trait - - - - - Lance une RuntimeException si une des classes dans interfaces ne peut être trouvée - - - - - Lance une RuntimeException si une des classes dans interfaces n'est pas une interface - - - - - - diff --git a/reference/componere/componere/definition/getclosure.xml b/reference/componere/componere/definition/getclosure.xml deleted file mode 100644 index 014302574f..0000000000 --- a/reference/componere/componere/definition/getclosure.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Componere\Definition::getClosure - Renvoie la fermeture - - - - &reftitle.description; - - public ClosureComponere\Definition::getClosure - stringname - - - Renvoie une fermeture pour la méthode spécifiée par le nom - - - - - - &reftitle.parameters; - - - name - - - Le nom insensible à la casse de la méthode - - - - - - - - &reftitle.returnvalues; - - Une fermeture liée à la portée correcte - - - - - Exceptions - - - Lance une RuntimeException si la Definition a été enregistrée - - - - - Lance une RuntimeException si name n'a pas pu être trouvé - - - - - - diff --git a/reference/componere/componere/definition/getclosures.xml b/reference/componere/componere/definition/getclosures.xml deleted file mode 100644 index b02814e504..0000000000 --- a/reference/componere/componere/definition/getclosures.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Componere\Definition::getClosures - Renvoie des fermetures - - - - &reftitle.description; - - public arrayComponere\Definition::getClosures - - - - Renvoie un tableau de fermetures - - - - - - &reftitle.returnvalues; - - Renvoie toutes les méthodes sous forme d'un tableau d'objets Fermeture liés à la portée correcte - - - - - Exceptions - - - Lance une RuntimeException si la Definition a été enregistrée - - - - - - diff --git a/reference/componere/componere/definition/isregistered.xml b/reference/componere/componere/definition/isregistered.xml deleted file mode 100644 index 5472f5f3c2..0000000000 --- a/reference/componere/componere/definition/isregistered.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - Componere\Definition::isRegistered - Détection d'état - - - - &reftitle.description; - - public boolComponere\Definition::isRegistered - - - - Détecte l'état d'enregistrement de cette Définition - - - - - &reftitle.returnvalues; - - Renvoie true si cette Définition est enregistrée - - - - - - diff --git a/reference/componere/componere/definition/register.xml b/reference/componere/componere/definition/register.xml deleted file mode 100644 index af03ea825b..0000000000 --- a/reference/componere/componere/definition/register.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - Componere\Definition::register - Inscription - - - - &reftitle.description; - - public voidComponere\Definition::register - - - - Inscrit la définition actuelle - - - - - - Exceptions - - - Lance une RuntimeException si la Definition a été enregistrée - - - - - - diff --git a/reference/componere/componere/method/construct.xml b/reference/componere/componere/method/construct.xml deleted file mode 100644 index 396862c710..0000000000 --- a/reference/componere/componere/method/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Componere\Method::__construct - Construction de méthode - - - - &reftitle.description; - - public Componere\Method::__construct - Closureclosure - - - - - - &reftitle.parameters; - - - closure - - - - - - - - - - - - - diff --git a/reference/componere/componere/method/getreflector.xml b/reference/componere/componere/method/getreflector.xml deleted file mode 100644 index eb86b96ff0..0000000000 --- a/reference/componere/componere/method/getreflector.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - Componere\Method::getReflector - Reflection - - - - &reftitle.description; - - public ReflectionMethodComponere\Method::getReflector - - - - Crée ou retourne une ReflectionMethod - - - - - &reftitle.returnvalues; - - Une ReflectionMethod pour la méthode actuelle (mise en cache) - - - - - - diff --git a/reference/componere/componere/method/setprivate.xml b/reference/componere/componere/method/setprivate.xml deleted file mode 100644 index b16acaf0ac..0000000000 --- a/reference/componere/componere/method/setprivate.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Componere\Method::setPrivate - Modification de l'accessibilité - - - - &reftitle.description; - - public MethodComponere\Method::setPrivate - - - - - - &reftitle.returnvalues; - - La méthode actuelle - - - - - Exceptions - - - Lance une RuntimeException si le niveau d'accès a déjà été défini - - - - - - diff --git a/reference/componere/componere/method/setprotected.xml b/reference/componere/componere/method/setprotected.xml deleted file mode 100644 index 4f2fcabaa0..0000000000 --- a/reference/componere/componere/method/setprotected.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Componere\Method::setProtected - Modification de l'accessibilité - - - - &reftitle.description; - - public MethodComponere\Method::setProtected - - - - - - &reftitle.returnvalues; - - La méthode actuelle - - - - - Exceptions - - - Lance une RuntimeException si le niveau d'accès a déjà été défini - - - - - - - diff --git a/reference/componere/componere/method/setstatic.xml b/reference/componere/componere/method/setstatic.xml deleted file mode 100644 index 75814595b3..0000000000 --- a/reference/componere/componere/method/setstatic.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - Componere\Method::setStatic - Modification de l'accessibilité - - - - &reftitle.description; - - public MethodComponere\Method::setStatic - - - - - - &reftitle.returnvalues; - - La méthode actuelle - - - - - - diff --git a/reference/componere/componere/patch/apply.xml b/reference/componere/componere/patch/apply.xml deleted file mode 100644 index 650f88b6ef..0000000000 --- a/reference/componere/componere/patch/apply.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Componere\Patch::apply - Applique - - - - &reftitle.description; - - public voidComponere\Patch::apply - - - - Applique le patch courant - - - - - - - diff --git a/reference/componere/componere/patch/construct.xml b/reference/componere/componere/patch/construct.xml deleted file mode 100644 index 7b255267b4..0000000000 --- a/reference/componere/componere/patch/construct.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Componere\Patch::__construct - Construction de patch - - - - &reftitle.description; - - public Componere\Patch::__construct - objectinstance - - - public Componere\Patch::__construct - objectinstance - arrayinterfaces - - - - - - &reftitle.parameters; - - - instance - - - La cible de ce patch - - - - - interfaces - - - Un tableau insensible à la casse de noms de classes - - - - - - - - Exceptions - - - Lance une RuntimeException si une classe dans interfaces ne peut pas être trouvée - - - - - Lance une RuntimeException si une classe dans interfaces n'est pas une interface - - - - - - diff --git a/reference/componere/componere/patch/derive.xml b/reference/componere/componere/patch/derive.xml deleted file mode 100644 index 1b4bb0b076..0000000000 --- a/reference/componere/componere/patch/derive.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Componere\Patch::derive - Dérivation de patch - - - - &reftitle.description; - - public PatchComponere\Patch::derive - objectinstance - - - Dérive un Patch pour l'instance donnée - - - - - - &reftitle.parameters; - - - instance - - - La cible pour le patch dérivé - - - - - - - - &reftitle.returnvalues; - - Un Patch pour instance dérivé du Patch courant - - - - - Exceptions - - - Lance une InvalidArgumentException si instance n'est pas compatible - - - - - - diff --git a/reference/componere/componere/patch/getclosure.xml b/reference/componere/componere/patch/getclosure.xml deleted file mode 100644 index c6a6072d63..0000000000 --- a/reference/componere/componere/patch/getclosure.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Componere\Patch::getClosure - Renvoie une fermeture - - - - &reftitle.description; - - public ClosureComponere\Patch::getClosure - stringname - - - Renvoie une fermeture pour la méthode spécifiée par le nom - - - - - - &reftitle.parameters; - - - name - - - Le nom insensible à la casse de la méthode - - - - - - - - &reftitle.returnvalues; - - Une fermeture liée au bon contexte et au bon objet - - - - - Exceptions - - - Lance une RuntimeException si name ne peut pas être trouvé - - - - - - diff --git a/reference/componere/componere/patch/getclosures.xml b/reference/componere/componere/patch/getclosures.xml deleted file mode 100644 index 7fa9b5755c..0000000000 --- a/reference/componere/componere/patch/getclosures.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - Componere\Patch::getClosures - Renvoie des fermetures - - - - &reftitle.description; - - public arrayComponere\Patch::getClosures - - - - Renvoie un tableau de fermetures - - - - - - &reftitle.returnvalues; - - Renvoie toutes les méthodes sous forme d'un tableau d'objets Fermeture liés au bon contexte et au bon objet - - - - - - diff --git a/reference/componere/componere/patch/isapplied.xml b/reference/componere/componere/patch/isapplied.xml deleted file mode 100644 index 37fa0666c4..0000000000 --- a/reference/componere/componere/patch/isapplied.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - Componere\Patch::isApplied - Détection d'état - - - - &reftitle.description; - - public boolComponere\Patch::isApplied - - - - - - - - diff --git a/reference/componere/componere/patch/revert.xml b/reference/componere/componere/patch/revert.xml deleted file mode 100644 index 8bc30e0dd4..0000000000 --- a/reference/componere/componere/patch/revert.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - Componere\Patch::revert - Restaure - - - - &reftitle.description; - - public voidComponere\Patch::revert - - - - Restaure le patch courant - - - - - - diff --git a/reference/componere/componere/value/construct.xml b/reference/componere/componere/value/construct.xml deleted file mode 100644 index ab821afc2a..0000000000 --- a/reference/componere/componere/value/construct.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Componere\Value::__construct - Construction de Value - - - - &reftitle.description; - - public Componere\Value::__construct - mixeddefault - - - - - - - - - &reftitle.parameters; - - - default - - - - - - - - - - - Exceptions - - - Lance une InvalidArgumentException si default n'a pas une valeur adaptée - - - - - - - - diff --git a/reference/componere/componere/value/hasdefault.xml b/reference/componere/componere/value/hasdefault.xml deleted file mode 100644 index c5094a113e..0000000000 --- a/reference/componere/componere/value/hasdefault.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Componere\Value::hasDefault - Interaction de valeur - - - - &reftitle.description; - - public boolComponere\Value::hasDefault - - - - - - - - - - - diff --git a/reference/componere/componere/value/isprivate.xml b/reference/componere/componere/value/isprivate.xml deleted file mode 100644 index 23e6ff806f..0000000000 --- a/reference/componere/componere/value/isprivate.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Componere\Value::isPrivate - Détection d'accessibilité - - - - &reftitle.description; - - public boolComponere\Value::isPrivate - - - - - - - - - - - diff --git a/reference/componere/componere/value/isprotected.xml b/reference/componere/componere/value/isprotected.xml deleted file mode 100644 index 2ab28f6eec..0000000000 --- a/reference/componere/componere/value/isprotected.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Componere\Value::isProtected - Détection d'accessibilité - - - - &reftitle.description; - - public boolComponere\Value::isProtected - - - - - - - - - - - diff --git a/reference/componere/componere/value/isstatic.xml b/reference/componere/componere/value/isstatic.xml deleted file mode 100644 index c3f36c5532..0000000000 --- a/reference/componere/componere/value/isstatic.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Componere\Value::isStatic - Détection d'accessibilité - - - - &reftitle.description; - - public boolComponere\Value::isStatic - - - - - - - - - - - diff --git a/reference/componere/componere/value/setprivate.xml b/reference/componere/componere/value/setprivate.xml deleted file mode 100644 index fb4aa212dd..0000000000 --- a/reference/componere/componere/value/setprivate.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - Componere\Value::setPrivate - Modification d'accessibilité - - - - &reftitle.description; - - public ValueComponere\Value::setPrivate - - - - - - - - - - &reftitle.returnvalues; - - La valeur actuelle - - - - - Exceptions - - - Lance une RuntimeException si le niveau d'accès a déjà été défini - - - - - - - diff --git a/reference/componere/componere/value/setprotected.xml b/reference/componere/componere/value/setprotected.xml deleted file mode 100644 index 80a5c982e8..0000000000 --- a/reference/componere/componere/value/setprotected.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - Componere\Value::setProtected - Modification d'accessibilité - - - - &reftitle.description; - - public ValueComponere\Value::setProtected - - - - - - - - - - &reftitle.returnvalues; - - La valeur actuelle - - - - - Exceptions - - - Lance une RuntimeException si le niveau d'accès a déjà été défini - - - - - - - diff --git a/reference/componere/componere/value/setstatic.xml b/reference/componere/componere/value/setstatic.xml deleted file mode 100644 index 518cec62f5..0000000000 --- a/reference/componere/componere/value/setstatic.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - Componere\Value::setStatic - Modification d'accessibilité - - - - &reftitle.description; - - public ValueComponere\Value::setStatic - - - - - - - - - - &reftitle.returnvalues; - - La valeur actuelle - - - - - - diff --git a/reference/componere/configure.xml b/reference/componere/configure.xml deleted file mode 100644 index aa5be65c7b..0000000000 --- a/reference/componere/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
- &reftitle.install; - - - Utiliser lors de la compilation de PHP. - - - - Les utilisateurs de Windows doivent inclure php_componere.dll dans &php.ini; - - -
- diff --git a/reference/componere/functions/componere.cast.xml b/reference/componere/functions/componere.cast.xml deleted file mode 100644 index 063015107f..0000000000 --- a/reference/componere/functions/componere.cast.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Componere\cast - Conversion de type - - - - &reftitle.description; - - objectComponere\cast - stringtype - objectobject - - - - - &reftitle.parameters; - - - type - - - Un type défini par l'utilisateur - - - - - object - - - Un objet avec un type défini par l'utilisateur compatible avec Type - - - - - - - - &reftitle.returnvalues; - - Un object de type Type, converti depuis object - - - - - &reftitle.errors; - - - Lance une InvalidArgumentException si le type de object est ou est dérivé d'une classe interne - - - - - Lance une InvalidArgumentException si Type est une interface - - - - - Lance une InvalidArgumentException si Type est un trait - - - - - Lance une InvalidArgumentException si Type est abstrait - - - - - Lance une InvalidArgumentException si Type n'est pas compatible avec le type de object - - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/componere/functions/componere.cast_by_ref.xml b/reference/componere/functions/componere.cast_by_ref.xml deleted file mode 100644 index ccd310d2ec..0000000000 --- a/reference/componere/functions/componere.cast_by_ref.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Componere\cast_by_ref - Conversion de type - - - - &reftitle.description; - - objectComponere\cast_by_ref - stringtype - objectobject - - - - - &reftitle.parameters; - - - type - - - Un type défini par l'utilisateur - - - - - object - - - Un objet avec un type défini par l'utilisateur compatible avec Type - - - - - - - - &reftitle.returnvalues; - - Un object de type Type, converti depuis object, où les membres sont des références aux membres de object - - - - - &reftitle.errors; - - - Lance une InvalidArgumentException si le type de object est ou est dérivé d'une classe interne - - - - - Lance une InvalidArgumentException si Type est une interface - - - - - Lance une InvalidArgumentException si Type est un trait - - - - - Lance une InvalidArgumentException si Type est abstrait - - - - - Lance une InvalidArgumentException si Type n'est pas compatible avec le type de object - - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/componere/reference.xml b/reference/componere/reference.xml deleted file mode 100644 index 737c5595d2..0000000000 --- a/reference/componere/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - &Functions; de Componere - - &reference.componere.functions.componere.cast; - &reference.componere.functions.componere.cast-by-ref; - - - - diff --git a/reference/componere/setup.xml b/reference/componere/setup.xml deleted file mode 100644 index e0a070e4b5..0000000000 --- a/reference/componere/setup.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - La Reflection est requise - -
- -
- &reftitle.install; - - Le code source et les versions de Componere sont disponibles sur - github - -
- - - diff --git a/reference/cubrid/aliases.xml b/reference/cubrid/aliases.xml deleted file mode 100644 index e25d979db5..0000000000 --- a/reference/cubrid/aliases.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - Fonctions et alias CUBRID obsolètes - - &reference.cubrid.entities.oldaliases; - - - - - - diff --git a/reference/cubrid/book.xml b/reference/cubrid/book.xml deleted file mode 100644 index 10b3651760..0000000000 --- a/reference/cubrid/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - CUBRID - CUBRID - - - &reftitle.intro; - - Ces fonctions autorisent à accéder aux serveurs de base de données - CUBRID. Plus d'informations sur CUBRID peuvent être trouvées sur le site de CUBRID. - - - La documentation sur CUBRID peut être trouvée ici. - - - - - &reference.cubrid.setup; - &reference.cubrid.constants; - &reference.cubrid.examples; - &reference.cubrid.reference; - &reference.cubrid.cubridmysql; - &reference.cubrid.aliases; - - diff --git a/reference/cubrid/configure.xml b/reference/cubrid/configure.xml deleted file mode 100644 index 1f73f99c4c..0000000000 --- a/reference/cubrid/configure.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;cubrid. - - - &pecl.windows.download; - - - Pour plus d'informations sur l'installation manuelle sous Linux et Windows, - consulter le fichier build-guide.html inclus dans le paquet. - - -
- diff --git a/reference/cubrid/constants.xml b/reference/cubrid/constants.xml deleted file mode 100644 index afca9af797..0000000000 --- a/reference/cubrid/constants.xml +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - Les constantes suivantes peuvent être utilisées lors de l'exécution - de requête SQL. Elles peuvent être passées aux fonctions cubrid_prepare - et cubrid_execute. - - Drapeaux d'exécution SQL CUBRID - - - - Constante - Description - - - - - CUBRID_INCLUDE_OID - Détermine si l'on doit récupérer l'OID lors de l'exécution de la - requête. - - - CUBRID_ASYNC - Exécute la requête en mode asynchrone. - - - CUBRID_EXEC_QUERY_ALL - - Exécute la requête en mode synchrone. Ce drapeau doit être - défini lors de l'exécution de requêtes SQL multiples. - - - -
- - - - Les constantes suivantes peuvent être utilisées lors de la récupération - des résultats afin d'en spécifier le comportement. Elles peuvent être - passées aux fonctions cubrid_fetch - et cubrid_fetch_array. - - Drapeaux de récupération CUBRID - - - - Constante - Description - - - - - CUBRID_NUM - Récupère le résultat de la requête sous la forme d'un tableau - numérique (dont les index commencent à 0). - - - CUBRID_ASSOC - Récupère le résultat de la requête sous la forme d'un tableau - associatif. - - - CUBRID_BOTH - Récupère le résultat de la requête à la fois sous la forme - d'un tableau numérique et sous la forme d'un tableau associatif (valeur - par défaut). - - - CUBRID_OBJECT - Récupère le résultat de la requête sous la forme d'un objet. - - - CUBRID_LOB - - La constante CUBRID_LOB peut être utilisée lorsque l'on veut - utiliser un objet LOB. Elle peut être passée aux fonctions - cubrid_fetch, - cubrid_fetch_row, - cubrid_fetch_array, - cubrid_fetch_assoc et - cubrid_fetch_object. - - - -
- - - - Les constantes suivantes peuvent être utilisées lors du positionnement du - curseur dans les résultats de la requête. Elles peuvent être passées à - ou retournées par la fonction cubrid_move_cursor. - - Drapeaux sur le positionnement du curseur CUBRID - - - - Constante - Description - - - - - CUBRID_CURSOR_FIRST - Déplace le curseur courant à la première position du résultat. - - - CUBRID_CURSOR_CURRENT - Déplace le curseur courant à une valeur par défaut si l'origine - n'est pas spécifiée. - - - CUBRID_CURSOR_LAST - Déplace le curseur courant à la dernière position du résultat. - - - CUBRID_CURSOR_SUCCESS - La valeur retournée par la fonction cubrid_move_cursor - en cas de succès. Ce drapeau a été supprimé depuis la version 8.4.1. - - - CUBRID_NO_MORE_DATA - La valeur retournée par la fonction cubrid_move_cursor - si une erreur survient. Ce drapeau a été supprimé depuis la version 8.4.1. - - - CUBRID_CURSOR_ERROR - La valeur retournée par la fonction cubrid_move_cursor - si une erreur survient. Ce drapeau a été supprimé depuis la version 8.4.1. - - - -
- - - - Les constantes suivantes peuvent être utilisées lors de la définition - du mode auto-commit pour la connexion à la base de données. - Elles peuvent être passées à la fonction cubrid_set_autocommit - ou retournées par la fonction cubrid_get_autocommit. - - Drapeaux CUBRID pour le mode auto-commit - - - - Constante - Description - - - - - CUBRID_AUTOCOMMIT_TRUE - Active le mode auto-commit. - - - CUBRID_AUTOCOMMIT_FALSE - Désactive le mode auto-commit. - - - -
- - - - Les constantes suivantes peuvent être utilisées lors de la définition - des paramètres à la base de données. Elles peuvent être passées à - la fonction cubrid_set_db_parameter. - - Drapeaux des paramètres CUBRID - - - - Constante - Description - - - - - CUBRID_PARAM_ISOLATION_LEVEL - Niveau d'isolation de la transaction pour la connexion - à la base de données. - - - CUBRID_PARAM_LOCK_TIMEOUT - Délai d'expiration de la transaction en secondes. - - - -
- - - - Les constantes suivantes peuvent être utilisées pour définir le niveau - d'isolation de la transaction. Elles peuvent être passées à la fonction - cubrid_set_db_parameter ou retournées par la fonction - cubrid_get_db_parameter. - - Drapeaux CUBRID pour le niveau d'isolation - - - - Constante - Description - - - - - TRAN_COMMIT_CLASS_UNCOMMIT_INSTANCE - Le niveau d'isolation le plus faible (1). - Une lecture de données modifiées, non-répétables, ou - fantômes peut survenir sur le tuple et, de plus, une lecture - non-répétable peut survenir sur la table. - - - TRAN_COMMIT_CLASS_COMMIT_INSTANCE - Un niveau d'isolation relativement bas (2). Une - lecture de données modifiées ne peut pas survenir, - mais une lecture de données non-répétables ou fantômes - peut survenir. - - - TRAN_REP_CLASS_UNCOMMIT_INSTANCE - Le niveau d'isolation par défaut pour CUBRID (3). - Une lecture de données modifiées, non répétables ou fantômes - peut survenir sur le tuple, mais la lecture de données répétables - est assurée pour la table. - - - TRAN_REP_CLASS_COMMIT_INSTANCE - Un niveau d'isolation relativement bas (4). Une lecture - de données modifiées ne peut pas survenir, mais une lecture - de données non-répétables ou fantômes peut survenir. - - - TRAN_REP_CLASS_REP_INSTANCE - Un niveau d'isolation relativement haut (5). Une lecture - de données modifiées ou non-répétables ne peut pas survenir, mais - une lecture de données fantômes peut survenir. - - - TRAN_SERIALIZABLE - Le niveau d'isolation le plus haut (6). Les problèmes liés - à la concurrence (c.-à-d. lecture de données modifiées, non-répétables, fantômes, - etc.) ne peuvent pas survenir. - - - -
- - - - Les constantes suivantes peuvent être utilisées pour récupérer les informations - de schéma. Elles peuvent être passées à la fonction - cubrid_schema. - - Drapeaux pour les schémas CUBRID - - - - Constante - Description - - - - - CUBRID_SCH_CLASS - Récupère le nom et le type de la table dans CUBRID. - - - CUBRID_SCH_VCLASS - Récupère le nom et le type de la vue dans CUBRID. - - - CUBRID_SCH_QUERY_SPEC - Récupère la définition de la requête pour une vue. - - - CUBRID_SCH_ATTRIBUTE - Récupère les attributs d'une colonne d'une table. - - - CUBRID_SCH_CLASS_ATTRIBUTE - Récupère les attributs d'une table. - - - CUBRID_SCH_METHOD - Récupère la méthode de l'instance. La méthode de l'instance - est la méthode appelée par une instance de classe. Elle est plus - souvent utilisée qu'une méthode de classe car la plupart des - opérations sont exécutées dans l'instance. - - - CUBRID_SCH_CLASS_METHOD - Récupère la méthode de classe. La méthode de classe est - la méthode appelée par un objet de la classe. Elle est habituellement - utilisée pour créer une nouvelle instance de la classe ou pour - l'initialiser. Elle est également utilisée pour accéder ou mettre - à jour les attributs de la classe. - - - CUBRID_SCH_METHOD_FILE - Récupère les informations du fichier définissant la méthode - de la table. - - - CUBRID_SCH_SUPERCLASS - Récupère le nom et le type de la table pour laquelle - la table hérite ses attributs. - - - CUBRID_SCH_SUBCLASS - Récupère le nom et le type de la table héritant des attributs. - - - CUBRID_SCH_CONSTRAINT - Récupère les contraintes de la table. - - - CUBRID_SCH_TRIGGER - Récupère les triggers de la table. - - - CUBRID_SCH_CLASS_PRIVILEGE - Récupère les informations quant aux privilèges de la table. - - - CUBRID_SCH_ATTR_PRIVILEGE - Récupère les informations de privilèges d'une colonne. - - - CUBRID_SCH_DIRECT_SUPER_CLASS - Récupère la table super direct de la table. - - - CUBRID_SCH_PRIMARY_KEY - Récupère la clé primaire de la table. - - - CUBRID_SCH_IMPORTED_KEYS - Récupère les clés importées de la table. - - - CUBRID_SCH_EXPORTED_KEYS - Récupère les clés exportées de la table. - - - CUBRID_SCH_CROSS_REFERENCE - Récupère les références des liens de 2 tables. - - - -
- - - - Les constantes suivantes peuvent être utilisées lors du rapport des - erreurs. Elles peuvent être retournées par la fonction - cubrid_error_code_facility. - - Code de facilité des erreurs CUBRID - - - - Constante - Description - - - - - CUBRID_FACILITY_DBMS - L'erreur est survenue dans la base de données CUBRID. - - - CUBRID_FACILITY_CAS - L'erreur est survenue dans le courtier CUBRID. - - - CUBRID_FACILITY_CCI - L'erreur est survenue dans le cci CUBRID. - - - CUBRID_FACILITY_CLIENT - L'erreur est survenue dans le client PHP CUBRID. - - - -
- - - - diff --git a/reference/cubrid/cubridmysql.xml b/reference/cubrid/cubridmysql.xml deleted file mode 100644 index 841755c713..0000000000 --- a/reference/cubrid/cubridmysql.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - Fonctions CUBRID compatibles MySQL - - &reference.cubrid.entities.cubridmysql; - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-affected-rows.xml b/reference/cubrid/cubridmysql/cubrid-affected-rows.xml deleted file mode 100644 index 40cc038a2e..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-affected-rows.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - cubrid_affected_rows - Récupère le nombre de lignes affectées par la dernière requête SQL - - - - &reftitle.description; - - intcubrid_affected_rows - resourceconn_identifier - - - intcubrid_affected_rows - resourcereq_identifier - - - La fonction cubrid_affected_rows est utilisée pour - récupérer le nombre de lignes affectées par la dernière requête Cubrid - (INSERT, DELETE, UPDATE). - - - - - &reftitle.parameters; - - - conn_identifier - La connexion CUBRID. Si l'identifiant de connexion n'est pas - spécifié, le dernier lien ouvert par cubrid_connect est utilisé. - - - req_identifier - - - L'identifiant de requête ; il peut être retourné soit - de la fonction cubrid_prepare, soit - de la fonction cubrid_execute. - Si l'identifiant de requête n'est pas spécifié, le dernier - identifiant de requête utilisé par la fonction - cubrid_prepare ou la fonction - cubrid_execute sera utilisé. - - - - - - - - &reftitle.returnvalues; - - Nombre de lignes affectées par la dernière requête SQL, lorsqu'elle a réussi. - - - -1, lorsque la dernière requête n'était pas de type - INSERT, DELETE ou UPDATE. - - - &false;, lorsque l'identifiant de requête n'est pas spécifié et qu'il n'y a - aucune requête précédente. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_affected_rows</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-client-encoding.xml b/reference/cubrid/cubridmysql/cubrid-client-encoding.xml deleted file mode 100644 index 52848ad1d9..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-client-encoding.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - cubrid_client_encoding - Retourne le jeu de caractères utilisé sur la connexion CUBRID courante - - - - &reftitle.description; - - stringcubrid_client_encoding - resourceconn_identifier - - - Cette fonction retourne le jeu de caractères utilisé sur la connexion - CUBRID courante et est similaire à la fonction cubrid_get_charset. - - - - - &reftitle.parameters; - - - - conn_identifier - - - - La connexion CUBRID. Si l'identifiant de connexion n'est pas spécifié, - la dernière connexion ouverte avec la fonction cubrid_connect - sera utilisée. - - - - - - - - &reftitle.returnvalues; - - Une &string; qui représente le jeu de caractères sur la connexion CUBRID en cas de succès. - - - &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_client_encoding</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_get_charset - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-close.xml b/reference/cubrid/cubridmysql/cubrid-close.xml deleted file mode 100644 index 9f606dd349..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-close.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - cubrid_close - Ferme une connexion CUBRID - - - - &reftitle.description; - - boolcubrid_close - resourceconn_identifier - - - La fonction cubrid_close met fin à la transaction courante, - ferme le gestionnaire de connexion et déconnecte le serveur. S'il existe des gestionnaires - de requêtes non clos à ce moment-là, ils seront tous clos. - Cette fonction est similaire à la fonction cubrid_disconnect. - - - - - &reftitle.parameters; - - - - conn_identifier - - - - L'identifiant de connexion CUBRID. Si l'identifiant de connexion n'est pas spécifié, - la dernière connexion ouverte avec la fonction cubrid_connect - sera utilisée. - - - - - - - - &reftitle.returnvalues; - - &true;, lorsque l'opération a été réalisée avec succès. - - - &false;, lorsque l'opération a échoué. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_close</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_disconnect - cubrid_connect - cubrid_connect_with_url - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-data-seek.xml b/reference/cubrid/cubridmysql/cubrid-data-seek.xml deleted file mode 100644 index e37a845ccb..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-data-seek.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - cubrid_data_seek - Déplace le pointeur de lignes interne du résultat CUBRID - - - - &reftitle.description; - - boolcubrid_data_seek - resourceresult - introw_number - - - Cette fonction déplace le pointeur de lignes interne du résultat CUBRID - (associé avec l'identifiant de résultat spécifié) pour pointer sur un numéro - de ligne spécifique. Il y a des fonctions, comme la fonction - cubrid_fetch_assoc, qui utilisent la valeur courante - stockée de row_number. - - - - - &reftitle.parameters; - - - result - Le résultat. - - - row_number - Numéro de ligne désiré pour le nouveau pointeur de résultat. - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, ou &false; - si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_data_seek</function> - - -]]> - - &example.outputs; - - - string(1) "X" - [1]=> - string(5) "Mixed" -} -array(2) { - [0]=> - string(1) "M" - [1]=> - string(3) "Man" -} -array(2) { - [0]=> - string(1) "S" - [1]=> - string(6) "Silver" -} -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-db-name.xml b/reference/cubrid/cubridmysql/cubrid-db-name.xml deleted file mode 100644 index 1bb6f645f9..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-db-name.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - cubrid_db_name - Récupère le nom de la base de données depuis les résultats de cubrid_list_dbs - - - - &reftitle.description; - - stringcubrid_db_name - arrayresult - intindex - - - Récupère le nom de la base de données depuis un appel à - la fonction cubrid_list_dbs. - - - - - &reftitle.parameters; - - - result - - - Le pointeur de résultat depuis un appel à la fonction - cubrid_list_dbs. - - - - - index - - - L'index dans le jeu de résultats. - - - - - - - - &reftitle.returnvalues; - - Retourne le nom de la base de données en cas de succès, - et &false; si une erreur survient. Si &false; est retourné, - utiliser la fonction cubrid_error pour - déterminer la nature de l'erreur. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_db_name</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_list_dbs - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-errno.xml b/reference/cubrid/cubridmysql/cubrid-errno.xml deleted file mode 100644 index a304beb476..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-errno.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - cubrid_errno - Retourne la valeur numérique d'un message d'erreur - - - - &reftitle.description; - - intcubrid_errno - resourceconn_identifier - - - Retourne le numéro de l'erreur issue depuis la dernière - fonction CUBRID. - - - La fonction cubrid_errno est utilisée pour récupérer - le code erreur de la dernière erreur survenue lors d'une exécution - de l'API. Habituellement, elle retourne le code erreur lorsque - l'API retourne &false;. - - - - - &reftitle.parameters; - - - conn_identifier - - - L'identifiant de connexion CUBRID. Si l'identifiant de connexion - n'est pas spécifié, la dernière connexion ouverte avec - la fonction cubrid_connect sera utilisée. - - - - - - - - &reftitle.returnvalues; - - Retourne le numéro de l'erreur issue lors de la dernière fonction CUBRID, - ou 0 (zéro) si aucune erreur n'est survenue. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_errno</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_error - cubrid_error_code - cubrid_error_msg - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-error.xml b/reference/cubrid/cubridmysql/cubrid-error.xml deleted file mode 100644 index 03f7daaae4..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-error.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - cubrid_error - Récupère le message de l'erreur - - - - &reftitle.description; - - stringcubrid_error - resourceconnection - - - La fonction cubrid_error est utilisée pour récupérer - le message de l'erreur survenue lors de l'utilisation de l'API CUBRID. - Habituellement, elle récupère le message de l'erreur lorsque l'API - retourne &false;. - - - - - &reftitle.parameters; - - - connection - La connexion CUBRID. - - - - - - &reftitle.returnvalues; - - Le message de l'erreur survenue. - - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_error</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_errno - cubrid_error_code - cubrid_error_msg - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-array.xml b/reference/cubrid/cubridmysql/cubrid-fetch-array.xml deleted file mode 100644 index dd7e4beb08..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-array.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - cubrid_fetch_array - Récupère une ligne de résultat sous forme de tableau associatif, de tableau numérique, ou les deux - - - - &reftitle.description; - - arraycubrid_fetch_array - resourceresult - inttypeCUBRID_BOTH - - - La fonction cubrid_fetch_array est utilisée pour récupérer - une seule ligne depuis le résultat de la requête et retourne - un tableau. Le curseur se déplace automatiquement sur la prochaine ligne - une fois le résultat récupéré. - - - - - &reftitle.parameters; - - - result - Le paramètre Result provient d'un - appel à la fonction cubrid_execute - - - type - Type du tableau récupéré : CUBRID_NUM, CUBRID_ASSOC, CUBRID_BOTH. - S'il est nécessaire d'utiliser un objet LOB, il est possible d'utiliser CUBRID_LOB. - - - - - - - &reftitle.returnvalues; - - Retourne un tableau de chaînes de caractères correspondant à la ligne - récupérée, lorsque l'opération a réussi. - - &false; lorsqu'il n'y a plus de ligne, - NULL lorsqu'une erreur survient. - - Le type du tableau retourné dépend de la façon dont le type a été défini. - En utilisant CUBRID_BOTH (valeur par défaut), on récupérera un tableau - contenant à la fois des indices associatifs et numériques ; il est possible de - choisir explicitement ce type via l'argument type. - La variable type peut être définie à une des - valeurs suivantes : - - CUBRID_NUM : Tableau numérique (en commençant à l'indice 0) - CUBRID_ASSOC : Tableau associatif - CUBRID_BOTH : Tableau associatif et numérique (valeur par défaut) - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_fetch_array</function> - - 10000"); - -printf("%-40s %-10s %-6s %-20s\n", "name", "area", "seats", "address"); -while ($row = cubrid_fetch_array($req, CUBRID_NUM)) { - printf("%-40s %-10s %-6s %-20s\n", $row[0], $row[1], $row[2], $row[3]); -} - -// Si vous voulez utiliser un objet LOB, vous pouvez utiliser -// cubrid_fetch_array($req, CUBRID_NUM | CUBRID_LOB) - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch - cubrid_fetch_row - cubrid_fetch_assoc - cubrid_fetch_object - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml b/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml deleted file mode 100644 index 7c7a500b42..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - cubrid_fetch_assoc - Retourne un tableau associatif correspondant à la ligne récupérée - - - - &reftitle.description; - - arraycubrid_fetch_assoc - resourceresult - inttype - - - Cette fonction retourne un tableau associatif correspondant à la ligne - récupérée, puis, déplace le pointeur de données interne sur la prochaine ligne. - La fonction retourne &false; s'il n'y a plus de résultat de disponible. - - - - - &reftitle.parameters; - - - result - Le paramètre result - provient d'un appel à la fonction cubrid_execute - - - type - Le type ne peut être que CUBRID_LOB ; ce paramètre - sera utilisé uniquement lorsqu'il est nécessaire d'utiliser un objet LOB. - - - - - - &reftitle.returnvalues; - - Un tableau associatif, en cas de succès. - - - &false; lorsqu'il n'y a plus de ligne, NULL - si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_fetch_assoc</function> - - 10000"); - -printf("%-40s %-10s %-6s %-20s\n", "name", "area", "seats", "address"); -while ($row = cubrid_fetch_assoc($req)) { - printf("%-40s %-10s %-6s %-20s\n", - $row["name"], $row["area"], $row["seats"], $row["address"]); -} - -// Si vous voulez utiliser un objet LOB, vous pouvez utiliser -// cubrid_fetch_assoc($req, CUBRID_LOB) - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch - cubrid_fetch_row - cubrid_fetch_array - cubrid_fetch_object - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-field.xml b/reference/cubrid/cubridmysql/cubrid-fetch-field.xml deleted file mode 100644 index 951cafd36d..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-field.xml +++ /dev/null @@ -1,196 +0,0 @@ - - - - - - - cubrid_fetch_field - Récupère des informations sur une colonne et les retourne sous la forme d'un objet - - - - &reftitle.description; - - objectcubrid_fetch_field - resourceresult - intfield_offset0 - - - Cette fonction retourne un objet avec certaines propriétés - d'une colonne spécifique. Les propriétés de l'objet sont : - - - - name - Nom de la colonne - - - table - Nom de la table contenant cette colonne - - - def - Valeur par défaut de la colonne - - - max_length - Longueur maximale de la colonne - - - not_null - 1 si la colonne ne peut être NULL - - - primary_key - 1 si la colonne est une clé primaire - - - unique_key - 1 si la colonne est une clé unique - - - multiple_key - 1 si la colonne est une clé non-unique - - - numeric - 1 si la colonne est de type numérique - - - blob - 1 si la colonne est de type BLOB - - - type - Le type de la colonne - - - unsigned - 1 si la colonne n'est pas signée - - - zerofill - 1 si la colonne est complétée par des zéros - - - - - - &reftitle.parameters; - - - result - Le paramètre result - provient d'un appel à la fonction cubrid_execute - - - field_offset - La position numérique du champ. Si la position - du champ n'est pas spécifiée, le prochain champ (qui n'a pas encore - été récupéré par cette fonction) est récupéré. Le paramètre - field_offset commence à zéro. - - - - - - &reftitle.returnvalues; - - Un objet avec certaines propriétés d'une colonne spécifique, - en cas de succès. - - - &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_fetch_field</function> - -name); -printf("%-30s %s\n", "table:", $field->table); -printf("%-30s \"%s\"\n", "default value:", $field->def); -printf("%-30s %d\n", "max length:", $field->max_length); -printf("%-30s %d\n", "not null:", $field->not_null); -printf("%-30s %d\n", "primary key:", $field->primary_key); -printf("%-30s %d\n", "unique key:", $field->unique_key); -printf("%-30s %d\n", "multiple key:", $field->multiple_key); -printf("%-30s %d\n", "numeric:", $field->numeric); -printf("%-30s %d\n", "blob:", $field->blob); -printf("%-30s %s\n", "type:", $field->type); -printf("%-30s %d\n", "unsigned:", $field->unsigned); -printf("%-30s %d\n", "zerofill:", $field->zerofill); - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - string(5) "20001" - [1]=> - string(5) "16681" - [2]=> - string(3) "KOR" - [3]=> - string(9) "1988-9-30" -} - ---- Propriétés des champs --- -name: athlete_code -table: game -default value: "" -max length: 0 -not null: 1 -primary key: 1 -unique key: 1 -multiple key: 0 -numeric: 1 -blob: 0 -type: integer -unsigned: 0 -zerofill: 0 -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml b/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml deleted file mode 100644 index 00e978f362..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - cubrid_fetch_lengths - Retourne un tableau contenant les longueurs des valeurs de chaque champ de la ligne courante - - - - &reftitle.description; - - arraycubrid_fetch_lengths - resourceresult - - - Cette fonction retourne un tableau numérique avec les longueurs des valeurs - de chaque champ depuis la ligne courante du jeu de résultats, ou retourne - &false; si une erreur survient. - - - - Si le type de données du champ est BLOB/CLOB, il faut utiliser - la fonction cubrid_lob_size afin d'en connaître sa longueur. - - - - - - - &reftitle.parameters; - - - result - Le paramètre result - provient d'un appel à la fonction cubrid_execute - - - - - - &reftitle.returnvalues; - - Un tableau numérique en cas de succès. - - - &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_fetch_lengths</function> - - -]]> - - &example.outputs; - - 2004 - [1] => 20085 - [2] => 15118 - [3] => 30134 - [4] => AUS - [5] => G - [6] => 2004-8-20 -) -Array -( - [0] => 4 - [1] => 5 - [2] => 5 - [3] => 5 - [4] => 3 - [5] => 1 - [6] => 10 -) -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-object.xml b/reference/cubrid/cubridmysql/cubrid-fetch-object.xml deleted file mode 100644 index af29bb96e2..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-object.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - - cubrid_fetch_object - Récupère la prochaine ligne et la retourne sous la forme d'un objet - - - - &reftitle.description; - - objectcubrid_fetch_object - resourceresult - stringclass_name - arrayparams - inttype - - - Cette fonction retourne un objet avec les noms des colonnes - du jeu de résultats comme propriétés. Les valeurs de ces propriétés - sont extraites depuis la ligne courante du jeu de résultats. - - - - - &reftitle.parameters; - - - result - Le paramètre result provient d'un - appel à la fonction cubrid_execute - - - class_name - - - Le nom de la classe à instancier, à définir les propriétés et à retourner. - Si non spécifié, un objet stdClass est retourné. - - - - - params - - - Un tableau de paramètres optionnels à passer au constructeur - de la classe class_name. - - - - - type - - - Le type ne peut être que CUBRID_LOB ; ce paramètre - sera utilisé uniquement lorsqu'il est nécessaire d'utiliser - un objet lob. - - - - - - - - &reftitle.returnvalues; - - Un objet en cas de succès. - - - &false; lorsqu'il n'y a plus de ligne, NULL si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_fetch_object</function> - -s_name = $s; - $this->f_name = $f; - } -} - -var_dump(cubrid_fetch_object($res, 'demodb_code_construct', array('s_name', 'f_name'))); - -// Si vous voulez utiliser un objet LOB, vous pouvez utiliser -// cubrid_fetch_object($res, 'demodb_code_construct', array('s_name', 'f_name'), CUBRID_LOB) - -var_dump(cubrid_fetch_object($res)); - -cubrid_close_request($res); -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - string(1) "X" - ["f_name"]=> - string(5) "Mixed" -} -object(demodb_code)#1 (2) { - ["s_name"]=> - string(1) "W" - ["f_name"]=> - string(5) "Woman" -} -object(demodb_code_construct)#1 (2) { - ["s_name"]=> - string(6) "s_name" - ["f_name"]=> - string(6) "f_name" -} -object(stdClass)#1 (2) { - ["s_name"]=> - string(1) "B" - ["f_name"]=> - string(6) "Bronze" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch - cubrid_fetch_array - cubrid_fetch_assoc - cubrid_fetch_row - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-row.xml b/reference/cubrid/cubridmysql/cubrid-fetch-row.xml deleted file mode 100644 index 89a6d62bb3..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-row.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - cubrid_fetch_row - Retourne un tableau numérique avec les valeurs de la ligne courante - - - - &reftitle.description; - - arraycubrid_fetch_row - resourceresult - inttype - - - Cette fonction retourne un tableau numérique avec les valeurs de la ligne - courante depuis le jeu de résultats, en commençant à 0 et déplace - le pointeur interne de données. - - - - - &reftitle.parameters; - - - result - Le paramètre result - provient d'un appel à la fonction cubrid_execute - - - type - Le type ne peut être que CUBRID_LOB ; ce paramètre - sera utilisé uniquement lorsqu'il est nécessaire d'utiliser un - objet lob. - - - - - - &reftitle.returnvalues; - - Un tableau numérique en cas de succès. - - - &false; lorsqu'il n'y a plus de ligne, NULL si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_fetch_row</function> - - 10000"); - -printf("%-40s %-10s %-6s %-20s\n", "name", "area", "seats", "address"); -while ($row = cubrid_fetch_row($req)) { - printf("%-40s %-10s %-6s %-20s\n", $row[0], $row[1], $row[2], $row[3]); -} - -// Si vous souhaitez utiliser un objet lob, vous pouvez utiliser -// cubrid_fetch_row($req, CUBRID_LOB) - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch - cubrid_fetch_array - cubrid_fetch_assoc - cubrid_fetch_object - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-flags.xml b/reference/cubrid/cubridmysql/cubrid-field-flags.xml deleted file mode 100644 index df3d7fb337..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-flags.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - cubrid_field_flags - Retourne une chaîne avec les drapeaux de la position du champ fourni - - - - &reftitle.description; - - stringcubrid_field_flags - resourceresult - intfield_offset - - - Cette fonction retourne une &string; avec les drapeaux de la position - du champ fourni, séparés par un espace. Il est possible d'utiliser la fonction - explode() pour récupérer chaque drapeau. Les drapeaux disponibles sont : - not_null, primary_key, - unique_key, foreign_key, - auto_increment, shared, - reverse_index, reverse_unique et - timestamp. - - - - - &reftitle.parameters; - - - result - Le paramètre result provient de - l'appel à la fonction cubrid_execute - - - field_offset - La position numérique du champ. - field_offset commence à zéro (0). Si - field_offset n'existe pas, une erreur de niveau - E_WARNING sera également émise. - - - - - - &reftitle.returnvalues; - - Une &string; avec les drapeaux, en cas de succès. - - - &false; si la valeur de field_offset est invalide. - - - -1 si la requête SQL n'est pas de type SELECT. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_field_flags</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-len.xml b/reference/cubrid/cubridmysql/cubrid-field-len.xml deleted file mode 100644 index d74216d66c..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-len.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - cubrid_field_len - Récupère la longueur maximale du champ spécifié - - - - &reftitle.description; - - intcubrid_field_len - resourceresult - intfield_offset - - - Cette fonction retourne la longueur maximale du champ spécifié en - cas de succès, ou &false; si une erreur survient. - - - - - &reftitle.parameters; - - - result - Le paramètre result provient de - l'appel à la fonction cubrid_execute - - - field_offset - La position numérique du champ. field_offset - commence à 0. Si field_offset n'existe pas, une erreur - de niveau E_WARNING sera également émise. - - - - - - &reftitle.returnvalues; - - La longueur maximale, en cas de succès. - - - &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_field_len</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-name.xml b/reference/cubrid/cubridmysql/cubrid-field-name.xml deleted file mode 100644 index b4ea1d2ead..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-name.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - cubrid_field_name - Retourne le nom du champ spécifié - - - - &reftitle.description; - - stringcubrid_field_name - resourceresult - intfield_offset - - - Cette fonction retourne le nom du champ spécifié par son index en cas - de succès, ou &false; si une erreur survient. - - - - - &reftitle.parameters; - - - result - Le paramètre result provient - de l'appel à la fonction cubrid_execute - - - field_offset - La position numérique du champ. field_offset - commence à zéro (0). Si field_offset n'existe pas, une erreur - de niveau E_WARNING sera également émise. - - - - - - &reftitle.returnvalues; - - Nom du champ spécifié par son index en cas de succès. - - - &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_field_name</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-seek.xml b/reference/cubrid/cubridmysql/cubrid-field-seek.xml deleted file mode 100644 index 5ad185430b..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-seek.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - cubrid_field_seek - Déplace le curseur du jeu de résultats à une position spécifiée - - - - &reftitle.description; - - boolcubrid_field_seek - resourceresult - intfield_offset0 - - - Cette fonction déplace le curseur du jeu de résultats à une - position spécifiée. La position est utilisée par la - fonction cubrid_fetch_field si elle n'inclut pas - une position de champ. La fonction retourne &true; en cas de succès, - &false; sinon. - - - - - &reftitle.parameters; - - - result - Le paramètre result provient - de l'appel à la fonction cubrid_execute - - - field_offset - La position numérique du champ. - field_offset commence à zéro (0). Si - field_offset n'existe pas, une erreur de niveau - E_WARNING sera également émise. - - - - - - &reftitle.returnvalues; - - &true; en cas de succès. - - - &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_field_seek</function> - -name); -printf("%-30s %s\n", "table:", $field->table); -printf("%-30s \"%s\"\n", "default value:", $field->def); -printf("%-30s %d\n", "max length:", $field->max_length); -printf("%-30s %d\n", "not null:", $field->not_null); -printf("%-30s %d\n", "unique key:", $field->unique_key); -printf("%-30s %d\n", "multiple key:", $field->multiple_key); -printf("%-30s %d\n", "numeric:", $field->numeric); -printf("%-30s %s\n", "type:", $field->type); - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - string(5) "20001" - [1]=> - string(5) "16132" - [2]=> - string(3) "KOR" - [3]=> - string(9) "1988-09-30" -} - ---- Field Properties --- -name: athlete_code -table: game -default value: "" -max length: 0 -not null: 1 -unique key: 1 -multiple key: 0 -numeric: 1 -type: integer -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-table.xml b/reference/cubrid/cubridmysql/cubrid-field-table.xml deleted file mode 100644 index 8ca9e97fa7..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-table.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - cubrid_field_table - Retourne le nom de la table d'un champ spécifié - - - - &reftitle.description; - - stringcubrid_field_table - resourceresult - intfield_offset - - - Cette fonction retourne le nom de la table d'un champ spécifié. - Ceci est utile lors de l'utilisation d'une requête SELECT volumineuse - avec des jointures. - - - - - &reftitle.parameters; - - - result - - - result provient d'un appel à cubrid_execute - - - - - field_offset - - - La position numérique du champ. field_offset - commence à zéro (0). Si field_offset n'existe pas, - une erreur de niveau E_WARNING sera également émise. - - - - - - - - &reftitle.returnvalues; - - Nom de la table du champ spécifié, en cas de succès. - - - &false; lorsque la valeur de field_offset est invalide. - - - -1 si la requête SQL n'est pas de type SELECT. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_field_table</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-type.xml b/reference/cubrid/cubridmysql/cubrid-field-type.xml deleted file mode 100644 index 16427fb98b..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-type.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - cubrid_field_type - Retourne le type de la colonne correspondant à la position du champ fourni - - - - &reftitle.description; - - stringcubrid_field_type - resourceresult - intfield_offset - - - Cette fonction retourne le type de la colonne correspondant - à la position du champ fourni. Le type du champ retourné peut être - un parmi les suivants : "int", "real", "string", etc. - - - - - &reftitle.parameters; - - - result - - - result provient d'un appel à cubrid_execute - - - - - field_offset - Position numérique du champ. Le paramètre - field_offset commence à zéro (0). Si - field_offset n'existe pas, une erreur de niveau - E_WARNING sera également émise. - - - - - - &reftitle.returnvalues; - - Le type de la colonne en cas de succès. - - - &false; Lorsque la valeur de field_offset est invalide. - - - -1 si la requête SQL n'est pas de type SELECT. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_field_type</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-list-dbs.xml b/reference/cubrid/cubridmysql/cubrid-list-dbs.xml deleted file mode 100644 index c374f49353..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-list-dbs.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - cubrid_list_dbs - Retourne un tableau contenant la liste de toutes les bases de données CUBRID existantes - - - - &reftitle.description; - - arraycubrid_list_dbs - resourceconn_identifier - - - Cette fonction retourne un tableau contenant la liste - de toutes les bases de données CUBRID existantes. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion CUBRID. - - - - - - &reftitle.returnvalues; - - Un tableau numérique contenant toutes les bases de données - CUBRID existantes en cas de succès. - - - &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_list_dbs</function> - - -]]> - - &example.outputs; - - - string(6) "demodb" -} -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-num-fields.xml b/reference/cubrid/cubridmysql/cubrid-num-fields.xml deleted file mode 100644 index 57a2d56f00..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-num-fields.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - cubrid_num_fields - Retourne le nombre de colonnes dans le jeu de résultats - - - - &reftitle.description; - - intcubrid_num_fields - resourceresult - - - Cette fonction retourne le nombre de colonnes dans le jeu de résultats - en cas de succès, ou &false; si une erreur survient. - - - - - &reftitle.parameters; - - - result - Le paramètre result provient - d'un appel à la fonction cubrid_execute, - cubrid_query ou - cubrid_prepare - - - - - - &reftitle.returnvalues; - - Nombre de colonnes en cas de succès. - - - -1 si la requête SQL n'est pas de type SELECT. - - - &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_num_fields</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-ping.xml b/reference/cubrid/cubridmysql/cubrid-ping.xml deleted file mode 100644 index 474938d363..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-ping.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - cubrid_ping - Ping une connexion au serveur ou se reconnecte s'il n'y a plus de connexion active - - - - &reftitle.description; - - boolcubrid_ping - resourceconn_identifier - - - Vérifie si la connexion au serveur est toujours active. - - - - - &reftitle.parameters; - - - conn_identifier - - - L'identifiant de connexion CUBRID. Si l'identifiant de connexion - n'est pas spécifié, la dernière connexion ouverte avec la fonction - cubrid_connect sera utilisée. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si la connexion au serveur CUBRID est active, &false; sinon. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_ping</function> - - -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-query.xml b/reference/cubrid/cubridmysql/cubrid-query.xml deleted file mode 100644 index b99f572cf8..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-query.xml +++ /dev/null @@ -1,196 +0,0 @@ - - - - - - - cubrid_query - Envoie une requête CUBRID - - - - &reftitle.description; - - resourcecubrid_query - stringquery - resourceconn_identifier - - - La fonction cubrid_query envoie une seule requête - (l'envoi de plusieurs requêtes n'est pas supporté) à la base de données - active sur le serveur associé avec le paramètre conn_identifier - fourni. - - - - - &reftitle.parameters; - - - query - - - Une requête SQL - - - Les données de la requête doivent être - proprement échappées. - - - - - conn_identifier - - - La connexion CUBRID. Si l'identifiant de connexion n'est pas - spécifié, la dernière connexion ouverte avec la fonction - cubrid_connect sera utilisée. - - - - - - - - &reftitle.returnvalues; - - Pour les requêtes de type SELECT, SHOW, DESCRIBE, EXPLAIN et autres requêtes - retournant un jeu de résultats, cubrid_query retourne - une &resource; en cas de succès, ou &false; si une erreur survient. - - - Pour les autres requêtes (INSERT, UPDATE, DELETE, DROP, etc.), - cubrid_query retourne &true; en cas de succès, ou &false; - si une erreur survient. - - - La ressource de résultats retournée doit être passée à la fonction - cubrid_fetch_array, et autres fonctions gérant - les ressources de résultats, afin d'accéder aux données retournées. - - - La fonction cubrid_num_rows permet de trouver - le nombre de lignes retournées par une requête SELECT ou la fonction - cubrid_affected_rows afin de savoir le nombre - de lignes affectées par une requête DELETE, INSERT, REPLACE, ou UPDATE. - - - La fonction cubrid_query échoue et retourne &false; - si l'utilisateur n'a pas l'autorisation d'accéder à la table utilisée dans - la requête. - - - - - &reftitle.examples; - - Requête invalide - - La requête suivante n'est littéralement pas valide, aussi, la fonction - cubrid_query échoue et retourne &false;. - - - -]]> - - - - Requête valide - - La requête suivante est valide, aussi, la fonction - cubrid_query retourne une ressource. - - - -]]> - - - - - - &reftitle.seealso; - - cubrid_connect - cubrid_error - cubrid_real_escape_string - cubrid_result - cubrid_fetch_assoc - cubrid_unbuffered_query - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml b/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml deleted file mode 100644 index f0ea881f52..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - cubrid_real_escape_string - Échappe les caractères spéciaux d'une chaîne pour l'utiliser dans une requête SQL - - - - &reftitle.description; - - stringcubrid_real_escape_string - stringunescaped_string - resourceconn_identifier - - - Cette fonction retourne la version échappée de la chaîne fournie. Elle ajoute - des antislashes aux caractères suivants : '. - - En général, les guillemets simples sont utilisés pour entourer - la chaîne. Les doubles guillemets peuvent être utilisés également suivant - la valeur d'ansi_quotes, qui est un paramètre des requêtes SQL. Si la - valeur d'ansi_quotes est "no", les guillemets doubles - seront gérés comme un caractère de la chaîne et non un identifiant. - La valeur par défaut est "yes". - - Si l'on veut inclure un guillemet simple comme caractère d'une chaîne, - il faut le spécifier 2 fois. - - - - - &reftitle.parameters; - - - unescaped_string - La &string; à échapper. - - - conn_identifier - L'identifiant de connexion CUBRID. Si l'identifiant de - connexion n'est pas spécifié, la dernière connexion ouverte avec la - fonction cubrid_connect sera utilisée. - - - - - - &reftitle.returnvalues; - - La version échappée de la &string; fournie en cas de succès. - - - &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_real_escape_string</function> - -?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~'; -$escaped_str = cubrid_real_escape_string($unescaped_str); - -$len = strlen($unescaped_str); - -@cubrid_execute($conn, "DROP TABLE cubrid_test"); -cubrid_execute($conn, "CREATE TABLE cubrid_test (t char($len))"); -cubrid_execute($conn, "INSERT INTO cubrid_test (t) VALUES('$escaped_str')"); - -$req = cubrid_execute($conn, "SELECT * FROM cubrid_test"); -$row = cubrid_fetch_assoc($req); - -var_dump($row); - -cubrid_close_request($req); -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - string(95) " !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~" -} -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-result.xml b/reference/cubrid/cubridmysql/cubrid-result.xml deleted file mode 100644 index f4af1cd8ae..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-result.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - cubrid_result - Retourne la valeur d'un champ d'une ligne spécifique - - - - &reftitle.description; - - stringcubrid_result - resourceresult - introw - mixedfield0 - - - Cette fonction retourne la valeur d'un champ spécifique d'une ligne - spécifique depuis un jeu de résultats. - - - - - &reftitle.parameters; - - - result - Le paramètre result provient d'un - appel à la fonction cubrid_execute - - - row - - Le numéro de la ligne depuis le résultat à récupérer. Ce numéro commence à partir de 0. - - - field - Le nom ou la position du champ field - à récupérer. Ce peut être la position du champ, son nom, ou le nom de la table suivi - d'un point, suivi du nom du champ (tablename.fieldname). Si le nom de la colonne - est un alias ('select foo as bar from...'), utiliser l'alias au lieu du nom - de la colonne. Si non défini, le premier champ sera récupéré. - - - - - - &reftitle.returnvalues; - - La valeur du champ spécifié en cas de succès (&null; - si la valeur est &null;). - - - &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_result</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml b/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml deleted file mode 100644 index 070955e034..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - cubrid_unbuffered_query - Exécute une requête sans placer les résultats en mémoire vive - - - - &reftitle.description; - - resourcecubrid_unbuffered_query - stringquery - resourceconn_identifier - - - Cette fonction exécute une requête sans attendre que tous les résultats - aient été récupérés. La fonction retournera lorsque les résultats seront - générés. - - - - - &reftitle.parameters; - - - query - Une requête SQL. - - - conn_identifier - - - Identifiant de connexion. Si non fourni, la dernière - connexion ouverte avec la fonction cubrid_connect - sera utilisée. - - - - - - - - &reftitle.returnvalues; - - Pour les requêtes de type SELECT, SHOW, DESCRIBE ou EXPLAIN, la fonction - retournera une ressource d'identifiant de requête en cas de succès. - - - Pour les autres types de requêtes SQL (UPDATE, DELETE, DROP, etc.), la - fonction retournera &true; en cas de succès. - - - &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_unbuffered_query</function> - - -]]> - - - - - - &reftitle.notes; - - - Les bénéfices de la fonction cubrid_unbuffered_query - ont un prix : il n'est pas possible d'utiliser cubrid_num_rows - et cubrid_data_seek sur le jeu de résultats retourné depuis - cubrid_unbuffered_query. - - - - - - diff --git a/reference/cubrid/examples.xml b/reference/cubrid/examples.xml deleted file mode 100644 index ad86640d63..0000000000 --- a/reference/cubrid/examples.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - &reftitle.examples; - - Ce qui suit est un simple exemple qui établit une connexion - entre PHP et CUBRID. Cette section expose les fonctions les - plus basiques et utiles. Le code suivant nécessite une - connexion à la base de données CUBRID, ce qui signifie que le - serveur CUBRID ainsi que le courtier CUBRID doivent être en - fonctionnement. - - - L'exemple ci-dessous utilise la base de données demodb - comme exemple. Par défaut, elle est créée durant l'installation. - Il faut s'assurer que c'est bien le cas. - - - Exemple de récupération de données - - - - - - -
- - - "; - - while (list($key, $colname) = each($columns)) { - echo ""; - } - - echo ""; - - /** - * Récupère les résultats depuis le jeu de résultats. - */ - while ($row = cubrid_fetch($result)) { - echo ""; - - for ($i = 0; $i < $num_fields; $i++) { - echo ""; - } - - echo ""; - } - } - /** - * Le module PHP dans CUBRID fonctionne en architecture 3 parties. - * Lors de l'appel à une requête de type SELECT dans une transaction, elle - * sera exécutée comme faisant partie de la transaction. Aussi, si la - * transaction est annulée avant l'appel à la requête SELECT, elle sera - * exécutée avec des performances moindres. - */ - cubrid_commit($cubrid_con); - cubrid_disconnect($cubrid_con); - ?> - - - ]]> - - - - Exemple d'insertion de données - - - - - - -
-
$colname
"; - echo $row[$i]; - echo "
- - - - - ]]> - - - - diff --git a/reference/cubrid/functions/cubrid-bind.xml b/reference/cubrid/functions/cubrid-bind.xml deleted file mode 100644 index 62c17e71da..0000000000 --- a/reference/cubrid/functions/cubrid-bind.xml +++ /dev/null @@ -1,351 +0,0 @@ - - - - - - - cubrid_bind - Lie des valeurs à une requête préparée - - - - &reftitle.description; - - boolcubrid_bind - resourcereq_identifier - intbind_index - mixedbind_value - stringbind_value_type - - - La fonction cubrid_bind est utilisée pour lier - les valeurs à un marqueur correspondant, nommé ou non d'une requête SQL - qui a été passée à la fonction cubrid_prepare. - Si le paramètre bind_value_type n'est pas fourni, - le type &string; sera le type par défaut. - - - - Si le type de données à lier est BLOB/CLOB, CUBRID tentera de lier - les données comme un flux PHP. Si le type de la valeur à lier n'est - pas un flux, CUBRID la convertira en chaîne, et l'utilisera comme - chemin complet et nom de fichier sur le système de fichiers client. - - - Si le type de données à lier explicitement est ENUM, l'argument - bind_value doit être l'élément ENUM sous forme de chaîne de caractères. - - - En environnement partagé CUBRID, bind_value_type doit être inclus - dans la fonction cubrid_bind. - - - - La liste suivante montre les types des valeurs substituées. - -
- Types de données liées CUBRID - - - - Support - Type de liage - Type correspondant SQL - - - - - Supporté - STRING - CHAR, VARCHAR - - - - NCHAR - NCHAR, NVARCHAR - - - - BIT - BIT, VARBIT - - - - NUMERIC or NUMBER - SHORT, INT, NUMERIC - - - - FLOAT - FLOAT - - - - DOUBLE - DOUBLE - - - - TIME - TIME - - - - DATE - DATE - - - - TIMESTAMP - TIMESTAMP - - - - OBJECT - OBJECT - - - - ENUM - ENUM - - - - BLOB - BLOB - - - - CLOB - CLOB - - - - NULL - NULL - - - Non supporté - SET - SET - - - - MULTISET - MULTISET - - - - SEQUENCE - SEQUENCE - - - -
- - - - &reftitle.parameters; - - - - req_identifier - - - - Identifiant de requête, retourné par la fonction - cubrid_prepare. - - - - - - bind_index - - - - Position des paramètres liés. Commence avec 1. - - - - - - bind_value - - - - Valeur effective à lier. - - - - - - bind_value_type - - - - Un type de valeur à lier (il est omis par défaut et en interne, - le type &string; sera utilisé. Cependant, il faut spécifier - le type exact de la valeur comme argument lorsque l'on utilise NCHAR, - BIT, ou BLOB/CLOB). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.3.1 - - Ajout du support des types BLOB/CLOB. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_bind</function> - - -]]> - - &example.outputs; - - - - - - - Exemple avec <function>cubrid_bind</function> et les types BLOB/CLOB - - -]]> - - - - - Exemple avec <function>cubrid_bind</function> et BLOB/CLOB - - -]]> - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_prepare - - - - diff --git a/reference/cubrid/functions/cubrid-close-prepare.xml b/reference/cubrid/functions/cubrid-close-prepare.xml deleted file mode 100644 index b7a2d4ca84..0000000000 --- a/reference/cubrid/functions/cubrid-close-prepare.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - cubrid_close_prepare - Ferme le gestionnaire de requête - - - - &reftitle.description; - - boolcubrid_close_prepare - resourcereq_identifier - - - La fonction cubrid_close_prepare ferme le gestionnaire - de requête fourni par l'argument req_identifier et libère - la région mémoire associée. C'est un alias de la fonction cubrid_close_request. - - - - - &reftitle.parameters; - - - - req_identifier - - - - Identifiant de requête. - - - - - - - - &reftitle.returnvalues; - - &true; en cas de succès. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_close_prepare</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_close_request - - - - diff --git a/reference/cubrid/functions/cubrid-close-request.xml b/reference/cubrid/functions/cubrid-close-request.xml deleted file mode 100644 index 191f1b4c2b..0000000000 --- a/reference/cubrid/functions/cubrid-close-request.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - cubrid_close_request - Ferme le gestionnaire de requête - - - - &reftitle.description; - - boolcubrid_close_request - resourcereq_identifier - - - La fonction cubrid_close_request ferme le gestionnaire de requête - fourni par l'argument req_identifier et libère - la mémoire associée. C'est un alias de la fonction cubrid_close_prepare. - - - - - &reftitle.parameters; - - - - req_identifier - - - - Identifiant de requête. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_close_request</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_close_prepare - - - - diff --git a/reference/cubrid/functions/cubrid-col-get.xml b/reference/cubrid/functions/cubrid-col-get.xml deleted file mode 100644 index fb0d3af409..0000000000 --- a/reference/cubrid/functions/cubrid-col-get.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - cubrid_col_get - Récupère le contenu des éléments d'un type de collection en utilisant l'OID - - - - &reftitle.description; - - arraycubrid_col_get - resourceconn_identifier - stringoid - stringattr_name - - - La fonction cubrid_col_get est utilisée pour récupérer le contenu - des attributs des éléments d'un type de collection (set, multiset, sequence), - sous la forme d'un &array;. - - - - - &reftitle.parameters; - - - - conn_identifier - - - - Identifiant de connexion. - - - - - - oid - - - - OID de l'instance à utiliser pour la lecture. - - - - - - attr_name - - - - Nom de l'attribut que l'on veut lire depuis l'instance. - - - - - - - - - &reftitle.returnvalues; - - Un &array; (numérique, commençant à 0) contenant les éléments - voulus lorsque l'opération a été réalisée avec succès. - - - &false; (afin de distinguer les erreurs et le fait que les attributs ont une - collection vide ou nul ; en cas d'erreur, un message d'alerte sera affiché ; - dans ce cas, il est possible de récupérer l'erreur en utilisant la fonction - cubrid_error_code), lorsque l'opération a échoué. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_col_get</function> - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -int(3) -]]> - - - - - diff --git a/reference/cubrid/functions/cubrid-col-size.xml b/reference/cubrid/functions/cubrid-col-size.xml deleted file mode 100644 index 098c580f51..0000000000 --- a/reference/cubrid/functions/cubrid-col-size.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - cubrid_col_size - Récupère le nombre d'éléments dans un type de colonne d'une collection en utilisant l'OID - - - - &reftitle.description; - - intcubrid_col_size - resourceconn_identifier - stringoid - stringattr_name - - - La fonction cubrid_col_size est utilisée - pour récupérer le nombre d'éléments dans un attribut de type de collection - (set, multiset, sequence). - - - - - &reftitle.parameters; - - - - conn_identifier - - - - Un identifiant de connexion. - - - - - - oid - - - - OID de l'instance à utiliser. - - - - - - attr_name - - - - Nom de l'attribut à utiliser. - - - - - - - - &reftitle.returnvalues; - - Nombre d'éléments, lorsque l'opération est un succès,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.3.1 - - Modification de la valeur retournée : lorsque l'opération échoue, - la fonction retourne maintenant &false; au lieu de -1. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_col_size</function> - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -int(3) -]]> - - - - - diff --git a/reference/cubrid/functions/cubrid-column-names.xml b/reference/cubrid/functions/cubrid-column-names.xml deleted file mode 100644 index 6c18a2ed04..0000000000 --- a/reference/cubrid/functions/cubrid-column-names.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - cubrid_column_names - Récupère les noms de colonnes du résultat - - - - &reftitle.description; - - arraycubrid_column_names - resourcereq_identifier - - - La fonction cubrid_column_names est utilisée pour - récupérer les noms de colonnes du résultat de la requête en - utilisant le paramètre req_identifier. - - - - - &reftitle.parameters; - - - - req_identifier - - - - Identifiant de requête. - - - - - - - - &reftitle.returnvalues; - - Un tableau de chaînes de caractères contenant les noms des colonnes lorsque - l'opération est un succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_column_names</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_prepare - cubrid_execute - cubrid_column_types - - - - - diff --git a/reference/cubrid/functions/cubrid-column-types.xml b/reference/cubrid/functions/cubrid-column-types.xml deleted file mode 100644 index 63004f04b9..0000000000 --- a/reference/cubrid/functions/cubrid-column-types.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - cubrid_column_types - Récupère les types de colonnes du résultat - - - - &reftitle.description; - - arraycubrid_column_types - resourcereq_identifier - - - La fonction cubrid_column_types récupère les types - de colonnes du résultat de la requête en utilisant le paramètre - req_identifier. - - - - - &reftitle.parameters; - - - - req_identifier - - - - Identifiant de requête. - - - - - - - - &reftitle.returnvalues; - - Un tableau de chaînes de caractères contenant les types de colonnes, - lorsque l'opération est un succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_column_types</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_column_names - cubrid_prepare - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-commit.xml b/reference/cubrid/functions/cubrid-commit.xml deleted file mode 100644 index 48d5c76a37..0000000000 --- a/reference/cubrid/functions/cubrid-commit.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - cubrid_commit - Valide une transaction - - - - &reftitle.description; - - boolcubrid_commit - resourceconn_identifier - - La fonction cubrid_commit est utilisée pour valider une - transaction pointée par le paramètre conn_identifier. - La connexion au serveur sera fermée après l'appel à la fonction - cubrid_commit ; cependant, le gestionnaire de connexion - restera valide. - - - En CUBRID PHP, le mode auto-commit est désactivé par défaut - pour la gestion des transactions. Il est possible de définir - en utilisant la fonction cubrid_set_autocommit. - Il est possible de récupérer son statut en utilisant la fonction - cubrid_get_autocommit. Avant de commencer une - transaction, il ne faut pas oublier de désactiver le mode auto-commit. - - - - - &reftitle.parameters; - - - - conn_identifier - - - - Identifiant de connexion. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_commit</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_rollback - cubrid_get_autocommit - cubrid_set_autocommit - - - - diff --git a/reference/cubrid/functions/cubrid-connect-with-url.xml b/reference/cubrid/functions/cubrid-connect-with-url.xml deleted file mode 100644 index 6e4dfcb04c..0000000000 --- a/reference/cubrid/functions/cubrid-connect-with-url.xml +++ /dev/null @@ -1,251 +0,0 @@ - - - - - - - cubrid_connect_with_url - Établit l'environnement pour une connexion au serveur CUBRID - - - - &reftitle.description; - - resourcecubrid_connect_with_url - stringconn_url - stringuserid - stringpasswd - boolnew_link&false; - - - La fonction cubrid_connect_with_url est utilisée pour préparer - l'environnement pour la connexion au serveur en utilisant les informations de connexion - passées avec des arguments dans l'URL. Si la fonctionnalité HA est active pour CUBRID, - il faut spécifier les informations de connexion du serveur de secours, qui sera utilisé - comme backup lorsqu'une erreur survient. Si le nom d'utilisateur et le mot de passe - ne sont pas fournis, alors la connexion "PUBLIC" sera établie par défaut. - - - <url> ::= CUBRID:<host>:<db_name>:<db_user>:<db_password>:[?<properties>] - - - <properties> ::= <property> [&<property>] - - - <properties> ::= alhosts=<alternative_hosts>[ &rctime=<time>] - - - <properties> ::= login_timeout=<milli_sec> - - - <properties> ::= query_timeout=<milli_sec> - - - <properties> ::= disconnect_on_query_timeout=true|false - - - <alternative_hosts> ::= <standby_broker1_host>:<port> [,<standby_broker2_host>:<port>] - - - <host> := HOSTNAME | IP_ADDR - - - <time> := SECOND - - - <milli_sec> := MILLI SECOND - - - host : Un nom d'hôte ou une adresse IP vers la base de données principale - db_name : Un nom de base de données - db_user : Un nom d'utilisateur pour la base de données - db_password : Le mot de passe associé à l'utilisateur - - alhosts : spécifie le courtier d'information pour le serveur de secours, - qui sera utilisé comme backup lorsqu'il devient impossible de se connecter au - serveur courant. Il est possible de spécifier plusieurs courtiers comme backup et la connexion - aux courtiers se fera dans l'ordre d'alhosts - - - rctime : un intervalle pendant lequel il sera tenté de se connecter - au courtier actif lorsqu'une erreur survient. Après qu'une erreur est survenue, - le système se connecte au courtier spécifié par althosts, met fin à la transaction, - et tente une connexion au courtier actif de la base de données principale à chaque - intervalle rctime. La valeur par défaut est 600 secondes. - - - login_timeout : Valeur du délai maximal d'attente (unité : milliseconde) pour l'identification - à la base de données. Par défaut, cette valeur vaut 0, ce qui signifie que l'on attend - indéfiniment. - - - query_timeout : Valeur du délai maximal d'attente (unité : milliseconde) pour l'exécution - de la requête. Une fois cette valeur atteinte, un message pour annuler la requête en cours - est envoyé au serveur. La valeur retournée peut dépendre de la configuration - de disconnect_on_query_timeout ; même si le message pour annuler - la requête a été envoyé au serveur, la requête peut réussir. - - - disconnect_on_query_timeout : Configure une valeur déterminant si l'on doit retourner - immédiatement une erreur pour les fonctions exécutées après le délai maximal d'attente. - La valeur par défaut est &false;. - - - - - Les caractères ? et : - utilisés comme identifiants dans les URLs de connexion PHP ne peuvent - être inclus dans le mot de passe. Voici un exemple de mot de passe - invalide, car utilisant les caractères "?:" dans l'URL de connexion. - - - $url = "CUBRID:localhost:33000:tdb:dba:12?:?login_timeout=100"; - - - Les mots de passe contenant le caractère ? ou le - caractère : peuvent être passés en tant que paramètre séparé. - - - $url = "CUBRID:localhost:33000:tbd:::?login_timeout=100"; - - - $conn = cubrid_connect_with_url($url, "dba", "12?"); - - - Si le nom d'utilisateur ou le mot de passe est vide, l'on ne doit - pas supprimer les ":" ; voici un exemple : - - - $url = "CUBRID:localhost:33000:demodb:::"; - - - - - - &reftitle.parameters; - - - conn_url - Une &string; contenant les informations de connexion au serveur. - - - userid - Le nom d'utilisateur de la base de données. - - - passwd - Le mot de passe de l'utilisateur. - - - new_link - - - Si un second appel est effectué à la fonction - cubrid_connect_with_url avec les mêmes arguments, - aucune nouvelle connexion ne sera établie, et l'identifiant de la - connexion déjà ouverte sera retourné à la place. Le paramètre - new_link modifie ce comportement et fera que la fonction - cubrid_connect_with_url ouvre toujours une nouvelle - connexion, y compris si la fonction cubrid_connect_with_url - a déjà été appelée avec les mêmes arguments. - - - - - - - - &reftitle.returnvalues; - - Identifiant de connexion, en cas de succès, &return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_connect_with_url</function> - - -]]> - - - - - Exemple avec <function>cubrid_connect_with_url</function> - - -]]> - - - - - - - &reftitle.seealso; - - cubrid_connect - cubrid_pconnect - cubrid_pconnect_with_url - cubrid_disconnect - cubrid_close - - - - - diff --git a/reference/cubrid/functions/cubrid-connect.xml b/reference/cubrid/functions/cubrid-connect.xml deleted file mode 100644 index 20eb3e989d..0000000000 --- a/reference/cubrid/functions/cubrid-connect.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - cubrid_connect - Ouvre une connexion au serveur CUBRID - - - - &reftitle.description; - - resourcecubrid_connect - stringhost - intport - stringdbname - stringuserid - stringpasswd - boolnew_link&false; - - - La fonction cubrid_connect est utilisée pour - établir l'environnement pour une connexion au serveur en utilisant - l'adresse du serveur, le numéro du port, le nom de la base de données, - le nom d'utilisateur et son mot de passe. Si le nom d'utilisateur et - le mot de passe ne sont pas fournis, alors une connexion "PUBLIC" - sera effectuée par défaut. - - - - - &reftitle.parameters; - - - host - Nom d'hôte ou adresse IP du serveur CUBRID CAS. - - - port - Numéro du port du serveur CUBRID CAS (BROKER_PORT est configuré dans le fichier $CUBRID/conf/cubrid_broker.conf). - - - dbname - Nom de la base de données. - - - userid - Nom d'utilisateur pour la base de données. - Si non fourni, la valeur par défaut est "public". - - - - passwd - Mot de passe pour l'utilisateur. - Si non fourni, la valeur par défaut est "". - - - new_link - - Si un second appel est effectué à la fonction - cubrid_connect avec les mêmes arguments, - aucune nouvelle connexion ne sera établie, et l'identifiant de la - connexion déjà ouverte sera retourné à la place. Le paramètre - new_link modifie ce comportement et fera que la fonction - cubrid_connect ouvre toujours une nouvelle - connexion, y compris si la fonction cubrid_connect - a déjà été appelée avec les mêmes arguments. - - - - - - &reftitle.returnvalues; - - Un identifiant de connexion, lorsque l'opération a été réalisée avec succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_connect</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_pconnect - cubrid_connect_with_url - cubrid_pconnect_with_url - cubrid_disconnect - cubrid_close - - - - - diff --git a/reference/cubrid/functions/cubrid-current-oid.xml b/reference/cubrid/functions/cubrid-current-oid.xml deleted file mode 100644 index 524f4068fb..0000000000 --- a/reference/cubrid/functions/cubrid-current-oid.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - cubrid_current_oid - Récupère l'OID de la localisation du curseur courant - - - - &reftitle.description; - - stringcubrid_current_oid - resourcereq_identifier - - - La fonction cubrid_current_oid est utilisée pour récupérer - l'OID de la localisation du curseur courant. Pour utiliser la fonction - cubrid_current_oid, la requête exécutée doit être une - requête de mise à jour, et l'option CUBRID_INCLUDE_OID doit être incluse - lors de l'exécution de la requête. - - - - - &reftitle.parameters; - - - - req_identifier - - - - Identifiant de requête. - - - - - - - - &reftitle.returnvalues; - - OID de la localisation du curseur courant, lorsque l'opération est un succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_current_oid</function> - - -]]> - - &example.outputs; - - X - [f_name] => Mixed -) -]]> - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-disconnect.xml b/reference/cubrid/functions/cubrid-disconnect.xml deleted file mode 100644 index b79150424c..0000000000 --- a/reference/cubrid/functions/cubrid-disconnect.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - cubrid_disconnect - Ferme la connexion à la base de données - - - - &reftitle.description; - - boolcubrid_disconnect - resourceconn_identifier - - - La fonction cubrid_disconnect ferme le gestionnaire de connexion - et se déconnecte du serveur. S'il existe des gestionnaires de requêtes non fermés, - à ce moment là, ils le seront. Cette fonction est similaire à - la fonction cubrid_close. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_disconnect</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_close - cubrid_connect - cubrid_connect_with_url - - - - - diff --git a/reference/cubrid/functions/cubrid-drop.xml b/reference/cubrid/functions/cubrid-drop.xml deleted file mode 100644 index a612214504..0000000000 --- a/reference/cubrid/functions/cubrid-drop.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - - cubrid_drop - Supprime une instance en utilisant son OID - - - - &reftitle.description; - - boolcubrid_drop - resourceconn_identifier - stringoid - - - La fonction cubrid_drop est utilisée pour supprimer une - instance de la base de données en utilisant le paramètre oid - de l'instance. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - Oid de l'instance que l'on veut supprimer. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_drop</function> - - -]]> - - &example.outputs; - - - string(1) "1" - ["b"]=> - array(3) { - [0]=> - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" - } - ["c"]=> - array(4) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" - } - ["d"]=> - string(10) "a " -} - ---- After Drop: --- -array(4) { - ["a"]=> - string(1) "2" - ["b"]=> - array(3) { - [0]=> - string(1) "4" - [1]=> - string(1) "5" - [2]=> - string(1) "7" - } - ["c"]=> - array(4) { - [0]=> - string(2) "44" - [1]=> - string(2) "55" - [2]=> - string(2) "66" - [3]=> - string(3) "666" - } - ["d"]=> - string(10) "b " -} -]]> - - - - - - &reftitle.seealso; - - cubrid_is_instance - - - - - diff --git a/reference/cubrid/functions/cubrid-error-code-facility.xml b/reference/cubrid/functions/cubrid-error-code-facility.xml deleted file mode 100644 index 4dcec6d931..0000000000 --- a/reference/cubrid/functions/cubrid-error-code-facility.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - cubrid_error_code_facility - Récupère le niveau du code erreur - - - - &reftitle.description; - - intcubrid_error_code_facility - - - - La fonction cubrid_error_code_facility est utilisée - pour récupérer le niveau du code erreur (niveau dans lequel l'erreur est survenue) - depuis le code erreur d'une erreur survenue lors de l'exécution de l'API. - Habituellement, il est possible de récupérer le code erreur lorsque l'API retourne - &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le niveau du code d'erreur survenue : CUBRID_FACILITY_DBMS, CUBRID_FACILITY_CAS, CUBRID_FACILITY_CCI, CUBRID_FACILITY_CLIENT. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_error_code_facility</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_error_code - cubrid_error_msg - - - - - diff --git a/reference/cubrid/functions/cubrid-error-code.xml b/reference/cubrid/functions/cubrid-error-code.xml deleted file mode 100644 index c3678defd3..0000000000 --- a/reference/cubrid/functions/cubrid-error-code.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - cubrid_error_code - Récupère le code erreur de la dernière erreur survenue - - - - &reftitle.description; - - intcubrid_error_code - - - - La fonction cubrid_error_code est utilisée pour récupérer le code - erreur survenue lors de l'exécution de l'API. Habituellement, elle récupère - le code erreur lorsque l'API retourne &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le code erreur de la dernière erreur survenue, ou 0 (zéro) - si aucune erreur n'est survenue. - - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_error_code</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_error_code_facility - cubrid_error_msg - - - - - diff --git a/reference/cubrid/functions/cubrid-error-msg.xml b/reference/cubrid/functions/cubrid-error-msg.xml deleted file mode 100644 index ccb1a906ad..0000000000 --- a/reference/cubrid/functions/cubrid-error-msg.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - cubrid_error_msg - Récupère le message d'erreur de la dernière erreur survenue - - - - &reftitle.description; - - stringcubrid_error_msg - - - - La fonction cubrid_error_msg est utilisée pour récupérer - le message d'erreur survenu lors de l'utilisation de l'API CUBRID. Habituellement, - elle récupère le message d'erreur lorsque l'API retourne &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le message d'erreur survenu. - - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_error_msg</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - cubrid_error_code - cubrid_error_code_facility - - - - - diff --git a/reference/cubrid/functions/cubrid-execute.xml b/reference/cubrid/functions/cubrid-execute.xml deleted file mode 100644 index 3f8e71a225..0000000000 --- a/reference/cubrid/functions/cubrid-execute.xml +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - - cubrid_execute - Exécute une requête SQL préparée - - - - &reftitle.description; - - resourcecubrid_execute - resourceconn_identifier - stringsql - intoption0 - - - boolcubrid_execute - resourcerequest_identifier - intoption0 - - - La fonction cubrid_execute est utilisée pour exécuter - une requête SQL. Elle exécute la requête en utilisant le paramètre - conn_identifier et SQL, puis, retourne l'identifiant - de requête créé. Elle est utilisée pour une exécution simple de requête, - où le liage de paramètre n'est pas nécessaire. De plus, la fonction - cubrid_execute est utilisée pour exécuter la requête - préparée en utilisant cubrid_prepare et cubrid_bind. - À ce point, il faut spécifier les arguments - request_identifier et option. - - - L'option est utilisée pour déterminer si l'on doit - récupérer l'OID après l'exécution de la requête, et si l'on doit exécuter - la requête en mode asynchrone ou non. CUBRID_INCLUDE_OID et CUBRID_ASYNC - (ou CUBRID_EXEC_QUERY_ALL si l'on veut exécuter plusieurs requêtes SQL) - peuvent être spécifiés en utilisant l'opérateur OR bit à bit. Si l'opérateur n'est - pas spécifié, aucun des deux ne sera sélectionné. Si le drapeau - CUBRID_EXEC_QUERY_ALL est défini, le mode synchrone (sync_mode) sera - utilisé pour récupérer les résultats de la requête, et dans un tel cas, - les règles suivantes seront appliquées : - - - La valeur retournée sera le résultat de la première requête. - - Si une erreur survient dans une des requêtes, l'exécution sera vue comme - étant un échec. - - - Pour une requête composée de q1 q2 et q3, si une erreur survient dans q2 - alors que q1 a été exécutée avec succès, le résultat de q1 reste valide. - Ainsi, l'exécution avec succès d'une précédente requête ne sera pas annulée - lorsqu'une erreur survient. - - - Si une requête est exécutée avec succès, le résultat de la seconde requête - peut être obtenu en utilisant la fonction cubrid_next_result. - - - - Si le premier paramètre est request_identifier pour - exécuter la fonction cubrid_prepare, il est possible de spécifier - une option, CUBRID_ASYNC uniquement. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - sql - SQL à exécuter. - - - option - Option d'exécution de la requête : CUBRID_INCLUDE_OID, CUBRID_ASYNC, CUBRID_EXEC_QUERY_ALL. - - - request_identifier - Identifiant de requête pour la fonction cubrid_prepare. - - - - - - &reftitle.returnvalues; - - Un identifiant de requête, lorsque l'opération a été réalisée avec succès et - que le premier paramètre est l'identifiant de connexion ; &true;, lorsque - l'opération a été réalisée avec succès et que le premier paramètre est - l'identifiant de requête,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.4.0 - - Ajout d'une nouvelle option : CUBRID_EXEC_QUERY_ALL. - - - - - - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_execute</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_prepare - cubrid_bind - cubrid_next_result - cubrid_close_request - cubrid_commit - cubrid_rollback - - - - - diff --git a/reference/cubrid/functions/cubrid-fetch.xml b/reference/cubrid/functions/cubrid-fetch.xml deleted file mode 100644 index a18a88ca97..0000000000 --- a/reference/cubrid/functions/cubrid-fetch.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - cubrid_fetch - Récupère la prochaine ligne du jeu de résultats - - - - &reftitle.description; - - mixedcubrid_fetch - resourceresult - inttypeCUBRID_BOTH - - - La fonction cubrid_fetch est utilisée - pour récupérer une seule ligne depuis le résultat de la - requête. Le curseur se déplace automatiquement sur la prochaine - ligne une fois la récupération effectuée. - - - - - &reftitle.parameters; - - - result - Le paramètre result - provient de l'appel à la fonction cubrid_execute - - - type - Type du tableau à retourner : CUBRID_NUM, CUBRID_ASSOC, CUBRID_BOTH, CUBRID_OBJECT. - Si l'on veut utiliser un objet LOB, il est possible d'utiliser CUBRID_LOB. - - - - - - - &reftitle.returnvalues; - - Tableau ou objet de résultat, en cas de succès. - - - &false; lorsqu'il n'y a plus de ligne de disponible, NULL - si une erreur survient. - - - Le résultat peut être sous la forme d'un tableau ou d'un objet ; - le type de résultat peut être défini grâce au paramètre type. - La variable type peut être définie à une - des valeurs suivantes : - - - CUBRID_NUM : Tableau numérique (en commençant à l'indice 0) - CUBRID_ASSOC : Tableau associatif - CUBRID_BOTH : Tableau numérique et associatif (valeur par défaut) - CUBRID_OBJECT : Objet dont les noms des attributs correspondent - aux noms des colonnes du résultat de la requête - - - Lorsque l'argument type est omis, le résultat - sera retourné en utilisant l'option CUBRID_BOTH par défaut. Lorsque l'on - veut recevoir le résultat de la requête sous la forme d'un objet, le nom - de la colonne du résultat doit être conforme aux règles de nommage des - identifiants en PHP. Par exemple, les noms de colonnes comme "count(*)" - ne peuvent être acceptés dans le type objet. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_fetch</function> - - 10000"); - -printf("%-40s %-10s %-6s %-20s\n", "name", "area", "seats", "address"); -while ($row = cubrid_fetch($req)) { - printf("%-40s %-10s %-6s %-20s\n", - $row["name"], $row["area"], $row["seats"], $row["address"]); -} - -// Si vous voulez utiliser un objet LOB, vous pouvez utiliser -// cubrid_fetch($req, CUBRID_LOB) - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch_array - cubrid_fetch_row - cubrid_fetch_assoc - cubrid_fetch_object - - - - - diff --git a/reference/cubrid/functions/cubrid-free-result.xml b/reference/cubrid/functions/cubrid-free-result.xml deleted file mode 100644 index 12ca426695..0000000000 --- a/reference/cubrid/functions/cubrid-free-result.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - cubrid_free_result - Libère la mémoire occupée par les données de résultat - - - - &reftitle.description; - - boolcubrid_free_result - resourcereq_identifier - - - Cette fonction libère la mémoire occupée par les données - de résultat. Elle retourne &true; en cas de succès, &false; sinon. - Il est à noter que cette fonction ne libère que le buffer de récupération - du client, et que si l'on veut libérer toute la mémoire, - il faut utiliser la fonction cubrid_close_request. - - - - - &reftitle.parameters; - - - req_identifier - Identifiant de requête. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_free_result</function> - - -]]> - - &example.outputs; - - - string(5) "20005" - ["athlete"]=> - string(12) "Hayes Joanna" - ["host_year"]=> - string(4) "2004" - ["score"]=> - string(5) "12.37" - ["unit"]=> - string(4) "time" -} -]]> - - - - - - diff --git a/reference/cubrid/functions/cubrid-get-autocommit.xml b/reference/cubrid/functions/cubrid-get-autocommit.xml deleted file mode 100644 index 02f8db1904..0000000000 --- a/reference/cubrid/functions/cubrid-get-autocommit.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - cubrid_get_autocommit - Récupère le mode auto-commit de la connexion - - - - &reftitle.description; - - boolcubrid_get_autocommit - resourceconn_identifier - - - La fonction cubrid_get_autocommit est utilisée - pour récupérer le statut du mode auto-commit de la connexion - à la base de données CUBRID. - - - En CUBRID 8.4.0, le mode auto-commit est désactivé par défaut pour la - gestion des transactions. - - - En CUBRID 8.4.1, le mode auto-commit est activé par défaut pour la - gestion des transactions. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - - - - &reftitle.returnvalues; - - &true;, lorsque le mode auto-commit est actif. - - - &false;, lorsque le mode auto-commit est inactif. - - - &null; Si une erreur survient. - - - - - &reftitle.seealso; - - cubrid_set_autocommit - cubrid_commit - - - - diff --git a/reference/cubrid/functions/cubrid-get-charset.xml b/reference/cubrid/functions/cubrid-get-charset.xml deleted file mode 100644 index ccd754ee4e..0000000000 --- a/reference/cubrid/functions/cubrid-get-charset.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - cubrid_get_charset - Retourne le jeu de caractères utilisé sur la connexion CUBRID courante - - - - &reftitle.description; - - stringcubrid_get_charset - resourceconn_identifier - - - Cette fonction retourne le jeu de caractères sur la connexion CUBRID - courante et est similaire à la fonction CUBRID compatible MySQL - cubrid_client_encoding. - - - - - &reftitle.parameters; - - - conn_identifier - La connexion CUBRID. - - - - - - &reftitle.returnvalues; - - Une &string; représentant le jeu de caractères sur la connexion CUBRID - en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_get_charset</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_client_encoding - - - - - diff --git a/reference/cubrid/functions/cubrid-get-class-name.xml b/reference/cubrid/functions/cubrid-get-class-name.xml deleted file mode 100644 index 5613c92829..0000000000 --- a/reference/cubrid/functions/cubrid-get-class-name.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - cubrid_get_class_name - Récupère le nom de la classe en utilisant son OID - - - - &reftitle.description; - - stringcubrid_get_class_name - resourceconn_identifier - stringoid - - - La fonction cubrid_get_class_name est utilisée - pour récupérer le nom de la classe depuis l'oid. - Ce mécanisme ne fonctionne pas lors de la sélection de données depuis - des tables systèmes, comme db_class. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - OID de l'instance dont l'on veut vérifier l'existence. - - - - - - &reftitle.returnvalues; - - Le nom de la classe, en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_get_class_name</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_is_instance - cubrid_drop - - - - diff --git a/reference/cubrid/functions/cubrid-get-client-info.xml b/reference/cubrid/functions/cubrid-get-client-info.xml deleted file mode 100644 index 7c5d6b9a36..0000000000 --- a/reference/cubrid/functions/cubrid-get-client-info.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - cubrid_get_client_info - Retourne la version de la bibliothèque cliente - - - - &reftitle.description; - - stringcubrid_get_client_info - - - - Cette fonction retourne une &string; représentant la version - de la bibliothèque cliente. - - - - - &reftitle.parameters; - - - - - - - &reftitle.returnvalues; - - Une &string; représentant la version de la bibliothèque cliente en - cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_get_client_info</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/functions/cubrid-get-db-parameter.xml b/reference/cubrid/functions/cubrid-get-db-parameter.xml deleted file mode 100644 index ec8f1109ec..0000000000 --- a/reference/cubrid/functions/cubrid-get-db-parameter.xml +++ /dev/null @@ -1,257 +0,0 @@ - - - - - - - cubrid_get_db_parameter - Retourne les paramètres de la base de données CUBRID - - - - &reftitle.description; - - arraycubrid_get_db_parameter - resourceconn_identifier - - - Cette fonction retourne les paramètres de la base de données CUBRID,&return.falseforfailure;. Elle retourne un tableau associatif - avec les valeurs des paramètres suivants : - - - PARAM_ISOLATION_LEVEL - PARAM_LOCK_TIMEOUT - PARAM_MAX_STRING_LENGTH - PARAM_AUTO_COMMIT - - - Paramètres de la base de données - - - - Paramètre - Description - - - - - PARAM_ISOLATION_LEVEL - Le niveau d'isolation de la transaction. - - - LOCK_TIMEOUT - CUBRID fournit la fonctionnalité de verrou du délai d'expiration, - qui définit le temps d'attente (en secondes) pour le verrou tant que - la configuration du verrou de la transaction est autorisée. - La valeur par défaut du paramètre lock_timeout_in_secs vaut -1, qui - signifie que l'application cliente attendra indéfiniment tant que le - verrou de transaction est autorisé. - - - PARAM_AUTO_COMMIT - En CUBRID PHP, le mode auto-commit est désactivé par défaut pour - le gestionnaire de transaction. Il peut être défini par - la fonction cubrid_set_autocommit. - - - -
- - La table suivante montre les niveaux d'isolation de 1 à 6 : - - Niveaux d'isolation supportés par CUBRID - - - - Nom - Description - - - - - SERIALIZABLE (6) - Dans ce niveau d'isolation, les problèmes de concurrence - (c.-à-d. lecture de données modifiées, lecture répétée de données, - lecture de données fantôme, etc.) ne peuvent pas survenir. - - - REPEATABLE READ CLASS avec REPEATABLE READ INSTANCES (5) - Une autre transaction T2 ne peut pas mettre à jour le schéma - de la table A tant que la transaction T1 lit la table A. La transaction - T1 peut rencontrer des données fantômes de l'enregistrement R - qui a été inséré par la transaction T2 lorsqu'elle récupère à plusieurs - reprises un enregistrement spécifique. - - - REPEATABLE READ CLASS with READ COMMITTED INSTANCES (or CURSOR STABILITY) (4) - Une autre transaction T2 ne peut pas mettre à jour le schéma - de la table A alors qu'une transaction T1 lit la table A. La transaction - T1 peut rencontrer des lectures répétées de données qui ont - été mises à jour, et validées par une autre transaction T2 lorsqu'elle - récupère à plusieurs reprises l'enregistrement R. - - - REPEATABLE READ CLASS with READ UNCOMMITTED INSTANCES (3) - Niveau d'isolation par défaut. Une transaction T2 ne peut - pas mettre à jour le schéma de la table A alors qu'une transaction - T1 lit la table A. La transaction T1 peut rencontrer des données - non mises à jour pour l'enregistrement qui a été mis à jour - mais non encore validé par la transaction T2. - - - READ COMMITTED CLASS with READ COMMITTED INSTANCES (2) - La transaction T1 peut rencontrer des lectures répétées de données - pour la table qui a été mise à jour et validée par la transaction T2 - alors qu'elle lit plusieurs fois la table A. La transaction T1 peut - rencontrer des lectures répétées de données pour l'enregistrement qui - a été mis à jour et validé par la transaction T2 alors qu'elle récupère - à plusieurs reprises l'enregistrement R. - - - READ COMMITTED CLASS with READ UNCOMMITTED INSTANCES (1) - La transaction T1 peut rencontrer des lectures répétées - de données pour la table qui a été mise à jour et validée par la - transaction T2 alors qu'elle lit à plusieurs reprises la table A. - La transaction T1 peut rencontrer des données non mises à jour pour - l'enregistrement qui a été mis à jour mais non validé par la transaction - T2. - - - -
- - - - - &reftitle.parameters; - - - conn_identifier - La connexion CUBRID. Si l'identifiant de connexion - n'est pas spécifié, le dernier lien ouvert avec la fonction - cubrid_connect sera utilisé. - - - - - - &reftitle.returnvalues; - - Un tableau associatif contenant les paramètres de la base - de données CUBRID en cas de succès,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.4.0 - - Modification de LOCK_TIMEOUT en PARAM_LOCK_TIMEOUT, - de MAX_STRING_LENGTH en PARAM_MAX_STRING_LENGTH dans le - résultat. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_get_db_parameter</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_set_db_parameter - cubrid_get_autocommit - - - - diff --git a/reference/cubrid/functions/cubrid-get-query-timeout.xml b/reference/cubrid/functions/cubrid-get-query-timeout.xml deleted file mode 100644 index 7b9ed72968..0000000000 --- a/reference/cubrid/functions/cubrid-get-query-timeout.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - cubrid_get_query_timeout - Récupère la valeur du délai d'attente maximal d'une requête - - - - &reftitle.description; - - intcubrid_get_query_timeout - resourcereq_identifier - - - La fonction cubrid_get_query_timeout - est utilisée pour récupérer le délai d'attente maximal d'une requête. - - - - - &reftitle.parameters; - - - req_identifier - - - Un identifiant de requête. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur du délai d'attente maximal pour la requête en cas - de succès, en millisecondes,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_get_query_timeout</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_set_query_timeout - - - - diff --git a/reference/cubrid/functions/cubrid-get-server-info.xml b/reference/cubrid/functions/cubrid-get-server-info.xml deleted file mode 100644 index 8a8a4ec6b1..0000000000 --- a/reference/cubrid/functions/cubrid-get-server-info.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - cubrid_get_server_info - Retourne la version du serveur CUBRID - - - - &reftitle.description; - - stringcubrid_get_server_info - resourceconn_identifier - - - Cette fonction retourne une &string; représentant la version - du serveur CUBRID. - - - - - &reftitle.parameters; - - - conn_identifier - L'identifiant de connexion CUBRID. - - - - - - &reftitle.returnvalues; - - Une &string; représentant la version du serveur CUBRID en cas - de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_get_server_info</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/functions/cubrid-get.xml b/reference/cubrid/functions/cubrid-get.xml deleted file mode 100644 index f73453800e..0000000000 --- a/reference/cubrid/functions/cubrid-get.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - - cubrid_get - Récupère une colonne en utilisant son OID - - - - &reftitle.description; - - mixedcubrid_get - resourceconn_identifier - stringoid - mixedattr - - - La fonction cubrid_get est utilisée pour récupérer - l'attribut de l'instance représentée par l'oid fourni. - Il est possible de récupérer un seul attribut en utilisant le type de données "&string;" - de l'argument attr ou plusieurs attributs en utilisant le - type de données "&array;" de l'argument attr. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - OID de l'instance depuis laquelle l'on veut lire. - - - attr - Nom de l'attribut que l'on veut lire. - - - - - - - &reftitle.returnvalues; - - Le contenu de l'attribut demandé, lorsque l'opération a réussi : lorsque - le paramètre attr est défini comme type de données - "&string;", le résultat est retourné sous la forme d'une &string; ; lorsque - le paramètre attr est défini comme type de données - "&array;" (tableau numérique commençant à 0), le résultat est retourné - sous la forme d'un tableau associatif. Lorsque le paramètre attr - est omis, alors tous les attributs seront retournés dans un tableau. - - - &false; si une erreur survient ou si le résultat vaut &null; (si une erreur - survient, pour distinguer d'une chaîne vide, un message d'alerte sera émis. - Il est possible de récupérer l'erreur en utilisant la fonction - cubrid_error_code). - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_get</function> - - -]]> - - &example.outputs; - - - string(1) "1" - ["b"]=> - array(3) { - [0]=> - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" - } - ["c"]=> - array(4) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" - } - ["d"]=> - string(10) "a " -} -]]> - - - - - - &reftitle.seealso; - - cubrid_put - - - - - diff --git a/reference/cubrid/functions/cubrid-insert-id.xml b/reference/cubrid/functions/cubrid-insert-id.xml deleted file mode 100644 index eea82a3054..0000000000 --- a/reference/cubrid/functions/cubrid-insert-id.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - cubrid_insert_id - Retourne l'identifiant généré pour la dernière mise à jour de la colonne AUTO_INCREMENT - - - - &reftitle.description; - - stringcubrid_insert_id - resourceconn_identifier - - - La fonction cubrid_insert_id récupère l'identifiant - généré pour la colonne AUTO_INCREMENT mise à jour par la précédente requête - INSERT. Elle retourne 0 si la précédente requête ne génère pas de nouvelles - lignes, ou &false; si une erreur survient. - - - - - CUBRID supporte AUTO_INCREMENT pour plus d'une colonne dans une table. - Dans la plupart des cas, il n'y en a qu'une seule. S'il y en a plusieurs, - cette fonction ne doit pas être utilisée y compris si elle retourne une - valeur. - - - - - - &reftitle.parameters; - - - conn_identifier - L'identifiant de connexion précédemment obtenu depuis - un appel à la fonction cubrid_connect. - - - - - - &reftitle.returnvalues; - - Une &string; représentant l'identifiant généré pour la colonne AUTO_INCREMENT - par la précédente requête en cas de succès. - - - 0 si la précédente requête n'a généré aucune nouvelle ligne. - - - &false; si une erreur survient. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.4.0 - - Modification de la valeur retournée (d'un tableau vers une &string;) ; - Suppression du premier paramètre class_name. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_insert_id</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/functions/cubrid-is-instance.xml b/reference/cubrid/functions/cubrid-is-instance.xml deleted file mode 100644 index 175d37a913..0000000000 --- a/reference/cubrid/functions/cubrid-is-instance.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - cubrid_is_instance - Vérifie si une instance existe - - - - &reftitle.description; - - intcubrid_is_instance - resourceconn_identifier - stringoid - - - La fonction cubrid_is_instance est utilisée pour - vérifier si l'instance pointée par l'oid fournie - existe ou non. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - OID de l'instance dont l'on veut vérifier l'existence. - - - - - - &reftitle.returnvalues; - - 1, si l'instance existe. - - - 0, si l'instance n'existe pas. - - - -1, si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_is_instance</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_drop - cubrid_get_class_name - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-close.xml b/reference/cubrid/functions/cubrid-lob-close.xml deleted file mode 100644 index 96fa3794e5..0000000000 --- a/reference/cubrid/functions/cubrid-lob-close.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - cubrid_lob_close - Ferme un BLOB/CLOB - - - - &reftitle.description; - - boolcubrid_lob_close - arraylob_identifier_array - - - La fonction cubrid_lob_close est utilisée pour - fermer tous les BLOB/CLOB retournés depuis la fonction cubrid_lob_get. - - - - - &reftitle.parameters; - - - lob_identifier_array - Un tableau d'identifiants LOB retournés par la fonction cubrid_lob_get. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_lob_close</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_get - cubrid_lob_size - cubrid_lob_export - cubrid_lob_send - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-export.xml b/reference/cubrid/functions/cubrid-lob-export.xml deleted file mode 100644 index c05acc0ca1..0000000000 --- a/reference/cubrid/functions/cubrid-lob-export.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - cubrid_lob_export - Exporte des données BLOB/CLOB vers un fichier - - - - &reftitle.description; - - boolcubrid_lob_export - resourceconn_identifier - resourcelob_identifier - stringpath_name - - - La fonction cubrid_lob_export est utilisée pour récupérer - les données BLOB/CLOB depuis la base de données CUBRID, et sauvegarde leurs contenus - dans un fichier. Pour utiliser cette fonction, il faut utiliser d'abord la - fonction cubrid_lob_get pour récupérer les informations des - BLOB/CLOB depuis CUBRID. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - lob_identifier - Identifiant LOB. - - - path_name - Chemin vers le fichier. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_lob_export</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_get - cubrid_lob_close - cubrid_lob_size - cubrid_lob_send - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-get.xml b/reference/cubrid/functions/cubrid-lob-get.xml deleted file mode 100644 index 714e1d196a..0000000000 --- a/reference/cubrid/functions/cubrid-lob-get.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - cubrid_lob_get - Récupère les données BLOB/CLOB - - - - &reftitle.description; - - arraycubrid_lob_get - resourceconn_identifier - stringsql - - - La fonction cubrid_lob_get est utilisée pour récupérer - les données d'informations méta BLOB/CLOB depuis la base de données CUBRID - (CUBRID récupère les BLOB/CLOB en exécutant une requête SQL), et retourne - tous les LOBs sous la forme d'un tableau de ressources. Il faut s'assurer - que le SQL récupère uniquement une seule colonne et que le type de données - est bien BLOB ou CLOB. - - - Il est important de noter que l'utilisation de la fonction - cubrid_lob_close libère les LOBs si on n'en a plus besoin. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - sql - Requête SQL à exécuter. - - - - - - &reftitle.returnvalues; - - Retourne un tableau de ressources LOB en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_lob_get</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_close - cubrid_lob_size - cubrid_lob_export - cubrid_lob_send - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-send.xml b/reference/cubrid/functions/cubrid-lob-send.xml deleted file mode 100644 index 9045099a8b..0000000000 --- a/reference/cubrid/functions/cubrid-lob-send.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - cubrid_lob_send - Lit les données BLOB/CLOB et les envoie au navigateur - - - - &reftitle.description; - - boolcubrid_lob_send - resourceconn_identifier - resourcelob_identifier - - - La fonction cubrid_lob_send lit des données BLOB/CLOB - et les passe au navigateur. Pour utiliser cette fonction, il faut utiliser - d'abord la fonction cubrid_lob_get pour récupérer les - informations des BLOB/CLOB depuis CUBRID. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - lob_identifier - Identifiant LOB. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_lob_send</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_get - cubrid_lob_close - cubrid_lob_size - cubrid_lob_export - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-size.xml b/reference/cubrid/functions/cubrid-lob-size.xml deleted file mode 100644 index dac54abae2..0000000000 --- a/reference/cubrid/functions/cubrid-lob-size.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - cubrid_lob_size - Récupère la taille des données BLOB/CLOB - - - - &reftitle.description; - - stringcubrid_lob_size - resourcelob_identifier - - - La fonction cubrid_lob_size est utilisée pour récupérer - la taille des données BLOB/CLOB. - - - - - &reftitle.parameters; - - - lob_identifier - Identifiant LOB. - - - - - - &reftitle.returnvalues; - - Une chaîne représentant la taille des données LOB, lorsque - l'opération a réussi,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.4.0 - - Le type de la valeur retournée a changé. - Avant, c'était un entier, maintenant, c'est une - chaîne de caractères. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_lob_size</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_get - cubrid_lob_close - cubrid_lob_export - cubrid_lob_send - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-bind.xml b/reference/cubrid/functions/cubrid-lob2-bind.xml deleted file mode 100644 index 20109adc6a..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-bind.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - cubrid_lob2_bind - Lie un objet LOB ou une chaîne de caractères à un objet LOB - comme paramètre d'une requête préparée - - - - &reftitle.description; - - boolcubrid_lob2_bind - resourcereq_identifier - intbind_index - mixedbind_value - stringbind_value_type - - - La fonction cubrid_lob2_bind est utilisée pour lier - des données BLOB/CLOB à un marqueur correspondant dans une requête SQL - passée à la fonction cubrid_prepare. Si le paramètre - bind_value_type n'est pas fourni, la chaîne sera - par défaut "BLOB". Mais si l'on utilise d'abord la fonction - cubrid_lob2_new, le paramètre bind_value_type - deviendra cohérent avec le paramètre type dans - la fonction cubrid_lob2_new. - - - - - &reftitle.parameters; - - - req_identifier - - - Identifiant de la requête, résultant de la fonction cubrid_prepare. - - - - - bind_index - - - Position du paramètre lié. Commence à 1. - - - - - bind_value - - - Valeur effective pour le liage. - - - - - bind_value_type - - - Doit être "BLOB" ou "CLOB" et n'est pas sensible à la casse. - S'il n'est pas fourni, la valeur par défaut sera "BLOB". - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_lob2_bind</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_new - cubrid_lob2_close - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-close.xml b/reference/cubrid/functions/cubrid-lob2-close.xml deleted file mode 100644 index 2b257acafd..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-close.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - cubrid_lob2_close - Ferme un objet LOB - - - - &reftitle.description; - - boolcubrid_lob2_close - resourcelob_identifier - - - La fonction cubrid_lob2_close est utilisée pour fermer - un objet LOB, retourné par la fonction cubrid_lob2_new - ou récupéré depuis le jeu de résultats. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identifiant LOB, résultant de la fonction - cubrid_lob2_new ou récupéré - depuis le jeu de résultats. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - cubrid_lob2_new - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-export.xml b/reference/cubrid/functions/cubrid-lob2-export.xml deleted file mode 100644 index 0b3d4a159f..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-export.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - cubrid_lob2_export - Exporte un objet LOB vers un fichier - - - - &reftitle.description; - - boolcubrid_lob2_export - resourcelob_identifier - stringfile_name - - - La fonction cubrid_lob2_export est utilisée - pour sauvegarder les données BLOB/CLOB dans un fichier. Pour utiliser - cette fonction, il faut tout d'abord utiliser la fonction - cubrid_lob2_new ou récupérer un objet LOB depuis la - base de données CUBRID. Si le fichier existe déjà, l'opération échouera. - Cette fonction ne modifiera pas la position du curseur de l'objet LOB. - Elle opère sur l'objet LOB dans sa totalité. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identifiant LOB résultant de la fonction - cubrid_lob2_new ou récupéré depuis le jeu de résultats. - - - - - filename - - - Nom du fichier dans lequel l'on souhaite enregistrer les données BLOB/CLOB. - Le chemin vers le fichier peut également être spécifié. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_lob2_export</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_new - cubrid_lob2_close - cubrid_lob2_import - cubrid_lob2_bind - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-import.xml b/reference/cubrid/functions/cubrid-lob2-import.xml deleted file mode 100644 index 6118701329..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-import.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - cubrid_lob2_import - Importe des données BLOB/CLOB depuis un fichier - - - - &reftitle.description; - - boolcubrid_lob2_import - resourcelob_identifier - stringfile_name - - - La fonction cubrid_lob2_import est utilisée pour importer - des données BLOB/CLOB depuis un fichier. Pour utiliser cette fonction, il faut - d'abord utiliser la fonction cubrid_lob2_new ou - récupérer un objet LOB depuis la base de données CUBRID. Si le fichier n'existe - pas, l'opération échouera. Cette fonction n'impacte pas la position du curseur - dans l'objet LOB ; elle opère sur l'objet LOB dans sa totalité. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identifiant LOB, résultat de la fonction - cubrid_lob2_new ou récupéré depuis le jeu de - résultats. - - - - - filename - - - Le nom du fichier depuis lequel les données BLOB/CLOB doivent - être importées. Le chemin vers le fichier est également supporté. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_lob2_export</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_new - cubrid_lob2_close - cubrid_lob2_export - cubrid_lob2_bind - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-new.xml b/reference/cubrid/functions/cubrid-lob2-new.xml deleted file mode 100644 index f74f5626a3..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-new.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - cubrid_lob2_new - Crée un nouvel objet LOB - - - - &reftitle.description; - - resourcecubrid_lob2_new - resourceconn_identifier - stringtype"BLOB" - - - La fonction cubrid_lob2_new est utilisée pour créer - un nouvel objet LOB (à la fois BLOB et CLOB). - Cette fonction doit être utilisée avant de lier un objet LOB. - - - - - &reftitle.parameters; - - - conn_identifier - - - Un identifiant de connexion. S'il n'est pas spécifié, la dernière - connexion ouverte avec la fonction cubrid_connect ou - la fonction cubrid_connect_with_url sera utilisée. - - - - - type - - - Peut être "BLOB" ou "CLOB", et n'est pas sensible à la casse. - La valeur par défaut est "BLOB". - - - - - - - &reftitle.returnvalues; - - Un identifiant LOB en cas de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_close - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-read.xml b/reference/cubrid/functions/cubrid-lob2-read.xml deleted file mode 100644 index 2bcdec943c..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-read.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - cubrid_lob2_read - Lit des données BLOB/CLOB - - - - &reftitle.description; - - stringcubrid_lob2_read - resourcelob_identifier - intlen - - - La fonction cubrid_lob2_read - lit len octets depuis les données LOB, - et retourne les octets lus. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identifiant LOB, résultant de la fonction - cubrid_lob2_new ou récupéré depuis le jeu de - résultats. - - - - - len - - - Quantité de données à lire depuis les données LOB. - - - - - - - - &reftitle.returnvalues; - - Retourne le contenu en tant que &string;, - &false; quand il n'y a plus de données, - ou &null; si une erreur survient. - - - - - &reftitle.examples; - - Exemple 1 avec <function>cubrid_lob2_read</function> - - -]]> - - - - - Exemple 2 avec <function>cubrid_lob2_read</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-seek.xml b/reference/cubrid/functions/cubrid-lob2-seek.xml deleted file mode 100644 index 79e067c697..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-seek.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - cubrid_lob2_seek - Déplace le curseur d'un objet LOB - - - - &reftitle.description; - - boolcubrid_lob2_seek - resourcelob_identifier - intoffset - intoriginCUBRID_CURSOR_CURRENT - - - La fonction cubrid_lob2_seek est utilisée - pour déplacer la position du curseur d'un objet LOB d'un pas spécifié par - l'argument offset, et dans la direction spécifiée - par l'argument origin. - - - Pour définir l'argument origin, il est possible d'utiliser la - constante CUBRID_CURSOR_FIRST pour déplacer en avant la position du curseur de - offset unités depuis le début. - Dans ce cas, offset doit être une valeur positive. - - - Si l'on utilise la constante CUBRID_CURSOR_CURRENT pour le paramètre - origin, il est possible de se déplacer en avant ou en arrière. - L'argument offset peut être négatif ou positif. - - - Si l'on utilise la constante CUBRID_CURSOR_LAST pour le paramètre - origin, il est possible de se déplacer en arrière - de offset unités depuis la fin de l'objet LOB ; - l'argument offset peut seulement être positif dans ce cas. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identifiant LOB, résultant de la fonction - cubrid_lob2_new ou récupéré depuis le jeu de résultats. - - - - - offset - - - Nombre d'unités à utiliser pour déplacer le curseur. - - - - - origin - - Ce paramètre peut prendre les valeurs suivantes : - CUBRID_CURSOR_FIRST : Se déplace en avant depuis le début. - CUBRID_CURSOR_CURRENT : Se déplace en avant ou en arrière, depuis la position courante. - CUBRID_CURSOR_LAST : Se déplace en arrière depuis la fin de l'objet LOB. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_lob2_seek</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-seek64.xml b/reference/cubrid/functions/cubrid-lob2-seek64.xml deleted file mode 100644 index 243e880900..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-seek64.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - - cubrid_lob2_seek64 - Déplace le curseur d'un objet LOB - - - - &reftitle.description; - - boolcubrid_lob2_seek64 - resourcelob_identifier - stringoffset - intoriginCUBRID_CURSOR_CURRENT - - - La fonction cubrid_lob2_seek64 est utilisée - pour déplacer la position du curseur dans un objet LOB d'une valeur - fournie par le paramètre offset, dans la direction - fournie par le paramètre origin. - Si la position offset est plus grande que la capacité - de stockage d'un entier, il est possible d'utiliser cette fonction. - - - Pour définir le paramètre origin, il est possible d'utiliser la constante CUBRID_CURSOR_FIRST pour définir la position - du curseur à laquelle on ajoute offset unités - depuis le début. Dans ce cas, offset doit être une valeur - positive. - - - Si l'on utilise CUBRID_CURSOR_CURRENT pour le paramètre origin, - il est possible de se déplacer vers l'arrière, comme vers l'avant. Et le paramètre - offset pourra être positif ou négatif. - - - Si l'on utilise la constante CUBRID_CURSOR_LAST pour le paramètre - origin, il est possible de se déplacer en arrière de - offset unités depuis la fin de l'objet LOB - et le paramètre offset ne pourra être que positif. - - - - Si l'on utilise cette fonction pour déplacer la position du curseur d'un - objet LOB, il est recommandé de passer le paramètre offset - sous la forme d'une chaîne de caractères. - - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identifiant LOB, récupéré depuis la fonction - cubrid_lob2_new ou depuis le jeu de résultats. - - - - - offset - - - Nombre d'unités de déplacement du curseur. - - - - origin - - Ce paramètre peut prendre les valeurs suivantes : - CUBRID_CURSOR_FIRST : déplace le curseur vers l'avant en partant du début. - CUBRID_CURSOR_CURRENT : déplace le curseur vers l'arrière et vers l'avant depuis la position courante. - CUBRID_CURSOR_LAST : déplace le curseur vers l'arrière depuis la fin de l'objet LOB. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_lob2_seek64</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-size.xml b/reference/cubrid/functions/cubrid-lob2-size.xml deleted file mode 100644 index fbb7a39692..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-size.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - cubrid_lob2_size - Récupère la taille d'un objet LOB - - - - &reftitle.description; - - intcubrid_lob2_size - resourcelob_identifier - - - La fonction cubrid_lob2_size est utilisée pour récupérer - la taille d'un objet LOB. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identifiant LOB, récupéré depuis la fonction - cubrid_lob2_new ou depuis le jeu de résultats. - - - - - - - - &reftitle.returnvalues; - - Retourne la taille de l'objet LOB en cas de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-size64.xml b/reference/cubrid/functions/cubrid-lob2-size64.xml deleted file mode 100644 index 4712d68d1f..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-size64.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - cubrid_lob2_size64 - Récupère la taille d'un objet LOB - - - - &reftitle.description; - - stringcubrid_lob2_size64 - resourcelob_identifier - - - La fonction cubrid_lob2_size64 est utilisée pour récupérer - la taille d'un objet LOB. Si la taille de l'objet LOB est plus grande - que la capacité de stockage d'un entier, il est possible d'utiliser cette fonction, - et elle retournera la taille sous la forme d'une chaîne de caractères. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identifiant LOB, récupéré depuis la fonction - cubrid_lob2_new ou depuis le jeu de résultats. - - - - - - - - &reftitle.returnvalues; - - Retourne la taille d'un objet LOB sous la forme d'une chaîne de - caractères en cas de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-tell.xml b/reference/cubrid/functions/cubrid-lob2-tell.xml deleted file mode 100644 index 6cb8e3db81..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-tell.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - cubrid_lob2_tell - Récupère la position du curseur dans un objet LOB - - - - &reftitle.description; - - intcubrid_lob2_tell - resourcelob_identifier - - - La fonction cubrid_lob2_tell est utilisée - pour récupérer la position du curseur dans l'objet LOB. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identifiant LOB, récupéré depuis la fonction - cubrid_lob2_new ou depuis le jeu de résultats. - - - - - - - - &reftitle.returnvalues; - - Retourne la position du curseur dans l'objet LOB en cas de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-tell64.xml b/reference/cubrid/functions/cubrid-lob2-tell64.xml deleted file mode 100644 index 660583b9af..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-tell64.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - cubrid_lob2_tell64 - Récupère la position du curseur dans l'objet LOB - - - - &reftitle.description; - - stringcubrid_lob2_tell64 - resourcelob_identifier - - - La fonction cubrid_lob2_tell64 est utilisée - pour récupérer la position du curseur dans l'objet LOB. Si la taille - de l'objet LOB est plus grande que la capacité de stockage d'un entier, - il est possible d'utiliser cette fonction et elle retournera l'information - sous la forme d'une chaîne de caractères. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identifiant LOB, récupéré depuis la fonction - cubrid_lob2_new ou depuis le jeu de résultats. - - - - - - - - &reftitle.returnvalues; - - Retourne la position du curseur dans l'objet LOB, sous la - forme d'une chaîne de caractères en cas de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-write.xml b/reference/cubrid/functions/cubrid-lob2-write.xml deleted file mode 100644 index 766dc742f5..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-write.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - cubrid_lob2_write - Écrit dans un objet LOB - - - - &reftitle.description; - - boolcubrid_lob2_write - resourcelob_identifier - stringbuf - - - La fonction cubrid_lob2_write lit les données - depuis le paramètre buf et les stocke dans l'objet LOB. - Il est à noter que cette fonction ne peut ajouter actuellement que des caractères. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identifiant LOB, récupéré depuis la fonction - cubrid_lob2_new ou depuis le jeu de résultats. - - - - - buf - - - Les données qui doivent être écrites dans l'objet LOB. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple 1 avec <function>cubrid_lob2_write</function> - - -]]> - - - - - Exemple 2 avec <function>cubrid_lob2_write</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lock-read.xml b/reference/cubrid/functions/cubrid-lock-read.xml deleted file mode 100644 index 3f471c20a5..0000000000 --- a/reference/cubrid/functions/cubrid-lock-read.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - cubrid_lock_read - Place un verrou de lecture sur l'OID fourni - - - - &reftitle.description; - - boolcubrid_lock_read - resourceconn_identifier - stringoid - - - La fonction cubrid_lock_read est utilisée pour placer - un verrou de lecture sur l'instance pointée par l'oid fournie. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - OID de l'instance dont l'on veut verrouiller la lecture. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_lock_read</function> - - -]]> - -&example.outputs; - - - string(1) "1" - ["b"]=> - array(3) { - [0]=> - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" - } - ["c"]=> - array(4) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" - } - ["d"]=> - string(10) "a " -} -]]> - - - - - - &reftitle.seealso; - - cubrid_lock_write - - - - - diff --git a/reference/cubrid/functions/cubrid-lock-write.xml b/reference/cubrid/functions/cubrid-lock-write.xml deleted file mode 100644 index 6605973945..0000000000 --- a/reference/cubrid/functions/cubrid-lock-write.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - cubrid_lock_write - Place un verrou d'écriture sur l'OID fourni - - - - &reftitle.description; - - boolcubrid_lock_write - resourceconn_identifier - stringoid - - - La fonction cubrid_lock_write est utilisée pour placer un - verrou d'écriture sur l'instance pointée par l'oid fournie. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - OID de l'instance sur laquelle placer un verrou d'écriture. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_lock_write</function> - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -array(3) { - [0]=> - string(1) "2" - [1]=> - string(1) "4" - [2]=> - string(1) "8" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_lock_read - - - - - diff --git a/reference/cubrid/functions/cubrid-move-cursor.xml b/reference/cubrid/functions/cubrid-move-cursor.xml deleted file mode 100644 index e0ce35801f..0000000000 --- a/reference/cubrid/functions/cubrid-move-cursor.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - cubrid_move_cursor - Déplace le curseur dans le résultat - - - - &reftitle.description; - - boolcubrid_move_cursor - resourcereq_identifier - intoffset - intoriginCUBRID_CURSOR_CURRENT - - - La fonction cubrid_move_cursor est utilisée pour déplacer le - curseur courant suivant le paramètre req_identifier - de la valeur du paramètre offset et dans la direction - définie par le paramètre origin. Pour définir - le paramètre origin, il est possible d'utiliser CUBRID_CURSOR_FIRST pour - la première partie du résultat, CUBRID_CURSOR_CURRENT pour la position courante du résultat, - ou CUBRID_CURSOR_LAST pour la dernière partie du résultat. Si l'argument origin - n'est pas explicitement désigné, alors la fonction utilisera CUBRID_CURSOR_CURRENT comme valeur par défaut. - - - Si la valeur courante du déplacement du curseur est au-delà des limites valides, alors - le curseur se déplace à la prochaine position après l'intervalle valide du curseur. Par exemple, - si on le déplace de 20 unités dans le résultat dont la taille est de 10, alors le curseur - se place sur la 11ème place et retournera CUBRID_NO_MORE_DATA. - - - - - &reftitle.parameters; - - - req_identifier - Identifiant de requête. - - - offset - Nombre d'unités que l'on veut utiliser pour le déplacement. - - - origin - Cible où l'on veut déplacer le curseur, soit CUBRID_CURSOR_FIRST, CUBRID_CURSOR_CURRENT, CUBRID_CURSOR_LAST. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_move_cursor</function> - - -]]> - - &example.outputs; - - - string(1) "G" - [1]=> - string(4) "Gold" -} -array(2) { - [0]=> - string(1) "X" - [1]=> - string(5) "Mixed" -} -array(2) { - [0]=> - string(1) "M" - [1]=> - string(3) "Man" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-next-result.xml b/reference/cubrid/functions/cubrid-next-result.xml deleted file mode 100644 index f28c20f9a4..0000000000 --- a/reference/cubrid/functions/cubrid-next-result.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - cubrid_next_result - Récupère le résultat de la prochaine requête lors de l'exécution - de requêtes SQL multiples - - - - &reftitle.description; - - boolcubrid_next_result - resourceresult - - - La fonction cubrid_next_result est utilisée pour - récupérer les résultats de la prochaine requête si plusieurs requêtes SQL - sont exécutées et que le drapeau CUBRID_EXEC_QUERY_ALL est défini lors de - l'utilisation de la fonction cubrid_execute. - - - - - &reftitle.parameters; - - - result - - - Le paramètre result provient de l'appel à la - fonction cubrid_execute - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_next_result</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-num-cols.xml b/reference/cubrid/functions/cubrid-num-cols.xml deleted file mode 100644 index cb81abf97a..0000000000 --- a/reference/cubrid/functions/cubrid-num-cols.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - cubrid_num_cols - Récupère le nombre de colonnes du jeu de résultats - - - - &reftitle.description; - - intcubrid_num_cols - resourceresult - - - La fonction cubrid_num_cols est utilisée pour récupérer - le nombre de colonnes depuis le résultat de la requête. Elle ne peut être utilisée - que lorsque la requête est de type SELECT. - - - - - &reftitle.parameters; - - - result - Le résultat. - - - - - - &reftitle.returnvalues; - - Nombre de colonnes en cas de succès. - - - &false;, si la requête SQL n'est pas de type SELECT. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_num_cols</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_num_rows - - - - - diff --git a/reference/cubrid/functions/cubrid-num-rows.xml b/reference/cubrid/functions/cubrid-num-rows.xml deleted file mode 100644 index b8b7212be6..0000000000 --- a/reference/cubrid/functions/cubrid-num-rows.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - cubrid_num_rows - Récupère le nombre de lignes d'un jeu de résultats - - - - &reftitle.description; - - intcubrid_num_rows - resourceresult - - - La fonction cubrid_num_rows est utilisée pour récupérer - le nombre de lignes depuis le jeu de résultats. L'on ne peut l'utiliser - que lorsque la requête est de type SELECT. Lorsque l'on veut savoir ce type - de valeur pour une requête de type INSERT, UPDATE ou DELETE, il faut utiliser - la fonction cubrid_affected_rows. - - - Note : La fonction cubrid_num_rows ne peut être utilisée que - sur les requêtes synchrones ; elle retourne 0 sur des requêtes asynchrones. - - - - - &reftitle.parameters; - - - result - - - Le paramètre result provient - d'un appel à la fonction cubrid_execute, - la fonction cubrid_query ou la fonction - cubrid_prepare. - - - - - - - - &reftitle.returnvalues; - - Nombre de lignes en cas de succès. - - - 0 lorsque la requête a été effectuée en mode asynchrone. - - - -1, si la requête SQL n'est pas de type SELECT. - - - &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_num_rows</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_num_cols - cubrid_affected_rows - - - - - diff --git a/reference/cubrid/functions/cubrid-pconnect-with-url.xml b/reference/cubrid/functions/cubrid-pconnect-with-url.xml deleted file mode 100644 index bdc5018e45..0000000000 --- a/reference/cubrid/functions/cubrid-pconnect-with-url.xml +++ /dev/null @@ -1,259 +0,0 @@ - - - - - - - cubrid_pconnect_with_url - Ouvre une connexion persistante vers un serveur CUBRID - - - - &reftitle.description; - - resourcecubrid_pconnect_with_url - stringconn_url - stringuserid - stringpasswd - - - Établit une connexion persistante vers un serveur CUBRID. - - - cubrid_pconnect_with_url agit de la même façon que la - fonction cubrid_connect_with_url, avec deux différences majeures. - - - Tout d'abord, lors de la connexion, la fonction tentera tout d'abord de trouver - un lien (persistant) déjà ouvert avec le même hôte, sur le même port, sur la - même base de données dbname et utilisant le même userid. Si une telle connexion - est trouvée, son identifiant sera retourné au lieu d'ouvrir une nouvelle - connexion. - - - Ensuite, la connexion vers le serveur SQL ne sera pas fermée lorsque la fin - du script sera atteinte. Au lieu de cela, la connexion restera ouverte - pour une utilisation future (la fonction cubrid_close ou la fonction - cubrid_disconnect ne fermera pas la connexion établie par la fonction - cubrid_pconnect_with_url). - - - Ce type de lien était appelé, auparavant, 'persistant'. - - - <url> ::= CUBRID:<host>:<db_name>:<db_user>:<db_password>:[?<properties>] - - - <properties> ::= <property> [&<property>] - - - <properties> ::= alhosts=<alternative_hosts>[ &rctime=<time>] - - - <properties> ::= login_timeout=<milli_sec> - - - <properties> ::= query_timeout=<milli_sec> - - - <properties> ::= disconnect_on_query_timeout=true|false - - - <alternative_hosts> ::= <standby_broker1_host>:<port> [,<standby_broker2_host>:<port>] - - - <host> := HOSTNAME | IP_ADDR - - - <time> := SECOND - - - <milli_sec> := MILLI SECOND - - - host : Un nom d'hôte ou une adresse IP du serveur maître de base de données - db_name : Un nom de base de données - db_user : Un nom d'utilisateur de la base de données - db_password : Un mot de passe pour l'utilisateur de la base de données - - alhosts : Spécifie l'information du broker du serveur, qui sera utilisé comme point de sortie - lorsqu'il est impossible de se connecter au serveur actif. Il est possible de spécifier plusieurs brokers dans ce cas, - et la connexion aux brokers sera tentée dans l'ordre de la configuration alhosts - - - rctime : Un intervalle de temps à attendre avant de tenter une connexion vers un broker lorsqu'une erreur - survient. Après qu'une erreur soit survenue, le système tentera une connexion vers un broker spécifié par - althosts, termine la transaction, et ensuite, tente de se connecter au broker actif du serveur maître - de base de données. La valeur par défaut est de 600 secondes. - - - login_timeout : Valeur du délai maximal d'attente (unité : milliseconde) pour l'identification - à la base de données. Par défaut, cette valeur vaut 0, ce qui signifie que l'on attend - indéfiniment. - - - query_timeout : Valeur du délai maximal d'attente (unité : milliseconde) pour l'exécution - de la requête. Une fois cette valeur atteinte, un message pour annuler la requête - envoyée au serveur est envoyé. La valeur retournée peut dépendre de la configuration - de disconnect_on_query_timeout ; même si le message pour annuler - la requête a été envoyé au serveur, la requête peut réussir. - - - disconnect_on_query_timeout : Configure une valeur déterminant si l'on doit retourner - immédiatement une erreur pour les fonctions exécutées après le délai maximal d'attente. - La valeur par défaut est &false;. - - - - - Les caractères ? et : - utilisés comme identifiants dans les URLs de connexion PHP ne peuvent - être inclus dans le mot de passe. Voici un exemple de mot de passe - invalide, car utilisant les caractères "?:" dans l'URL de connexion. - - - $url = "CUBRID:localhost:33000:tdb:dba:12?:?login_timeout=100"; - - - Les mots de passe contenant le caractère ? ou le - caractère : peuvent être passés en tant que paramètre séparé. - - - $url = "CUBRID:localhost:33000:tbd:::?login_timeout=100"; - - - $conn = cubrid_pconnect_with_url ($url, "dba", "12?"); - - - Si le nom d'utilisateur ou le mot de passe est vide, l'on ne doit - pas supprimer les ":" ; voici un exemple : - - - $url = "CUBRID:localhost:33000:demodb:::"; - - - - - - &reftitle.parameters; - - - conn_url - - - Une &string; qui contient les informations de connexion pour le serveur. - - - - - userid - - - Nom d'utilisateur pour la base de données. - - - - - passwd - - - Mot de passe pour l'utilisateur. - - - - - - - - &reftitle.returnvalues; - - Identifiant de connexion, lorsque le processus réussit,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_pconnect_with_url</function> sans propriétés - - -]]> - - - - - Exemple avec <function>cubrid_pconnect_with_url</function> et des propriétés dans l'URL - - -]]> - - - - - - &reftitle.seealso; - - cubrid_connect - cubrid_connect_with_url - cubrid_pconnect - cubrid_disconnect - cubrid_close - - - - - diff --git a/reference/cubrid/functions/cubrid-pconnect.xml b/reference/cubrid/functions/cubrid-pconnect.xml deleted file mode 100644 index 7b7b430de9..0000000000 --- a/reference/cubrid/functions/cubrid-pconnect.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - cubrid_pconnect - Ouvre une connexion persistante vers un serveur CUBRID - - - - &reftitle.description; - - resourcecubrid_pconnect - stringhost - intport - stringdbname - stringuserid - stringpasswd - - - Établit une connexion persistante vers un serveur CUBRID. - - - cubrid_pconnect agit de la même façon que - cubrid_connect avec deux différences majeures. - - - Tout d'abord, lors de la connexion, la fonction tentera d'abord de trouver - un lien (persistant) déjà ouvert avec le même nom d'hôte, sur le même port, - utilisant la même base de données dbname ainsi que le même userid. Si un tel - lien est trouvé, son identifiant sera retourné au lieu d'ouvrir une nouvelle - connexion. - - - Ensuite, la connexion vers le serveur SQL ne sera pas fermée lorsque - la fin du script est atteinte. Au lieu de cela, le lien restera ouvert - pour une utilisation future (cubrid_close ou - cubrid_disconnect ne fermera pas les liens établis avec - cubrid_pconnect). - - - Ce type de lien est donc appelé 'persistant'. - - - - - &reftitle.parameters; - - - host - - - Nom de l'hôte ou adresse IP du serveur CUBRID CAS. - - - - - port - - - Numéro du port du serveur CUBRID CAS (BROKER_PORT configuré dans $CUBRID/conf/cubrid_broker.conf). - - - - - dbname - - - Nom de la base de données. - - - - - userid - - - Nom d'utilisateur pour la base de données. - - - - - passwd - - - Mot de passe à associer avec le nom d'utilisateur. - - - - - - - - &reftitle.returnvalues; - - Identifiant de connexion en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_pconnect</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_connect - cubrid_connect_with_url - cubrid_pconnect_with_url - cubrid_disconnect - cubrid_close - - - - - diff --git a/reference/cubrid/functions/cubrid-prepare.xml b/reference/cubrid/functions/cubrid-prepare.xml deleted file mode 100644 index ba38fe5887..0000000000 --- a/reference/cubrid/functions/cubrid-prepare.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - cubrid_prepare - Prépare une requête SQL pour son exécution - - - - &reftitle.description; - - resourcecubrid_prepare - resourceconn_identifier - stringprepare_stmt - intoption0 - - - La fonction cubrid_prepare compile une requête SQL pour un - gestionnaire de connexion donné et retourne un gestionnaire qui représente la requête - pré-compilée. - - - Une requête préparée peut être exécutée plusieurs fois, ce qui est efficace pour une - exécution répétée ou pour traiter de gros volumes de données. Une seule requête peut - être utilisée, et un paramètre peut être marqué par un point d'interrogation - (?) à l'emplacement approprié dans la requête SQL. Un paramètre est - ajouté lors de la liaison d'une valeur dans la clause VALUES d'une - instruction INSERT ou dans la clause WHERE. Il - est à noter qu'une valeur ne peut être liée à un paramètre qu'en utilisant la fonction - cubrid_bind. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - prepare_stmt - Requête préparée. - - - option - OID retourné par l'option CUBRID_INCLUDE_OID. - - - - - - &reftitle.returnvalues; - - Identifiant de requête en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_prepare</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_bind - - - - - diff --git a/reference/cubrid/functions/cubrid-put.xml b/reference/cubrid/functions/cubrid-put.xml deleted file mode 100644 index 88bc0b3a4b..0000000000 --- a/reference/cubrid/functions/cubrid-put.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - cubrid_put - Met à jour une colonne suivant son OID - - - - &reftitle.description; - - boolcubrid_put - resourceconn_identifier - stringoid - stringattr - mixedvalue - - - La fonction cubrid_put est utilisée pour mettre à jour - un attribut de l'instance pointée par l'oid fournie. - - - Il est possible de mettre à jour un seul attribut en utilisant une &string; dans le paramètre - attr. Dans ce cas, il est possible d'utiliser un &integer;, un nombre à - virgule flottante, ou une &string; comme value. Pour mettre à jour - plusieurs attributs, il faut ignorer le paramètre attr et - définir l'argument value en utilisant un tableau associatif. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - OID de l'instance que l'on veut mettre à jour. - - - attr - Nom de l'attribut que l'on veut mettre à jour. - - - value - Nouvelle valeur que l'on veut assigner à l'attribut. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_put</function> - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -array(3) { - [0]=> - string(1) "2" - [1]=> - string(1) "4" - [2]=> - string(1) "8" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_get - cubrid_set_add - cubrid_set_drop - cubrid_seq_insert - cubrid_seq_drop - cubrid_seq_put - - - - - diff --git a/reference/cubrid/functions/cubrid-rollback.xml b/reference/cubrid/functions/cubrid-rollback.xml deleted file mode 100644 index 015baf4539..0000000000 --- a/reference/cubrid/functions/cubrid-rollback.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - cubrid_rollback - Annule une transaction - - - - &reftitle.description; - - boolcubrid_rollback - resourceconn_identifier - - - La fonction cubrid_rollback annule la transaction en cours - pointée par le paramètre conn_identifier. - - - La connexion au serveur est fermée après l'appel à la fonction - cubrid_rollback. Cependant, le gestionnaire de connexion - reste actif. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_rollback</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_commit - cubrid_disconnect - - - - - diff --git a/reference/cubrid/functions/cubrid-schema.xml b/reference/cubrid/functions/cubrid-schema.xml deleted file mode 100644 index b38f28671d..0000000000 --- a/reference/cubrid/functions/cubrid-schema.xml +++ /dev/null @@ -1,629 +0,0 @@ - - - - - - - cubrid_schema - Récupère des informations sur un schéma - - - - &reftitle.description; - - arraycubrid_schema - resourceconn_identifier - intschema_type - stringclass_name - stringattr_name - - - La fonction cubrid_schema est utilisée pour - récupérer des informations d'un schéma depuis la base de données. - Pour récupérer les informations d'une classe particulière, - il faut définir class_name, - pour récupérer les informations sur un attribut particulier (seulement - utilisable avec CUBRID_SCH_ATTR_PRIVILEGE), - il faut définir attr_name. - - - - Le résultat de la fonction cubrid_schema est retourné sous la forme d'un tableau - à 2 dimensions (colonne (tableau associatif) * lignes (tableau numérique)). - Les tables suivantes montrent les types d'un schéma ainsi que la structure - d'une colonne du tableau résultant, suivant le type de schéma demandé. - - - - Composition du résultat pour chaque type - - - - Schéma - Numéro de colonne - Nom de la colonne - Valeur - - - - - CUBRID_SCH_CLASS - 1 - NAME - - - - - 2 - TYPE - 0:system class 1:vclass 2:class - - - - CUBRID_SCH_VCLASS - 1 - NAME - - - - - 2 - TYPE - 1:vclass - - - - CUBRID_SCH_QUERY_SPEC - 1 - QUERY_SPEC - - - - - CUBRID_SCH_ATTRIBUTE / CUBRID_SCH_CLASS_ATTRIBUTE - 1 - ATTR_NAME - - - - - 2 - DOMAIN - - - - - 3 - SCALE - - - - - 4 - PRECISION - - - - - 5 - INDEXED - 1:indexed - - - - 6 - NOT NULL - 1:not null - - - - 7 - SHARED - 1:shared - - - - 8 - UNIQUE - 1:unique - - - - 9 - DEFAULT - - - - - 10 - ATTR_ORDER - base:1 - - - - 11 - CLASS_NAME - - - - - 12 - SOURCE_CLASS - - - - - 13 - IS_KEY - 1:key - - - - CUBRID_SCH_METHOD / CUBRID_SCH_CLASS_METHOD - 1 - NAME - - - - - 2 - RET_DOMAIN - - - - - 3 - ARG_DOMAIN - - - - - CUBRID_SCH_METHOD_FILE - 1 - METHOD_FILE - - - - - CUBRID_SCH_SUPERCLASS / CUBRID_SCH_DIRECT_SUPER_CLASS / CUBRID_SCH_SUBCLASS - 1 - CLASS_NAME - - - - - 2 - TYPE - 0:system class 1:vclass 2:class - - - - CUBRID_SCH_CONSTRAINT - 1 - TYPE - 0:unique 1:index 2:reverse unique 3:reverse index - - - - 2 - NAME - - - - - 3 - ATTR_NAME - - - - - 4 - NUM_PAGES - - - - - 5 - NUM_KEYS - - - - - 6 - PRIMARY_KEY - 1:primary key - - - - 7 - KEY_ORDER - base:1 - - - - CUBRID_SCH_TRIGGER - 1 - NAME - - - - - 2 - STATUS - - - - - 3 - EVENT - - - - - 4 - TARGET_CLASS - - - - - 5 - TARGET_ATTR - - - - - 6 - ACTION_TIME - - - - - 7 - ACTION - - - - - 8 - PRIORITY - - - - - 9 - CONDITION_TIME - - - - - 10 - CONDITION - - - - - CUBRID_SCH_CLASS_PRIVILEGE / CUBRID_SCH_ATTR_PRIVILEGE - 1 - CLASS_NAME / ATTR_NAME - - - - - 2 - PRIVILEGE - - - - - 3 - GRANTABLE - - - - - CUBRID_SCH_PRIMARY_KEY - 1 - CLASS_NAME - - - - - 2 - ATTR_NAME - - - - - 3 - KEY_SEQ - base:1 - - - - 4 - KEY_NAME - - - - - CUBRID_SCH_IMPORTED_KEYS / CUBRID_SCH_EXPORTED_KEYS / CUBRID_SCH_CROSS_REFERENCE - 1 - PKTABLE_NAME - - - - - 2 - PKCOLUMN_NAME - - - - - 3 - FKTABLE_NAME - base:1 - - - - 4 - FKCOLUMN_NAME - - - - - 5 - KEY_SEQ - base:1 - - - - 6 - UPDATE_ACTION - 0:cascade 1:restrict 2:no action 3:set null - - - - 7 - DELETE_ACTION - 0:cascade 1:restrict 2:no action 3:set null - - - - 8 - FK_NAME - - - - - 9 - PK_NAME - - - - -
- - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - schema_type - Données du schéma à récupérer. - - - class_name - Classe pour laquelle l'on souhaite connaître le schéma. - - - attr_name - Attribut pour lequel l'on souhaite connaître le schéma. - - - - - - &reftitle.returnvalues; - - Un tableau contenant les informations sur le schéma en cas de succès,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.3.1 - - Modification de la valeur retournée : lorsque la fonction échoue, - la valeur retournée est maintenant &false; au lieu de -1. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_schema</function> - - -]]> - - &example.outputs; - - - array(4) { - ["CLASS_NAME"]=> - string(4) "game" - ["ATTR_NAME"]=> - string(12) "athlete_code" - ["KEY_SEQ"]=> - string(1) "3" - ["KEY_NAME"]=> - string(41) "pk_game_host_year_event_code_athlete_code" - } - [1]=> - array(4) { - ["CLASS_NAME"]=> - string(4) "game" - ["ATTR_NAME"]=> - string(10) "event_code" - ["KEY_SEQ"]=> - string(1) "2" - ["KEY_NAME"]=> - string(41) "pk_game_host_year_event_code_athlete_code" - } - [2]=> - array(4) { - ["CLASS_NAME"]=> - string(4) "game" - ["ATTR_NAME"]=> - string(9) "host_year" - ["KEY_SEQ"]=> - string(1) "1" - ["KEY_NAME"]=> - string(41) "pk_game_host_year_event_code_athlete_code" - } -} - ---- Foreign Keys --- -array(2) { - [0]=> - array(9) { - ["PKTABLE_NAME"]=> - string(7) "athlete" - ["PKCOLUMN_NAME"]=> - string(4) "code" - ["FKTABLE_NAME"]=> - string(4) "game" - ["FKCOLUMN_NAME"]=> - string(12) "athlete_code" - ["KEY_SEQ"]=> - string(1) "1" - ["UPDATE_RULE"]=> - string(1) "1" - ["DELETE_RULE"]=> - string(1) "1" - ["FK_NAME"]=> - string(20) "fk_game_athlete_code" - ["PK_NAME"]=> - string(15) "pk_athlete_code" - } - [1]=> - array(9) { - ["PKTABLE_NAME"]=> - string(5) "event" - ["PKCOLUMN_NAME"]=> - string(4) "code" - ["FKTABLE_NAME"]=> - string(4) "game" - ["FKCOLUMN_NAME"]=> - string(10) "event_code" - ["KEY_SEQ"]=> - string(1) "1" - ["UPDATE_RULE"]=> - string(1) "1" - ["DELETE_RULE"]=> - string(1) "1" - ["FK_NAME"]=> - string(18) "fk_game_event_code" - ["PK_NAME"]=> - string(13) "pk_event_code" - } -} - ---- Column Attribute --- -array(1) { - [0]=> - array(13) { - ["ATTR_NAME"]=> - string(4) "area" - ["DOMAIN"]=> - string(1) "7" - ["SCALE"]=> - string(1) "2" - ["PRECISION"]=> - string(2) "10" - ["INDEXED"]=> - string(1) "0" - ["NON_NULL"]=> - string(1) "0" - ["SHARED"]=> - string(1) "0" - ["UNIQUE"]=> - string(1) "0" - ["DEFAULT"]=> - NULL - ["ATTR_ORDER"]=> - string(1) "4" - ["CLASS_NAME"]=> - string(7) "stadium" - ["SOURCE_CLASS"]=> - string(7) "stadium" - ["IS_KEY"]=> - string(1) "0" - } -} -]]> - - - - - - diff --git a/reference/cubrid/functions/cubrid-seq-drop.xml b/reference/cubrid/functions/cubrid-seq-drop.xml deleted file mode 100644 index eaec603921..0000000000 --- a/reference/cubrid/functions/cubrid-seq-drop.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - cubrid_seq_drop - Supprime un élément d'une séquence - - - - &reftitle.description; - - boolcubrid_seq_drop - resourceconn_identifier - stringoid - stringattr_name - intindex - - - La fonction cubrid_seq_drop est utilisée pour supprimer - un élément de la base de données en se basant sur la séquence de types - d'attributs fournie. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - OID de l'instance à utiliser. - - - attr_name - Nom de l'attribut depuis lequel l'élément doit être supprimé. - - - index - Index de l'élément à supprimer (en commençant à 1). - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_seq_drop</function> - - -]]> - - &example.outputs; - - - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" -} -array(3) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_seq_insert - cubrid_seq_put - - - - - diff --git a/reference/cubrid/functions/cubrid-seq-insert.xml b/reference/cubrid/functions/cubrid-seq-insert.xml deleted file mode 100644 index ef568924a7..0000000000 --- a/reference/cubrid/functions/cubrid-seq-insert.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - cubrid_seq_insert - Insère un élément dans une séquence - - - - &reftitle.description; - - boolcubrid_seq_insert - resourceconn_identifier - stringoid - stringattr_name - intindex - stringseq_element - - - La fonction cubrid_seq_insert est utilisée pour - insérer un élément dans une séquence de types d'attributs. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - OID de l'instance à utiliser. - - - attr_name - Nom de l'attribut à insérer. - - - index - Position de l'élément pour son insertion (en commençant à 1). - - - seq_element - Contenu de l'élément à insérer. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_seq_insert</function> - - -]]> - - &example.outputs; - - - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" -} -array(5) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" - [4]=> - string(2) "44" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_seq_drop - cubrid_seq_put - - - - - diff --git a/reference/cubrid/functions/cubrid-seq-put.xml b/reference/cubrid/functions/cubrid-seq-put.xml deleted file mode 100644 index da0647cbfa..0000000000 --- a/reference/cubrid/functions/cubrid-seq-put.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - cubrid_seq_put - Met à jour la valeur d'un élément d'une séquence - - - - &reftitle.description; - - boolcubrid_seq_put - resourceconn_identifier - stringoid - stringattr_name - intindex - stringseq_element - - - La fonction cubrid_seq_put est utilisée pour - mettre à jour le contenu d'un élément dans une séquence de types - d'attributs. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - OID de l'instance à utiliser. - - - attr_name - Nom de l'attribut à utiliser. - - - index - Index (en commençant à 1) de l'élément à mettre à jour. - - - seq_element - Nouveau contenu à placer dans l'élément. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_seq_put</function> - - -]]> - - &example.outputs; - - - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" -} -array(4) { - [0]=> - string(3) "111" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_seq_drop - cubrid_seq_insert - - - - - diff --git a/reference/cubrid/functions/cubrid-set-add.xml b/reference/cubrid/functions/cubrid-set-add.xml deleted file mode 100644 index e77a7cab60..0000000000 --- a/reference/cubrid/functions/cubrid-set-add.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - cubrid_set_add - Insère un seul élément pour définir le type d'une colonne - - - - &reftitle.description; - - boolcubrid_set_add - resourceconn_identifier - stringoid - stringattr_name - stringset_element - - - La fonction cubrid_set_add est utilisée pour insérer - un seul élément dans un jeu de types d'attributs. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - OID de l'instance à utiliser. - - - attr_name - Nom de l'attribut dans lequel le nouvel élément sera inséré. - - - set_element - Contenu de l'élément à insérer. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_set_add</function> - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -array(4) { - [0]=> - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" - [3]=> - string(1) "4" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_seq_drop - - - - - diff --git a/reference/cubrid/functions/cubrid-set-autocommit.xml b/reference/cubrid/functions/cubrid-set-autocommit.xml deleted file mode 100644 index 8e048a0b35..0000000000 --- a/reference/cubrid/functions/cubrid-set-autocommit.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - cubrid_set_autocommit - Définit le mode auto-commit pour la connexion - - - - &reftitle.description; - - boolcubrid_set_autocommit - resourceconn_identifier - boolmode - - - La fonction cubrid_set_autocommit est utilisée pour - définir le mode auto-commit pour la connexion à la base de données CUBRID. - - - En CUBRID PHP, le mode auto-commit est désactivé par défaut pour la gestion - des transactions. Lorsque le mode auto-commit passe d'Off à On, tous les - travaux en attente sont automatiquement validés. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - mode - - Le mode auto-commit. Les constantes suivantes peuvent être utilisées : - - CUBRID_AUTOCOMMIT_FALSE - CUBRID_AUTOCOMMIT_TRUE - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - cubrid_get_autocommit - cubrid_commit - - - - diff --git a/reference/cubrid/functions/cubrid-set-db-parameter.xml b/reference/cubrid/functions/cubrid-set-db-parameter.xml deleted file mode 100644 index db5219b056..0000000000 --- a/reference/cubrid/functions/cubrid-set-db-parameter.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - cubrid_set_db_parameter - Définit les paramètres de base de données CUBRID - - - - &reftitle.description; - - boolcubrid_set_db_parameter - resourceconn_identifier - intparam_type - intparam_value - - - La fonction cubrid_set_db_parameter est utilisée - pour définir les paramètres de base de données CUBRID. Elle peut - définir les paramètres de base de données CUBRID suivants : - - - PARAM_ISOLATION_LEVEL - PARAM_LOCK_TIMEOUT - - - - - Le mode auto-commit peut être défini en utilisant la fonction - cubrid_set_autocommit. - - - - - - &reftitle.parameters; - - - conn_identifier - - La connexion CUBRID. Si l'identifiant de connexion n'est pas spécifié, - le dernier lien ouvert par la fonction - cubrid_connect sera utilisé. - - - - param_type - Type de paramètre de la base de données. - - - param_value - Niveau d'isolation (1-6) ou la valeur du délai d'expiration (en secondes). - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_get_db_parameter</function> - - -]]> - - &example.outputs; - - - int(3) - ["PARAM_LOCK_TIMEOUT"]=> - int(-1) - ["PARAM_MAX_STRING_LENGTH"]=> - int(1073741823) - ["PARAM_AUTO_COMMIT"]=> - int(0) -} -array(4) { - ["PARAM_ISOLATION_LEVEL"]=> - int(2) - ["PARAM_LOCK_TIMEOUT"]=> - int(-1) - ["PARAM_MAX_STRING_LENGTH"]=> - int(1073741823) - ["PARAM_AUTO_COMMIT"]=> - int(1) -} -]]> - - - - - - &reftitle.seealso; - - cubrid_get_db_parameter - cubrid_set_autocommit - - - - diff --git a/reference/cubrid/functions/cubrid-set-drop.xml b/reference/cubrid/functions/cubrid-set-drop.xml deleted file mode 100644 index 48ac8ff548..0000000000 --- a/reference/cubrid/functions/cubrid-set-drop.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - cubrid_set_drop - Supprime un élément - - - - &reftitle.description; - - boolcubrid_set_drop - resourceconn_identifier - stringoid - stringattr_name - stringset_element - - - La fonction cubrid_set_drop est utilisée pour - supprimer un élément depuis un attribut donné de la base de données. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - OID de l'instance à utiliser. - - - attr_name - Nom de l'attribut depuis lequel l'élément sera supprimé. - - - set_element - Contenu de l'élément à supprimer. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_set_drop</function> - - -]]> - -&example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -array(2) { - [0]=> - string(1) "2" - [1]=> - string(1) "3" -} -]]> - - - - - - - &reftitle.seealso; - - cubrid_set_add - - - - - diff --git a/reference/cubrid/functions/cubrid-set-query-timeout.xml b/reference/cubrid/functions/cubrid-set-query-timeout.xml deleted file mode 100644 index 9026855859..0000000000 --- a/reference/cubrid/functions/cubrid-set-query-timeout.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - cubrid_set_query_timeout - Définit le délai maximal d'exécution d'une requête - - - - &reftitle.description; - - boolcubrid_set_query_timeout - resourcereq_identifier - inttimeout - - - La fonction cubrid_set_query_timeout est utilisée pour définir - le délai maximal d'exécution d'une requête. - - - - - &reftitle.parameters; - - - req_identifier - - - Identifiant de requête. - - - - - timeout - - - Délai maximal, en millisecondes. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - cubrid_get_query_timeout - - - - diff --git a/reference/cubrid/functions/cubrid-version.xml b/reference/cubrid/functions/cubrid-version.xml deleted file mode 100644 index c03115228a..0000000000 --- a/reference/cubrid/functions/cubrid-version.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - cubrid_version - Récupère la version du module PHP CUBRID - - - - &reftitle.description; - - stringcubrid_version - - - - La fonction cubrid_version est utilisée - pour récupérer la version du module PHP CUBRID. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Information sur la version (c.-à-d. "8.3.1.0001"). - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_version</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_error_code - cubrid_error_code_facility - - - - - - diff --git a/reference/cubrid/oldaliases/cubrid-load-from-glo.xml b/reference/cubrid/oldaliases/cubrid-load-from-glo.xml deleted file mode 100644 index f3ae7a1cb1..0000000000 --- a/reference/cubrid/oldaliases/cubrid-load-from-glo.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - cubrid_load_from_glo - Lie une donnée - - - - &reftitle.description; - - intcubrid_load_from_glo - resourceconn_identifier - stringoid - stringfile_name - - - La fonction cubrid_load_from_glo est utilisée pour - lire une donnée depuis une instance glo, et la sauvegarde dans un fichier - donné. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - Oid de l'instance glo depuis laquelle l'on veut lire la donnée. - - - file_name - Nom du fichier où la sauvegarde de la donnée doit s'effectuer. - - - - - - &reftitle.returnvalues; - - &true; lorsque le processus est un succès. - - - &false; lorsque le processus a échoué. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_load_from_glo</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - cubrid_load_from_glo - - - - - Cette fonction a été supprimée depuis CUBRID 3.1. - - - - - - &reftitle.seealso; - - cubrid_new_glo - cubrid_save_to_glo - cubrid_send_glo - - - - - diff --git a/reference/cubrid/oldaliases/cubrid-new-glo.xml b/reference/cubrid/oldaliases/cubrid-new-glo.xml deleted file mode 100644 index 9c6cd7980e..0000000000 --- a/reference/cubrid/oldaliases/cubrid-new-glo.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - cubrid_new_glo - Crée une instance glo - - - - &reftitle.description; - - stringcubrid_new_glo - resourceconn_identifier - stringclass_name - stringfile_name - - - La fonction cubrid_new_glo est utilisée pour créer une - instance glo dans la classe demandée (classe glo). - Le glo créé est de type LO, et est stocké dans le fichier - file_name. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - class_name - Nom de la classe dans laquelle l'on veut créer le glo. - - - file_name - Le nom du fichier dans lequel l'on veut sauvegarder le nouveau glo créé. - - - - - - &reftitle.returnvalues; - - OID de l'instance créée en cas de succès. - - - &false; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_new_glo</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - cubrid_new_glo - - - - - Cette fonction a été supprimée depuis CUBRID 3.1. - - - - - - &reftitle.seealso; - - cubrid_save_to_glo - cubrid_load_from_glo - cubrid_send_glo - - - - - diff --git a/reference/cubrid/oldaliases/cubrid-save-to-glo.xml b/reference/cubrid/oldaliases/cubrid-save-to-glo.xml deleted file mode 100644 index abc509069a..0000000000 --- a/reference/cubrid/oldaliases/cubrid-save-to-glo.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - cubrid_save_to_glo - Sauvegarde un fichier dans une instance glo - - - - &reftitle.description; - - intcubrid_save_to_glo - resourceconn_identifier - stringoid - stringfile_name - - - La fonction cubrid_save_to_glo est utilisée pour sauvegarder - un fichier dans une instance glo. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - Oid de l'instance glo dans laquelle le fichier sera sauvegardé. - - - file_name - Le nom du fichier à sauvegarder. - - - - - - &reftitle.returnvalues; - - &true; en cas de succès. - - - &false; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_save_to_glo</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - cubrid_save_to_glo - - - - - Cette fonction a été supprimée depuis CUBRID 3.1. - - - - - - &reftitle.seealso; - - cubrid_new_glo - cubrid_load_from_glo - cubrid_send_glo - - - - - diff --git a/reference/cubrid/oldaliases/cubrid-send-glo.xml b/reference/cubrid/oldaliases/cubrid-send-glo.xml deleted file mode 100644 index 98128efc33..0000000000 --- a/reference/cubrid/oldaliases/cubrid-send-glo.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - cubrid_send_glo - Lit les données depuis une instance glo - - - - &reftitle.description; - - intcubrid_send_glo - resourceconn_identifier - stringoid - - - La fonction cubrid_send_glo est utilisée pour - lire les données depuis une instance glo et les envoie à la sortie - standard de PHP. - - - - - &reftitle.parameters; - - - conn_identifier - Identifiant de connexion. - - - oid - Oid de l'instance glo depuis laquelle les données sont lues. - - - - - - &reftitle.returnvalues; - - &true; en cas de succès. - - - &false; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <function>cubrid_send_glo</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - cubrid_send_glo - - - - - Cette fonction a été supprimée depuis CUBRID 3.1. - - - - - - &reftitle.seealso; - - cubrid_new_glo - cubrid_save_to_glo - cubrid_load_from_glo - - - - - diff --git a/reference/cubrid/reference.xml b/reference/cubrid/reference.xml deleted file mode 100644 index 7617acd2a3..0000000000 --- a/reference/cubrid/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; CUBRID - - &reference.cubrid.entities.functions; - - - - diff --git a/reference/cubrid/setup.xml b/reference/cubrid/setup.xml deleted file mode 100644 index 969d59a8a4..0000000000 --- a/reference/cubrid/setup.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - &reftitle.setup; - -
- &reftitle.required; - - Afin d'avoir accès à ces fonctions, il faut installer CUBRID, - et compiler la bibliothèque PHP CUBRID avec le support CUBRID. - -
- - &reference.cubrid.configure; - -
- &reftitle.runtime; - - Il n'y a pas actuellement de configuration au moment de l'exécution. - -
- -
- &reftitle.resources; - - Il y a 4 types de ressources utilisés dans CUBRID. La première - est l'identifiant du lien pour une connexion à la base de données, - la seconde est une ressource qui contient le résultat d'une requête, - et les deux dernières, une ressource qui contient les résultats d'une - requête pour les types de données BLOB/CLOB. - -
- Identifiant de connexion - - Un identifiant de connexion retourné par les fonctions - cubrid_connect, - cubrid_connect_with_url, - cubrid_pconnect et - cubrid_pconnect_with_url. - -
-
- Identifiant de requête - - Un identifiant de requête retourné par la fonction - cubrid_prepare et par la fonction - cubrid_execute. - -
-
- Identifiant LOB - - Un identifiant LOB retourné par la fonction - cubrid_lob_get. - -
-
- Identifiant LOB2 - - Un identifiant LOB retourné par la fonction - cubrid_lob2_new ou récupéré depuis le jeu - de résultats. - -
- -
- - - diff --git a/reference/dbase/book.xml b/reference/dbase/book.xml deleted file mode 100644 index dcb95056ba..0000000000 --- a/reference/dbase/book.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - - dBase - - - - &reftitle.intro; - - - &pecl.moved-ver;5.3.0. - - - - Ces fonctions permettent d'accéder aux enregistrements des bases - de données au format dBase (dbf). - - - - Il est recommandé de ne pas utiliser les fichiers dBase - comme la base de données de production. Il est recommandé d'utiliser - SQLite ou d'opter plutôt pour un vrai - serveur SQL à la place ; - MySQL ou - PostgreSQL - sont des choix communs en PHP. Le support dBase est présent en PHP - uniquement pour permettre d'importer et d'exporter des données - depuis et vers la base de données, car ce format de fichier - est habituellement compris par les tableurs Windows. - - - - - À partir de dbase 7.0.0 les bases de données sont automatiquement verrouillées - via flock. Il n'y avait aucun support pour le verrouillage - précédemment, donc deux processus de serveur web concomitants modifiant le même - fichier dBase auraient très probablement ruiné la base de données. Ceci peut se - produire même avec dbase 7.0.0+ sur les systèmes qui implémentent le verrouillage - au niveau du processus avec les SAPI multithreadés. - - - - Les fichiers dBase sont de simples fichiers séquentiels, d'un - nombre d'enregistrements fixe. Les enregistrements sont ajoutés - à la fin du fichier et les enregistrements effacés sont - conservés tant que l'on n'appelle pas la fonction - dbase_pack. - - - Seuls les fichiers dbf levels 3 (dBASE III+) - 5 (dBASE V) sont supportés. - Les types de champs dBase disponibles sont : - - Types de champs disponibles - - - - Champ - Type dBase - Format - Informations complémentaires - - - - - M - Memo - n/a - Ce type n'est pas supporté par PHP, et sera ignoré - - - D - Date - YYYYMMDD - La taille du champ est limitée à 8 - - - T - DateTime - YYYYMMDDhhmmss.uuu - (FoxPro) Aucune vérification de validité n'est faite. Disponible à partir de dbase 7.0.0. - - - N - Number - Un nombre - - Il faut déclarer une taille et une précision (le nombre de chiffres - après le point décimal). - - - - F - Float - Un nombre flottant - Identique à N. - - - C - &string; - Une chaîne de caractères - - Il faut déclarer une taille. Lors de la récupération des - données, la chaîne sera complétée d'espaces afin d'atteindre la - taille déclarée. Les &string; trop longues seront tronquées silencieusement - lors de l'enregistrement. - - - - L - &boolean; - - T ou Y pour &true;, - F ou N pour &false;, - ? pour non initialisée. - - - À partir de dbase 7.0.0, retourné en tant que bool (&true; ou &false;), - ou &null; pour les champs non initialisés. - Précédemment, retourné en tant que int (1 ou 0). - - - - -
- - - - À partir de dbase 7.0.0 les champs nullable sont supportés pour les bases de - données DBASE_TYPE_FOXPRO. Si un champ est nullable, - passer &null; définira le drapeau respectif, et lors d'une récupération ultérieure - la valeur du champ sera &null;. - - - - - Il n'y a aucun support des index ou des champs memo. - - - - - - &reference.dbase.setup; - &reference.dbase.constants; - &reference.dbase.reference; - - - - diff --git a/reference/dbase/configure.xml b/reference/dbase/configure.xml deleted file mode 100644 index fe0539fe4e..0000000000 --- a/reference/dbase/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;dbase. - -
- - diff --git a/reference/dbase/constants.xml b/reference/dbase/constants.xml deleted file mode 100644 index 02e1fa5ee5..0000000000 --- a/reference/dbase/constants.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - DBASE_VERSION - (string) - - - - La version de l'extension - (Disponible à partir de dbase 7.0.0) - - - - - - DBASE_RDONLY - (int) - - - - Ouvre une base de données en lecture seule. Utilisé avec dbase_open. - (Disponible à partir de dbase 7.0.0) - - - - - - DBASE_RDWR - (int) - - - - Ouvre une base de données en lecture et écriture. - Utilisé avec dbase_open. - (Disponible à partir de dbase 7.0.0) - - - - - - DBASE_TYPE_DBASE - (int) - - - - Crée une base de données style dBASE. Utilisé avec dbase_create. - (Disponible à partir de dbase 7.0.0) - - - - - - DBASE_TYPE_FOXPRO - (int) - - - - Crée une base de données style FoxPro. Utilisé avec dbase_create. - (Disponible à partir de dbase 7.0.0) - - - - - - - - diff --git a/reference/dbase/functions/dbase-add-record.xml b/reference/dbase/functions/dbase-add-record.xml deleted file mode 100644 index b8c4bd9919..0000000000 --- a/reference/dbase/functions/dbase-add-record.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - - dbase_add_record - Ajoute un enregistrement dans une base de données dBase - - - &reftitle.description; - - booldbase_add_record - resourcedatabase - arraydata - - - dbase_add_record ajoute les données fournies dans la - base de données dBase spécifiée. - - - - &reftitle.parameters; - - - - database - - - La ressource de base de données, retournée par - dbase_open ou dbase_create. - - - - - data - - - Un tableau de données indexé. Le nombre d'éléments doit être égal - au nombre de champs dans la base de données, sinon la fonction - dbase_add_record échouera. - - - - Si l'on utilise dbase_get_record pour retourner - une valeur pour ce paramètre, il ne faut pas oublier de réinitialiser la clé nommée - deleted. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database est maintenant une resource - au lieu d'un int. - - - - - - - - - &reftitle.examples; - - - Insertion d'un enregistrement dans une base de données dBase - - -]]> - - - - - - &reftitle.seealso; - - - dbase_delete_record - dbase_replace_record - - - - - - diff --git a/reference/dbase/functions/dbase-close.xml b/reference/dbase/functions/dbase-close.xml deleted file mode 100644 index 4384243ee4..0000000000 --- a/reference/dbase/functions/dbase-close.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - - dbase_close - Ferme une base dBase - - - &reftitle.description; - - booldbase_close - resourcedatabase - - - dbase_close ferme la base de données correspondant à la - ressource database. - - - - &reftitle.parameters; - - - - database - - - La ressource de base de données, retournée par - dbase_open ou dbase_create. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database est maintenant une resource - au lieu d'un int. - - - - - - - - - &reftitle.examples; - - - Ferme un fichier de base de données dBase - - -]]> - - - - - - &reftitle.seealso; - - - dbase_open - dbase_create - - - - - - diff --git a/reference/dbase/functions/dbase-create.xml b/reference/dbase/functions/dbase-create.xml deleted file mode 100644 index 268a6c5da0..0000000000 --- a/reference/dbase/functions/dbase-create.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - - dbase_create - Crée une base de données dBase - - - &reftitle.description; - - resourcedbase_create - stringpath - arrayfields - inttypeDBASE_TYPE_DBASE - - - dbase_create crée une base de - données dBase avec la définition fournie. - Si le fichier existe déjà, il n'est pas tronqué. - dbase_pack peut être appelé pour forcer une troncature. - - ¬e.open-basedir.func; - - - - &reftitle.parameters; - - - - path - - - Le chemin vers la base de données. Il peut être un chemin relatif ou absolu - vers le fichier où dBase stockera les données. - - - - - fields - - - Un tableau de tableaux, chaque tableau décrit le format d'un champ de la - base de données. Chaque champ est constitué d'un nom, d'un caractère - indiquant le type du champ et optionnellement, une longueur, une précision - et un drapeau nullable. - Les champs supportés sont énumérés dans la - section d'introduction. - - - - Les noms des champs sont limités en longueur et ne doivent - pas excéder 10 caractères. - - - - - - type - - - Le type de base de données à créer. Soit - DBASE_TYPE_DBASE ou - DBASE_TYPE_FOXPRO. - - - - - - - - &reftitle.returnvalues; - - Retourne une ressource de base de données si la base de données - a été créée avec succès, ou &false; si une erreur survient. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - Le paramètre type a été ajouté. - - - - PECL dbase 7.0.0 - - Le type de retour de dbase_identifier est - désormais une resource au lieu d'un int. - - - - - - - - - &reftitle.examples; - - - Création d'un fichier de base de données dBase - - -]]> - - - - - - &reftitle.seealso; - - - dbase_open - dbase_close - - - - - - diff --git a/reference/dbase/functions/dbase-delete-record.xml b/reference/dbase/functions/dbase-delete-record.xml deleted file mode 100644 index b91fb63a8a..0000000000 --- a/reference/dbase/functions/dbase-delete-record.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - dbase_delete_record - Efface un enregistrement dans une base dBase - - - - &reftitle.description; - - booldbase_delete_record - resourcedatabase - intnumber - - - Marque l'enregistrement donné pour être effacé de la base de données. - - - - Pour effacer réellement l'enregistrement de la base de données, il faut - appeler la fonction dbase_pack. - - - - - - &reftitle.parameters; - - - - database - - - La ressource de base de données, retournée par - dbase_open ou dbase_create. - - - - - number - - - Un entier compris entre 1 et le nombre maximal d'enregistrements dans - la base de données (tel que retourné par la fonction - dbase_numrecords). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database est maintenant une resource - au lieu d'un int. - - - - - - - - - &reftitle.seealso; - - - dbase_add_record - dbase_replace_record - - - - - - diff --git a/reference/dbase/functions/dbase-get-header-info.xml b/reference/dbase/functions/dbase-get-header-info.xml deleted file mode 100644 index 9684188afc..0000000000 --- a/reference/dbase/functions/dbase-get-header-info.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - - dbase_get_header_info - Récupère des informations d'en-tête d'une base de données dBase - - - &reftitle.description; - - arraydbase_get_header_info - resourcedatabase - - - dbase_get_header_info retourne des informations sur - la structure des colonnes de la base de données référencée par la ressource - database. - - - - &reftitle.parameters; - - - - database - - - La ressource de base de données, retournée par - dbase_open ou dbase_create. - - - - - - - - &reftitle.returnvalues; - - Un tableau indexé avec une entrée pour chaque colonne de la base de données. - L'index du tableau commence à 0. - - - Chaque élément du tableau contient un tableau associatif contenant les informations - sur les colonnes, comme décrit ici : - - - name - - - Le nom de la colonne - - - - - type - - - Le nom lisible du type de la colonne (c.-à-d. date, - booléen, etc.) - Les types de champs supportés sont énumérés dans la - section d'introduction. - - - - - length - - - Le nombre d'octets que cette colonne peut contenir - - - - - precision - - - Le nombre de décimales pour la colonne - - - - - format - - - Un format printf suggéré pour la colonne - - - - - offset - - - La position de la colonne depuis le début de la ligne - - - - - - - Si les informations d'en-tête de la base de données ne peuvent pas - être lues, &false; est retourné. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database est maintenant une resource - au lieu d'un int. - - - - - - - - - &reftitle.examples; - - - Affiche les informations d'en-tête pour un fichier de base de données dBase - - -]]> - - - - - - - diff --git a/reference/dbase/functions/dbase-get-record-with-names.xml b/reference/dbase/functions/dbase-get-record-with-names.xml deleted file mode 100644 index 30bc963039..0000000000 --- a/reference/dbase/functions/dbase-get-record-with-names.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - - dbase_get_record_with_names - - Lit un enregistrement dans une base dBase, sous la forme d'un tableau associatif - - - - &reftitle.description; - - arraydbase_get_record_with_names - resourcedatabase - intnumber - - - Récupère un enregistrement d'une base de données dBase en tant qu'un tableau associatif. - - - - &reftitle.parameters; - - - - database - - - La ressource de base de données, retournée par - dbase_open ou dbase_create. - - - - - number - - - L'index de l'enregistrement entre 1 et - dbase_numrecords($dbase_identifier). - - - - - - - - &reftitle.returnvalues; - - L'enregistrement, sous la forme d'un tableau associatif. Ceci inclut - également une clé nommée deleted qui est définie - à 1 si l'enregistrement a été marqué pour effacement - (voir la fonction dbase_delete_record). - Par conséquent il n'est pas possible de récupérer la valeur d'un champ nommé - deleted avec cette fonction. - - &dbase.type-conversion; - - En cas d'erreur, dbase_get_record_with_names - retourne &false;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database est maintenant une resource - au lieu d'un int. - - - - - - - - - &reftitle.examples; - - - Liste tous les membres enregistrés dans la base de données - - -]]> - - - - - - &reftitle.seealso; - - - dbase_get_record - - - - - - diff --git a/reference/dbase/functions/dbase-get-record.xml b/reference/dbase/functions/dbase-get-record.xml deleted file mode 100644 index 934724b41e..0000000000 --- a/reference/dbase/functions/dbase-get-record.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - - dbase_get_record - Lit un enregistrement dans une base dBase - - - &reftitle.description; - - arraydbase_get_record - resourcedatabase - intnumber - - - dbase_get_record retourne les données de - l'enregistrement number dans un tableau. - - - - &reftitle.parameters; - - - - database - - - La ressource de base de données, retournée par - dbase_open ou dbase_create. - - - - - number - - - L'index de l'enregistrement entre 1 et - dbase_numrecords($dbase_identifier). - - - - - - - - &reftitle.returnvalues; - - Un tableau indexé avec l'enregistrement. Ce tableau inclut également - une clé associée nommée deleted qui est définie à 1 - si l'enregistrement a été marqué pour effacement (voir - dbase_delete_record). - - &dbase.type-conversion; - - En cas d'erreur, dbase_get_record retourne &false;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database est maintenant une resource - au lieu d'un int. - - - - - - - - - &reftitle.seealso; - - - dbase_get_record_with_names - - - - - - diff --git a/reference/dbase/functions/dbase-numfields.xml b/reference/dbase/functions/dbase-numfields.xml deleted file mode 100644 index 92387d0303..0000000000 --- a/reference/dbase/functions/dbase-numfields.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - dbase_numfields - Compte le nombre de champs d'une base dBase - - - &reftitle.description; - - intdbase_numfields - resourcedatabase - - - Retourne le nombre de champs (colonnes) de la base de données spécifiée. - - - - Les champs sont numérotés de 0 à dbase_numfields($db)-1, - tandis que les enregistrements sont numérotés de 1 à - dbase_numrecords($db). - - - - - &reftitle.parameters; - - - - database - - - La ressource de base de données, retournée par - dbase_open ou dbase_create. - - - - - - - - &reftitle.returnvalues; - - Le nombre de champs de la base de données, ou &false; si une erreur survient. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database est maintenant une resource - au lieu d'un int. - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>dbase_numfields</function> - - -]]> - - - - - - &reftitle.seealso; - - - dbase_numrecords - - - - - - diff --git a/reference/dbase/functions/dbase-numrecords.xml b/reference/dbase/functions/dbase-numrecords.xml deleted file mode 100644 index 06c2827695..0000000000 --- a/reference/dbase/functions/dbase-numrecords.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - - dbase_numrecords - Compte le nombre d'enregistrements dans une base dBase - - - &reftitle.description; - - intdbase_numrecords - resourcedatabase - - - Récupère le nombre d'enregistrements (lignes) dans la base spécifiée. - - - - Les enregistrements marqués comme supprimés sont aussi comptés. - - - - - Les numéros de champ sont numérotés de 0 à - dbase_numfields($db)-1, tandis que les numéros - d'enregistrements sont numérotés de 1 à - dbase_numrecords($db). - - - - - &reftitle.parameters; - - - - database - - - Une ressource de base de données, retournée par - dbase_open ou dbase_create. - - - - - - - - &reftitle.returnvalues; - - Le nombre d'enregistrements dans la base de données ou &false; si une - erreur survient. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - Le paramètre database est maintenant une - resource au lieu d'un int. - - - - - - - - - &reftitle.examples; - - - Lecture de tous les enregistrements de la base de données - - -]]> - - - - - - &reftitle.seealso; - - - dbase_numfields - - - - - - diff --git a/reference/dbase/functions/dbase-open.xml b/reference/dbase/functions/dbase-open.xml deleted file mode 100644 index 5a2937aca3..0000000000 --- a/reference/dbase/functions/dbase-open.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - dbase_open - Ouvre une base dBase - - - &reftitle.description; - - resourcefalsedbase_open - stringpath - intmode - - - dbase_open ouvre une base de données dBase - avec un mode d'accès donné. - - ¬e.open-basedir.func; - - - &reftitle.parameters; - - - - path - - - Le chemin vers la base de données. Il peut être un chemin relatif ou absolu - vers le fichier où dBase stockera les données. - - - - - mode - - - Un entier correspondant à celui utilisé pour l'appel système - open() (Typiquement, 0 signifie lecture seule, 1 - signifie écriture seule, et 2 signifie lecture et écriture). - - - - Il n'est pas possible d'ouvrir un fichier dBase en mode écriture seule, car la fonction - échouera lors de la lecture des informations d'en-têtes et donc, l'on ne peut - pas utiliser 1 comme mode. - - - - À partir de dbase 7.0.0 DBASE_RDONLY et - DBASE_RDWR peuvent être utilisés, respectivement, - pour définir le mode. - - - - - - - - - &reftitle.returnvalues; - - Retourne une ressource de base de données en cas de succès, - &return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - La valeur retournée est maintenant une resource - au lieu d'un int. - - - - - - - - - &reftitle.examples; - - - Ouverture d'un fichier de base de données dBase - - -]]> - - - - - - - &reftitle.seealso; - - - dbase_create - dbase_close - - - - - - diff --git a/reference/dbase/functions/dbase-pack.xml b/reference/dbase/functions/dbase-pack.xml deleted file mode 100644 index cab14c7835..0000000000 --- a/reference/dbase/functions/dbase-pack.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - - dbase_pack - Compacte une base dBase - - - &reftitle.description; - - booldbase_pack - resourcedatabase - - - Compacte la base de données spécifiée en supprimant définitivement tous - les enregistrements marqués pour l'effacement à l'aide de - dbase_delete_record. - Il est à noter que le fichier sera tronqué après un compactage réussi - (contrairement à la commande PACK de dBASE III). - - - - &reftitle.parameters; - - - - database - - - La ressource de base de données, retournée par - dbase_open ou dbase_create. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database est maintenant - une resource au lieu d'un int. - - - - - - - - - &reftitle.examples; - - - Vide une base de données dBase - - -]]> - - - - - - - &reftitle.seealso; - - - dbase_delete_record - - - - - - diff --git a/reference/dbase/functions/dbase-replace-record.xml b/reference/dbase/functions/dbase-replace-record.xml deleted file mode 100644 index 6f4f91bce6..0000000000 --- a/reference/dbase/functions/dbase-replace-record.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - - dbase_replace_record - Remplace un enregistrement dans une base dBase - - - &reftitle.description; - - booldbase_replace_record - resourcedatabase - arraydata - intnumber - - - Remplace l'enregistrement passé dans la base de données avec les données fournies. - - - - &reftitle.parameters; - - - - database - - - La ressource de base de données, retournée par - dbase_open ou dbase_create. - - - - - data - - - Un tableau indexé des données. Le nombre d'éléments doit être égal - au nombre de champs dans la base de données, sinon la fonction - dbase_replace_record échouera. - - - - Si l'on utilise dbase_get_record pour retourner la valeur - de ce paramètre, il ne faut pas oublier de réinitialiser la clé nommée - deleted. - - - - - - number - - - Un entier entre 1 et le nombre total d'enregistrements dans la - base de données (comme retourné par la fonction - dbase_numrecords). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - Le paramètre database est maintenant - une resource au lieu d'un int. - - - - - - - - - &reftitle.examples; - - - Mise à jour d'un enregistrement dans une base de données - - -]]> - - - - - - - &reftitle.notes; - - - Les résultats de champs &boolean; sont des éléments de valeur de type &integer; - (0 ou 1) quand récupérés via - dbase_get_record ou - dbase_get_record_with_names. Si elles sont réécrites, - ceci fera que la valeur deviendra 0, des précautions doivent - donc être prises pour ajuster correctement les valeurs. - - - - - - &reftitle.seealso; - - - dbase_add_record - dbase_delete_record - - - - - - diff --git a/reference/dbase/reference.xml b/reference/dbase/reference.xml deleted file mode 100644 index f327c63c11..0000000000 --- a/reference/dbase/reference.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - &Functions; dBase - - -
- &reftitle.examples; - - La plupart des exemples de cette documentation nécessitent une base - de données dBase. Nous utiliserons /tmp/test.dbf - qui est créée dans l'exemple de la fonction dbase_create. - -
- - - - &reference.dbase.entities.functions; - - - - diff --git a/reference/dbase/setup.xml b/reference/dbase/setup.xml deleted file mode 100644 index df7a07a5c3..0000000000 --- a/reference/dbase/setup.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.dbase.configure; - - - -
- &reftitle.resources; - - À partir de dbase 7.0.0, le type de ressource dbase est défini, - qui est retourné par dbase_open et - dbase_create. - -
- - - - - - diff --git a/reference/dio/book.xml b/reference/dio/book.xml deleted file mode 100644 index 24e90383a6..0000000000 --- a/reference/dio/book.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - Direct IO - - - - &reftitle.intro; - - PHP supporte les fonctions Direct IO, telles que décrites dans - le standard Posix (Section 6) pour effectuer des fonctions - I/O de bas niveau par rapport aux fonctions - C-Language stream I/O (fopen, - fread,..). L'utilisation des fonctions - DIO devrait être considérée uniquement lorsqu'un contrôle direct - d'un périphérique est nécessaire. Dans tous les autres cas, - les fonctions standard de système - de fichiers sont plus adéquates. - - - - - &reference.dio.setup; - &reference.dio.constants; - &reference.dio.reference; - - - - - diff --git a/reference/dio/configure.xml b/reference/dio/configure.xml deleted file mode 100644 index 3499e56d69..0000000000 --- a/reference/dio/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;dio. - -
- - diff --git a/reference/dio/constants.xml b/reference/dio/constants.xml deleted file mode 100644 index 89b2fa2a85..0000000000 --- a/reference/dio/constants.xml +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - F_DUPFD - (int) - - - - - - - - F_GETFD - (int) - - - - - - - - F_GETFL - (int) - - - - - - - - F_GETLK - (int) - - - - - - - - F_GETOWN - (int) - - - - - - - - F_RDLCK - (int) - - - - - - - - F_SETFL - (int) - - - - - - - - F_SETLK - (int) - - - - - - - - F_SETLKW - (int) - - - - - - - - F_SETOWN - (int) - - - - - - - - F_UNLCK - (int) - - - - - - - - F_WRLCK - (int) - - - - - - - - O_APPEND - (int) - - - - - - - - O_ASYNC - (int) - - - - - - - - O_CREAT - (int) - - - - - - - - O_EXCL - (int) - - - - - - - - O_NDELAY - (int) - - - - - - - - O_NOCTTY - (int) - - - - - - - - O_NONBLOCK - (int) - - - - - - - - O_RDONLY - (int) - - - - - - - - O_RDWR - (int) - - - - - - - - O_SYNC - (int) - - - - - - - - O_TRUNC - (int) - - - - - - - - O_WRONLY - (int) - - - - - - - - S_IRGRP - (int) - - - - - - - - S_IROTH - (int) - - - - - - - - S_IRUSR - (int) - - - - - - - - S_IRWXG - (int) - - - - - - - - S_IRWXO - (int) - - - - - - - - S_IRWXU - (int) - - - - - - - - S_IWGRP - (int) - - - - - - - - S_IWOTH - (int) - - - - - - - - S_IWUSR - (int) - - - - - - - - S_IXGRP - (int) - - - - - - - - S_IXOTH - (int) - - - - - - - - S_IXUSR - (int) - - - - - - - - - diff --git a/reference/dio/functions/dio-close.xml b/reference/dio/functions/dio-close.xml deleted file mode 100644 index 2f5d0b91f3..0000000000 --- a/reference/dio/functions/dio-close.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - dio_close - Ferme l'accès au fichier - - - - &reftitle.description; - - voiddio_close - resourcefd - - - dio_close ferme l'accès au fichier - représenté par la ressource fd. - - - - - &reftitle.parameters; - - - - fd - - - La ressource de fichier retournée par dio_open. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Fermeture d'une ressource de fichier - - -]]> - - - - - - - &reftitle.seealso; - - - dio_open - - - - - - diff --git a/reference/dio/functions/dio-fcntl.xml b/reference/dio/functions/dio-fcntl.xml deleted file mode 100644 index 5c723c1e5a..0000000000 --- a/reference/dio/functions/dio-fcntl.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - - - dio_fcntl - Exécute une fonction fichier de langage C - - - - &reftitle.description; - - mixeddio_fcntl - resourcefd - intcmd - mixedargs - - - dio_fcntl exécute l'opération - cmd sur le fichier représenté par la - ressource fd. Certaines commandes demandent - des arguments supplémentaires qui sont fournis dans l'argument - args. - - - - - &reftitle.parameters; - - - - fd - - - La ressource de fichier retournée par dio_open. - - - - - cmd - - - Peut être une de ces opérations suivantes : - - - - F_SETLK : le verrou est posé ou levé. Si le - verrou appartient à un autre utilisateur, dio_fcntl - retourne -1. - - - - - F_SETLKW : identique à - F_SETLK, mais si le verrou appartient à quelqu'un - d'autre, dio_fcntl attend la levée du verrou. - - - - - F_GETLK : dio_fcntl retourne - un tableau associatif (comme décrit ci-dessous) si un autre utilisateur - empêche la pose d'un verrou. S'il n'y a aucun empêchement, - l'entrée "type" prendra la valeur F_UNLCK. - - - - - F_DUPFD : trouve les numéros de ressource de fichier - les plus petits, disponibles, inférieurs ou égaux à - args et les retourne. - - - - - F_SETFL : configure les descripteurs de fichier - à la valeur spécifiée par args, qui peut être - O_APPEND, O_NONBLOCK ou - O_ASYNC. Pour utiliser - O_ASYNC il sera nécessaire d'utiliser l'extension - PCNTL. - - - - - - - - args - - - args est un tableau associatif lorsque - cmd vaut F_SETLK - ou F_SETLKW, avec les entrées suivantes : - - - - start : offset de début de verrou - - - - - length : taille de la surface verrouillée. Zéro indique la fin - du fichier - - - - - whence : l_start est relatif à : peut être - SEEK_SET, SEEK_END et - SEEK_CUR - - - - - type : type de verrou. peut être - F_RDLCK (verrou en lecture), - F_WRLCK (verrou en écriture) ou - F_UNLCK (déverrouillage) - - - - - - - - - - - - &reftitle.returnvalues; - - Retourne le résultat d'un appel en C. - - - - - &reftitle.examples; - - - Positionnement et suppression d'un verrou - -F_WRLCK)) == -1) { - // le descripteur de fichier semble verrouillé - echo "Le verrou n'a pu être effacé. Il a été posé par quelqu'un d'autre."; -} else { - echo "Le verrou a été défini/verrouillé avec succès"; -} - -dio_close($fd); -?> -]]> - - - - - - - &reftitle.notes; - ¬e.no-windows; - - - - diff --git a/reference/dio/functions/dio-open.xml b/reference/dio/functions/dio-open.xml deleted file mode 100644 index d98a7957e9..0000000000 --- a/reference/dio/functions/dio-open.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - - dio_open - Ouvre un nouveau fichier avec les permissions spécifiées - - - - &reftitle.description; - - resourcedio_open - stringfilename - intflags - intmode0 - - - Ouvre un accès à un fichier et retourne une ressource de fichier. - - - - - &reftitle.parameters; - - - - filename - - - Le chemin vers le fichier à ouvrir. - - - - - flags - - - Le paramètre flags est une valeur - comprenant des drapeaux depuis la liste suivante. Cette valeur - doit inclure une constante parmi - O_RDONLY, O_WRONLY, - ou O_RDWR. À cette constante, il est possible - d'y ajouter n'importe quels drapeaux depuis cette liste. - - - - O_RDONLY : ouvre le fichier en lecture seule. - - - - - O_WRONLY : ouvre le fichier en écriture. - - - - - O_RDWR : ouvre le fichier en lecture et écriture. - - - - - O_CREAT : crée le fichier, s'il n'existe pas. - - - - - O_EXCL : si O_CREAT - et O_EXCL sont utilisés et que le fichier existe, - dio_open échouera. - - - - - O_TRUNC : si le fichier existe et qu'il est ouvert en écriture, - le fichier sera réduit à la taille nulle. - - - - - O_APPEND : les écritures se font à partir de la fin du fichier. - - - - - O_NONBLOCK : active le mode non-bloquant. - - - - - O_NOCTTY : évite que le système d'exploitation - n'assigne au fichier ouvert un processus contrôlant le terminal - lorsque ce fichier est un fichier TTY. - - - - - - - - mode - - - Si flags contient - O_CREAT, mode définira - les permissions du fichier (permissions de création). - mode est requis pour une opération - correcte lorsque O_CREAT est spécifié - dans le flags et est ignoré sinon. - - - Les permissions assignées au fichier créé seront affectées - par la configuration du processus umask. - - - - - - - - - &reftitle.returnvalues; - - Une ressource de fichier ou &false; en cas d'erreur. - - - - - &reftitle.examples; - - Ouverture d'un fichier - - -]]> - - - - - - &reftitle.seealso; - - - dio_close - - - - - - diff --git a/reference/dio/functions/dio-read.xml b/reference/dio/functions/dio-read.xml deleted file mode 100644 index 9fdeba27be..0000000000 --- a/reference/dio/functions/dio-read.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - dio_read - - Lit les octets dans un fichier - - - - - &reftitle.description; - - stringdio_read - resourcefd - intlen1024 - - - dio_read lit et retourne - len octets dans le fichier représenté par - la ressource fd. - - - - - &reftitle.parameters; - - - - fd - - - La ressource de fichier retournée par dio_open. - - - - - len - - - Le nombre d'octets à lire. Si le paramètre n'est pas spécifié, - dio_read lit un bloc de 1 ko. - - - - - - - - - &reftitle.returnvalues; - - Les octets lus de fd. - - - - - &reftitle.seealso; - - - dio_write - - - - - - diff --git a/reference/dio/functions/dio-seek.xml b/reference/dio/functions/dio-seek.xml deleted file mode 100644 index 6c725ed3eb..0000000000 --- a/reference/dio/functions/dio-seek.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - - dio_seek - Déplace le pointeur interne de fichier - - - - &reftitle.description; - - intdio_seek - resourcefd - intpos - intwhenceSEEK_SET - - - dio_seek sert à modifier la position du - pointeur de fichier dans le fichier. - - - - - &reftitle.parameters; - - - - fd - - - La ressource de fichier retournée par dio_open. - - - - - pos - - - La nouvelle position. - - - - - whence - - - Spécifie comment la position pos devrait être - interprétée : - - - - SEEK_SET (défaut) : spécifie que - pos est spécifié à partir du début du - fichier. - - - - - SEEK_CUR : spécifie que - pos est un nombre de caractères à partir de - la position courante dans le fichier. Ce nombre peut être positif ou - négatif. - - - - - SEEK_END : spécifie que - pos est un nombre de caractères à partir de - la fin du fichier. Une valeur négative spécifie une position à - l'intérieur de l'étendue courante du fichier ; une valeur positive - spécifie une position au-delà de la fin courante. Si l'on spécifie - une position après la fin et que l'on y écrit des données, cela - va agrandir le fichier avec des zéros jusqu'à cette position. - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - - Positionnement dans un fichier - - -]]> - - - - - - - diff --git a/reference/dio/functions/dio-stat.xml b/reference/dio/functions/dio-stat.xml deleted file mode 100644 index 53f9fded78..0000000000 --- a/reference/dio/functions/dio-stat.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - - dio_stat - - Lit des informations sur le fichier - - - - - &reftitle.description; - - arraydio_stat - resourcefd - - - dio_stat retourne les informations sur le - fichier. - - - - - &reftitle.parameters; - - - - fd - - - Le descripteur de fichier retourné par dio_open. - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif avec les clés suivantes : - - - - "device" : device - - - - - "inode" : inode - - - - - "mode" : mode - - - - - "nlink" : nombre de liens physiques - - - - - "uid" : user id - - - - - "gid" : group id - - - - - "device_type" : type de device (si inode device) - - - - - "size" : taille totale en octets - - - - - "blocksize" : taille du bloc - - - - - "blocks" : nombre de blocs alloués - - - - - "atime" : date du dernier accès - - - - - "mtime" : date de dernière modification - - - - - "ctime" : date de dernier changement - - - - En cas d'erreur, dio_stat retourne &null;. - - - - - diff --git a/reference/dio/functions/dio-tcsetattr.xml b/reference/dio/functions/dio-tcsetattr.xml deleted file mode 100644 index 6bca30ff51..0000000000 --- a/reference/dio/functions/dio-tcsetattr.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - - dio_tcsetattr - - Modifie les attributs du terminal et le taux de baud du port série - - - - - &reftitle.description; - - booldio_tcsetattr - resourcefd - arrayoptions - - - dio_tcsetattr modifie les attributs du terminal - et le taux de baud du port série de fd. - - - - - &reftitle.parameters; - - - - fd - - - Le descripteur de fichier retourné par dio_open. - - - - - options - - - Les options actuellement disponibles sont : - - - - 'baud' : taux de baud du port : peut être 38400,19200,9600,4800, - 2400,1800,1200,600,300,200,150,134,110,75 ou 50. Par défaut, c'est 9600. - - - - - 'bits' : bits de données : peut être 8,7,6 ou 5. Par défaut, c'est 8. - - - - - 'stop' : bits de stop : peut être 1 ou 2. Par défaut, c'est 1. - - - - - 'parity' : peut être 0, 1 ou 2. Par défaut, c'est 0. - - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Définition du débit des bauds sur un port série - - 9600, - 'bits' => 8, - 'stop' =>1, - 'parity' => 0 -)); - -while (true) { - $data = dio_read($fd, 256); - if ($data !== null && $data !== '') { - echo $data; - } -} - -?> -]]> - - - - - - &reftitle.notes; - ¬e.no-windows; - - - diff --git a/reference/dio/functions/dio-truncate.xml b/reference/dio/functions/dio-truncate.xml deleted file mode 100644 index 7125a93eb9..0000000000 --- a/reference/dio/functions/dio-truncate.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - dio_truncate - Tronque un fichier - - - - &reftitle.description; - - booldio_truncate - resourcefd - intoffset - - - dio_truncate tronque un fichier à au plus - offset octets, en taille. - - - Si auparavant le fichier était plus grand que cette taille, les données en - plus seront perdues. Si par contre le fichier était plus petit, il n'est - pas spécifié si le fichier est gardé intact ou agrandi. Dans le dernier - cas, la partie étendue devient des octets zéros. - - - - - &reftitle.parameters; - - - - fd - - - La ressource de fichier retournée par dio_open. - - - - - offset - - - La position en octets. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - ¬e.no-windows; - - - - diff --git a/reference/dio/functions/dio-write.xml b/reference/dio/functions/dio-write.xml deleted file mode 100644 index 0870c7a437..0000000000 --- a/reference/dio/functions/dio-write.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - dio_write - - Écrit des données dans le fichier avec la possibilité de tronquer sa - longueur - - - - - &reftitle.description; - - intdio_write - resourcefd - stringdata - intlen0 - - - dio_write écrit jusqu'à - len octets issus de la variable - data, dans le fichier représenté - par la ressource fd. - - - - - &reftitle.parameters; - - - - fd - - - Le descripteur de fichier retourné par dio_open. - - - - - data - - - Les données à écrire. - - - - - len - - - La longueur des données à écrire en octets. Si elle n'est pas spécifiée, la - fonction écrit toutes les données dans le fichier spécifié. - - - - - - - - - &reftitle.returnvalues; - - Retourne le nombre d'octets écrits dans fd. - - - - - &reftitle.seealso; - - - dio_read - - - - - - diff --git a/reference/dio/reference.xml b/reference/dio/reference.xml deleted file mode 100644 index fb963a9131..0000000000 --- a/reference/dio/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - &Functions; Direct IO - - &reference.dio.entities.functions; - - - - diff --git a/reference/dio/setup.xml b/reference/dio/setup.xml deleted file mode 100644 index 61dae2c6f4..0000000000 --- a/reference/dio/setup.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.dio.configure; - - - -
- &reftitle.resources; - - Un type de ressource est défini par cette extension : - un descripteur de fichier, retourné par la fonction - dio_open. - -
- - - - - - diff --git a/reference/ds/book.xml b/reference/ds/book.xml deleted file mode 100644 index 15ccc3d107..0000000000 --- a/reference/ds/book.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Structures de données - - - - &reftitle.intro; - - Structures de données efficaces pour PHP 7, fournies en alternative aux &array;. - - - Voir cet article de blog - pour des benchmarks, des discussions et des questions fréquemment posées. - - - - &reference.ds.setup; - &reference.ds.examples; - - &reference.ds.ds.collection; - &reference.ds.ds.hashable; - - &reference.ds.ds.sequence; - &reference.ds.ds.vector; - &reference.ds.ds.deque; - - &reference.ds.ds.map; - &reference.ds.ds.pair; - &reference.ds.ds.set; - &reference.ds.ds.stack; - &reference.ds.ds.queue; - &reference.ds.ds.priorityqueue; - - - - diff --git a/reference/ds/ds.collection.xml b/reference/ds/ds.collection.xml deleted file mode 100644 index 4afb5740cf..0000000000 --- a/reference/ds/ds.collection.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - L'interface Collection - Ds\Collection - - - - -
- &reftitle.intro; - - Ds\Collection est l'interface de base qui couvre les fonctionnalités - communes à toutes les structures de données de cette bibliothèque. Elle garantit que toutes les structures - sont traversables, dénombrables, et peuvent être converties en json en utilisant json_encode. - -
- - -
- &reftitle.interfacesynopsis; - - - - Ds\Collection - - - extends - Countable - - - IteratorAggregate - - - JsonSerializable - - - &Methods; - - - &InheritedMethods; - - - - - - - - - - - - - -
- -
- &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL ds 1.4.0 - - Collection implémente - IteratorAggregate à la place de simplement Traversable. (Cette modification a été apportée au polyfill dans la version 1.4.1.) - - - - - -
- - - - &reference.ds.ds.entities.collection; - - - - diff --git a/reference/ds/ds.deque.xml b/reference/ds/ds.deque.xml deleted file mode 100644 index 064c82b2da..0000000000 --- a/reference/ds/ds.deque.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - La classe Deque - Ds\Deque - - - - -
- &reftitle.intro; - - Un Deque (prononcé “deck”) est une séquence de valeurs - dans un tampon contigu qui grandit et rétrécit automatiquement. - Le nom est une abréviation courante de “double-ended queue” et est utilisé - en interne par Ds\Queue. - - - Deux pointeurs sont utilisés pour garder une trace d'une tête et d'une queue. Les pointeurs peuvent - “enrouler” la fin du tampon, ce qui évite de déplacer d'autres valeurs pour - faire de la place. Cela rend shift et unshift très rapides — - quelque chose qu'un Ds\Vector ne peut pas concurrencer. - - - Accéder à une valeur par index nécessite une traduction entre l'index et sa - position correspondante dans le tampon : ((head + position) % capacity). - -
- - -
- Forces - - - Support de la syntaxe de tableau (crochets). - Utilise moins de mémoire globale qu'un &array; pour le même nombre de valeurs. - Libère automatiquement la mémoire allouée lorsque sa taille devient suffisamment faible. - - get, - set, - push, - pop, - shift, et - unshift sont tous de complexité O(1). - - - -
- -
- Faiblesses - - - La capacité doit être une puissance de 2. - - insert et - remove sont de complexité O(n). - - - -
- -
- &reftitle.classsynopsis; - - - - Ds\Deque - - - - - Ds\Deque - - - - Ds\Sequence - - - ArrayAccess - - - - &Constants; - - const - int - Ds\Deque::MIN_CAPACITY - 8 - - - &Methods; - - - - - - -
- - -
- &reftitle.constants; - - - - Ds\Deque::MIN_CAPACITY - - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - La classe implémente maintenant ArrayAccess. - - - - - - -
- - - - &reference.ds.ds.entities.deque; - - - - diff --git a/reference/ds/ds.hashable.xml b/reference/ds/ds.hashable.xml deleted file mode 100644 index 3f5f83d043..0000000000 --- a/reference/ds/ds.hashable.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - L'interface Hashable - Ds\Hashable - - - - -
- &reftitle.intro; - - Hashable est une interface qui permet aux objets d'être utilisés comme clés. - C'est une alternative à spl_object_hash, - qui détermine le hachage d'un objet en fonction de son identifiant : - cela signifie que deux objets considérés comme égaux par une définition implicite - ne seraient pas traités comme égaux car ils ne sont pas la même instance. - - - hash est utilisée pour retourner une valeur scalaire à utiliser comme - valeur de hachage de l'objet, qui détermine où il va dans la table de hachage. - Bien que cette valeur n'ait pas à être unique, les objets qui sont égaux doivent - avoir la même valeur de hachage. - - - equals est utilisée pour déterminer si deux objets sont égaux. - Il est garanti que l'objet de comparaison sera une instance de la même classe - que le sujet. - - -
- - -
- &reftitle.interfacesynopsis; - - - - Ds\Hashable - - &Methods; - - - - -
- - - - &reference.ds.ds.entities.hashable; - - - - diff --git a/reference/ds/ds.map.xml b/reference/ds/ds.map.xml deleted file mode 100644 index d5d311d6cc..0000000000 --- a/reference/ds/ds.map.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - La classe Map - Ds\Map - - - - -
- &reftitle.intro; - - Une Map est une collection séquentielle de paires clé-valeur, presque identique à un - &array; utilisé dans un contexte similaire. Les clés peuvent être de n'importe quel type, mais doivent être uniques. - Les valeurs sont remplacées si elles sont ajoutées à la map en utilisant la même clé. - -
- - - -
- Force - - - Les clés et les valeurs peuvent être de n'importe quel type, y compris des objets. - Support de la syntaxe de tableau (crochets). - L'ordre d'insertion est préservé. - La performance et l'efficacité mémoire sont très similaires à un &array;. - Libère automatiquement la mémoire allouée lorsque sa taille devient suffisamment faible. - - -
- -
- Faiblesses - - - Ne peut pas être converti en un tableau lorsque des objets sont utilisés comme clés. - - -
- - -
- &reftitle.classsynopsis; - - - - Ds\Map - - - - - Ds\Map - - - - Ds\Collection - - - ArrayAccess - - - - &Constants; - - const - int - Ds\Map::MIN_CAPACITY - 8 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - Ds\Map::MIN_CAPACITY - - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - La classe implémente maintenant ArrayAccess. - - - - PECL ds 1.2.0 - - Ds\Map::MIN_CAPACITY est passé de 16 à 8. - - - - - - -
- - - - &reference.ds.ds.entities.map; - - - - diff --git a/reference/ds/ds.pair.xml b/reference/ds/ds.pair.xml deleted file mode 100644 index c5b62ffb3f..0000000000 --- a/reference/ds/ds.pair.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - La classe Pair - Ds\Pair - - - - -
- &reftitle.intro; - - Une paire est utilisée par Ds\Map pour associer des clés à des valeurs. - -
- - -
- &reftitle.classsynopsis; - - - - Ds\Pair - - - - - Ds\Pair - - - - JsonSerializable - - - - - &Methods; - - - - - - - - - -
- - - - &reference.ds.ds.entities.pair; - - - - diff --git a/reference/ds/ds.priorityqueue.xml b/reference/ds/ds.priorityqueue.xml deleted file mode 100644 index 6076b1122d..0000000000 --- a/reference/ds/ds.priorityqueue.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - La classe PriorityQueue - Ds\PriorityQueue - - - - -
- &reftitle.intro; - - Une PriorityQueue est très similaire à une Queue. Les valeurs sont poussées dans la file - avec une priorité attribuée, et la valeur avec la priorité la plus élevée sera - toujours en tête de la file. - - - Implémentée en utilisant un tas maximum. - - - - "Premier entré, premier sorti" est préservé pour les valeurs ayant la même priorité. - - - - - Itérer sur une PriorityQueue est destructif, équivalent à des opérations de dépilement successives jusqu'à ce que la file soit vide. - - -
- - -
- &reftitle.classsynopsis; - - - - Ds\PriorityQueue - - - - - Ds\PriorityQueue - - - - Ds\Collection - - - - &Constants; - - const - int - Ds\PriorityQueue::MIN_CAPACITY - 8 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - Ds\PriorityQueue::MIN_CAPACITY - - - - - - -
- - - - - - &reference.ds.ds.entities.priorityqueue; - - - - diff --git a/reference/ds/ds.queue.xml b/reference/ds/ds.queue.xml deleted file mode 100644 index 40344154af..0000000000 --- a/reference/ds/ds.queue.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - La classe Queue - Ds\Queue - - - - -
- &reftitle.intro; - - Une Queue est une collection "premier entré, premier sorti" ou "FIFO" qui - ne permet l'accès qu'à la valeur en tête de la file et itère dans cet ordre, - de manière destructive. - -
- - -
- &reftitle.classsynopsis; - - - - Ds\Queue - - - - - Ds\Queue - - - - Ds\Collection - - - ArrayAccess - - - - &Constants; - - const - int - Ds\Queue::MIN_CAPACITY - 8 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - Ds\Queue::MIN_CAPACITY - - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - Cette classe implémente maintenant ArrayAccess. - - - - - - -
- - - - &reference.ds.ds.entities.queue; - - - - diff --git a/reference/ds/ds.sequence.xml b/reference/ds/ds.sequence.xml deleted file mode 100644 index 3028e39094..0000000000 --- a/reference/ds/ds.sequence.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - L'interface Sequence - Ds\Sequence - - - - -
- &reftitle.intro; - - Une Sequence décrit le comportement des valeurs disposées dans une seule dimension linéaire. - Certains langages se réfèrent à cela comme une "Liste". C'est similaire à un tableau qui utilise - des clés entières incrémentales, à l'exception de quelques caractéristiques : - - Les valeurs seront toujours indexées comme [0, 1, 2, …, size - 1]. - Seules les valeurs par index dans la plage [0, size - 1] sont autorisées. - - - - Cas d'utilisation : - - Partout où l'on utiliserait un tableau en tant que liste (sans se soucier des clés). - Une alternative plus efficace à - SplDoublyLinkedList et - SplFixedArray. - - - -
- - -
- &reftitle.interfacesynopsis; - - - - Ds\Sequence - - - extends - Ds\Collection - - - ArrayAccess - - - &Methods; - - - &InheritedMethods; - - - - - - - - - - - - - - - - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - Cette interface étend maintenant ArrayAccess. - - - - - - -
- - - - &reference.ds.ds.entities.sequence; - - - - diff --git a/reference/ds/ds.set.xml b/reference/ds/ds.set.xml deleted file mode 100644 index 85508c9e0a..0000000000 --- a/reference/ds/ds.set.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - La classe Set - Ds\Set - - - - -
- &reftitle.intro; - - Un Set est une séquence de valeurs uniques. Cette implémentation utilise la même table de hachage que - Ds\Map, où les valeurs sont utilisées comme clés et la valeur - mappée est ignorée. - -
- - - -
- Force - - - Les valeurs peuvent être de n'importe quel type, y compris des objets. - Support de la syntaxe de tableau (crochets). - L'ordre d'insertion est préservé. - Libère automatiquement la mémoire allouée lorsque sa taille devient suffisamment faible. - - add, - remove et - contains sont tous de complexité O(1). - - - -
- -
- Faiblesses - - - Ne supporte pas: - push, - pop, - insert, - shift, ou - unshift. - - - get est de complexité O(n) s'il y a des valeurs supprimées - dans le tampon avant l'index accédé, O(1) sinon. - - - -
- -
- &reftitle.classsynopsis; - - - - Ds\Set - - - - - Ds\Set - - - - Ds\Collection - - - ArrayAccess - - - - &Constants; - - const - int - Ds\Set::MIN_CAPACITY - 8 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - Ds\Set::MIN_CAPACITY - - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - Cette classe implémente maintenant ArrayAccess. - - - - PECL ds 1.2.7 - - Ajout de la méthode Ds\Set::map. - - - - PECL ds 1.2.0 - - Ds\Set::MIN_CAPACITY est passé de 16 à 8. - - - - - - -
- - - - &reference.ds.ds.entities.set; - - - - diff --git a/reference/ds/ds.stack.xml b/reference/ds/ds.stack.xml deleted file mode 100644 index a1f0cbf156..0000000000 --- a/reference/ds/ds.stack.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - La classe Stack - Ds\Stack - - - - -
- &reftitle.intro; - - Une Stack est une collection "dernier entré, premier sorti" ou "LIFO" qui - ne permet l'accès qu'à la valeur en haut de la structure et itère dans cet - ordre, de manière destructive. - - - Utilise un Ds\Vector en interne. - -
- - -
- &reftitle.classsynopsis; - - - - Ds\Stack - - - - - Ds\Stack - - - - Ds\Collection - - - ArrayAccess - - - - - &Methods; - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - Cette classe implémente maintenant ArrayAccess. - - - - - - -
- - - - &reference.ds.ds.entities.stack; - - - - diff --git a/reference/ds/ds.vector.xml b/reference/ds/ds.vector.xml deleted file mode 100644 index f4cef355ba..0000000000 --- a/reference/ds/ds.vector.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - La classe Vector - Ds\Vector - - - - -
- &reftitle.intro; - - Un Vector est une séquence de valeurs dans un tampon contigu qui grandit et - rétrécit automatiquement. C'est la structure séquentielle la plus efficace - car l'index d'une valeur est une correspondance directe avec son index dans - le tampon, et le facteur de croissance n'est pas lié à un multiple ou un - exposant spécifique. - -
- - - -
- Forces - - - Support de la syntaxe de tableau (crochets). - Utilise moins de mémoire globale qu'un &array; pour le même nombre de valeurs. - Libère automatiquement la mémoire allouée lorsque sa taille devient suffisamment faible. - La capacité n'a pas à être une puissance de 2. - - get, - set, - push, - pop sont tous de complexité O(1). - - - -
- -
- Faiblesses - - - - shift, - unshift, - insert et - remove sont tous de complexité O(n). - - - -
- -
- &reftitle.classsynopsis; - - - - - Ds\Vector - - - - - - Ds\Vector - Ds\Sequence - ArrayAccess - - - - &Constants; - - const - int - Ds\Vector::MIN_CAPACITY - 8 - - - &Methods; - - - - - - -
- - -
- &reftitle.constants; - - - - Ds\Vector::MIN_CAPACITY - - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - Cette classe implémente maintenant ArrayAccess. - - - - PECL ds 1.2.0 - - Ds\Vector::MIN_CAPACITY est passé de 10 à 8. - - - - - - -
- - - - &reference.ds.ds.entities.vector; - - - - diff --git a/reference/ds/ds/collection/clear.xml b/reference/ds/ds/collection/clear.xml deleted file mode 100644 index 58bdc9f1b2..0000000000 --- a/reference/ds/ds/collection/clear.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - Ds\Collection::clear - Supprime toutes les valeurs - - - - &reftitle.description; - - public voidDs\Collection::clear - - - - Supprime toutes les valeurs de la collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple avec <function>Ds\Collection::clear</function> - -clear(); -print_r($collection); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Vector Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/collection/copy.xml b/reference/ds/ds/collection/copy.xml deleted file mode 100644 index 8ed5330ac9..0000000000 --- a/reference/ds/ds/collection/copy.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - Ds\Collection::copy - Retourne une copie superficielle de la collection - - - - &reftitle.description; - - public Ds\CollectionDs\Collection::copy - - - - Retourne une copie superficielle de la collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une copie superficielle de la collection. - - - - - &reftitle.examples; - - <function>Ds\Collection::copy</function> exemple - -copy(); - -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Vector Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/collection/isempty.xml b/reference/ds/ds/collection/isempty.xml deleted file mode 100644 index b9d6dd895d..0000000000 --- a/reference/ds/ds/collection/isempty.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - Ds\Collection::isEmpty - Indique si la collection est vide - - - - &reftitle.description; - - public boolDs\Collection::isEmpty - - - - Indique si la collection est vide. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si la collection est vide, &false; dans le cas contraire. - - - - - &reftitle.examples; - - <function>Ds\Collection::isEmpty</function> exemple - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/collection/toarray.xml b/reference/ds/ds/collection/toarray.xml deleted file mode 100644 index d52139c32d..0000000000 --- a/reference/ds/ds/collection/toarray.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - Ds\Collection::toArray - - Convertit la collection en un &array; - - - - - &reftitle.description; - - public arrayDs\Collection::toArray - - - - Convertit la collection en un &array;. - - - - Le casting vers un &array; n'est pas encore supporté. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; contenant toutes les valeurs dans le même ordre que la collection. - - - - - &reftitle.examples; - - <function>Ds\Collection::toArray</function> exemple - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/allocate.xml b/reference/ds/ds/deque/allocate.xml deleted file mode 100644 index 4504a13fda..0000000000 --- a/reference/ds/ds/deque/allocate.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Deque::allocate - Alloue suffisamment de mémoire pour une capacité requise - - - - &reftitle.description; - - public voidDs\Deque::allocate - intcapacity - - - Assure qu'assez de mémoire est allouée pour une capacité requise. - Cela élimine le besoin de réallouer le tampon interne à mesure que les valeurs sont ajoutées. - - - - - &reftitle.parameters; - - - capacity - - - Le nombre de valeurs pour lesquelles la capacité doit être allouée. - - - - La capacité restera la même si cette valeur est inférieure ou égale à la - capacité actuelle. - - - - - La capacité sera toujours arrondie à la puissance de 2 la plus proche. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::allocate</function> - -capacity()); - -$deque->allocate(100); -var_dump($deque->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/apply.xml b/reference/ds/ds/deque/apply.xml deleted file mode 100644 index c3c3299dd6..0000000000 --- a/reference/ds/ds/deque/apply.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Ds\Deque::apply - Met à jour toutes les valeurs en appliquant une fonction de rappel à chaque valeur - - - - &reftitle.description; - - public voidDs\Deque::apply - callablecallback - - - Met à jour toutes les valeurs en appliquant un callback - à chaque valeur dans la deque. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - Un callable à appliquer à chaque valeur dans la deque. - - - - La fonction de rappel devrait accepter une valeur et retourner ce que la valeur devrait être remplacée par. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::apply</function> - -apply(function($value) { return $value * 2; }); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/capacity.xml b/reference/ds/ds/deque/capacity.xml deleted file mode 100644 index e002d29a24..0000000000 --- a/reference/ds/ds/deque/capacity.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Deque::capacity - Renvoie la capacité actuelle - - - - &reftitle.description; - - public intDs\Deque::capacity - - - - Renvoie la capacité actuelle. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacité actuelle. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::capacity</function> - -capacity()); - -$deque->push(...range(1, 50)); -var_dump($deque->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/clear.xml b/reference/ds/ds/deque/clear.xml deleted file mode 100644 index 7236826a35..0000000000 --- a/reference/ds/ds/deque/clear.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Deque::clear - Supprime toutes les valeurs du deque - - - - &reftitle.description; - - public voidDs\Deque::clear - - - - Supprime toutes les valeurs du deque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::clear</function> - -clear(); -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Deque Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/construct.xml b/reference/ds/ds/deque/construct.xml deleted file mode 100644 index 87a349205d..0000000000 --- a/reference/ds/ds/deque/construct.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Deque::__construct - Crée une nouvelle instance - - - - &reftitle.description; - - public Ds\Deque::__construct - mixedvalues - - - Crée une nouvelle instance, en utilisant soit un objet traversable, - soit un &array; pour les values initiales. - - - - - &reftitle.parameters; - - - values - - - Un objet traversable ou un &array; à utiliser pour les valeurs initiales. - - - - - - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::__construct</function> - - -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/contains.xml b/reference/ds/ds/deque/contains.xml deleted file mode 100644 index f364d613bd..0000000000 --- a/reference/ds/ds/deque/contains.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Deque::contains - Détermine si le deque contient des valeurs données - - - - &reftitle.description; - - public boolDs\Deque::contains - mixedvalues - - - Détermine si le deque contient toutes les valeurs. - - - - - &reftitle.parameters; - - - values - - - Les valeurs à vérifier. - - - - - - - - &reftitle.returnvalues; - - &false; si l'une des values fournies n'est pas dans le deque, - &true; sinon. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::contains</function> - -contains('a')); // true -var_dump($deque->contains('a', 'b')); // true -var_dump($deque->contains('c', 'd')); // false - -var_dump($deque->contains(...['c', 'b', 'a'])); // true - -// Toujours strict -var_dump($deque->contains(1)); // true -var_dump($deque->contains('1')); // false - -var_dump($deque->contains(...[])); // true -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/copy.xml b/reference/ds/ds/deque/copy.xml deleted file mode 100644 index 0a7787daa7..0000000000 --- a/reference/ds/ds/deque/copy.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Ds\Deque::copy - Renvoie une copie superficielle de la deque - - - - &reftitle.description; - - public Ds\DequeDs\Deque::copy - - - - Renvoie une copie superficielle de la deque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une copie superficielle de la deque. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::copy</function> - -copy(); - -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Deque Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/count.xml b/reference/ds/ds/deque/count.xml deleted file mode 100644 index 31ba928591..0000000000 --- a/reference/ds/ds/deque/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Deque::count - Renvoie le nombre de valeurs dans la collection - - - - &reftitle.description; - - Voir Countable::count - - - - - - diff --git a/reference/ds/ds/deque/filter.xml b/reference/ds/ds/deque/filter.xml deleted file mode 100644 index 71cbaaf4eb..0000000000 --- a/reference/ds/ds/deque/filter.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - Ds\Deque::filter - - Créer un nouveau deque en utilisant un callable pour - déterminer quelles valeurs inclure - - - - - &reftitle.description; - - public Ds\DequeDs\Deque::filter - callablecallback - - - Crée un nouveau deque en utilisant un callable pour - déterminer quelles valeurs inclure. - - - - - &reftitle.parameters; - - - - callback - - - - - bool - callback - mixedvalue - - - - Un callable optionnel qui retourne &true; si la valeur doit être incluse, &false; sinon. - - - Si aucune fonction de rappel n'est fournie, seules les valeurs qui sont &true; - (voir conversion en booléen) - seront incluses. - - - - - - - - - &reftitle.returnvalues; - - Un nouveau deque contenant toutes les valeurs pour lesquelles - soit le callback a retourné &true;, soit toutes les valeurs qui - se convertissent en &true; si un callback n'a pas été fourni. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::filter</function> avec une fonction de rappel - -filter(function($value) { - return $value % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) -} -]]> - - - - Exemple de <function>Ds\Deque::filter</function> sans une fonction de rappel - -filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/find.xml b/reference/ds/ds/deque/find.xml deleted file mode 100644 index 879394aa2b..0000000000 --- a/reference/ds/ds/deque/find.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Deque::find - - Essaye de trouver l'index d'une valeur - - - - - &reftitle.description; - - public mixedDs\Deque::find - mixedvalue - - - Renvoie l'index de la value, ou &false; si non trouvée. - - - - - - &reftitle.parameters; - - - value - - - La valeur à trouver. - - - - - - - - &reftitle.returnvalues; - - L'index de la valeur, ou &false; si non trouvée. - - - - Les valeurs seront comparées par valeur et par type. - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::find</function> - -find("a")); // 0 -var_dump($deque->find("b")); // false -var_dump($deque->find("1")); // false -var_dump($deque->find(1)); // 1 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/first.xml b/reference/ds/ds/deque/first.xml deleted file mode 100644 index c0265ef7cd..0000000000 --- a/reference/ds/ds/deque/first.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Deque::first - Renvoie la première valeur de la deque - - - - &reftitle.description; - - public mixedDs\Deque::first - - - - Renvoie la première valeur de la deque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la première valeur de la deque. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::first</function> - -first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/get.xml b/reference/ds/ds/deque/get.xml deleted file mode 100644 index 918d09c61e..0000000000 --- a/reference/ds/ds/deque/get.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Ds\Deque::get - Renvoie la valeur à un index donné - - - - &reftitle.description; - - public mixedDs\Deque::get - intindex - - - Renvoie la valeur à un index donné. - - - - - - &reftitle.parameters; - - - index - - - L'index à accéder, en commençant à 0. - - - - - - - - &reftitle.returnvalues; - - La valeur à l'index demandé. - - - - - &reftitle.errors; - - OutOfRangeException si l'index n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::get</function> - -get(0)); -var_dump($deque->get(1)); -var_dump($deque->get(2)); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Deque::get</function> en utilisant la syntaxe de tableau - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/insert.xml b/reference/ds/ds/deque/insert.xml deleted file mode 100644 index 2721b07932..0000000000 --- a/reference/ds/ds/deque/insert.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Ds\Deque::insert - Insère des valeurs à un index donné - - - - &reftitle.description; - - public voidDs\Deque::insert - intindex - mixedvalues - - - Insère des valeurs dans le deque à un index donné. - - - - - - &reftitle.parameters; - - - index - - - Insère à l'index donné. 0 <= index <= count - - - - Il est possible d'insérer à l'index égal au nombre de valeurs. - - - - - - values - - - La ou les valeurs à insérer. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException si l'index n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::insert</function> - -insert(0, "e"); // [e] -$deque->insert(1, "f"); // [e, f] -$deque->insert(2, "g"); // [e, f, g] -$deque->insert(0, "a", "b"); // [a, b, e, f, g] -$deque->insert(2, ...["c", "d"]); // [a, b, c, d, e, f, g] - -var_dump($deque); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - [1]=> - string(1) "b" - [2]=> - string(1) "c" - [3]=> - string(1) "d" - [4]=> - string(1) "e" - [5]=> - string(1) "f" - [6]=> - string(1) "g" -} -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/isempty.xml b/reference/ds/ds/deque/isempty.xml deleted file mode 100644 index 35c4aab7c0..0000000000 --- a/reference/ds/ds/deque/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Deque::isEmpty - Renvoie si la deque est vide - - - - &reftitle.description; - - public boolDs\Deque::isEmpty - - - - Renvoie si la deque est vide. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si la deque est vide, &false; sinon. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::isEmpty</function> - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/join.xml b/reference/ds/ds/deque/join.xml deleted file mode 100644 index bb7a848d61..0000000000 --- a/reference/ds/ds/deque/join.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Deque::join - Rassemble toutes les valeurs en une chaîne - - - - &reftitle.description; - - public stringDs\Deque::join - stringglue - - - Rassemble toutes les valeurs en une chaîne en utilisant un séparateur optionnel entre chaque valeur. - - - - - &reftitle.parameters; - - - glue - - - Une chaîne optionnelle pour séparer chaque valeur. - - - - - - - - &reftitle.returnvalues; - - Toutes les valeurs du deque rassemblées en une chaîne. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::join</function> utilisant une chaîne séparatrice - -join("|")); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Deque::join</function> sans chaîne séparatrice - -join()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/jsonserialize.xml b/reference/ds/ds/deque/jsonserialize.xml deleted file mode 100644 index 3a3dac6ea4..0000000000 --- a/reference/ds/ds/deque/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Deque::jsonSerialize - Renvoie une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - Voir JsonSerializable::jsonSerialize - - - - Il ne devrait jamais être nécessaire d'appeler cette méthode directement. - - - - - - - diff --git a/reference/ds/ds/deque/last.xml b/reference/ds/ds/deque/last.xml deleted file mode 100644 index ab3a978f85..0000000000 --- a/reference/ds/ds/deque/last.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Deque::last - Renvoie la dernière valeur - - - - &reftitle.description; - - public mixedDs\Deque::last - - - - Renvoie la dernière valeur du deque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La dernière valeur du deque. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::last</function> - -last()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/map.xml b/reference/ds/ds/deque/map.xml deleted file mode 100644 index 85c236e67b..0000000000 --- a/reference/ds/ds/deque/map.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Ds\Deque::map - Renvoie le résultat de l'application d'une fonction de rappel à chaque valeur - - - - &reftitle.description; - - public Ds\DequeDs\Deque::map - callablecallback - - - Renvoie le résultat de l'application de callback à - chaque valeur de la deque. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - Un callable à appliquer à chaque valeur de la deque. - - - - La fonction de rappel doit prendre un argument et retourner la nouvelle valeur. - - - - - - - - - &reftitle.returnvalues; - - Le résultat de l'application de callback à chaque valeur - de la deque. - - - - Les valeurs de l'instance actuelle ne seront pas affectées. - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::map</function> - -map(function($value) { return $value * 2; })); -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -Ds\Deque Object -( - [0] => 1 - [1] => 2 - [2] => 3 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/merge.xml b/reference/ds/ds/deque/merge.xml deleted file mode 100644 index d944230132..0000000000 --- a/reference/ds/ds/deque/merge.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Ds\Deque::merge - Renvoie le résultat de l'ajout de toutes les valeurs données au deque - - - - &reftitle.description; - - public Ds\DequeDs\Deque::merge - mixedvalues - - - Renvoie le résultat de l'ajout de toutes les valeurs données au deque. - - - - - - &reftitle.parameters; - - - values - - - Un objet traversable ou un &array;. - - - - - - - - &reftitle.returnvalues; - - Le résultat de l'ajout de toutes les valeurs données au deque, - effectivement le même que d'ajouter les valeurs à une copie, puis de renvoyer cette copie. - - - - L'instance actuelle ne sera pas affectée. - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::merge</function> - -merge([4, 5, 6])); -var_dump($deque); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) - [5]=> - int(6) -} -object(Ds\Deque)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/pop.xml b/reference/ds/ds/deque/pop.xml deleted file mode 100644 index 3350f66d60..0000000000 --- a/reference/ds/ds/deque/pop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Deque::pop - Enlève et renvoie la dernière valeur - - - - &reftitle.description; - - public mixedDs\Deque::pop - - - - Enlève et renvoie la dernière valeur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La dernière valeur enlevée. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::pop</function> - -pop()); -var_dump($deque->pop()); -var_dump($deque->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/push.xml b/reference/ds/ds/deque/push.xml deleted file mode 100644 index 52f500c43a..0000000000 --- a/reference/ds/ds/deque/push.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Deque::push - Ajoute des valeurs à la fin du deque - - - - &reftitle.description; - - public voidDs\Deque::push - mixedvalues - - - Ajoute les valeurs à la fin du deque. - - - - - - &reftitle.parameters; - - - values - - - Les valeurs à ajouter. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::push</function> - -push("a"); -$deque->push("b"); -$deque->push("c", "d"); -$deque->push(...["e", "f"]); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/reduce.xml b/reference/ds/ds/deque/reduce.xml deleted file mode 100644 index 61f5a3ddf3..0000000000 --- a/reference/ds/ds/deque/reduce.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - Ds\Deque::reduce - Réduit le deque à une seule valeur en utilisant une fonction de rappel - - - - &reftitle.description; - - public mixedDs\Deque::reduce - callablecallback - mixedinitial - - - Réduit le deque à une seule valeur en utilisant une fonction de rappel. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedvalue - - - - carry - - - La valeur de retour du rappel précédent, ou initial si - c'est la première itération. - - - - - value - - - La valeur de l'itération actuelle. - - - - - - - - - initial - - - La valeur initiale de la valeur de retour. Peut être &null;. - - - - - - - - &reftitle.returnvalues; - - La valeur de retour du rappel final. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::reduce</function> avec une valeur initiale - -reduce($callback, 5)); - -// Itérations : -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Deque::reduce</function> sans valeur initiale - -reduce(function($carry, $value) { - return $carry + $value + 5; -})); - -// Itérations : -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/remove.xml b/reference/ds/ds/deque/remove.xml deleted file mode 100644 index 680836acf9..0000000000 --- a/reference/ds/ds/deque/remove.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Ds\Deque::remove - Enlève et renvoie une valeur par index - - - - &reftitle.description; - - public mixedDs\Deque::remove - intindex - - - Enlève et renvoie une valeur par index. - - - - - - &reftitle.parameters; - - - index - - - L'index de la valeur à enlever. - - - - - - - - &reftitle.returnvalues; - - La valeur qui a été enlevée. - - - - - &reftitle.errors; - - OutOfRangeException si l'index n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::remove</function> - -remove(1)); -var_dump($deque->remove(0)); -var_dump($deque->remove(0)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/reverse.xml b/reference/ds/ds/deque/reverse.xml deleted file mode 100644 index e8da99c1d9..0000000000 --- a/reference/ds/ds/deque/reverse.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Deque::reverse - - Renverse le deque en place - - - - - &reftitle.description; - - public voidDs\Deque::reverse - - - - Renverse le deque en place. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::reverse</function> - -reverse(); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/reversed.xml b/reference/ds/ds/deque/reversed.xml deleted file mode 100644 index 2e938350ed..0000000000 --- a/reference/ds/ds/deque/reversed.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Deque::reversed - Renvoie une copie renversée - - - - &reftitle.description; - - public Ds\DequeDs\Deque::reversed - - - - Renvoie une copie renversée du deque. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une copie renversée du deque. - - - - L'instance actuelle n'est pas affectée. - - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::reversed</function> - -reversed()); -print_r($deque); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -Ds\Deque Object -( - [0] => a - [1] => b - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/rotate.xml b/reference/ds/ds/deque/rotate.xml deleted file mode 100644 index 6180faa52c..0000000000 --- a/reference/ds/ds/deque/rotate.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Deque::rotate - Tourne le deque d'un certain nombre de rotations - - - - &reftitle.description; - - public voidDs\Deque::rotate - introtations - - - Tourne le deque d'un certain nombre de rotations, ce qui équivaut à appeler successivement - $deque->push($deque->shift()) si le nombre de rotations est positif, ou - $deque->unshift($deque->pop()) si négatif. - - - - - - &reftitle.parameters; - - - rotations - - - Le nombre de fois que le deque doit être tourné. - - - - - - - - &reftitle.returnvalues; - - &return.void;. Le deque de l'instance actuelle sera tourné. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::rotate</function> - -rotate(1); // "a" est décalé, puis poussé. -print_r($deque); - -$deque->rotate(2); // "b" et "c" sont tous deux décalés, puis poussés. -print_r($deque); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => d - [3] => a -) -Ds\Deque Object -( - [0] => d - [1] => a - [2] => b - [3] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/set.xml b/reference/ds/ds/deque/set.xml deleted file mode 100644 index f3dd912af5..0000000000 --- a/reference/ds/ds/deque/set.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - Ds\Deque::set - Met à jour une valeur à un index donné - - - - &reftitle.description; - - public voidDs\Deque::set - intindex - mixedvalue - - - Met à jour une valeur à un index donné. - - - - - - &reftitle.parameters; - - - index - - - L'index de la valeur à mettre à jour. - - - - - value - - - La nouvelle valeur. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException si l'index n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::set</function> - -set(1, "_"); -print_r($deque); -?> -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - Exemple de <function>Ds\Deque::set</function> utilisant la syntaxe de tableau - - -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/shift.xml b/reference/ds/ds/deque/shift.xml deleted file mode 100644 index 2b7b3e151d..0000000000 --- a/reference/ds/ds/deque/shift.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Deque::shift - Enlève et renvoie la première valeur - - - - &reftitle.description; - - public mixedDs\Deque::shift - - - - Enlève et renvoie la première valeur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La première valeur, qui a été enlevée. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::shift</function> - -shift()); -var_dump($deque->shift()); -var_dump($deque->shift()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/slice.xml b/reference/ds/ds/deque/slice.xml deleted file mode 100644 index d5b128a601..0000000000 --- a/reference/ds/ds/deque/slice.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - Ds\Deque::slice - - Renvoie un sous-deque d'une plage donnée - - - - - &reftitle.description; - - public Ds\DequeDs\Deque::slice - intindex - intlength - - - Crée un sous-deque d'une plage donnée. - - - - - - &reftitle.parameters; - - - index - - - L'index auquel commence le sous-deque. - - - Si positif, le sous-deque commencera à cet index dans le deque. - Si négatif, le sous-deque commencera à cette distance de la fin. - - - - - length - - - Si une longueur est donnée et est positive, le sous-deque résultant - aura jusqu'à autant de valeurs. - - Si la longueur entraîne un dépassement, seules - les valeurs jusqu'à la fin du deque seront incluses. - - Si une longueur est donnée et est négative, le sous-deque - s'arrêtera à autant de valeurs de la fin. - - Si une longueur n'est pas fournie, le sous-deque - contiendra toutes les valeurs entre l'index et la - fin du deque. - - - - - - - - &reftitle.returnvalues; - - Un sous-deque de la plage donnée. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::slice</function> - -slice(2)); - -// Découpe à partir de 1, pour une longueur de 3 -print_r($deque->slice(1, 3)); - -// Découpe à partir de 1 en avant -print_r($deque->slice(1)); - -// Découpe à partir de 2 en arrière -print_r($deque->slice(-2)); - -// Découpe de 1 à 1 de la fin -print_r($deque->slice(1, -1)); -?> -]]> - - &example.outputs.similar; - - c - [1] => d - [2] => e -) -Ds\Deque Object -( - [0] => b - [1] => c - [2] => d -) -Ds\Deque Object -( - [0] => b - [1] => c - [2] => d - [3] => e -) -Ds\Deque Object -( - [0] => d - [1] => e -) -Ds\Deque Object -( - [0] => b - [1] => c - [2] => d -) - -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/sort.xml b/reference/ds/ds/deque/sort.xml deleted file mode 100644 index 2e8d921c54..0000000000 --- a/reference/ds/ds/deque/sort.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Ds\Deque::sort - - Trie le deque en place - - - - - &reftitle.description; - - public voidDs\Deque::sort - callablecomparator - - - Trie le deque en place, en utilisant une fonction comparator optionnelle. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::sort</function> - -sort(); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Exemple de <function>Ds\Deque::sort</function> utilisant un comparateur - -sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/deque/sorted.xml b/reference/ds/ds/deque/sorted.xml deleted file mode 100644 index 6b8450824a..0000000000 --- a/reference/ds/ds/deque/sorted.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Ds\Deque::sorted - Renvoie une copie triée - - - - &reftitle.description; - - public Ds\DequeDs\Deque::sorted - callablecomparator - - - Renvoie une copie triée du deque, en utilisant une fonction comparator optionnelle. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Renvoie une copie triée du deque. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::sorted</function> - -sorted()); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Exemple de <function>Ds\Deque::sorted</function> utilisant un comparateur - -sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/deque/sum.xml b/reference/ds/ds/deque/sum.xml deleted file mode 100644 index 1270d5c02a..0000000000 --- a/reference/ds/ds/deque/sum.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Deque::sum - Renvoie la somme de toutes les valeurs du deque - - - - &reftitle.description; - - public intfloatDs\Deque::sum - - - - Renvoie la somme de toutes les valeurs du deque. - - - - Les tableaux et les objets sont considérés comme égaux à zéro lors du calcul de la somme. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La somme de toutes les valeurs du deque en tant que float ou int - en fonction des valeurs du deque. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::sum</function> avec un entier - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Deque::sum</function> avec un nombre à virgule flottante - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/toarray.xml b/reference/ds/ds/deque/toarray.xml deleted file mode 100644 index c9ce020145..0000000000 --- a/reference/ds/ds/deque/toarray.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Deque::toArray - - Convertit le deque en un &array; - - - - - &reftitle.description; - - public arrayDs\Deque::toArray - - - - Convertit le deque en un &array;. - - - - La conversion en un &array; n'est pas encore supportée. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; contenant toutes les valeurs dans le même ordre que le deque. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::toArray</function> - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/unshift.xml b/reference/ds/ds/deque/unshift.xml deleted file mode 100644 index 869d8ae67c..0000000000 --- a/reference/ds/ds/deque/unshift.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Deque::unshift - Ajoute des valeurs au début du deque - - - - &reftitle.description; - - public voidDs\Deque::unshift - mixedvalues - - - Ajoute les valeurs au début du deque, déplaçant toutes les valeurs actuelles - vers l'avant pour faire de la place pour les nouvelles valeurs. - - - - - - &reftitle.parameters; - - - values - - - Les valeurs à ajouter au début du deque. - - - Les valeurs seront ajoutées dans le même ordre qu'elles sont - passées. - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Deque::unshift</function> - -unshift("a"); -$deque->unshift("b", "c"); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => a - [3] => 1 - [4] => 2 - [5] => 3 -) -]]> - - - - - - - diff --git a/reference/ds/ds/hashable/equals.xml b/reference/ds/ds/hashable/equals.xml deleted file mode 100644 index 290dc556d9..0000000000 --- a/reference/ds/ds/hashable/equals.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Ds\Hashable::equals - Détermine si un objet est égal à l'instance actuelle - - - - &reftitle.description; - - abstract public boolDs\Hashable::equals - objectobj - - - Détermine si un autre objet est égal à l'instance actuelle. - - - - Cette méthode permet d'utiliser des objets comme clés dans des structures telles que - Ds\Map et Ds\Set, ou toute autre - structure de recherche qui respecte cette interface. - - - - - Il est garanti que obj est une instance de la même classe. - - - - - - Il est important que les objets qui sont égaux aient également la même valeur de hachage. - Voir Ds\Hashable::hash. - - - - - - - &reftitle.parameters; - - - obj - - - L'objet à comparer à l'instance actuelle, qui est toujours une instance de - la même classe. - - - - - - - - &reftitle.returnvalues; - - &true; si les objets sont égaux, sinon &false;. - - - - - - - diff --git a/reference/ds/ds/hashable/hash.xml b/reference/ds/ds/hashable/hash.xml deleted file mode 100644 index 986b4a3472..0000000000 --- a/reference/ds/ds/hashable/hash.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - Ds\Hashable::hash - Renvoie une valeur scalaire à utiliser comme valeur de hachage - - - - &reftitle.description; - - abstract public mixedDs\Hashable::hash - - - - Renvoie une valeur scalaire à utiliser comme valeur de hachage des objets. - - - Tant que la valeur de hachage ne définit pas l'égalité, tous les objets qui sont égaux selon Ds\Hashable::equals - doivent avoir la même valeur de hachage. Les valeurs de hachage des objets égaux n'ont pas à être uniques, par exemple - l'on pourrait simplement retourner &true; pour tous les objets et rien ne se casserait - la seule - implication serait que les tables de hachage se transformeraient en listes chaînées car tous - les objets seront hachés dans le même seau. Il est donc très important - que l'on choisisse une bonne valeur de hachage, telle qu'un ID ou une adresse e-mail. - - - - Cette méthode permet d'utiliser des objets comme clés dans des structures telles que - Ds\Map et Ds\Set, ou toute autre - structure de recherche qui respecte cette interface. - - - - - Il ne faut pas choisir une valeur qui pourrait changer dans l'objet, comme une propriété publique. - Les recherches dans les tables de hachage échoueraient car le hachage a changé. - - - - - - Tous les objets qui sont égaux doivent avoir la même valeur de hachage. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une valeur scalaire à utiliser comme valeur de hachage de cet objet. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Hashable::hash</function> - -name = $name; - $this->email = $email; - } - - /** - * Devrait renvoyer la même valeur pour tous les objets égaux, mais n'a pas à - * être unique. Cette valeur ne sera pas utilisée pour déterminer l'égalité. - */ - public function hash() - { - return $this->email; - } - - /** - * Détermine l'égalité, généralement lors d'une recherche dans une table de hachage pour déterminer - * si la clé du seau correspond à la clé de recherche. Le hachage doit être égal si - * les objets sont égaux, sinon cette détermination ne serait pas atteinte. - */ - public function equals($obj): bool - { - return $this->name === $obj->name - && $this->email === $obj->email; - } -} -?> -]]> - - - - - - - - diff --git a/reference/ds/ds/map/allocate.xml b/reference/ds/ds/map/allocate.xml deleted file mode 100644 index 954f93e92b..0000000000 --- a/reference/ds/ds/map/allocate.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Map::allocate - Alloue suffisamment de mémoire pour une capacité requise - - - - &reftitle.description; - - public voidDs\Map::allocate - intcapacity - - - Alloue suffisamment de mémoire pour une capacité requise. - - - - - - &reftitle.parameters; - - - capacity - - - Le nombre de valeurs pour lesquelles la capacité doit être allouée. - - - - La capacité restera la même si cette valeur est inférieure ou égale à la - capacité actuelle. - - - - - La capacité sera toujours arrondie à la puissance de 2 la plus proche. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::allocate</function> - -capacity()); - -$map->allocate(100); -var_dump($map->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/apply.xml b/reference/ds/ds/map/apply.xml deleted file mode 100644 index 5740e196d9..0000000000 --- a/reference/ds/ds/map/apply.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Ds\Map::apply - Met à jour toutes les valeurs en appliquant une fonction de rappel à chaque valeur - - - - &reftitle.description; - - public voidDs\Map::apply - callablecallback - - - Met à jour toutes les valeurs en appliquant une callback à - chaque valeur de la carte. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedkey - mixedvalue - - - - Un callable à appliquer à chaque valeur de la carte. - - - - La fonction de rappel doit retourner ce que la valeur doit être remplacée par. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::apply</function> - - 1, "b" => 2, "c" => 3]); -$map->apply(function($key, $value) { return $value * 2; }); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 4 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 6 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/capacity.xml b/reference/ds/ds/map/capacity.xml deleted file mode 100644 index 4fca54fd48..0000000000 --- a/reference/ds/ds/map/capacity.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Ds\Map::capacity - Renvoie la capacité actuelle - - - - &reftitle.description; - - public intDs\Map::capacity - - - - Renvoie la capacité actuelle. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacité actuelle. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::capacity</function> - -capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/clear.xml b/reference/ds/ds/map/clear.xml deleted file mode 100644 index 91b42f9ef7..0000000000 --- a/reference/ds/ds/map/clear.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Ds\Map::clear - Enlève toutes les valeurs - - - - &reftitle.description; - - public voidDs\Map::clear - - - - Enlève toutes les valeurs de la carte. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::clear</function> - - 1, - "b" => 2, - "c" => 3, -]); -print_r($map); - -$map->clear(); -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -Ds\Map Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/construct.xml b/reference/ds/ds/map/construct.xml deleted file mode 100644 index 867b7a024d..0000000000 --- a/reference/ds/ds/map/construct.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Ds\Map::__construct - Crée une nouvelle instance - - - - &reftitle.description; - - public Ds\Map::__construct - mixedvalues - - - Crée une nouvelle instance, en utilisant soit un objet traversable - soit un &array; pour les values initiales. - - - - - - &reftitle.parameters; - - - values - - - Un objet traversable ou un &array; à utiliser pour les valeurs initiales. - - - - - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::__construct</function> - - 1, "b" => 2, "c" => 3]); -var_dump($map); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#1 (2) { - ["key"]=> - string(1) "a" - ["value"]=> - int(1) - } - [1]=> - object(Ds\Pair)#3 (2) { - ["key"]=> - string(1) "b" - ["value"]=> - int(2) - } - [2]=> - object(Ds\Pair)#4 (2) { - ["key"]=> - string(1) "c" - ["value"]=> - int(3) - } -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/copy.xml b/reference/ds/ds/map/copy.xml deleted file mode 100644 index 95c3daf0e6..0000000000 --- a/reference/ds/ds/map/copy.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Map::copy - Renvoie une copie superficielle de la carte - - - - &reftitle.description; - - public Ds\MapDs\Map::copy - - - - Renvoie une copie superficielle de la carte. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une copie superficielle de la carte. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::copy</function> - - 1, - "b" => 2, - "c" => 3, -]); - -print_r($map->copy()); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/count.xml b/reference/ds/ds/map/count.xml deleted file mode 100644 index a70e806948..0000000000 --- a/reference/ds/ds/map/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Map::count - Renvoie le nombre de valeurs dans la carte - - - - &reftitle.description; - - Voir Countable::count - - - - - - diff --git a/reference/ds/ds/map/diff.xml b/reference/ds/ds/map/diff.xml deleted file mode 100644 index 291f3a4c11..0000000000 --- a/reference/ds/ds/map/diff.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Ds\Map::diff - Crée une nouvelle map en utilisant des clés qui ne sont pas dans une autre map - - - - &reftitle.description; - - public Ds\MapDs\Map::diff - Ds\Mapmap - - - Renvoie le résultat de la suppression de toutes les clés de l'instance actuelle qui sont - présentes dans une map donnée. - - - A \ B = {x ∈ A | x ∉ B} - - - - - &reftitle.parameters; - - - map - - - La map contenant les clés à exclure de la map résultante. - - - - - - - - &reftitle.returnvalues; - - Le résultat de la suppression de toutes les clés de l'instance actuelle qui sont - présentes dans une map donnée. - - - - - &reftitle.seealso; - - - Complement sur Wikipedia - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::diff</function> - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(["b" => 4, "c" => 5, "d" => 6]); - -var_dump($a->diff($b)); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#4 (2) { - ["key"]=> - string(1) "a" - ["value"]=> - int(1) - } -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/filter.xml b/reference/ds/ds/map/filter.xml deleted file mode 100644 index c4634e1e17..0000000000 --- a/reference/ds/ds/map/filter.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - Ds\Map::filter - - Crée une nouvelle carte en utilisant un callable pour déterminer quelles paires inclure - - - - - &reftitle.description; - - public Ds\MapDs\Map::filter - callablecallback - - - Crée une nouvelle carte en utilisant un callable pour déterminer quelles paires inclure. - - - - - - &reftitle.parameters; - - - callback - - - - bool - callback - mixedkey - mixedvalue - - - - Un callable optionnel qui retourne &true; si la paire doit être incluse, &false; sinon. - - - Si aucune fonction de rappel n'est fournie, seules les valeurs qui sont &true; - (voir conversion en booléen) - seront incluses. - - - - - - - - &reftitle.returnvalues; - - Une nouvelle carte contenant toutes les paires pour lesquelles - soit le callback a retourné &true;, soit toutes les valeurs qui - se convertissent en &true; si un callback n'a pas été fourni. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::filter</function> en utilisant une fonction de rappel - -filter(function($key, $value) { - return $key % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#2 (2) { - ["key"]=> - int(0) - ["value"]=> - string(1) "a" - } - [1]=> - object(Ds\Pair)#4 (2) { - ["key"]=> - int(2) - ["value"]=> - string(1) "c" - } - [2]=> - object(Ds\Pair)#5 (2) { - ["key"]=> - int(4) - ["value"]=> - string(1) "e" - } -} -]]> - - - - Exemple de <function>Ds\Map::filter</function> sans fonction de rappel - - 0, "b" => 1, "c" => true, "d" => false]); - -var_dump($map->filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/first.xml b/reference/ds/ds/map/first.xml deleted file mode 100644 index ea6c8b674d..0000000000 --- a/reference/ds/ds/map/first.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Map::first - Renvoie la première paire de la carte - - - - &reftitle.description; - - public Ds\PairDs\Map::first - - - - Renvoie la première paire de la carte. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La première paire de la carte. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::first</function> - - 1, "b" => 2, "c" => 3]); -var_dump($map->first()); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - ["value"]=> - int(1) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/get.xml b/reference/ds/ds/map/get.xml deleted file mode 100644 index 79f16456ce..0000000000 --- a/reference/ds/ds/map/get.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - Ds\Map::get - Renvoie la valeur pour une clé donnée - - - - &reftitle.description; - - public mixedDs\Map::get - mixedkey - mixeddefault - - - Renvoie la valeur pour une clé donnée, ou une valeur par défaut optionnelle si la clé - n'a pas pu être trouvée. - - - - - Les clés de type object sont prises en charge. - - Si un objet implémente Ds\Hashable, - l'égalité sera déterminée par la fonction equals de l'objet. - - Si un objet n'implémente pas Ds\Hashable, - les objets doivent être des références à la même instance pour être considérés comme égaux. - - - - - - Il est également possible d'utiliser la syntaxe de tableau pour accéder aux valeurs par clé, par exemple $map["clé"]. - - - - - - Attention à l'utilisation de la syntaxe de tableau. Les clés scalaires seront coercées en - entiers par le moteur. Par exemple, $map["1"] tentera d'accéder à int(1), - tandis que $map->get("1") recherchera correctement la clé de chaîne. - - - Voir tableau. - - - - - - - &reftitle.parameters; - - - key - - - La clé à rechercher. - - - - - default - - - La valeur par défaut optionnelle, renvoyée si la clé n'a pas pu être trouvée. - - - - - - - - &reftitle.returnvalues; - - La valeur mappée à la key donnée, ou la default - si fournie et que la clé n'a pas pu être trouvée dans la carte. - - - - - &reftitle.errors; - - OutOfBoundsException si la clé n'a pas pu être trouvée - et qu'aucune valeur par défaut n'a été fournie. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::get</function> - - 1, "b" => 2, "c" => 3]); - -var_dump($map->get("a")); // 1 -var_dump($map->get("d", 10)); // 10 (valeur par défaut utilisée) -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Map::get</function> utilisant la syntaxe de tableau - - 1, "b" => 2, "c" => 3]); - -var_dump($map["a"]); // 1 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/haskey.xml b/reference/ds/ds/map/haskey.xml deleted file mode 100644 index 25cd2cc2b4..0000000000 --- a/reference/ds/ds/map/haskey.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Map::hasKey - Détermine si la carte contient une clé donnée - - - - &reftitle.description; - - public boolDs\Map::hasKey - mixedkey - - - Détermine si la carte contient une clé donnée. - - - - - - &reftitle.parameters; - - - key - - - La clé à rechercher. - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; si la clé a été trouvée, sinon &false;. - - - - - &reftitle.examples; - - Exemple avec <function>Ds\Map::hasKey</function> - - 1, "b" => 2, "c" => 3]); - -var_dump($map->hasKey("a")); // true -var_dump($map->hasKey("e")); // false -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/hasvalue.xml b/reference/ds/ds/map/hasvalue.xml deleted file mode 100644 index 66587cd47d..0000000000 --- a/reference/ds/ds/map/hasvalue.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Map::hasValue - Détermine si la carte contient une valeur donnée - - - - &reftitle.description; - - public boolDs\Map::hasValue - mixedvalue - - - Détermine si la carte contient une valeur donnée. - - - - - - &reftitle.parameters; - - - value - - - La valeur à rechercher. - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; si la valeur a été trouvée, sinon &false;. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::hasValue</function> - - 1, "b" => 2, "c" => 3]); - -var_dump($map->hasValue(1)); // true -var_dump($map->hasValue(4)); // false -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/intersect.xml b/reference/ds/ds/map/intersect.xml deleted file mode 100644 index 9c5cde5fce..0000000000 --- a/reference/ds/ds/map/intersect.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - Ds\Map::intersect - Crée une nouvelle carte en intersectant les clés avec une autre carte - - - - &reftitle.description; - - public Ds\MapDs\Map::intersect - Ds\Mapmap - - - Crée une nouvelle carte contenant les paires de l'instance actuelle dont les clés - sont également présentes dans la map donnée. - - En d'autres termes, renvoie une copie de l'instance actuelle avec toutes les clés supprimées qui - ne sont pas également dans l'autre map. - - - A ∩ B = {x : x ∈ A ∧ x ∈ B} - - - - - Les valeurs de l'instance actuelle seront conservées. - - - - - - &reftitle.parameters; - - - map - - - L'autre carte, contenant les clés à intersecter. - - - - - - - - &reftitle.returnvalues; - - L'intersection des clés de l'instance actuelle et d'une autre map. - - - - - &reftitle.seealso; - - - Intersection sur Wikipedia - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::intersect</function> - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(["b" => 4, "c" => 5, "d" => 6]); - -var_dump($a->intersect($b)); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#4 (2) { - ["key"]=> - string(1) "b" - ["value"]=> - int(2) - } - [1]=> - object(Ds\Pair)#5 (2) { - ["key"]=> - string(1) "c" - ["value"]=> - int(3) - } -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/isempty.xml b/reference/ds/ds/map/isempty.xml deleted file mode 100644 index ecf99eefab..0000000000 --- a/reference/ds/ds/map/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Map::isEmpty - Renvoie si la carte est vide - - - - &reftitle.description; - - public boolDs\Map::isEmpty - - - - Renvoie si la carte est vide. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si la carte est vide, sinon &false;. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::isEmpty</function> - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(); - -var_dump($a->isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/jsonserialize.xml b/reference/ds/ds/map/jsonserialize.xml deleted file mode 100644 index 8287d6cbc2..0000000000 --- a/reference/ds/ds/map/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Map::jsonSerialize - Renvoie une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - Voir JsonSerializable::jsonSerialize - - - - Il ne devrait jamais être nécessaire d'appeler cette méthode directement. - - - - - - - diff --git a/reference/ds/ds/map/keys.xml b/reference/ds/ds/map/keys.xml deleted file mode 100644 index 639bb5df49..0000000000 --- a/reference/ds/ds/map/keys.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Map::keys - Renvoie un ensemble des clés de la carte - - - - &reftitle.description; - - public Ds\SetDs\Map::keys - - - - Renvoie un ensemble contenant toutes les clés de la carte, dans le même ordre. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un ensemble Ds\Set contenant toutes les clés de la carte. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::keys</function> - - 1, "b" => 2, "c" => 3]); -var_dump($map->keys()); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - [1]=> - string(1) "b" - [2]=> - string(1) "c" -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/ksort.xml b/reference/ds/ds/map/ksort.xml deleted file mode 100644 index 31c1b898fb..0000000000 --- a/reference/ds/ds/map/ksort.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - Ds\Map::ksort - - Trie la carte en place par clé - - - - - &reftitle.description; - - public voidDs\Map::ksort - callablecomparator - - - Trie la carte en place par clé, en utilisant une fonction comparator facultative. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::ksort</function> - - 2, "c" => 3, "a" => 1]); -$map->ksort(); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - Exemple de <function>Ds\Map::ksort</function> utilisant un comparateur - - "x", 2 => "y", 0 => "z"]); - -// Inversé -$map->ksort(function($a, $b) { - return $b <=> $a; -}); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => 2 - [value] => y - ) - - [1] => Ds\Pair Object - ( - [key] => 1 - [value] => x - ) - - [2] => Ds\Pair Object - ( - [key] => 0 - [value] => z - ) - -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/map/ksorted.xml b/reference/ds/ds/map/ksorted.xml deleted file mode 100644 index 705493d5ff..0000000000 --- a/reference/ds/ds/map/ksorted.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - Ds\Map::ksorted - Renvoie une copie, triée par clé - - - - &reftitle.description; - - public Ds\MapDs\Map::ksorted - callablecomparator - - - Renvoie une copie triée par clé, en utilisant une fonction comparator facultative. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Renvoie une copie de la carte, triée par clé. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::ksorted</function> - - 2, "c" => 3, "a" => 1]); - -print_r($map->ksorted()); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - Exemple de <function>Ds\Map::ksorted</function> utilisant un comparateur - - "x", 2 => "y", 0 => "z"]); - -// Inversé -$sorted = $map->ksorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => 2 - [value] => y - ) - - [1] => Ds\Pair Object - ( - [key] => 1 - [value] => x - ) - - [2] => Ds\Pair Object - ( - [key] => 0 - [value] => z - ) - -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/map/last.xml b/reference/ds/ds/map/last.xml deleted file mode 100644 index f11093c9ca..0000000000 --- a/reference/ds/ds/map/last.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Map::last - Renvoie la dernière paire de la carte - - - - &reftitle.description; - - public Ds\PairDs\Map::last - - - - Renvoie la dernière paire de la carte. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la dernière paire de la carte. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::last</function> - - 1, "b" => 2, "c" => 3]); -var_dump($map->last()); -?> -]]> - - &example.outputs.similar; - - - string(1) "c" - ["value"]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/map.xml b/reference/ds/ds/map/map.xml deleted file mode 100644 index b0002753d5..0000000000 --- a/reference/ds/ds/map/map.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - Ds\Map::map - Renvoie le résultat de l'application d'une fonction de rappel à chaque valeur - - - - &reftitle.description; - - public Ds\MapDs\Map::map - callablecallback - - - Renvoie le résultat de l'application d'un callback à - chaque valeur de la carte. - - - - - &reftitle.parameters; - - - callback - - - - mixed - callback - mixedkey - mixedvalue - - - - Un callable à appliquer à chaque valeur de la carte. - - - - La fonction de rappel doit retourner ce à quoi la clé sera mappée - dans la carte résultante. - - - - - - - - - &reftitle.returnvalues; - - Le résultat de l'application d'un callback à chaque valeur de - la carte. - - - - Les clés et les valeurs de l'instance actuelle ne seront pas affectées. - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::map</function> - - 1, "b" => 2, "c" => 3]); - -print_r($map->map(function($key, $value) { return $value * 2; })); -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 4 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 6 - ) - -) -Ds\Map Object -( - [0] => Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/merge.xml b/reference/ds/ds/map/merge.xml deleted file mode 100644 index a1787c352d..0000000000 --- a/reference/ds/ds/map/merge.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Ds\Map::merge - Renvoie le résultat de l'ajout de toutes les associations données - - - - &reftitle.description; - - public Ds\MapDs\Map::merge - mixedvalues - - - Renvoie le résultat de l'ajout de toutes les associations d'un objet traversable - donné ou d'un &array; avec leurs valeurs correspondantes, combinées avec l'instance actuelle. - - - - - Les valeurs de l'instance actuelle seront écrasées par celles fournies lorsque les clés sont égales. - - - - - - - &reftitle.parameters; - - - values - - - Un objet traversable ou un &array;. - - - - - - - - &reftitle.returnvalues; - - Le résultat de l'association de toutes les clés d'un objet traversable - donné ou d'un &array; avec leurs valeurs correspondantes, combinées avec l'instance actuelle. - - - - L'instance actuelle ne sera pas affectée. - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::merge</function> - - 1, "b" => 2, "c" => 3]); - -print_r($map->merge(["a" => 10, "e" => 50])); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 10 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - - [3] => Ds\Pair Object - ( - [key] => e - [value] => 50 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/pairs.xml b/reference/ds/ds/map/pairs.xml deleted file mode 100644 index f25faefde5..0000000000 --- a/reference/ds/ds/map/pairs.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - Ds\Map::pairs - Renvoie une séquence contenant toutes les paires de la carte - - - - &reftitle.description; - - public Ds\SequenceDs\Map::pairs - - - - Renvoie une Ds\Sequence contenant toutes les paires de la carte. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Ds\Sequence contenant toutes les paires de la carte. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::pairs</function> - - 1, "b" => 2, "c" => 3]); - -var_dump($map->pairs()); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#5 (2) { - ["key"]=> - string(1) "a" - ["value"]=> - int(1) - } - [1]=> - object(Ds\Pair)#6 (2) { - ["key"]=> - string(1) "b" - ["value"]=> - int(2) - } - [2]=> - object(Ds\Pair)#7 (2) { - ["key"]=> - string(1) "c" - ["value"]=> - int(3) - } -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/put.xml b/reference/ds/ds/map/put.xml deleted file mode 100644 index 08043c91cc..0000000000 --- a/reference/ds/ds/map/put.xml +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - Ds\Map::put - Associe une clé à une valeur - - - - &reftitle.description; - - public voidDs\Map::put - mixedkey - mixedvalue - - - Associe une key à une value, - en écrasant une association précédente si elle existe. - - - - - Les clés de type object sont supportées. - - Si un objet implémente Ds\Hashable, - l'égalité sera déterminée par la fonction equals de l'objet. - - Si un objet n'implémente pas Ds\Hashable, - les objets doivent être des références à la même instance pour être considérés comme égaux. - - - - - - Il est également possible d'utiliser la syntaxe de tableau pour associer des valeurs par clé, par exemple $map["clé"] = $valeur. - - - - - - Attention à l'utilisation de la syntaxe de tableau. Les clés scalaires seront coercées en - entiers par le moteur. Par exemple, $map["1"] tentera d'accéder à - int(1), tandis que $map->get("1") - recherchera correctement la clé de chaîne. - - - Voir tableaux. - - - - - - - &reftitle.parameters; - - - key - - - La clé à associer à la valeur. - - - - - value - - - La valeur à associer à la clé. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::put</function> - -put("a", 1); -$map->put("b", 2); -$map->put("c", 3); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - Exemple de <function>Ds\Map::put</function> utilisant des objets en tant que clé - -value = $value; - } - - public function hash() - { - return $this->value; - } - - public function equals($obj): bool - { - return $this->value === $obj->value; - } -} - -$map = new \Ds\Map(); - -$obj = new \ArrayIterator([]); - -// Utiliser la même instance plusieurs fois écrasera la valeur précédente. -$map->put($obj, 1); -$map->put($obj, 2); - -// Utiliser plusieurs instances du même objet créera de nouvelles associations. -$map->put(new \stdClass(), 3); -$map->put(new \stdClass(), 4); - -// Utiliser plusieurs instances d'objets égaux écrasera les valeurs précédentes. -$map->put(new \HashableObject(1), 5); -$map->put(new \HashableObject(1), 6); -$map->put(new \HashableObject(2), 7); -$map->put(new \HashableObject(2), 8); - -var_dump($map); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#7 (2) { - ["key"]=> - object(ArrayIterator)#2 (1) { - ["storage":"ArrayIterator":private]=> - array(0) { - } - } - ["value"]=> - int(2) - } - [1]=> - object(Ds\Pair)#8 (2) { - ["key"]=> - object(stdClass)#3 (0) { - } - ["value"]=> - int(3) - } - [2]=> - object(Ds\Pair)#9 (2) { - ["key"]=> - object(stdClass)#4 (0) { - } - ["value"]=> - int(4) - } - [3]=> - object(Ds\Pair)#10 (2) { - ["key"]=> - object(HashableObject)#5 (1) { - ["value":"HashableObject":private]=> - int(1) - } - ["value"]=> - int(6) - } - [4]=> - object(Ds\Pair)#11 (2) { - ["key"]=> - object(HashableObject)#6 (1) { - ["value":"HashableObject":private]=> - int(2) - } - ["value"]=> - int(8) - } -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/putAll.xml b/reference/ds/ds/map/putAll.xml deleted file mode 100644 index 45afb995c1..0000000000 --- a/reference/ds/ds/map/putAll.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Ds\Map::putAll - Associe toutes les paires clé-valeur d'un objet traversable ou d'un tableau - - - - &reftitle.description; - - public voidDs\Map::putAll - mixedpairs - - - Associe toutes les paires clé-valeur d'un objet traversable ou d'un &array;. - - - - - Les clés de type object sont supportées. - - Si un objet implémente Ds\Hashable, - l'égalité sera déterminée par la fonction equals de l'objet. - - Si un objet n'implémente pas Ds\Hashable, - les objets doivent être des références à la même instance pour être considérés comme égaux. - - - - - - - &reftitle.parameters; - - - pairs - - - Un objet traversable ou &array;. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::putAll</function> - -putAll([ - "a" => 1, - "b" => 2, - "c" => 3, -]); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/map/reduce.xml b/reference/ds/ds/map/reduce.xml deleted file mode 100644 index dbcecedcc3..0000000000 --- a/reference/ds/ds/map/reduce.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - Ds\Map::reduce - Réduit la carte à une seule valeur en utilisant une fonction de rappel - - - - &reftitle.description; - - public mixedDs\Map::reduce - callablecallback - mixedinitial - - - Réduit la carte à une seule valeur en utilisant une fonction de rappel. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedkey - mixedvalue - - - - carry - - - La valeur de retour du rappel précédent, ou initial si - c'est la première itération. - - - - - key - - - La clé de l'itération actuelle. - - - - - value - - - La valeur de l'itération actuelle. - - - - - - - - - initial - - - La valeur initiale de la valeur de retour. Peut être &null;. - - - - - - - - &reftitle.returnvalues; - - La valeur de retour du rappel final. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::reduce</function> avec valeur initiale - - 1, "b" => 2, "c" => 3]); - -$callback = function($carry, $key, $value) { - return $carry * $value; -}; - -var_dump($map->reduce($callback, 5)); - -// Itérations: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Map::reduce</function> sans valeur initiale - - 1, "b" => 2, "c" => 3]); - -var_dump($map->reduce(function($carry, $key, $value) { - return $carry + $value + 5; -})); - -// Itérations: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/remove.xml b/reference/ds/ds/map/remove.xml deleted file mode 100644 index d678288de8..0000000000 --- a/reference/ds/ds/map/remove.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - Ds\Map::remove - Enlève et renvoie une valeur par clé - - - - &reftitle.description; - - public mixedDs\Map::remove - mixedkey - mixeddefault - - - Enlève et renvoie une valeur par clé, ou renvoie une valeur par défaut optionnelle si la clé - n'a pas pu être trouvée. - - - - - Les clés de type object sont supportées. - - Si un objet implémente Ds\Hashable, - l'égalité sera déterminée par la fonction equals de l'objet. - - Si un objet n'implémente pas Ds\Hashable, - les objets doivent être des références à la même instance pour être considérés comme égaux. - - - - - - Il est également possible d'utiliser la syntaxe de tableau pour accéder aux valeurs par clé, par exemple $map["clé"]. - - - - - - Attention à l'utilisation de la syntaxe de tableau. Les clés scalaires seront coercées en - entiers par le moteur. Par exemple, $map["1"] tentera d'accéder à - int(1), tandis que $map->get("1") - recherchera correctement la clé de chaîne. - - - Voir tableaux. - - - - - - - &reftitle.parameters; - - - key - - - La clé à enlever. - - - - - default - - - La valeur par défaut optionnelle, renvoyée si la clé n'a pas pu être trouvée. - - - - - - - - &reftitle.returnvalues; - - La valeur qui a été enlevée, ou la default - valeur si elle a été fournie et que la key n'a pas pu être trouvée dans la carte. - - - - - &reftitle.errors; - - OutOfBoundsException si la clé n'a pas été trouvée - et qu'aucune valeur par défaut n'a été fournie. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::remove</function> - - 1, "b" => 2, "c" => 3]); - -var_dump($map->remove("a")); // 1 -var_dump($map->remove("e", 10)); // 10 (utilisation de la valeur par défaut) -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/reverse.xml b/reference/ds/ds/map/reverse.xml deleted file mode 100644 index 05e5274f98..0000000000 --- a/reference/ds/ds/map/reverse.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Map::reverse - - Renverse la carte en place - - - - - &reftitle.description; - - public voidDs\Map::reverse - - - - Renverse la carte en place. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::reverse</function> - - 1, "b" => 2, "c" => 3]); -$map->reverse(); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/reversed.xml b/reference/ds/ds/map/reversed.xml deleted file mode 100644 index c36a1511b8..0000000000 --- a/reference/ds/ds/map/reversed.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Map::reversed - Renvoie une copie inversée - - - - &reftitle.description; - - public Ds\MapDs\Map::reversed - - - - Renvoie une copie inversée de la carte. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une copie inversée de la carte. - - - - L'instance actuelle n'est pas affectée. - - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::reversed</function> - - 1, "b" => 2, "c" => 3]); - -print_r($map->reversed()); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/skip.xml b/reference/ds/ds/map/skip.xml deleted file mode 100644 index 0f41b28a9e..0000000000 --- a/reference/ds/ds/map/skip.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Map::skip - Renvoie la paire à un index de position donné - - - - &reftitle.description; - - public Ds\PairDs\Map::skip - intposition - - - Renvoie la paire à un index donné basé sur zéro position. - - - - - - &reftitle.parameters; - - - position - - - L'index de position basé sur zéro à renvoyer. - - - - - - - - &reftitle.returnvalues; - - Renvoie la Ds\Pair à la position donnée. - - - - - &reftitle.errors; - - OutOfRangeException si la position n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::skip</function> - - 1, "b" => 2, "c" => 3]); - -var_dump($map->skip(1)); -?> -]]> - - &example.outputs.similar; - - - string(1) "b" - ["value"]=> - int(2) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/slice.xml b/reference/ds/ds/map/slice.xml deleted file mode 100644 index a5ae6f8bd5..0000000000 --- a/reference/ds/ds/map/slice.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - Ds\Map::slice - - Renvoie un sous-ensemble de la carte défini par un index de départ et une longueur - - - - - &reftitle.description; - - public Ds\MapDs\Map::slice - intindex - intlength - - - Renvoie un sous-ensemble de la carte défini par un index de départ et une longueur length. - - - - - - &reftitle.parameters; - - - index - - - L'index à partir duquel la plage commence. - - - Si positif, la plage commencera à cet index dans la carte. - Si négatif, la plage commencera à cette distance de la fin. - - - - - length - - - Si une longueur est donnée et est positive, la carte résultante - aura jusqu'à autant de paires. - - Si une longueur est donnée et est négative, la plage - s'arrêtera à autant de paires de la fin. - - Si la longueur entraîne un dépassement, seules - les paires jusqu'à la fin de la carte seront incluses. - - Si une longueur n'est pas fournie, la carte résultante - contiendra toutes les paires entre l'index et la fin de la carte. - - - - - - - - &reftitle.returnvalues; - - Un sous-ensemble de la carte défini par un index de départ et une longueur. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::slice</function> - - 1, "b" => 2, "c" => 3, "d" => 4, "e" => 5]); - -// Découpe à partir de l'index 2 -print_r($map->slice(2)->toArray()); - -// Découpe à partir de l'index 1, pour une longueur de 3 -print_r($map->slice(1, 3)->toArray()); - -// Découpe à partir de l'index 1 -print_r($map->slice(1)->toArray()); - -// Découpe à partir du 2e depuis la fin -print_r($map->slice(-2)->toArray()); - -// Découpe de l'index 1 à 1 depuis la fin -print_r($map->slice(1, -1)->toArray()); -?> -]]> - - &example.outputs.similar; - - 3 - [d] => 4 - [e] => 5 -) -Array -( - [b] => 2 - [c] => 3 - [d] => 4 -) -Array -( - [b] => 2 - [c] => 3 - [d] => 4 - [e] => 5 -) -Array -( - [d] => 4 - [e] => 5 -) -Array -( - [b] => 2 - [c] => 3 - [d] => 4 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/sort.xml b/reference/ds/ds/map/sort.xml deleted file mode 100644 index b9f74c6951..0000000000 --- a/reference/ds/ds/map/sort.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - Ds\Map::sort - - Trie la carte en place par valeur - - - - - &reftitle.description; - - public voidDs\Map::sort - callablecomparator - - - Trie la carte en place par valeur, en utilisant une fonction comparator optionnelle. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::sort</function> - - 2, "b" => 3, "c" => 1]); -$map->sort(); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => c - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - -) -]]> - - - - Exemple de <function>Ds\Map::sort</function> utilisant un comparateur - - 2, "b" => 3, "c" => 1]); - -$map->sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - - [1] => Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 1 - ) - -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/map/sorted.xml b/reference/ds/ds/map/sorted.xml deleted file mode 100644 index 345b8bbdfa..0000000000 --- a/reference/ds/ds/map/sorted.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - Ds\Map::sorted - Renvoie une copie, triée par valeur - - - - &reftitle.description; - - public Ds\MapDs\Map::sorted - callablecomparator - - - Renvoie une copie, triée par valeur en utilisant une fonction comparator optionnelle. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Renvoie une copie de la carte, triée par valeur. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::sort</function> - - 2, "b" => 3, "c" => 1]); - -print_r($map->sorted()); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => c - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - -) -]]> - - - - Exemple de <function>Ds\Map::sort</function> utilisant un comparateur - - 2, "b" => 3, "c" => 1]); - -// Inversé -$sorted = $map->sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - - [1] => Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 1 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/sum.xml b/reference/ds/ds/map/sum.xml deleted file mode 100644 index 886a9c9b6f..0000000000 --- a/reference/ds/ds/map/sum.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Map::sum - Renvoie la somme de toutes les valeurs de la carte - - - - &reftitle.description; - - public intfloatDs\Map::sum - - - - Renvoie la somme de toutes les valeurs de la carte. - - - - Les tableaux et les objets sont considérés comme égaux à zéro lors du calcul de la somme. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La somme de toutes les valeurs de la carte en tant que float ou int - en fonction des valeurs de la carte. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::sum</function> avec des entiers - - 1, "b" => 2, "c" => 3]); -var_dump($map->sum()); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Map::sum</function> avec des nombres à virgule flottante - - 1, "b" => 2.5, "c" => 3]); -var_dump($map->sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/toarray.xml b/reference/ds/ds/map/toarray.xml deleted file mode 100644 index 66b719c9e7..0000000000 --- a/reference/ds/ds/map/toarray.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Ds\Map::toArray - - Convertit la carte en un &array; - - - - - &reftitle.description; - - public arrayDs\Map::toArray - - - - Convertit la carte en un &array;. - - - - Les cartes où les clés ne sont pas scalaires ne peuvent pas être converties en &array;. - - - - - Un &array; traitera toutes les clés numériques comme des entiers, - par exemple "1" et 1 en tant que clés dans la carte - ne résulteront qu'en 1 étant inclus dans le tableau. - - - - - La conversion en &array; n'est pas encore supportée. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; contenant toutes les valeurs dans le même ordre que la carte. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::toArray</function> - - 1, - "b" => 2, - "c" => 3, -]); - -var_dump($map->toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - ["b"]=> - int(2) - ["c"]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/union.xml b/reference/ds/ds/map/union.xml deleted file mode 100644 index ebb467eb86..0000000000 --- a/reference/ds/ds/map/union.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - Ds\Map::union - Crée une nouvelle carte en utilisant les valeurs de l'instance actuelle et d'une autre carte - - - - &reftitle.description; - - public Ds\MapDs\Map::union - Ds\Mapmap - - - Crée une nouvelle carte qui contient les paires de l'instance actuelle ainsi que les - paires d'une autre map. - - - A ∪ B = {x: x ∈ A ∨ x ∈ B} - - - - - Les valeurs de l'instance actuelle seront écrasées par celles fournies lorsque les clés sont égales. - - - - - - - &reftitle.parameters; - - - map - - - L'autre carte, à combiner avec l'instance actuelle. - - - - - - - - &reftitle.returnvalues; - - Une nouvelle carte contenant toutes les paires de l'instance actuelle ainsi que d'une autre map. - - - - - &reftitle.seealso; - - - Union sur Wikipedia - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::union</function> - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(["b" => 3, "c" => 4, "d" => 5]); - -print_r($a->union($b)); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 4 - ) - - [3] => Ds\Pair Object - ( - [key] => d - [value] => 5 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/values.xml b/reference/ds/ds/map/values.xml deleted file mode 100644 index e95fe9c7b5..0000000000 --- a/reference/ds/ds/map/values.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Map::values - Renvoie une séquence des valeurs de la carte - - - - &reftitle.description; - - public Ds\SequenceDs\Map::values - - - - Renvoie une séquence contenant toutes les valeurs de la carte, dans le même ordre. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une Ds\Sequence contenant toutes les valeurs de la carte. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::values</function> - - 1, "b" => 2, "c" => 3]); -var_dump($map->values()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/xor.xml b/reference/ds/ds/map/xor.xml deleted file mode 100644 index 1d808ee488..0000000000 --- a/reference/ds/ds/map/xor.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Ds\Map::xor - Crée une nouvelle carte en utilisant les clés de l'instance actuelle ou d'une autre carte, mais pas des deux - - - - &reftitle.description; - - public Ds\MapDs\Map::xor - Ds\Mapmap - - - Crée une nouvelle carte qui contient les clés de l'instance actuelle ainsi que d'une autre map, - mais pas des deux. - - - A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)} - - - - - &reftitle.parameters; - - - map - - - L'autre carte. - - - - - - - - &reftitle.returnvalues; - - Une nouvelle carte contenant les clés de l'instance actuelle ainsi que d'une autre map, - mais pas des deux. - - - - - &reftitle.seealso; - - - Différence symétrique sur Wikipedia - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Map::xor</function> - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(["b" => 4, "c" => 5, "d" => 6]); - -print_r($a->xor($b)); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => d - [value] => 6 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/pair/clear.xml b/reference/ds/ds/pair/clear.xml deleted file mode 100644 index 353e5b9025..0000000000 --- a/reference/ds/ds/pair/clear.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - Ds\Pair::clear - Supprime toutes les valeurs - - - - &reftitle.description; - - public voidDs\Pair::clear - - - - Supprime toutes les valeurs de la paire. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Pair::clear</function> - -clear(); -print_r($pair); -?> -]]> - - &example.outputs.similar; - - a - [value] => 1 -) -Ds\Pair Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/pair/construct.xml b/reference/ds/ds/pair/construct.xml deleted file mode 100644 index 63d9fb2e82..0000000000 --- a/reference/ds/ds/pair/construct.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Ds\Pair::__construct - Crée une nouvelle instance - - - - &reftitle.description; - - public Ds\Pair::__construct - mixedkey - mixedvalue - - - Crée une nouvelle instance en utilisant une key et une value données. - - - - - - &reftitle.parameters; - - - key - - - La clé. - - - - - value - - - La valeur. - - - - - - - - - - - - diff --git a/reference/ds/ds/pair/copy.xml b/reference/ds/ds/pair/copy.xml deleted file mode 100644 index 698d3fa434..0000000000 --- a/reference/ds/ds/pair/copy.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Ds\Pair::copy - Renvoie une copie superficielle de la paire - - - - &reftitle.description; - - public Ds\PairDs\Pair::copy - - - - Renvoie une copie superficielle de la paire. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une copie superficielle de la paire. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Pair::copy</function> - -copy(); - -$a->key = "x"; - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - x - [value] => 1 -) -Ds\Pair Object -( - [key] => a - [value] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/pair/isempty.xml b/reference/ds/ds/pair/isempty.xml deleted file mode 100644 index 221859c951..0000000000 --- a/reference/ds/ds/pair/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Pair::isEmpty - Renvoie si la paire est vide - - - - &reftitle.description; - - public boolDs\Pair::isEmpty - - - - Renvoie si la paire est vide. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si la paire est vide, sinon &false;. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Pair::isEmpty</function> - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/pair/jsonserialize.xml b/reference/ds/ds/pair/jsonserialize.xml deleted file mode 100644 index 9f6b11c16a..0000000000 --- a/reference/ds/ds/pair/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Pair::jsonSerialize - Renvoie une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - Voir JsonSerializable::jsonSerialize - - - - Il ne devrait jamais être nécessaire d'appeler cette méthode directement. - - - - - - - diff --git a/reference/ds/ds/pair/toarray.xml b/reference/ds/ds/pair/toarray.xml deleted file mode 100644 index 166266106a..0000000000 --- a/reference/ds/ds/pair/toarray.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Pair::toArray - - Convertit la paire en un &array; - - - - - &reftitle.description; - - public arrayDs\Pair::toArray - - - - Convertit la paire en un &array;. - - - - La conversion en &array; n'est pas encore supportée. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; contenant toutes les valeurs dans le même ordre que la paire. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Pair::toArray</function> - -toArray()); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - ["value"]=> - int(1) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/allocate.xml b/reference/ds/ds/priorityqueue/allocate.xml deleted file mode 100644 index 83c5aa71a9..0000000000 --- a/reference/ds/ds/priorityqueue/allocate.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\PriorityQueue::allocate - Alloue suffisamment de mémoire pour une capacité requise - - - - &reftitle.description; - - public voidDs\PriorityQueue::allocate - intcapacity - - - Assure qu'assez de mémoire est allouée pour une capacité requise. - Cela élimine le besoin de réallouer le tampon interne à mesure que les valeurs sont ajoutées. - - - - - &reftitle.parameters; - - - capacity - - - Le nombre de valeurs pour lesquelles la capacité doit être allouée. - - - - La capacité restera la même si cette valeur est inférieure ou égale à la - capacité actuelle. - - - - - La capacité sera toujours arrondie à la puissance de 2 la plus proche. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - &reftitle.examples; - - Exemple de <function>Ds\PriorityQueue::allocate</function> - -capacity()); - -$queue->allocate(100); -var_dump($queue->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/capacity.xml b/reference/ds/ds/priorityqueue/capacity.xml deleted file mode 100644 index d713327c33..0000000000 --- a/reference/ds/ds/priorityqueue/capacity.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Ds\PriorityQueue::capacity - Renvoie la capacité actuelle - - - - &reftitle.description; - - public intDs\PriorityQueue::capacity - - - - Renvoie la capacité actuelle. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacité actuelle. - - - - - &reftitle.examples; - - Exemple de <function>Ds\PriorityQueue::capacity</function> - -capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/clear.xml b/reference/ds/ds/priorityqueue/clear.xml deleted file mode 100644 index 97a60f24c2..0000000000 --- a/reference/ds/ds/priorityqueue/clear.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\PriorityQueue::clear - Supprime toutes les valeurs - - - - &reftitle.description; - - public voidDs\PriorityQueue::clear - - - - Supprime toutes les valeurs de la queue. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\PriorityQueue::clear</function> - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -$queue->clear(); -print_r($queue); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/construct.xml b/reference/ds/ds/priorityqueue/construct.xml deleted file mode 100644 index 60e97e212d..0000000000 --- a/reference/ds/ds/priorityqueue/construct.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Ds\PriorityQueue::__construct - Crée une nouvelle instance - - - - &reftitle.description; - - public Ds\PriorityQueue::__construct - - - - Crée une nouvelle instance. - - - - - - - - &reftitle.examples; - - Exemple de <function>Ds\PriorityQueue::__construct</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/copy.xml b/reference/ds/ds/priorityqueue/copy.xml deleted file mode 100644 index 7d10a10de6..0000000000 --- a/reference/ds/ds/priorityqueue/copy.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\PriorityQueue::copy - Renvoie une copie superficielle de la queue - - - - &reftitle.description; - - public Ds\PriorityQueueDs\PriorityQueue::copy - - - - Renvoie une copie superficielle de la queue. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une copie superficielle de la queue. - - - - - &reftitle.examples; - - Exemple de <function>Ds\PriorityQueue::copy</function> - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -print_r($queue->copy()); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => a -) -]]> - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/count.xml b/reference/ds/ds/priorityqueue/count.xml deleted file mode 100644 index cf8ba79dbb..0000000000 --- a/reference/ds/ds/priorityqueue/count.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - Ds\PriorityQueue::count - Renvoie le nombre de valeurs dans la queue - - - - &reftitle.description; - - Voir Countable::count - - - - - diff --git a/reference/ds/ds/priorityqueue/isempty.xml b/reference/ds/ds/priorityqueue/isempty.xml deleted file mode 100644 index 5469f53086..0000000000 --- a/reference/ds/ds/priorityqueue/isempty.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\PriorityQueue::isEmpty - Renvoie si la queue est vide - - - - &reftitle.description; - - public boolDs\PriorityQueue::isEmpty - - - - Renvoie si la queue est vide. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si la queue est vide, sinon &false;. - - - - - &reftitle.examples; - - Exemple de <function>Ds\PriorityQueue::isEmpty</function> - -push("a", 5); -$a->push("b", 15); -$a->push("c", 10); - -var_dump($a->isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/jsonserialize.xml b/reference/ds/ds/priorityqueue/jsonserialize.xml deleted file mode 100644 index 1d4c2a27c6..0000000000 --- a/reference/ds/ds/priorityqueue/jsonserialize.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - Ds\PriorityQueue::jsonSerialize - Renvoie une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - Voir JsonSerializable::jsonSerialize - - - - Il ne devrait jamais être nécessaire d'appeler cette méthode directement. - - - - - - diff --git a/reference/ds/ds/priorityqueue/peek.xml b/reference/ds/ds/priorityqueue/peek.xml deleted file mode 100644 index cbc05b3957..0000000000 --- a/reference/ds/ds/priorityqueue/peek.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\PriorityQueue::peek - Renvoie la valeur à l'avant de la queue - - - - &reftitle.description; - - public mixedDs\PriorityQueue::peek - - - - Renvoie la valeur à l'avant de la queue, mais ne la supprime pas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la valeur à l'avant de la queue. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\PriorityQueue::peek</function> - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -var_dump($queue->peek()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/pop.xml b/reference/ds/ds/priorityqueue/pop.xml deleted file mode 100644 index 3099252b1a..0000000000 --- a/reference/ds/ds/priorityqueue/pop.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Ds\PriorityQueue::pop - Supprime et renvoie la valeur avec la plus haute priorité - - - - &reftitle.description; - - public mixedDs\PriorityQueue::pop - - - - Supprime et renvoie la valeur à l'avant de la queue, c'est-à-dire la valeur - avec la plus haute priorité. - - - - Les valeurs avec une priorité égale sont traitées en FIFO (premier entré, premier sorti). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La valeur supprimée qui était à l'avant de la queue. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\PriorityQueue::pop</function> - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -print_r($queue->pop()); -print_r($queue->pop()); -print_r($queue->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/push.xml b/reference/ds/ds/priorityqueue/push.xml deleted file mode 100644 index f7adaebf2c..0000000000 --- a/reference/ds/ds/priorityqueue/push.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\PriorityQueue::push - Ajoute des valeurs dans la queue - - - - &reftitle.description; - - public voidDs\PriorityQueue::push - mixedvalue - intpriority - - - Ajoute une value avec une priority donnée dans la queue. - - - - - - &reftitle.parameters; - - - value - - - La valeur à ajouter dans la queue. - - - - - priority - - - La priorité associée à la valeur. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\PriorityQueue::push</function> - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -print_r($queue->pop()); -print_r($queue->pop()); -print_r($queue->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/toarray.xml b/reference/ds/ds/priorityqueue/toarray.xml deleted file mode 100644 index a4dd005be1..0000000000 --- a/reference/ds/ds/priorityqueue/toarray.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\PriorityQueue::toArray - - Convertit la queue en un &array; - - - - - &reftitle.description; - - public arrayDs\PriorityQueue::toArray - - - - Convertit la queue en un &array;. - - - - Cette méthode n'est pas destructive. - - - - - La conversion en un &array; n'est pas encore supportée. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; contenant toutes les valeurs dans le même ordre que la queue. - - - - - &reftitle.examples; - - Exemple de <function>Ds\PriorityQueue::toArray</function> - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -var_dump($queue->toArray()); -?> -]]> - - &example.outputs.similar; - - - string(1) "b" - [1]=> - string(1) "c" - [2]=> - string(1) "a" -} -]]> - - - - - - - - diff --git a/reference/ds/ds/queue/allocate.xml b/reference/ds/ds/queue/allocate.xml deleted file mode 100644 index 01ce2bca90..0000000000 --- a/reference/ds/ds/queue/allocate.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Ds\Queue::allocate - Alloue suffisamment de mémoire pour une capacité requise - - - - &reftitle.description; - - public voidDs\Queue::allocate - intcapacity - - - Assure qu'assez de mémoire est allouée pour une capacité requise. - Cela élimine le besoin de réallouer le tampon interne à mesure que les valeurs sont ajoutées. - - - - La capacité sera toujours arrondie à la puissance de 2 la plus proche. - - - - - - &reftitle.parameters; - - - capacity - - - Le nombre de valeurs pour lesquelles la capacité doit être allouée. - - - - La capacité restera la même si cette valeur est inférieure ou égale à la - capacité actuelle. - - - - - La capacité sera toujours arrondie à la puissance de 2 la plus proche. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Queue::allocate</function> - -capacity()); - -$queue->allocate(100); -var_dump($queue->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/queue/capacity.xml b/reference/ds/ds/queue/capacity.xml deleted file mode 100644 index 76e5f13871..0000000000 --- a/reference/ds/ds/queue/capacity.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Queue::capacity - Renvoie la capacité actuelle - - - - &reftitle.description; - - public intDs\Queue::capacity - - - - Renvoie la capacité actuelle. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacité actuelle. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Queue::capacity</function> - -capacity()); - -$queue->push(...range(1, 50)); -var_dump($queue->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/queue/clear.xml b/reference/ds/ds/queue/clear.xml deleted file mode 100644 index b3543d7d99..0000000000 --- a/reference/ds/ds/queue/clear.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Queue::clear - Supprime toutes les valeurs - - - - &reftitle.description; - - public voidDs\Queue::clear - - - - Supprime toutes les valeurs de la queue. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Queue::clear</function> - -clear(); -print_r($queue); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Queue Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/queue/construct.xml b/reference/ds/ds/queue/construct.xml deleted file mode 100644 index f1174d6e28..0000000000 --- a/reference/ds/ds/queue/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Queue::__construct - Crée une nouvelle instance - - - - &reftitle.description; - - public Ds\Queue::__construct - mixedvalues - - - Crée une nouvelle instance en utilisant soit un objet traversable, - soit un &array; pour les values initiales. - - - - - &reftitle.parameters; - - - values - - - Un objet traversable ou un &array; pour les valeurs initiales. - - - - - - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Queue::__construct</function> - - -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/queue/copy.xml b/reference/ds/ds/queue/copy.xml deleted file mode 100644 index 667c86ce15..0000000000 --- a/reference/ds/ds/queue/copy.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Ds\Queue::copy - Renvoie une copie superficielle de la queue - - - - &reftitle.description; - - public Ds\QueueDs\Queue::copy - - - - Renvoie une copie superficielle de la queue. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une copie superficielle de la queue. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Queue::copy</function> - -copy(); - -// Changer la copie n'affecte pas l'original -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Queue Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/queue/count.xml b/reference/ds/ds/queue/count.xml deleted file mode 100644 index a73b8aa8d5..0000000000 --- a/reference/ds/ds/queue/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Queue::count - Renvoie le nombre de valeurs dans la queue - - - - &reftitle.description; - - Voir Countable::count - - - - - - diff --git a/reference/ds/ds/queue/isempty.xml b/reference/ds/ds/queue/isempty.xml deleted file mode 100644 index d78af2772b..0000000000 --- a/reference/ds/ds/queue/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Queue::isEmpty - Renvoie si la queue est vide - - - - &reftitle.description; - - public boolDs\Queue::isEmpty - - - - Renvoie si la queue est vide. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si la queue est vide, sinon &false;. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Queue::isEmpty</function> - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/queue/jsonserialize.xml b/reference/ds/ds/queue/jsonserialize.xml deleted file mode 100644 index 1693f28ba3..0000000000 --- a/reference/ds/ds/queue/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Queue::jsonSerialize - Renvoie une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - Voir JsonSerializable::jsonSerialize - - - - Il ne devrait jamais être nécessaire d'appeler cette méthode directement. - - - - - - - diff --git a/reference/ds/ds/queue/peek.xml b/reference/ds/ds/queue/peek.xml deleted file mode 100644 index 15761a0285..0000000000 --- a/reference/ds/ds/queue/peek.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Queue::peek - Renvoie la valeur à l'avant de la queue - - - - &reftitle.description; - - public mixedDs\Queue::peek - - - - Renvoie la valeur à l'avant de la queue, mais ne la supprime pas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la valeur à l'avant de la queue. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Queue::peek</function> - -push("a"); -$queue->push("b"); -$queue->push("c"); - -var_dump($queue->peek()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/queue/pop.xml b/reference/ds/ds/queue/pop.xml deleted file mode 100644 index acec4abb28..0000000000 --- a/reference/ds/ds/queue/pop.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Queue::pop - Supprime et renvoie la valeur à l'avant de la queue - - - - &reftitle.description; - - public mixedDs\Queue::pop - - - - Supprime et renvoie la valeur à l'avant de la queue. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La valeur supprimée qui était à l'avant de la queue. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Queue::pop</function> - -push("a"); -$queue->push("b"); -$queue->push("c"); - -var_dump($queue->pop()); -var_dump($queue->pop()); -var_dump($queue->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/queue/push.xml b/reference/ds/ds/queue/push.xml deleted file mode 100644 index 0b97dcd14f..0000000000 --- a/reference/ds/ds/queue/push.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Queue::push - Ajoute des valeurs à la queue - - - - &reftitle.description; - - public voidDs\Queue::push - mixedvalues - - - Ajoute les values à la queue. - - - - - - &reftitle.parameters; - - - values - - - Les valeurs à ajouter à la queue. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Queue::push</function> - -push("a"); -$queue->push("b"); -$queue->push("c", "d"); -$queue->push(...["e", "f"]); - -print_r($queue); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - - diff --git a/reference/ds/ds/queue/toarray.xml b/reference/ds/ds/queue/toarray.xml deleted file mode 100644 index ced3183eda..0000000000 --- a/reference/ds/ds/queue/toarray.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Ds\Queue::toArray - - Convertit la queue en un &array; - - - - - &reftitle.description; - - public arrayDs\Queue::toArray - - - - Convertit la queue en un &array;. - - - - La conversion en un &array; n'est pas encore supportée. - - - - - Cette méthode n'est pas destructive. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; contenant toutes les valeurs dans le même ordre que la queue. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Queue::toArray</function> - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/allocate.xml b/reference/ds/ds/sequence/allocate.xml deleted file mode 100644 index 67a59438d0..0000000000 --- a/reference/ds/ds/sequence/allocate.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Sequence::allocate - Alloue suffisamment de mémoire pour une capacité requise - - - - &reftitle.description; - - abstract public voidDs\Sequence::allocate - intcapacity - - - Assure qu'assez de mémoire est allouée pour une capacité requise. - Cela élimine le besoin de réallouer le tampon interne à mesure que les valeurs sont ajoutées. - - - - - &reftitle.parameters; - - - capacity - - - Le nombre de valeurs pour lesquelles la capacité doit être allouée. - - - - La capacité restera la même si cette valeur est inférieure ou égale à la - capacité actuelle. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::allocate</function> - -capacity()); - -$vector->allocate(100); -var_dump($sequence->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/apply.xml b/reference/ds/ds/sequence/apply.xml deleted file mode 100644 index b6daee55fd..0000000000 --- a/reference/ds/ds/sequence/apply.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Ds\Sequence::apply - Met à jour toutes les valeurs en appliquant une fonction de rappel à chaque valeur - - - - &reftitle.description; - - abstract public voidDs\Sequence::apply - callablecallback - - - Met à jour toutes les valeurs en appliquant une callback à - chaque valeur dans la séquence. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - Un callable à appliquer à chaque valeur de la séquence. - - - - La fonction de rappel doit retourner la valeur par laquelle elle doit être remplacée. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::apply</function> - -apply(function($value) { return $value * 2; }); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/capacity.xml b/reference/ds/ds/sequence/capacity.xml deleted file mode 100644 index 951b7de853..0000000000 --- a/reference/ds/ds/sequence/capacity.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Sequence::capacity - Renvoie la capacité actuelle - - - - &reftitle.description; - - abstract public intDs\Sequence::capacity - - - - Renvoie la capacité actuelle. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacité actuelle. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::capacity</function> - -capacity()); - -$sequence->push(...range(1, 50)); -var_dump($sequence->capacity()); - -$sequence[] = "a"; -var_dump($sequence->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/contains.xml b/reference/ds/ds/sequence/contains.xml deleted file mode 100644 index cb5c7eb612..0000000000 --- a/reference/ds/ds/sequence/contains.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Sequence::contains - Détermine si la séquence contient des valeurs données - - - - &reftitle.description; - - abstract public boolDs\Sequence::contains - mixedvalues - - - Détermine si la séquence contient toutes les valeurs. - - - - - &reftitle.parameters; - - - values - - - Les valeurs à vérifier. - - - - - - - - &reftitle.returnvalues; - - &false; si l'une des values fournies n'est pas dans la - séquence, &true; sinon. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::contains</function> - -contains('a')); // true -var_dump($sequence->contains('a', 'b')); // true -var_dump($sequence->contains('c', 'd')); // false - -var_dump($sequence->contains(...['c', 'b', 'a'])); // true - -// Toujours strict -var_dump($sequence->contains(1)); // true -var_dump($sequence->contains('1')); // false - -var_dump($sequence->contains(...[])); // true -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/filter.xml b/reference/ds/ds/sequence/filter.xml deleted file mode 100644 index 038f11046e..0000000000 --- a/reference/ds/ds/sequence/filter.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - Ds\Sequence::filter - - Créer une nouvelle séquence en utilisant un callable pour - déterminer quelles valeurs inclure - - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::filter - callablecallback - - - Crée une nouvelle séquence en utilisant un callable pour - déterminer quelles valeurs inclure. - - - - - &reftitle.parameters; - - - - callback - - - - - bool - callback - mixedvalue - - - - Un callable optionnel qui retourne &true; si la valeur doit être incluse, &false; sinon. - - - Si aucune fonction de rappel n'est fournie, seules les valeurs qui sont &true; - (voir conversion en booléen) - seront incluses. - - - - - - - - - &reftitle.returnvalues; - - Une nouvelle séquence contenant toutes les valeurs pour lesquelles - soit le callback a retourné &true;, soit toutes les valeurs qui - se convertissent en &true; si un callback n'a pas été fourni. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::filter</function> utilisant une fonction de rappel - -filter(function($value) { - return $value % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) -} -]]> - - - - Exemple de <function>Ds\Sequence::filter</function> sans fonction de rappel - -filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/find.xml b/reference/ds/ds/sequence/find.xml deleted file mode 100644 index 64e979f62a..0000000000 --- a/reference/ds/ds/sequence/find.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Sequence::find - - Essaye de trouver l'index d'une valeur - - - - - &reftitle.description; - - abstract public mixedDs\Sequence::find - mixedvalue - - - Renvoie l'index de la value, ou &false; si non trouvée. - - - - - - &reftitle.parameters; - - - value - - - La valeur à trouver. - - - - - - - - &reftitle.returnvalues; - - L'index de la valeur, ou &false; si non trouvée. - - - - Les valeurs seront comparées par valeur et par type. - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::find</function> - -find("a")); // 0 -var_dump($sequence->find("b")); // false -var_dump($sequence->find("1")); // false -var_dump($sequence->find(1)); // 1 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/first.xml b/reference/ds/ds/sequence/first.xml deleted file mode 100644 index 87ecc0b3f5..0000000000 --- a/reference/ds/ds/sequence/first.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Sequence::first - Renvoie la première valeur de la séquence - - - - &reftitle.description; - - abstract public mixedDs\Sequence::first - - - - Renvoie la première valeur de la séquence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la première valeur de la séquence. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::first</function> - -first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/get.xml b/reference/ds/ds/sequence/get.xml deleted file mode 100644 index 7e1beee61c..0000000000 --- a/reference/ds/ds/sequence/get.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Ds\Sequence::get - Renvoie la valeur à un index donné - - - - &reftitle.description; - - abstract public mixedDs\Sequence::get - intindex - - - Renvoie la valeur à un index donné. - - - - - - &reftitle.parameters; - - - index - - - L'index à accéder, en commençant à 0. - - - - - - - - &reftitle.returnvalues; - - La valeur à l'index demandé. - - - - - &reftitle.errors; - - OutOfRangeException si l'index n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::get</function> - -get(0)); -var_dump($sequence->get(1)); -var_dump($sequence->get(2)); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Sequence::get</function> en utilisant la syntaxe de tableau - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/insert.xml b/reference/ds/ds/sequence/insert.xml deleted file mode 100644 index 423bd6b1dc..0000000000 --- a/reference/ds/ds/sequence/insert.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Ds\Sequence::insert - Insère des valeurs à un index donné - - - - &reftitle.description; - - abstract public voidDs\Sequence::insert - intindex - mixedvalues - - - Insère des valeurs dans la séquence à un index donné. - - - - - - &reftitle.parameters; - - - index - - - L'index auquel insérer. 0 <= index <= count - - - - Il est possible d'insérer à l'index égal au nombre de valeurs. - - - - - - values - - - La ou les valeurs à insérer. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException si l'index n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::insert</function> - -insert(0, "e"); // [e] -$sequence->insert(1, "f"); // [e, f] -$sequence->insert(2, "g"); // [e, f, g] -$sequence->insert(0, "a", "b"); // [a, b, e, f, g] -$sequence->insert(2, ...["c", "d"]); // [a, b, c, d, e, f, g] - -var_dump($sequence); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - [1]=> - string(1) "b" - [2]=> - string(1) "c" - [3]=> - string(1) "d" - [4]=> - string(1) "e" - [5]=> - string(1) "f" - [6]=> - string(1) "g" -} -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/join.xml b/reference/ds/ds/sequence/join.xml deleted file mode 100644 index a00aa9bc33..0000000000 --- a/reference/ds/ds/sequence/join.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Sequence::join - Rassemble toutes les valeurs en une chaîne - - - - &reftitle.description; - - abstract public stringDs\Sequence::join - stringglue - - - Rassemble toutes les valeurs en une chaîne en utilisant un séparateur optionnel entre chaque valeur. - - - - - &reftitle.parameters; - - - glue - - - Une chaîne optionnelle pour séparer chaque valeur. - - - - - - - - &reftitle.returnvalues; - - Toutes les valeurs de la séquence rassemblées en une chaîne. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::join</function> avec une chaîne séparatrice - -join("|")); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Sequence::join</function> sans chaîne séparatrice - -join()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/last.xml b/reference/ds/ds/sequence/last.xml deleted file mode 100644 index b0380f2fa2..0000000000 --- a/reference/ds/ds/sequence/last.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Sequence::last - Renvoie la dernière valeur - - - - &reftitle.description; - - abstract public mixedDs\Sequence::last - - - - Renvoie la dernière valeur de la séquence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La dernière valeur de la séquence. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::last</function> - -last()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/map.xml b/reference/ds/ds/sequence/map.xml deleted file mode 100644 index 4123f7b2cc..0000000000 --- a/reference/ds/ds/sequence/map.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Ds\Sequence::map - Renvoie le résultat de l'application d'une fonction de rappel à chaque valeur - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::map - callablecallback - - - Renvoie le résultat de l'application de callback à - chaque valeur de la séquence. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - Un callable à appliquer à chaque valeur de la séquence. - - - - La fonction de rappel doit prendre un argument et retourner la nouvelle valeur. - - - - - - - - - &reftitle.returnvalues; - - Le résultat de l'application de callback à chaque valeur - de la séquence. - - - - Les valeurs de l'instance actuelle ne seront pas affectées. - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::map</function> - -map(function($value) { return $value * 2; })); -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -Ds\Vector Object -( - [0] => 1 - [1] => 2 - [2] => 3 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/merge.xml b/reference/ds/ds/sequence/merge.xml deleted file mode 100644 index ccc285a5a7..0000000000 --- a/reference/ds/ds/sequence/merge.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Ds\Sequence::merge - Renvoie le résultat de l'ajout de toutes les valeurs de la séquence - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::merge - mixedvalues - - - Renvoie le résultat de l'ajout de toutes les valeurs de la séquence. - - - - - - &reftitle.parameters; - - - values - - - Un objet traversable ou un &array;. - - - - - - - - &reftitle.returnvalues; - - Le résultat de l'ajout de toutes les valeurs données à la séquence, - effectivement le même que d'ajouter les valeurs à une copie, puis de renvoyer cette copie. - - - - L'instance actuelle ne sera pas affectée. - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::merge</function> - -merge([4, 5, 6])); -var_dump($sequence); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) - [5]=> - int(6) -} -object(Ds\Vector)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/pop.xml b/reference/ds/ds/sequence/pop.xml deleted file mode 100644 index 800c8af615..0000000000 --- a/reference/ds/ds/sequence/pop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Sequence::pop - Supprime et renvoie la dernière valeur - - - - &reftitle.description; - - abstract public mixedDs\Sequence::pop - - - - Supprime et renvoie la dernière valeur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La dernière valeur supprimée. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::pop</function> - -pop()); -var_dump($sequence->pop()); -var_dump($sequence->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/push.xml b/reference/ds/ds/sequence/push.xml deleted file mode 100644 index e7373d0fad..0000000000 --- a/reference/ds/ds/sequence/push.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Sequence::push - Ajoute des valeurs à la fin de la séquence - - - - &reftitle.description; - - abstract public voidDs\Sequence::push - mixedvalues - - - Ajoute des valeurs à la fin de la séquence. - - - - - - &reftitle.parameters; - - - values - - - Les valeurs à ajouter. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::push</function> - -push("a"); -$sequence->push("b"); -$sequence->push("c", "d"); -$sequence->push(...["e", "f"]); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/reduce.xml b/reference/ds/ds/sequence/reduce.xml deleted file mode 100644 index 0687a35960..0000000000 --- a/reference/ds/ds/sequence/reduce.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - Ds\Sequence::reduce - Réduit la séquence à une seule valeur en utilisant une fonction de rappel - - - - &reftitle.description; - - abstract public mixedDs\Sequence::reduce - callablecallback - mixedinitial - - - Réduit la séquence à une seule valeur en utilisant une fonction de rappel. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedvalue - - - - carry - - - La valeur de retour du rappel précédent, ou initial si - c'est la première itération. - - - - - value - - - La valeur de l'itération actuelle. - - - - - - - - - initial - - - La valeur initiale de la valeur de retour. Peut être &null;. - - - - - - - - &reftitle.returnvalues; - - La valeur de retour du rappel final. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::reduce</function> avec une valeur initiale - -reduce($callback, 5)); - -// Itérations : -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Sequence::reduce</function> sans valeur initiale - -reduce(function($carry, $value) { - return $carry + $value + 5; -})); - -// Itérations: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/remove.xml b/reference/ds/ds/sequence/remove.xml deleted file mode 100644 index c6cc8182e9..0000000000 --- a/reference/ds/ds/sequence/remove.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Ds\Sequence::remove - Supprime et renvoie une valeur par index - - - - &reftitle.description; - - abstract public mixedDs\Sequence::remove - intindex - - - Supprime et renvoie une valeur par index. - - - - - - &reftitle.parameters; - - - index - - - L'index de la valeur à supprimer. - - - - - - - - &reftitle.returnvalues; - - La valeur qui a été supprimée. - - - - - &reftitle.errors; - - OutOfRangeException si l'index n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::remove</function> - -remove(1)); -var_dump($sequence->remove(0)); -var_dump($sequence->remove(0)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/reverse.xml b/reference/ds/ds/sequence/reverse.xml deleted file mode 100644 index 9e1237bf62..0000000000 --- a/reference/ds/ds/sequence/reverse.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Sequence::reverse - - Renverse la séquence en place - - - - - &reftitle.description; - - abstract public voidDs\Sequence::reverse - - - - Renverse la séquence en place. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::reverse</function> - -reverse(); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/reversed.xml b/reference/ds/ds/sequence/reversed.xml deleted file mode 100644 index c4245fbeae..0000000000 --- a/reference/ds/ds/sequence/reversed.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Sequence::reversed - Renvoie une copie renversée - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::reversed - - - - Renvoie une copie renversée de la séquence. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une copie renversée de la séquence. - - - - L'instance actuelle n'est pas affectée. - - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::reversed</function> - -reversed()); -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -Ds\Vector Object -( - [0] => a - [1] => b - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/rotate.xml b/reference/ds/ds/sequence/rotate.xml deleted file mode 100644 index fe56035d23..0000000000 --- a/reference/ds/ds/sequence/rotate.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Sequence::rotate - Tourne la séquence d'un nombre donné de rotations - - - - &reftitle.description; - - abstract public voidDs\Sequence::rotate - introtations - - - Tourne la séquence d'un certain nombre de rotations, ce qui équivaut à appeler successivement - $sequence->push($sequence->shift()) si le nombre de rotations est positif, ou - $sequence->unshift($sequence->pop()) si négatif. - - - - - - &reftitle.parameters; - - - rotations - - - Le nombre de fois que la séquence doit être tournée. - - - - - - - - &reftitle.returnvalues; - - &return.void;. La séquence de l'instance actuelle sera tournée. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::rotate</function> - -rotate(1); // "a" est décalé, puis poussé. -print_r($sequence); - -$sequence->rotate(2); // "b" et "c" sont tous deux décalés, puis poussés. -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => d - [3] => a -) -Ds\Vector Object -( - [0] => d - [1] => a - [2] => b - [3] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/set.xml b/reference/ds/ds/sequence/set.xml deleted file mode 100644 index da63942c26..0000000000 --- a/reference/ds/ds/sequence/set.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - Ds\Sequence::set - Met à jour une valeur à un index donné - - - - &reftitle.description; - - abstract public voidDs\Sequence::set - intindex - mixedvalue - - - Met à jour une valeur à un index donné. - - - - - - &reftitle.parameters; - - - index - - - L'index de la valeur à mettre à jour. - - - - - value - - - La nouvelle valeur. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException si l'index n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::set</function> - -set(1, "_"); -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - Exemple de <function>Ds\Sequence::set</function> utilisant la syntaxe de tableau - - -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/shift.xml b/reference/ds/ds/sequence/shift.xml deleted file mode 100644 index 3191093ed7..0000000000 --- a/reference/ds/ds/sequence/shift.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Sequence::shift - Supprime et renvoie la première valeur - - - - &reftitle.description; - - abstract public mixedDs\Sequence::shift - - - - Supprime et renvoie la première valeur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La première valeur, qui a été supprimée. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::shift</function> - -shift()); -var_dump($sequence->shift()); -var_dump($sequence->shift()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/slice.xml b/reference/ds/ds/sequence/slice.xml deleted file mode 100644 index 9da3a882a9..0000000000 --- a/reference/ds/ds/sequence/slice.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - Ds\Sequence::slice - - Renvoie une sous-séquence d'une plage donnée - - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::slice - intindex - intlength - - - Crée une sous-séquence d'une plage donnée. - - - - - - &reftitle.parameters; - - - index - - - L'index auquel commence la sous-séquence. - - - Si positif, la sous-séquence commencera à cet index dans la séquence. - Si négatif, la sous-séquence commencera à cette distance de la fin. - - - - - length - - - Si une longueur est donnée et est positive, la sous-séquence résultante - aura jusqu'à autant de valeurs. - - Si la longueur entraîne un dépassement, seules - les valeurs jusqu'à la fin de la séquence seront incluses. - - Si une longueur est donnée et est négative, la sous-séquence - s'arrêtera à autant de valeurs de la fin. - - Si une longueur n'est pas fournie, la sous-séquence - contiendra toutes les valeurs entre l'index et la - fin de la séquence. - - - - - - - - &reftitle.returnvalues; - - Une sous-séquence de la plage donnée. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::slice</function> - -slice(2)); - -// Découpe à partir de 1, pour une longueur de 3 -print_r($sequence->slice(1, 3)); - -// Découpe à partir de 1 en avant -print_r($sequence->slice(1)); - -// Découpe à partir de 2 en arrière -print_r($sequence->slice(-2)); - -// Découpe de 1 à 1 de la fin -print_r($sequence->slice(1, -1)); -?> -]]> - - &example.outputs.similar; - - c - [1] => d - [2] => e -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d - [3] => e -) -Ds\Vector Object -( - [0] => d - [1] => e -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d -) - -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/sort.xml b/reference/ds/ds/sequence/sort.xml deleted file mode 100644 index ecb43918f9..0000000000 --- a/reference/ds/ds/sequence/sort.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Ds\Sequence::sort - - Trie la séquence en place - - - - - &reftitle.description; - - abstract public voidDs\Sequence::sort - callablecomparator - - - Trie la séquence en place, en utilisant une fonction de comparaison optionnelle comparator. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::sort</function> - -sort(); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Exemple de <function>Ds\Sequence::sort</function> utilisant un comparateur - -sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/sequence/sorted.xml b/reference/ds/ds/sequence/sorted.xml deleted file mode 100644 index 3c5d77ec98..0000000000 --- a/reference/ds/ds/sequence/sorted.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Ds\Sequence::sorted - Renvoie une copie triée - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::sorted - callablecomparator - - - Renvoie une copie triée de la séquence, en utilisant une fonction de comparaison optionnelle comparator. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Renvoie une copie triée de la séquence. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::sorted</function> - -sorted()); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Exemple de <function>Ds\Sequence::sorted</function> utilisant un comparateur - -sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/sequence/sum.xml b/reference/ds/ds/sequence/sum.xml deleted file mode 100644 index 0afcc8dc07..0000000000 --- a/reference/ds/ds/sequence/sum.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Sequence::sum - Renvoie la somme de toutes les valeurs de la séquence - - - - &reftitle.description; - - abstract public intfloatDs\Sequence::sum - - - - Renvoie la somme de toutes les valeurs de la séquence. - - - - Les tableaux et les objets sont considérés comme égaux à zéro lors du calcul de la somme. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La somme de toutes les valeurs de la séquence en tant que float ou int - en fonction des valeurs de la séquence. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::sum</function> avec un entier - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Sequence::sum</function> avec un nombre à virgule flottante - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/unshift.xml b/reference/ds/ds/sequence/unshift.xml deleted file mode 100644 index 905749fdde..0000000000 --- a/reference/ds/ds/sequence/unshift.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Sequence::unshift - Ajoute des valeurs au début de la séquence - - - - &reftitle.description; - - abstract public voidDs\Sequence::unshift - mixedvalues - - - Ajoute des valeurs au début de la séquence, déplaçant toutes les valeurs actuelles - vers l'avant pour faire de la place pour les nouvelles valeurs. - - - - - - &reftitle.parameters; - - - values - - - Les valeurs à ajouter au début de la séquence. - - - Plusieurs valeurs seront ajoutées dans le même ordre qu'elles sont - passées. - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Sequence::unshift</function> - -unshift("a"); -$sequence->unshift("b", "c"); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => a - [3] => 1 - [4] => 2 - [5] => 3 -) -]]> - - - - - - - diff --git a/reference/ds/ds/set/add.xml b/reference/ds/ds/set/add.xml deleted file mode 100644 index 23f76229d6..0000000000 --- a/reference/ds/ds/set/add.xml +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - Ds\Set::add - Ajoute des valeurs à l'ensemble - - - - &reftitle.description; - - public voidDs\Set::add - mixedvalues - - - Ajoute toutes les valeurs données à l'ensemble qui n'ont pas déjà été ajoutées. - - - - Les valeurs de type object sont supportées. - - Si un objet implémente Ds\Hashable, - l'égalité sera déterminée par la fonction equals de l'objet. - - Si un objet n'implémente pas Ds\Hashable, - les objets doivent être des références à la même instance pour être considérés comme égaux. - - - - - Toutes les comparaisons sont strictes (type et valeur). - - - - - - &reftitle.parameters; - - - values - - - Les valeurs à ajouter à l'ensemble. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::add</function> utilisant les entiers - -add(1); -$set->add(1); -$set->add(2); -$set->add(3); - -// Les comparaisons strictes ne traiteraient pas ces valeurs de la même manière que int(1) -$set->add("1"); -$set->add(true); - -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - string(1) "1" - [4]=> - bool(true) -} -]]> - - - - Exemple de <function>Ds\Set::add</function> utilisant les objets - -value = $value; - } - - public function hash() - { - return $this->value; - } - - public function equals($obj): bool - { - return $this->value === $obj->value; - } -} - -$set = new \Ds\Set(); - -$obj = new \ArrayIterator([]); - -// Ajouter la même instance plusieurs fois n'ajoutera que la première. -$set->add($obj); -$set->add($obj); - -// Ajouter plusieurs instances du même objet ajoutera toutes les instances. -$set->add(new \stdClass()); -$set->add(new \stdClass()); - -// Ajouter plusieurs instances d'objets hachables égaux n'ajoutera que la première. -$set->add(new \HashableObject(1)); -$set->add(new \HashableObject(1)); -$set->add(new \HashableObject(2)); -$set->add(new \HashableObject(2)); - -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - object(ArrayIterator)#2 (1) { - ["storage":"ArrayIterator":private]=> - array(0) { - } - } - [1]=> - object(stdClass)#3 (0) { - } - [2]=> - object(stdClass)#4 (0) { - } - [3]=> - object(HashableObject)#5 (1) { - ["value":"HashableObject":private]=> - int(1) - } - [4]=> - object(HashableObject)#6 (1) { - ["value":"HashableObject":private]=> - int(2) - } -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/allocate.xml b/reference/ds/ds/set/allocate.xml deleted file mode 100644 index c55f2ac760..0000000000 --- a/reference/ds/ds/set/allocate.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Set::allocate - Alloue suffisamment de mémoire pour une capacité requise - - - - &reftitle.description; - - public voidDs\Set::allocate - intcapacity - - - Alloue suffisamment de mémoire pour une capacité requise. - - - - - - &reftitle.parameters; - - - capacity - - - Le nombre de valeurs pour lesquelles la capacité doit être allouée. - - - - La capacité restera la même si cette valeur est inférieure ou égale à la - capacité actuelle. - - - - - La capacité sera toujours arrondie à la puissance de 2 la plus proche. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::allocate</function> - -capacity()); - -$set->allocate(100); -var_dump($set->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/capacity.xml b/reference/ds/ds/set/capacity.xml deleted file mode 100644 index 7812b07d17..0000000000 --- a/reference/ds/ds/set/capacity.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Set::capacity - Renvoie la capacité actuelle - - - - &reftitle.description; - - public intDs\Set::capacity - - - - Renvoie la capacité actuelle. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacité actuelle. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::capacity</function> - -capacity()); - -$set->add(...range(1, 50)); -var_dump($set->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/clear.xml b/reference/ds/ds/set/clear.xml deleted file mode 100644 index 5f2ee42057..0000000000 --- a/reference/ds/ds/set/clear.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Set::clear - Supprime toutes les valeurs - - - - &reftitle.description; - - public voidDs\Set::clear - - - - Supprime toutes les valeurs de l'ensemble. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::clear</function> - -clear(); -print_r($set); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Set Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/set/construct.xml b/reference/ds/ds/set/construct.xml deleted file mode 100644 index edd200852a..0000000000 --- a/reference/ds/ds/set/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Set::__construct - Crée une nouvelle instance - - - - &reftitle.description; - - public Ds\Set::__construct - mixedvalues[] - - - Crée une nouvelle instance, en utilisant soit un objet traversable, - soit un &array; pour les values initiales. - - - - - - &reftitle.parameters; - - - values - - - Un objet traversable ou un &array; à utiliser pour les valeurs initiales. - - - - - - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::__construct</function> - - -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/contains.xml b/reference/ds/ds/set/contains.xml deleted file mode 100644 index b75b2e8cda..0000000000 --- a/reference/ds/ds/set/contains.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Ds\Set::contains - Détermine si l'ensemble contient toutes les valeurs - - - - &reftitle.description; - - public boolDs\Set::contains - mixedvalues - - - Détermine si l'ensemble contient toutes les valeurs. - - - - - Les valeurs de type object sont supportées. - - Si un objet implémente Ds\Hashable, - l'égalité sera déterminée par la fonction equals de l'objet. - - Si un objet n'implémente pas Ds\Hashable, - les objets doivent être des références à la même instance pour être considérés comme égaux. - - - - - Toutes les comparaisons sont strictes (type et valeur). - - - - - - - &reftitle.parameters; - - - values - - - Les valeurs à vérifier. - - - - - - - - &reftitle.returnvalues; - - &false; si l'une des values fournies n'est pas dans - l'ensemble, sinon &true;. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::contains</function> - -contains(1)); // true -var_dump($set->contains(1, 2)); // true -var_dump($set->contains(...[1, 2])); // true - -var_dump($set->contains("1")); // false -var_dump($set->contains(...[1, 2, 3, 4])); // false - -var_dump($set->contains(...[])); // true -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/copy.xml b/reference/ds/ds/set/copy.xml deleted file mode 100644 index 6942946d29..0000000000 --- a/reference/ds/ds/set/copy.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Ds\Set::copy - Renvoie une copie superficielle de l'ensemble - - - - &reftitle.description; - - public Ds\SetDs\Set::copy - - - - Renvoie une copie superficielle de l'ensemble. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une copie superficielle de l'ensemble. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::copy</function> - -copy(); - -// Changer la copie n'affecte pas l'original -$b->add(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Set Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/set/count.xml b/reference/ds/ds/set/count.xml deleted file mode 100644 index 882bd1597f..0000000000 --- a/reference/ds/ds/set/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Set::count - Renvoie le nombre de valeurs dans l'ensemble - - - - &reftitle.description; - - Voir Countable::count - - - - - - diff --git a/reference/ds/ds/set/diff.xml b/reference/ds/ds/set/diff.xml deleted file mode 100644 index 6dafc6749a..0000000000 --- a/reference/ds/ds/set/diff.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Set::diff - Crée un nouvel ensemble en utilisant des valeurs qui ne sont pas dans un autre ensemble - - - - &reftitle.description; - - public Ds\SetDs\Set::diff - Ds\Setset - - - Crée un nouvel ensemble utilisant des valeurs qui ne sont pas dans un autre ensemble. - - - A \ B = {x ∈ A | x ∉ B} - - - - - &reftitle.parameters; - - - set - - - L'ensemble contenant les valeurs à exclure. - - - - - - - - &reftitle.returnvalues; - - Un nouvel ensemble contenant toutes les valeurs qui n'étaient pas dans l'autre set. - - - - - &reftitle.seealso; - - - Complément sur Wikipedia - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::diff</function> - -diff($b)); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/filter.xml b/reference/ds/ds/set/filter.xml deleted file mode 100644 index 78f099e62c..0000000000 --- a/reference/ds/ds/set/filter.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - Ds\Set::filter - - Créer un nouvel ensemble en utilisant un callable - pour déterminer quelles valeurs inclure - - - - - &reftitle.description; - - public Ds\SetDs\Set::filter - callablecallback - - - Crée un nouvel ensemble en utilisant un callable pour - déterminer quelles valeurs inclure. - - - - - - &reftitle.parameters; - - - callback - - - - bool - callback - mixedvalue - - - - Un callable optionnel qui retourne &true; si la valeur doit être incluse, &false; sinon. - - - Si aucune fonction de rappel n'est fournie, seules les valeurs qui sont &true; - (voir conversion en booléen) - seront incluses. - - - - - - - - &reftitle.returnvalues; - - Un nouvel ensemble contenant toutes les valeurs pour lesquelles - soit le callback a retourné &true;, soit toutes les valeurs qui - se convertissent en &true; si un callback n'a pas été fourni. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::filter</function> utilisant une fonction de rappel - -filter(function($value) { - return $value % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) -} -]]> - - - - Exemple de <function>Ds\Set::filter</function> sans fonction de rappel - -filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/first.xml b/reference/ds/ds/set/first.xml deleted file mode 100644 index 403d415c95..0000000000 --- a/reference/ds/ds/set/first.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Set::first - Renvoie la première valeur de l'ensemble - - - - &reftitle.description; - - public mixedDs\Set::first - - - - Renvoie la première valeur de l'ensemble. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La première valeur de l'ensemble. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::first</function> - -first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/get.xml b/reference/ds/ds/set/get.xml deleted file mode 100644 index 8d61bdd145..0000000000 --- a/reference/ds/ds/set/get.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Ds\Set::get - Renvoie la valeur à un index donné - - - - &reftitle.description; - - public mixedDs\Set::get - intindex - - - Renvoie la valeur à un index donné. - - - - - - &reftitle.parameters; - - - index - - - L'index à accéder, en commençant à 0. - - - - - - - - &reftitle.returnvalues; - - La valeur à l'index demandé. - - - - - &reftitle.errors; - - OutOfRangeException si l'index est invalide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::get</function> - -get(0)); -var_dump($set->get(1)); -var_dump($set->get(2)); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Set::get</function> utilisant la syntaxe de tableau - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/intersect.xml b/reference/ds/ds/set/intersect.xml deleted file mode 100644 index 3588cc0f80..0000000000 --- a/reference/ds/ds/set/intersect.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Set::intersect - Crée un nouvel ensemble en utilisant des valeurs communes avec un autre ensemble - - - - &reftitle.description; - - public Ds\SetDs\Set::intersect - Ds\Setset - - - Crée un nouvel ensemble en utilisant des valeurs communes avec un autre set. - - En d'autres termes, renvoie une copie de l'instance actuelle avec toutes les valeurs supprimées - qui ne sont pas dans l'autre set. - - - A ∩ B = {x : x ∈ A ∧ x ∈ B} - - - - - &reftitle.parameters; - - - set - - - L'autre ensemble. - - - - - - - - &reftitle.returnvalues; - - L'intersection de l'instance actuelle et d'un autre set. - - - - - &reftitle.seealso; - - - Intersection sur Wikipedia - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::intersect</function> - -intersect($b)); -?> -]]> - - &example.outputs.similar; - - - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/isempty.xml b/reference/ds/ds/set/isempty.xml deleted file mode 100644 index 556421ea7a..0000000000 --- a/reference/ds/ds/set/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Set::isEmpty - Renvoie si l'ensemble est vide - - - - &reftitle.description; - - public boolDs\Set::isEmpty - - - - Renvoie si l'ensemble est vide. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si l'ensemble est vide, sinon &false;. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::isEmpty</function> - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/join.xml b/reference/ds/ds/set/join.xml deleted file mode 100644 index a34e988f9e..0000000000 --- a/reference/ds/ds/set/join.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Set::join - Rassemble toutes les valeurs en une chaîne - - - - &reftitle.description; - - public stringDs\Set::join - stringglue - - - Rassemble toutes les valeurs en une chaîne en utilisant un séparateur optionnel entre chaque valeur. - - - - - &reftitle.parameters; - - - glue - - - Une chaîne optionnelle pour séparer chaque valeur. - - - - - - - - &reftitle.returnvalues; - - Toutes les valeurs de l'ensemble rassemblées en une chaîne. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::join</function> avec une chaîne séparatrice - -join("|")); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Set::join</function> sans une chaîne séparatrice - -join()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/jsonserialize.xml b/reference/ds/ds/set/jsonserialize.xml deleted file mode 100644 index 2fb2549388..0000000000 --- a/reference/ds/ds/set/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Set::jsonSerialize - Renvoie une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - Voir JsonSerializable::jsonSerialize - - - - Il ne devrait jamais être nécessaire d'appeler cette méthode directement. - - - - - - - diff --git a/reference/ds/ds/set/last.xml b/reference/ds/ds/set/last.xml deleted file mode 100644 index fc6ba6f5f6..0000000000 --- a/reference/ds/ds/set/last.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Set::last - Renvoie la dernière valeur de l'ensemble - - - - &reftitle.description; - - public mixedDs\Set::last - - - - Renvoie la dernière valeur de l'ensemble. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La dernière valeur de l'ensemble. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::last</function> - -last()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/map.xml b/reference/ds/ds/set/map.xml deleted file mode 100644 index 4c546058e7..0000000000 --- a/reference/ds/ds/set/map.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Ds\Set::map - Renvoie le résultat de l'application d'une fonction de rappel à chaque valeur - - - - &reftitle.description; - - public Ds\SetDs\Set::map - callablecallback - - - Renvoie le résultat de l'application d'une fonction de rappel callback à - chaque valeur de l'ensemble. - - - - - &reftitle.parameters; - - - callback - - - La fonction de rappel à appliquer à chaque valeur de l'ensemble doit avoir la signature suivante: - - mixed - callback - mixedvalue - - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouvel objet Ds\Set où chaque valeur - est le résultat de l'application de la fonction de rappel callback à chaque valeur - de l'ensemble. - - - - - &reftitle.examples; - - Exemple de <methodname>Ds\Set::map</methodname> - -map(function($value) { return $value * 2; })); -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) - [2]=> - int(6) -} -object(Ds\Set)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - diff --git a/reference/ds/ds/set/merge.xml b/reference/ds/ds/set/merge.xml deleted file mode 100644 index d49f2969a9..0000000000 --- a/reference/ds/ds/set/merge.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Ds\Set::merge - Renvoie le résultat de l'ajout de toutes les valeurs données à l'ensemble - - - - &reftitle.description; - - public Ds\SetDs\Set::merge - mixedvalues - - - Renvoie le résultat de l'ajout de toutes les valeurs données à l'ensemble. - - - - - - &reftitle.parameters; - - - values - - - Un objet traversable ou un &array;. - - - - - - - - &reftitle.returnvalues; - - Le résultat de l'ajout de toutes les valeurs données à l'ensemble, - effectivement le même que d'ajouter les valeurs à une copie, puis de renvoyer cette copie. - - - - L'instance actuelle ne sera pas affectée. - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::merge</function> - -merge([3, 4, 5])); -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) -} -object(Ds\Set)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/reduce.xml b/reference/ds/ds/set/reduce.xml deleted file mode 100644 index cb42489e52..0000000000 --- a/reference/ds/ds/set/reduce.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - Ds\Set::reduce - Réduit l'ensemble à une seule valeur en utilisant une fonction de rappel - - - - &reftitle.description; - - public mixedDs\Set::reduce - callablecallback - mixedinitial - - - Réduit l'ensemble à une seule valeur en utilisant une fonction de rappel. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedvalue - - - - carry - - - La valeur de retour du rappel précédent, ou initial si - c'est la première itération. - - - - - value - - - La valeur de l'itération actuelle. - - - - - - - - - initial - - - La valeur initiale de la valeur de retour. Peut être &null;. - - - - - - - - &reftitle.returnvalues; - - La valeur de retour du rappel final. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::reduce</function> avec valeur initiale - -reduce($callback, 5)); - -// Itérations: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Set::reduce</function> sans valeur initiale - -reduce(function($carry, $value) { - return $carry + $value + 5; -})); - -// Itérations: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/remove.xml b/reference/ds/ds/set/remove.xml deleted file mode 100644 index 768b5d351c..0000000000 --- a/reference/ds/ds/set/remove.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Ds\Set::remove - Supprime toutes les valeurs données de l'ensemble - - - - &reftitle.description; - - public voidDs\Set::remove - mixedvalues - - - Supprime toutes les values données de l'ensemble, en ignorant celles qui ne sont pas dans l'ensemble. - - - - - - &reftitle.parameters; - - - values - - - Les valeurs à supprimer. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::remove</function> - -remove(1); // Supprime 1 -$set->remove(1, 2); // Ne trouve pas 1, mais supprime 2 -$set->remove(...[3, 4]); // Supprime 3 et 4 - -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - int(5) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/reverse.xml b/reference/ds/ds/set/reverse.xml deleted file mode 100644 index 8fa8113f8b..0000000000 --- a/reference/ds/ds/set/reverse.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Ds\Set::reverse - - Renverse l'ensemble en place - - - - - &reftitle.description; - - public voidDs\Set::reverse - - - - Renverse l'ensemble en place. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::reverse</function> - -reverse(); - -print_r($set); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -]]> - - - - - - - - diff --git a/reference/ds/ds/set/reversed.xml b/reference/ds/ds/set/reversed.xml deleted file mode 100644 index 5476e6e76d..0000000000 --- a/reference/ds/ds/set/reversed.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Set::reversed - Renvoie une copie renversée - - - - &reftitle.description; - - public Ds\SetDs\Set::reversed - - - - Renvoie une copie renversée de l'ensemble. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une copie renversée de l'ensemble. - - - - L'instance actuelle n'est pas affectée. - - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::reversed</function> - -reversed()); -print_r($set); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -Ds\Set Object -( - [0] => a - [1] => b - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/set/slice.xml b/reference/ds/ds/set/slice.xml deleted file mode 100644 index 597069852b..0000000000 --- a/reference/ds/ds/set/slice.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - Ds\Set::slice - - Renvoie un sous-ensemble d'une plage donnée - - - - - &reftitle.description; - - public Ds\SetDs\Set::slice - intindex - intlength - - - Crée un sous-ensemble d'une plage donnée. - - - - - - &reftitle.parameters; - - - index - - - L'index auquel commence le sous-ensemble. - - - Si positif, le sous-ensemble commencera à cet index dans l'ensemble. - Si négatif, le sous-ensemble commencera à cette distance de la fin. - - - - - length - - - Si une longueur est donnée et est positive, le sous-ensemble résultant - aura jusqu'à autant de valeurs. - - Si la longueur entraîne un dépassement, seules - les valeurs jusqu'à la fin de l'ensemble seront incluses. - - Si une longueur est donnée et est négative, le sous-ensemble - s'arrêtera à autant de valeurs de la fin. - - Si une longueur n'est pas fournie, le sous-ensemble - contiendra toutes les valeurs entre l'index et la - fin de l'ensemble. - - - - - - - - &reftitle.returnvalues; - - Un sous-ensemble de l'ensemble donné. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::slice</function> - -slice(2)); - -// Découpe à partir de 1, pour une longueur de 3 -print_r($set->slice(1, 3)); - -// Découpe à partir de 1 en avant -print_r($set->slice(1)); - -// Découpe à partir de 2 en arrière -print_r($set->slice(-2)); - -// Découpe de 1 à 1 de la fin -print_r($set->slice(1, -1)); -?> -]]> - - &example.outputs.similar; - - c - [1] => d - [2] => e -) -Ds\Set Object -( - [0] => b - [1] => c - [2] => d -) -Ds\Set Object -( - [0] => b - [1] => c - [2] => d - [3] => e -) -Ds\Set Object -( - [0] => d - [1] => e -) -Ds\Set Object -( - [0] => b - [1] => c - [2] => d -) - -]]> - - - - - - - - diff --git a/reference/ds/ds/set/sort.xml b/reference/ds/ds/set/sort.xml deleted file mode 100644 index 9aab4f6214..0000000000 --- a/reference/ds/ds/set/sort.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Ds\Set::sort - - Trie l'ensemble en place - - - - - &reftitle.description; - - public voidDs\Set::sort - callablecomparator - - - Trie l'ensemble en place, en utilisant une fonction comparator optionnelle. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::sort</function> - -sort(); - -print_r($set); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Exemple de <function>Ds\Set::sort</function> en utilisant un comparateur - -sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($set); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/set/sorted.xml b/reference/ds/ds/set/sorted.xml deleted file mode 100644 index 97fdd2d651..0000000000 --- a/reference/ds/ds/set/sorted.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Ds\Set::sorted - Renvoie une copie triée - - - - &reftitle.description; - - public Ds\SetDs\Set::sorted - callablecomparator - - - Renvoie une copie triée de l'ensemble, en utilisant une fonction comparator optionnelle. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Renvoie une copie triée de l'ensemble. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::sorted</function> - -sorted()); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Exemple de <function>Ds\Set::sorted</function> utilisant un comparateur - -sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/set/sum.xml b/reference/ds/ds/set/sum.xml deleted file mode 100644 index 932226dcc4..0000000000 --- a/reference/ds/ds/set/sum.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Set::sum - Renvoie la somme de toutes les valeurs de l'ensemble - - - - &reftitle.description; - - public intfloatDs\Set::sum - - - - Renvoie la somme de toutes les valeurs de l'ensemble. - - - - Les tableaux et les objets sont considérés comme égaux à zéro lors du calcul de la somme. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La somme de toutes les valeurs de l'ensemble en tant que float ou int - en fonction des valeurs de l'ensemble. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::sum</function> avec un entier - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Set::sum</function> avec un nombre à virgule flottante - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/toarray.xml b/reference/ds/ds/set/toarray.xml deleted file mode 100644 index a4e0c585d5..0000000000 --- a/reference/ds/ds/set/toarray.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Set::toArray - - Convertit l'ensemble en un &array; - - - - - &reftitle.description; - - public arrayDs\Set::toArray - - - - Convertit l'ensemble en un &array;. - - - - La conversion en un &array; n'est pas encore supportée. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; contenant toutes les valeurs dans le même ordre que l'ensemble. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::toArray</function> - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/union.xml b/reference/ds/ds/set/union.xml deleted file mode 100644 index 186bf9e854..0000000000 --- a/reference/ds/ds/set/union.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Ds\Set::union - Crée un nouvel ensemble en utilisant les valeurs de l'instance actuelle et d'un autre ensemble - - - - &reftitle.description; - - public Ds\SetDs\Set::union - Ds\Setset - - - Crée un nouvel ensemble qui contient les valeurs de l'instance actuelle ainsi - que les valeurs d'un autre set. - - - A ∪ B = {x: x ∈ A ∨ x ∈ B} - - - - - &reftitle.parameters; - - - set - - - L'autre ensemble, à combiner avec l'instance actuelle. - - - - - - - - &reftitle.returnvalues; - - Un nouvel ensemble contenant toutes les valeurs de l'instance actuelle ainsi que d'un autre set. - - - - - &reftitle.seealso; - - - Union sur Wikipedia - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::union</function> - -union($b)); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/xor.xml b/reference/ds/ds/set/xor.xml deleted file mode 100644 index 24fe62d792..0000000000 --- a/reference/ds/ds/set/xor.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Ds\Set::xor - Crée un nouvel ensemble en utilisant les valeurs de l'instance actuelle ou d'un autre ensemble, mais pas des deux - - - - &reftitle.description; - - public Ds\SetDs\Set::xor - Ds\Setset - - - Crée un nouvel ensemble qui contient les valeurs de l'instance actuelle - ou d'un autre set, - mais pas des deux. - - - A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)} - - - - - &reftitle.parameters; - - - set - - - L'autre ensemble. - - - - - - - - &reftitle.returnvalues; - - Un nouvel ensemble contenant les valeurs de l'instance actuelle ou d'un autre set, - mais pas des deux. - - - - - &reftitle.seealso; - - - Différence symétrique sur Wikipedia - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Set::xor</function> - -xor($b)); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(4) - [3]=> - int(5) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/stack/allocate.xml b/reference/ds/ds/stack/allocate.xml deleted file mode 100644 index b928335c25..0000000000 --- a/reference/ds/ds/stack/allocate.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Stack::allocate - Alloue suffisamment de mémoire pour une capacité requise - - - - &reftitle.description; - - public voidDs\Stack::allocate - intcapacity - - - Assure qu'assez de mémoire est allouée pour une capacité requise. - Cela élimine le besoin de réallouer le tampon interne à mesure que les valeurs sont ajoutées. - - - - - &reftitle.parameters; - - - capacity - - - Le nombre de valeurs pour lesquelles la capacité doit être allouée. - - - - La capacité restera la même si cette valeur est inférieure ou égale à la - capacité actuelle. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/ds/ds/stack/capacity.xml b/reference/ds/ds/stack/capacity.xml deleted file mode 100644 index f60520f155..0000000000 --- a/reference/ds/ds/stack/capacity.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Stack::capacity - Renvoie la capacité actuelle - - - - &reftitle.description; - - public intDs\Stack::capacity - - - - Renvoie la capacité actuelle. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacité actuelle. - - - - - - - diff --git a/reference/ds/ds/stack/clear.xml b/reference/ds/ds/stack/clear.xml deleted file mode 100644 index 7da03a198f..0000000000 --- a/reference/ds/ds/stack/clear.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Stack::clear - Supprime toutes les valeurs - - - - &reftitle.description; - - public voidDs\Stack::clear - - - - Supprime toutes les valeurs de la pile. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Stack::clear</function> - -clear(); -print_r($stack); -?> -]]> - - &example.outputs.similar; - - 3 - [1] => 2 - [2] => 1 -) -Ds\Stack Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/stack/construct.xml b/reference/ds/ds/stack/construct.xml deleted file mode 100644 index 29561585dc..0000000000 --- a/reference/ds/ds/stack/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Ds\Stack::__construct - Crée une nouvelle instance - - - - &reftitle.description; - - public Ds\Stack::__construct - mixedvalues - - - Crée une nouvelle instance, en utilisant soit un objet traversable - ou un &array; pour les values initiales. - - - - - &reftitle.parameters; - - - values - - - Un objet traversable ou un &array; à utiliser pour les valeurs initiales. - - - - - - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Stack::__construct</function> - - -]]> - - &example.outputs.similar; - - 3 - [1] => 2 - [2] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/stack/copy.xml b/reference/ds/ds/stack/copy.xml deleted file mode 100644 index f624776554..0000000000 --- a/reference/ds/ds/stack/copy.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Ds\Stack::copy - Renvoie une copie superficielle de la pile - - - - &reftitle.description; - - public Ds\StackDs\Stack::copy - - - - Renvoie une copie superficielle de la pile. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une copie superficielle de la pile. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Stack::copy</function> - -copy(); - -// Changer la copie n'affecte pas l'original -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 3 - [1] => 2 - [2] => 1 -) -Ds\Stack Object -( - [0] => 4 - [1] => 3 - [2] => 2 - [3] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/stack/count.xml b/reference/ds/ds/stack/count.xml deleted file mode 100644 index 00e6bf8fb1..0000000000 --- a/reference/ds/ds/stack/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Stack::count - Renvoie le nombre de valeurs dans la pile - - - - &reftitle.description; - - Voir Countable::count - - - - - - diff --git a/reference/ds/ds/stack/isempty.xml b/reference/ds/ds/stack/isempty.xml deleted file mode 100644 index 1c906f2ba8..0000000000 --- a/reference/ds/ds/stack/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Stack::isEmpty - Renvoie si la pile est vide - - - - &reftitle.description; - - public boolDs\Stack::isEmpty - - - - Renvoie si la pile est vide. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si la pile est vide, sinon &false;. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Stack::isEmpty</function> - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/stack/jsonserialize.xml b/reference/ds/ds/stack/jsonserialize.xml deleted file mode 100644 index 6ac159ea4b..0000000000 --- a/reference/ds/ds/stack/jsonserialize.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - Ds\Stack::jsonSerialize - Renvoie une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - Voir JsonSerializable::jsonSerialize - - - - Il ne devrait jamais être nécessaire d'appeler cette méthode directement. - - - - - - diff --git a/reference/ds/ds/stack/peek.xml b/reference/ds/ds/stack/peek.xml deleted file mode 100644 index d9676bf1df..0000000000 --- a/reference/ds/ds/stack/peek.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Stack::peek - Renvoie la valeur en haut de la pile - - - - &reftitle.description; - - public mixedDs\Stack::peek - - - - Renvoie la valeur en haut de la pile, mais ne la supprime pas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La valeur en haut de la pile. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Stack::peek</function> - -push("a"); -$stack->push("b"); -$stack->push("c"); - -var_dump($stack->peek()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/stack/pop.xml b/reference/ds/ds/stack/pop.xml deleted file mode 100644 index 0f0b4acb25..0000000000 --- a/reference/ds/ds/stack/pop.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Stack::pop - Supprime et renvoie la valeur en haut de la pile - - - - &reftitle.description; - - public mixedDs\Stack::pop - - - - Supprime et renvoie la valeur en haut de la pile. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La valeur supprimée qui était en haut de la pile. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Stack::pop</function> - -push("a"); -$stack->push("b"); -$stack->push("c"); - -var_dump($stack->pop()); -var_dump($stack->pop()); -var_dump($stack->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/stack/push.xml b/reference/ds/ds/stack/push.xml deleted file mode 100644 index 4f03f2cec9..0000000000 --- a/reference/ds/ds/stack/push.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Stack::push - Ajoute des valeurs à la pile - - - - &reftitle.description; - - public voidDs\Stack::push - mixedvalues - - - Ajoute les values dans la pile. - - - - - - &reftitle.parameters; - - - values - - - Les valeurs à ajouter à la pile. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Stack::push</function> - -push("a"); -$stack->push("b"); -$stack->push("c", "d"); -$stack->push(...["e", "f"]); - -print_r($stack); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - - diff --git a/reference/ds/ds/stack/toarray.xml b/reference/ds/ds/stack/toarray.xml deleted file mode 100644 index 5741ec6bb3..0000000000 --- a/reference/ds/ds/stack/toarray.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Stack::toArray - - Convertit la pile en un &array; - - - - - &reftitle.description; - - public arrayDs\Stack::toArray - - - - Convertit la pile en un &array;. - - - - La conversion en &array; n'est pas encore supportée. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; contenant toutes les valeurs dans le même ordre que la pile. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Stack::toArray</function> - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(3) - [1]=> - int(2) - [2]=> - int(1) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/allocate.xml b/reference/ds/ds/vector/allocate.xml deleted file mode 100644 index f0d52f9801..0000000000 --- a/reference/ds/ds/vector/allocate.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Vector::allocate - Alloue suffisamment de mémoire pour une capacité requise - - - - &reftitle.description; - - public voidDs\Vector::allocate - intcapacity - - - Assure qu'assez de mémoire est allouée pour une capacité requise. - Cela élimine le besoin de réallouer le tampon interne à mesure que les valeurs sont ajoutées. - - - - - &reftitle.parameters; - - - capacity - - - Le nombre de valeurs pour lesquelles la capacité doit être allouée. - - - - La capacité restera la même si cette valeur est inférieure ou égale à la - capacité actuelle. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::allocate</function> - -capacity()); - -$vector->allocate(100); -var_dump($vector->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/apply.xml b/reference/ds/ds/vector/apply.xml deleted file mode 100644 index 4635de2c47..0000000000 --- a/reference/ds/ds/vector/apply.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Ds\Vector::apply - Change toutes les valeurs en appliquant une fonction de rappel à chaque valeur - - - - &reftitle.description; - - public voidDs\Vector::apply - callablecallback - - - Change toutes les valeurs en appliquant un callback à - chaque valeur dans le vecteur. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - Un callable à appliquer à chaque valeur du vecteur. - - - - La fonction de rappel devrait retourner la valeur par laquelle elle devrait être remplacée. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::apply</function> - -apply(function($value) { return $value * 2; }); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/capacity.xml b/reference/ds/ds/vector/capacity.xml deleted file mode 100644 index 64ca0e1f7e..0000000000 --- a/reference/ds/ds/vector/capacity.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Vector::capacity - Renvoie la capacité actuelle - - - - &reftitle.description; - - public intDs\Vector::capacity - - - - Renvoie la capacité actuelle. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacité actuelle. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::capacity</function> - -capacity()); - -$vector->push(...range(1, 50)); -var_dump($vector->capacity()); - -$vector[] = "a"; -var_dump($vector->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/clear.xml b/reference/ds/ds/vector/clear.xml deleted file mode 100644 index ef59ee3520..0000000000 --- a/reference/ds/ds/vector/clear.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Vector::clear - Supprime toutes les valeurs - - - - &reftitle.description; - - public voidDs\Vector::clear - - - - Supprime toutes les valeurs du vecteur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::clear</function> - -clear(); -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Vector Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/construct.xml b/reference/ds/ds/vector/construct.xml deleted file mode 100644 index c4354a5e81..0000000000 --- a/reference/ds/ds/vector/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Vector::__construct - Crée une nouvelle instance - - - - &reftitle.description; - - public Ds\Vector::__construct - mixedvalues - - - Crée une nouvelle instance, en utilisant soit un objet traversable, - soit un &array; pour les values initiales. - - - - - &reftitle.parameters; - - - values - - - Un objet traversable ou un &array; à utiliser pour les valeurs initiales. - - - - - - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::__construct</function> - - -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/contains.xml b/reference/ds/ds/vector/contains.xml deleted file mode 100644 index 41dc980e76..0000000000 --- a/reference/ds/ds/vector/contains.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Vector::contains - Détermine si le vecteur contient des valeurs données - - - - &reftitle.description; - - public boolDs\Vector::contains - mixedvalues - - - Détermine si le vecteur contient toutes les valeurs. - - - - - &reftitle.parameters; - - - values - - - Les valeurs à vérifier. - - - - - - - - &reftitle.returnvalues; - - &false; si l'une des values fournies n'est pas dans le - vecteur, sinon &true;. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::contains</function> - -contains('a')); // true -var_dump($vector->contains('a', 'b')); // true -var_dump($vector->contains('c', 'd')); // false - -var_dump($vector->contains(...['c', 'b', 'a'])); // true - -// Toujours strict -var_dump($vector->contains(1)); // true -var_dump($vector->contains('1')); // false - -var_dump($vector->contains(...[])); // true -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/copy.xml b/reference/ds/ds/vector/copy.xml deleted file mode 100644 index fbd0f89123..0000000000 --- a/reference/ds/ds/vector/copy.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Ds\Vector::copy - Renvoie une copie superficielle du vecteur - - - - &reftitle.description; - - public Ds\VectorDs\Vector::copy - - - - Renvoie une copie superficielle du vecteur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une copie superficielle du vecteur. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::copy</function> - -copy(); - -// Changer la copie n'affecte pas l'original -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Vector Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/count.xml b/reference/ds/ds/vector/count.xml deleted file mode 100644 index 0e4c8dd5e5..0000000000 --- a/reference/ds/ds/vector/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Vector::count - Renvoie le nombre de valeurs dans la collection - - - - &reftitle.description; - - Voir Countable::count - - - - - - diff --git a/reference/ds/ds/vector/filter.xml b/reference/ds/ds/vector/filter.xml deleted file mode 100644 index bc5e015a87..0000000000 --- a/reference/ds/ds/vector/filter.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - Ds\Vector::filter - - Créer un nouveau vecteur en utilisant un callable pour - déterminer quelles valeurs inclure - - - - - &reftitle.description; - - public Ds\VectorDs\Vector::filter - callablecallback - - - Crée un nouveau vecteur en utilisant un callable pour - déterminer quelles valeurs inclure. - - - - - &reftitle.parameters; - - - - callback - - - - - bool - callback - mixedvalue - - - - Un callable optionnel qui retourne &true; si la valeur doit être incluse, &false; sinon. - - - Si aucune fonction de rappel n'est fournie, seules les valeurs qui sont &true; - (voir conversion en booléen) - seront incluses. - - - - - - - - - &reftitle.returnvalues; - - Un nouveau vecteur contenant toutes les valeurs pour lesquelles - soit le callback a retourné &true;, soit toutes les valeurs qui - se convertissent en &true; si un callback n'a pas été fourni. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::filter</function> avec une fonction de rappel - -filter(function($value) { - return $value % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) -} -]]> - - - - Exemple de <function>Ds\Vector::filter</function> sans fonction de rappel - -filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/find.xml b/reference/ds/ds/vector/find.xml deleted file mode 100644 index cb93817028..0000000000 --- a/reference/ds/ds/vector/find.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Vector::find - - Essaye de trouver l'index d'une valeur - - - - - &reftitle.description; - - public mixedDs\Vector::find - mixedvalue - - - Renvoie l'index de la value, ou &false; si non trouvée. - - - - - - &reftitle.parameters; - - - value - - - La valeur à trouver. - - - - - - - - &reftitle.returnvalues; - - L'index de la valeur, ou &false; si non trouvée. - - - - Les valeurs seront comparées par valeur et par type. - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::find</function> - -find("a")); // 0 -var_dump($vector->find("b")); // false -var_dump($vector->find("1")); // false -var_dump($vector->find(1)); // 1 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/first.xml b/reference/ds/ds/vector/first.xml deleted file mode 100644 index 5abf93043c..0000000000 --- a/reference/ds/ds/vector/first.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Vector::first - Renvoie la première valeur dans le vecteur - - - - &reftitle.description; - - public mixedDs\Vector::first - - - - Renvoie la première valeur dans le vecteur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La première valeur dans le vecteur. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::first</function> - -first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/get.xml b/reference/ds/ds/vector/get.xml deleted file mode 100644 index 21bf78ae1f..0000000000 --- a/reference/ds/ds/vector/get.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Ds\Vector::get - Renvoie la valeur à un index donné - - - - &reftitle.description; - - public mixedDs\Vector::get - intindex - - - Renvoie la valeur à un index donné. - - - - - - &reftitle.parameters; - - - index - - - L'index à accéder, en commençant à 0. - - - - - - - - &reftitle.returnvalues; - - La valeur à l'index demandé. - - - - - &reftitle.errors; - - OutOfRangeException si l'index n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::get</function> - -get(0)); -var_dump($vector->get(1)); -var_dump($vector->get(2)); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Vector::get</function> utilisant la syntaxe de tableau - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/insert.xml b/reference/ds/ds/vector/insert.xml deleted file mode 100644 index 2973dd1742..0000000000 --- a/reference/ds/ds/vector/insert.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Ds\Vector::insert - Insère des valeurs à un index donné - - - - &reftitle.description; - - public voidDs\Vector::insert - intindex - mixedvalues - - - Insère des valeurs dans le vecteur à un index donné. - - - - - - &reftitle.parameters; - - - index - - - L'index auquel insérer. 0 <= index <= count - - - - Il est possible d'insérer à l'index égal au nombre de valeurs. - - - - - - values - - - La ou les valeurs à insérer. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException si l'index n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::insert</function> - -insert(0, "e"); // [e] -$vector->insert(1, "f"); // [e, f] -$vector->insert(2, "g"); // [e, f, g] -$vector->insert(0, "a", "b"); // [a, b, e, f, g] -$vector->insert(2, ...["c", "d"]); // [a, b, c, d, e, f, g] - -var_dump($vector); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - [1]=> - string(1) "b" - [2]=> - string(1) "c" - [3]=> - string(1) "d" - [4]=> - string(1) "e" - [5]=> - string(1) "f" - [6]=> - string(1) "g" -} -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/isempty.xml b/reference/ds/ds/vector/isempty.xml deleted file mode 100644 index 828284896a..0000000000 --- a/reference/ds/ds/vector/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Vector::isEmpty - Renvoie si le vecteur est vide - - - - &reftitle.description; - - public boolDs\Vector::isEmpty - - - - Renvoie si le vecteur est vide. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si le vecteur est vide, sinon &false;. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::isEmpty</function> - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/join.xml b/reference/ds/ds/vector/join.xml deleted file mode 100644 index 0b98e04b5f..0000000000 --- a/reference/ds/ds/vector/join.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Ds\Vector::join - Rassemble toutes les valeurs en une chaîne de caractères - - - - &reftitle.description; - - public stringDs\Vector::join - stringglue - - - Rassemble toutes les valeurs en une chaîne en utilisant un séparateur optionnel entre chaque valeur. - - - - - &reftitle.parameters; - - - glue - - - Une chaîne optionnelle pour séparer chaque valeur. - - - - - - - - &reftitle.returnvalues; - - Toutes les valeurs du vecteur rassemblées en une chaîne. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::join</function> avec une chaîne séparatrice - -join("|")); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Vector::join</function> sans chaîne séparatrice - -join()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/jsonserialize.xml b/reference/ds/ds/vector/jsonserialize.xml deleted file mode 100644 index 8424800c3f..0000000000 --- a/reference/ds/ds/vector/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Vector::jsonSerialize - Renvoie une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - Voir JsonSerializable::jsonSerialize - - - - Il ne devrait jamais être nécessaire d'appeler cette méthode directement. - - - - - - - diff --git a/reference/ds/ds/vector/last.xml b/reference/ds/ds/vector/last.xml deleted file mode 100644 index 684b53ddbd..0000000000 --- a/reference/ds/ds/vector/last.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Vector::last - Renvoie la dernière valeur - - - - &reftitle.description; - - public mixedDs\Vector::last - - - - Renvoie la dernière valeur dans le vecteur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La dernière valeur dans le vecteur. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::last</function> - -last()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/map.xml b/reference/ds/ds/vector/map.xml deleted file mode 100644 index 1fe2739beb..0000000000 --- a/reference/ds/ds/vector/map.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Ds\Vector::map - Renvoie le résultat de l'application d'un rappel à chaque valeur - - - - &reftitle.description; - - public Ds\VectorDs\Vector::map - callablecallback - - - Renvoie le résultat de l'application d'un callback à - chaque valeur du vecteur. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - Un callable à appliquer à chaque valeur du vecteur. - - - - La fonction de rappel doit prendre un argument et retourner la nouvelle valeur. - - - - - - - - - &reftitle.returnvalues; - - Le résultat de l'application de callback à chaque valeur - du vecteur. - - - - Les valeurs de l'instance actuelle ne seront pas affectées. - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::map</function> - -map(function($value) { return $value * 2; })); -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -Ds\Vector Object -( - [0] => 1 - [1] => 2 - [2] => 3 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/merge.xml b/reference/ds/ds/vector/merge.xml deleted file mode 100644 index e51af8c5e3..0000000000 --- a/reference/ds/ds/vector/merge.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Ds\Vector::merge - Renvoie le résultat de l'ajout de toutes les valeurs données au vecteur - - - - &reftitle.description; - - public Ds\VectorDs\Vector::merge - mixedvalues - - - Renvoie le résultat de l'ajout de toutes les valeurs données au vecteur. - - - - - - &reftitle.parameters; - - - values - - - Un objet traversable ou un &array;. - - - - - - - - &reftitle.returnvalues; - - Le résultat de l'ajout de toutes les valeurs données au vecteur, - effectivement le même que d'ajouter les valeurs à une copie, puis de retourner cette copie. - - - - L'instance actuelle ne sera pas affectée. - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::merge</function> - -merge([4, 5, 6])); -var_dump($vector); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) - [5]=> - int(6) -} -object(Ds\Vector)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/pop.xml b/reference/ds/ds/vector/pop.xml deleted file mode 100644 index cdd2d9ea5f..0000000000 --- a/reference/ds/ds/vector/pop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Vector::pop - Supprime et renvoie la dernière valeur - - - - &reftitle.description; - - public mixedDs\Vector::pop - - - - Supprime et renvoie la dernière valeur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le dernier élément supprimé. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::pop</function> - -pop()); -var_dump($vector->pop()); -var_dump($vector->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/push.xml b/reference/ds/ds/vector/push.xml deleted file mode 100644 index 1d587fb3f6..0000000000 --- a/reference/ds/ds/vector/push.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Vector::push - Ajoute des valeurs à la fin du vecteur - - - - &reftitle.description; - - public voidDs\Vector::push - mixedvalues - - - Ajoute des valeurs à la fin du vecteur. - - - - - - &reftitle.parameters; - - - values - - - Les valeurs à ajouter. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::push</function> - -push("a"); -$vector->push("b"); -$vector->push("c", "d"); -$vector->push(...["e", "f"]); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/reduce.xml b/reference/ds/ds/vector/reduce.xml deleted file mode 100644 index 8eb330af63..0000000000 --- a/reference/ds/ds/vector/reduce.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - Ds\Vector::reduce - Réduit le vecteur à une seule valeur en utilisant une fonction de rappel - - - - &reftitle.description; - - public mixedDs\Vector::reduce - callablecallback - mixedinitial - - - Réduit le vecteur à une seule valeur en utilisant une fonction de rappel. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedvalue - - - - carry - - - La valeur de retour du rappel précédent, ou initial si - c'est la première itération. - - - - - value - - - La valeur de l'itération actuelle. - - - - - - - - - initial - - - La valeur initiale de la valeur de retour. Peut être &null;. - - - - - - - - &reftitle.returnvalues; - - La valeur de retour du rappel final. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::reduce</function> avec valeur initiale - -reduce($callback, 5)); - -// Itérations: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Vector::reduce</function> sans valeur initiale - -reduce(function($carry, $value) { - return $carry + $value + 5; -})); - -// Itérations: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/remove.xml b/reference/ds/ds/vector/remove.xml deleted file mode 100644 index 5bc13b3962..0000000000 --- a/reference/ds/ds/vector/remove.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Ds\Vector::remove - Supprime et renvoie une valeur par index - - - - &reftitle.description; - - public mixedDs\Vector::remove - intindex - - - Supprime et renvoie une valeur par index. - - - - - - &reftitle.parameters; - - - index - - - L'index de la valeur à supprimer. - - - - - - - - &reftitle.returnvalues; - - La valeur qui a été supprimée. - - - - - &reftitle.errors; - - OutOfRangeException si l'index n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::remove</function> - -remove(1)); -var_dump($vector->remove(0)); -var_dump($vector->remove(0)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/reverse.xml b/reference/ds/ds/vector/reverse.xml deleted file mode 100644 index 16e952e6ea..0000000000 --- a/reference/ds/ds/vector/reverse.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Vector::reverse - - Renverser le vecteur en place - - - - - &reftitle.description; - - public voidDs\Vector::reverse - - - - Renverse le vecteur en place. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::reverse</function> - -reverse(); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/reversed.xml b/reference/ds/ds/vector/reversed.xml deleted file mode 100644 index 825c382ba4..0000000000 --- a/reference/ds/ds/vector/reversed.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Vector::reversed - Renvoie une copie inversée - - - - &reftitle.description; - - public Ds\VectorDs\Vector::reversed - - - - Renvoie une copie inversée du vecteur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une copie inversée du vecteur. - - - - L'instance actuelle n'est pas affectée. - - - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::reversed</function> - -reversed()); -print_r($vector); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -Ds\Vector Object -( - [0] => a - [1] => b - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/rotate.xml b/reference/ds/ds/vector/rotate.xml deleted file mode 100644 index 2ce73d6750..0000000000 --- a/reference/ds/ds/vector/rotate.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Vector::rotate - Tourne le vecteur d'un certain nombre de rotations - - - - &reftitle.description; - - public voidDs\Vector::rotate - introtations - - - Tourne le vecteur d'un certain nombre de rotations, ce qui équivaut à appeler successivement - $vector->push($vector->shift()) si le nombre de rotations est positif, ou - $vector->unshift($vector->pop()) si négatif. - - - - - - &reftitle.parameters; - - - rotations - - - Le nombre de fois que le vecteur doit être tourné. - - - - - - - - &reftitle.returnvalues; - - &return.void;. Le vecteur de l'instance actuelle sera tourné. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::rotate</function> - -rotate(1); // "a" est décalé, puis poussé. -print_r($vector); - -$vector->rotate(2); // sont tous deux décalés, puis poussés. -print_r($vector); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => d - [3] => a -) -Ds\Vector Object -( - [0] => d - [1] => a - [2] => b - [3] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/set.xml b/reference/ds/ds/vector/set.xml deleted file mode 100644 index 89bc8338c0..0000000000 --- a/reference/ds/ds/vector/set.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - Ds\Vector::set - Change une valeur à un index donné - - - - &reftitle.description; - - public voidDs\Vector::set - intindex - mixedvalue - - - Change une valeur à un index donné. - - - - - - &reftitle.parameters; - - - index - - - L'index de la valeur à mettre à jour. - - - - - value - - - La nouvelle valeur. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException si l'index n'est pas valide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::set</function> - -set(1, "_"); -print_r($vector); -?> -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - Exemple de <function>Ds\Vector::set</function> utilisant la syntaxe de tableau - - -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/shift.xml b/reference/ds/ds/vector/shift.xml deleted file mode 100644 index 6a41c67e46..0000000000 --- a/reference/ds/ds/vector/shift.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Vector::shift - Supprime et renvoie la première valeur - - - - &reftitle.description; - - public mixedDs\Vector::shift - - - - Supprime et renvoie la première valeur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La première valeur, qui a été supprimée. - - - - - &reftitle.errors; - - UnderflowException si vide. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::shift</function> - -shift()); -var_dump($vector->shift()); -var_dump($vector->shift()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/slice.xml b/reference/ds/ds/vector/slice.xml deleted file mode 100644 index 0ddfdc5b4f..0000000000 --- a/reference/ds/ds/vector/slice.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - Ds\Vector::slice - - Renvoie un sous-vecteur d'une plage donnée - - - - - &reftitle.description; - - public Ds\VectorDs\Vector::slice - intindex - intlength - - - Crée un sous-vecteur d'une plage donnée. - - - - - - &reftitle.parameters; - - - index - - - L'index auquel commence le sous-vecteur. - - - Si positif, le sous-vecteur commencera à cet index dans le vecteur. - Si négatif, le sous-vecteur commencera à cette distance de la fin. - - - - - length - - - Si une longueur est donnée et est positive, le sous-vecteur résultant - aura jusqu'à autant de valeurs. - - Si la longueur entraîne un dépassement, seules - les valeurs jusqu'à la fin du vecteur seront incluses. - - Si une longueur est donnée et est négative, le sous-vecteur - s'arrêtera à autant de valeurs de la fin. - - Si une longueur n'est pas fournie, le sous-vecteur - contiendra toutes les valeurs entre l'index et la - fin du vecteur. - - - - - - - - &reftitle.returnvalues; - - Un sous-vecteur de la plage donnée. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::slice</function> - -slice(2)); - -// Découpe à partir de 1, pour une longueur de 3 -print_r($vector->slice(1, 3)); - -// Découpe à partir de 1 en avant -print_r($vector->slice(1)); - -// Découpe à partir de 2 en arrière -print_r($vector->slice(-2)); - -// Découpe de 1 à 1 de la fin -print_r($vector->slice(1, -1)); -?> -]]> - - &example.outputs.similar; - - c - [1] => d - [2] => e -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d - [3] => e -) -Ds\Vector Object -( - [0] => d - [1] => e -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d -) - -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/sort.xml b/reference/ds/ds/vector/sort.xml deleted file mode 100644 index 4d5d38f686..0000000000 --- a/reference/ds/ds/vector/sort.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Ds\Vector::sort - - Trie le vecteur en place - - - - - &reftitle.description; - - public voidDs\Vector::sort - callablecomparator - - - Trie le vecteur en place, en utilisant une fonction comparator facultative. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::sort</function> - -sort(); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Exemple de <function>Ds\Vector::sort</function> utilisant un comparateur - -sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/vector/sorted.xml b/reference/ds/ds/vector/sorted.xml deleted file mode 100644 index 6fa59da20e..0000000000 --- a/reference/ds/ds/vector/sorted.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Ds\Vector::sorted - Renvoie une copie triée - - - - &reftitle.description; - - public Ds\VectorDs\Vector::sorted - callablecomparator - - - Renvoie une copie triée du vecteur, en utilisant une fonction comparator facultative. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Renvoie une copie triée du vecteur. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::sorted</function> - -sorted()); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Exemple de <function>Ds\Vector::sorted</function> utilisant un comparateur - -sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/vector/sum.xml b/reference/ds/ds/vector/sum.xml deleted file mode 100644 index c7615e9282..0000000000 --- a/reference/ds/ds/vector/sum.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Vector::sum - Renvoie la somme de toutes les valeurs du vecteur - - - - &reftitle.description; - - public intfloatDs\Vector::sum - - - - Renvoie la somme de toutes les valeurs du vecteur. - - - - Les tableaux et les objets sont considérés comme égaux à zéro lors du calcul de la somme. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La somme de toutes les valeurs du vecteur en tant que float ou int - en fonction des valeurs du vecteur. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::sum</function> avec un entier - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple de <function>Ds\Vector::sum</function> avec un nombre à virgule flottante - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/toarray.xml b/reference/ds/ds/vector/toarray.xml deleted file mode 100644 index 6998bca81f..0000000000 --- a/reference/ds/ds/vector/toarray.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Vector::toArray - - Convertit le vecteur en &array; - - - - - &reftitle.description; - - public arrayDs\Vector::toArray - - - - Convertit le vecteur en un &array;. - - - - La conversion en &array; n'est pas encore supportée. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; contenant toutes les valeurs dans le même ordre que le vecteur. - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::toArray</function> - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/unshift.xml b/reference/ds/ds/vector/unshift.xml deleted file mode 100644 index fce4355b6e..0000000000 --- a/reference/ds/ds/vector/unshift.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Vector::unshift - Ajoute des valeurs au début du vecteur - - - - &reftitle.description; - - public voidDs\Vector::unshift - mixedvalues - - - Ajoute des valeurs au début du vecteur, déplaçant toutes les valeurs actuelles - vers l'avant pour faire de la place pour les nouvelles valeurs. - - - - - - &reftitle.parameters; - - - values - - - Les valeurs à ajouter au début du vecteur. - - - De multiples valeurs peuvent être ajoutées dans le même ordre qu'elles sont - passées. - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>Ds\Vector::unshift</function> - -unshift("a"); -$vector->unshift("b", "c"); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => a - [3] => 1 - [4] => 2 - [5] => 3 -) -]]> - - - - - - - diff --git a/reference/ds/examples.xml b/reference/ds/examples.xml deleted file mode 100644 index 2a0d9e489d..0000000000 --- a/reference/ds/examples.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - &reftitle.examples; - - Vector - -push('a'); -$vector->push('b', 'c'); - -$vector[] = 'd'; - -print_r($vector); - -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d -) -]]> - - - - Map - -put('a', 1); -$map->put('b', 2); - -$map['c'] = 3; - -print_r($map); - -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - - diff --git a/reference/ds/setup.xml b/reference/ds/setup.xml deleted file mode 100644 index 04d7e9321a..0000000000 --- a/reference/ds/setup.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - PHP 7 est requis par l'extension et le polyfill de compatibilité. - -
- -
- &reftitle.install; - - Le moyen le plus simple d'installer l'extension est via PECL - - - - - - - Il est également possible de construire directement à partir de la source: - - - - - - - - - - Si l'on utilise Composer, il est fortement recommandé d'inclure - php-ds/php-ds - dans le projet pour que le code soit toujours fonctionnel dans un environnement où l'extension - n'est pas installée. L'extension prendra la priorité si elle est installée. - - -
- - - - - diff --git a/reference/eio/book.xml b/reference/eio/book.xml deleted file mode 100644 index d3e5c2eacf..0000000000 --- a/reference/eio/book.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - - Eio - Eio - - - &reftitle.intro; - - Cette extension fournit un système POSIX I/O asynchrone via - la bibliothèque C libeio - écrite par Marc Lehmann. - - - ¬e.no-windows.extension; - - - - - - Il est important de noter que chaque demande est exécutée dans un thread, - et l'ordre d'exécution des demandes en attente n'est pas assuré. - Pour l'instant, le code suivant n'est pas correct. - - - - - Demandes incorrectes - -]]> - - - Dans l'exemple ci-dessus, la fonction eio_rename - peut se terminer avant la fonction eio_symlink. - Pour résoudre ce problème, il est possible d'appeler la fonction - eio_rename dans la fonction de rappel de la - fonction eio_symlink: - - Exécution d'une demande dans la fonction de rappel d'une autre - - ]]> - - - - Alternativement, il est possible de créer un groupe de demandes : - - - Exécution d'une demande depuis la fonction de rappel d'une autre - -]]> - - Un groupe est une demande spéciale qui peut cumuler un jeu de - demandes eio. Ce mécanisme peut être utile pour - créer une demande complexe qui ouvre, lit et ferme un fichier. - - - À partir de la version 0.3.0 alpha, une variable utilisée dans les - communications internes avec libeio peut être récupérée - avec la fonction eio_get_event_stream. La - variable peut être utilisée pour lier une boucle d'événements - avec d'autres extensions. Il est possible d'organiser une boucle - d'événements où libeio et libevent fonctionnent ensemble : - - Utilisation d'eio et libevent - -]]> - - - - - - &reference.eio.setup; - &reference.eio.constants; - &reference.eio.examples; - &reference.eio.reference; - - - diff --git a/reference/eio/configure.xml b/reference/eio/configure.xml deleted file mode 100644 index 23c2dafb30..0000000000 --- a/reference/eio/configure.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;eio. - - - Pour des informations complémentaires sur l'installation manuelle, - se référer au fichier INSTALL - inclus dans le paquet. - - -
- diff --git a/reference/eio/constants.xml b/reference/eio/constants.xml deleted file mode 100644 index 57227abf0a..0000000000 --- a/reference/eio/constants.xml +++ /dev/null @@ -1,687 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - Constantes de priorités des demandes : - - - - - - EIO_PRI_MIN - (int) - - - - Demande une priorité minimale. - - - - - - EIO_PRI_DEFAULT - (int) - - - - Demande une priorité par défaut. - - - - - - EIO_PRI_MAX - (int) - - - - Demande une priorité maximale. - - - - - - - - - Argument whence de la fonction - eio_seek : - - - - EIO_SEEK_SET - (int) - - - - La position est définie pour spécifier le nombre - d'octets (offset). - - - - - - EIO_SEEK_CUR - (int) - - - - La position est définie à sa position courante, - à laquelle on ajoute offset octets. - - - - - - EIO_SEEK_END - (int) - - - - La position est définie à la taille du fichier, à laquelle - on ajoute offset octets. - - - - - - - - Drapeaux utilisés avec la fonction eio_readdir: - - - - - - EIO_READDIR_DENTS - (int) - - - - Drapeau de la fonction eio_readdir. - Si spécifié, l'argument résultant de la fonction de rappel - devient un tableau contenant les clés suivantes : - 'names' - tableau de noms de dossier - 'dents' - tableau de tableaux struct eio_dirent - contenant les clés suivantes : - 'name' - le nom du dossier ; - 'type' - une constante EIO_DT_* ; - 'inode' - le nombre d'inodes, si disponible, sinon, non spécifié. - - - - - - EIO_READDIR_DIRS_FIRST - (int) - - - - Lorsque ce drapeau est spécifié, les noms sont retournés dans un - ordre où les dossiers arrivent en premier, dans un ordre optimal suivant - les statistiques. - - - - - - EIO_READDIR_STAT_ORDER - (int) - - - - Lorsque ce drapeau est spécifié, alors les noms sont retournés - dans un ordre utilisant uniquement stat. - Lors de l'utilisation de la fonction - stat sur tous les fichiers du dossier fourni, - l'ordre retourné grâce à ce drapeau sera bien plus rapide. - - - - - - EIO_READDIR_FOUND_UNKNOWN - (int) - - - - - - - - - - - - EIO_DT_UNKNOWN - (int) - - - - Noeud de type inconnu (assez commun). Un appel à la fonction - stat est nécessaire. - - - - - - EIO_DT_FIFO - (int) - - - - Noeud de type FIFO. - - - - - - EIO_DT_CHR - (int) - - - - Type de nœud. - - - - - - EIO_DT_MPC - (int) - - - - Noeud de type périphérique à caractères multiplexés (v7+coherent). - - - - - - EIO_DT_DIR - (int) - - - - Noeud de type dossier. - - - - - - EIO_DT_NAM - (int) - - - - Noeud de type fichier nommé Xenix. - - - - - - EIO_DT_BLK - (int) - - - - Type de nœud. - - - - - - EIO_DT_MPB - (int) - - - - Périphérique de bloc multiplexé (v7+coherent). - - - - - - EIO_DT_REG - (int) - - - - Type de nœud. - - - - - - EIO_DT_NWK - (int) - - - - - - - - - EIO_DT_CMP - (int) - - - - Noeud de type réseau HP-UX. - - - - - - EIO_DT_LNK - (int) - - - - Noeud de type lien. - - - - - - EIO_DT_SOCK - (int) - - - - Noeud de type socket. - - - - - - EIO_DT_DOOR - (int) - - - - Noeud de type Solaris door. - - - - - - EIO_DT_WHT - (int) - - - - Noeud de type. - - - - - - EIO_DT_MAX - (int) - - - - Valeur maximale du type de nœud. - - - - - - - - - - Modes d'accès utilisés par l'argument flags - de la fonction eio_open : - - - - - - EIO_O_RDONLY - (int) - - - - - - - - - EIO_O_WRONLY - (int) - - - - - - - - - EIO_O_RDWR - (int) - - - - - - - - - EIO_O_NONBLOCK - (int) - - - - - - - - - EIO_O_APPEND - (int) - - - - - - - - - EIO_O_CREAT - (int) - - - - - - - - - EIO_O_TRUNC - (int) - - - - - - - - - EIO_O_EXCL - (int) - - - - - - - - - EIO_O_FSYNC - (int) - - - - - - - - - - - - Drapeaux pour l'argument mode de la fonction eio_open : - - - - - - EIO_S_IRUSR - (int) - - - - - - - - - EIO_S_IWUSR - (int) - - - - - - - - - EIO_S_IXUSR - (int) - - - - - - - - - EIO_S_IRGRP - (int) - - - - - - - - - EIO_S_IWGRP - (int) - - - - - - - - - EIO_S_IXGRP - (int) - - - - - - - - - EIO_S_IROTH - (int) - - - - - - - - - EIO_S_IWOTH - (int) - - - - - - - - - EIO_S_IXOTH - (int) - - - - - - - - - EIO_S_IFREG - (int) - - - - - - - - - EIO_S_IFCHR - (int) - - - - - - - - - EIO_S_IFBLK - (int) - - - - - - - - - EIO_S_IFIFO - (int) - - - - - - - - - EIO_S_IFSOCK - (int) - - - - - - - - - - - - - Drapeaux pour la fonction eio_sync_file_range : - - - - - - EIO_SYNC_FILE_RANGE_WAIT_BEFORE - (int) - - - - - - - - - EIO_SYNC_FILE_RANGE_WRITE - (int) - - - - - - - - - EIO_SYNC_FILE_RANGE_WAIT_AFTER - (int) - - - - - - - - - - - - - Drapeaux pour la fonction eio_fallocate : - - - - - EIO_FALLOC_FL_KEEP_SIZE - (int) - - - - - - - - - - - - - Les constantes EIO_S_I* ont la même signification - que leurs équivalents POSIX S_I*. - - - - - - Les constantes EIO_SYNC_FILE_* ont la même signification - que leurs équivalents SYNC_FILE_**. - - - - - - Les constantes EIO_O_* ont la même signification - que leurs équivalents O_*. - - - - diff --git a/reference/eio/examples.xml b/reference/eio/examples.xml deleted file mode 100644 index 2c31b8e8c2..0000000000 --- a/reference/eio/examples.xml +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - - &reftitle.examples; - - Annulation d'une demande - - -]]> - - &example.outputs.similar; - - - - - - - Appel de la fonction <function>eio_chmod</function> - - -]]> - - &example.outputs.similar; - - - - - - - Fabrication d'une demande personnalisée - - 1001, - 'data_modified' => "mes données personnalisées", - ); - - return $result; -} - -$data = "my_custom_data"; -$req = eio_custom("my_custom", EIO_PRI_DEFAULT, "my_custom_callback", $data); -var_dump($req); -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - Création d'un groupe de demandes - - 0); - - // Crée une demande eio_read() et l'ajoute au groupe - $req = eio_read($my_file_fd, 4, 0, EIO_PRI_DEFAULT, "my_grp_file_read_callback"); - eio_grp_add($grp, $req); -} - -/* Sera appelé lorsque la fonction eio_read() aura terminé */ -function my_grp_file_read_callback($data, $result) { - global $my_file_fd, $grp; - - var_dump($result); - - // Crée une demande eio_close() et l'ajoute au groupe - $req = eio_close($my_file_fd); - eio_grp_add($grp, $req); -} - -$grp = eio_grp("my_grp_done", "my_grp_data"); - -// Crée une demande eio_open() et l'ajoute au groupe -$req = eio_open($temp_filename, EIO_O_RDWR | EIO_O_APPEND , NULL, - EIO_PRI_DEFAULT, "my_grp_file_opened_callback", NULL); -eio_grp_add($grp, $req); -var_dump($grp); - -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - Utilisation d'eio avec libevent - -]]> - - &example.outputs.similar; - - - - - - - Utilisation d'eio avec l'extension event - add(); - -// Ajoute le job eio -eio_nop(EIO_PRI_DEFAULT, function () { - echo "eio_nop\n"; -}); - -// Ajoute les événements -$timer = Event::timer($base, function () { - echo "2 seconds elapsed\n"; -}); -$timer->add(2); - -// Envoie les événements. -$base->dispatch(); -?> -]]> - -&example.outputs.similar; - - - - - - - diff --git a/reference/eio/functions/eio-busy.xml b/reference/eio/functions/eio-busy.xml deleted file mode 100644 index e838bb0274..0000000000 --- a/reference/eio/functions/eio-busy.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - eio_busy - Augmente artificiellement la charge. Utile dans le cadre de tests - - - - &reftitle.description; - - resourceeio_busy - intdelay - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - La fonction eio_busy augmente artificiellement la charge - en prenant un nombre delay de secondes - à s'exécuter. Peut être utile pour le débogage, ou les tests. - - - - - &reftitle.parameters; - - - delay - - - Le délai, en secondes. - - - - - pri - - &eio.request.pri.values; - - - - callback - - - Cette fonction de rappel est appelée lorsque toutes les - requêtes du groupe sont terminées. - - - - - data - - - Variable arbitraire passée à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - La fonction eio_busy - retourne une ressource de requête en cas de succès,&return.falseforfailure;. - - - - &reftitle.seealso; - - eio_nop - - - - - diff --git a/reference/eio/functions/eio-cancel.xml b/reference/eio/functions/eio-cancel.xml deleted file mode 100644 index 68b68bd355..0000000000 --- a/reference/eio/functions/eio-cancel.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - eio_cancel - Annule une requête - - - - &reftitle.description; - - voideio_cancel - resourcereq - - - La fonction eio_cancel - annule une requête spécifiée par - req. - - - - - &reftitle.parameters; - - - req - - - La ressource de la requête. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraire passée à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple avec <function>eio_cancel</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_grp_cancel - - - - - diff --git a/reference/eio/functions/eio-chmod.xml b/reference/eio/functions/eio-chmod.xml deleted file mode 100644 index efaa9d7a22..0000000000 --- a/reference/eio/functions/eio-chmod.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - eio_chmod - Modifie les permissions d'un fichier/dossier - - - - &reftitle.description; - - resourceeio_chmod - stringpath - intmode - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - La fonction eio_chmod modifie - les permissions d'un fichier ou d'un dossier. Les - nouvelles permissions sont spécifiées par - le paramètre mode. - - - - - - &reftitle.parameters; - - - path - - - Chemin vers le fichier ou le dossier cible. - - &eio.warn.relpath; - - - - mode - - - Les nouvelles permissions, c.-à-d. 0644. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraire à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - La fonction eio_chmod - retourne la ressource de requête en cas de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_chown - - - - - diff --git a/reference/eio/functions/eio-chown.xml b/reference/eio/functions/eio-chown.xml deleted file mode 100644 index 53c34f7448..0000000000 --- a/reference/eio/functions/eio-chown.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - eio_chown - Modifie le propriétaire d'un fichier/dossier - - - - &reftitle.description; - - resourceeio_chown - stringpath - intuid - intgid-1 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_chown modifie le propriétaire d'un fichier ou d'un - dossier. Le nouveau propriétaire est spécifié par uid, - et le groupe par gid. - - - - - &reftitle.parameters; - - - path - - - Chemin vers le fichier, ou le dossier. - - &eio.warn.relpath; - - - - uid - - - ID de l'utilisateur. Il sera ignoré si défini à -1. - - - - - gid - - - ID du groupe. Il sera ignoré si défini à -1. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraire à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_chown retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - - &reftitle.seealso; - - eio_chmod - - - - - diff --git a/reference/eio/functions/eio-close.xml b/reference/eio/functions/eio-close.xml deleted file mode 100644 index 45dea090e4..0000000000 --- a/reference/eio/functions/eio-close.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - eio_close - Ferme un fichier - - - - &reftitle.description; - - resourceeio_close - mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_close ferme un fichier spécifié par - le paramètre fd. - - - - - - &reftitle.parameters; - - - fd - - - Un flux, une ressource de socket, - ou un descripteur de fichier. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraire à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_close retourne la ressource demandée en cas - de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_open - - - - - diff --git a/reference/eio/functions/eio-custom.xml b/reference/eio/functions/eio-custom.xml deleted file mode 100644 index f1f54a794d..0000000000 --- a/reference/eio/functions/eio-custom.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - eio_custom - Exécute une demande personnalisée comme l'appel à une des fonctions eio_* - - - - &reftitle.description; - - resourceeio_custom - callableexecute - intpri - callablecallback - mixeddataNULL - - - eio_custom exécute une fonction personnalisée - spécifiée par le paramètre execute et la traitant - juste comme les autres fonctions eio_*. - - - - - - - &reftitle.parameters; - - - execute - - - Spécifie la fonction demandée, qui doit correspondre au prototype suivant : - - - callback est la fonction de rappel qui doit correspondre au prototype suivant : - - - data représente les données passées à - execute via l'argument data - sans modification de la valeur result retournée par execute - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraire à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_custom retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - - - &reftitle.examples; - - Exemple avec <function>eio_custom</function> - - 1001, - 'data_modified' => "mes données personnalisées", - ); - - return $result; -} - -$data = "mes données personnalisées"; -$req = eio_custom("my_custom", EIO_PRI_DEFAULT, "my_custom_callback", $data); -var_dump($req); -eio_event_loop(); -?> -]]> - -&example.outputs.similar; - - - - - - - - diff --git a/reference/eio/functions/eio-dup2.xml b/reference/eio/functions/eio-dup2.xml deleted file mode 100644 index ddeed0acd5..0000000000 --- a/reference/eio/functions/eio-dup2.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - eio_dup2 - Duplique un descripteur de fichier - - - - &reftitle.description; - - resourceeio_dup2 - mixedfd - mixedfd2 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - eio_dup2 duplique un descripteur de fichier. - - - - - - &reftitle.parameters; - - - fd - - - Flux source, ressource de socket, ou descripteur de fichier numérique - - - - - fd2 - - - Flux cible, ressource de socket, ou descripteur de fichier numérique - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraire à passer à la fonction - de rappel callback. - - - - - - - - &reftitle.returnvalues; - - eio_dup2 retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-event-loop.xml b/reference/eio/functions/eio-event-loop.xml deleted file mode 100644 index 5dcb9748d2..0000000000 --- a/reference/eio/functions/eio-event-loop.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - eio_event_loop - Boucle libeio tant que les requêtes s'exécutent - - - - &reftitle.description; - - booleio_event_loop - - - - eio_event_loop boucle libeio - tant que les requêtes s'exécutent. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_event_loop - retourne &true; en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>eio_event_loop</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - - &reftitle.seealso; - - eio_poll - - - - - diff --git a/reference/eio/functions/eio-fallocate.xml b/reference/eio/functions/eio-fallocate.xml deleted file mode 100644 index c11ca295f6..0000000000 --- a/reference/eio/functions/eio-fallocate.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - eio_fallocate - Autorise l'appelant à manipuler directement l'espace disque alloué pour un fichier - - - - &reftitle.description; - - resourceeio_fallocate - mixedfd - intmode - intoffset - intlength - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - - eio_fallocate autorise l'appelant à manipuler directement - l'espace disque alloué pour le fichier spécifié par le descripteur de fichier - fd pour l'intervalle d'octets commençant à - offset et se prolongeant sur - length octets. - - - - Le fichier doit être ouvert en écriture - - La constante EIO_O_CREAT doit être un - OU logique avec EIO_O_WRONLY, ou - EIO_O_RDWR. - - - - - - - &reftitle.parameters; - - - fd - - - Un flux, une ressource de socket, - ou un descripteur de fichier, c.-à-d. retourné par la fonction - eio_open. - - - - - mode - - - Actuellement, un seul drapeau est supporté pour le mode : - EIO_FALLOC_FL_KEEP_SIZE (identique à la constante - POSIX FALLOC_FL_KEEP_SIZE). - - - - - offset - - - Spécifie le début de l'intervalle d'octets. - - - - - length - - - Spécifie la longueur de l'intervalle d'octets. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_fallocate retourne une ressource de la - requête en cas de succès,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-fchmod.xml b/reference/eio/functions/eio-fchmod.xml deleted file mode 100644 index 14f6a8fcd2..0000000000 --- a/reference/eio/functions/eio-fchmod.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - eio_fchmod - Modifie les permissions sur un fichier - - - - &reftitle.description; - - resourceeio_fchmod - mixedfd - intmode - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_fchmod modifie les permissions - sur le fichier spécifié par le descripteur de fichier - fd. - - - - - - &reftitle.parameters; - - - fd - - - Un flux, une ressource de socket, - ou un descripteur de fichier, c.-à-d. retourné par la fonction - eio_open. - - - - - mode - - - Les nouvelles permissions, c.-à-d. 0644. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_fchmod retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_fchown - - - - - diff --git a/reference/eio/functions/eio-fchown.xml b/reference/eio/functions/eio-fchown.xml deleted file mode 100644 index 0eaae57f34..0000000000 --- a/reference/eio/functions/eio-fchown.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - eio_fchown - Modifie le propriétaire du fichier - - - - &reftitle.description; - - resourceeio_fchown - mixedfd - intuid - intgid-1 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_fchown modifie le propriétaire - du fichier spécifié par le descripteur de fichier - fd. - - - - - - &reftitle.parameters; - - - fd - - - Un flux, une ressource de socket, - ou un descripteur de fichier. - - - - - uid - - - ID de l'utilisateur. Sera ignoré si vaut -1. - - - - - gid - - - ID du groupe. Sera ignoré si vaut -1. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires passées à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_fchown retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_fchmod - - - - - diff --git a/reference/eio/functions/eio-fdatasync.xml b/reference/eio/functions/eio-fdatasync.xml deleted file mode 100644 index 3d3922fd48..0000000000 --- a/reference/eio/functions/eio-fdatasync.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - eio_fdatasync - Synchronise le statut interne d'un fichier avec le périphérique de stockage - - - - &reftitle.description; - - resourceeio_fdatasync - mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_fdatasync synchronise le statut interne - d'un fichier avec le périphérique de stockage. - - - - - - &reftitle.parameters; - - - fd - - - Un flux, une ressource de socket, - ou un descripteur de fichier, c.-à-d. retourné par la fonction - eio_open. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraire à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_fdatasync retourne la ressource de la demande - en cas de succès,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-fstat.xml b/reference/eio/functions/eio-fstat.xml deleted file mode 100644 index ed87ab9b3a..0000000000 --- a/reference/eio/functions/eio-fstat.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - - eio_fstat - Récupère le statut d'un fichier - - - - &reftitle.description; - - resourceeio_fstat - mixedfd - intpri - callablecallback - mixeddata - - - eio_fstat retourne les informations quant au - statut d'un fichier dans l'argument result - de la fonction de rappel callback - - - - - - &reftitle.parameters; - - - fd - - - Un flux, une ressource de socket, - ou un descripteur de fichier. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_fstat retourne la ressource - demandée en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>eio_fstat</function> example - - $result, - 'file'=> $data - ); - // Demande les informations de statut - eio_fstat($result, EIO_PRI_DEFAULT, "my_res_cb", $d); - // Exécute les demandes - eio_event_loop(); -} - -// Ouvre le fichier temporaire -eio_open($tmp_filename, EIO_O_RDONLY, NULL, EIO_PRI_DEFAULT, - "my_open_cb", $tmp_filename); -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - int(2050) - ["st_ino"]=> - int(2489159) - ["st_mode"]=> - int(33188) - ["st_nlink"]=> - int(1) - ["st_uid"]=> - int(1000) - ["st_gid"]=> - int(100) - ["st_rdev"]=> - int(0) - ["st_blksize"]=> - int(4096) - ["st_blocks"]=> - int(0) - ["st_atime"]=> - int(1318239506) - ["st_mtime"]=> - int(1318239506) - ["st_ctime"]=> - int(1318239506) -} -]]> - - - - - - - &reftitle.seealso; - - eio_lstat - eio_stat - - - - - diff --git a/reference/eio/functions/eio-fstatvfs.xml b/reference/eio/functions/eio-fstatvfs.xml deleted file mode 100644 index 85ee6fee98..0000000000 --- a/reference/eio/functions/eio-fstatvfs.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - eio_fstatvfs - Récupère des statistiques sur le système de fichiers - - - - &reftitle.description; - - resourceeio_fstatvfs - mixedfd - intpri - callablecallback - mixeddata - - - eio_fstatvfs retourne des statistiques - sur le système de fichiers dans l'argument - result de la fonction de rappel - callback. - - - - - - &reftitle.parameters; - - - fd - - - Un descripteur de fichier d'un fichier contenu dans - le système de fichiers monté. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraire à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_fstatvfs retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_statvfs - - - - - diff --git a/reference/eio/functions/eio-fsync.xml b/reference/eio/functions/eio-fsync.xml deleted file mode 100644 index defa143188..0000000000 --- a/reference/eio/functions/eio-fsync.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - eio_fsync - Synchronise le statut interne d'un fichier avec le périphérique de stockage - - - - &reftitle.description; - - resourceeio_fsync - mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - Synchronise le statut interne d'un fichier avec le périphérique de stockage. - - - - - - &reftitle.parameters; - - - fd - - - Un flux, une ressource de socket, ou - un descripteur de fichier. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_fsync retourne la ressource demandée en - cas de succès,&return.falseforfailure;. - - - - - - &reftitle.seealso; - - eio_sync - - - - - diff --git a/reference/eio/functions/eio-ftruncate.xml b/reference/eio/functions/eio-ftruncate.xml deleted file mode 100644 index 38f4b02446..0000000000 --- a/reference/eio/functions/eio-ftruncate.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - eio_ftruncate - Tronque un fichier - - - - &reftitle.description; - - resourceeio_ftruncate - mixedfd - intoffset0 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_ftruncate tronque un fichier régulier décrit - par le descripteur fd à la position de - length octets. - - - - - - &reftitle.parameters; - - - fd - - - Un flux, une ressource de socket, ou - un descripteur de fichier. - - - - - offset - - - La position depuis le début du fichier. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_ftruncate retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - - &reftitle.seealso; - - eio_truncate - - - - - diff --git a/reference/eio/functions/eio-futime.xml b/reference/eio/functions/eio-futime.xml deleted file mode 100644 index 74f8db09d6..0000000000 --- a/reference/eio/functions/eio-futime.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - eio_futime - Modifie l'heure du dernier accès et de la dernière modification d'un fichier - - - - &reftitle.description; - - resourceeio_futime - mixedfd - floatatime - floatmtime - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - eio_futime modifie l'heure du dernier - accès et de la dernière modification d'un fichier. - - - - - - &reftitle.parameters; - - - fd - - - Un flux, une ressource de socket, - ou un descripteur de fichier, c.-à-d. retourné par la fonction - eio_open - - - - - atime - - - Heure du dernier accès. - - - - - mtime - - - Heure de la dernière modification. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_futime retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_utime - - - - - diff --git a/reference/eio/functions/eio-get-event-stream.xml b/reference/eio/functions/eio-get-event-stream.xml deleted file mode 100644 index db187b44e0..0000000000 --- a/reference/eio/functions/eio-get-event-stream.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - eio_get_event_stream - Récupère le flux représentant une variable utilisée dans les communications internes avec libeio - - - - &reftitle.description; - - mixedeio_get_event_stream - - - - eio_get_event_stream récupère un flux représentant - une variable utilisée dans les communications internes avec libeio. - Peut être utilisé pour lier avec des boucles d'événements fournies - par d'autres extensions PECL, par exemple - libevent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_get_event_stream retourne un flux en - cas de succès, &null; sinon. - - - - - &reftitle.examples; - - Utilisation d'eio avec libevent - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/eio/functions/eio-get-last-error.xml b/reference/eio/functions/eio-get-last-error.xml deleted file mode 100644 index ed9f3192b1..0000000000 --- a/reference/eio/functions/eio-get-last-error.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - eio_get_last_error - Retourne une chaîne décrivant la dernière erreur associée avec la ressource demandée - - - - &reftitle.description; - - stringeio_get_last_error - resourcereq - - - eio_get_last_error retourne une chaîne - décrivant la dernière erreur associée avec le paramètre - req. - - - - - &reftitle.parameters; - - - req - - - La ressource demandée. - - - - - - - - &reftitle.returnvalues; - - eio_get_last_error retourne une chaîne - décrivant la dernière erreur avec la ressource demandée - spécifiée par le paramètre req. - - &warn.experimental.func; - - - diff --git a/reference/eio/functions/eio-grp-add.xml b/reference/eio/functions/eio-grp-add.xml deleted file mode 100644 index 92692f94de..0000000000 --- a/reference/eio/functions/eio-grp-add.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - eio_grp_add - Ajoute une requête au groupe de requêtes - - - - &reftitle.description; - - voideio_grp_add - resourcegrp - resourcereq - - - eio_grp_add ajoute une requête au groupe - de requêtes. - - - - - - &reftitle.parameters; - - - grp - - - La ressource du groupe de requêtes, retournée par la fonction - eio_grp - - - - - req - - - La ressource de la requête - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Le regroupement des requêtes - 0); - - // Crée une requête eio_read() et l'ajoute dans le groupe - // Passe le descripteur de fichier à la fonction de rappel - $req = eio_read($result, 4, 0, - EIO_PRI_DEFAULT, "my_grp_file_read_callback", $result); - eio_grp_add($grp, $req); -} - -/* Sera appelé lorsque eio_read() aura terminé */ -function my_grp_file_read_callback($data, $result) { - global $grp; - - // Lit les octets - var_dump($result); - - // Crée une requête eio_close() et l'ajoute dans le groupe - // $data doit contenir le descripteur de fichier - $req = eio_close($data); - eio_grp_add($grp, $req); -} - -// Crée un groupe de requêtes -$grp = eio_grp("my_grp_done", $temp_filename); -var_dump($grp); - -// Crée une requête eio_open() et l'ajoute dans le groupe -$req = eio_open($temp_filename, EIO_O_RDWR | EIO_O_APPEND , NULL, - EIO_PRI_DEFAULT, "my_grp_file_opened_callback", NULL); -eio_grp_add($grp, $req); - -// Exécute les demandes -eio_event_loop(); -?> -]]> - &example.outputs.similar; - - - - - - &reftitle.seealso; - - eio_grp - eio_grp_cancel - eio_grp_limit - - - - - diff --git a/reference/eio/functions/eio-grp-cancel.xml b/reference/eio/functions/eio-grp-cancel.xml deleted file mode 100644 index 7a0cb4d70a..0000000000 --- a/reference/eio/functions/eio-grp-cancel.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - eio_grp_cancel - Annule un groupe de requêtes - - - - &reftitle.description; - - voideio_grp_cancel - resourcegrp - - - eio_grp_cancel annule un groupe - de requêtes spécifié par la ressource de groupe - grp. - - - - - - &reftitle.parameters; - - - grp - - - La ressource du groupe de requêtes retournée par la fonction - eio_grp. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_grp - eio_grp_add - - - - - diff --git a/reference/eio/functions/eio-grp-limit.xml b/reference/eio/functions/eio-grp-limit.xml deleted file mode 100644 index 25ef4650f6..0000000000 --- a/reference/eio/functions/eio-grp-limit.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - eio_grp_limit - Définit la limite d'un groupe - - - - &reftitle.description; - - voideio_grp_limit - resourcegrp - intlimit - - - Limite le nombre de requêtes dans un groupe de requêtes. - - - - - - &reftitle.parameters; - - - grp - - - La ressource du groupe de requêtes. - - - - - limit - - - Nombre de requêtes maximales dans le groupe. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_grp_add - - - - - diff --git a/reference/eio/functions/eio-grp.xml b/reference/eio/functions/eio-grp.xml deleted file mode 100644 index 80fde25ee3..0000000000 --- a/reference/eio/functions/eio-grp.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - eio_grp - Crée un groupe de requêtes - - - - &reftitle.description; - - resourceeio_grp - callablecallback - stringdataNULL - - - eio_grp crée un groupe de requêtes. - - - - - - &reftitle.parameters; - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_grp retourne la ressource du groupe - de requêtes en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>eio_grp</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - eio_grp_cancel - eio_grp_add - - - - - diff --git a/reference/eio/functions/eio-init.xml b/reference/eio/functions/eio-init.xml deleted file mode 100644 index 5c8004554e..0000000000 --- a/reference/eio/functions/eio-init.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - eio_init - (Re-)initialise Eio - - - - &reftitle.description; - - voideio_init - - - - eio_init (re-)initialise Eio. - Elle alloue la mémoire pour les structures internes - de la bibliothèque libeio et Eio lui-même. - Il est possible d'appeler la fonction eio_init - avant d'utiliser les fonctions Eio. Sinon, cette fonction sera - appelée en interne dès lors qu'une fonction Eio sera appelée. - - - - Cette fonction a été supprimée dans la version 3.0.0RC1 de l'extension eio - pour les versions de PHP 8 et ultérieures. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/eio/functions/eio-link.xml b/reference/eio/functions/eio-link.xml deleted file mode 100644 index 854b2dc907..0000000000 --- a/reference/eio/functions/eio-link.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - - eio_link - Crée un lien fort sur un fichier - - - - &reftitle.description; - - resourceeio_link - stringpath - stringnew_path - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_link crée le lien fort - new_path sur un fichier spécifié par - path. - - - - - - &reftitle.parameters; - - - path - - - Le chemin du fichier source. - - - - - new_path - - - Le chemin du fichier cible. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <function>eio_link</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_symlink - - - - - diff --git a/reference/eio/functions/eio-lstat.xml b/reference/eio/functions/eio-lstat.xml deleted file mode 100644 index 11f5bebe37..0000000000 --- a/reference/eio/functions/eio-lstat.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - - eio_lstat - Récupère le statut d'un fichier - - - - &reftitle.description; - - resourceeio_lstat - stringpath - intpri - callablecallback - mixeddataNULL - - - eio_lstat retourne les informations de statut - du fichier dans l'argument result de la fonction - de rappel callback - - - - - - &reftitle.parameters; - - - path - - - Le chemin du fichier. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_lstat retourne la ressource demandée - en cas de succès, ou &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>eio_lstat</function> - - -]]> - - &example.outputs.similar; - - - int(2050) - ["st_ino"]=> - int(2099197) - ["st_mode"]=> - int(33188) - ["st_nlink"]=> - int(1) - ["st_uid"]=> - int(1000) - ["st_gid"]=> - int(100) - ["st_rdev"]=> - int(0) - ["st_blksize"]=> - int(4096) - ["st_blocks"]=> - int(0) - ["st_atime"]=> - int(1318235777) - ["st_mtime"]=> - int(1318235777) - ["st_ctime"]=> - int(1318235777) -} -]]> - - - - - - - &reftitle.seealso; - - eio_stat - eio_fstat - - - - - diff --git a/reference/eio/functions/eio-mkdir.xml b/reference/eio/functions/eio-mkdir.xml deleted file mode 100644 index 841af443db..0000000000 --- a/reference/eio/functions/eio-mkdir.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - eio_mkdir - Crée un dossier - - - - &reftitle.description; - - resourceeio_mkdir - stringpath - intmode - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_mkdir crée un dossier avec les permissions - spécifiées par l'argument mode. - - - - - - &reftitle.parameters; - - - path - - - Chemin du nouveau dossier. - - - - - mode - - - Mode d'accès, c.-à-d. 0755 - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_mkdir retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>eio_mkdir</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_rmdir - - - - - diff --git a/reference/eio/functions/eio-mknod.xml b/reference/eio/functions/eio-mknod.xml deleted file mode 100644 index fcd8097db6..0000000000 --- a/reference/eio/functions/eio-mknod.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - - eio_mknod - Crée un fichier spécial ou ordinaire - - - - &reftitle.description; - - resourceeio_mknod - stringpath - intmode - intdev - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - eio_mknod crée un fichier spécial ou ordinaire. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - Chemin du nouveau nœud (fichier). - - - - - mode - - - Spécifie à la fois les permissions à utiliser et le type - de nœud à créer. Il doit être une combinaison (en utilisant - l'opérateur OR) d'un des types de fichier listés ci-dessous, - et les permissions pour le nouveau nœud (c.-à-d. 0640). - - Les types de fichier possibles sont : - EIO_S_IFREG(fichier régulier), - EIO_S_IFCHR(fichier de caractères), - EIO_S_IFBLK(fichier de bloc spécial), - EIO_S_IFIFO(FIFO - nommé pipe) et - EIO_S_IFSOCK(socket de domaine UNIX). - - Pour spécifier les permissions, les constantes EIO_S_I* - doivent être utilisées. - - - - - dev - - - Si le type de fichier est EIO_S_IFCHR ou - EIO_S_IFBLK, alors ce paramètre spécifie le - nombre majeur et mineur du nouveau fichier spécial de périphérique créé. - Sinon, le paramètre dev sera ignoré. Voir - la page du manuel de mknod(2) pour plus de détails. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_mknod retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>eio_mknod</function> - - -]]> - - &example.outputs.similar; - - - int(17) - [1]=> - int(2337608) - [2]=> - int(4096) - [3]=> - int(1) - [4]=> - int(1000) - [5]=> - int(100) - [6]=> - int(0) - [7]=> - int(0) - [8]=> - int(1318241261) - [9]=> - int(1318241261) - [10]=> - int(1318241261) - [11]=> - int(4096) - [12]=> - int(0) - ["dev"]=> - int(17) - ["ino"]=> - int(2337608) - ["mode"]=> - int(4096) - ["nlink"]=> - int(1) - ["uid"]=> - int(1000) - ["gid"]=> - int(100) - ["rdev"]=> - int(0) - ["size"]=> - int(0) - ["atime"]=> - int(1318241261) - ["mtime"]=> - int(1318241261) - ["ctime"]=> - int(1318241261) - ["blksize"]=> - int(4096) - ["blocks"]=> - int(0) -} -eio_mknod_ok -]]> - - - - - - &reftitle.seealso; - - eio_open - - - - - diff --git a/reference/eio/functions/eio-nop.xml b/reference/eio/functions/eio-nop.xml deleted file mode 100644 index 4eb0bafe89..0000000000 --- a/reference/eio/functions/eio-nop.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - eio_nop - Ne fait rien, mis à part le fait de parcourir l'ensemble du cycle des requêtes - - - - &reftitle.description; - - resourceeio_nop - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_nop ne fait rien, mis à part le fait - de parcourir l'ensemble du cycle des requêtes. Peut être utile pour - le débogage. - - - - - - &reftitle.parameters; - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_nop retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - - &reftitle.seealso; - - eio_busy - - - - - diff --git a/reference/eio/functions/eio-npending.xml b/reference/eio/functions/eio-npending.xml deleted file mode 100644 index e88e50a6e0..0000000000 --- a/reference/eio/functions/eio-npending.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - eio_npending - Retourne le nombre de requêtes terminées, mais non traitées - - - - &reftitle.description; - - inteio_npending - - - - eio_npending retourne le nombre de requêtes terminées, mais non traitées. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_npending retourne le nombre de requêtes terminées, - mais non traitées. - - - - - - &reftitle.seealso; - - eio_nreqs - eio_nready - eio_nthreads - - - - - diff --git a/reference/eio/functions/eio-nready.xml b/reference/eio/functions/eio-nready.xml deleted file mode 100644 index 1c77d32ee1..0000000000 --- a/reference/eio/functions/eio-nready.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - eio_nready - Retourne le nombre de requêtes pas encore gérées - - - - &reftitle.description; - - inteio_nready - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_nready retourne le nombre de requêtes pas encore gérées. - - - - - - &reftitle.seealso; - - eio_nreqs - eio_nthreads - - - - - diff --git a/reference/eio/functions/eio-nreqs.xml b/reference/eio/functions/eio-nreqs.xml deleted file mode 100644 index 48aed1428f..0000000000 --- a/reference/eio/functions/eio-nreqs.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - eio_nreqs - Retourne le nombre de requêtes restant à exécuter - - - - &reftitle.description; - - inteio_nreqs - - - - eio_nreqs peut être appelée - dans une boucle personnalisée appelant la fonction - eio_poll. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_nreqs retourne le nombre de requêtes restant à exécuter. - - - - - &reftitle.examples; - - Exemple avec <function>eio_nreqs</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_poll - eio_nready - - - - - diff --git a/reference/eio/functions/eio-nthreads.xml b/reference/eio/functions/eio-nthreads.xml deleted file mode 100644 index ba37ba74bc..0000000000 --- a/reference/eio/functions/eio-nthreads.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - eio_nthreads - Retourne le nombre de threads actuellement utilisés - - - - &reftitle.description; - - inteio_nthreads - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_nthreads retourne le nombre de threads actuellement utilisés. - - - - - - &reftitle.seealso; - - eio_npending - eio_nready - eio_nreqs - eio_set_max_idle - eio_set_max_parallel - eio_set_min_parallel - - - - - diff --git a/reference/eio/functions/eio-open.xml b/reference/eio/functions/eio-open.xml deleted file mode 100644 index 4002d75e1d..0000000000 --- a/reference/eio/functions/eio-open.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - eio_open - Ouvre un fichier - - - - &reftitle.description; - - resourceeio_open - stringpath - intflags - intmode - intpri - callablecallback - mixeddataNULL - - - eio_open ouvre un fichier spécifié par l'argument - path avec le mode d'accès spécifié par - l'argument mode et les - flags donnés. - - - - - - - &reftitle.parameters; - - - path - - - Chemin vers le fichier à ouvrir. - - - Avec quelques APIs (c.-à-d. PHP-FPM), l'appel - peut échouer si l'on ne spécifie pas le chemin complet. - - - - - - - flags - - - Une constante parmi les constantes EIO_O_*, - ou bien une combinaison de ces constantes. Les constantes - EIO_O_* ont la même signification que les - constantes correspondantes O_* définies dans - le fichier d'en-têtes C fnctl.h. Par défaut, vaut - EIO_O_RDWR. - - - - - mode - - - Une constante parmi les constantes EIO_S_I*, ou bien - une combinaison de ces constantes (via l'opérateur OR). - Les constantes ont la même signification que les constantes correspondantes - S_I* définies dans le fichier d'en-têtes C sys/stat.h. - Requis si un fichier est créé. Sinon, il sera ignoré. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_open retourne un descripteur de fichier - dans l'argument result de la fonction de - rappel callback en cas de succès ; - sinon, result vaudra -1. - - - - - &reftitle.examples; - - Exemple avec <function>eio_open</function> - - 0); - - if ($result > 0) { - // Ferme le fichier - eio_close($result, EIO_PRI_DEFAULT, "my_close_cb", $data); - eio_event_loop(); - } -} - -// Crée un nouveau fichier pour lecture et écriture -// N'autorise pas les groupes et autres à faire quoi que ce soit avec ce fichier -eio_open($temp_filename, EIO_O_CREAT | EIO_O_RDWR, EIO_S_IRUSR | EIO_S_IWUSR, - EIO_PRI_DEFAULT, "my_file_opened_callback", $temp_filename); -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_mknod - - - - - diff --git a/reference/eio/functions/eio-poll.xml b/reference/eio/functions/eio-poll.xml deleted file mode 100644 index 3b028ec782..0000000000 --- a/reference/eio/functions/eio-poll.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - eio_poll - Vérifie s'il reste des requêtes en cours d'exécution - - - - &reftitle.description; - - inteio_poll - - - - eio_poll peut être utilisé pour implémenter une boucle - d'événements spéciale. - Pour ceci, la fonction eio_nreqs peut être utilisée pour - tester s'il reste des requêtes à exécuter. - - - - - Applicable uniquement lors de l'implémentation d'une boucle - d'événements dans l'espace utilisateur. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Si une des invocations retourne une valeur différente de zéro, - cette valeur sera retournée. Sinon, la fonction retournera - 0. - - - - - &reftitle.examples; - - Exemple avec <function>eio_poll</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - eio_nreqs - - - - - diff --git a/reference/eio/functions/eio-read.xml b/reference/eio/functions/eio-read.xml deleted file mode 100644 index 8143f58e49..0000000000 --- a/reference/eio/functions/eio-read.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - - eio_read - Lit un descripteur de fichier à une position donnée - - - - &reftitle.description; - - resourceeio_read - mixedfd - intlength - intoffset - intpri - callablecallback - mixeddataNULL - - - eio_read lit jusqu'à length octets - depuis le descripteur de fichier fd à la position - offset. Les octets lus sont stockés dans l'argument - result de la fonction de rappel callback. - - - - - - &reftitle.parameters; - - - fd - - - Un flux, une ressource de socket, ou - un descripteur de fichier - - - - - length - - - Nombre maximal d'octets à lire. - - - - - offset - - - Position dans le fichier. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_read stocke les octets lus dans l'argument - result de la fonction de rappel callback. - - - - - &reftitle.examples; - - Exemple avec <function>eio_read</function> - - 0) { - // Lit 5 octets en commençant par le troisième - eio_read($result, 5, 2, EIO_PRI_DEFAULT, "my_read_cb", $result); - eio_event_loop(); - } else { - // eio_open() a échoué - unlink($data); - } -} - -// Ouvre le fichier en lecture et en écriture -eio_open($temp_filename, EIO_O_RDWR, NULL, - EIO_PRI_DEFAULT, "my_file_opened_callback", $temp_filename); -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_open - eio_write - eio_close - eio_event_loop - - - - - diff --git a/reference/eio/functions/eio-readahead.xml b/reference/eio/functions/eio-readahead.xml deleted file mode 100644 index b74006c28e..0000000000 --- a/reference/eio/functions/eio-readahead.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - eio_readahead - Effectue un readahead sur le fichier dans le cache d'une page - - - - &reftitle.description; - - resourceeio_readahead - mixedfd - intoffset - intlength - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_readahead peuple le cache de la page avec - les données d'un fichier faisant que les prochains appels à la lecture - de ce fichier ne bloqueront pas l'I/O du disque. Voir la page - du manuel sur READAHEAD(2) pour plus de détails. - - - - - - &reftitle.parameters; - - - fd - - - Un flux, une ressource de socket ou un descripteur - de fichier. - - - - - offset - - - Point de départ à partir duquel les données seront lues. - - - - - length - - - Nombre d'octets à lire. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_readahead retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-readdir.xml b/reference/eio/functions/eio-readdir.xml deleted file mode 100644 index bac484d3f6..0000000000 --- a/reference/eio/functions/eio-readdir.xml +++ /dev/null @@ -1,485 +0,0 @@ - - - - - - - eio_readdir - Lit le contenu d'un dossier - - - - &reftitle.description; - - resourceeio_readdir - stringpath - intflags - intpri - callablecallback - stringdataNULL - - - Lit le contenu complet d'un dossier (via les appels systèmes - opendir, readdir et - closedir) et retourne soit les noms, soit un tableau - suivant la valeur de l'argument flags. - - - - - - &reftitle.parameters; - - - path - - - Chemin du dossier. - - - - - flags - - - Combinaison de constantes EIO_READDIR_*. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_readdir retourne la ressource demandée en cas - de succès,&return.falseforfailure;. - Définir l'argument - result de la fonction de rappel - callback suivant le drapeau - flags utilisé : - - - - - - - - EIO_READDIR_DENTS - (&integer;) - - - - Drapeau pour eio_readdir. - Si spécifié, l'argument de résultat de la fonction de rappel - devient un tableau contenant les clés suivantes : - 'names' - tableau de noms de dossiers - 'dents' - tableau de struct - eio_dirent - comme un tableau, mais contenant les clés spécifiques suivantes : - 'name' - le nom du dossier ; - 'type' - une des constantes EIO_DT_* ; - 'inode' - le numéro d'inode, si disponible, sinon ne sera pas spécifié ; - - - - - - EIO_READDIR_DIRS_FIRST - (&integer;) - - - - Lorsque ce drapeau est spécifié, les noms sont retournés dans un ordre - où les dossiers arrivent en premier, et ensuite dans un ordre de statut optimal. - - - - - - EIO_READDIR_STAT_ORDER - (&integer;) - - - - Lorsque ce drapeau est spécifié, alors les noms sont retournés dans un - ordre suivant le statut stat de chaque nœud. - Pour appliquer la fonction stat à tous - les fichiers du dossier, il sera plus rapide d'utiliser ce drapeau. - - - - - - EIO_READDIR_FOUND_UNKNOWN - (&integer;) - - - - - - - - - - - - Types de nœud : - - - - - - EIO_DT_UNKNOWN - (&integer;) - - - - Un nœud de type inconnu (souvent le cas). Une utilisation de la fonction - stat est nécessaire. - - - - - - EIO_DT_FIFO - (&integer;) - - - - Un nœud de type FIFO - - - - - - EIO_DT_CHR - (&integer;) - - - - Type de nœud - - - - - - EIO_DT_MPC - (&integer;) - - - - Un nœud de type périphérique à caractères multiplexés (v7+coherent) - - - - - - EIO_DT_DIR - (&integer;) - - - - Un nœud de type dossier - - - - - - EIO_DT_NAM - (&integer;) - - - - Un nœud de type fichier nommé spécialement Xenix - - - - - - EIO_DT_BLK - (&integer;) - - - - Type de nœud - - - - - - EIO_DT_MPB - (&integer;) - - - - Bloc multiplexé du périphérique (v7+coherent) - - - - - - EIO_DT_REG - (&integer;) - - - - Type de nœud - - - - - - EIO_DT_NWK - (&integer;) - - - - - - - - - EIO_DT_CMP - (&integer;) - - - - Un nœud de type spécial du réseau HP-UX - - - - - - EIO_DT_LNK - (&integer;) - - - - Un nœud de type lien - - - - - - EIO_DT_SOCK - (&integer;) - - - - Un nœud de type socket - - - - - - EIO_DT_DOOR - (&integer;) - - - - Un nœud de type Solaris door - - - - - - EIO_DT_WHT - (&integer;) - - - - Type de nœud - - - - - - EIO_DT_MAX - (&integer;) - - - - Valeur de type de nœud le plus haut possible - - - - - - - - - - - - &reftitle.examples; - - Exemple avec <function>eio_readdir</function> - - -]]> - - &example.outputs.similar; - - - array(7) { - [0]=> - string(7) "archive" - [1]=> - string(8) "articles" - [2]=> - string(8) "incoming" - [3]=> - string(7) "innfeed" - [4]=> - string(8) "outgoing" - [5]=> - string(8) "overview" - [6]=> - string(3) "tmp" - } - ["dents"]=> - array(7) { - [0]=> - array(3) - { - ["name"]=> - string(7) - "archive" - ["type"]=> - int(4) - ["inode"]=> - int(393265) - } - [1]=> - array(3) - { - ["name"]=> - string(8) - "articles" - ["type"]=> - int(4) - ["inode"]=> - int(393266) - } - [2]=> - array(3) - { - ["name"]=> - string(8) - "incoming" - ["type"]=> - int(4) - ["inode"]=> - int(393267) - } - [3]=> - array(3) - { - ["name"]=> - string(7) - "innfeed" - ["type"]=> - int(4) - ["inode"]=> - int(393269) - } - [4]=> - array(3) - { - ["name"]=> - string(8) - "outgoing" - ["type"]=> - int(4) - ["inode"]=> - int(393270) - } - [5]=> - array(3) - { - ["name"]=> - string(8) - "overview" - ["type"]=> - int(4) - ["inode"]=> - int(393271) - } - [6]=> - array(3) - { - ["name"]=> - string(3) - "tmp" - ["type"]=> - int(4) - ["inode"]=> - int(393272) - } - } -} -]]> - - - - - - - diff --git a/reference/eio/functions/eio-readlink.xml b/reference/eio/functions/eio-readlink.xml deleted file mode 100644 index 61b1af4b67..0000000000 --- a/reference/eio/functions/eio-readlink.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - eio_readlink - Lit la valeur d'un lien symbolique - - - - &reftitle.description; - - resourceeio_readlink - stringpath - intpri - callablecallback - mixeddataNULL - - - - - - - - - &reftitle.parameters; - - - path - - - Chemin source du lien symbolique - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_readlink retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>eio_readlink</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_symlink - - - - - diff --git a/reference/eio/functions/eio-realpath.xml b/reference/eio/functions/eio-realpath.xml deleted file mode 100644 index d3fe773ca5..0000000000 --- a/reference/eio/functions/eio-realpath.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - eio_realpath - Récupère le nom du chemin absolu canonisé - - - - &reftitle.description; - - resourceeio_realpath - stringpath - intpri - callablecallback - stringdataNULL - - - eio_realpath retourne le nom du chemin - absolu canonisé dans l'argument result - de la fonction de rappel callback. - - - - - - &reftitle.parameters; - - - path - - - Nom du chemin en version courte. - - - - - pri - - - - - - - - callback - - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <function>eio_realpath</function> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/eio/functions/eio-rename.xml b/reference/eio/functions/eio-rename.xml deleted file mode 100644 index 7acd3b8545..0000000000 --- a/reference/eio/functions/eio-rename.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - eio_rename - Modifie le nom ou le chemin d'un fichier - - - - &reftitle.description; - - resourceeio_rename - stringpath - stringnew_path - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_rename renomme ou déplace un fichier - vers un nouvel endroit. - - - - - - &reftitle.parameters; - - - path - - - Chemin source - - - - - new_path - - - Chemin cible - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_rename retourne la ressource demandée en cas - de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>eio_rename</function> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/eio/functions/eio-rmdir.xml b/reference/eio/functions/eio-rmdir.xml deleted file mode 100644 index 8fe2cdcc3b..0000000000 --- a/reference/eio/functions/eio-rmdir.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - eio_rmdir - Supprime un dossier - - - - &reftitle.description; - - resourceeio_rmdir - stringpath - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_rmdir supprime un dossier. - - - - - - &reftitle.parameters; - - - path - - - Chemin du dossier - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_rmdir retourne la ressource - demandée en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>eio_rmdir</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_mkdir - - - - - diff --git a/reference/eio/functions/eio-seek.xml b/reference/eio/functions/eio-seek.xml deleted file mode 100644 index b14e258e4d..0000000000 --- a/reference/eio/functions/eio-seek.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - eio_seek - Repositionne le curseur d'un fichier ouvert - - - - &reftitle.description; - - resourceeio_seek - mixedfd - intoffset - intwhence - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_seek repositionne le décalage du fichier ouvert associé au flux, - à l'instance de Socket, ou au descripteur de fichier spécifié par fd - à la valeur de l'argument offset conformément - à la directive whence. - - - - - &reftitle.parameters; - - - fd - - - Un flux, une Socket, ou un descripteur de fichier numérique - - - - - offset - - - Point de départ depuis lequel les données vont commencer à être lues. - - - - - whence - - - Les valeurs de whence sont : - - EIO_SEEK_SET - Positionne à offset octets. - EIO_SEEK_CUR - Positionne à la position actuelle plus offset. - EIO_SEEK_END - Positionne à la fin du fichier plus offset. - - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraire à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_seek retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-sendfile.xml b/reference/eio/functions/eio-sendfile.xml deleted file mode 100644 index e104367d07..0000000000 --- a/reference/eio/functions/eio-sendfile.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - eio_sendfile - Transfère des données entre des descripteurs de fichiers - - - - &reftitle.description; - - resourceeio_sendfile - mixedout_fd - mixedin_fd - intoffset - intlength - intpri - callablecallback - stringdata - - - eio_sendfile copie des données entre un descripteur - de fichier et un autre. Voir la page du manuel sur - SENDFILE(2) pour plus de détails. - - - - - - &reftitle.parameters; - - - out_fd - - - Flux, ressource de socket, ou descripteur de fichier pour la sortie. - Doit être ouvert en écriture. - - - - - in_fd - - - Flux, ressource de socket, ou descripteur de fichier pour l'entrée. - Doit être ouvert en lecture. - - - - - offset - - - Position dans le fichier source. - - - - - length - - - Nombre d'octets à copier. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_sendfile retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-set-max-idle.xml b/reference/eio/functions/eio-set-max-idle.xml deleted file mode 100644 index 3053352eae..0000000000 --- a/reference/eio/functions/eio-set-max-idle.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - eio_set_max_idle - Définit le nombre maximal de threads inactifs - - - - &reftitle.description; - - voideio_set_max_idle - intnthreads - - - - - - - - - &reftitle.parameters; - - - nthreads - - - Nombre de threads inactifs. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_nthreads - eio_set_min_parallel - eio_set_max_parallel - - - - - diff --git a/reference/eio/functions/eio-set-max-parallel.xml b/reference/eio/functions/eio-set-max-parallel.xml deleted file mode 100644 index 4dcd6bc1af..0000000000 --- a/reference/eio/functions/eio-set-max-parallel.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - eio_set_max_parallel - Définit le nombre maximal de threads en parallèle - - - - &reftitle.description; - - voideio_set_max_parallel - intnthreads - - - - - - - - - &reftitle.parameters; - - - nthreads - - - Nombre de threads en parallèle - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_nthreads - eio_set_max_idle - eio_set_min_parallel - - - - - diff --git a/reference/eio/functions/eio-set-max-poll-reqs.xml b/reference/eio/functions/eio-set-max-poll-reqs.xml deleted file mode 100644 index 5af25e166a..0000000000 --- a/reference/eio/functions/eio-set-max-poll-reqs.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - eio_set_max_poll_reqs - Définit le nombre maximal de requêtes traitées dans un cycle d'interrogation - - - - &reftitle.description; - - voideio_set_max_poll_reqs - intnreqs - - - - - - - - - &reftitle.parameters; - - - nreqs - - - Nombre de requêtes - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/eio/functions/eio-set-max-poll-time.xml b/reference/eio/functions/eio-set-max-poll-time.xml deleted file mode 100644 index d38882ee29..0000000000 --- a/reference/eio/functions/eio-set-max-poll-time.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - eio_set_max_poll_time - Définit la durée maximale d'une interrogation - - - - &reftitle.description; - - voideio_set_max_poll_time - floatnseconds - - - L'interrogation s'interrompt si elle prend plus de - nseconds secondes. - - - - - - &reftitle.parameters; - - - nseconds - - - Nombre de secondes - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/eio/functions/eio-set-min-parallel.xml b/reference/eio/functions/eio-set-min-parallel.xml deleted file mode 100644 index b8644730dd..0000000000 --- a/reference/eio/functions/eio-set-min-parallel.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - eio_set_min_parallel - Définit le nombre minimum de threads parallèles - - - - &reftitle.description; - - voideio_set_min_parallel - stringnthreads - - - - - - - - - &reftitle.parameters; - - - nthreads - - - Nombre de threads en parallèle. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - &reftitle.seealso; - - eio_nthreads - eio_set_max_idle - eio_set_max_parallel - - - - - diff --git a/reference/eio/functions/eio-stat.xml b/reference/eio/functions/eio-stat.xml deleted file mode 100644 index 4595409941..0000000000 --- a/reference/eio/functions/eio-stat.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - eio_stat - Récupère le statut d'un fichier - - - - &reftitle.description; - - resourceeio_stat - stringpath - intpri - callablecallback - mixeddataNULL - - - eio_stat retourne les informations de statut - d'un fichier dans l'argument result de la fonction - de rappel callback - - - - - - &reftitle.parameters; - - - path - - - Le chemin vers le fichier - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_stat retourne une ressource demandée en - cas de succès, ou &false; si une erreur survient. - En cas de succès, l'argument result de la fonction - de rappel callback recevra les données sous la - forme d'un tableau. - - - - - &reftitle.examples; - - Exemple avec <function>eio_stat</function> - - -]]> - - &example.outputs.similar; - - - int(2050) - ["st_ino"]=> - int(2489173) - ["st_mode"]=> - int(33188) - ["st_nlink"]=> - int(1) - ["st_uid"]=> - int(1000) - ["st_gid"]=> - int(100) - ["st_rdev"]=> - int(0) - ["st_blksize"]=> - int(4096) - ["st_blocks"]=> - int(0) - ["st_atime"]=> - int(1318250380) - ["st_mtime"]=> - int(1318250380) - ["st_ctime"]=> - int(1318250380) -} -]]> - - - - - - - &reftitle.seealso; - - eio_lstat - eio_fstat - - - - - diff --git a/reference/eio/functions/eio-statvfs.xml b/reference/eio/functions/eio-statvfs.xml deleted file mode 100644 index 848ac730fa..0000000000 --- a/reference/eio/functions/eio-statvfs.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - eio_statvfs - Récupère les statistiques du système de fichiers - - - - &reftitle.description; - - resourceeio_statvfs - stringpath - intpri - callablecallback - mixeddata - - - eio_statvfs retourne les informations quant - aux statistiques du système de fichiers dans l'argument - result de la fonction de rappel - callback - - - - - &reftitle.parameters; - - - path - - - Nom du chemin d'un fichier contenu dans le système de fichiers monté - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_statvfs retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - En cas de succès, l'argument result de la fonction - de rappel callback recevra les données sous la forme - d'un tableau. - - - - - &reftitle.examples; - - Exemple avec <function>eio_statvfs</function> - - -]]> - - &example.outputs.similar; - - - int(4096) - ["f_frsize"]=> - int(4096) - ["f_blocks"]=> - int(262144) - ["f_bfree"]=> - int(262111) - ["f_bavail"]=> - int(262111) - ["f_files"]=> - int(1540815) - ["f_ffree"]=> - int(1540743) - ["f_favail"]=> - int(1540743) - ["f_fsid"]=> - int(0) - ["f_flag"]=> - int(4102) - ["f_namemax"]=> - int(255) -} -]]> - - - - - - - diff --git a/reference/eio/functions/eio-symlink.xml b/reference/eio/functions/eio-symlink.xml deleted file mode 100644 index 555ed03aad..0000000000 --- a/reference/eio/functions/eio-symlink.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - eio_symlink - Crée un lien symbolique - - - - &reftitle.description; - - resourceeio_symlink - stringpath - stringnew_path - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - eio_symlink crée un lien symbolique - new_path vers le chemin path. - - - - - - &reftitle.parameters; - - - path - - - Chemin source - - - - - new_path - - - Chemin cible - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_symlink retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>eio_symlink</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_link - - - - - diff --git a/reference/eio/functions/eio-sync-file-range.xml b/reference/eio/functions/eio-sync-file-range.xml deleted file mode 100644 index aa51c48c9f..0000000000 --- a/reference/eio/functions/eio-sync-file-range.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - eio_sync_file_range - Synchronise un segment de fichier avec le disque - - - - &reftitle.description; - - resourceeio_sync_file_range - mixedfd - intoffset - intnbytes - intflags - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_sync_file_range permet un contrôle fin lors - de la synchronisation d'un fichier ouvert spécifié par le descripteur - de fichier fd avec le disque. - - - - - - &reftitle.parameters; - - - fd - - - Le descripteur de fichier. - - - - - offset - - - La position de début d'intervalle à partir de laquelle la synchronisation doit s'effectuer. - - - - - nbytes - - - Spécifie la longueur de l'intervalle à synchroniser, en octets. - Si nbytes vaut zéro, alors tous les octets - depuis la position offset jusqu'à la fin du fichier - seront synchronisés. - - - - - flags - - - Un masque. Peut inclure n'importe quelle valeur suivante : - EIO_SYNC_FILE_RANGE_WAIT_BEFORE, - EIO_SYNC_FILE_RANGE_WRITE, - EIO_SYNC_FILE_RANGE_WAIT_AFTER. - Ces drapeaux ont la même signification que leurs équivalents - SYNC_FILE_RANGE_* (voir la page du manuel - sur SYNC_FILE_RANGE(2)). - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_sync_file_range retourne la ressource demandée, - en cas de succès,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-sync.xml b/reference/eio/functions/eio-sync.xml deleted file mode 100644 index b6c8f46637..0000000000 --- a/reference/eio/functions/eio-sync.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - eio_sync - Valide le cache du buffer sur le disque - - - - &reftitle.description; - - resourceeio_sync - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_sync retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-syncfs.xml b/reference/eio/functions/eio-syncfs.xml deleted file mode 100644 index e1155d7511..0000000000 --- a/reference/eio/functions/eio-syncfs.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - eio_syncfs - Appelle la fonction système Linux syncfs, si disponible - - - - &reftitle.description; - - resourceeio_syncfs - mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - - - - - - &reftitle.parameters; - - - fd - - - Le descripteur de fichier. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_syncfs retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - - diff --git a/reference/eio/functions/eio-truncate.xml b/reference/eio/functions/eio-truncate.xml deleted file mode 100644 index 045258fa36..0000000000 --- a/reference/eio/functions/eio-truncate.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - eio_truncate - Tronque un fichier - - - - &reftitle.description; - - resourceeio_truncate - stringpath - intoffset0 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_truncate tronque le fichier régulier nommé - par le chemin path à une taille de - length octets. - - - - - - &reftitle.parameters; - - - path - - - Chemin vers le fichier. - - - - - offset - - - Position depuis le début du fichier. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_truncate retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_ftruncate - - - - - diff --git a/reference/eio/functions/eio-unlink.xml b/reference/eio/functions/eio-unlink.xml deleted file mode 100644 index af75476e86..0000000000 --- a/reference/eio/functions/eio-unlink.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - eio_unlink - Supprime un nom et éventuellement, le fichier qui s'y réfère - - - - &reftitle.description; - - resourceeio_unlink - stringpath - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_unlink supprime un nom depuis le système de fichiers. - - - - - - &reftitle.parameters; - - - path - - - Chemin vers le fichier. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_unlink retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-utime.xml b/reference/eio/functions/eio-utime.xml deleted file mode 100644 index 31f1b32c18..0000000000 --- a/reference/eio/functions/eio-utime.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - eio_utime - Modifie l'heure du dernier accès et de la dernière modification d'un fichier - - - - &reftitle.description; - - resourceeio_utime - stringpath - floatatime - floatmtime - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - - - - - - &reftitle.parameters; - - - path - - - Chemin vers le fichier. - - - - - atime - - - Heure du dernier accès. - - - - - mtime - - - Heure de dernière modification. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_utime retourne la ressource demandée - en cas de succès,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_futime - - - - - diff --git a/reference/eio/functions/eio-write.xml b/reference/eio/functions/eio-write.xml deleted file mode 100644 index 7ac0c1dbda..0000000000 --- a/reference/eio/functions/eio-write.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - eio_write - Écrit dans un fichier - - - - &reftitle.description; - - resourceeio_write - mixedfd - stringstr - intlength0 - intoffset0 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_write écrit length - octets depuis le paramètre str à la position - offset depuis le début du fichier. - - - - - - &reftitle.parameters; - - - fd - - - Un flux, une ressource de socket, ou - un descripteur de fichier, c.-à-d. retourné par la - fonction eio_open - - - - - str - - - Chaîne de caractères source. - - - - - length - - - Nombre maximum d'octets à écrire. - - - - - offset - - - Position depuis le début du fichier. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitraires à passer à la fonction de rappel - callback. - - - - - - - - &reftitle.returnvalues; - - eio_write retourne la ressource demandée, - &return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_open - - - - - diff --git a/reference/eio/reference.xml b/reference/eio/reference.xml deleted file mode 100644 index 0d4b02be40..0000000000 --- a/reference/eio/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; Eio - - &reference.eio.entities.functions; - - - - diff --git a/reference/eio/setup.xml b/reference/eio/setup.xml deleted file mode 100644 index 0dead90c48..0000000000 --- a/reference/eio/setup.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - &reftitle.setup; - -
- &reftitle.required; - - Cette extension contient la bibliothèque - libeio. Aussi, il n'y a pas - à l'installer séparément. - -
- - - &reference.eio.configure; - - - -
- &reftitle.resources; - - Il y a deux types de ressources dans cette extension : les demandes, - et les groupes de demandes. - -
- - - - diff --git a/reference/ev/book.xml b/reference/ev/book.xml deleted file mode 100644 index e761433fe8..0000000000 --- a/reference/ev/book.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Ev - Ev - - &reftitle.intro; - - Cette extension fournit une interface à la bibliothèque - libev, une boucle d'événements - hautement performante, écrite en C. - - - ¬e.no-windows.extension; - - - Libev est une boucle d'événements : elle enregistre - un intérêt pour certains événements (comme un descripteur de fichier - devenu lisible, ou encore un délai d'attente maximal qui survient), - elle va gérer les sources de ces événements, et fournir le programme - avec ces événements. - - - Pour réaliser cela, elle va prendre un contrôle plus ou moins total - du processus (ou Thread) en exécutant un gestionnaire de boucle - d'événements, puis va les communiquer via un mécanisme de fonction - de rappel. - - - L'enregistrement d'intérêts pour certains événements se fait via des - observateurs, puis, redonne la main à libev en démarrant ces - observateurs. - - - Pour plus de détails, se reporter à la - documentation de libev. - - - - &reference.ev.setup; - &reference.ev.examples; - &reference.ev.watchers; - &reference.ev.watcher-callbacks; - &reference.ev.periodic-modes; - &reference.ev.ev; - &reference.ev.evcheck; - &reference.ev.evchild; - &reference.ev.evembed; - &reference.ev.evfork; - &reference.ev.evidle; - &reference.ev.evio; - &reference.ev.evloop; - &reference.ev.evperiodic; - &reference.ev.evprepare; - &reference.ev.evsignal; - &reference.ev.evstat; - &reference.ev.evtimer; - &reference.ev.evwatcher; - - - diff --git a/reference/ev/configure.xml b/reference/ev/configure.xml deleted file mode 100644 index 95aff7fd6b..0000000000 --- a/reference/ev/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;ev - - - Pour plus d'informations concernant l'installation manuelle, - se reporter au fichier INSTALL.md inclus - dans les sources du paquet. - -
- diff --git a/reference/ev/ev.xml b/reference/ev/ev.xml deleted file mode 100644 index 1a876717fe..0000000000 --- a/reference/ev/ev.xml +++ /dev/null @@ -1,800 +0,0 @@ - - - - - La classe Ev - Ev - - -
- &reftitle.intro; - - La classe Ev est une classe statique fournissant l'accès à la boucle par défaut - ainsi qu'à quelques opérations communes. - -
- -
- &reftitle.classsynopsis; - - - - - Ev - - - - - final - Ev - - - - &Constants; - - - const - int - Ev::FLAG_AUTO - 0 - - - const - int - Ev::FLAG_NOENV - 16777216 - - - const - int - Ev::FLAG_FORKCHECK - 33554432 - - - const - int - Ev::FLAG_NOINOTIFY - 1048576 - - - const - int - Ev::FLAG_SIGNALFD - 2097152 - - - const - int - Ev::FLAG_NOSIGMASK - 4194304 - - - const - int - Ev::RUN_NOWAIT - 1 - - - const - int - Ev::RUN_ONCE - 2 - - - const - int - Ev::BREAK_CANCEL - 0 - - - const - int - Ev::BREAK_ONE - 1 - - - const - int - Ev::BREAK_ALL - 2 - - - const - int - Ev::MINPRI - -2 - - - const - int - Ev::MAXPRI - 2 - - - const - int - Ev::READ - 1 - - - const - int - Ev::WRITE - 2 - - - const - int - Ev::TIMER - 256 - - - const - int - Ev::PERIODIC - 512 - - - const - int - Ev::SIGNAL - 1024 - - - const - int - Ev::CHILD - 2048 - - - const - int - Ev::STAT - 4096 - - - const - int - Ev::IDLE - 8192 - - - const - int - Ev::PREPARE - 16384 - - - const - int - Ev::CHECK - 32768 - - - const - int - Ev::EMBED - 65536 - - - const - int - Ev::CUSTOM - 16777216 - - - const - int - Ev::ERROR - 2147483648 - - - const - int - Ev::BACKEND_SELECT - 1 - - - const - int - Ev::BACKEND_POLL - 2 - - - const - int - Ev::BACKEND_EPOLL - 4 - - - const - int - Ev::BACKEND_KQUEUE - 8 - - - const - int - Ev::BACKEND_DEVPOLL - 16 - - - const - int - Ev::BACKEND_PORT - 32 - - - const - int - Ev::BACKEND_ALL - 63 - - - const - int - Ev::BACKEND_MASK - 65535 - - - &Methods; - - - -
- -
- &reftitle.constants; - - - Drapeaux passés pour créer une boucle : - - - - - Ev::FLAG_AUTO - - - - La valeur par défaut des drapeaux - - - - - - Ev::FLAG_NOENV - - - - Si ce drapeau est utilisé (ou que le programme exécute - setuid ou setgid), libev - ne va pas regarder la variable d'environnement - LIBEV_FLAGS. Sinon (comportement par défaut), - LIBEV_FLAGS va écraser complètement le - drapeau s'il est trouvé. Utile pour des tests de performance - et pour la recherche de bogues. - - - - - - Ev::FLAG_FORKCHECK - - - - Fait que libev va vérifier si un fork existe à chaque itération, - au lieu d'appeler manuellement la méthode - EvLoop::fork. Ce mécanisme fonctionne - en appelant getpid() à chaque itération de - la boucle, et ainsi, va ralentir la boucle d'événements qui - possèdent beaucoup d'itérations, mais habituellement, - ce ralentissement n'est pas notable. La configuration de ce drapeau - ne peut pas être écrasée ou spécifiée dans la variable - d'environnement LIBEV_FLAGS. - - - - - - Ev::FLAG_NOINOTIFY - - - - Lorsque ce drapeau est spécifié, libev - ne va pas tenter d'utiliser l'API inotify - pour ces watchers - ev_stat. - Ce drapeau peut être utile pour conserver les descripteurs de - fichiers inotify, sachant que sinon, chaque boucle utilisant les - watchers ev_stat va consommer un gestionnaire - inotify. - - - - - - Ev::FLAG_SIGNALFD - - - - Lorsque ce drapeau est spécifié, libev - va tenter d'utiliser l'API signalfd - pour ces watchers - ev_signal - (et - ev_child). - Cette API délivre les signaux de façon synchrone, ce qui - la rend plus rapide, et peut permettre la récupération des données - des signaux en attente. Elle peut également simplifier la gestion - des signaux avec les threads, sachant que les signaux sont des - propriétés bloquées dans les threads. Signalfd - ne sera pas utilisé par défaut. - - - - - - Ev::FLAG_NOSIGMASK - - - - Lorsque ce drapeau est spécifié, libev - ne va pas modifier le masque du signal. Ceci signifie - qu'il faut s'assurer que les signaux sont déverrouillés - avant de les recevoir. - - - Ce comportement est utile pour la gestion personnalisée des signaux, - ou la gestion des signaux uniquement dans des threads spécifiques. - - - - - - - - Drapeaux à passer à - Ev::run, - ou à EvLoop::run - - - - - Ev::RUN_NOWAIT - - - - Signifie que la boucle d'événements va regarder si de nouveaux - événements sont présents, va gérer ces nouveaux événements, - et tous les événements spéciaux, mais ne va pas attendre et - bloquer le processus dans le cas où il n'y a pas d'événement, - et va retourner après une itération de la boucle. Il est parfois - utile de placer en file et gérer les nouveaux événements - pendant de longs calculs, et ce, pour garder le programme actif. - - - - - - Ev::RUN_ONCE - - - - Signifie que la boucle d'événements va regarder si de nouveaux - événements sont présents (et attendre, si nécessaire), et va les - gérer, eux et les spéciaux. Elle va bloquer le processus tant qu'au - moins un événement arrive (qui peut être un événement interne à libev, - aussi, il n'est pas garanti qu'une fonction de rappel enregistrée par - l'utilisateur ne soit appelée), et va retourner après une itération - de la boucle. - - - - - - - - Drapeaux passés à - Ev::stop, - ou à - EvLoop::stop - - - - - Ev::BREAK_CANCEL - - - - Annule l'opération d'annulation. - - - - - - Ev::BREAK_ONE - - - - Retourne le plus profond appel à - Ev::run - (ou EvLoop::run). - - - - - - Ev::BREAK_ALL - - - - Retourne le plus proche appel à - Ev::run - (ou EvLoop::run). - - - - - - - - Priorités de Watcher : - - - - - Ev::MINPRI - - - - Priorité minimale autorisée pour un watcher. - - - - - - Ev::MAXPRI - - - - Priorité maximale autorisée pour un watcher. - - - - - - - - Masques d'octets d'événements (reçus) : - - - - - Ev::READ - - - - Le descripteur de fichier dans le watcher - EvIo est devenu accessible - en lecture. - - - - - - Ev::WRITE - - - - Le descripteur de fichier dans le watcher - EvIo est devenu accessible - en écriture. - - - - - - Ev::TIMER - - - - Le watcher EvTimer - a atteint son délai maximal d'attente. - - - - - - Ev::PERIODIC - - - - Le watcher EvPeriodic - a atteint son délai maximal d'attente. - - - - - - Ev::SIGNAL - - - - Un signal spécifié dans - EvSignal::__construct - a été reçu. - - - - - - Ev::CHILD - - - - Le pid spécifié dans - EvChild::__construct - a reçu une modification de statut. - - - - - - Ev::STAT - - - - Le chemin spécifié dans le watcher - EvStat a modifié ses - attributs. - - - - - - Ev::IDLE - - - - Le watcher EvIdle fonctionne lorsqu'il - n'a aucune autre tâche à faire avec les autres watchers. - - - - - - Ev::PREPARE - - - - Tous les watchers EvPrepare - sont appelés juste avant le démarrage de - Ev::run. Ainsi, les watchers - EvPrepare sont les derniers watchers - à être appelés avant le repos de la boucle d'événements, - ou la mise en file des nouveaux événements. - - - - - - Ev::CHECK - - - - Tous les watchers EvCheck - sont placés en file d'attente juste après que - Ev::run ait récupéré - les nouveaux événements, mais avant, toutes les - fonctions de rappel de tous les événements reçus - sont placées en file d'attente. Ainsi, les watchers - EvCheck seront appelés avant tout - autre watcher de même priorité ou de priorité plus basse - dans une itération de boucle d'événements. - - - - - - Ev::EMBED - - - - La boucle d'événements embarquée spécifiée dans le - watcher EvEmbed a besoin - de toute l'attention. - - - - - - Ev::CUSTOM - - - - Pas encore envoyé (ou utilisé) par - libev, mais peut être - librement utilisé par les utilisateurs - libev pour signaler les watchers - (c.-à-d. via la méthode EvWatcher::feed). - - - - - - Ev::ERROR - - - - Une erreur inconnue est survenue, le watcher s'est arrêté. Ceci peut - arriver car le watcher n'a pas pu être démarré proprement - car libev a dépassé la mémoire allouée, un - descripteur de fichier a été fermé, ou tout autre problème. - Libev considère ceci comme des bogues - de l'application. Voir aussi - l'anatomie - d'un watcher - - - - - - - - Drapeaux de Backend : - - - - - Ev::BACKEND_SELECT - - - - select(2) backend - - - - - - Ev::BACKEND_POLL - - - - poll(2) backend - - - - - - Ev::BACKEND_EPOLL - - - - Backend epoll(7) spécifique à Linux - pour, à la fois, les kernels avant et après 2.6.9. - - - - - - Ev::BACKEND_KQUEUE - - - - Backend kqueue utilisé sur la - plupart des systèmes BSD. Le watcher EvEmbed - peut être utilisé pour embarquer une boucle (avec le - backend kqueue) dans une autre. Actuellement, une boucle peut - tenter de créer une boucle d'événements avec le backend - kqueue et l'utiliser uniquement pour les - sockets. - - - - - - Ev::BACKEND_DEVPOLL - - - - Backend Solaris 8. Actuellement non implémenté. - - - - - - Ev::BACKEND_PORT - - - - Mécanisme de port d'événements Solaris avec un bon rendement. - - - - - - Ev::BACKEND_ALL - - - - Essaie tous les backends (y compris les corrompus). - Il n'est pas recommandé de l'utiliser explicitement. - Les opérateurs de bits devraient être appliqués ici - (c.-à-d. Ev::BACKEND_ALL & ~ - Ev::BACKEND_KQUEUE). - Utiliser la méthode - Ev::recommendedBackends ou ne - spécifier aucun backend. - - - - - - Ev::BACKEND_MASK - - - - Pas un backend, mais un masque pour sélectionner tous - les bits d'un backend depuis la valeur de - flags pour représenter dans un - masque n'importe quel backend (c.-à-d. lors de la modification - de la variable d'environnement LIBEV_FLAGS). - - - - - - - - - Pour la boucle par défaut, pendant la phase d'initialisation - du module, Ev enregistre des appels à - ev_loop_fork - via pthread_atfork (si disponible). - - - - - Il y a des méthodes fournissant l'accès à la - boucle d'événements par défaut - dans la classe Ev - (c.-à-d. Ev::iteration, - Ev::depth, etc.) Pour les - boucles personnalisées (créées avec - EvLoop::__construct), ces - valeurs peuvent être accessibles via les propriétés et les - méthodes correspondantes de la classe - EvLoop. - - - L'instance de la boucle d'événements par défaut peut être récupérée - via la méthode EvLoop::defaultLoop. - - -
- - - - &reference.ev.entities.ev; - - - diff --git a/reference/ev/ev/backend.xml b/reference/ev/ev/backend.xml deleted file mode 100644 index 64a9af7e36..0000000000 --- a/reference/ev/ev/backend.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Ev::backend - Retourne un entier décrivant le backend utilisé par libev - - - &reftitle.description; - - final - public - static - int - Ev::backend - - - - Retourne un entier décrivant le backend utilisé par libev. - Voir les - drapeaux de Backend. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un entier (masque de bits) décrivant le backend utilisé par - libev. - - - - &reftitle.seealso; - - - EvEmbed - - - Ev::embeddableBackends - - - Ev::recommendedBackends - - - Ev::supportedBackends - - - Les drapeaux de Backend - - - - - diff --git a/reference/ev/ev/depth.xml b/reference/ev/ev/depth.xml deleted file mode 100644 index a60fed4b6e..0000000000 --- a/reference/ev/ev/depth.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Ev::depth - Retourne la profondeur de récursion - - - &reftitle.description; - - final - public - static - int - Ev::depth - - - - Le nombre de fois où la méthode Ev::run - est entrée, moins le nombre de fois où la méthode - Ev::run est sortie normalement, en d'autres - termes, la profondeur de récursion. En dehors de - Ev::run, ce nombre vaut 0. - Dans une fonction de rappel, ce nombre vaut 1, - sauf si la méthode Ev::run est invoquée - récursivement (ou depuis un autre thread), auquel cas, il sera supérieur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - ev_depth retourne la profondeur de récursion - de la boucle par défaut. - - - - &reftitle.seealso; - - - Ev::iteration - - - - - diff --git a/reference/ev/ev/embeddablebackends.xml b/reference/ev/ev/embeddablebackends.xml deleted file mode 100644 index 90e71907c2..0000000000 --- a/reference/ev/ev/embeddablebackends.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - Ev::embeddableBackends - Retourne le jeu de backends qui sont encapsulés dans les autres boucles d'événements - - - &reftitle.description; - - final - public - static - int - Ev::embeddableBackends - - - - Retourne le jeu de backends qui sont encapsulés dans les autres boucles d'événements. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un masque de bits qui peut contenir les - drapeaux de backend - combinés avec l'opérateur OR bit à bit. - - - - &reftitle.examples; - - Encapsule une boucle créée avec le backend kqueue dans la boucle par défaut - - -]]> - - - - - &reftitle.seealso; - - - EvEmbed - - - Ev::recommendedBackends - - - Ev::supportedBackends - - - Les drapeaux de Backend - - - Les exemples - - - - - diff --git a/reference/ev/ev/feedsignal.xml b/reference/ev/ev/feedsignal.xml deleted file mode 100644 index 6c7ac27c8b..0000000000 --- a/reference/ev/ev/feedsignal.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ev::feedSignal - Simule la réception d'un signal - - - &reftitle.description; - - final - public - static - void - Ev::feedSignal - - int - signum - - - - Simule la réception d'un signal. Il est sécurisé d'appeler cette fonction - à n'importe quel moment, depuis n'importe quel contexte, y compris depuis - un gestionnaire de signaux, ou depuis un thread aléatoire. Sa principale - utilisation est de personnaliser le gestionnaire de signaux dans le processus. - - - Contrairement à la méthode Ev::feedSignalEvent, - cette méthode fonctionne quelle que soit la boucle qui a enregistré le signal. - - - - &reftitle.parameters; - - - - signum - - - - Numéro du signal. Voir la page man de signal(7) - pour plus de détails. Il est possible d'utiliser les constantes exportées - par l'extension pcntl. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::feedSignalEvent - - - - - diff --git a/reference/ev/ev/feedsignalevent.xml b/reference/ev/ev/feedsignalevent.xml deleted file mode 100644 index b926cf08d9..0000000000 --- a/reference/ev/ev/feedsignalevent.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Ev::feedSignalEvent - Simule un événement de signal dans la boucle par défaut - - - &reftitle.description; - - final - public - static - void - Ev::feedSignalEvent - - int - signum - - - - Simule un événement de signal dans la boucle par défaut. - Ev va réagir à cet appel comme si le signal spécifié par - le paramètre signal était survenu. - - - - &reftitle.parameters; - - - - signum - - - - Numéro du signal. Voir la page man de signal(7) - pour plus de détails. Voir aussi les constantes exportées par - l'extension pcntl. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::feedSignal - - - - - diff --git a/reference/ev/ev/iteration.xml b/reference/ev/ev/iteration.xml deleted file mode 100644 index aaee779b8d..0000000000 --- a/reference/ev/ev/iteration.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - Ev::iteration - Retourne le nombre de fois que la boucle d'événement par défaut - a été sollicitée pour un nouvel événement - - - &reftitle.description; - - final - public - static - int - Ev::iteration - - - - Retourne le nombre de fois que la boucle d'événement par défaut - a été sollicitée pour un nouvel événement. Peut être utile comme - compteur de génération. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne le nombre de sollicitations de la boucle d'événement - par défaut. - - - - &reftitle.seealso; - - - Ev::depth - - - - - diff --git a/reference/ev/ev/now.xml b/reference/ev/ev/now.xml deleted file mode 100644 index 480566267a..0000000000 --- a/reference/ev/ev/now.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Ev::now - Retourne le temps de démarrage de la dernière itération de la boucle - d'événement par défaut - - - &reftitle.description; - - final - public - static - float - Ev::now - - - - Retourne le temps de démarrage de la dernière itération de la boucle - d'événement par défaut. C'est le temps sur lequel les timers - (EvTimer et EvPeriodic) - se basent, et s'y référer est souvent plus rapide que d'appeler la méthode - Ev::time. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne le nombre de secondes représentant le temps de démarrage - de la dernière itération de la boucle d'événement par défaut. - - - - &reftitle.seealso; - - - Ev::nowUpdate - - - - - diff --git a/reference/ev/ev/nowupdate.xml b/reference/ev/ev/nowupdate.xml deleted file mode 100644 index d0e26f5ef6..0000000000 --- a/reference/ev/ev/nowupdate.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Ev::nowUpdate - Établit le temps courant en demandant au kernel ; met à jour le - temps retourné par Ev::now pendant l'exécution - - - &reftitle.description; - - final - public - static - void - Ev::nowUpdate - - - - Établit le temps courant en demandant au kernel ; met à jour le temps - retourné par la méthode Ev::now pendant - l'exécution. Ceci est une opération coûteuse, et est habituellement - effectuée automatiquement dans la méthode - Ev::run. - - - Cette méthode est rarement utile, mais lorsque des fonctions de rappel - d'événement s'exécutent pendant très longtemps sans entrer dans une - boucle d'événement, mettre à jour libev avec le - temps courant est une bonne idée. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::now - - - - - diff --git a/reference/ev/ev/recommendedbackends.xml b/reference/ev/ev/recommendedbackends.xml deleted file mode 100644 index 37c40357de..0000000000 --- a/reference/ev/ev/recommendedbackends.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Ev::recommendedBackends - Retourne un masque de bits de backends recommandés - pour la plateforme courante - - - &reftitle.description; - - final - public - static - int - Ev::recommendedBackends - - - - Retourne un jeu de tous les backends compilés dans ce binaire de - libev, et également recommandés pour cette - plateforme, ce qui signifie qu'ils devraient fonctionner pour la - plupart des types de descripteur de fichiers. Ce jeu est généralement - plus petit que celui retourné par la fonction - ev_supported_backends, sachant que, par exemple, - kqueue est cassé sur les systèmes BSD - et ne sera pas auto-détecté tant qu'il n'est pas requis explicitement. - C'est le jeu de backends que libev utilisera - lorsqu'aucun ne sera demandé explicitement. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un masque de bits contenant les - drapeaux des backends - combinés en utilisant l'opérateur OR bit à bit. - - - - &reftitle.examples; - - Encapsule une boucle dans une autre - - -]]> - - - - - &reftitle.seealso; - - - EvEmbed - - - Ev::embeddableBackends - - - Ev::supportedBackends - - - Les drapeaux de Backend - - - Les exemples - - - - - diff --git a/reference/ev/ev/resume.xml b/reference/ev/ev/resume.xml deleted file mode 100644 index ca34808128..0000000000 --- a/reference/ev/ev/resume.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ev::resume - Reprend la boucle d'événement par défaut précédemment stoppée - - - &reftitle.description; - - final - public - static - void - Ev::resume - - - - Les méthodes Ev::suspend et - Ev::resume suspendent et reprennent - une boucle. - - - Tous les watchers timer seront suspendus pendant la durée entre - la suspension et la reprise - et tous les watchers periodic seront - reprogrammés (et perdront tous les événements qui seront survenus - pendant le temps de cette suspension). - - - Après l'appel à la méthode Ev::suspend, - il n'est pas autorisé d'appeler une fonction sur la boucle fournie - autre que la méthode Ev::resume. - De plus, il n'est pas autorisé d'appeler la méthode - Ev::resume sans un précédent appel à la - méthode Ev::suspend. - - - L'appel à une suspension/reprise - a comme effet de bord de mettre à jour le temps de la boucle d'événement - (voir la méthode Ev::nowUpdate). - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::suspend - - - - - diff --git a/reference/ev/ev/run.xml b/reference/ev/ev/run.xml deleted file mode 100644 index 77e20745bd..0000000000 --- a/reference/ev/ev/run.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - Ev::run - Commence la vérification des événements et appelle les fonctions - de rappels pour la boucle par défaut - - - &reftitle.description; - - final - public - static - void - Ev::run - - int - flags - - - - Commence la vérification des événements et appelle les fonctions de rappel - pour la boucle par défaut. Retourne lorsqu'une fonction - de rappel appelle la méthode Ev::stop, ou lorsque - les drapeaux sont différents de zéro (auquel cas, la valeur retournée - sera &true;), ou bien lorsqu'il n'y a plus d'observateur actif qui - référence la boucle (EvWatcher::keepalive vaut - &true;), auquel cas, la valeur retournée sera &false;. La valeur retournée - peut généralement être interprétée comme ceci : - si &true;, il y a encore des travaux à faire. - - - - &reftitle.parameters; - - - - flags - - - - Le paramètre optionnel flags - peut être une des valeurs suivantes : - - - Liste des valeurs possibles de <parameter>flags</parameter> - - - - - - flags - - Description - - - - - - 0 - - Le comportement par défaut, décrit ci-dessus - - - - Ev::RUN_ONCE - - Bloque au plus un (mise en attente, mais ne boucle plus) - - - - Ev::RUN_NOWAIT - - Ne pas bloquer du tout (récupère/gère les événements - mais n'attend pas) - - - -
- - - Voir les - constantes de drapeaux d'exécution. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::stop - - - EvLoop::run - - - - - diff --git a/reference/ev/ev/sleep.xml b/reference/ev/ev/sleep.xml deleted file mode 100644 index d97d6be742..0000000000 --- a/reference/ev/ev/sleep.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - Ev::sleep - Bloque le processus pendant un nombre de secondes fourni - - - &reftitle.description; - - final - public - static - void - Ev::sleep - - float - seconds - - - - Bloque le processus pendant un nombre de secondes fourni. - - - - &reftitle.parameters; - - - - seconds - - - - Nombre fractionnaire de secondes - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/ev/stop.xml b/reference/ev/ev/stop.xml deleted file mode 100644 index 08600f679e..0000000000 --- a/reference/ev/ev/stop.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Ev::stop - Arrête la boucle d'événements par défaut - - - &reftitle.description; - - final - public - static - void - Ev::stop - - int - how - - - - Arrête la boucle d'événements par défaut. - - - - &reftitle.parameters; - - - - how - - - - Une constante - parmi les constantes Ev::BREAK_*. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::run - - - - - diff --git a/reference/ev/ev/supportedbackends.xml b/reference/ev/ev/supportedbackends.xml deleted file mode 100644 index a4424e8874..0000000000 --- a/reference/ev/ev/supportedbackends.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - Ev::supportedBackends - Retourne le jeu de backends supportés par la configuration courante de libev - - - &reftitle.description; - - final - public - static - int - Ev::supportedBackends - - - - Retourne le jeu de backends supportés par la configuration courante de libev. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un masque de bits qui peut contenir les - drapeaux de backend - combinés en utilisant l'opérateur OR bit à bit. - - - - &reftitle.examples; - - Boucle embarquée créée avec le backend kqueue dans la boucle par défaut - - -]]> - - - - - &reftitle.seealso; - - - EvEmbed - - - Ev::recommendedBackends - - - Ev::embeddableBackends - - - Les drapeaux de backend - - - Les exemples - - - - - diff --git a/reference/ev/ev/suspend.xml b/reference/ev/ev/suspend.xml deleted file mode 100644 index bd39a56518..0000000000 --- a/reference/ev/ev/suspend.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Ev::suspend - Suspend la boucle par défaut d'événements - - - &reftitle.description; - - final - public - static - void - Ev::suspend - - - - Les méthodes Ev::suspend et - Ev::resume suspendent et reprennent - la boucle par défaut. - - - Tous les minuteurs des observateurs seront mis en suspend entre une - suspension et une reprise, - et tous les observateurs périodiques - seront remis à jour (aussi, tous les événements survenus pendant - cette suspension seront perdus). - - - Après un appel à la méthode Ev::suspend, - il n'est pas autorisé d'appeler une fonction sur la boucle fournie - autre que la méthode Ev::resume. De même, - il n'est pas autorisé d'appeler la méthode Ev::resume - sans un précédent appel à la méthode Ev::suspend. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::resume - - - - - diff --git a/reference/ev/ev/time.xml b/reference/ev/ev/time.xml deleted file mode 100644 index 90fa2fe4f1..0000000000 --- a/reference/ev/ev/time.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Ev::time - Retourne le temps courant depuis l'époque Unix - - - &reftitle.description; - - final - public - static - float - Ev::time - - - - Retourne le temps courant depuis l'époque Unix. - Il est recommandé de plutôt utiliser la méthode Ev::now. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne le temps courant, en nombre de secondes, depuis l'époque Unix. - - - - &reftitle.seealso; - - - Ev::now - - - - - diff --git a/reference/ev/ev/verify.xml b/reference/ev/ev/verify.xml deleted file mode 100644 index e15c210247..0000000000 --- a/reference/ev/ev/verify.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Ev::verify - Effectue des vérifications internes de consistance (pour le débogage) - - - &reftitle.description; - - final - public - static - void - Ev::verify - - - - Effectue des vérifications internes de consistance (pour le débogage de - libev) et met fin au programme si une structure - de données corrompue a été trouvée. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evcheck.xml b/reference/ev/evcheck.xml deleted file mode 100644 index 7a5306b3c7..0000000000 --- a/reference/ev/evcheck.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - La classe EvCheck - EvCheck - - -
- &reftitle.intro; - - Les observateurs EvPrepare et - EvCheck sont habituellement utilisés ensemble. - L'observateur EvPrepare sera appelé avant les - blocs du processus, alors que l'observateur EvCheck - sera appelé après. - - - Il n'est pas autorisé d'appeler la méthode EvLoop::run - ou une méthode/fonction similaire qui entre dans la boucle de l'événement - courante depuis soit l'observateur EvPrepare, - soit l'observateur EvCheck. Toutefois, - cela est possible pour toutes les autres boucles que la courante. - La cause de cela est qu'il n'est pas nécessaire de vérifier la récursion - dans ces observateurs, c.-à-d. la séquence suivante sera toujours : - EvPrepare -> blocage -> EvCheck, - aussi, avoir un observateur pour chacun n'est pas utile, sachant qu'ils seront toujours appelés - ensemble lors de l'appel au blocage. - - - Le but primaire est d'intégrer d'autres mécanismes d'événements dans - la bibliothèque libev, avec une utilisation avancée. - Ils peuvent être utilisés, par exemple, pour surveiller les modifications - de variables, implémenter des observateurs personnalisés, intégrer net-snmp - ou une bibliothèque supplémentaire, et bien plus encore. Ils peuvent être aussi - utiles pour mettre en cache des données, et vouloir les afficher après - le blocage. - - - Il est recommandé de fournir une priorité haute à EvCheck - (Ev::MAXPRI) afin de s'assurer qu'il sera exécuté - avant tout autre observateur de la file (à contrario, peu importe pour - l'observateur EvPrepare). - - - De plus, les observateurs EvCheck ne doivent pas - activer/alimenter des événements. Bien que libev - supporte cela, ils peuvent être exécutés avant que les autres observateurs - EvCheck ne terminent leurs travaux. - -
- -
- &reftitle.classsynopsis; - - - - - EvCheck - - - - - EvCheck - - - extends - EvWatcher - - - - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- - - &reference.ev.entities.evcheck; - - - diff --git a/reference/ev/evcheck/construct.xml b/reference/ev/evcheck/construct.xml deleted file mode 100644 index a3279b122e..0000000000 --- a/reference/ev/evcheck/construct.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - EvCheck::__construct - Construit l'objet d'observation EvCheck - - - &reftitle.description; - - public - EvCheck::__construct - - callable - callback - - - mixed - data - - - int - priority - - - - Construit l'objet d'observation EvCheck. - - - - &reftitle.parameters; - - - - callback - - - - Voir les - fonctions de - rappel des observations. - - - - - - data - - - - Données personnalisées associées avec l'observateur. - - - - - - priority - - - - Priorité de l'observateur - - - - - - - - &reftitle.seealso; - - - EvPrepare - - - EvLoop::check - - - - - diff --git a/reference/ev/evcheck/createstopped.xml b/reference/ev/evcheck/createstopped.xml deleted file mode 100644 index 22eaa82d66..0000000000 --- a/reference/ev/evcheck/createstopped.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - EvCheck::createStopped - Crée une instance d'un observateur stoppé EvCheck - - - &reftitle.description; - - final - public - static - object - EvCheck::createStopped - - string - callback - - - string - data - - - string - priority - - - - Crée une instance d'un observateur stoppé EvCheck. - - - - &reftitle.parameters; - - - - callback - - - - Voir les - fonctions de rappel des - observateurs. - - - - - - data - - - - Données personnalisées à associer avec l'observateur. - - - - - - priority - - - - Priorité de l'observateur - - - - - - - &reftitle.returnvalues; - - Retourne l'objet EvCheck en cas de succès. - - - - &reftitle.seealso; - - - EvPrepare - - - - - diff --git a/reference/ev/evchild.xml b/reference/ev/evchild.xml deleted file mode 100644 index dc62ad0218..0000000000 --- a/reference/ev/evchild.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - La classe EvChild - EvChild - - -
- &reftitle.intro; - - Les watchers EvChild sont lancés lorsque le - processus reçoit un SIGCHLD en réponse à des - modifications de statut de fils (typiquement, lorsqu'un fils - meurt ou sort). Il est permis d'installer un watcher - EvChild après que le fils n'ait été forké - (ce qui implique qu'il a dû déjà exister), tant que la boucle - d'événements n'a pas débuté (ou continué depuis un watcher), c.-à-d. - forker puis, enregistrer immédiatement un watcher pour le fils est - la bonne méthode, mais forker et enregistrer un watcher après quelques - itérations de la boucle d'événements ou dans la prochaine invocation - de la fonction de rappel n'est pas la bonne méthode. - - - Il est seulement autorisé d'enregistrer des watchers - EvChild dans la - boucle par défaut. - -
- -
- &reftitle.classsynopsis; - - - - - EvChild - - - - - EvChild - - - extends - EvWatcher - - - - &Properties; - - public - pid - - - public - rpid - - - public - rstatus - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - pid - - - - Lecture seule. - L'ID du processus relatif - aux watchers, ou 0 signifiant tous les IDs - de processus. - - - - - - rpid - - - - Lecture seule. L'ID du processus qui a détecté - une modification de statut. - - - - - - rstatus - - - - Lecture seule. - Le statut de sortie du processus - causé par rpid. - - - - -
- - - - &reference.ev.entities.evchild; - - - diff --git a/reference/ev/evchild/construct.xml b/reference/ev/evchild/construct.xml deleted file mode 100644 index 95e8f3a599..0000000000 --- a/reference/ev/evchild/construct.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - EvChild::__construct - Construit l'objet d'observation EvChild - - - &reftitle.description; - - public - EvChild::__construct - - int - pid - - - bool - trace - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Construit l'objet d'observateur EvChild. - - - Appelle la fonction de rappel lorsqu'une modification de statut d'un processus - dont l'ID pid (ou de tout PID - s'il vaut 0) a été reçue (une modification de statut - survient lorsque le processus se termine ou est tué, ou lorsque le - paramètre trace vaut &true;, lorsque le processus - est stoppé ou continué). En d'autres termes, lorsque le processus - reçoit un SIGCHLD, Ev - va récupérer tous les statuts de sortie/d'attente pour tous les fils - modifiés/zombies et va appeler la fonction de rappel. - - - Il est valide d'installer un observateur sur le fils après qu'un - EvChild ne soit sorti, mais avant que la boucle - d'événement n'ait démarré sa prochaine itération. Par exemple, - d'abord, appelez fork, puis le nouveau processus - fils peut sortir, et uniquement là, un observateur - EvChild est installé sur le parent pour le - nouveau PID. - - - Il sera possible d'accéder aux statuts de sortie/de traçage ainsi qu'aux - pid en utilisant les propriétés - rstatus et rpid de l'objet d'observation. - - - Le nombre d'observateurs PID par PID - n'est pas limité. Ils seront tous appelés. - - - La méthode EvChild::createStopped - ne démarre (active) pas le nouvel observateur créé. - - - - &reftitle.parameters; - - - - pid - - - - Attend les modifications de statut des processus PID (ou tout processus - si PID vaut 0). - - - - - - trace - - - - Si vaut &false;, n'active l'observateur que lorsque le processus - se termine. Sinon (&true;), active l'observateur lorsque le - processus est stoppé ou continué. - - - - - - callback - - - - Voir les - fonctions de rappel des observateurs. - - - - - - data - - - - Données personnalisées associées avec l'observateur. - - - - - - priority - - - - Priorité de l'observateur - - - - - - - - &reftitle.seealso; - - - EvLoop::child - - - - - diff --git a/reference/ev/evchild/createstopped.xml b/reference/ev/evchild/createstopped.xml deleted file mode 100644 index 9702026f40..0000000000 --- a/reference/ev/evchild/createstopped.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - EvChild::createStopped - Crée une instance de l'observateur stoppé EvChild - - - &reftitle.description; - - final - public - static - object - EvChild::createStopped - - int - pid - - - bool - trace - - - callable - callback - - - mixed - data - - - int - priority - - - - Identique à EvChild::__construct, - mais ne démarre pas automatiquement l'observateur. - - - - &reftitle.parameters; - - - - pid - - - - Identique à celui utilisé pour - EvChild::__construct - - - - - - trace - - - - Identique à celui utilisé pour - EvChild::__construct - - - - - - callback - - - - Voir les fonctions - de rappel des observateurs. - - - - - - data - - - - Données personnalisées associées avec l'observateur. - - - - - - priority - - - - Priorité de - l'observateur - - - - - - - - &reftitle.returnvalues; - - - - - &reftitle.seealso; - - - EvChild::__construct - - - EvLoop::child - - - - - - diff --git a/reference/ev/evchild/set.xml b/reference/ev/evchild/set.xml deleted file mode 100644 index 5ea57dfdb6..0000000000 --- a/reference/ev/evchild/set.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - EvChild::set - Configure l'observateur - - - &reftitle.description; - - public - void - EvChild::set - - int - pid - - - bool - trace - - - - - - &reftitle.parameters; - - - - pid - - - - Identique à celui utilisé pour - EvChild::__construct - - - - - - trace - - - - Identique à celui utilisé pour - EvChild::__construct - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvChild::__construct - - - - - diff --git a/reference/ev/evembed.xml b/reference/ev/evembed.xml deleted file mode 100644 index 40189a4fb0..0000000000 --- a/reference/ev/evembed.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - La classe EvEmbed - EvEmbed - - -
- &reftitle.intro; - - Utilisé pour intégrer une boucle d'événements dans une autre. - -
- -
- &reftitle.classsynopsis; - - - - - EvEmbed - - - - - EvEmbed - - - extends - EvWatcher - - - - &Properties; - - public - embed - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - is_active - - - - - - - - data - - - - - - - - is_pending - - - - - - - - priority - - - - - - - - embed - - - - - - -
- - - - &reference.ev.entities.evembed; - - - diff --git a/reference/ev/evembed/construct.xml b/reference/ev/evembed/construct.xml deleted file mode 100644 index 9f826b5c1e..0000000000 --- a/reference/ev/evembed/construct.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - EvEmbed::__construct - Construit un objet EvEmbed - - - &reftitle.description; - - public - EvEmbed::__construct - - object - other - - - callable - callback - - - mixed - data - - - int - priority - - - - Il s'agit d'un type de watcher avancé qui permet d'intégrer une boucle - d'événement dans une autre (actuellement, seuls les événements IO sont - supportés dans la boucle interne, les autres types de watcher ne doivent - pas être utilisés). - - - Voir la - - documentation libev pour plus de détails. - - - Ce watcher est le plus utile sous les systèmes - BSD où kqueue n'est pas utilisé, - pour être capable de gérer un grand nombre de sockets. Voir l'exemple ci-dessous. - - - - &reftitle.parameters; - - - - other - - - - Une instance de EvLoop. La boucle à intégrer ; - elle doit être encapsulable (voir la méthode - Ev::embeddableBackends). - - - - - - callback - - - - Voir les - fonctions de rappel des Watcher. - - - - - - data - - - - Données personnalisées à associer avec le watcher. - - - - - - priority - - - - Priorité du Watcher - - - - - - - - &reftitle.examples; - - - Encapsulage d'une boucle créée avec le gestionnaire kqueue dans la boucle par défaut - - -]]> - - - - - &reftitle.seealso; - - - Ev::embeddableBackends - - - - - diff --git a/reference/ev/evembed/createstopped.xml b/reference/ev/evembed/createstopped.xml deleted file mode 100644 index be9685b48c..0000000000 --- a/reference/ev/evembed/createstopped.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - EvEmbed::createStopped - Crée un objet EvEmbed watcher stoppé - - - &reftitle.description; - - final - public - static - void - EvEmbed::createStopped - - object - other - - - callable - callback - - - mixed - data - - - int - priority - - - - Identique à la méthode - EvEmbed::__construct, mais ne démarre - pas automatiquement le watcher. - - - - &reftitle.parameters; - - - - other - - - - Identique au paramètre de la méthode - EvEmbed::__construct - - - - - - callback - - - - Voir les - fonctions de rappel des Watcher. - - - - - - data - - - - Données personnalisées à associer avec le watcher. - - - - - - priority - - - - Priorité du Watcher - - - - - - - &reftitle.returnvalues; - - Retourne un objet EvEmbed stoppé en cas de succès. - - - - &reftitle.seealso; - - - EvEmbed::__construct - - - Ev::embeddableBackends - - - - - diff --git a/reference/ev/evembed/set.xml b/reference/ev/evembed/set.xml deleted file mode 100644 index 122d586433..0000000000 --- a/reference/ev/evembed/set.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - EvEmbed::set - Configure le watcher - - - &reftitle.description; - - public - void - EvEmbed::set - - object - other - - - - Configure le watcher pour utiliser l'objet - other de la boucle d'événement. - - - - &reftitle.parameters; - - - - other - - - - Identique au paramètre de la méthode - EvEmbed::__construct - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evembed/sweep.xml b/reference/ev/evembed/sweep.xml deleted file mode 100644 index 0f3a823ad0..0000000000 --- a/reference/ev/evembed/sweep.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - EvEmbed::sweep - Balaye, une seule fois, et de façon non bloquante la boucle interne - - - &reftitle.description; - - public - void - EvEmbed::sweep - - - - Balaye, une seule fois, et de façon non bloquante la boucle interne. - Fonctionne de la même façon que ce qui suit, mais d'une façon plus - appropriée pour les boucles internes : - -start(Ev::RUN_NOWAIT); -?> -]]> - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvWatcher::start - - - - - diff --git a/reference/ev/evfork.xml b/reference/ev/evfork.xml deleted file mode 100644 index 6d21cc58a6..0000000000 --- a/reference/ev/evfork.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - La classe EvFork - EvFork - - -
- &reftitle.intro; - - Les watchers Fork sont appelés lorsqu'un - fork() a été détecté (habituellement, parce que - signalé à libev en appelant la méthode - EvLoop::fork). L'invocation est - faite avant que la boucle d'événements ne bloque le suivant - et avant l'appel des watchers EvCheck, - et seulement dans le fils après le fork. Il est à noter que si quelqu'un - appelle EvLoop::fork dans le mauvais - processus, le gestionnaire de fork sera appelé également. - -
- -
- &reftitle.classsynopsis; - - - - - EvFork - - - - - EvFork - - - extends - EvWatcher - - - - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- - - &reference.ev.entities.evfork; - - - diff --git a/reference/ev/evfork/construct.xml b/reference/ev/evfork/construct.xml deleted file mode 100644 index a11e12316b..0000000000 --- a/reference/ev/evfork/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - EvFork::__construct - Construit l'objet observateur EvFork - - - &reftitle.description; - - public - EvFork::__construct - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Construit l'objet observateur EvFork et démarre l'observateur automatiquement. - - - - &reftitle.parameters; - - - - callback - - - - Voir aussi les - fonctions de rappel pour - les observateurs. - - - - - - data - - - - Données personnalisées associées à l'observateur. - - - - - - priority - - - - Priorité de l'observateur - - - - - - - - &reftitle.seealso; - - - EvLoop::fork - - - EvCheck - - - - - diff --git a/reference/ev/evfork/createstopped.xml b/reference/ev/evfork/createstopped.xml deleted file mode 100644 index 91f3a45b6a..0000000000 --- a/reference/ev/evfork/createstopped.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - EvFork::createStopped - Crée une instance arrêtée de la classe de l'observateur EvFork - - - &reftitle.description; - - final - public - static - object - EvFork::createStopped - - string - callback - - - string - data - - - string - priority - - - - Identique à la méthode - EvFork::__construct mais - ne démarre pas automatiquement l'observateur. - - - - &reftitle.parameters; - - - - callback - - - - Voir les - fonctions de rappel d'observateurs. - - - - - - data - - - - Données personnalisées associées avec l'observateur. - - - - - - priority - - - - Priorité d'observateur - - - - - - - &reftitle.returnvalues; - - Retourne un objet EvFork (arrêté) en cas de succès. - - - - &reftitle.seealso; - - - EvFork::__construct - - - - - diff --git a/reference/ev/evidle.xml b/reference/ev/evidle.xml deleted file mode 100644 index b13b27e16e..0000000000 --- a/reference/ev/evidle.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - La classe EvIdle - EvIdle - - -
- &reftitle.intro; - - Les watchers EvIdle lancent les événements - lorsqu'aucun autre événement ayant la même (ou supérieure) priorité - n'est en attente (EvPrepare, EvCheck - et d'autres watchers EvIdle ne comptent pas - recevoir d'événements). - - - Aussi, tant que le processus est en cours de gestion des sockets ou - des délais d'attente maximal (ou même de signaux) de même priorité (ou de - priorité supérieure), il ne sera pas lancé. Mais lorsque le processus - est au ralenti (ou que seuls des watchers ayant une priorité basse ne sont - en attente), les watchers EvIdle seront appelés - une fois par itération de la boucle d'événements - et ce, tant qu'ils - ne sont pas stoppés, ou que le processus ne reçoive plus d'événements - et devienne ainsi occupé à gérer les travaux ayant une priorité supérieure. - - - En plus de maintenir le processus non bloquant (ce qui est utile parfois), - les watchers EvIdle sont un bon endroit - pour réaliser des "travaux en pseudo-arrière plan", - ou remettre des travaux après que la boucle d'événements n'ait géré - les événements exceptionnels. - - - L'effet le plus notable est que, tant que des watchers - idle sont actifs, le processus - ne va pas bloquer lors de l'attente de nouveaux - événements. - -
- -
- &reftitle.classsynopsis; - - - - - EvIdle - - - - - EvIdle - - - extends - EvWatcher - - - - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- - - - &reference.ev.entities.evidle; - - - diff --git a/reference/ev/evidle/construct.xml b/reference/ev/evidle/construct.xml deleted file mode 100644 index 17addf3c0d..0000000000 --- a/reference/ev/evidle/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - EvIdle::__construct - Construit l'objet observateur EvIdle - - - &reftitle.description; - - public - EvIdle::__construct - - callable - callback - - - mixed - data - - - int - priority - - - - Construit l'objet observateur EvIdle et démarre automatiquement - l'observateur. - - - - &reftitle.parameters; - - - - callback - - - - Voir les - fonctions de rappel des - observateurs. - - - - - - data - - - - Données personnalisées associées avec l'observateur. - - - - - - priority - - - - Priorité de l'observateur - - - - - - - - &reftitle.seealso; - - - EvIdle::createStopped - - - EvLoop::idle - - - - - - diff --git a/reference/ev/evidle/createstopped.xml b/reference/ev/evidle/createstopped.xml deleted file mode 100644 index 7ce1c6465f..0000000000 --- a/reference/ev/evidle/createstopped.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - EvIdle::createStopped - Crée une instance d'un objet observateur EvIdle arrêté - - - &reftitle.description; - - final - public - static - object - EvIdle::createStopped - - string - callback - - - mixed - data - - - int - priority - - - - Identique à la méthode EvIdle::__construct - mais ne démarre pas automatiquement l'observateur. - - - - &reftitle.parameters; - - - - callback - - - - Voir les - fonctions de rappel des - observateurs. - - - - - - data - - - - Données personnalisées avec l'observateur. - - - - - - priority - - - - Priorité de l'observateur - - - - - - - &reftitle.returnvalues; - - Retourne un objet EvIdle en cas de succès. - - - - &reftitle.seealso; - - - EvIdle::__construct - - - EvLoop::idle - - - - - diff --git a/reference/ev/evio.xml b/reference/ev/evio.xml deleted file mode 100644 index 1b8895cd1c..0000000000 --- a/reference/ev/evio.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - La classe EvIo - EvIo - - -
- &reftitle.intro; - - Les watchers EvIo vérifient si un descripteur - de fichier (ou un socket, ou un flux pouvant être transtypé en descripteur - de fichier numérique) est accessible en lecture ou en écriture à chaque - itération de la boucle d'événements, ou, plus précisément, lorsque la - lecture ne va pas bloquer le processus, et lorsque l'écriture va - permettre d'écrire des données. Ce comportement est appelé - niveau de lancement car les événements sont - gardés tant que la condition persiste. Pour stopper la réception - d'événements, stoppez seulement le watcher. - - - Le nombre d'événements de lecture/écriture des watchers par - fd est illimité. Le fait de définir tous les - descripteurs de fichiers en mode non-bloquant est généralement - une bonne idée (mais ce n'est pas requis). - - - Une autre chose à savoir, c'est qu'il est très facile de recevoir - de fausses notifications de système prêt à la lecture, c.-à-d. la fonction - de rappel peut être appelée avec Ev::READ - mais une sous-séquence read() peut bloquer - en raison du fait qu'il n'y a pas de données. Il est très simple - de se retrouver dans cette situation. Aussi, il est recommandé de - toujours utiliser des I/O non bloquants : un read() - supplémentaire retournant EAGAIN (ou similaire) - est bien préférable à un programme qui attend l'arrivée de données. - - - Si pour une raison ou une autre, il est impossible d'exécuter le - fd en mode non-bloquant, alors, séparément, - re-testez si le descripteur de fichier est réellement prêt. - Quelques utilisateurs utilisent en plus SIGALRM - et un minuteur d'intervalle, juste pour s'assurer qu'aucun - blocage infini ne soit présent. - - - Il est recommandé de toujours utiliser le mode non bloquant. - -
- -
- &reftitle.classsynopsis; - - - - - EvIo - - - - - EvIo - - - extends - EvWatcher - - - - &Properties; - - public - fd - - - public - events - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - fd - - - - - - - - events - - - - - - -
- - - - &reference.ev.entities.evio; - - - diff --git a/reference/ev/evio/construct.xml b/reference/ev/evio/construct.xml deleted file mode 100644 index c15b3bec25..0000000000 --- a/reference/ev/evio/construct.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - EvIo::__construct - Construit un nouvel objet EvIo - - - &reftitle.description; - - public - EvIo::__construct - - mixed - fd - - - int - events - - - callable - callback - - - mixed - data - - - int - priority - - - - Construit un nouvel objet EvIo et démarre l'observateur automatiquement. - - - - &reftitle.parameters; - - - - fd - - - - Peut être un flux ouvert avec la fonction - fopen ou toutes fonctions similaires, - descripteurs de fichiers ou sockets. - - - - - - events - - - - Ev::READ et/ou Ev::WRITE. - Voir les - masques d'octets. - - - - - - callback - - - - Voir les - fonctions de rappels des observateurs. - - - - - - data - - - - Données personnalisées associées avec l'observateur. - - - - - - priority - - - - Priorité de l'observateur - - - - - - - - &reftitle.seealso; - - - EvIo::createStopped - - - EvLoop::io - - - - - diff --git a/reference/ev/evio/createstopped.xml b/reference/ev/evio/createstopped.xml deleted file mode 100644 index 998c013fe3..0000000000 --- a/reference/ev/evio/createstopped.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - EvIo::createStopped - Crée un objet d'observateur EvIo arrêté - - - &reftitle.description; - - final - public - static - EvIo - EvIo::createStopped - - mixed - fd - - - int - events - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Identique à la méthode - EvIo::__construct mais - ne démarre pas automatiquement l'observateur. - - - - &reftitle.parameters; - - - - fd - - - - Identique à la méthode - EvIo::__construct - - - - - - events - - - - Identique à la méthode - EvIo::__construct - - - - - - callback - - - - Voir les - fonctions de rappel des observateurs. - - - - - - data - - - - Données personnalisées associées avec l'observateur. - - - - - - priority - - - - Priorité de l'observateur - - - - - - - &reftitle.returnvalues; - - Retourne un objet EvIo en cas de succès. - - - - &reftitle.seealso; - - - EvIo::__construct - - - EvLoop::io - - - - - diff --git a/reference/ev/evio/set.xml b/reference/ev/evio/set.xml deleted file mode 100644 index 834d51a20a..0000000000 --- a/reference/ev/evio/set.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - EvIo::set - Configure l'observateur - - - &reftitle.description; - - public - void - EvIo::set - - mixed - fd - - - int - events - - - - Configure l'observateur EvIo. - - - - &reftitle.parameters; - - - - fd - - - - Identique à la méthode - EvIo::__construct - - - - - - events - - - - Identique à la méthode - EvIo::__construct - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evloop.xml b/reference/ev/evloop.xml deleted file mode 100644 index 7214f72544..0000000000 --- a/reference/ev/evloop.xml +++ /dev/null @@ -1,235 +0,0 @@ - - - - - La classe EvLoop - EvLoop - - -
- &reftitle.intro; - - Représente une boucle d'événements qui est toujours distincte de la - boucle par défaut. Contrairement à la - boucle par défaut, elle ne peut pas gérer les - watchers EvChild. - - - Lorsqu'on utilise les threads, nous devons créer une boucle par thread, - et utiliser la boucle par défaut dans le thread - parent. - - - La boucle d'événements par défaut est initialisée - automatiquement par Ev. Elle est accessible via les - méthodes de la classe Ev ou via la méthode - EvLoop::defaultLoop. - -
- -
- &reftitle.classsynopsis; - - - - - EvLoop - - - - - final - EvLoop - - - - &Properties; - - public - data - - - public - backend - - - public - is_default_loop - - - public - iteration - - - public - pending - - - public - io_interval - - - public - timeout_interval - - - public - depth - - &Methods; - - - - -
- -
- &reftitle.properties; - - - - data - - - - Données personnalisées à attacher à la boucle - - - - - - backend - - - - Lecture seule. - Les - drapeaux du backend - indiquant le backend d'événements en cours d'utilisation. - - - - - - is_default_loop - - - - Lecture seule. - &true; si c'est la boucle d'événements par défaut. - - - - - - iteration - - - - Le compteur d'itération courant de la boucle. Voir la méthode - Ev::iteration. - - - - - - pending - - - - Le nombre de watchers en attente. - 0 indique qu'il n'y a aucun watcher en attente. - - - - - - io_interval - - - - Une valeur haute pour io_interval permet à - libev de passer plus de temps à collecter - les événements EvIo, ainsi, plus d'événements - peuvent être gérés par itération, mais cela va augmenter la - latence. Les délais d'attente maximum (pour à la fois - EvPeriodic et EvTimer) - ne seront pas affectés. Le fait de définir cette option à une valeur - différente de zéro va introduire un appel à sleep() - supplémentaire dans la plupart des itérations de la boucle. - Le temps de pause assure que libev - ne va pas interroger EvIo plus d'une fois - pendant cet intervalle, en moyenne. La plupart des programmes - peuvent avoir des effets bénéfiques en définissant - io_interval à une valeur proche de - 0.1, ce qui est en général suffisant pour les - serveurs interactifs (et non destinés aux jeux). Il n'y a généralement - aucun sens à définir cette valeur à une valeur inférieure à - 0.01, sachant que l'on s'approche de la - granularité au niveau des durées de la plupart des systèmes. - - - Voir aussi les - - fonctions contrôlant les boucles d'événements. - - - - - - timeout_interval - - - - Une valeur haute pour timeout_interval permet à - libev de passer plus de temps à collecter les - délais maximaux d'attente, mais a pour conséquence d'accroître - la latence, le stress et l'inexactitude (la fonction de rappel - du watcher sera appelée plus tard). Les watchers EvIo - ne seront pas affectés. Le fait de définir cette valeur à une valeur non - nulle ne va introduire aucun surcoût supplémentaire à - libev. Voir aussi les - - fonctions contrôlant les boucles d'événements. - - - - - - depth - - - - La profondeur de la récursion. Voir la méthode - Ev::depth. - - - - -
- - - - &reference.ev.entities.evloop; - - - diff --git a/reference/ev/evloop/backend.xml b/reference/ev/evloop/backend.xml deleted file mode 100644 index 82502b17ef..0000000000 --- a/reference/ev/evloop/backend.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - EvLoop::backend - Retourne un entier décrivant le backend utilisé par libev - - - &reftitle.description; - - public - int - EvLoop::backend - - - - Identique à la méthode Ev::backend, - mais pour l'instance de la boucle. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un entier décrivant le backend utilisé par libev. - Voir la méthode Ev::backend. - - - - &reftitle.seealso; - - - Ev::backend - - - - - diff --git a/reference/ev/evloop/check.xml b/reference/ev/evloop/check.xml deleted file mode 100644 index 8fe42ac1ab..0000000000 --- a/reference/ev/evloop/check.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - EvLoop::check - Crée un objet EvCheck associé avec l'instance de la boucle d'événements courante - - - &reftitle.description; - - final - public - EvCheck - EvLoop::check - - string - callback - - - string - data - - - string - priority - - - - Crée un objet EvCheck associé avec l'instance de la boucle d'événements courante. - - - - &reftitle.parameters; - - Tous les paramètres ont la même signification que pour la méthode - EvCheck::__construct. - - - - &reftitle.returnvalues; - - Retourne un objet EvCheck en cas de succès. - - - - &reftitle.seealso; - - - EvCheck::__construct - - - - - diff --git a/reference/ev/evloop/child.xml b/reference/ev/evloop/child.xml deleted file mode 100644 index b01ca7d96b..0000000000 --- a/reference/ev/evloop/child.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - EvLoop::child - Crée un objet EvChild associé avec la boucle d'événements courante - - - &reftitle.description; - - final - public - EvChild - EvLoop::child - - string - pid - - - string - trace - - - string - callback - - - string - data - - - string - priority - - - - Crée un objet EvChild associé avec la boucle d'événements courante. - - - - &reftitle.parameters; - - Tous les paramètres ont la même signification que pour la méthode - EvChild::__construct. - - - - &reftitle.returnvalues; - - Retourne un objet EvChild en cas de succès. - - - - &reftitle.seealso; - - - EvChild::__construct - - - - - diff --git a/reference/ev/evloop/construct.xml b/reference/ev/evloop/construct.xml deleted file mode 100644 index 5cc231298d..0000000000 --- a/reference/ev/evloop/construct.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - EvLoop::__construct - Construit un objet de boucle d'événements - - - &reftitle.description; - - public - EvLoop::__construct - - int - flags - - - mixed - data - NULL - - - float - io_interval - 0.0 - - - float - timeout_interval - 0.0 - - - - Construit l'objet de boucle d'événements. - - - - &reftitle.parameters; - - - - flags - - - - Un des - drapeaux de boucle - d'événements - - - - - - data - - - - Données personnalisées à associer avec la boucle. - - - - - - io_interval - - - - Voir - io_interval - - - - - - timeout_interval - - - - Voir - timeout_interval - - - - - - - - &reftitle.seealso; - - - EvLoop::defaultLoop - - - - - diff --git a/reference/ev/evloop/defaultloop.xml b/reference/ev/evloop/defaultloop.xml deleted file mode 100644 index d8c836727c..0000000000 --- a/reference/ev/evloop/defaultloop.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - EvLoop::defaultLoop - Retourne ou crée la boucle d'événements par défaut - - - &reftitle.description; - - public - static - EvLoop - EvLoop::defaultLoop - - int - flags - Ev::FLAG_AUTO - - - mixed - data - NULL - - - float - io_interval - 0. - - - float - timeout_interval - 0. - - - - Si la boucle d'événements par défaut n'est pas créée, la méthode - EvLoop::defaultLoop la crée avec les paramètres - spécifiés. Sinon, elle retournera l'instance de l'objet correspondant - précédemment créé en ignorant tous les paramètres. - - - - &reftitle.parameters; - - - - flags - - - - Un des - drapeaux de boucle d'événements - - - - - - data - - - - Données personnalisées à associer avec la boucle. - - - - - - io_collect_interval - - - - Voir - io_interval - - - - - - timeout_collect_interval - - - - Voir - timeout_interval - - - - - - - &reftitle.returnvalues; - - Retourne l'objet EvLoop en cas de succès. - - - - &reftitle.seealso; - - - EvLoop::__construct - - - - - diff --git a/reference/ev/evloop/embed.xml b/reference/ev/evloop/embed.xml deleted file mode 100644 index f6ec1df11e..0000000000 --- a/reference/ev/evloop/embed.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - EvLoop::embed - Crée une instance de l'observateur EvEmbed associé avec l'objet de l'EvLoop courant - - - &reftitle.description; - - final - public - EvEmbed - EvLoop::embed - - string - other - - - string - callback - - - string - data - - - string - priority - - - - Crée une instance de l'observateur - EvEmbed associé avec l'objet - EvLoop courant. - - - - &reftitle.parameters; - - Tous les paramètres ont la même signification que pour la méthode - EvEmbed::__construct. - - - - &reftitle.returnvalues; - - Retourne l'objet EvEmbed en cas de succès. - - - - &reftitle.seealso; - - - EvEmbed::__construct - - - - - diff --git a/reference/ev/evloop/fork.xml b/reference/ev/evloop/fork.xml deleted file mode 100644 index 67bf7a8c44..0000000000 --- a/reference/ev/evloop/fork.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - EvLoop::fork - Crée un objet EvFork watcher associé avec l'instance de la - boucle de l'événement courant - - - &reftitle.description; - - final - public - EvFork - EvLoop::fork - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée un objet EvFork watcher associé avec l'instance de la - boucle de l'événement courant - - - - &reftitle.parameters; - - Tous les paramètres ont la même signification que ceux de la méthode - EvFork::__construct. - - - - &reftitle.returnvalues; - - Retourne l'objet EvFork en cas de succès. - - - - &reftitle.seealso; - - - EvFork::__construct - - - - - diff --git a/reference/ev/evloop/idle.xml b/reference/ev/evloop/idle.xml deleted file mode 100644 index 0cc51e60d1..0000000000 --- a/reference/ev/evloop/idle.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - EvLoop::idle - Crée un objet EvIdle watcher associé avec l'instance de la boucle - de l'événement courant - - - &reftitle.description; - - final - public - EvIdle - EvLoop::idle - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée un objet EvIdle watcher associé avec l'instance de la boucle - de l'événement courant - - - - &reftitle.parameters; - - Tous les paramètres ont la même signification que ceux de la méthode - EvIdle::__construct - - - - &reftitle.returnvalues; - - Retourne un objet EvIdle en cas de succès. - - - - &reftitle.seealso; - - - EvIdle::__construct - - - - - diff --git a/reference/ev/evloop/invokepending.xml b/reference/ev/evloop/invokepending.xml deleted file mode 100644 index 84b93f8494..0000000000 --- a/reference/ev/evloop/invokepending.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - EvLoop::invokePending - Invoque tous les watchers en attente tout en réinitialisant - leur état d'attente - - - &reftitle.description; - - public - void - EvLoop::invokePending - - - - Invoque tous les watchers en attente tout en réinitialisant - leur état d'attente. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evloop/io.xml b/reference/ev/evloop/io.xml deleted file mode 100644 index 0d545cc56b..0000000000 --- a/reference/ev/evloop/io.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - EvLoop::io - Crée un objet EvIo watcher associé avec l'instance de la boucle - de l'événement courant - - - &reftitle.description; - - final - public - EvIo - EvLoop::io - - mixed - fd - - - int - events - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée un objet EvIo watcher associé avec l'instance de la boucle - de l'événement courant. - - - - &reftitle.parameters; - - Tous les paramètres ont la même signification que ceux de la méthode - EvIo::__construct. - - - - &reftitle.returnvalues; - - Retourne un objet EvIo en cas de succès. - - - - &reftitle.seealso; - - - EvIo::__construct - - - - - diff --git a/reference/ev/evloop/loopfork.xml b/reference/ev/evloop/loopfork.xml deleted file mode 100644 index 506019e783..0000000000 --- a/reference/ev/evloop/loopfork.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - EvLoop::loopFork - Doit être appelé après un fork - - - &reftitle.description; - - public - void - EvLoop::loopFork - - - - Doit être appelé après un fork dans le fils, - et avant d'entrer ou de continuer la boucle d'événement. Une alternative - est d'utiliser la constante Ev::FLAG_FORKCHECK - qui appelle cette fonction automatiquement, avec une perte de - performance (se référer à la documentation - libev). - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evloop/now.xml b/reference/ev/evloop/now.xml deleted file mode 100644 index 6301339aa3..0000000000 --- a/reference/ev/evloop/now.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - EvLoop::now - Retourne le "event loop time" courant - - - &reftitle.description; - - public - float - EvLoop::now - - - - Retourne le "event loop time" courant, qui est la durée pendant - laquelle la boucle d'événement reçoit des événements et - démarre leurs analyses. Cet horodatage ne change pas tant que les - fonctions de rappel sont en cours d'exécution, et c'est aussi le temps - de base utilisé pour les timers relatifs. Il est possible de le considérer - comme l'horodatage de l'événement en cours (ou plus exactement, - celui utilisé par libev). - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne l'horodatage de la boucle d'événement, en secondes. - - - - &reftitle.seealso; - - - Ev::now - - - - - diff --git a/reference/ev/evloop/nowupdate.xml b/reference/ev/evloop/nowupdate.xml deleted file mode 100644 index 8bd989132d..0000000000 --- a/reference/ev/evloop/nowupdate.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - EvLoop::nowUpdate - Établit le temps courant en demandant au kernel, et met à jour - le temps retourné par EvLoop::now pendant l'exécution - - - &reftitle.description; - - public - void - EvLoop::nowUpdate - - - - Établit le temps courant en demandant au kernel, et met à jour - le temps retourné par EvLoop::now pendant l'exécution. - C'est une opération qui est coûteuse en termes de performance et qui - est habituellement exécutée automatiquement dans la méthode - EvLoop::run. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::now - - - Ev::nowUpdate - - - - - diff --git a/reference/ev/evloop/periodic.xml b/reference/ev/evloop/periodic.xml deleted file mode 100644 index 2f40d084d6..0000000000 --- a/reference/ev/evloop/periodic.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - EvLoop::periodic - Crée un objet EvPeriodic watcher associé avec l'instance de la - boucle d'événement courant - - - &reftitle.description; - - final - public - EvPeriodic - EvLoop::periodic - - float - offset - - - float - interval - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée un objet EvPeriodic watcher associé avec l'instance de la - boucle d'événement courant. - - - - &reftitle.parameters; - - Tous les paramètres ont la même signification que ceux de la méthode - EvPeriodic::__construct. - - - - &reftitle.returnvalues; - - Retourne un objet EvPeriodic en cas de succès. - - - - &reftitle.seealso; - - - EvPeriodic::__construct - - - - - diff --git a/reference/ev/evloop/prepare.xml b/reference/ev/evloop/prepare.xml deleted file mode 100644 index c5067a2ea0..0000000000 --- a/reference/ev/evloop/prepare.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - EvLoop::prepare - Crée un objet EvPrepare watcher associé avec l'instance de la boucle - d'événement courant - - - &reftitle.description; - - final - public - EvPrepare - EvLoop::prepare - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée un objet EvPrepare watcher associé avec l'instance de la boucle - d'événement courant. - - - - &reftitle.parameters; - - Tous les paramètres ont la même signification que ceux de la méthode - EvPrepare. - - - - &reftitle.returnvalues; - - Retourne un objet EvPrepare en cas de succès. - - - - &reftitle.seealso; - - - EvPrepare::__construct - - - - - diff --git a/reference/ev/evloop/resume.xml b/reference/ev/evloop/resume.xml deleted file mode 100644 index 1629bfba12..0000000000 --- a/reference/ev/evloop/resume.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - EvLoop::resume - Reprend une boucle d'événement précédemment stoppée - - - &reftitle.description; - - public - void - EvLoop::resume - - - - Les méthodes EvLoop::suspend - et EvLoop::resume suspendent et - reprennent une boucle. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::suspend - - - Ev::resume - - - - - diff --git a/reference/ev/evloop/run.xml b/reference/ev/evloop/run.xml deleted file mode 100644 index 558bb9fc79..0000000000 --- a/reference/ev/evloop/run.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - EvLoop::run - Commence à vérifier les événements et à appeler les fonctions de rappel de la boucle - - - &reftitle.description; - - public - void - EvLoop::run - - int - flags - 0 - - - - Commence à vérifier les événements et à appeler les fonctions de rappel - pour la boucle d'événements courante. La méthode s'arrête lorsqu'une - fonction de rappel appelle la méthode Ev::stop - ou que les drapeaux sont différents de zéro (auquel cas, la valeur - retournée est &true;) ou lorsqu'il n'y a aucun watcher actif qui référence - la boucle (EvWatcher::keepalive vaut &true;), - auquel cas, la valeur retournée sera &false;. - La valeur retournée peut généralement être interprétée comme - si &true;, il y a encore des travaux à faire. - - - - &reftitle.parameters; - - - - flags - - - - Le paramètre optionnel flags - peut prendre une des valeurs suivantes : - - - Liste des valeurs possibles pour <parameter>flags</parameter> - - - - - - flags - - Description - - - - - - 0 - - Le comportement par défaut, décrit ci-dessus - - - - Ev::RUN_ONCE - - Ne pas bloquer plus d'un événement (attend, mais ne boucle pas) - - - - Ev::RUN_NOWAIT - - Aucun blocage (récupère, gère les événements, mais n'attend pas) - - - -
- - - Voir les - constantes des drapeaux - d'exécution. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::stop - - - Ev::run - - - - - diff --git a/reference/ev/evloop/signal.xml b/reference/ev/evloop/signal.xml deleted file mode 100644 index c78b10c9b2..0000000000 --- a/reference/ev/evloop/signal.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - EvLoop::signal - Crée un objet EvSignal watcher associé avec l'instance de la - boucle d'événement courante - - - &reftitle.description; - - final - public - EvSignal - EvLoop::signal - - int - signum - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée un objet EvSignal watcher associé avec l'instance de la - boucle d'événement courante. - - - - &reftitle.parameters; - - Tous les paramètres ont la même signification que ceux de la méthode - EvSignal::__construct. - - - - &reftitle.returnvalues; - - Retourne un objet EvSignal en cas de succès. - - - - &reftitle.seealso; - - - EvSignal::__construct - - - - - diff --git a/reference/ev/evloop/stat.xml b/reference/ev/evloop/stat.xml deleted file mode 100644 index 9d72a6a318..0000000000 --- a/reference/ev/evloop/stat.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - EvLoop::stat - Crée un objet EvStat watcher associé avec l'instance de la - boucle d'événement courant - - - &reftitle.description; - - final - public - EvStat - EvLoop::stat - - string - path - - - float - interval - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée un objet EvStat watcher associé avec l'instance de la - boucle d'événement courant. - - - - &reftitle.parameters; - - Tous les paramètres ont la même signification que ceux de la méthode - EvSignal::__construct. - - - - &reftitle.returnvalues; - - Retourne un objet EvStat en cas de succès. - - - - &reftitle.seealso; - - - EvSignal::__construct - - - - - diff --git a/reference/ev/evloop/stop.xml b/reference/ev/evloop/stop.xml deleted file mode 100644 index 3631e1b2c1..0000000000 --- a/reference/ev/evloop/stop.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - EvLoop::stop - Stoppe la boucle d'événement - - - &reftitle.description; - - public - void - EvLoop::stop - - int - how - - - - Stoppe la boucle d'événement. - - - - &reftitle.parameters; - - - - how - - - - Une constante - Ev::BREAK_*. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::run - - - Ev::stop - - - - - diff --git a/reference/ev/evloop/suspend.xml b/reference/ev/evloop/suspend.xml deleted file mode 100644 index 32cf997973..0000000000 --- a/reference/ev/evloop/suspend.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - EvLoop::suspend - Suspend la boucle - - - &reftitle.description; - - public - void - EvLoop::suspend - - - - Les méthodes EvLoop::suspend - et EvLoop::resume suspendent - et reprennent une boucle. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::resume - - - Ev::suspend - - - - - diff --git a/reference/ev/evloop/timer.xml b/reference/ev/evloop/timer.xml deleted file mode 100644 index c9244dc042..0000000000 --- a/reference/ev/evloop/timer.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - EvLoop::timer - Crée un objet EvTimer watcher associé avec l'instance de la boucle - d'événement courant - - - &reftitle.description; - - final - public - EvTimer - EvLoop::timer - - float - after - - - float - repeat - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée un objet EvTimer watcher associé avec l'instance de la boucle - d'événement courant. - - - - &reftitle.parameters; - - Tous les paramètres ont la même signification que ceux de la méthode - EvTimer::__construct. - - - - &reftitle.returnvalues; - - Retourne l'objet EvTimer en cas de succès. - - - - &reftitle.seealso; - - - EvTimer::__construct - - - - - diff --git a/reference/ev/evloop/verify.xml b/reference/ev/evloop/verify.xml deleted file mode 100644 index bde3ed380a..0000000000 --- a/reference/ev/evloop/verify.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - EvLoop::verify - Effectue des vérifications de consistance interne (pour le débogage) - - - &reftitle.description; - - public - void - EvLoop::verify - - - - Effectue des vérifications de consistance interne (pour le débogage - de libev) et stoppe le programme si des structures - de données corrompues sont trouvées. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::verify - - - - - diff --git a/reference/ev/evperiodic.xml b/reference/ev/evperiodic.xml deleted file mode 100644 index 459b0470f9..0000000000 --- a/reference/ev/evperiodic.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - La classe EvPeriodic - EvPeriodic - - -
- &reftitle.intro; - - Les watchers périodiques sont des sortes de minuteurs, mais ils sont très - polyvalents. - - - Contrairement à EvTimer, les watchers - EvPeriodic ne sont pas basés sur un temps réel - (ou un temps relatif, le temps physique qui passe), mais sur un temps - d'horloge (temps absolu, calendaire, ou d'horloge). La différence est - qu'un temps d'horloge peut être plus rapide ou plus lent qu'un temps - réel, et les sauts dans le temps ne sont pas rares (c.-à-d. lors d'un ajustement). - - - Un watcher EvPeriodic peut être configuré pour - être lancé après des points spécifiques dans le temps. Par exemple, - si un watcher EvPeriodic est configuré pour - se lancer "dans 10 secondes" (c.-à-d. - EvLoop::now + 10.0, - c.-à-d. un temps absolu, et non un délai), et que l'horloge système - est ré-initialisée à janvier de l'année dernière, - alors cela prendra une année et plus à lancer l'événement (contrairement - à EvTimer qui sera lancé 10 - secondes après son démarrage, sachant qu'il utilise un délai maximal d'attente - relatif). - - - Comme pour les minuteurs, il est garanti que la fonction de rappel soit - appelée uniquement lorsque le point dans le temps où il est supposé se lancer - est passé. Si plusieurs minuteurs deviennent prêts en même temps - pendant la même itération de boucle, alors ceux dont les valeurs de délai - maximal d'attente sont les plus proches seront appelés avant ceux qui ont des - valeurs de délai maximal d'attente plus éloignées (mais ceci n'est plus - vrai lorsqu'une fonction de rappel appelle récursivement la méthode - EvLoop::run). - -
- -
- &reftitle.classsynopsis; - - - - - EvPeriodic - - - - - EvPeriodic - - - extends - EvWatcher - - - - &Properties; - - public - offset - - - public - interval - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - offset - - - - Lors de la répétition, va contenir la valeur de la position, sinon, - ce sera le point absolu dans le temps (la valeur de la position - passée à la méthode EvPeriodic::set, - bien que libev peut modifier cette valeur - pour une meilleure stabilité numérique). - - - - - - interval - - - - La valeur de l'intervalle courant. Peut être modifié à tout moment, - mais les modifications ne prennent effet que lorsque le minuteur - périodique se lance, ou lorsque la méthode - EvPeriodic::again est appelée. - - - - -
- - - - &reference.ev.entities.evperiodic; - - - diff --git a/reference/ev/evperiodic/again.xml b/reference/ev/evperiodic/again.xml deleted file mode 100644 index ee625701d3..0000000000 --- a/reference/ev/evperiodic/again.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - EvPeriodic::again - Arrête et re-démarre le watcher périodique - - - &reftitle.description; - - public - void - EvPeriodic::again - - - - Arrête et re-démarre le watcher périodique. Ceci n'est utile - que lorsque les attributs ont changé. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvTimer::again - - - - - diff --git a/reference/ev/evperiodic/at.xml b/reference/ev/evperiodic/at.xml deleted file mode 100644 index c1ca903f2e..0000000000 --- a/reference/ev/evperiodic/at.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - EvPeriodic::at - Retourne le temps absolu auquel ce watcher sera appelé la prochaine fois - - - &reftitle.description; - - public - float - EvPeriodic::at - - - - Retourne le temps absolu auquel ce watcher sera appelé la prochaine fois. - Ce n'est pas la même chose que l'argument de position de la méthode - EvPeriodic::set ou la méthode - EvPeriodic::__construct, mais fonctionne aussi en - mode intervalle. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne le temps absolu auquel ce watcher sera appelé la prochaine fois, - en secondes. - - - - diff --git a/reference/ev/evperiodic/construct.xml b/reference/ev/evperiodic/construct.xml deleted file mode 100644 index 6619c48845..0000000000 --- a/reference/ev/evperiodic/construct.xml +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - EvPeriodic::__construct - Construit un objet watcher EvPeriodic - - - &reftitle.description; - - public - EvPeriodic::__construct - - float - offset - - - string - interval - - - callable - reschedule_cb - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Construit un objet watcher EvPeriodic et le démarre automatiquement. - La méthode EvPeriodic::createStopped - crée un watcher périodique stoppé. - - - - &reftitle.parameters; - - - - offset - - - - Voir les - modes d'opération du watcher périodique - - - - - - interval - - - - Voir les - modes d'opération du watcher périodique - - - - - - reschedule_cb - - - - Fonction de rappel Reschedule. Il est possible de passer la valeur &null;. - Voir les - modes d'opération du watcher périodique - - - - - - callback - - - - Voir les - fonctions de rappel des Watchers . - - - - - - data - - - - Données personnalisées à associer avec le watcher. - - - - - - priority - - - - Priorité du Watcher - - - - - - - - &reftitle.examples; - - - Timer périodique. Utilisant le rappel de replanification - - - -]]> - - - - Timer périodique. Appelé toutes les 10.5 secondes - - -]]> - - - - Watcher chaque heure - - -]]> - - - - - &reftitle.seealso; - - - Les modes d'opération du watcher périodique - - - EvTimer - - - EvPeriodic::createStopped - - - - - diff --git a/reference/ev/evperiodic/createstopped.xml b/reference/ev/evperiodic/createstopped.xml deleted file mode 100644 index 7ebc0554a4..0000000000 --- a/reference/ev/evperiodic/createstopped.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - EvPeriodic::createStopped - Crée un watcher EvPeriodic stoppé - - - &reftitle.description; - - final - public - static - EvPeriodic - EvPeriodic::createStopped - - float - offset - - - float - interval - - - callable - reschedule_cb - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée un objet EvPeriodic. Contrairement à la méthode - EvPeriodic::__construct, cette méthode - ne démarre pas le watcher automatiquement. - - - - &reftitle.parameters; - - - - offset - - - - Voir les - modes d'opération du watcher périodique - - - - - - interval - - - - Voir les - modes d'opération du watcher périodique - - - - - - reschedule_cb - - - - Fonction de rappel Reschedule. Il est possible de passer la valeur &null;. - Voir les - modes d'opération du watcher périodique - - - - - - callback - - - - Voir les - fonctions de rappel des Watchers. - - - - - - data - - - - Données personnalisées à associer avec le watcher. - - - - - - priority - - - - Priorité du Watcher - - - - - - - &reftitle.returnvalues; - - Retourne un objet watcher EvPeriodic en cas de succès. - - - - &reftitle.seealso; - - - EvPeriodic::__construct - - - EvTimer::createStopped - - - - - diff --git a/reference/ev/evperiodic/set.xml b/reference/ev/evperiodic/set.xml deleted file mode 100644 index d0937874b4..0000000000 --- a/reference/ev/evperiodic/set.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - EvPeriodic::set - Configure le watcher - - - &reftitle.description; - - public - void - EvPeriodic::set - - float - offset - - - float - interval - - - - (Re-)Configure le watcher EvPeriodic. - - - - &reftitle.parameters; - - - - offset - - - - La même signification que pour la méthode - EvPeriodic::__construct. - Voir les - modes d'opération du watcher périodique - - - - - - interval - - - - La même signification que pour la méthode - EvPeriodic::__construct. - Voir les - modes d'opération du watcher périodique - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evprepare.xml b/reference/ev/evprepare.xml deleted file mode 100644 index 24030bacf3..0000000000 --- a/reference/ev/evprepare.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - La classe EvPrepare - EvPrepare - - -
- -
- -
- &reftitle.classsynopsis; - - - - - EvPrepare - - - - - EvPrepare - - - extends - EvWatcher - - - - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- - - &reference.ev.entities.evprepare; - - - diff --git a/reference/ev/evprepare/construct.xml b/reference/ev/evprepare/construct.xml deleted file mode 100644 index bf937e7a3c..0000000000 --- a/reference/ev/evprepare/construct.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - EvPrepare::__construct - Construit un objet de watcher EvPrepare - - - &reftitle.description; - - public - EvPrepare::__construct - - string - callback - - - string - data - - - string - priority - - - - Construit un objet de watcher EvPrepare. - Démarre le watcher automatiquement. S'il est nécessaire - d'un watcher stoppé, utiliser plutôt la méthode - EvPrepare::createStopped. - - - - &reftitle.parameters; - - - - callback - - - - Voir les - fonctions de rappel des Watchers. - - - - - - data - - - - Données personnalisées à associer avec le watcher. - - - - - - priority - - - - Priorité du Watcher - - - - - - - - &reftitle.seealso; - - - EvCheck - - - - - diff --git a/reference/ev/evprepare/createstopped.xml b/reference/ev/evprepare/createstopped.xml deleted file mode 100644 index d4b49341cc..0000000000 --- a/reference/ev/evprepare/createstopped.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - EvPrepare::createStopped - Crée une instance stoppée du watcher EvPrepare - - - &reftitle.description; - - final - public - static - EvPrepare - EvPrepare::createStopped - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée une instance stoppée du watcher EvPrepare. Contrairement - à la méthode EvPrepare::__construct, - cette méthode ne démarre pas le watcher automatiquement. - - - - &reftitle.parameters; - - - - callback - - - - Voir les - fonctions de rappel des Watchers. - - - - - - data - - - - Données personnalisées à associer avec le watcher. - - - - - - priority - - - - Priorité du Watcher - - - - - - - &reftitle.returnvalues; - - Retourne un objet EvPrepare en cas de succès. - - - - &reftitle.seealso; - - - EvPrepare::__construct - - - EvWatcher::start - - - - - diff --git a/reference/ev/evsignal.xml b/reference/ev/evsignal.xml deleted file mode 100644 index e67ba16865..0000000000 --- a/reference/ev/evsignal.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - La classe EvSignal - EvSignal - - -
- &reftitle.intro; - - Les watchers EvSignal vont lancer un événement - lorsque le processus reçoit un signal spécifique une ou plusieurs fois. - Malgré le fait que les signaux soient asynchrones, - libev va tenter de faire de son mieux pour - délivrer les signaux de façon synchrone, c.-à-d. tout comme n'importe quel - autre événement. - - - Il n'y a aucune limite pour le nombre de watchers pour le même signal, - mais seulement dans la même boucle, c.-à-d. il est possible de surveiller - SIGINT dans la boucle par défaut, et pour - SIGIO dans une autre boucle, mais il n'est pas - autorisé de surveiller SIGINT à la fois dans - la boucle par défaut, et dans une autre boucle au même moment. - À ce moment, SIGCHLD est lié de façon permanente - à la boucle par défaut. - - - Si possible et si supporté, libev va installer son - gestionnaire avec SA_RESTART (ou équivalent) activé, - aussi, les appels système ne devraient pas être interrompus. Dans le cas - d'un problème avec les appels système qui se verraient interrompus par - des signaux, tous les signaux peuvent être bloqués dans un watcher - EvCheck et débloqués dans un watcher - EvPrepare. - -
- -
- &reftitle.classsynopsis; - - - - - EvSignal - - - - - EvSignal - - - extends - EvWatcher - - - - &Properties; - - public - signum - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - signum - - - - Le numéro du signal. Voir les constantes exportées par l'extension - pcntl. Voir aussi la page de manuel pour - signal(7). - - - - -
- - - - &reference.ev.entities.evsignal; - - - diff --git a/reference/ev/evsignal/construct.xml b/reference/ev/evsignal/construct.xml deleted file mode 100644 index 45a50462d7..0000000000 --- a/reference/ev/evsignal/construct.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - EvSignal::__construct - Construit un objet watcher EvSignal - - - &reftitle.description; - - public - EvSignal::__construct - - int - signum - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Construit un objet watcher EvSignal et le démarre automatiquement. - Pour un watcher de signal stoppé, utiliser plutôt la méthode - EvSignal::createStopped. - - - - &reftitle.parameters; - - - - signum - - - - Numéro du signal. Voir les constantes exportées par l'extension - pcntl. Voir aussi la page du manuel système - signal(7). - - - - - - callback - - - - Voir les - fonctions de rappel des Watchers. - - - - - - data - - - - Données personnalisées à associer avec le watcher. - - - - - - priority - - - - Priorité du Watcher - - - - - - - - &reftitle.examples; - - Gestion d'un signal SIGTERM - -stop(); -}); - -Ev::run(); -?> -]]> - - - - - &reftitle.seealso; - - - EvSignal::createStopped - - - - - diff --git a/reference/ev/evsignal/createstopped.xml b/reference/ev/evsignal/createstopped.xml deleted file mode 100644 index 8b8b028033..0000000000 --- a/reference/ev/evsignal/createstopped.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - EvSignal::createStopped - Crée un objet watcher EvSignal stoppé - - - &reftitle.description; - - final - public - static - EvSignal - EvSignal::createStopped - - int - signum - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée un objet watcher EvSignal stoppé. Contrairement à la méthode - EvSignal::__construct, cette méthode - ne démarre pas automatiquement le watcher. - - - - &reftitle.parameters; - - - - signum - - - - Numéro du signal. Voir les constantes exportées par l'extension - pcntl. Voir aussi la page de manuel système - signal(7). - - - - - - callback - - - - Voir les - fonctions de rappel des Watchers. - - - - - - data - - - - Données personnalisées à associer avec le watcher. - - - - - - priority - - - - Priorité du Watcher - - - - - - - &reftitle.returnvalues; - - Retourne un objet EvSignal en cas de succès. - - - - &reftitle.seealso; - - - EvWatcher::start - - - EvSignal::__construct - - - - - diff --git a/reference/ev/evsignal/set.xml b/reference/ev/evsignal/set.xml deleted file mode 100644 index 2e7a943129..0000000000 --- a/reference/ev/evsignal/set.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - EvSignal::set - Configure le watcher - - - &reftitle.description; - - public - void - EvSignal::set - - int - signum - - - - Configure le watcher. - - - - &reftitle.parameters; - - - - signum - - - - Numéro du signal. Identique à celui du constructeur - EvSignal::__construct. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evstat.xml b/reference/ev/evstat.xml deleted file mode 100644 index ecc3f79ac5..0000000000 --- a/reference/ev/evstat.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - La classe EvStat - EvStat - - -
- &reftitle.intro; - - La classe EvStat surveille - un fichier du système de fichiers afin de regarder toute modification - de ces attributs. Elle appelle la commande stat() - sur ce chemin, à intervalle régulier (ou lorsque l'OS signale une modification) - et regarde s'il a été modifié depuis la dernière fois, et appelle la - fonction de rappel si c'est le cas. - - - Le chemin n'a pas besoin d'exister : la modification de "le chemin existe" - vers "le chemin n'existe pas" est une modification de statut comme un autre. - La condition "le chemin n'existe pas" est signifiée par la valeur 0 de - l'élément 'nlink' (retourné par la méthode - EvStat::attr). - - - Le chemin ne doit pas se terminer par un slash, ou contenir des composants - spéciaux comme '.' ou ... - Le chemin doit être absolu : s'il est relatif, et que le dossier de travail - change, alors le comportement sera indéfini. - - - Sachant qu'il n'y a pas d'interface de notification de changement portable, - l'implémentation portable appelle simplement la commande - stat() sur le chemin pour vérifier les modifications. - Pour ce cas, un intervalle régulier peut être spécifié. S'il est spécifié, - un intervalle de 0.0 (vivement recommandé) alors - une valeur par défaut non spécifiée sera utilisée (aux alentours de 5 secondes, - et peut être modifiée dynamiquement). libev - va également imposer un intervalle minimum qui est actuellement aux alentours - de 0.1, ce qui est largement suffisant. - - - Ce type de watcher n'est pas prévu pour un nombre important de watchers - EvStat, sachant que même avec les notifications - systèmes sur les modifications supportées par l'OS, ceci prend beaucoup - de ressources. - -
- -
- &reftitle.classsynopsis; - - - - - EvStat - - - - - EvStat - - - extends - EvWatcher - - - - &Properties; - - public - path - - - public - interval - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - interval - - - - Lecture seule. La rapidité avec laquelle - une modification doit être détectée ; normalement, doit valoir - 0.0 pour laisser libev - choisir une bonne valeur. - - - - - - path - - - - Lecture seule. Le chemin vers le fichier - dont on souhaite surveiller les modifications de statut. - - - - -
- - - - &reference.ev.entities.evstat; - - - diff --git a/reference/ev/evstat/attr.xml b/reference/ev/evstat/attr.xml deleted file mode 100644 index 74100ed79d..0000000000 --- a/reference/ev/evstat/attr.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - - EvStat::attr - Retourne la valeur la plus récente détectée par Ev - - - &reftitle.description; - - public - array - EvStat::attr - - - - Retourne un tableau des valeurs les plus récentes détectées par Ev. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un tableau des valeurs les plus récentes détectées par Ev - (sans le stat courant) : - - Liste des clés du tableau retourné par la méthode <methodname>EvStat::attr</methodname> - - - - Clé - Description - - - - - - 'dev' - - ID du périphérique contenant le fichier - - - - 'ino' - - nombre d'inodes - - - - 'mode' - - protection - - - - 'nlink' - - nombre de liens durs - - - - 'uid' - - ID de l'utilisateur du propriétaire - - - - 'size' - - taille totale, en octets - - - - 'gid' - - ID du groupe du propriétaire - - - - 'rdev' - - ID du périphérique (si fichier spécial) - - - - 'blksize' - - taille du bloc pour un système de fichiers I/O - - - - 'blocks' - - nombre de blocs 512B alloués - - - - 'atime' - - Date/heure du dernier accès - - - - 'ctime' - - Date/Heure de la dernière modification de statut - - - - 'mtime' - - Date/heure de la dernière modification - - - -
- - - Voir la page du manuel sur stat(2) - pour plus de détails. - - - - &reftitle.examples; - - Surveillance des modifications dans /var/log/messages - -attr(); - - if ($attr['nlink']) { - printf("Current size: %ld\n", $attr['size']); - printf("Current atime: %ld\n", $attr['atime']); - printf("Current mtime: %ld\n", $attr['mtime']); - } else { - fprintf(STDERR, "Le fichier `messages` est introuvable !"); - $w->stop(); - } -}); - -Ev::run(); -?> -]]> - - - - - &reftitle.seealso; - - - EvStat::prev - - - EvStat::stat - - - - - diff --git a/reference/ev/evstat/construct.xml b/reference/ev/evstat/construct.xml deleted file mode 100644 index e04607be80..0000000000 --- a/reference/ev/evstat/construct.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - EvStat::__construct - Construit un objet EvStat watcher - - - &reftitle.description; - - public - EvStat::__construct - - string - path - - - float - interval - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Construit un objet EvStat watcher et démarre le watcher automatiquement. - - - - &reftitle.parameters; - - - - path - - - - Le chemin pour lequel on attend une modification de statut. - - - - - - interval - - - - Intervalle de détection d'une modification ; devrait valoir normalement - 0.0 pour laisser libev - choisir la bonne valeur. - - - - - - callback - - - - Voir les - fonctions de rappel Watcher. - - - - - - data - - - - Données personnalisées à associer avec le watcher. - - - - - - priority - - - - Les priorités du Watcher - - - - - - - - &reftitle.examples; - - - Surveillance des modifications dans le dossier /var/log/messages - -attr(); - - if ($attr['nlink']) { - printf("Current size: %ld\n", $attr['size']); - printf("Current atime: %ld\n", $attr['atime']); - printf("Current mtime: %ld\n", $attr['mtime']); - } else { - fprintf(STDERR, "Le fichier `messages` est introuvable !"); - $w->stop(); - } -}); - -?> -]]> - - - - - diff --git a/reference/ev/evstat/createstopped.xml b/reference/ev/evstat/createstopped.xml deleted file mode 100644 index aa08326e58..0000000000 --- a/reference/ev/evstat/createstopped.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - EvStat::createStopped - Crée un objet EvStat watcher stoppé - - - &reftitle.description; - - final - public - static - void - EvStat::createStopped - - string - path - - - float - interval - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée un objet EvStat watcher, mais ne le démarre pas automatiquement - (contrairement à la méthode EvStat::__construct). - - - - &reftitle.parameters; - - - - path - - - - Le chemin pour lequel on doit attendre un changement de statut. - - - - - - interval - - - - Intervalle de détection de la modification ; doit normalement valoir - 0.0 pour laisser libev - choisir une bonne valeur. - - - - - - callback - - - - Voir les - fonctions de rappel Watcher. - - - - - - data - - - - Données personnalisées à associer avec le watcher. - - - - - - priority - - - - les priorités du Watcher - - - - - - - &reftitle.returnvalues; - - Retourne un objet EvStat watcher stoppé en cas de succès. - - - - &reftitle.seealso; - - - EvStat::__construct - - - EvWatcher::start - - - - - diff --git a/reference/ev/evstat/prev.xml b/reference/ev/evstat/prev.xml deleted file mode 100644 index fd5ad7b210..0000000000 --- a/reference/ev/evstat/prev.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - EvStat::prev - Retourne le jeu précédent retourné par EvStat::attr - - - &reftitle.description; - - public - void - EvStat::prev - - - - Identique à la méthode EvStat::attr - mais retourne le jeu précédent de valeurs. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un tableau avec la même structure que le tableau retourné par - la méthode EvStat::attr. Le tableau contiendra - les valeurs précédemment détectées. - - - - &reftitle.seealso; - - - EvStat::attr - - - EvStat::stat - - - - - diff --git a/reference/ev/evstat/set.xml b/reference/ev/evstat/set.xml deleted file mode 100644 index 84b792c08f..0000000000 --- a/reference/ev/evstat/set.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - EvStat::set - Configure le watcher - - - &reftitle.description; - - public - void - EvStat::set - - string - path - - - float - interval - - - - Configure le watcher. - - - - &reftitle.parameters; - - - - path - - - - Le chemin pour lequel on attendra un changement de statut. - - - - - - interval - - - - Intervalle de détection des modifications ; doit normalement valoir - 0.0 pour laisser libev - choisir une bonne valeur. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evstat/stat.xml b/reference/ev/evstat/stat.xml deleted file mode 100644 index dafe635fc5..0000000000 --- a/reference/ev/evstat/stat.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - EvStat::stat - Initialise l'appel à stat - - - &reftitle.description; - - public - bool - EvStat::stat - - - - Initialise l'appel à stat (mise à jour du cache interne). - La commande va appeler stat (en utilisant lstat) - sur le chemin spécifié path dans le watcher - et définir les valeurs trouvées. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne &true; si path existe. Sinon, &false;. - - - - &reftitle.seealso; - - - EvStat::attr - - - EvStat::prev - - - - - diff --git a/reference/ev/evtimer.xml b/reference/ev/evtimer.xml deleted file mode 100644 index 01e069322e..0000000000 --- a/reference/ev/evtimer.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - La classe EvTimer - EvTimer - - -
- &reftitle.intro; - - Les watchers EvTimer sont des watchers relativement - simples qui génèrent un événement après une durée fournie, et, optionnellement, - se répètent dans un intervalle régulier. - - - Les minuteurs sont basés sur un temps réel, aussi, si un minuteur enregistre - un événement qui se termine après une heure et ré-initialise l'horloge système - à janvier de l'an passé, il sera de nouveau - hors délai après une heure (approximativement). "Approximativement" - car la détection des sauts dans le temps est dure, et certaines inexactitudes - sont inévitables. - - - Il est garanti que la fonction de rappel sera appelée uniquement après - l'expiration du délai maximal d'attente (et non exactement à ce moment précis, - aussi, sur des systèmes avec une horloge basse résolution, il se peut qu'un - petit délai soit introduit). Si plusieurs minuteurs deviennent - prêts pendant la même itération de boucle, alors celui dont la valeur - du délai d'attente maximal sera la plus proche sera invoqué avant l'autre - ayant une priorité identique mais avec une valeur du délai d'attente plus - éloignée (mais ceci n'est plus vrai lorsqu'une fonction de rappel appelle - récursivement la méthode EvLoop::run). - - - Le minuteur lui-même va faire tout ce qu'il lui est possible pour ne pas - dériver, mais, si un minuteur est configuré pour se lancer toutes les - 10 secondes, alors il va normalement se lancer - à intervalle de 10 secondes exactement. - Cependant, si le script ne peut pas conserver le minuteur car il prend - plus de temps que ses 10 secondes, le minuteur - ne pourra pas se lancer plus d'une fois par itération de boucle - d'événements. - -
- -
- &reftitle.classsynopsis; - - - - - EvTimer - - - - - EvTimer - - - extends - EvWatcher - - - - &Properties; - - public - repeat - - - public - remaining - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - repeat - - - - Si cette propriété vaut 0.0, alors il sera automatiquement - stoppé une fois le délai maximal d'attente atteint. S'il est positif, - alors le minuteur sera automatiquement configuré à se lancer à chaque - seconde en suivant, tant qu'il ne sera pas stoppé manuellement. - - - - - - remaining - - - - Retourne le temps restant avant que le minuteur ne se lance. - Si le minuteur est actif, alors ce temps sera relatif au temps de - la boucle d'événements courante, sinon, il sera relatif à la - valeur du délai d'attente maximal actuellement configuré. - - - Aussi, après l'instanciation d'un EvTimer - avec une valeur de after à - 5.0 et une valeur de repeat - à 7.0, remaining retournera - 5.0. Lorsque le minuteur est démarré, et qu'une - seconde se passe, remaining retourne - 4.0. Lorsque le minuteur expire et qu'il est - redémarré, il retournera approximativement 7.0 - (probablement un peu moins sachant que l'invocation de la fonction de rappel - prend un peu de temps aussi), et ainsi de suite. - - - - -
- - - - &reference.ev.entities.evtimer; - - - diff --git a/reference/ev/evtimer/again.xml b/reference/ev/evtimer/again.xml deleted file mode 100644 index da2ec66c3a..0000000000 --- a/reference/ev/evtimer/again.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - EvTimer::again - Re-démarre le watcher Timer - - - &reftitle.description; - - public - void - EvTimer::again - - - - Cette méthode fonctionne comme si le Timer s'était terminé, et re-commence - son cycle. La sémantique exacte est : - - - - - si le Timer est en attente, son statut est nettoyé. - - - - - si le Timer est commencé, mais ne doit pas re-commencer, alors il sera - stoppé (comme s'il s'était terminé normalement). - - - - - si le Timer doit re-commencer, soit la méthode le démarre si nécessaire - (avec la valeur repeat), ou ré-initialise le Timer à la - valeur de la variable repeat. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvWatcher::stop - - - - - diff --git a/reference/ev/evtimer/construct.xml b/reference/ev/evtimer/construct.xml deleted file mode 100644 index 7a51a4691e..0000000000 --- a/reference/ev/evtimer/construct.xml +++ /dev/null @@ -1,220 +0,0 @@ - - - - - - EvTimer::__construct - Construit un objet EvTimer watcher - - - &reftitle.description; - - public - EvTimer::__construct - - float - after - - - float - repeat - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Construit un objet EvTimer watcher. - - - - &reftitle.parameters; - - - - after - - - - Configure le timer pour se déclencher après - after secondes. - - - - - - repeat - - - - Si ce paramètre vaut 0.0, alors le watcher - sera automatiquement stoppé lorsque le délai maximal d'attente sera - atteint. Si ce paramètre est positif, alors le timer sera automatiquement - configuré pour se déclencher à nouveau toutes les repeat - secondes, tant qu'il ne sera pas stoppé manuellement. - - - - - - callback - - - - Voir les - fonctions de rappel Watcher. - - - - - - data - - - - Données personnalisées associées avec le watcher. - - - - - - priority - - - - Les priorités du Watcher - - - - - - - - &reftitle.examples; - - Timers simples - -stop(); - // Stoppe le watcher si les appels suivants provoquent plus de 10 itérations - Ev::iteration() >= 10 and $w->stop(); -}); - -// Crée un timer stoppé. Il sera inactif tant que nous ne le démarrons pas nous même -$w_stopped = EvTimer::createStopped(10, 5, function($w) { - echo "Fonction de rappel du timer créé stoppé\n"; - - // Stoppe le watcher après 2 itérations - Ev::iteration() >= 2 and $w->stop(); -}); - -// Boucle jusqu'à ce que Ev::stop() soit appelé ou que tous les watchers s'arrêtent -Ev::run(); - -// Démarre et regarde si ça fonctionne -$w_stopped->start(); -echo "Exécution d'une seule itération\n"; -Ev::run(Ev::RUN_ONCE); - -echo "Redémarre le second watcher et tente de gérer les mêmes événements, mais ne bloque pas\n"; -$w2->again(); -Ev::run(Ev::RUN_NOWAIT); - -$w = new EvTimer(10, 0, function() {}); -echo "Exécution d'une boucle bloquante\n"; -Ev::run(); -echo "FIN\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EvTimer::createStopped - - - EvPeriodic - - - ev_timer - répétition d'un délai d'attente maximal - - - Être intelligent avec les délais d'attente maximaux - - - - - diff --git a/reference/ev/evtimer/createstopped.xml b/reference/ev/evtimer/createstopped.xml deleted file mode 100644 index 2892b709b2..0000000000 --- a/reference/ev/evtimer/createstopped.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - EvTimer::createStopped - Crée un objet EvTimer watcher stoppé - - - &reftitle.description; - - final - public - static - EvTimer - EvTimer::createStopped - - float - after - - - float - repeat - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crée un objet EvTimer watcher stoppé. Contrairement à la méthode - EvTimer::__construct, cette méthode ne - démarre pas automatiquement le watcher. - - - - &reftitle.parameters; - - - - after - - - - Configure le timer pour lancer un trigger après - after secondes. - - - - - - repeat - - - - Si ce paramètre vaut 0.0, alors le watcher - sera automatiquement stoppé une fois le délai maximal d'attente atteint. - Si ce paramètre est positif, alors le timer va automatiquement - lancer le trigger à chaque seconde suivante, et ce, tant qu'il ne - sera pas stoppé manuellement. - - - - - - callback - - - - Voir les - fonctions de rappel Watcher. - - - - - - data - - - - Données personnelles associées au watcher. - - - - - - priority - - - - Les priorités du Watcher - - - - - - - &reftitle.returnvalues; - - Retourne un objet EvTimer watcher en cas de succès. - - - - &reftitle.examples; - - Surveillance des modifications dans /var/log/messages. - Détecte les mises à jour oubliées en ajoutant une seconde de délai - -stop(); - - $stat = $w->data; - - // 1 seconde après la modification la plus récente du fichier - printf("Current size: %ld\n", $stat->attr()['size']); -}); - -$stat = new EvStat("/var/log/messages", 0., function () use ($timer) { - // Réinitialise le watcher timer - $timer->again(); -}); - -$timer->data = $stat; - -Ev::run(); -?> -]]> - - - - - &reftitle.seealso; - - - EvTimer::__construct - - - EvPeriodic - - - - - diff --git a/reference/ev/evtimer/set.xml b/reference/ev/evtimer/set.xml deleted file mode 100644 index fb35ae024f..0000000000 --- a/reference/ev/evtimer/set.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - EvTimer::set - Configure le watcher - - - &reftitle.description; - - public - void - EvTimer::set - - float - after - - - float - repeat - - - - Configure le watcher - - - - &reftitle.parameters; - - - - after - - - - Configure le timer du trigger à lancer après - after secondes. - - - - - - repeat - - - - Si ce paramètre vaut 0.0, alors le watcher sera - automatiquement stoppé si le délai d'attente maximal est atteint. - Si ce paramètre est positif, alors le timer va automatiquement lancer le - trigger à chaque seconde suivante, tant qu'il ne sera pas stoppé manuellement. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evwatcher.xml b/reference/ev/evwatcher.xml deleted file mode 100644 index 2ff33a75fa..0000000000 --- a/reference/ev/evwatcher.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - La classe EvWatcher - EvWatcher - - -
- &reftitle.intro; - - La classe EvWatcher est une classe de base - pour tous les watchers (EvCheck, EvChild - etc.). Vu que le constructeur de la classe EvWatcher - est abstrait, on ne peut pas - (et on ne doit pas) créer des objets EvWatcher directement. - -
- -
- &reftitle.classsynopsis; - - - - - EvWatcher - - - - - abstract - EvWatcher - - - - &Properties; - - public - is_active - - - public - data - - - public - is_pending - - - public - priority - - &Methods; - - - - -
- -
- &reftitle.properties; - - - - is_active - - - - En lecture seule. &true; si le watcher est - actif, &false; sinon. - - - - - - data - - - - Données utilisateur personnalisées associées avec le watcher - - - - - - is_pending - - - - En lecture seule. &true; si le watcher est en attente, - c.-à-d. si le watcher a des événements en attente, mais que sa fonction - de rappel n'a pas encore été appelée, &false; sinon. Tant que le - watcher est en attente (mais non actif), un autre ne peut pas - modifier ses priorités. - - - - - - priority - - - - &integer; - Intervalle entre Ev::MINPRI et Ev::MAXPRI. - Les watchers en attente avec une priorité haute seront appelés - avant les watchers avec une priorité basse, mais la priorité ne peut pas - faire qu'un watcher ne sera jamais exécuté (sauf pour les watchers - EvIdle). - Les watchers EvIdle fournissent des fonctionnalités - permettant de supprimer l'invocation lorsque des événements ayant une priorité - plus élevée sont en attente. - - - - -
- - - - &reference.ev.entities.evwatcher; - - - diff --git a/reference/ev/evwatcher/clear.xml b/reference/ev/evwatcher/clear.xml deleted file mode 100644 index b4f6c4933a..0000000000 --- a/reference/ev/evwatcher/clear.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - EvWatcher::clear - Efface le statut d'attente de l'observateur - - - &reftitle.description; - - public - int - EvWatcher::clear - - - - Si l'observateur est en attente, cette méthode efface son statut - d'attente (pending) et retourne son bitset - revents (comme si sa fonction de rappel avait été invoquée). - Si l'observateur n'est pas en attente, cette méthode ne fera rien, - et retournera 0. - - - Quelques fois, il est utile d'interroger un observateur plutôt que d'attendre - que sa fonction de rappel ne soit invoquée, et c'est bien ce que permet - de faire cette méthode. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Dans le cas où l'observateur est en attente, retourne le bitset - revents, comme si sa fonction de rappel était invoquée. - Sinon, retourne 0. - - - - - diff --git a/reference/ev/evwatcher/construct.xml b/reference/ev/evwatcher/construct.xml deleted file mode 100644 index 86fbce61cb..0000000000 --- a/reference/ev/evwatcher/construct.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - EvWatcher::__construct - Constructeur abstrait d'un objet observateur - - - &reftitle.description; - - abstract - public - EvWatcher::__construct - - - - EvWatcher::__construct est un constructeur - abstrait d'un objet observateur, implémenté dans les classes dérivées. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - diff --git a/reference/ev/evwatcher/feed.xml b/reference/ev/evwatcher/feed.xml deleted file mode 100644 index 622e394fe9..0000000000 --- a/reference/ev/evwatcher/feed.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - EvWatcher::feed - Alimente les revents fournis dans la boucle d'événements - - - &reftitle.description; - - public - void - EvWatcher::feed - - int - revents - - - - Alimente les revents fournis dans la boucle d'événements, - comme si l'événement spécifié était survenu dans l'observateur. - - - - &reftitle.parameters; - - - - revents - - - - Masque de bits de l'observateur - de réception d'événements. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evwatcher/getloop.xml b/reference/ev/evwatcher/getloop.xml deleted file mode 100644 index 3a0b400578..0000000000 --- a/reference/ev/evwatcher/getloop.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - EvWatcher::getLoop - Retourne la boucle responsable de l'observateur - - - &reftitle.description; - - public - EvLoop - EvWatcher::getLoop - - - - Retourne la boucle responsable de l'observateur. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un objet EvLoop - responsable de l'observateur. - - - - diff --git a/reference/ev/evwatcher/invoke.xml b/reference/ev/evwatcher/invoke.xml deleted file mode 100644 index cf92b135b5..0000000000 --- a/reference/ev/evwatcher/invoke.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - EvWatcher::invoke - Invoque la fonction de rappel de l'observateur avec - le masque de bits des événements reçus fournis - - - &reftitle.description; - - public - void - EvWatcher::invoke - - int - revents - - - - Invoque la fonction de rappel de l'observateur avec - le masque de bits des événements reçus fournis. - - - - &reftitle.parameters; - - - - revents - - - - Masque de bits de l'observateur - qui reçoit les événements. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evwatcher/keepalive.xml b/reference/ev/evwatcher/keepalive.xml deleted file mode 100644 index 9d4c72b09b..0000000000 --- a/reference/ev/evwatcher/keepalive.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - EvWatcher::keepalive - Configure si la boucle doit être empêchée de se terminer - - - &reftitle.description; - - public - bool - EvWatcher::keepalive - - bool - value - - - - Configure si la boucle doit être empêchée de se terminer. Avec un paramètre value - défini à &false;, le Watcher n'empêchera pas les méthodes - Ev::run/EvLoop::run - de s'arrêter même si le Watcher est actif. - - - Les Watchers ont, par défaut, un paramètre - value défini à &true;. - - - Le fait de nettoyer le statut « keepalive » est utile lorsqu'il est - indésirable de sortir des méthodes Ev::run/EvLoop::run - uniquement à cause de ce Watcher. Ce peut être un Watcher socket UDP - qui fonctionne longtemps. - - - - &reftitle.parameters; - - - - value - - - - Si vaut &false;, le Watcher ne va pas empêcher les méthodes - Ev::run/EvLoop::run - de se terminer, même si le Watcher est actif. - - - - - - - &reftitle.returnvalues; - - Retourne le précédent statut. - - - - &reftitle.examples; - - Enregistre un Watcher I/O pour un socket UDP mais sans maintenir la - boucle d'événements active uniquement à cause de ce Watcher. - -keepalive(FALSE); -?> -]]> - - - - - diff --git a/reference/ev/evwatcher/setcallback.xml b/reference/ev/evwatcher/setcallback.xml deleted file mode 100644 index 9759794fcd..0000000000 --- a/reference/ev/evwatcher/setcallback.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - EvWatcher::setCallback - Définit une nouvelle fonction de rappel pour le watcher - - - &reftitle.description; - - public - void - EvWatcher::setCallback - - callable - callback - - - - Définit une nouvelle fonction de rappel pour le watcher. - - - - &reftitle.parameters; - - - - callback - - - - Voir les - fonctions de rappel pour les Watchers. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evwatcher/start.xml b/reference/ev/evwatcher/start.xml deleted file mode 100644 index 1fa2e625b0..0000000000 --- a/reference/ev/evwatcher/start.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - EvWatcher::start - Démarre le Watcher - - - &reftitle.description; - - public - void - EvWatcher::start - - - - Marque le Watcher comme actif. Il est à noter que seuls les Watchers actifs - recevront les événements. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvWatcher::stop - - - - - diff --git a/reference/ev/evwatcher/stop.xml b/reference/ev/evwatcher/stop.xml deleted file mode 100644 index 7535b1313c..0000000000 --- a/reference/ev/evwatcher/stop.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - EvWatcher::stop - Arrête le Watcher - - - &reftitle.description; - - public - void - EvWatcher::stop - - - - Marque le Watcher comme étant inactif. Il est à noter que seuls les Watchers actifs - recevront les événements. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvWatcher::start - - - - - diff --git a/reference/ev/examples.xml b/reference/ev/examples.xml deleted file mode 100644 index 95a3d7591c..0000000000 --- a/reference/ev/examples.xml +++ /dev/null @@ -1,439 +0,0 @@ - - - - - - - &reftitle.examples; - - Exemple de minuteurs - -stop(); - // Stoppe le watcher si les prochains appels provoquent plus de 10 itérations - Ev::iteration() >= 10 and $w->stop(); -}); - -// Crée un minuteur stoppé. Il restera inactif tant que nous ne le démarrons pas nous même -$w_stopped = EvTimer::createStopped(10, 5, function($w) { - echo "Fonction de rappel d'un minuteur créé arrêté\n"; - - // Stoppe le watcher après 2 itérations - Ev::iteration() >= 2 and $w->stop(); -}); - -// Boucle tant que Ev::stop() n'est pas appelé ou que tous les watchers ne soient stoppés -Ev::run(); - -// Démarre et regarde si ça fonctionne -$w_stopped->start(); -echo "Exécute une seule itération\n"; -Ev::run(Ev::RUN_ONCE); - -echo "Redémarre le second watcher et tente de gérer le même événement, mais ne bloque pas\n"; -$w2->again(); -Ev::run(Ev::RUN_NOWAIT); - -$w = new EvTimer(10, 0, function() {}); -echo "Exécution d'une boucle bloquante\n"; -Ev::run(); -echo "END\n"; -?> -]]> - - &example.outputs.similar; - - - - - - Minuteur périodique. Alerte toutes les 10.5 secondes - - -]]> - - - - Minuteur périodique. Utilisation de la fonction de rappel de reprogrammation - - - -]]> - - - - Minuteur périodique. Alerte toutes les 10.5 secondes, en commençant maintenant - - -]]> - - - - Attend que STDIN devienne accessible en lecture - - -]]> - - - - Utilisation de quelques I/O asynchrones pour accéder à un socket - -stop(); - // Stoppe le watcher write - $w->stop(); - - $in = "HEAD / HTTP/1.1\r\n"; - $in .= "Host: google.co.uk\r\n"; - $in .= "Connection: Close\r\n\r\n"; - - if (!socket_write($socket, $in, strlen($in))) { - trigger_error("Échec lors de l'écriture de $in dans le socket", E_USER_ERROR); - } - - $read_watcher = new EvIo($socket, Ev::READ, function ($w, $re) - use ($socket, $e_nonblocking) - { - // Le socket est accessible en lecture. recv() a reçu 20 octets en utilisant le mode non bloquant - $ret = socket_recv($socket, $out, 20, MSG_DONTWAIT); - - if ($ret) { - echo $out; - } elseif ($ret === 0) { - // Tout a été lu - $w->stop(); - socket_close($socket); - return; - } - - // On attrape EINPROGRESS, EAGAIN, ou EWOULDBLOCK - if (in_array(socket_last_error(), $e_nonblocking)) { - return; - } - - $w->stop(); - socket_close($socket); - }); - - Ev::run(); -}); - -$result = socket_connect($socket, $address, $service_port); - -Ev::run(); -?> -]]> - - &example.outputs.similar; - - - - - - Encapsule une boucle dans une autre - - -]]> - - - - Encapsule une boucle créée avec le backend kqueue dans la boucle par défaut - - -]]> - - - - Gestion du signal SIGTERM - -stop(); -}); - -Ev::run(); -?> -]]> - - - - Surveillance des modifications dans /var/log/messages - -attr(); - - if ($attr['nlink']) { - printf("Taille courante : %ld\n", $attr['size']); - printf("atime actuel : %ld\n", $attr['atime']); - printf("mtime actuel : %ld\n", $attr['mtime']); - } else { - fprintf(STDERR, "Le fichier `messages` n'est plus ici !"); - $w->stop(); - } -}); - -Ev::run(); -?> -]]> - - - - Surveillance des modifications dans /var/log/messages. On regarde les modifications avec une seconde de délai - -stop(); - - $stat = $w->data; - - // 1 seconde après la dernière modification d'un fichier - printf("Taille actuelle : %ld\n", $stat->attr()['size']); -}); - -$stat = new EvStat("/var/log/messages", 0., function () use ($timer) { - // Réinitialise le watcher timer - $timer->again(); -}); - -$timer->data = $stat; - -Ev::run(); -?> -]]> - - - - Modification du statut d'un processus - -stop(); - - printf("Le processus %d est sorti avec un statut %d\n", $w->rpid, $w->rstatus); - }); - - Ev::run(); - - // Protection contre les Zombies - pcntl_wait($status); -} else { - // On fork le fils - exit(2); -} -?> -]]> - - - - - diff --git a/reference/ev/periodic-modes.xml b/reference/ev/periodic-modes.xml deleted file mode 100644 index e47f56bcf2..0000000000 --- a/reference/ev/periodic-modes.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - Modes d'opération périodique d'un watcher - - Le watcher EvPeriodic fonctionne en différents - modes suivant les paramètres offset, - interval et reschedule_cb. - - - - - Le mode Minuterie absolue. Dans ce mode, - interval = 0, - reschedule_cb = &null;. - L'appel se fera à l'heure d'horloge offset - et ne sera pas répété. Il ne sera pas ajusté lorsqu'un bond dans le temps - surviendra, aussi, s'il doit être exécuté à - 1er janvier 2014, alors il le sera lorsque l'heure - système sera atteinte, ou dépassée. - - - - - Le mode Minuterie avec répétition par intervalle. - Dans ce mode, interval > 0, - reschedule_cb = &null; ; le watcher sera automatiquement - programmé pour se terminer à la prochaine durée - offset + N * interval - (pour un entier N) puis, se répète, indépendamment des sauts - dans le temps. - - - Il peut être utilisé pour créer des minuteries qui ne dérivent pas en respectant - l'horloge système : - - -]]> - - Cela ne signifie pas qu'il y aura toujours 3600 secondes - entre chaque appel, mais seulement que la fonction de rappel sera appelée - lorsque l'horloge système affichera une heure pleine (UTC). - - - La classe EvPeriodic va tenter d'exécuter la fonction - de rappel dans ce mode à la prochaine heure possible où - time = offset (mod - interval), indépendamment des sauts dans le temps. - - - - - Le mode reprogrammation manuelle. Dans ce mode, - reschedule_cb est un callable. - - - interval et offset - seront tous les deux ignorés. À la place, chaque fois que le watcher périodique - est prévu, la fonction de rappel de reprogrammation (reschedule_cb) - sera appelée avec le watcher d'abord, et le temps courant comme second argument. - - - Cette fonction de rappel ne doit pas stopper ou détruire - ce watcher périodique, ni un autre, et ne doit pas - appeler de fonctions ou de méthodes de boucle d'événements. Pour le stopper, - il faut retourner 1e30 et le stopper après. Un watcher - EvPrepare peut être utilisé pour réaliser cette tâche. - - - Il doit retourner la prochaine heure d'appel, en se basant sur la valeur - du temps passé (la plus petite valeur de temps doit être supérieure - ou égale au second argument). Il sera appelé, habituellement, juste après - que la fonction de rappel ne soit lancée, mais possiblement à d'autres moments. - - - Utilisation de rappel de reprogrammation - - -]]> - - - - - - diff --git a/reference/ev/setup.xml b/reference/ev/setup.xml deleted file mode 100644 index 8c8508b5d2..0000000000 --- a/reference/ev/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - La bibliothèque libev est incluse dans - cette extension. Il n'est pas nécessaire de l'installer séparément. - -
-
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;ev. - -
- - diff --git a/reference/ev/watcher-callbacks.xml b/reference/ev/watcher-callbacks.xml deleted file mode 100644 index 867b94b3bd..0000000000 --- a/reference/ev/watcher-callbacks.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - Les fonctions de rappel d'un Watcher - - Tous les watchers peuvent être actifs (en attente d'événements) ou inactifs - (en pause). Seuls les watchers actifs peuvent avoir leurs fonctions de rappel - appelées. Toutes les fonctions de rappel seront appelées avec au moins deux - arguments : - watcher - le watcher, et revents, - un masque d'événements reçus. - - - Les fonctions de rappel des watchers sont passées aux constructeurs des watchers - (une classe dérivée de EvWatcher - - EvCheck::__construct, EvChild::__construct - etc.). Une fonction de rappel d'un watcher doit correspondre au prototype suivant : - - - void - callback - - object - watcher - NULL - - - int - revents - NULL - - - - - - watcher - - - - L'instance du watcher (d'une classe étendant EvWatcher). - - - - - - revents - - - - Les événements reçus par le watcher. - - - - - - Chaque type de watcher a un bit d'associé dans - revents, aussi, on peut utiliser la même - fonction de rappel pour plusieurs watchers. Le masque d'événements - est nommé après le type, c.-à-d. - EvChild (ou EvLoop::child) définit - Ev::CHILD, EvPrepare (ou - EvLoop::prepare) définit Ev::PREPARE, - EvPeriodic (ou EvLoop::periodic) - définit Ev::PERIODIC et ainsi de suite, avec comme exception les - événements I/O (qui peuvent définir à la fois les bits - Ev::READ et Ev::WRITE). - - - diff --git a/reference/ev/watchers.xml b/reference/ev/watchers.xml deleted file mode 100644 index 3bf8cec8cc..0000000000 --- a/reference/ev/watchers.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Watchers - - Un watcher est un objet créé pour enregistrer des particularités d'un événement. - Par exemple, le code suivant attend que - STDIN devienne accessible en lecture : - - -]]> - - - - Tous les constructeurs des watchers démarrent automatiquement les watchers. - Les méthodes createStopped créent des watchers stoppés (c.-à-d. - EvIo::createStopped). - - - Il est à noter qu'un watcher sera automatiquement stoppé lorsque l'objet watcher est - détruit. Toutefois, les objets watchers retournés par les constructeurs - ou les méthodes fabriques devraient être conservés. - - - Il est également à noter que toutes les méthodes qui modifient les propriétés - d'un watcher (set, priority etc.) - stoppent et redémarrent automatiquement le watcher s'il est actif, ce qui - signifie que les événements en attente seront perdus. - - - Voir aussi : - Les fonctions de rappel des Watchers. - - - diff --git a/reference/event/book.xml b/reference/event/book.xml deleted file mode 100644 index 2185b8206d..0000000000 --- a/reference/event/book.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - Event - Event - - &reftitle.intro; - - Ceci est une extension pour planifier efficacement les I/O, les temps - et les signaux basés sur les événements en utilisant le meilleur - mécanisme de notification d'I/O disponible sur une plateforme spécifique. C'est un portage - de libevent pour l'infrastructure PHP. - - - - Il est à noter que le support Windows a été introduit en - event-1.9.0. - - - - La version 1.0.0 introduit une nouvelle API - orientée objet (cassant la compatibilité ascendante), et - le support de libevent 2+, incluant HTTP, DNS, - OpenSSL et l'écoute d'événements. - - - - Il est à noter que event-1.0.0 et supérieur n'est pas compatible - avec les versions précédentes. - - - - &reference.event.setup; - &reference.event.examples; - &reference.event.event.flags; - &reference.event.event.persistence; - &reference.event.event.callbacks; - &reference.event.event.constructing.signal.events; - &reference.event.event; - &reference.event.eventbase; - &reference.event.eventbuffer; - &reference.event.eventbufferevent; - &reference.event.eventbufferevent.about.callbacks; - &reference.event.eventconfig; - &reference.event.eventdnsbase; - &reference.event.eventhttp; - &reference.event.eventhttpconnection; - &reference.event.eventhttprequest; - &reference.event.eventlistener; - &reference.event.eventsslcontext; - &reference.event.eventutil; - &reference.event.eventexception; - - - diff --git a/reference/event/configure.xml b/reference/event/configure.xml deleted file mode 100644 index 5afbecd859..0000000000 --- a/reference/event/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;event - -
- diff --git a/reference/event/event.callbacks.xml b/reference/event/event.callbacks.xml deleted file mode 100644 index 444fbaa3fa..0000000000 --- a/reference/event/event.callbacks.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Fonctions de rappel des événements - - Si une fonction de rappel est enregistrée pour un événement, elle - sera appelée lorsque l'événement devient actif. Pour associer une fonction - de rappel avec un événement, il convient de la passer avec un type - callable à la méthode Event::__construct, - Event::set, ou toute autre méthode de fabrique comme - Event::timer. - - - Une fonction de rappel d'événement doit correspondre au prototype suivant : - - - void - callback - - mixed - fd - &null; - - - int - what - - - mixed - arg - &null; - - - - - - fd - - - - Un descripteur de fichier, une ressource de flux, ou un socket - associé avec l'événement. Pour les événements de type signal, - fd correspond au numéro du signal. - - - - - - what - - - - Masque de bits de tous les événements lancés. - - - - - - arg - - - - Données utilisateurs personnalisées. - - - - - - La méthode Event::timer attend une fonction - de rappel qui correspond au prototype suivant : - - - void - callback - - mixed - arg - &null; - - - - - - arg - - - - Données utilisateurs personnalisées. - - - - - - La méthode Event::signal attend une fonction - de rappel correspondant au prototype suivant : - - - void - callback - - int - signum - - - mixed - arg - &null; - - - - - - signum - - - - Le numéro du signal lancé (c.-à-d. SIGTERM). - - - - - - arg - - - - Données utilisateurs personnalisées. - - - - - - diff --git a/reference/event/event.constructing.signal.events.xml b/reference/event/event.constructing.signal.events.xml deleted file mode 100644 index 13ff225183..0000000000 --- a/reference/event/event.constructing.signal.events.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Construction d'un événement de type signal - - Un événement peut aussi surveiller les signaux de style POSIX. - Pour construire un gestionnaire pour un signal, utiliser la méthode - Event::__construct avec le drapeau - Event::SIGNAL ou la méthode de fabrique - Event::signal. - - - Gestion d'un signal <literal>SIGTERM</literal> - -base = $base; - $this->ev = Event::signal($base, SIGTERM, array($this, 'eventSighandler')); - $this->ev->add(); - } - - public function eventSighandler($no, $c) { - echo "Caught signal $no\n"; - $this->base->exit(); - } -} - -$base = new EventBase(); -$c = new MyEventSignal($base); - -$base->loop(); -?> -]]> - - - - Il est à noter que les fonctions de rappel d'un signal sont exécutées dans la - boucle d'événement après que le signal est survenu, aussi, - il est plus sûr pour le signal d'appeler des fonctions depuis la boucle - que l'on n'est pas supposé appeler depuis un gestionnaire de signaux - POSIX classique. - - - - Voir aussi la - - programmation réseau facile, portable et non bloquante avec Libevent ; Construction - d'un événement de type signal. - - - - diff --git a/reference/event/event.flags.xml b/reference/event/event.flags.xml deleted file mode 100644 index 621d84f8cb..0000000000 --- a/reference/event/event.flags.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Les drapeaux d'événements - - Event::READ - Ce drapeau indique que l'événement devient actif lorsque le descripteur - de fichier fourni (habituellement une ressource de flux ou un socket) est prêt - à être lu. - - - Event::WRITE - Ce drapeau indique que l'événement devient actif lorsque le descripteur - de fichier fourni (habituellement, une ressource de flux ou un socket) - est prêt à être écrit. - - - Event::SIGNAL - Ce drapeau est utilisé pour implémenter la détection de signaux. Voir - la création d'un événement de type signal ci-dessous. - - - Event::TIMEOUT - Ce drapeau indique que l'événement devient actif après l'expiration - d'un délai maximal. Le drapeau Event::TIMEOUT - est ignoré lors de la construction d'un événement : un délai peut - être défini lors de l'ajout de l'événement, ou non. - Il est défini dans l'argument $what de la fonction - de rappel lorsque le délai maximal est atteint. - - - Voir aussi - - la programmation réseau facile, portable et non bloquante avec Libevent ; les travaux - avec les événements et leurs drapeaux - - - - diff --git a/reference/event/event.persistence.xml b/reference/event/event.persistence.xml deleted file mode 100644 index 6a6194067a..0000000000 --- a/reference/event/event.persistence.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - À propos de la persistance des événements - - Par défaut, dès qu'un événement en attente devient actif (car son descripteur - de fichier est prêt à être lu ou écrit, ou parce que son délai d'attente - maximal est atteint), il n'est plus en attente dès lors que sa fonction - de rappel est exécutée. Aussi, pour rendre de nouveau l'événement en attente, - une façon est d'appeler la méthode Event::add - dans la fonction de rappel. - - - Si le drapeau Event::PERSIST est défini sur l'événement, - alors il est persistant. Cela signifie que - l'événement reste en attente y compris lorsque sa fonction de rappel - est activée. La méthode Event::del peut être - appelée pour le passer en non-attente. - - - Le délai maximal d'attente sur un événement persistant est réinitialisé - dès lors que sa fonction de rappel est exécutée. - Aussi, si un événement a comme drapeaux Event::READ - | Event::PERSIST et un - délai d'attente fixé à 5 secondes, l'événement devient actif : - - - - - Lorsque le socket ou le descripteur de fichier est prêt pour la lecture. - - - - - Lorsque 5 secondes ont passé depuis la dernière activation de l'événement. - - - - - Voir aussi - - la programmation réseau rapide, portable et non-bloquante avec Libevent ; - À propos des événements persistants - - - diff --git a/reference/event/event.xml b/reference/event/event.xml deleted file mode 100644 index 9509d13eb3..0000000000 --- a/reference/event/event.xml +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - La classe Event - Event - - -
- &reftitle.intro; - - La classe Event représente et lance un événement - sur un descripteur de fichier devenu prêt pour une lecture ou une écriture ; - un descripteur de fichier devient prêt pour une lecture ou une écriture - (I/O edge-triggered uniquement) ; un délai d'attente expiré ; un signal survenant ; - un événement lancé par l'utilisateur. - - - Chaque événement est associé avec un EventBase. - Cependant, l'événement ne sera jamais lancé tant qu'il n'a pas été - ajouté (via la méthode Event::add). - Un événement ajouté reste dans un statut d'attente - tant que l'événement enregistré ne survient pas, le passant ainsi en - statut actif. Pour gérer les événements, l'utilisateur - doit enregistrer une fonction de rappel qui sera appelée lorsque l'événement - devient actif. Si l'événement est configuré comme persistant, - il restera en attente. S'il n'est pas persistant, il ne sera plus en attente - lorsque sa fonction de rappel sera exécutée. La méthode Event::del - supprime l'événement, il n'est alors plus en attente. - En appelant la méthode Event::add, il sera ajouté - de nouveau. - -
- -
- &reftitle.classsynopsis; - - - - - Event - - - - - final - Event - - - - &Constants; - - const - int - Event::ET - 32 - - - const - int - Event::PERSIST - 16 - - - const - int - Event::READ - 2 - - - const - int - Event::WRITE - 4 - - - const - int - Event::SIGNAL - 8 - - - const - int - Event::TIMEOUT - 1 - - &Properties; - - public - readonly - bool - pending - - &Methods; - - - -
- -
- &reftitle.properties; - - - - pending - - - - Si l'événement est en attente. Voir la section : - À propos de la persistance des événements. - - - - -
- - -
- &reftitle.constants; - - - - Event::ET - - - - Indique que l'événement doit être edge-triggered, si le backend de la - base d'événement sous-jacente supporte les événements edge-triggered. - Ceci affecte la sémantique - de Event::READ et de Event::WRITE. - - - - - - Event::PERSIST - - - - Indique que l'événement est persistant. Voir la section : - À propos de la persistance des événements. - - - - - - Event::READ - - - - Ce drapeau indique qu'un événement devient actif lorsque le descripteur - de fichier fourni (habituellement, une ressource de flux ou un socket) - est prêt pour une lecture. - - - - - - Event::WRITE - - - - Ce drapeau indique qu'un événement devient actif lorsque le descripteur - de fichier fourni (habituellement, une ressource de flux ou un socket) - est prêt pour une écriture. - - - - - - Event::SIGNAL - - - - Utilisé pour implémenter une détection de signal. Voir la section ci-dessous - sur la construction d'un événement de type signal. - - - - - - Event::TIMEOUT - - - - Ce drapeau indique qu'un événement devient actif après l'expiration - de ce délai d'attente maximal. - - - Le drapeau Event::TIMEOUT est ignoré lors de la - construction d'un événement : il peut être indiqué ou non lors de - l'ajout de l'événement. Il doit être défini dans - l'argument $what de la fonction de rappel - lorsqu'un délai d'attente maximal est survenu. - - - - -
- - - - &reference.event.entities.event; - - - diff --git a/reference/event/event/add.xml b/reference/event/event/add.xml deleted file mode 100644 index 9d3299bcb5..0000000000 --- a/reference/event/event/add.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - Event::add - Bascule un évènement en attente - - - &reftitle.description; - - public - bool - Event::add - - float - timeout - - - - Bascule un évènement en attente. Un évènement qui n'a pas le statut en - attente ne se lancera jamais, et la fonction de rappel de l'évènement ne sera - jamais appelée. En utilisant Event::del un - évènement peut être re-planifié par l'utilisateur quand il veut. - - - Si Event::add est appelé sur un évènement déjà en - attente, libevent va le laisser en attente et le re-planifier avec le - nouveau timeout (si donné). Dans le cas où le timeout n'est pas spécifié - Event::add n'a aucun effet. - - - - - &reftitle.parameters; - - - - timeout - - - - Timeout en secondes. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ajout d'un signal personnalisé - -base = $base; - $this->ev = Event::signal($base, SIGTERM, array($this, 'eventSighandler')); - $this->ev->add(); - } - public function eventSighandler($no, $c) { - echo "Signal attrapé $no\n"; - $this->base->exit(); - } -} - -$base = new EventBase(); -$c = new MyEventSignal($base); - -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - Ajout d'une minuterie - -delTimer(); -}, $n); -$e->add($n); -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Event::add - Event::del - Event::signal - Event::timer - - - - diff --git a/reference/event/event/addsignal.xml b/reference/event/event/addsignal.xml deleted file mode 100644 index 978bb21309..0000000000 --- a/reference/event/event/addsignal.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - Event::addSignal - &Alias; Event::add - - - &reftitle.description; - - &info.method.alias; Event::add - - - - diff --git a/reference/event/event/addtimer.xml b/reference/event/event/addtimer.xml deleted file mode 100644 index 996bc85110..0000000000 --- a/reference/event/event/addtimer.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - Event::addTimer - &Alias; Event::add - - - &reftitle.description; - - &info.method.alias; Event::add - - - - diff --git a/reference/event/event/construct.xml b/reference/event/event/construct.xml deleted file mode 100644 index 354bcde5f1..0000000000 --- a/reference/event/event/construct.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - Event::__construct - Construit un objet Event - - - &reftitle.description; - - public - Event::__construct - - EventBase - base - - - mixed - fd - - - int - what - - - callable - cb - - - mixed - arg - NULL - - - - Construit un objet Event. - - - - &reftitle.parameters; - - - - base - - - - La base d'événement à associer. - - - - - - fd - - - - Ressource de flux, ressource de socket, ou descripteur numérique - de fichier. Pour les événements timer, passez comme valeur - -1. Pour les événements de type signal, - passez le numéro du signal, c.-à-d. SIGHUP. - - - - - - what - - - - Drapeaux d'événements. Voir les - drapeaux d'événements pour - plus de détails. - - - - - - cb - - - - La fonction de rappel de l'événement. Voir les - fonctions de rappel d'événements - pour plus de détails. - - - - - - arg - - - - Données personnalisées. Si spécifiées, elles seront passées à la fonction - de rappel lorsque l'événement se déclenche. - - - - - - - &reftitle.seealso; - - - Event::signal - - - Event::timer - - - - - diff --git a/reference/event/event/del.xml b/reference/event/event/del.xml deleted file mode 100644 index 805cbc2325..0000000000 --- a/reference/event/event/del.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - Event::del - Supprime un événement de la liste des événements surveillés - - - &reftitle.description; - - public - bool - Event::del - - - - Supprime un événement du jeu d'événements surveillés, c.-à-d. le passe en - non-attente. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - Event::add - - - - - diff --git a/reference/event/event/delsignal.xml b/reference/event/event/delsignal.xml deleted file mode 100644 index 396498ca06..0000000000 --- a/reference/event/event/delsignal.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - Event::delSignal - &Alias; Event::del - - - &reftitle.description; - - &info.method.alias; Event::del - - - - diff --git a/reference/event/event/deltimer.xml b/reference/event/event/deltimer.xml deleted file mode 100644 index dd1e867165..0000000000 --- a/reference/event/event/deltimer.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - Event::delTimer - &Alias; Event::del - - - &reftitle.description; - - &info.method.alias; Event::del - - - - diff --git a/reference/event/event/free.xml b/reference/event/event/free.xml deleted file mode 100644 index 486feb6309..0000000000 --- a/reference/event/event/free.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Event::free - Supprime un événement de la liste des événements surveillés - et libère les ressources associées - - - &reftitle.description; - - public - void - Event::free - - - - Supprime un événement de la liste des événements surveillés par libevent, - et libère les ressources allouées à cet événement. - - - - La méthode Event::free - ne détruit actuellement pas l'objet en tant que tel. Pour détruire - l'objet complètement, appelez la fonction unset - ou assignez-lui la valeur &null;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Event::__construct - - - - - diff --git a/reference/event/event/getsupportedmethods.xml b/reference/event/event/getsupportedmethods.xml deleted file mode 100644 index dfe8e59c16..0000000000 --- a/reference/event/event/getsupportedmethods.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Event::getSupportedMethods - Retourne un tableau contenant les noms des méthodes supportées - par cette version de Libevent - - - &reftitle.description; - - public - static - array - Event::getSupportedMethods - - - - Retourne un tableau contenant les noms des méthodes supportées - par cette version de Libevent. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un tableau. - - - - &reftitle.seealso; - - - EventConfig - - - - - diff --git a/reference/event/event/pending.xml b/reference/event/event/pending.xml deleted file mode 100644 index b0dcee80bc..0000000000 --- a/reference/event/event/pending.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Event::pending - Détecte si l'événement est en attente ou programmé - - - &reftitle.description; - - public - bool - Event::pending - - int - flags - - - - Détecte si l'événement est en attente ou programmé. - - - - &reftitle.parameters; - - - - flags - - - - Une ou plusieurs des constantes suivantes : - Event::READ, - Event::WRITE, - Event::TIMEOUT, - Event::SIGNAL. - - - - - - - &reftitle.returnvalues; - - Retourne &true; si l'événement est en attente ou programmé, - &false; sinon. - - - - diff --git a/reference/event/event/set.xml b/reference/event/event/set.xml deleted file mode 100644 index 5ff11be8f1..0000000000 --- a/reference/event/event/set.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - Event::set - Re-configure l'événement - - - &reftitle.description; - - public - bool - Event::set - - EventBase - base - - - mixed - fd - - - int - what - - - callable - cb - - - mixed - arg - - - - Re-configure l'événement. Il est à noter que cette fonction n'appelle pas - la fonction obsolète event_set de libevent. Elle appelle - plutôt la fonction event_assign. - - - - &reftitle.parameters; - - - - base - - - - La base d'événement à associer. - - - - - - fd - - - - Une ressource de flux, une ressource de socket, ou un descripteur numérique de fichier. Pour les événements de type minuteur passez -1. - Pour les événements de type signal passez le numéro du signal, par exemple SIGHUP. - - - - - - what - - - - Voir les - drapeaux d'événements. - - - - - - cb - - - - La fonction de rappel de l'événement. Voir les - fonctions de rappel d'événements. - - - - - - arg - - - - Données personnalisées à associer avec l'événement. Elles seront passées - à la fonction de rappel lorsque l'événement deviendra actif. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/event/setpriority.xml b/reference/event/event/setpriority.xml deleted file mode 100644 index eb01a7cda5..0000000000 --- a/reference/event/event/setpriority.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Event::setPriority - Définit la priorité de l'événement - - - &reftitle.description; - - public - bool - Event::setPriority - - int - priority - - - - Définit la priorité de l'événement. - - - - &reftitle.parameters; - - - - priority - - - - La priorité de l'événement. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/event/settimer.xml b/reference/event/event/settimer.xml deleted file mode 100644 index 16963af611..0000000000 --- a/reference/event/event/settimer.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Event::setTimer - Re-configure un événement timer - - - &reftitle.description; - - public - bool - Event::setTimer - - EventBase - base - - - callable - cb - - - mixed - arg - - - - Re-configure un événement timer. Il est à noter que cette méthode - n'appelle pas la fonction obsolète event_set - de libevent. Elle appelle plutôt la fonction - event_assign. - - - - &reftitle.parameters; - - - - base - - - - La base d'événement à associer. - - - - - - cb - - - - La fonction de rappel de l'événement timer. Voir les - fonctions de rappel d'événements. - - - - - - arg - - - - Données personnalisées. Si spécifiées, elles seront passées à la fonction - de rappel lorsque l'événement se déclenche. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - Event::__construct - - - Event::timer - - - - - diff --git a/reference/event/event/signal.xml b/reference/event/event/signal.xml deleted file mode 100644 index 570d0eb90a..0000000000 --- a/reference/event/event/signal.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - Event::signal - Construit un objet d'événement signal - - - &reftitle.description; - - public - static - Event - Event::signal - - EventBase - base - - - int - signum - - - callable - cb - - - mixed - arg - - - - Construit un objet d'événement signal. C'est une méthode simple pour - créer un événement de signal. Il est à noter que la méthode générique - Event::__construct peut construire aussi un - objet d'événement de signal. - - - - &reftitle.parameters; - - - - base - - - - L'objet de base d'événement associé. - - - - - - signum - - - - Le numéro du signal. - - - - - - cb - - - - La fonction de rappel de l'événement signal. Voir les - fonctions de rappel d'événements. - - - - - - arg - - - - Données personnalisées. Si spécifiées, elles seront passées à la fonction - de rappel lorsque l'événement se déclenche. - - - - - - - &reftitle.returnvalues; - - Retourne un objet d'événement en cas de succès, &false; sinon. - - - - &reftitle.seealso; - - - La construction d'événement de signal - - - - - diff --git a/reference/event/event/timer.xml b/reference/event/event/timer.xml deleted file mode 100644 index 3016b75ce7..0000000000 --- a/reference/event/event/timer.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - Event::timer - Construit un objet d'événement timer - - - &reftitle.description; - - public - static - Event - Event::timer - - EventBase - base - - - callable - cb - - - mixed - arg - - - - Construit un objet d'événement timer. Il s'agit d'une méthode simple pour - créer un événement timer. Il est à noter que la méthode générique - Event::__construct peut aussi construire des objets - d'événements signal. - - - - &reftitle.parameters; - - - - base - - - - L'objet de base d'événement associé. - - - - - - cb - - - - La fonction de rappel d'événement signal. Voir les - fonctions de rappel d'événements. - - - - - - arg - - - - Données personnalisées. Si spécifiées, elles seront passées à la fonction - de rappel lorsque l'événement se déclenche. - - - - - - - &reftitle.returnvalues; - - Retourne un objet d'événement en cas de succès, &false; sinon. - - - - diff --git a/reference/event/eventbase.xml b/reference/event/eventbase.xml deleted file mode 100644 index 43c9b56de5..0000000000 --- a/reference/event/eventbase.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - La classe EventBase - EventBase - - -
- &reftitle.intro; - - La classe EventBase représente la structure - de base d'un événement libevent. Elle contient un jeu d'événements - et peut vérifier quels sont les événements actifs. - - - Chaque événement de base a une méthode ou un - backend utilisé pour déterminer quels - sont les événements prêts. Ces méthodes sont : - select, poll, epoll, - kqueue, devpoll, evport - et win32. - - - Pour configurer un événement de base à utiliser, ou éviter un backend spécifique, - la classe EventConfig peut être utilisée. - - - - Ne détruisez pas l'objet EventBase - tant que les ressources associées aux objets Event - ne sont pas libérées. Sinon, cela mènera à des résultats totalement indéfinis ! - - -
- -
- &reftitle.classsynopsis; - - - - - EventBase - - - - - final - EventBase - - - - &Constants; - - const - int - EventBase::LOOP_ONCE - 1 - - - const - int - EventBase::LOOP_NONBLOCK - 2 - - - const - int - EventBase::NOLOCK - 1 - - - const - int - EventBase::STARTUP_IOCP - 4 - - - const - int - EventBase::NO_CACHE_TIME - 8 - - - const - int - EventBase::EPOLL_USE_CHANGELIST - 16 - - &Methods; - - - -
- -
- &reftitle.constants; - - - - EventBase::LOOP_ONCE - - - - Drapeau utilisé avec la méthode EventBase::loop - qui signifie : "blocage tant que libevent a un événement actif, puis, - sortie une fois que tous les événements actifs ont exécuté leurs - fonctions de rappel". - - - - - - EventBase::LOOP_NONBLOCK - - - - Drapeau utilisé avec la méthode EventBase::loop - qui signifie : "ne pas bloquer : regarde quels sont les événements prêts actuellement, - exécute leurs fonctions de rappel avec une priorité haute, puis, on sort". - - - - - - EventBase::NOLOCK - - - - Drapeau de configuration. Ne pas verrouiller la base de l'événement, même si - un verrouillage avait été mis en place. - - - - - - EventBase::STARTUP_IOCP - - - - Drapeau de configuration spécifique à Windows. Active le répartiteur IOCP - au démarrage. - - - - - - EventBase::NO_CACHE_TIME - - - - Drapeau de configuration. Au lieu de vérifier le temps courant chaque fois - que la boucle d'événement est prête à exécuter la fonction de rappel, - le temps sera vérifié à chaque fois que le délai maximal d'attente pour la - fonction de rappel sera atteint. - - - - - - EventBase::EPOLL_USE_CHANGELIST - - - - Si l'on utilise le backend epoll, ce drapeau - signifie qu'il est sécurisé d'utiliser le code interne de modification de liste - interne à Libevent pour mettre en lot les ajouts et les suppressions afin - de tenter de minimiser le plus possible le nombre d'appels système. - - - Le fait de définir ce drapeau rend le code plus rapide, mais il peut - déclencher un bogue Linux : il n'est pas sécurisé d'utiliser ce drapeau - en présence d'un fds cloné par dup() ou une de ces variantes. - Ceci produirait un comportement étrange et très difficile à diagnostiquer. - - - Ce drapeau peut aussi être activé en définissant la variable d'environnement - EVENT_EPOLL_USE_CHANGELIST. - - - Ce drapeau n'a aucun effet si on l'utilise avec un autre backend que - epoll. - - - - -
- - - - &reference.event.entities.eventbase; - - - diff --git a/reference/event/eventbase/construct.xml b/reference/event/eventbase/construct.xml deleted file mode 100644 index 3e79c9a412..0000000000 --- a/reference/event/eventbase/construct.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBase::__construct - Construit un objet EventBase - - - &reftitle.description; - - public - EventBase::__construct - - EventConfig - cfg - - - - Construit un objet EventBase. - - - - &reftitle.parameters; - - - - cfg - - - - Optionnel - Un objet EventConfig. - - - - - - - &reftitle.errors; - - Si EventBase ne peut pas être construit avec la configuration fournie, - une exception de type EventException sera déclenchée. - - - - &reftitle.seealso; - - - EventConfig - - - - - diff --git a/reference/event/eventbase/dispatch.xml b/reference/event/eventbase/dispatch.xml deleted file mode 100644 index c8de1bea92..0000000000 --- a/reference/event/eventbase/dispatch.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - EventBase::dispatch - Distribue les événements en attente - - - &reftitle.description; - - public - void - EventBase::dispatch - - - - Attend que les événements deviennent actifs, et exécute leurs - fonctions de rappel. Identique à la méthode - EventBase::loop mais sans drapeau. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::loop - - - - - diff --git a/reference/event/eventbase/exit.xml b/reference/event/eventbase/exit.xml deleted file mode 100644 index e2e26d249d..0000000000 --- a/reference/event/eventbase/exit.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - EventBase::exit - Stoppe la distribution des événements - - - &reftitle.description; - - public - bool - EventBase::exit - - float - timeout - - - - Demande à l'événement de base de stopper la distribution - des événements, optionnellement après un nombre de secondes fourni. - - - - &reftitle.parameters; - - - - timeout - - - - Optionnel - Nombre de secondes après lequel l'événement - de base doit stopper la distribution d'événements. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::stop - - - - - diff --git a/reference/event/eventbase/free.xml b/reference/event/eventbase/free.xml deleted file mode 100644 index 542b8dd81d..0000000000 --- a/reference/event/eventbase/free.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - EventBase::free - Libère les ressources allouées pour l'événement de base - - - &reftitle.description; - - public - void - EventBase::free - - - - Désalloue les ressources allouées par libevent pour l'objet - EventBase. - - - - La méthode EventBase::free ne détruit pas - l'objet lui-même. Pour détruire l'objet complètement, appelez la fonction - unset ou assignez-lui la valeur &null;. - - - Cette méthode ne désalloue, ni ne détache aucun événement qui serait actuellement - associé avec l'objet EventBase, ni ne ferme aucun de leur - socket ; gardez cela en tête. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventBase::__construct - - - - - diff --git a/reference/event/eventbase/getfeatures.xml b/reference/event/eventbase/getfeatures.xml deleted file mode 100644 index 619e806910..0000000000 --- a/reference/event/eventbase/getfeatures.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - EventBase::getFeatures - Retourne un masque des fonctionnalités supportées - - - &reftitle.description; - - public - int - EventBase::getFeatures - - - - Retourne un masque des fonctionnalités supportées. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un entier représentant un masque des fonctionnalités supportées. - Voir les constantes - EventConfig::FEATURE_*. - - - - &reftitle.examples; - - Exemple avec <function>EventBase::getFeatures</function> - -avoidMethod("select")) { - echo "Mise à l'écart de la méthode 'select'\n"; -} - -$base = new EventBase($cfg); - -echo "fonctionnalités :\n"; -$features = $base->getFeatures(); -($features & EventConfig::FEATURE_ET) and print "ET - E/S déclenchées par front\n"; -($features & EventConfig::FEATURE_O1) and print "O1 - opération O(1) pour l'ajout/suppression d'événements\n"; -($features & EventConfig::FEATURE_FDS) and print "FDS - type de descripteur de fichiers arbitraire, et non uniquement les sockets\n"; -?> -]]> - - - - - &reftitle.seealso; - - - EventBase::getMethod - - - EventConfig - - - - - diff --git a/reference/event/eventbase/getmethod.xml b/reference/event/eventbase/getmethod.xml deleted file mode 100644 index f68cdf7092..0000000000 --- a/reference/event/eventbase/getmethod.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - EventBase::getMethod - Retourne la méthode d'événement utilisée - - - - &reftitle.description; - - public - string - EventBase::getMethod - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une chaîne de caractères représentant la méthode - d'événement utilisée (backend). - - - - - &reftitle.examples; - - Exemple avec <function>EventBase::getMethod</function> - -avoidMethod("select")) { - echo "Mise à l'écart de la méthode 'select'\n"; -} - -// Crée un event_base associé avec la configuration -$base = new EventBase($cfg); -echo "Méthode d'événement utilisée : ", $base->getMethod(), PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - EventBase::getFeatures - - - - - - diff --git a/reference/event/eventbase/gettimeofdaycached.xml b/reference/event/eventbase/gettimeofdaycached.xml deleted file mode 100644 index 0f63601498..0000000000 --- a/reference/event/eventbase/gettimeofdaycached.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - EventBase::getTimeOfDayCached - Retourne le temps de l'événement de base courant - - - &reftitle.description; - - public - float - EventBase::getTimeOfDayCached - - - - En cas de succès, retourne le temps courant (tel que retourné - par la fonction gettimeofday()), - en analysant la valeur mise en cache dans - base si possible, et en appelant - la fonction gettimeofday() ou la fonction - clock_gettime() si aucun temps n'est disponible - en cache. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne le temps de l'événement de base courant. - En cas d'échec, retourne &null;. - - - - diff --git a/reference/event/eventbase/gotexit.xml b/reference/event/eventbase/gotexit.xml deleted file mode 100644 index de328d2e3e..0000000000 --- a/reference/event/eventbase/gotexit.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - EventBase::gotExit - Vérifie s'il a été demandé à la boucle d'événements de sortir - - - &reftitle.description; - - public - bool - EventBase::gotExit - - - - Vérifie s'il a été demandé à la boucle d'événements de sortir via - la méthode EventBase::exit. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne &true; s'il a été demandé à la boucle d'événements de - sortir via la méthode EventBase::exit. - &false; sinon. - - - - &reftitle.seealso; - - - EventBase::exit - - - EventBase::stop - - - EventBase::gotStop - - - - - diff --git a/reference/event/eventbase/gotstop.xml b/reference/event/eventbase/gotstop.xml deleted file mode 100644 index 635f49b292..0000000000 --- a/reference/event/eventbase/gotstop.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - EventBase::gotStop - Vérifie s'il a été demandé à la boucle d'événements de s'arrêter - - - &reftitle.description; - - public - bool - EventBase::gotStop - - - - Vérifie s'il a été demandé à la boucle d'événements de s'arrêter - via la méthode EventBase::stop. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne &true; s'il a été demandé à la boucle d'événements - de s'arrêter via la méthode EventBase::stop. - &false; sinon. - - - - &reftitle.seealso; - - EventBase::exit - EventBase::stop - EventBase::gotExit - - - - diff --git a/reference/event/eventbase/loop.xml b/reference/event/eventbase/loop.xml deleted file mode 100644 index dea9e763b3..0000000000 --- a/reference/event/eventbase/loop.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - EventBase::loop - Distribue les événements en attente - - - &reftitle.description; - - public - bool - EventBase::loop - - int - flags - - - - Attend que les événements deviennent actifs, puis, - exécute leurs fonctions de rappel. - - - - - - - &reftitle.parameters; - - - - flags - - - - Drapeaux optionnels. Une constante EventBase::LOOP_*. - Voir les constantes EventBase. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::dispatch - - - - - diff --git a/reference/event/eventbase/priorityinit.xml b/reference/event/eventbase/priorityinit.xml deleted file mode 100644 index 690cfcd618..0000000000 --- a/reference/event/eventbase/priorityinit.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBase::priorityInit - Définit le nombre de priorités par événement de base - - - &reftitle.description; - - public - bool - EventBase::priorityInit - - int - n_priorities - - - - Définit le nombre de priorités par événement de base. - - - - &reftitle.parameters; - - - - n_priorities - - - - Le nombre de priorités par événement de base. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - Event::setPriority - - - - - diff --git a/reference/event/eventbase/reinit.xml b/reference/event/eventbase/reinit.xml deleted file mode 100644 index 539c1d7408..0000000000 --- a/reference/event/eventbase/reinit.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - EventBase::reInit - Re-initialise l'événement de base (après un fork) - - - &reftitle.description; - - public - bool - EventBase::reInit - - - - Re-initialise l'événement de base. - Devrait être appelée après un fork. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventbase/stop.xml b/reference/event/eventbase/stop.xml deleted file mode 100644 index 7c2e88be1f..0000000000 --- a/reference/event/eventbase/stop.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - EventBase::stop - Demande à event_base de stopper la distribution d'événements - - - &reftitle.description; - - public - bool - EventBase::stop - - - - Demande à event_base de stopper la distribution d'événements. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::exit - - - EventBase::gotStop - - - - - diff --git a/reference/event/eventbuffer.xml b/reference/event/eventbuffer.xml deleted file mode 100644 index 8e45228feb..0000000000 --- a/reference/event/eventbuffer.xml +++ /dev/null @@ -1,230 +0,0 @@ - - - - - - La classe EventBuffer - EventBuffer - - -
- &reftitle.intro; - - La classe EventBuffer représente - "evbuffer" de Libevent, un utilitaire pour les I/O bufferisés. - - - Les buffers d'événements sont généralement utiles pour réaliser la - partie buffer d'un réseau I/O bufferisé. - -
- -
- &reftitle.classsynopsis; - - - - - EventBuffer - - - - - EventBuffer - - - - &Constants; - - const - int - EventBuffer::EOL_ANY - 0 - - - const - int - EventBuffer::EOL_CRLF - 1 - - - const - int - EventBuffer::EOL_CRLF_STRICT - 2 - - - const - int - EventBuffer::EOL_LF - 3 - - - const - int - EventBuffer::PTR_SET - 0 - - - const - int - EventBuffer::PTR_ADD - 1 - - &Properties; - - public - readonly - int - length - - - public - readonly - int - contiguous_space - - &Methods; - - - -
- -
- &reftitle.properties; - - - - length - - - - Le nombre d'octets stockés dans un buffer d'événement. - - - - - - contiguous_space - - - - Le nombre d'octets stockés de façon contiguë au début du buffer. - Les octets dans un buffer peuvent être stockés dans plusieurs parties - séparées de la mémoire ; cette propriété retourne le nombre d'octets - actuellement stockés dans la première partie. - - - - -
- - -
- &reftitle.constants; - - - - EventBuffer::EOL_ANY - - - - La fin de ligne est une séquence quelconque d'un nombre quelconque de - caractères de retour chariot et de saut de ligne. Ce format n'est pas - très utile ; il existe principalement pour des raisons de compatibilité - ascendante. - - - - - - EventBuffer::EOL_CRLF - - - - La fin de ligne est un retour chariot optionnel, suivi par une nouvelle - ligne. (En d'autres termes, c'est soit "\r\n", - soit "\n"). Ce format est utile pour analyser - les protocoles Internet basés sur du texte ; le standard veut qu'on - utilise "\r\n" mais quelques clients fournissent - seulement "\n". - - - - - - EventBuffer::EOL_CRLF_STRICT - - - - La fin de ligne est un simple retour chariot, suivi par une - simple nouvelle ligne (aussi connu comme "\r\n". - Les valeurs ASCII sont 0x0D 0x0A). - - - - - - EventBuffer::EOL_LF - - - - La fin de ligne est un simple caractère de nouvelle ligne (aussi connu - comme "\n". La valeur ASCII est 0x0A). - - - - - - EventBuffer::PTR_SET - - - - Drapeau utilisé comme argument de la méthode - EventBuffer::setPosition. Si ce drapeau est spécifié, - la position du pointeur est déplacée à une position absolue du buffer. - - - - - - EventBuffer::PTR_ADD - - - - Identique à EventBuffer::PTR_SET, - sauf que ce drapeau fait que la méthode - EventBuffer::setPosition - se déplace en avant jusqu'au nombre d'octets spécifié - (au lieu de définir une position absolue). - - - - -
- - - - &reference.event.entities.eventbuffer; - - - diff --git a/reference/event/eventbuffer/add.xml b/reference/event/eventbuffer/add.xml deleted file mode 100644 index 5b4f545f46..0000000000 --- a/reference/event/eventbuffer/add.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBuffer::add - Ajoute des données à la fin du tampon d'événement - - - &reftitle.description; - - public - bool - EventBuffer::add - - string - data - - - - Ajoute des données à la fin du tampon d'événement. - - - - &reftitle.parameters; - - - - data - - - - Chaîne de caractères à ajouter à la fin du tampon. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::addBuffer - - - - - diff --git a/reference/event/eventbuffer/addbuffer.xml b/reference/event/eventbuffer/addbuffer.xml deleted file mode 100644 index 379abfb2e8..0000000000 --- a/reference/event/eventbuffer/addbuffer.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - EventBuffer::addBuffer - Déplace toutes les données du tampon fourni dans l'instance courante EventBuffer - - - &reftitle.description; - - public - bool - EventBuffer::addBuffer - - EventBuffer - buf - - - - Déplace toutes les données du tampon fourni par le paramètre - buf à la fin de l'EventBuffer - courant. C'est un ajout destructeur. Les données du premier tampon - sont déplacées dans l'autre. Cependant, aucune copie mémoire inutile ne survient. - - - - &reftitle.parameters; - - - - buf - - - - L'objet source EventBuffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::add - - - - - diff --git a/reference/event/eventbuffer/appendfrom.xml b/reference/event/eventbuffer/appendfrom.xml deleted file mode 100644 index f190af4ffa..0000000000 --- a/reference/event/eventbuffer/appendfrom.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - EventBuffer::appendFrom - Déplace le nombre d'octets fourni depuis un tampon source vers la fin du tampon courant - - - &reftitle.description; - - public - int - EventBuffer::appendFrom - - EventBuffer - buf - - - int - len - - - - Déplace le nombre d'octets fourni depuis un tampon source, vers la - fin du tampon courant. S'il n'y a pas assez d'octets de disponibles, - tous les octets disponibles seront déplacés du tampon source. - - - - &reftitle.parameters; - - - - buf - - - - Tampon source. - - - - - - len - - - - - - - - - &reftitle.returnvalues; - - Retourne le nombre d'octets lus. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.6.0 - - La méthode EventBuffer::appendFrom - a été renommée en EventBuffer::appendFrom. - - - - - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::pullup - - - EventBuffer::readLine - - - EventBuffer::read - - - - - diff --git a/reference/event/eventbuffer/construct.xml b/reference/event/eventbuffer/construct.xml deleted file mode 100644 index 0901e95df2..0000000000 --- a/reference/event/eventbuffer/construct.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - - EventBuffer::__construct - Construit un objet EventBuffer - - - &reftitle.description; - - public - EventBuffer::__construct - - - - Construit un objet EventBuffer. - - - - &reftitle.parameters; - &no.function.parameters; - - - diff --git a/reference/event/eventbuffer/copyout.xml b/reference/event/eventbuffer/copyout.xml deleted file mode 100644 index d90e05c14c..0000000000 --- a/reference/event/eventbuffer/copyout.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - EventBuffer::copyout - Copie le nombre d'octets spécifié depuis le début du tampon - - - &reftitle.description; - - public - int - EventBuffer::copyout - - string - data - - - int - max_bytes - - - - Fonctionne de la même façon que la méthode - EventBuffer::read, mais ne vide pas les - données du tampon. C.-à-d. que la méthode copie les premiers - max_bytes octets depuis le début du tampon - dans le paramètre data. S'il y a moins de - max_bytes octets disponibles, la méthode - copie tous les octets présents. - - - - &reftitle.parameters; - - - - data - - - - Chaîne de sortie. - - - - - - max_bytes - - - - Le nombre d'octets à copier. - - - - - - - &reftitle.returnvalues; - - Retourne le nombre d'octets copiés, ou - -1 si une erreur survient. - - - - &reftitle.seealso; - - - EventBuffer::read - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/drain.xml b/reference/event/eventbuffer/drain.xml deleted file mode 100644 index 3ecc2f688b..0000000000 --- a/reference/event/eventbuffer/drain.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - EventBuffer::drain - Supprime un nombre spécifié d'octets depuis le début du tampon - sans copier les données - - - &reftitle.description; - - public - bool - EventBuffer::drain - - int - len - - - - Fonctionne de la même manière que la méthode - EventBuffer::read excepté le fait que - les données supprimées ne sont pas copiées : elles sont seulement - supprimées du début du tampon. - - - - &reftitle.parameters; - - - - len - - - - Le nombre d'octets à supprimer depuis le tampon. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::read - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/enablelocking.xml b/reference/event/eventbuffer/enablelocking.xml deleted file mode 100644 index 7618af28b0..0000000000 --- a/reference/event/eventbuffer/enablelocking.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - EventBuffer::enableLocking - - - - &reftitle.description; - - public - void - EventBuffer::enableLocking - - - - Active le verrouillage de l'EventBuffer, lui - permettant ainsi de pouvoir être utilisé de façon sécurisée - par plusieurs threads à la fois. Lorsque le verrouillage est activé, - le verrou sera placé lorsque les fonctions de rappel seront appelées. - Ce comportement peut conduire à des verrous morts si l'on n'est pas - attentif. Il faut donc anticiper en conséquence. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Evbuffers and Thread-safety - - - - - diff --git a/reference/event/eventbuffer/expand.xml b/reference/event/eventbuffer/expand.xml deleted file mode 100644 index dcea838726..0000000000 --- a/reference/event/eventbuffer/expand.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - EventBuffer::expand - Réserve de l'espace dans le tampon - - - &reftitle.description; - - public - bool - EventBuffer::expand - - int - len - - - - Modifie le dernier bloc mémoire du tampon, ou en ajoute un nouveau, - faisant ainsi que la taille du tampon augmente de sorte à contenir - len octets sans avoir à faire de futures - allocations supplémentaires. - - - - &reftitle.parameters; - - - - len - - - - Le nombre d'octets à réserver pour le tampon. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventbuffer/freeze.xml b/reference/event/eventbuffer/freeze.xml deleted file mode 100644 index d1779d7ab6..0000000000 --- a/reference/event/eventbuffer/freeze.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - EventBuffer::freeze - Permet d'empêcher les appels qui tentent de modifier un - tampon d'événements de réussir - - - &reftitle.description; - - public - bool - EventBuffer::freeze - - bool - at_front - - - - Permet d'empêcher les appels qui tentent de modifier un - tampon d'événements de réussir. - - - - &reftitle.parameters; - - - - at_front - - - - Permet de désactiver les modifications en début ou en - fin de tampon. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::unfreeze - - - - - diff --git a/reference/event/eventbuffer/lock.xml b/reference/event/eventbuffer/lock.xml deleted file mode 100644 index b604c9bddd..0000000000 --- a/reference/event/eventbuffer/lock.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - EventBuffer::lock - Acquiert un verrou sur le buffer - - - &reftitle.description; - - public - void - EventBuffer::lock - - - - Acquiert un verrou sur le buffer. Peut être utilisé de pair avec la méthode - EventBuffer::unlock pour réaliser un jeu - d'opérations atomiques, c.-à-d. thread-safe. Il est à noter qu'il n'est pas nécessaire - de verrouiller les buffers pour les opérations individuelles. - Lorsque le verrou est actif (voir EventBuffer::enableLocking), - les opérations individuelles sur les buffers d'événements sont déjà atomiques. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventBuffer::unlock - - - - - diff --git a/reference/event/eventbuffer/prepend.xml b/reference/event/eventbuffer/prepend.xml deleted file mode 100644 index c751e7f80c..0000000000 --- a/reference/event/eventbuffer/prepend.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - EventBuffer::prepend - Ajoute des données au début du buffer - - - &reftitle.description; - - public - bool - EventBuffer::prepend - - string - data - - - - Ajoute des données au début du buffer. - - - - &reftitle.parameters; - - - - data - - - - Chaîne de caractères à ajouter au début du buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::prependBuffer - - - EventBuffer::add - - - EventBuffer::addBuffer - - - - - diff --git a/reference/event/eventbuffer/prependbuffer.xml b/reference/event/eventbuffer/prependbuffer.xml deleted file mode 100644 index 06a5ecc53f..0000000000 --- a/reference/event/eventbuffer/prependbuffer.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - EventBuffer::prependBuffer - Déplace toutes les données depuis le buffer source vers le début - du buffer courant - - - &reftitle.description; - - public - bool - EventBuffer::prependBuffer - - EventBuffer - buf - - - - Fonctionne exactement comme la méthode - EventBuffer::addBuffer, excepté le fait - qu'elle déplace les données au début du buffer. - - - - &reftitle.parameters; - - - - buf - - - - Buffer source. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::add - - - EventBuffer::addBuffer - - - EventBuffer::prepend - - - - - diff --git a/reference/event/eventbuffer/pullup.xml b/reference/event/eventbuffer/pullup.xml deleted file mode 100644 index 7e1d8a6651..0000000000 --- a/reference/event/eventbuffer/pullup.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - EventBuffer::pullup - Linéarise les données du buffer et retourne le contenu du - buffer sous la forme d'une chaîne - - - &reftitle.description; - - public - string - EventBuffer::pullup - - int - size - - - - Linéarise les premiers size octets du buffer, - les copie ou les bouge comme nécessaire pour assurer qu'ils soient contigus - et occupent la même partie de la mémoire. Si la taille - est négative, la fonction linéarise la totalité du buffer. - - - - L'appel à la méthode EventBuffer::pullup - avec une taille très grande ralentit l'exécution, sachant qu'elle - peut potentiellement avoir besoin de copier le contenu entier du buffer. - - - - - &reftitle.parameters; - - - - size - - - - Le nombre d'octets qui doivent être contigus dans le buffer. - - - - - - - &reftitle.returnvalues; - - Si size est supérieur au nombre d'octets du buffer, - la fonction retournera &null;. Sinon, EventBuffer::pullup - retournera une chaîne de caractères. - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::read - - - EventBuffer::readLine - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/read.xml b/reference/event/eventbuffer/read.xml deleted file mode 100644 index 46e9228e09..0000000000 --- a/reference/event/eventbuffer/read.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - EventBuffer::read - Lit les données d'un evbuffer, et vide les octets lus - - - &reftitle.description; - - public - string - EventBuffer::read - - int - max_bytes - - - - Lit les premiers max_bytes octets depuis le tampon - et vide les octets lus. Si le paramètre max_bytes - représente plus d'octets que de disponible dans le tampon, - l'ensemble des octets disponibles seront lus. - - - - &reftitle.parameters; - - - - max_bytes - - - - Le nombre maximal d'octets à lire depuis le tampon. - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne lue, ou &false; si une erreur survient. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.6.0 - - La méthode EventBuffer::read - a été renommée en EventBuffer::read. - EventBuffer::read - ne prend maintenant qu'un seul argument : max_bytes - ; elle retourne maintenant une chaîne au lieu d'un entier. - - - - - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::pullup - - - EventBuffer::readLine - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/readfrom.xml b/reference/event/eventbuffer/readfrom.xml deleted file mode 100644 index 19e406ff97..0000000000 --- a/reference/event/eventbuffer/readfrom.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - EventBuffer::readFrom - Lit des données depuis un fichier et les place à la fin du tampon - - - &reftitle.description; - - public - int - EventBuffer::read - - mixed - fd - - - int - howmuch - - - - Lit des données depuis le fichier fd - et les place à la fin du tampon. - - - - &reftitle.parameters; - - - - fd - - - - Un socket, un flux, ou un descripteur de fichier numérique. - - - - - - howmuch - - - - Nombre maximal d'octets à lire. - - - - - - - &reftitle.returnvalues; - - Retourne le nombre d'octets lus, ou &false; si une erreur survient. - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::pullup - - - EventBuffer::readLine - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/readline.xml b/reference/event/eventbuffer/readline.xml deleted file mode 100644 index 909bb57467..0000000000 --- a/reference/event/eventbuffer/readline.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - EventBuffer::readLine - Extrait une ligne depuis le début du tampon - - - &reftitle.description; - - public - string - EventBuffer::readLine - - int - eol_style - - - - Extrait une ligne depuis le début du tampon et la retourne - dans une nouvelle chaîne allouée. S'il n'y a pas de ligne complète - à lire, la méthode retourne &null;. La terminaison de la ligne - n'est pas incluse dans la chaîne copiée. - - - - &reftitle.parameters; - - - - eol_style - - - - Une constante - EventBuffer:EOL_*. - - - - - - - &reftitle.returnvalues; - - En cas de succès, retourne la ligne lue depuis le tampon, - &null; sinon. - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::pullup - - - EventBuffer::read - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/search.xml b/reference/event/eventbuffer/search.xml deleted file mode 100644 index cd87fc2e61..0000000000 --- a/reference/event/eventbuffer/search.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - EventBuffer::search - Recherche dans le tampon une occurrence d'une chaîne - - - &reftitle.description; - - public - mixed - EventBuffer::search - - string - what - - - int - start - -1 - - - int - end - -1 - - - - Recherche dans le tampon une occurrence de la chaîne - what. La méthode retourne la position - numérique de la chaîne recherchée, ou &false; si la chaîne - n'a pu être trouvée. - - - Si l'argument start est fourni, ce sera la position - à partir de laquelle la recherche doit commencer ; sinon, la recherche - sera réalisée depuis le début de la chaîne. Si l'argument - end est fourni, la recherche sera réalisée - entre les positions de début et de fin du tampon. - - - - &reftitle.parameters; - - - - what - - - - Chaîne à chercher. - - - - - - start - - - - Position de départ de la recherche. - - - - - - end - - - - Position de fin de la recherche. - - - - - - - &reftitle.returnvalues; - - Retourne la position numérique de la première occurrence de la - chaîne dans le tampon, ou &false; si la chaîne n'a pas été trouvée. - - &return.falseproblem; - - - &reftitle.examples; - - Exemple avec <function>EventBuffer::search</function> - -search($str, $p); - if ($p === FALSE) { - break; - } - ++$total; - ++$p; - } - - return $total; -} - -$buf = new EventBuffer(); -$buf->add("Some string within a string inside another string"); -var_dump(count_instances($buf, "str")); -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventBuffer::searchEol - - - - - diff --git a/reference/event/eventbuffer/searcheol.xml b/reference/event/eventbuffer/searcheol.xml deleted file mode 100644 index d6275282d7..0000000000 --- a/reference/event/eventbuffer/searcheol.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - EventBuffer::searchEol - Cherche dans le tampon une occurrence de fin de ligne - - - &reftitle.description; - - public - mixed - EventBuffer::searchEol - - int - start - -1 - - - int - eol_style - - EventBuffer::EOL_ANY - - - - - Cherche dans le tampon une occurrence de fin de ligne spécifiée par - le paramètre eol_style. La méthode retourne - la position numérique de la chaîne, ou &false; si la chaîne n'a pas été - trouvée. - - - Si l'argument start est fourni, il représente - la position où la recherche commencera ; sinon, la recherche sera - effectuée depuis le début de la chaîne. Si l'argument end - est fourni, la recherche sera réalisée entre les positions de début - et de fin du tampon. - - - - &reftitle.parameters; - - - - start - - - - Position de début de recherche. - - - - - - eol_style - - - - Une constante - EventBuffer:EOL_*. - - - - - - - &reftitle.returnvalues; - - Retourne la position numérique de la première occurrence du - symbole de fin de ligne dans le tampon, ou bien &false; s'il - n'a pas été trouvé. - - &return.falseproblem; - - - &reftitle.seealso; - - - EventBuffer::search - - - - - diff --git a/reference/event/eventbuffer/substr.xml b/reference/event/eventbuffer/substr.xml deleted file mode 100644 index 321cea5801..0000000000 --- a/reference/event/eventbuffer/substr.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - EventBuffer::substr - Soustrait une portion des données du tampon - - - &reftitle.description; - - public - string - EventBuffer::substr - - int - start - - - int - length - - - - Soustrait une taille de length octets - du tampon, en commençant à la position start. - - - - &reftitle.parameters; - - - - start - - - - La position de départ des données à soustraire. - - - - - - length - - - - Nombre maximal d'octets à soustraire. - - - - - - - &reftitle.returnvalues; - - Retourne les données soustraites sous la forme d'une chaîne de caractères - en cas de succès, ou bien &false; si une erreur survient. - - - - &reftitle.seealso; - - - EventBuffer::read - - - - - diff --git a/reference/event/eventbuffer/unfreeze.xml b/reference/event/eventbuffer/unfreeze.xml deleted file mode 100644 index e7809fb071..0000000000 --- a/reference/event/eventbuffer/unfreeze.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBuffer::unfreeze - Ré-active les appels qui permettent de modifier un buffer d'événements - - - &reftitle.description; - - public - bool - EventBuffer::unfreeze - - bool - at_front - - - - Ré-active les appels qui permettent de modifier un buffer d'événements. - - - - &reftitle.parameters; - - - - at_front - - - - Si l'on doit activer les événements au début ou à la fin du buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::freeze - - - - - diff --git a/reference/event/eventbuffer/unlock.xml b/reference/event/eventbuffer/unlock.xml deleted file mode 100644 index 5779ad70d6..0000000000 --- a/reference/event/eventbuffer/unlock.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - EventBuffer::unlock - Libère un verrou acquis avec EventBuffer::lock - - - &reftitle.description; - - public - bool - EventBuffer::unlock - - - - Libère un verrou acquis avec la méthode - EventBuffer::lock. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::lock - - - - - diff --git a/reference/event/eventbuffer/write.xml b/reference/event/eventbuffer/write.xml deleted file mode 100644 index f290bb8ac9..0000000000 --- a/reference/event/eventbuffer/write.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - EventBuffer::write - Écrit le contenu du buffer dans un fichier ou dans un socket - - - &reftitle.description; - - public - int - EventBuffer::write - - mixed - fd - - - int - howmuch - - - - Écrit le contenu du buffer dans un descripteur de fichier. Le buffer - sera vidé après l'écriture avec succès des derniers octets. - - - - &reftitle.parameters; - - - - fd - - - - Ressource de socket, flux, ou un descripteur numérique de fichier - associé avec un socket. - - - - - - howmuch - - - - Le nombre maximal d'octets à écrire. - - - - - - - &reftitle.returnvalues; - - Retourne le nombre d'octets écrits, ou &false; si une erreur survient. - - - - &reftitle.seealso; - - - EventBuffer::read - - - - - diff --git a/reference/event/eventbufferevent.about.callbacks.xml b/reference/event/eventbufferevent.about.callbacks.xml deleted file mode 100644 index 4751346b27..0000000000 --- a/reference/event/eventbufferevent.about.callbacks.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - À propos des fonctions de rappel du buffer d'événements - - Un objet de la classe EventBufferEvent - représente un buffer d'événements. - La nature asynchrone d'I/O réalisée par Libevent implique qu'un socket - (ou tout autre type de descripteur de fichiers) n'est pas toujours - disponible. Event invoque les fonctions de rappel correspondantes lorsque - la ressource devient disponible pour une lecture ou une écriture, - ou lorsque des événements surviennent (c.-à-d. une erreur, une fin de ligne, - etc.). - - - Les fonctions de rappel de lecture et d'écriture doivent correspondre - au prototype suivant : - - - void - callback - - EventBufferEvent - bev - &null; - - - mixed - arg - &null; - - - - - - bev - - - - Objet EventBufferEvent associé. - - - - - - arg - - - - Variable personnalisée attachée à toutes les fonctions de rappel - via la méthode EventBufferEvent::__construct - ou la méthode EventBufferEvent::setCallbacks. - - - - - - Une fonction de rappel d'événement doit correspondre au prototype suivant : - - - void - callback - - EventBufferEvent - bev - &null; - - - int - events - 0 - - - mixed - arg - &null; - - - - - - bev - - - - Objet EventBufferEvent associé. - - - - - - events - - - - Masque d'octets d'événements : - EventBufferEvent::READING, - EventBufferEvent::WRITING, - EventBufferEvent::EOL, - EventBufferEvent::ERROR et - EventBufferEvent::TIMEOUT. Voir les - constantes EventBufferEvent. - - - - - - arg - - - - Variable personnalisée attachée à toutes les fonctions de rappel via - la méthode EventBufferEvent::__construct ou - la méthode EventBufferEvent::setCallbacks. - - - - - - diff --git a/reference/event/eventbufferevent.xml b/reference/event/eventbufferevent.xml deleted file mode 100644 index dbef653e8d..0000000000 --- a/reference/event/eventbufferevent.xml +++ /dev/null @@ -1,405 +0,0 @@ - - - - - - La classe EventBufferEvent - EventBufferEvent - - -
- &reftitle.intro; - - Représente un buffer d'événement Libevent. - - - Habituellement, une application veut mettre en buffer des données en plus - de juste répondre à des événements. Lorsque nous voulons écrire des données, - par exemple, le mécanisme habituel ressemble à : - - - - - On décide que l'on veut écrire des données dans une connexion ; on place - ces données dans un buffer. - - - - - On attend que la connexion devienne accessible en écriture - - - - - On écrit autant de données que l'on peut - - - - - On se souvient de la quantité écrite, et si on a encore plus de données - à écrire, on attend que la connexion redevienne accessible en écriture. - - - - - Ce mécanisme de mise en buffer I/O est suffisamment commun pour que - Libevent fournisse un mécanisme générique pour cela. Un buffer d'événement - consiste en un transport sous-jacent (comme un socket), un buffer de - lecture, et un buffer d'écriture. Au lieu d'un événement classique, - qui fournit des fonctions de rappel lorsque le transport sous-jacent - est prêt à être lu ou écrit, un buffer d'événement appelle ses fonctions - de rappel fournies par l'utilisateur lorsqu'il a lu ou écrit suffisamment - de données. - -
- -
- &reftitle.classsynopsis; - - - - - EventBufferEvent - - - - - final - EventBufferEvent - - - - &Constants; - - const - int - EventBufferEvent::READING - 1 - - - const - int - EventBufferEvent::WRITING - 2 - - - const - int - EventBufferEvent::EOF - 16 - - - const - int - EventBufferEvent::ERROR - 32 - - - const - int - EventBufferEvent::TIMEOUT - 64 - - - const - int - EventBufferEvent::CONNECTED - 128 - - - const - int - EventBufferEvent::OPT_CLOSE_ON_FREE - 1 - - - const - int - EventBufferEvent::OPT_THREADSAFE - 2 - - - const - int - EventBufferEvent::OPT_DEFER_CALLBACKS - 4 - - - const - int - EventBufferEvent::OPT_UNLOCK_CALLBACKS - 8 - - - const - int - EventBufferEvent::SSL_OPEN - 0 - - - const - int - EventBufferEvent::SSL_CONNECTING - 1 - - - const - int - EventBufferEvent::SSL_ACCEPTING - 2 - - &Properties; - - public - int - fd - - - public - int - priority - - - public - readonly - EventBuffer - input - - - public - readonly - EventBuffer - output - - &Methods; - - - -
- -
- &reftitle.properties; - - - - fd - - - - Descripteur de fichier numérique associé avec le buffer d'événement. - Normalement, représente un socket lié. Vaut &null; s'il n'y a aucun - descripteur de fichier (socket) associé avec le buffer d'événement. - - - - - - priority - - - - La priorité de l'événement, utilisée pour implémenter le buffer - d'événement. - - - - - - input - - - - Objet de buffer d'entrée sous-jacent (EventBuffer) - - - - - - output - - - - Objet de buffer de sortie sous-jacent (EventBuffer) - - - - -
- - -
- &reftitle.constants; - - - - EventBufferEvent::READING - - - - Un événement survient pendant l'opération de lecture sur le - bufferevent. Voir les autres drapeaux pour connaître le type d'événement. - - - - - - EventBufferEvent::WRITING - - - - Un événement survient pendant une opération d'écriture sur le - bufferevent. Voir les autres drapeaux pour connaître le type d'événement. - - - - - - EventBufferEvent::EOF - - - - On récupère une indication de fin de fichier sur le buffer d'événement. - - - - - - EventBufferEvent::ERROR - - - - Une erreur survient pendant une opération bufferevent. Pour plus - d'informations sur l'erreur, appeler la méthode - EventUtil::getLastSocketErrno et/ou - EventUtil::getLastSocketError. - - - - - - EventBufferEvent::TIMEOUT - - - - - - - - EventBufferEvent::CONNECTED - - - - Termine une connexion demandée sur le bufferevent. - - - - - - EventBufferEvent::OPT_CLOSE_ON_FREE - - - - Lorsque le buffer d'événement est libéré, ferme le transport - sous-jacent. Ceci va fermer le socket sous-jacent, libérer le buffer - d'événement sous-jacent, etc. - - - - - - EventBufferEvent::OPT_THREADSAFE - - - - Alloue automatiquement des verrous pour le bufferevent, afin - de rendre sécurisé l'utilisation de plusieurs threads. - - - - - - EventBufferEvent::OPT_DEFER_CALLBACKS - - - - Lorsque ce drapeau est défini, le bufferevent reporte toutes ses - fonctions de rappel. Voir - - la documentation sur la programmation réseau rapide, portable, non bloquante avec Libevent, - le report des fonctions de rappel. - - - - - - EventBufferEvent::OPT_UNLOCK_CALLBACKS - - - - Par défaut, lorsque le bufferevent est défini pour être sécurisé au niveau - des threads, le verrou du buffer d'événement est maintenu, y compris si - une fonction de rappel utilisateur est appelée. La définition de cette option - permet à Libevent de libérer le verrou du buffer d'événement lorsque la fonction - de rappel est appelée. - - - - - - EventBufferEvent::SSL_OPEN - - - - La négociation SSL se fait - - - - - - EventBufferEvent::SSL_CONNECTING - - - - SSL effectue actuellement la négociation comme client - - - - - - EventBufferEvent::SSL_ACCEPTING - - - - SSL effectue actuellement la négociation comme serveur - - - - -
- - - - &reference.event.entities.eventbufferevent; - - - diff --git a/reference/event/eventbufferevent/close.xml b/reference/event/eventbufferevent/close.xml deleted file mode 100644 index 0f61b7f35c..0000000000 --- a/reference/event/eventbufferevent/close.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - EventBufferEvent::close - Ferme le descripteur de fichier associé avec le buffer d'événements courant - - - &reftitle.description; - - public - void - EventBufferEvent::close - - - - Ferme le descripteur de fichier associé avec le buffer d'événements courant. - - - Cette méthode peut être utilisée dans les cas où l'option - EventBufferEvent::OPT_CLOSE_ON_FREE n'est pas appropriée. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventbufferevent/connect.xml b/reference/event/eventbufferevent/connect.xml deleted file mode 100644 index 6a3a2be913..0000000000 --- a/reference/event/eventbufferevent/connect.xml +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - - - EventBufferEvent::connect - Connecte le descripteur de fichier du tampon d'événement à l'adresse fournie, - ou au socket UNIX - - - &reftitle.description; - - public - bool - EventBufferEvent::connect - - string - addr - - - - Connecte le descripteur de fichier du tampon d'événement à l'adresse fournie - (optionnellement, en fournissant le port), ou au socket UNIX. - - - Si le socket n'est pas assigné au tampon d'événements, cette méthode - alloue un nouveau socket et le rend non bloquant en interne. - - - Pour résoudre les noms DNS (de façon asynchrone), utiliser la méthode - EventBufferEvent::connectHost. - - - - &reftitle.parameters; - - - - addr - - - - Doit contenir une adresse IP avec, optionnellement, le numéro du port, - ou un chemin vers le socket UNIX. Les formats reconnus sont : - - - - Il est à noter que le préfixe 'unix:' n'est actuellement - pas sensible à la casse. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Exemple avec <function>EventBufferEvent::connect</function> - -getInput(); - - while (($n = $input->remove($buf, 1024)) > 0) { - echo $buf; - } -} - -/* Fonction de rappel d'événement */ -function eventcb($bev, $events, $base) { - if ($events & EventBufferEvent::CONNECTED) { - echo "Connecté.\n"; - } elseif ($events & (EventBufferEvent::ERROR | EventBufferEvent::EOF)) { - if ($events & EventBufferEvent::ERROR) { - echo "Erreur DNS : ", $bev->getDnsErrorString(), PHP_EOL; - } - - echo "Fermeture\n"; - $base->exit(); - exit("Fait !\n"); - } -} - -$base = new EventBase(); - -echo "étape 1\n"; -$bev = new EventBufferEvent($base, /* use internal socket */ NULL, - EventBufferEvent::OPT_CLOSE_ON_FREE | EventBufferEvent::OPT_DEFER_CALLBACKS); -if (!$bev) { - exit("Échec lors de la création du socket bufferevent\n"); -} - -echo "étape 2\n"; -$bev->setCallbacks("readcb", /* writecb */ NULL, "eventcb", $base); -$bev->enable(Event::READ | Event::WRITE); - -echo "étape 3\n"; -/* Envoi la demande */ -$output = $bev->getOutput(); -if (!$output->add( - "GET /index.cphp HTTP/1.0\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Échec lors de l'ajout de la demande dans le tampon de sortie\n"); -} - -/* Connexion à l'hôte de façon synchrone. - * Nous connaissons l'IP, et donc, nous n'avons pas besoin de résolution DNS. */ -if (!$bev->connect("127.0.0.1:80")) { - exit("Impossible de se connecter à l'hôte\n"); -} - -/* Distribue les événements en attente */ -$base->dispatch(); -]]> - - &example.outputs.similar; - - - - - - Connexion à un socket UNIX, lecture de la réponse depuis le - serveur, et affichage dans une console - -base = $base; - $this->bev = new EventBufferEvent($base, NULL, EventBufferEvent::OPT_CLOSE_ON_FREE, - array ($this, "read_cb"), NULL, array ($this, "event_cb")); - - if (!$this->bev->connect("unix:$sock_path")) { - trigger_error("Échec lors de la connexion au socket `$sock_path'", E_USER_ERROR); - } - - $this->bev->enable(Event::READ); - } - - function __destruct() { - if ($this->bev) { - $this->bev->free(); - $this->bev = NULL; - } - } - - function dispatch() { - $this->base->dispatch(); - } - - function read_cb($bev, $unused) { - $in = $bev->input; - - printf("Réception de %ld octets\n", $in->length); - printf("----- données ----\n"); - printf("%ld:\t%s\n", (int) $in->length, $in->pullup(-1)); - - $this->bev->free(); - $this->bev = NULL; - $this->base->exit(NULL); - } - - function event_cb($bev, $events, $unused) { - if ($events & EventBufferEvent::ERROR) { - echo "Erreur depuis bufferevent\n"; - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - $bev->free(); - $bev = NULL; - } elseif ($events & EventBufferEvent::CONNECTED) { - $bev->output->add("test\n"); - } - } -} - -if ($argc <= 1) { - exit("Le chemin vers le socket n'est pas fourni\n"); -} -$sock_path = $argv[1]; - -$base = new EventBase(); -$cl = new MyUnixSocketClient($base, $sock_path); -$cl->dispatch(); -?> - -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventBufferEvent::connectHost - - - - - diff --git a/reference/event/eventbufferevent/connecthost.xml b/reference/event/eventbufferevent/connecthost.xml deleted file mode 100644 index e98eadcf9b..0000000000 --- a/reference/event/eventbufferevent/connecthost.xml +++ /dev/null @@ -1,257 +0,0 @@ - - - - - - - EventBufferEvent::connectHost - Connexion à un hôte avec résolution DNS optionnellement asynchrone - - - &reftitle.description; - - public - bool - EventBufferEvent::connectHost - - EventDnsBase - dns_base - - - string - hostname - - - int - port - - - int - family - EventUtil::AF_UNSPEC - - - - Résout le nom d'hôte DNS, recherche de l'adresse du type - family (constante EventUtil::AF_*). - Si la résolution du nom échoue, la fonction de rappel de l'événement - sera appelée avec un événement d'erreur. Si la résolution réussit, - une tentative de connexion sera émise, tout comme le fait la méthode - EventBufferEvent::connect. - - - Le paramètre dns_base est optionnel. - Il peut valoir &null;, ou bien un objet créé avec la méthode - EventDnsBase::__construct. - Pour une résolution de nom d'hôte asynchrone, il faut passer une ressource - d'événement de base DNS valide. Sinon, la résolution du nom d'hôte - sera bloquante. - - - - EventDnsBase n'est disponible que si - Event est configuré avec l'option - - (bibliothèque event_extra, - le support des fonctionnalités spécifiques à libevent - incluant HTTP, DNS et RPC). - - - - - EventBufferEvent::connectHost - requiert libevent-2.0.3-alpha ou suivants. - - - - - &reftitle.parameters; - - - - dns_base - - - - Objet EventDnsBase dans le cas - où le DNS doit être résolu de façon asynchrone. Sinon, &null;. - - - - - - hostname - - - - Le nom d'hôte sur lequel la connexion tente d'être faite. - Les formats reconnus sont : - - - - - - - - - port - - - - Le numéro du port - - - - - - family - - - - Famille de l'adresse. - EventUtil::AF_UNSPEC, - EventUtil::AF_INET ou - EventUtil::AF_INET6. Voir les - constantes EventUtil. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Exemple avec <function>EventBufferEvent::connectHost</function> - -input; //$bev->getInput(); - - //$pos = $input->search("TTP"); - $pos = $bev->input->search("TTP"); - - while (($n = $bev->input->remove($buf, 1024)) > 0) { - echo $buf; - } -} - -/* Fonction de rappel de l'événement */ -function eventcb($bev, $events, $base) { - if ($events & EventBufferEvent::CONNECTED) { - echo "Connecté.\n"; - } elseif ($events & (EventBufferEvent::ERROR | EventBufferEvent::EOF)) { - if ($events & EventBufferEvent::ERROR) { - echo "Erreur DNS : ", $bev->getDnsErrorString(), PHP_EOL; - } - - echo "Fermeture\n"; - $base->exit(); - exit("Fait !\n"); - } -} - -$base = new EventBase(); - -$dns_base = new EventDnsBase($base, TRUE); // Résolution DNS asynchrone -if (!$dns_base) { - exit("Échec de l'initialisation de la base DNS\n"); -} - -$bev = new EventBufferEvent($base, /* utilisation d'un socket interne */ NULL, - EventBufferEvent::OPT_CLOSE_ON_FREE | EventBufferEvent::OPT_DEFER_CALLBACKS, - "readcb", /* writecb */ NULL, "eventcb", $base -); -if (!$bev) { - exit("Échec lors de la création du socket bufferevent\n"); -} - -//$bev->setCallbacks("readcb", /* writecb */ NULL, "eventcb", $base); -$bev->enable(Event::READ | Event::WRITE); - -$output = $bev->output; //$bev->getOutput(); -if (!$output->add( - "GET {$argv[2]} HTTP/1.0\r\n". - "Host: {$argv[1]}\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Échec lors de l'ajout de la demande dans le tampon de sortie\n"); -} - -if (!$bev->connectHost($dns_base, $argv[1], 80, EventUtil::AF_UNSPEC)) { - exit("Impossible de se connecter à l'hôte {$argv[1]}\n"); -} - -$base->dispatch(); -?> -]]> - - &example.outputs.similar; - - -301 Moved -

301 Moved

-The document has moved -here. - -Fermeture -Fait ! -]]> - - - - - &reftitle.seealso; - - - EventBufferEvent::connect - - - - - diff --git a/reference/event/eventbufferevent/construct.xml b/reference/event/eventbufferevent/construct.xml deleted file mode 100644 index 408bada6f6..0000000000 --- a/reference/event/eventbufferevent/construct.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - EventBufferEvent::__construct - Construit un objet EventBufferEvent - - - &reftitle.description; - - public - EventBufferEvent::__construct - - EventBase - base - - - mixed - socket - &null; - - - int - options - 0 - - - callable - readcb - &null; - - - callable - writecb - &null; - - - callable - eventcb - &null; - - mixedarg&null; - - - Crée un tampon d'événement sur un socket, un flux, ou un descripteur - de fichier. Le fait de passer la valeur &null; au paramètre - socket signifie que le socket doit être créé - ultérieurement, c.-à-d. via la méthode - EventBufferEvent::connect. - - - - &reftitle.parameters; - - - - base - - - - Événement de base qui doit être associé avec le nouveau tampon d'événement. - - - - - - socket - - - - Doit être créé comme flux (non nécessairement via l'extension - sockets) - - - - - - options - - - - Une constante parmi les constantes - EventBufferEvent::OPT_*, - ou 0. - - - - - - readcb - - - - Fonction de rappel pour les événements de lecture. Voir aussi - les fonctions - de rappel des tampons d'événement. - - - - - - writecb - - - - Fonction de rappel pour les événements d'écriture. Voir aussi les - fonctions - de rappel des tampons d'événement. - - - - - - eventcb - - - - Fonction de rappel pour les événements de changement de statut. - Voir aussi les - fonctions - de rappel des tampons d'événement. - - - - - - arg - - - - Une variable qui sera passée à toutes les fonctions de rappel. - - - - - - - &reftitle.seealso; - - - EventBufferEvent::sslFilter - - - EventBufferEvent::sslSocket - - - - - diff --git a/reference/event/eventbufferevent/createpair.xml b/reference/event/eventbufferevent/createpair.xml deleted file mode 100644 index 971389691f..0000000000 --- a/reference/event/eventbufferevent/createpair.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - EventBufferEvent::createPair - Crée deux événements de tampon connectés l'un à l'autre - - - &reftitle.description; - - public - static - array - EventBufferEvent::createPair - - EventBase - base - - - int - options - 0 - - - - Retourne un tableau de deux objets EventBufferEvent - connectés l'un à l'autre. Toutes les options habituelles sont supportées, - sauf pour EventBufferEvent::OPT_CLOSE_ON_FREE - qui n'a aucun effet, et EventBufferEvent::OPT_DEFER_CALLBACKS - qui est toujours activé. - - - - &reftitle.parameters; - - - - base - - - - Événement de base associé. - - - - - - options - - - - Constantes EventBufferEvent::OPT_* - combinées avec l'opérateur OR bit à bit. - - - - - - - &reftitle.returnvalues; - - Retourne un tableau de deux objets - EventBufferEvent - connectés l'un à l'autre. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.9.0 - - La méthode est maintenant statique. - - - - - - - - diff --git a/reference/event/eventbufferevent/disable.xml b/reference/event/eventbufferevent/disable.xml deleted file mode 100644 index aeef3ad657..0000000000 --- a/reference/event/eventbufferevent/disable.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - EventBufferEvent::disable - Désactive les événements de lecture, d'écriture ou des deux sur un événement de tampon - - - &reftitle.description; - - public - bool - EventBufferEvent::disable - - int - events - - - - Désactive les événements Event::READ, - Event::WRITE, ou - Event::READ|Event::WRITE - sur un événement de tampon. - - - - &reftitle.parameters; - - - - events - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::enable - - - - - diff --git a/reference/event/eventbufferevent/enable.xml b/reference/event/eventbufferevent/enable.xml deleted file mode 100644 index a73bfebd06..0000000000 --- a/reference/event/eventbufferevent/enable.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - EventBufferEvent::enable - Active les événements de lecture, d'écriture, ou des deux, sur un événement de tampon - - - &reftitle.description; - - public - bool - EventBufferEvent::enable - - int - events - - - - Active les événements Event::READ, - Event::WRITE, ou - Event::READ|Event::WRITE - sur un événement de tampon. - - - - &reftitle.parameters; - - - - events - - - - Event::READ, Event::WRITE, ou - Event::READ|Event::WRITE - sur un événement de tampon. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::disable - - - - - diff --git a/reference/event/eventbufferevent/free.xml b/reference/event/eventbufferevent/free.xml deleted file mode 100644 index c9e35d379b..0000000000 --- a/reference/event/eventbufferevent/free.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - EventBufferEvent::free - Libère un événement de tampon - - - &reftitle.description; - - public - void - EventBufferEvent::free - - - - Libère toutes les ressources allouées par un événement - de tampon. - - - Habituellement, il n'est pas nécessaire d'appeler cette méthode, sachant - que normalement, la libération totale des ressources associées s'effectue - dans les destructeurs internes de l'objet. Cependant, il se peut - qu'un long script alloue beaucoup d'instances, ou bien qu'un script - utilise énormément de mémoire ; dans ces cas, il peut être nécessaire - de libérer les ressources aussi vite que possible. Aussi, l'utilisation - de la méthode EventBufferEvent::free peut être utile - pour protéger l'exécution du script d'atteindre la valeur de - memory_limit. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventbufferevent/getdnserrorstring.xml b/reference/event/eventbufferevent/getdnserrorstring.xml deleted file mode 100644 index 88344351f1..0000000000 --- a/reference/event/eventbufferevent/getdnserrorstring.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - EventBufferEvent::getDnsErrorString - Retourne une chaîne décrivant la dernière erreur DNS - - - &reftitle.description; - - public - string - EventBufferEvent::getDnsErrorString - - - - Retourne une chaîne décrivant la dernière erreur DNS lors de - l'exécution de la méthode EventBufferEvent::connectHost - ou une chaîne vide s'il n'y a aucune erreur DNS de détectée. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne une chaîne décrivant l'erreur DNS, ou une chaîne vide s'il n'y a - aucune erreur. - - - - &reftitle.seealso; - - - EventBufferEvent::connectHost - - - - - diff --git a/reference/event/eventbufferevent/getenabled.xml b/reference/event/eventbufferevent/getenabled.xml deleted file mode 100644 index 77d434fe42..0000000000 --- a/reference/event/eventbufferevent/getenabled.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - EventBufferEvent::getEnabled - Retourne un masque d'événements actuellement actifs sur le tampon d'événements - - - &reftitle.description; - - public - int - EventBufferEvent::getEnabled - - - - Retourne un masque d'événements actuellement actifs sur le tampon d'événements. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un entier représentant un masque d'événements actuellement - actifs sur le tampon d'événements. - - - - &reftitle.seealso; - - - EventBufferEvent::enable - - - EventBufferEvent::disable - - - - - diff --git a/reference/event/eventbufferevent/getinput.xml b/reference/event/eventbufferevent/getinput.xml deleted file mode 100644 index 2299781f61..0000000000 --- a/reference/event/eventbufferevent/getinput.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - EventBufferEvent::getInput - Retourne le tampon d'entrée associé avec le tampon d'événements courant - - - &reftitle.description; - - public - EventBuffer - EventBufferEvent::getInput - - - - Retourne le tampon d'entrée associé avec le tampon d'événements courant. - Un tampon d'entrée est un stockage pour les données à lire. - - - Il est à noter qu'il y a aussi des propriétés d' - entrée - pour la classe EventBufferEvent. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne une instance du tampon d'entrée - EventBuffer associé avec le tampon d'événements courant. - - - - &reftitle.examples; - - Fonction de rappel pour un événement de lecture sur le tampon - -input; //$bev->getInput(); - - while (($n = $input->remove($buf, 1024)) > 0) { - echo $buf; - } -} -?> -]]> - - - - - &reftitle.seealso; - - - EventBufferEvent::getOutput - - - - - diff --git a/reference/event/eventbufferevent/getoutput.xml b/reference/event/eventbufferevent/getoutput.xml deleted file mode 100644 index b134bc5207..0000000000 --- a/reference/event/eventbufferevent/getoutput.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - EventBufferEvent::getOutput - Retourne le tampon de sortie associé avec le tampon - d'événement courant - - - &reftitle.description; - - public - EventBuffer - EventBufferEvent::getOutput - - - - Retourne le tampon de sortie associé avec le tampon - d'événement courant. Un tampon de sortie est un stockage pour les données - à écrire. - - - Il est à noter qu'il y a aussi des propriétés de - sortie - pour la classe EventBufferEvent. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne une instance du tampon de sortie - EventBuffer associé avec le tampon - d'événements courant. - - - - &reftitle.examples; - - Exemple avec <function>EventBufferEvent::getOutput</function> - -enable(Event::READ | Event::WRITE); - -$output = $bev->getOutput(); -if (!$output->add( - "GET {$argv[2]} HTTP/1.0\r\n". - "Host: {$argv[1]}\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Échec lors de l'ajout de la demande dans le tampon de sortie\n"); -} - -/* ... */ -?> -]]> - - - - - &reftitle.seealso; - - - EventBufferEvent::getInput - - - - - diff --git a/reference/event/eventbufferevent/read.xml b/reference/event/eventbufferevent/read.xml deleted file mode 100644 index 04ad67ba4f..0000000000 --- a/reference/event/eventbufferevent/read.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - EventBufferEvent::read - Lit les données du tampon - - - &reftitle.description; - - public - string - EventBufferEvent::read - - int - size - - - - Supprime jusqu'à size octets du tampon - d'entrée. Retourne une chaîne de données lues - depuis le tampon d'entrée. - - - - &reftitle.parameters; - - - - size - - - - Nombre maximal d'octets à lire - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne de données lues depuis le tampon d'entrée. - - - - &reftitle.seealso; - - - EventBufferEvent::readBuffer - - - - - diff --git a/reference/event/eventbufferevent/readbuffer.xml b/reference/event/eventbufferevent/readbuffer.xml deleted file mode 100644 index dfe84bdc38..0000000000 --- a/reference/event/eventbufferevent/readbuffer.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - EventBufferEvent::readBuffer - Vide le contenu entier du tampon d'entrée et le place dans le tampon - - - &reftitle.description; - - public - bool - EventBufferEvent::readBuffer - - EventBuffer - buf - - - - Vide le contenu entier du tampon d'entrée et le place dans le tampon - buf. - - - - &reftitle.parameters; - - - - buf - - - - Tampon cible - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::read - - - - - diff --git a/reference/event/eventbufferevent/setcallbacks.xml b/reference/event/eventbufferevent/setcallbacks.xml deleted file mode 100644 index 30555ce016..0000000000 --- a/reference/event/eventbufferevent/setcallbacks.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - EventBufferEvent::setCallbacks - Assigne les fonctions de rappel pour la lecture, l'écriture, et les statuts d'événements - - - &reftitle.description; - - public - void - EventBufferEvent::setCallbacks - - callable - readcb - - - callable - writecb - - - callable - eventcb - - - mixed - arg - - - - Assigne les fonctions de rappel pour la lecture, l'écriture, - et les statuts d'événements. - - - - &reftitle.parameters; - - - - readcb - - - - Fonction de rappel pour un événement de lecture. - Voir les - fonctions de - rappel pour les tampons d'événements. - - - - - - writecb - - - - Fonction de rappel pour un événement d'écriture. - Voir les - fonctions de - rappel pour les tampons d'événements. - - - - - - eventcb - - - - Fonction de rappel pour un événement de modification de statut. - Voir les - fonctions de - rappel pour les tampons d'événements. - - - - - - arg - - - - Une variable qui sera passée à toutes les fonctions de rappel. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventBufferEvent::__construct - - - - - diff --git a/reference/event/eventbufferevent/setpriority.xml b/reference/event/eventbufferevent/setpriority.xml deleted file mode 100644 index e24183f8b6..0000000000 --- a/reference/event/eventbufferevent/setpriority.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - EventBufferEvent::setPriority - Assigne une priorité pour un tampon d'événements - - - &reftitle.description; - - public - bool - EventBufferEvent::setPriority - - int - priority - - - - Assigne une priorité pour un tampon d'événements. - - - - Uniquement supporté pour les sockets de tampon d'événements. - - - - - &reftitle.parameters; - - - - priority - - - - Valeur de la priorité. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventbufferevent/settimeouts.xml b/reference/event/eventbufferevent/settimeouts.xml deleted file mode 100644 index f1e2bfecdd..0000000000 --- a/reference/event/eventbufferevent/settimeouts.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - EventBufferEvent::setTimeouts - Définit le délai d'attente en lecture et en écriture d'un tampon d'événement - - - &reftitle.description; - - public - bool - EventBufferEvent::setTimeouts - - float - timeout_read - - - float - timeout_write - - - - Définit le délai d'attente en lecture et en écriture d'un tampon d'événement. - - - - &reftitle.parameters; - - - - timeout_read - - - - Le délai d'attente en lecture - - - - - - timeout_write - - - - Le délai d'attente en écriture - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventbufferevent/setwatermark.xml b/reference/event/eventbufferevent/setwatermark.xml deleted file mode 100644 index a31a7c0323..0000000000 --- a/reference/event/eventbufferevent/setwatermark.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - EventBufferEvent::setWatermark - Ajuste les filigranes de lecture et/ou d'écriture - - - &reftitle.description; - - public - void - EventBufferEvent::setWatermark - - int - events - - - int - lowmark - - - int - highmark - - - - Ajuste les filigranes de lecture, les filigranes d'écriture, - ou les deux, d'un unique tampon d'événement. - - - Un filigrane de tampon d'événement est une portion, une valeur spécifiant - le nombre d'octets à lire ou à écrire avant d'appeler la fonction de rappel. - Par défaut, chaque événement de lecture/écriture lance une fonction de - rappel. Voir aussi la page suivante (en anglais) : - Fast - portable non-blocking network programming with Libevent: Callbacks and watermarks - - - - &reftitle.parameters; - - - - events - - - - Masque de constantes Event::READ, - Event::WRITE, ou les deux. - - - - - - lowmark - - - - Valeur minimale du filigrane. - - - - - - highmark - - - - Valeur maximale du filigrane. La valeur 0 - signifie "aucune limite". - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventbufferevent/sslerror.xml b/reference/event/eventbufferevent/sslerror.xml deleted file mode 100644 index 7b44077565..0000000000 --- a/reference/event/eventbufferevent/sslerror.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - EventBufferEvent::sslError - Retourne l'erreur OpenSSL la plus récente rapportée par le tampon d'événement - - - &reftitle.description; - - public - string - EventBufferEvent::sslError - - - - Retourne l'erreur OpenSSL la plus récente rapportée par le tampon d'événement. - - - - Cette méthode n'est disponible que si - Event a été compilé avec le support OpenSSL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne la chaîne d'erreur OpenSSL rapportée par le tampon d'événement ou - &false; s'il n'y a plus aucune erreur à retourner. - - - - &reftitle.examples; - - Exemple avec <function>EventBufferEvent::sslError</function> - -sslError()) { - fprintf(STDERR, "Erreur Bufferevent %s.\n", $err); - } - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - $bev->free(); - } -} -?> -]]> - - - - - &reftitle.seealso; - - - EventBufferEvent::sslRenegotiate - - - - - diff --git a/reference/event/eventbufferevent/sslfilter.xml b/reference/event/eventbufferevent/sslfilter.xml deleted file mode 100644 index 8b1d2d6072..0000000000 --- a/reference/event/eventbufferevent/sslfilter.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - EventBufferEvent::sslFilter - Crée un nouveau tampon d'événement SSL, dont les données - seront envoyées via un autre tampon d'événement - - - &reftitle.description; - - public - static - EventBufferEvent - EventBufferEvent::sslFilter - - EventBase - base - - - EventBufferEvent - underlying - - - EventSslContext - ctx - - - int - state - - - int - options - 0 - - - - Crée un nouveau tampon d'événement SSL, dont les données - seront envoyées via un autre tampon d'événement. - - - - Cette méthode n'est disponible que si - Event a été compilé avec le support OpenSSL. - - - - - &reftitle.parameters; - - - - base - - - - Événement de base associé. - - - - - - underlying - - - - Un socket de tampon d'événement à utiliser pour ce SSL. - - - - - - ctx - - - - Objet de la classe EventSslContext. - - - - - - state - - - - Le statut courant de la connexion SSL : - EventBufferEvent::SSL_OPEN, - EventBufferEvent::SSL_ACCEPTING ou - EventBufferEvent::SSL_CONNECTING. - - - - - - options - - - - Une ou plusieurs options de tampon d'événement. - - - - - - - &reftitle.returnvalues; - - Retourne un nouvel objet EventBufferEvent SSL. - - - - &reftitle.examples; - - - - - - &reftitle.seealso; - - - EventBufferEvent::sslSocket - - - - - diff --git a/reference/event/eventbufferevent/sslgetcipherinfo.xml b/reference/event/eventbufferevent/sslgetcipherinfo.xml deleted file mode 100644 index 95c6f157c6..0000000000 --- a/reference/event/eventbufferevent/sslgetcipherinfo.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - EventBufferEvent::sslGetCipherInfo - Retourne une description textuelle d'un cipher - - - &reftitle.description; - - public - string - EventBufferEvent::sslGetCipherInfo - - - - Récupère la description du cipher courant via la fonction - SSL_CIPHER_description de l'API SSL (voir - la page man de SSL_CIPHER_get_name(3)). - - - - Cette fonction n'est disponible que si - Event a été compilé avec le support - OpenSSL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne une description textuelle du cipher en cas de succès, - ou bien &false; si une erreur survient. - - - - diff --git a/reference/event/eventbufferevent/sslgetciphername.xml b/reference/event/eventbufferevent/sslgetciphername.xml deleted file mode 100644 index ef5e1f6c3d..0000000000 --- a/reference/event/eventbufferevent/sslgetciphername.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventBufferEvent::sslGetCipherName - Retourne le nom du cipher courant pour la connexion SSL - - - &reftitle.description; - - public - string - EventBufferEvent::sslGetCipherName - - - - Récupère le nom du cipher courant pour la connexion SSL. - - - - Cette fonction n'est disponible que si - Event a été compilé avec le support - OpenSSL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne le nom du cipher courant pour la connexion SSL ou &false; - si une erreur survient. - - - - diff --git a/reference/event/eventbufferevent/sslgetcipherversion.xml b/reference/event/eventbufferevent/sslgetcipherversion.xml deleted file mode 100644 index 1c82718771..0000000000 --- a/reference/event/eventbufferevent/sslgetcipherversion.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventBufferEvent::sslGetCipherVersion - Retourne la version du cipher utilisé pour la connexion SSL courante - - - &reftitle.description; - - public - string - EventBufferEvent::sslGetCipherVersion - - - - Récupère la version du cipher utilisé pour la connexion SSL courante. - - - - Cette fonction n'est disponible que si - Event a été compilé avec le support - OpenSSL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne la version du cipher utilisé pour la connexion SSL courante - ou &false; si une erreur survient. - - - - diff --git a/reference/event/eventbufferevent/sslgetprotocol.xml b/reference/event/eventbufferevent/sslgetprotocol.xml deleted file mode 100644 index 5411a03cf6..0000000000 --- a/reference/event/eventbufferevent/sslgetprotocol.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventBufferEvent::sslGetProtocol - Retourne le nom du protocole utilisé pour la connexion SSL courante - - - &reftitle.description; - - public - string - EventBufferEvent::sslGetProtocol - - - - Retourne le nom du protocole utilisé pour la connexion SSL courante. - - - - Cette fonction n'est disponible que si - Event a été compilé avec le support - OpenSSL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne le nom du protocole utilisé pour la connexion SSL courante. - - - - - diff --git a/reference/event/eventbufferevent/sslrenegotiate.xml b/reference/event/eventbufferevent/sslrenegotiate.xml deleted file mode 100644 index 15e7102c5d..0000000000 --- a/reference/event/eventbufferevent/sslrenegotiate.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - EventBufferEvent::sslRenegotiate - Demande au tampon d'événement de commencer une renégociation SSL - - - &reftitle.description; - - public - void - EventBufferEvent::sslRenegotiate - - - - Demande au tampon d'événement de commencer une renégociation SSL. - - - - L'appel à cette méthode demande à SSL une renégociation, et au tampon - d'événement d'appeler la fonction de rappel appropriée. C'est une méthode - très avancée ; elle ne doit être appelée que si l'on sait parfaitement - ce que l'on fait, tout spécialement depuis que de nombreuses versions SSL - ont présenté des failles de sécurité connues liées à la renégociation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventbufferevent/sslsocket.xml b/reference/event/eventbufferevent/sslsocket.xml deleted file mode 100644 index ef7a6a19d4..0000000000 --- a/reference/event/eventbufferevent/sslsocket.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - EventBufferEvent::sslSocket - Crée un nouveau tampon SSL dont ses données seront envoyées via un socket SSL - - - &reftitle.description; - - public - static - EventBufferEvent - EventBufferEvent::sslSocket - - EventBase - base - - - mixed - socket - - - EventSslContext - ctx - - - int - state - - - int - options - - - - Crée un nouveau tampon SSL dont ses données seront - envoyées via un socket SSL. - - - - &reftitle.parameters; - - - - base - - - - Événement de base associé. - - - - - - socket - - - - Socket à utiliser pour ce SSL. Peut être un flux, une ressource - de socket, un descripteur numérique de fichier, ou &null;. Si le - paramètre socket vaut &null;, on suppose - que le descripteur de fichier pour ce socket sera assigné ultérieurement - via la méthode EventBufferEvent::connectHost. - - - - - - ctx - - - - Objet de la classe EventSslContext. - - - - - - state - - - - Le statut courant de la connexion SSL : - EventBufferEvent::SSL_OPEN, - EventBufferEvent::SSL_ACCEPTING ou - EventBufferEvent::SSL_CONNECTING. - - - - - - options - - - - Les options du tampon d'événement. - - - - - - - &reftitle.returnvalues; - - Retourne un objet EventBufferEvent. - - - - &reftitle.seealso; - - - EventBufferEvent::sslFilter - - - - - diff --git a/reference/event/eventbufferevent/write.xml b/reference/event/eventbufferevent/write.xml deleted file mode 100644 index eb6d61cd00..0000000000 --- a/reference/event/eventbufferevent/write.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBufferEvent::write - Ajoute des données dans le tampon de sortie d'un tampon d'événement - - - &reftitle.description; - - public - bool - EventBufferEvent::write - - string - data - - - - Ajoute des données dans le tampon de sortie d'un tampon d'événement. - - - - &reftitle.parameters; - - - - data - - - - Données à ajouter dans le tampon. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::writeBuffer - - - - - diff --git a/reference/event/eventbufferevent/writebuffer.xml b/reference/event/eventbufferevent/writebuffer.xml deleted file mode 100644 index a502e2e5b2..0000000000 --- a/reference/event/eventbufferevent/writebuffer.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBufferEvent::writeBuffer - Ajoute le contenu entier d'un tampon dans le tampon de sortie d'un tampon d'événement - - - &reftitle.description; - - public - bool - EventBufferEvent::writeBuffer - - EventBuffer - buf - - - - Ajoute le contenu entier d'un tampon dans le tampon de sortie d'un tampon d'événement. - - - - &reftitle.parameters; - - - - buf - - - - Objet EventBuffer source. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::write - - - - - diff --git a/reference/event/eventconfig.xml b/reference/event/eventconfig.xml deleted file mode 100644 index ac36d56c28..0000000000 --- a/reference/event/eventconfig.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - La classe EventConfig - EventConfig - - -
- &reftitle.intro; - - Représente la structure de configuration qui peut être utilisée - dans la construction de la classe EventBase. - -
- -
- &reftitle.classsynopsis; - - - - - EventConfig - - - - - final - EventConfig - - - - &Constants; - - const - int - EventConfig::FEATURE_ET - 1 - - - const - int - EventConfig::FEATURE_O1 - 2 - - - const - int - EventConfig::FEATURE_FDS - 4 - - &Methods; - - - -
- -
- &reftitle.constants; - - - - EventConfig::FEATURE_ET - - - - Requiert une méthode du backend qui supporte les I/O edge-triggered. - - - - - - EventConfig::FEATURE_O1 - - - - Requiert une méthode du backend où ajouter ou supprimer un seul événement, - ou avoir un seul événement qui devient actif, est une opération en O(1). - - - - - - EventConfig::FEATURE_FDS - - - - Requiert une méthode du backend qui peut supporter des types arbitraires - de descripteur de fichier, et non pas seulement des sockets. - - - - -
- - - - &reference.event.entities.eventconfig; - - - diff --git a/reference/event/eventconfig/avoidmethod.xml b/reference/event/eventconfig/avoidmethod.xml deleted file mode 100644 index d4d98995df..0000000000 --- a/reference/event/eventconfig/avoidmethod.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - EventConfig::avoidMethod - Demande à libevent d'ignorer une méthode d'événement spécifique - - - &reftitle.description; - - public - bool - EventConfig::avoidMethod - - string - method - - - - Demande à libevent d'ignorer une méthode d'événement spécifique. - Voir la - création - d'un événement de base. - - - - &reftitle.parameters; - - - - method - - - - La méthode à ignorer. Voir - les constantes EventConfig. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Exemple avec <function>EventConfig::avoidMethod</function> - -avoidMethod("select")) { - echo "Méthode 'select' ignorée\n"; -} -?> -]]> - - - - - &reftitle.seealso; - - - EventBase::__construct - - - - - diff --git a/reference/event/eventconfig/construct.xml b/reference/event/eventconfig/construct.xml deleted file mode 100644 index 9d873d6fe8..0000000000 --- a/reference/event/eventconfig/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - EventConfig::__construct - Construit un objet EventConfig - - - &reftitle.description; - - public - EventConfig::__construct - - - - Construit un objet EventConfig qui pourra être passé - au constructeur EventBase::__construct. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.examples; - - Exemple avec <function>EventConfig::__construct</function> - -avoidMethod("select")) { - echo "Méthode 'select' ignorée\n"; -} - -// Crée un event_base associé avec la configuration -$base = new EventBase($cfg); - -/* Maintenant, $base est configuré pour ignorer la méthode select */ -?> -]]> - - - - - - &reftitle.seealso; - - - EventBase::__construct - - - - - diff --git a/reference/event/eventconfig/requirefeatures.xml b/reference/event/eventconfig/requirefeatures.xml deleted file mode 100644 index 92a1d31ae6..0000000000 --- a/reference/event/eventconfig/requirefeatures.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - EventConfig::requireFeatures - Entre dans une fonctionnalité de méthode d'événement demandée par l'application - - - &reftitle.description; - - public - bool - EventConfig::requireFeatures - - int - feature - - - - Entre dans une fonctionnalité de méthode d'événement demandée - par l'application. - - - - &reftitle.parameters; - - - - feature - - - - Masque de fonctionnalités demandées. Voir les constantes - EventConfig::FEATURE_*. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Exemple avec <function>EventConfig::requireFeatures</function> - -requireFeatures(EventConfig::FEATURE_FDS)) { - echo "fonctionnalité FDS demandée\n"; - - $base = new EventBase($cfg); - ($base->getFeatures() & EventConfig::FEATURE_FDS) - and print "FDS - types arbitraires de descripteur de fichier et non pas juste des sockets\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventBase::getFeatures - - - - - diff --git a/reference/event/eventconfig/setflags.xml b/reference/event/eventconfig/setflags.xml deleted file mode 100644 index 170560330a..0000000000 --- a/reference/event/eventconfig/setflags.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - EventConfig::setFlags - Définit un ou plusieurs indicateurs qui configurent la manière dont l'événement de base éventuel sera initialisé - - - &reftitle.description; - - public - bool - EventConfig::setFlags - - int - flags - - - - Définit un ou plusieurs indicateurs pour configurer quelles parties - de l'événement de base éventuel seront initialisées, et comment elles fonctionneront. - - - - &reftitle.parameters; - - - - flags - - - - L'une des constantes EventBase::LOOP_*. - Voir constantes d'EventBase. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::getFeatures - - - - - diff --git a/reference/event/eventconfig/setmaxdispatchinterval.xml b/reference/event/eventconfig/setmaxdispatchinterval.xml deleted file mode 100644 index 1cb7713496..0000000000 --- a/reference/event/eventconfig/setmaxdispatchinterval.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - EventConfig::setMaxDispatchInterval - Évite l'inversion des priorités - - - &reftitle.description; - - public - void - EventConfig::setMaxDispatchInterval - - int - max_interval - - - int - max_callbacks - - - int - min_priority - - - - Évite l'inversion des priorités en limitant le nombre - de fonctions de rappel d'événements en basse priorité qui peuvent - être invoquées avant de vérifier la présence d'événements de haute - priorité. - - - - Disponible depuis libevent 2.1.0-alpha. - - - - - &reftitle.parameters; - - - - max_interval - - - - Un intervalle après lequel Libevent va arrêter l'exécution des - fonctions de rappel et vérifier la présence d'autres événements, ou - 0 s'il ne doit pas y avoir de tel intervalle. - - - - - - max_callbacks - - - - Un nombre de fonctions de rappel après lequel Libevent doit arrêter - l'exécution des fonctions de rappel et vérifier la présence d'autres - événements, ou -1 s'il ne doit pas y avoir - de telle limite. - - - - - - min_priority - - - - Une priorité en dessous de laquelle max_interval - et max_callbacks ne doivent pas être pris - en compte. Si défini à 0, ils seront pris - en compte pour les événements de n'importe quelle priorité ; - si défini à 1, ils seront pris en compte - pour les événements de priorité 1 et ainsi - de suite. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase.xml b/reference/event/eventdnsbase.xml deleted file mode 100644 index 0d9b410eae..0000000000 --- a/reference/event/eventdnsbase.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - La classe EventDnsBase - EventDnsBase - - -
- &reftitle.intro; - - Représente la structure de base DNS de Libevent. Utilisé pour - résoudre les DNS de façon asynchrone, pour analyser les fichiers - de configuration comme resolv.conf etc. - -
- -
- &reftitle.classsynopsis; - - - - - EventDnsBase - - - - - final - EventDnsBase - - - - &Constants; - - const - int - EventDnsBase::OPTION_SEARCH - 1 - - - const - int - EventDnsBase::OPTION_NAMESERVERS - 2 - - - const - int - EventDnsBase::OPTION_MISC - 4 - - - const - int - EventDnsBase::OPTION_HOSTSFILE - 8 - - - const - int - EventDnsBase::OPTIONS_ALL - 15 - - - const - int - EventDnsBase::DISABLE_WHEN_INACTIVE - 32768 - - - const - int - EventDnsBase::INITIALIZE_NAMESERVERS - 1 - - - const - int - EventDnsBase::NAMESERVERS_NO_DEFAULT - 65536 - - &Methods; - - - - -
- -
- &reftitle.constants; - - - - EventDnsBase::OPTION_SEARCH - - - - Demande à lire le domaine et recherche les champs depuis le - fichier resolv.conf et l'option - ndots, et les utilise pour décider quel domaine - (s'il y en a) doit être utilisé pour chercher les noms d'hôtes - qui ne sont pas totalement qualifiés. - - - - - - EventDnsBase::OPTION_NAMESERVERS - - - - Demande à connaître les noms des serveurs depuis le fichier - resolv.conf. - - - - - - EventDnsBase::OPTION_MISC - - - - - - - - EventDnsBase::OPTION_HOSTSFILE - - - - Demande à lire une liste d'hôtes depuis le fichier - /etc/hosts comme partie du - chargement du fichier resolv.conf. - - - - - - EventDnsBase::OPTIONS_ALL - - - - Demande à connaître tout le contenu du fichier - resolv.conf. - - - - - - EventDnsBase::DISABLE_WHEN_INACTIVE - - - - Ne pas empêcher la boucle d'événements de libevent de se terminer lorsque nous n'avons pas de requêtes DNS actives. - - - - - - EventDnsBase::INITIALIZE_NAMESERVERS - - - - Traiter le fichier resolv.conf. - - - - - - EventDnsBase::NAMESERVERS_NO_DEFAULT - - - - Ne pas ajouter de serveur de noms par défaut s'il n'y a pas de serveurs de noms dans le fichier resolv.conf. - - - - -
- - - - &reference.event.entities.eventdnsbase; - - - diff --git a/reference/event/eventdnsbase/addnameserverip.xml b/reference/event/eventdnsbase/addnameserverip.xml deleted file mode 100644 index 91919e40d1..0000000000 --- a/reference/event/eventdnsbase/addnameserverip.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - EventDnsBase::addNameserverIp - Ajoute un serveur de noms à la base DNS - - - &reftitle.description; - - public - bool - EventDnsBase::addNameserverIp - - string - ip - - - - Ajoute un serveur de noms à evdns_base. - - - - &reftitle.parameters; - - - - ip - - - - La chaîne représentant le serveur de noms ; soit une adresse - IPv4, soit une adresse IPv6, soit une adresse IPv4 avec un port - (IPv4:Port), soit une adresse IPv6 avec un - port ([IPv6]:Port). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase/addsearch.xml b/reference/event/eventdnsbase/addsearch.xml deleted file mode 100644 index d9f1b0510a..0000000000 --- a/reference/event/eventdnsbase/addsearch.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - EventDnsBase::addSearch - Ajoute un domaine à la liste des domaines utilisés pour la recherche - - - &reftitle.description; - - public - void - EventDnsBase::addSearch - - string - domain - - - - Ajoute un domaine à la liste des domaines utilisés pour la recherche. - - - - &reftitle.parameters; - - - - domain - - - - Le domaine à ajouter pour la recherche. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventdnsbase/clearsearch.xml b/reference/event/eventdnsbase/clearsearch.xml deleted file mode 100644 index 11a40c200c..0000000000 --- a/reference/event/eventdnsbase/clearsearch.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - EventDnsBase::clearSearch - Supprime tous les suffixes courants de recherche - - - &reftitle.description; - - public - void - EventDnsBase::clearSearch - - - - Supprime tous les suffixes courants de recherche depuis - la base DNS ; la méthode EventDnsBase::addSearch - ajoute un suffixe. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventDnsBase::addSearch - - - - - diff --git a/reference/event/eventdnsbase/construct.xml b/reference/event/eventdnsbase/construct.xml deleted file mode 100644 index e32be0b5ed..0000000000 --- a/reference/event/eventdnsbase/construct.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - EventDnsBase::__construct - Construit un objet EventDnsBase - - - &reftitle.description; - - public - EventDnsBase::__construct - - EventBase - base - - - intbool - initialize - - - - Construit un objet EventDnsBase. - - - - &reftitle.parameters; - - - - base - - - - Événement de base. - - - - - - initialize - - - - Si initialize est &true;, il tente d'utiliser les paramètres par défaut du système d'exploitation sous-jacent pour configurer judicieusement la base DNS. - Si c'est &false;, la base DNS est laissée non configurée, sans serveurs de noms ni options définies. - Dans ce dernier cas, la base DNS doit être configurée manuellement, par exemple avec la méthode EventDnsBase::parseResolvConf. - - - Si initialize est un entier, il doit être l'un des drapeaux suivants: - - - - - Drapeau - &Description; - - - - - EventDnsBase::DISABLE_WHEN_INACTIVE - - Ne pas empêcher la boucle d'événements de libevent de se terminer lorsque nous n'avons pas de requêtes DNS actives. - - - - EventDnsBase::INITIALIZE_NAMESERVERS - - Traiter le fichier resolv.conf. - - - - EventDnsBase::NAMESERVERS_NO_DEFAULT - - Ne pas ajouter de serveur de noms par défaut s'il n'y a pas de serveurs de noms dans le fichier resolv.conf. - - - - - - - - - - - - &reftitle.errors; - - Si initialize a un type autre que - intbool, - une TypeError est déclenchée. - - - Si la valeur de initialize est invalide, - une EventException est déclenchée. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 3.1.3 - - Si initialize a un type autre que - intbool, - une TypeError est déclenchée. - - - - PECL event 3.1.0RC1 - - Le type du paramètre initialize a été changé de bool - à mixed. La valeur peut être soit bool (en préservant le sens précédent) - ou l'une des constantes suivantes: - EventDnsBase::DISABLE_WHEN_INACTIVE, - EventDnsBase::INITIALIZE_NAMESERVERS, - ou EventDnsBase::NAMESERVERS_NO_DEFAULT. - - - - - - - - diff --git a/reference/event/eventdnsbase/countnameservers.xml b/reference/event/eventdnsbase/countnameservers.xml deleted file mode 100644 index 159d3dfdf5..0000000000 --- a/reference/event/eventdnsbase/countnameservers.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - EventDnsBase::countNameservers - Récupère le nombre de serveurs de noms configurés - - - &reftitle.description; - - public - int - EventDnsBase::countNameservers - - - - Récupère le nombre de serveurs de noms configurés. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne le nombre de serveurs de noms configurés (pas nécessairement - le nombre de serveurs de noms en cours de fonctionnement). Ceci est utile - pour vérifier si nos appels aux diverses fonctions de configuration - des serveurs de noms ont réussi ou non. - - - - diff --git a/reference/event/eventdnsbase/loadhosts.xml b/reference/event/eventdnsbase/loadhosts.xml deleted file mode 100644 index dc3cccbbd6..0000000000 --- a/reference/event/eventdnsbase/loadhosts.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - EventDnsBase::loadHosts - Charge un fichier hosts (au même format que /etc/hosts) - - - &reftitle.description; - - public - bool - EventDnsBase::loadHosts - - string - hosts - - - - Charge un fichier hosts (au même format que - /etc/hosts). - - - - &reftitle.parameters; - - - - hosts - - - - Chemin vers le fichier hosts. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase/parseresolvconf.xml b/reference/event/eventdnsbase/parseresolvconf.xml deleted file mode 100644 index 054166a474..0000000000 --- a/reference/event/eventdnsbase/parseresolvconf.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - EventDnsBase::parseResolvConf - Analyse le fichier resolv.conf - - - &reftitle.description; - - public - bool - EventDnsBase::parseResolvConf - - int - flags - - - string - filename - - - - Analyse le fichier resolv.conf, et y lit toutes les options - présentes. - - - - &reftitle.parameters; - - - - flags - - - - Détermine les informations à analyser depuis le fichier - resolv.conf. Voir la page du manuel système - du fichier resolv.conf pour connaître - son format. - - - Les directives suivantes ne sont pas analysées dans le fichier : - sortlist, rotate, no-check-names, inet6, debug. - - - Si cette fonction rencontre une erreur, les valeurs retournées possibles - sont : - - - 1 = échec lors de l'ouverture du fichier - - 2 = échec lors de la récupération des informations du fichier - - 3 = fichier trop grand - - 4 = dépassement mémoire - - 5 = lecture trop courte du fichier - - 6 = aucun serveur de noms listé dans le fichier - - - - - - - filename - - - - Chemin vers le fichier resolv.conf. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase/setoption.xml b/reference/event/eventdnsbase/setoption.xml deleted file mode 100644 index 7de5512c56..0000000000 --- a/reference/event/eventdnsbase/setoption.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - EventDnsBase::setOption - Définit la valeur d'une option de configuration - - - &reftitle.description; - - public - bool - EventDnsBase::setOption - - string - option - - - string - value - - - - Définit la valeur d'une option de configuration. - - - - &reftitle.parameters; - - - - option - - - - Les options de configuration actuellement disponibles sont : - "ndots", "timeout", - "max-timeouts", "max-inflight" - et "attempts". - - - - - - value - - - - La valeur de l'option. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase/setsearchndots.xml b/reference/event/eventdnsbase/setsearchndots.xml deleted file mode 100644 index 56d8e2ee22..0000000000 --- a/reference/event/eventdnsbase/setsearchndots.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - EventDnsBase::setSearchNdots - Définit le paramètre 'ndots' pour les recherches - - - &reftitle.description; - - public - bool - EventDnsBase::setSearchNdots - - int - ndots - - - - Définit le paramètre 'ndots' pour les recherches. - Définit le nombre de points qui, lorsqu'ils sont trouvés dans un nom, - fait que la première requête se déroule sans recherche de domaine. - - - - &reftitle.parameters; - - - - ndots - - - - Le nombre de points. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventexception.xml b/reference/event/eventexception.xml deleted file mode 100644 index 00e8be736a..0000000000 --- a/reference/event/eventexception.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - La classe EventException - EventException - - -
- &reftitle.intro; - - Une EventException est lancée lorsque les méthodes d'extension d'Event - rencontrent une entrée utilisateur invalide ou identifient une erreur irrécupérable. Cette exception - sert de signal aux développeurs pour gérer les situations exceptionnelles de manière élégante. - -
- -
- &reftitle.classsynopsis; - - - - - EventException - - - - extends - RuntimeException - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - - - -
- - - - diff --git a/reference/event/eventhttp.xml b/reference/event/eventhttp.xml deleted file mode 100644 index cc5ef59d20..0000000000 --- a/reference/event/eventhttp.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - La classe EventHttp - EventHttp - - -
- &reftitle.intro; - - Représente le serveur HTTP. - -
- -
- &reftitle.classsynopsis; - - - - - EventHttp - - - - - final - EventHttp - - - - &Methods; - - - -
- - - &reference.event.entities.eventhttp; - - - diff --git a/reference/event/eventhttp/accept.xml b/reference/event/eventhttp/accept.xml deleted file mode 100644 index edd84c5d87..0000000000 --- a/reference/event/eventhttp/accept.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - EventHttp::accept - Autorise un serveur HTTP à accepter les connexions sur le - socket ou la ressource spécifiée - - - &reftitle.description; - - public - bool - EventHttp::accept - - mixed - socket - - - - Autorise un serveur HTTP à accepter les connexions sur le - socket ou la ressource spécifiée. Le socket doit être prêt à - accepter les connexions. - - - Peut être appelé plusieurs fois pour accepter les connexions sur - différents sockets. - - - - Pour lier un socket, une connexion listen et une connexion - accept sur le socket en un seul appel, utiliser la méthode - EventHttp::bind. - EventHttp::accept n'est nécessaire que si un socket - est prêt à accepter les connexions. - - - - - &reftitle.parameters; - - - - socket - - - - Socket, flux, ou descripteur numérique de fichier représentant un socket - prêt à accepter les connexions. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Exemple avec <function>EventHttp::accept</function> - - "127.0.0.1", - 8092 => "127.0.0.2", -]; -$i = 0; - -$socket = array(); - -foreach ($addresses as $port => $ip) { - echo $ip, " ", $port, PHP_EOL; - $socket[$i] = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - - if (!socket_bind($socket[$i], $ip, $port)) { - exit("échec de socket_bind\n"); - } - - socket_listen($socket[$i], 0); - socket_set_nonblock($socket[$i]); - - if (!$http->accept($socket[$i])) { - echo "L'acceptation a échoué\n"; - exit(1); - } - - ++$i; -} - -$http->setCallback("/some-page", function () { - echo "(some-page)\n"; - echo "URI : ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); - echo "OK\n"; -}); - -$http->setDefaultCallback(function ($req) { - echo "URI : ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); - echo "OK\n"; -}); - -$signal = Event::signal($base, SIGINT, function () use ($base) { - echo "SIGINT reçu. Arrêt...\n"; - $base->stop(); -}); -$signal->add(); - -$base->dispatch(); -echo "END\n"; - -// Nous ne fermons pas les sockets, sachant que Libevent définit -// déjà les drapeaux CLOSE_ON_FREE et CLOSE_ON_EXEC sur le descripteur -// de fichier avec les sockets. -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventHttp::bind - - - - - diff --git a/reference/event/eventhttp/addserveralias.xml b/reference/event/eventhttp/addserveralias.xml deleted file mode 100644 index 271138678c..0000000000 --- a/reference/event/eventhttp/addserveralias.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - - EventHttp::addServerAlias - Ajoute un alias du serveur pour l'objet serveur HTTP - - - &reftitle.description; - - public - bool - EventHttp::addServerAlias - - string - alias - - - - Ajoute un alias du serveur pour l'objet serveur HTTP. - - - - &reftitle.parameters; - - - - alias - - - - L'alias à ajouter. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Exemple avec <function>EventHttp::addServerAlias</function> - -bind("127.0.0.1", 8088)) { - exit("bind(1) a échoué\n"); -}; - -if (!$http->addServerAlias("local.net")) { - exit("Impossible d'ajouter l'alias du serveur\n"); -} - -$http->setCallback("/about", function($req) { - echo "URI : ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); -}); -$base->dispatch(); -?> -]]> - - - - - &reftitle.seealso; - - - EventHttp::removeServerAlias - - - - - diff --git a/reference/event/eventhttp/bind.xml b/reference/event/eventhttp/bind.xml deleted file mode 100644 index 5d6b9aa97f..0000000000 --- a/reference/event/eventhttp/bind.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - - EventHttp::bind - Lie un serveur HTTP sur une adresse et un port spécifiés - - - &reftitle.description; - - public - void - EventHttp::bind - - string - address - - - int - port - - - - Lie un serveur HTTP sur une adresse et un port spécifiés. - - - Peut être appelée plusieurs fois pour lier le même serveur HTTP - sur plusieurs ports. - - - - &reftitle.parameters; - - - - address - - - - Une chaîne de caractères contenant l'adresse IP sur laquelle - listen(2) - écoute. - - - - - - port - - - - Le numéro de port sur lequel l'écoute s'effectuera. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Exemple avec <function>EventHttp::bind</function> - -bind("127.0.0.1", 8088)) { - exit("bind(1) a échoué\n"); -}; -if (!$http->bind("127.0.0.1", 8089)) { - exit("bind(2) a échoué\n"); -}; - -$http->setCallback("/about", function($req) { - echo "URI : ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); - echo "OK\n"; -}); - -$base->dispatch(); -?> -]]> - - &example.outputs.similar; - -404 Not Found

Not Found

The requested URL /unknown was not found on this server.

- -Server: -URI : /about -OK -]]> - - - - - &reftitle.seealso; - - - EventHttp::accept - - - - - diff --git a/reference/event/eventhttp/construct.xml b/reference/event/eventhttp/construct.xml deleted file mode 100644 index 78d48a2e54..0000000000 --- a/reference/event/eventhttp/construct.xml +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - - EventHttp::__construct - Construit un objet EventHttp (le serveur HTTP) - - - &reftitle.description; - - public - EventHttp::__construct - - EventBase - base - - - EventSslContext - ctx - &null; - - - - Construit l'objet serveur HTTP. - - - - - &reftitle.parameters; - - - - base - - - - Événement de base associé. - - - - - - ctx - - - - L'objet de la classe EventSslContext. - Transforme un serveur HTTP en un serveur HTTPS. Cela signifie que si - le paramètre ctx est configuré correctement, - alors le buffer d'événements sous-jacent sera basé sur des sockets OpenSSL. - Aussi, tout le trafic passera via SSL ou TLS. - - - - Ce paramètre n'est disponible que si Event - a été compilé avec le support d'OpenSSL, et seulement à partir de la - version Libevent 2.1.0-alpha ou supérieures. - - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.9.0 - - Ajout du support d'OpenSSL (ctx). - - - - - - - - - &reftitle.examples; - - Serveur HTTP simple - -= $max_requests) { - echo "Le compteur a atteint le maximum de requêtes $max_requests. Sortie\n"; - exit(); - } - - echo __METHOD__, " appelée\n"; - echo "requête :"; var_dump($req); - echo "données :"; var_dump($data); - - echo "\n===== DUMP =====\n"; - echo "Commande :", $req->getCommand(), PHP_EOL; - echo "URI :", $req->getUri(), PHP_EOL; - echo "En-têtes d'entrée :"; var_dump($req->getInputHeaders()); - echo "En-têtes de sortie :"; var_dump($req->getOutputHeaders()); - - echo "\n >> Envoi de la réponse ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; - - echo "\n >> Lecture du buffer d'entrée ...\n"; - $buf = $req->getInputBuffer(); - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - echo "Plus de données dans le buffer\n"; -} - -function _http_about($req) { - echo __METHOD__, PHP_EOL; - echo "URI : ", $req->getUri(), PHP_EOL; - echo "\n >> Envoi de la réponse ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_default($req, $data) { - echo __METHOD__, PHP_EOL; - echo "URI : ", $req->getUri(), PHP_EOL; - echo "\n >> Envoi de la réponse ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -$port = 8010; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Port invalide"); -} - -$base = new EventBase(); -$http = new EventHttp($base); -$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST); - -$http->setCallback("/dump", "_http_dump", array(4, 8)); -$http->setCallback("/about", "_http_about"); -$http->setDefaultCallback("_http_default", "valeur de données personnalisée"); - -$http->bind("0.0.0.0", 8010); -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - diff --git a/reference/event/eventhttp/removeserveralias.xml b/reference/event/eventhttp/removeserveralias.xml deleted file mode 100644 index 0e08e0192a..0000000000 --- a/reference/event/eventhttp/removeserveralias.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - EventHttp::removeServerAlias - Supprime un alias sur le serveur - - - &reftitle.description; - - public - bool - EventHttp::removeServerAlias - - string - alias - - - - Supprime un alias sur le serveur, précédemment ajouté avec la - méthode EventHttp::addServerAlias - - - - &reftitle.parameters; - - - - alias - - - - L'alias à supprimer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventHttp::addServerAlias - - - - - diff --git a/reference/event/eventhttp/setallowedmethods.xml b/reference/event/eventhttp/setallowedmethods.xml deleted file mode 100644 index b90c6f7ae3..0000000000 --- a/reference/event/eventhttp/setallowedmethods.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - EventHttp::setAllowedMethods - Définit les méthodes HTTP supportées et acceptées dans les requêtes - sur ce serveur, et passées aux fonctions de rappel utilisateurs - - - - &reftitle.description; - - public - void - EventHttp::setAllowedMethods - - int - methods - - - - Définit les méthodes HTTP supportées et acceptées dans les requêtes - sur ce serveur, et passées aux fonctions de rappel utilisateurs. - - - Si non supportées, elles généreront une réponse - "405 Method not allowed". - - - Par défaut, les méthodes suivantes sont incluses : - GET, POST, HEAD, - PUT, et DELETE. Voir les constantes - EventHttpRequest::CMD_*. - - - - - &reftitle.parameters; - - - - methods - - - - Un masque de constantes - EventHttpRequest::CMD_*. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/event/eventhttp/setcallback.xml b/reference/event/eventhttp/setcallback.xml deleted file mode 100644 index 31d7c763aa..0000000000 --- a/reference/event/eventhttp/setcallback.xml +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - EventHttp::setCallback - Définit une fonction de rappel pour une URI spécifique - - - &reftitle.description; - - public - void - EventHttp::setCallback - - string - path - - - string - cb - - - string - arg - - - - Définit une fonction de rappel pour une URI spécifique. - - - - &reftitle.parameters; - - - - path - - - - L'URI pour laquelle la fonction de rappel doit être invoquée. - - - - - - cb - - - - La fonction de rappel callable - qui sera invoquée lors d'une demande sur l'URI - path. Elle doit correspondre au prototype - suivant : - - - void - callback - - EventHttpRequest - req - NULL - - - mixed - arg - NULL - - - - - - req - - - - Un objet EventHttpRequest. - - - - - - arg - - - - Données personnalisées. - - - - - - - - - arg - - - - Données personnalisées. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Exemple avec <function>EventHttp::setCallback</function> - -= $max_requests) { - echo "Le compteur a atteint le maximum de requêtes $max_requests. Sortie\n"; - exit(); - } - - echo __METHOD__, " appelée\n"; - echo "requête :"; var_dump($req); - echo "données :"; var_dump($data); - - echo "\n===== DUMP =====\n"; - echo "Commande :", $req->getCommand(), PHP_EOL; - echo "URI :", $req->getUri(), PHP_EOL; - echo "En-têtes d'entrée :"; var_dump($req->getInputHeaders()); - echo "En-têtes de sortie :"; var_dump($req->getOutputHeaders()); - - echo "\n >> Envoi de la réponse ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; - - echo "\n >> Lecture du buffer d'entrée ...\n"; - $buf = $req->getInputBuffer(); - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - echo "Plus de données dans le buffer\n"; -} - -function _http_about($req) { - echo __METHOD__, PHP_EOL; - echo "URI : ", $req->getUri(), PHP_EOL; - echo "\n >> Envoi de la réponse ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_default($req, $data) { - echo __METHOD__, PHP_EOL; - echo "URI : ", $req->getUri(), PHP_EOL; - echo "\n >> Envoi de la réponse ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -$port = 8010; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Port invalide"); -} - -$base = new EventBase(); -$http = new EventHttp($base); -$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST); - -$http->setCallback("/dump", "_http_dump", array(4, 8)); -$http->setCallback("/about", "_http_about"); -$http->setDefaultCallback("_http_default", "valeur de données personnalisée"); - -$http->bind("0.0.0.0", 8010); -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventHttp::setDefaultCallback - - - - - diff --git a/reference/event/eventhttp/setdefaultcallback.xml b/reference/event/eventhttp/setdefaultcallback.xml deleted file mode 100644 index 9123fe8cfe..0000000000 --- a/reference/event/eventhttp/setdefaultcallback.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - EventHttp::setDefaultCallback - Définit la fonction de rappel par défaut pour gérer les requêtes qui ne sont pas attrapées par - des fonctions de rappel spécifiques - - - &reftitle.description; - - public - void - EventHttp::setDefaultCallback - - string - cb - - - string - arg - - - - Définit la fonction de rappel par défaut pour gérer les requêtes qui ne sont pas attrapées par - des fonctions de rappel spécifiques. - - - - &reftitle.parameters; - - - - cb - - - - La fonction de rappel de type callable. - Elle devrait correspondre au prototype suivant : - - - void - callback - - EventHttpRequest - req - NULL - - - mixed - arg - NULL - - - - - - req - - - - EventHttpRequest - Objet. - - - - - - arg - - - - Données personnalisées. - - - - - - - - - arg - - - - Données personnalisées fournies par l'utilisateur à la fonction de rappel. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Exemple avec <function>EventHttp::setDefaultCallback</function> - -bind("127.0.0.1", 8088)) { - exit("Échec de bind(1)\n"); -}; - -$http->setDefaultCallback(function($req) { - echo "URI : ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); -}); - -$base->dispatch(); -?> -]]> - - - - - &reftitle.seealso; - - - EventHttp::setCallback - - - - - diff --git a/reference/event/eventhttp/setmaxbodysize.xml b/reference/event/eventhttp/setmaxbodysize.xml deleted file mode 100644 index 30b9328894..0000000000 --- a/reference/event/eventhttp/setmaxbodysize.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventHttp::setMaxBodySize - Définit la taille maximale du corps de la demande - - - &reftitle.description; - - public - void - EventHttp::setMaxBodySize - - int - value - - - - Définit la taille maximale du corps de la demande. - - - - &reftitle.parameters; - - - - value - - - - La taille du corps, en octets. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttp::setMaxHeadersSize - - - - - diff --git a/reference/event/eventhttp/setmaxheaderssize.xml b/reference/event/eventhttp/setmaxheaderssize.xml deleted file mode 100644 index 98ce337e01..0000000000 --- a/reference/event/eventhttp/setmaxheaderssize.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventHttp::setMaxHeadersSize - Définit la taille maximale des en-têtes HTTP - - - &reftitle.description; - - public - void - EventHttp::setMaxHeadersSize - - int - value - - - - Définit la taille maximale des en-têtes HTTP. - - - - &reftitle.parameters; - - - - value - - - - La taille maximale des en-têtes, en octets. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttp::setMaxHeadersSize - - - - - diff --git a/reference/event/eventhttp/settimeout.xml b/reference/event/eventhttp/settimeout.xml deleted file mode 100644 index 3989e471a3..0000000000 --- a/reference/event/eventhttp/settimeout.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - EventHttp::setTimeout - Définit le délai d'attente maximal pour une requête HTTP - - - &reftitle.description; - - public - void - EventHttp::setTimeout - - int - value - - - - Définit le délai d'attente maximal pour une requête HTTP. - - - - &reftitle.parameters; - - - - value - - - - Le délai d'attente maximal, en secondes. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttpconnection.xml b/reference/event/eventhttpconnection.xml deleted file mode 100644 index 6cfd4367bb..0000000000 --- a/reference/event/eventhttpconnection.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - La classe EventHttpConnection - EventHttpConnection - - -
- &reftitle.intro; - - Représente une connexion HTTP. - -
- -
- &reftitle.classsynopsis; - - - - - EventHttpConnection - - - - - EventHttpConnection - - - - &Methods; - - - -
- - - &reference.event.entities.eventhttpconnection; - - - diff --git a/reference/event/eventhttpconnection/construct.xml b/reference/event/eventhttpconnection/construct.xml deleted file mode 100644 index 92f817e7ef..0000000000 --- a/reference/event/eventhttpconnection/construct.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - EventHttpConnection::__construct - Construit un objet EventHttpConnection - - - &reftitle.description; - - public - EventHttpConnection::__construct - - EventBase - base - - - EventDnsBase - dns_base - - - string - address - - - int - port - - - EventSslContext - ctx - &null; - - - - Construit un objet EventHttpConnection. - - - - &reftitle.parameters; - - - - base - - - - Événement de base associé. - - - - - - dns_base - - - - Si - dns_base - vaut &null;, la résolution du nom d'hôte sera bloquante. - - - - - - address - - - - L'adresse de connexion. - - - - - - port - - - - Le port de connexion. - - - - - - ctx - - - - L'objet de la classe EventSslContext. - Active OpenSSL. - - - - Ce paramètre n'est disponible que si Event - a été compilé avec le support OpenSSL, et uniquement avec la - version Libevent 2.1.0-alpha et supérieures. - - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.9.0 - - Ajout du support d'OpenSSL (ctx). - - - - - - - - - diff --git a/reference/event/eventhttpconnection/getbase.xml b/reference/event/eventhttpconnection/getbase.xml deleted file mode 100644 index 0450e574aa..0000000000 --- a/reference/event/eventhttpconnection/getbase.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - EventHttpConnection::getBase - Retourne l'événement de base associé avec la connexion - - - &reftitle.description; - - public - EventBase - EventHttpConnection::getBase - - - - Retourne l'événement de base associé avec la connexion. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne l'objet EventBase associé avec - la connexion en cas de succès. &false; sinon. - - - - diff --git a/reference/event/eventhttpconnection/getpeer.xml b/reference/event/eventhttpconnection/getpeer.xml deleted file mode 100644 index 7d03cb4485..0000000000 --- a/reference/event/eventhttpconnection/getpeer.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - EventHttpConnection::getPeer - Récupère l'adresse et le port distant associés avec la connexion - - - &reftitle.description; - - public - void - EventHttpConnection::getPeer - - string - address - - - int - port - - - - Récupère l'adresse et le port distant associés avec la connexion. - - - - &reftitle.parameters; - - - - address - - - - Adresse du pair. - - - - - - port - - - - Port du pair. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttpconnection/makerequest.xml b/reference/event/eventhttpconnection/makerequest.xml deleted file mode 100644 index 23f2cd4f16..0000000000 --- a/reference/event/eventhttpconnection/makerequest.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - EventHttpConnection::makeRequest - Effectue une requête HTTP sur la connexion spécifiée - - - &reftitle.description; - - public - bool - EventHttpConnection::makeRequest - - EventHttpRequest - req - - - int - type - - - string - uri - - - - Effectue une requête HTTP sur la connexion spécifiée. - Le paramètre type sera une constante - EventHttpRequest::CMD_*. - - - - &reftitle.parameters; - - - - req - - - - L'objet représentant la connexion sur laquelle la requête sera envoyée. - - - - - - type - - - - Une constante - EventHttpRequest::CMD_*. - - - - - - uri - - - - L'URI associé à la requête. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Exemple avec <function>EventHttpConnection::makeRequest</function> - -getResponseCode(); - - if ($response_code == 0) { - echo "Connexion refusée\n"; - } elseif ($response_code != 200) { - echo "Réponse inattendue : $response_code\n"; - } else { - echo "Succès : $response_code\n"; - $buf = $req->getInputBuffer(); - echo "Corps :\n"; - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - } - } - - $base->exit(NULL); -} - -$address = "127.0.0.1"; -$port = 80; - -$base = new EventBase(); -$conn = new EventHttpConnection($base, NULL, $address, $port); -$conn->setTimeout(5); -$req = new EventHttpRequest("_request_handler", $base); - -$req->addHeader("Host", $address, EventHttpRequest::OUTPUT_HEADER); -$req->addHeader("Content-Length", "0", EventHttpRequest::OUTPUT_HEADER); -$conn->makeRequest($req, EventHttpRequest::CMD_GET, "/index.cphp"); - -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventHttpRequest::addHeader - - - - - diff --git a/reference/event/eventhttpconnection/setclosecallback.xml b/reference/event/eventhttpconnection/setclosecallback.xml deleted file mode 100644 index 2069f72a34..0000000000 --- a/reference/event/eventhttpconnection/setclosecallback.xml +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - - EventHttpConnection::setCloseCallback - Définit une fonction de rappel lors de la fermeture de la connexion - - - &reftitle.description; - - public - void - EventHttpConnection::setCloseCallback - - callable - callback - - - mixed - data - - - - Définit une fonction de rappel lors de la fermeture de la connexion. - - - - &reftitle.parameters; - - - - callback - - - - Fonction de rappel à appeler lors de la fermeture de la connexion. - Devrait correspondre au prototype suivant : - - - void - callback - - EventHttpConnection - conn - &null; - - - mixed - arg - &null; - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - Exemple avec <methodname>EventHttpConnection::setCloseCallback</methodname> - - - * - * 3) Terminez la connexion client brusquement, - * par exemple en tuant le processus, ou en appuyant sur Ctrl-C. - * - * 4) Vérifiez si le serveur a appelé _close_callback. - * Le script devrait afficher la chaîne "_close_callback" sur la sortie standard. - * - * 5) Vérifiez que le processus serveur n'a pas de connexions orphelines, - * par exemple avec l'utilitaire `lsof`. - */ - -function _close_callback($conn) -{ - echo __FUNCTION__, PHP_EOL; -} - -function _http_default($req, $dummy) -{ - $conn = $req->getConnection(); - $conn->setCloseCallback('_close_callback', NULL); - - /* - En activant Event::READ, on protège le serveur contre les connexions non fermées. - C'est une particularité de Libevent. La bibliothèque désactive les événements - Event::READ sur cette connexion, et le serveur n'est pas notifié des connexions - terminées. - - Ainsi, chaque fois qu'un client termine brusquement la connexion, on obtient une - connexion orpheline. Par exemple, voici une partie de la commande - `lsof -p $PID | grep TCP` après que le client a terminé la connexion : - - 57-php 15057 ruslan 6u unix 0xffff8802fb59c780 0t0 125187 socket - 58:php 15057 ruslan 7u IPv4 125189 0t0 TCP *:4242 (LISTEN) - 59:php 15057 ruslan 8u IPv4 124342 0t0 TCP localhost:4242->localhost:37375 (CLOSE_WAIT) - - où $PID est l'identifiant du processus. - - Le bloc de code suivant corrige ce type de connexions orphelines. - */ - $bev = $req->getBufferEvent(); - $bev->enable(Event::READ); - - // Nous devons le libérer explicitement. Voir EventHttpRequest::getConnection - - $bev->free(); // Nous devons le libérer explicitement - - - $req->addHeader( - 'Content-Type', - 'multipart/x-mixed-replace;boundary=boundarydonotcross', - EventHttpRequest::OUTPUT_HEADER - ); - - $buf = new EventBuffer(); - $buf->add(''); - - $req->sendReply(200, "OK"); - $req->sendReplyChunk($buf); -} - -$port = 4242; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Port invalide"); -} - -$base = new EventBase(); -$http = new EventHttp($base); - -$http->setDefaultCallback("_http_default", NULL); -$http->bind("0.0.0.0", $port); -$base->loop(); - -?> -]]> - - - - - diff --git a/reference/event/eventhttpconnection/setlocaladdress.xml b/reference/event/eventhttpconnection/setlocaladdress.xml deleted file mode 100644 index cadbf29f59..0000000000 --- a/reference/event/eventhttpconnection/setlocaladdress.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventHttpConnection::setLocalAddress - Définit l'adresse IP depuis laquelle les connexions HTTP sont effectuées - - - &reftitle.description; - - public - void - EventHttpConnection::setLocalAddress - - string - address - - - - Définit l'adresse IP depuis laquelle les connexions HTTP sont effectuées. - - - - &reftitle.parameters; - - - - address - - - - L'adresse IP depuis laquelle les connexions HTTP sont effectuées. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpConnection::setLocalPort - - - - - diff --git a/reference/event/eventhttpconnection/setlocalport.xml b/reference/event/eventhttpconnection/setlocalport.xml deleted file mode 100644 index 97ff318537..0000000000 --- a/reference/event/eventhttpconnection/setlocalport.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - EventHttpConnection::setLocalPort - Définit le port local depuis lequel les connexions sont effectuées - - - &reftitle.description; - - public - void - EventHttpConnection::setLocalPort - - int - port - - - - Définit le port local depuis lequel les connexions sont effectuées. - - - - &reftitle.parameters; - - - - port - - - - Le numéro du port. - - - - - - - &reftitle.returnvalues; - - - - &reftitle.seealso; - - - EventHttpConnection::setLocalAddress - - - - - diff --git a/reference/event/eventhttpconnection/setmaxbodysize.xml b/reference/event/eventhttpconnection/setmaxbodysize.xml deleted file mode 100644 index 49ca1688d8..0000000000 --- a/reference/event/eventhttpconnection/setmaxbodysize.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventHttpConnection::setMaxBodySize - Définit la taille maximale du corps pour la connexion - - - &reftitle.description; - - public - void - EventHttpConnection::setMaxBodySize - - string - max_size - - - - Définit la taille maximale du corps pour la connexion. - - - - &reftitle.parameters; - - - - max_size - - - - La taille maximale du corps, en octets. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpConnection::setMaxHeadersSize - - - - - diff --git a/reference/event/eventhttpconnection/setmaxheaderssize.xml b/reference/event/eventhttpconnection/setmaxheaderssize.xml deleted file mode 100644 index a24f3da1f3..0000000000 --- a/reference/event/eventhttpconnection/setmaxheaderssize.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventHttpConnection::setMaxHeadersSize - Définit la taille maximale des en-têtes - - - &reftitle.description; - - public - void - EventHttpConnection::setMaxHeadersSize - - string - max_size - - - - Définit la taille maximale des en-têtes pour la connexion. - - - - &reftitle.parameters; - - - - max_size - - - - La taille maximale des en-têtes, en octets. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpConnection::setMaxBodySize - - - - - diff --git a/reference/event/eventhttpconnection/setretries.xml b/reference/event/eventhttpconnection/setretries.xml deleted file mode 100644 index 3459a5788b..0000000000 --- a/reference/event/eventhttpconnection/setretries.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - EventHttpConnection::setRetries - Définit le nombre de tentatives pour la connexion - - - &reftitle.description; - - public - void - EventHttpConnection::setRetries - - int - retries - - - - Définit le nombre de tentatives pour la connexion. - - - - &reftitle.parameters; - - - - retries - - - - Le nombre limite de tentatives. - -1 signifie indéfiniment. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttpconnection/settimeout.xml b/reference/event/eventhttpconnection/settimeout.xml deleted file mode 100644 index a5082012fa..0000000000 --- a/reference/event/eventhttpconnection/settimeout.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - EventHttpConnection::setTimeout - Définit le délai d'attente maximal pour la connexion - - - &reftitle.description; - - public - void - EventHttpConnection::setTimeout - - int - timeout - - - - Définit le délai d'attente maximal pour la connexion. - - - - &reftitle.parameters; - - - - timeout - - - - Le délai d'attente maximal, en secondes. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttprequest.xml b/reference/event/eventhttprequest.xml deleted file mode 100644 index 598422d06b..0000000000 --- a/reference/event/eventhttprequest.xml +++ /dev/null @@ -1,246 +0,0 @@ - - - - - - - La classe EventHttpRequest - EventHttpRequest - - -
- &reftitle.intro; - - Représente une requête HTTP. - -
- -
- &reftitle.classsynopsis; - - - - - EventHttpRequest - - - - - EventHttpRequest - - - - &Constants; - - const - int - EventHttpRequest::CMD_GET - 1 - - - const - int - EventHttpRequest::CMD_POST - 2 - - - const - int - EventHttpRequest::CMD_HEAD - 4 - - - const - int - EventHttpRequest::CMD_PUT - 8 - - - const - int - EventHttpRequest::CMD_DELETE - 16 - - - const - int - EventHttpRequest::CMD_OPTIONS - 32 - - - const - int - EventHttpRequest::CMD_TRACE - 64 - - - const - int - EventHttpRequest::CMD_CONNECT - 128 - - - const - int - EventHttpRequest::CMD_PATCH - 256 - - - const - int - EventHttpRequest::INPUT_HEADER - 1 - - - const - int - EventHttpRequest::OUTPUT_HEADER - 2 - - &Methods; - - - -
- -
- &reftitle.constants; - - - - EventHttpRequest::CMD_GET - - - - méthode GET (commande) - - - - - - EventHttpRequest::CMD_POST - - - - méthode POST (commande) - - - - - - EventHttpRequest::CMD_HEAD - - - - méthode HEAD (commande) - - - - - - EventHttpRequest::CMD_PUT - - - - méthode PUT (commande) - - - - - - EventHttpRequest::CMD_DELETE - - - - commande DELETE (méthode) - - - - - - EventHttpRequest::CMD_OPTIONS - - - - méthode OPTIONS (commande) - - - - - - EventHttpRequest::CMD_TRACE - - - - méthode TRACE (commande) - - - - - - EventHttpRequest::CMD_CONNECT - - - - méthode CONNECT (commande) - - - - - - EventHttpRequest::CMD_PATCH - - - - méthode PATCH (commande) - - - - - - EventHttpRequest::INPUT_HEADER - - - - Type d'en-tête d'entrée de la requête. - - - - - - EventHttpRequest::OUTPUT_HEADER - - - - Type d'en-tête de sortie de la requête. - - - - -
- - - - &reference.event.entities.eventhttprequest; - - - diff --git a/reference/event/eventhttprequest/addheader.xml b/reference/event/eventhttprequest/addheader.xml deleted file mode 100644 index 7822ae49ad..0000000000 --- a/reference/event/eventhttprequest/addheader.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - EventHttpRequest::addHeader - Ajoute un en-tête HTTP aux en-têtes de la requête - - - &reftitle.description; - - public - bool - EventHttpRequest::addHeader - - string - key - - - string - value - - - int - type - - - - Ajoute un en-tête HTTP aux en-têtes de la requête. - - - - &reftitle.parameters; - - - - key - - - - Nom de l'en-tête. - - - - - - value - - - - Valeur de l'en-tête. - - - - - - type - - - - Une des constantes - - EventHttpRequest::*_HEADER. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventHttpRequest::removeHeader - - - - - - diff --git a/reference/event/eventhttprequest/cancel.xml b/reference/event/eventhttprequest/cancel.xml deleted file mode 100644 index f8cfa3e5ec..0000000000 --- a/reference/event/eventhttprequest/cancel.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - EventHttpRequest::cancel - Annule une requête HTTP en attente - - - &reftitle.description; - - public - void - EventHttpRequest::cancel - - - - Annule une requête HTTP en attente. - - - Annule une requête HTTP en cours. La fonction de rappel associée avec - cette requête ne sera pas exécutée, et l'objet de la requête, libéré. - Si la requête est en cours de traitement, l'objet EventHttpConnection - correspondant sera ré-initialisé. - - - Une requête ne peut être annulée si sa fonction de rappel a déjà été exécutée. - Une requête peut être annulée de manière réentrante depuis sa fonction de rappel chunked. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttprequest/clearheaders.xml b/reference/event/eventhttprequest/clearheaders.xml deleted file mode 100644 index 1e84c0bebb..0000000000 --- a/reference/event/eventhttprequest/clearheaders.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - EventHttpRequest::clearHeaders - Supprime tous les en-têtes de sortie depuis la liste des en-têtes de la requête - - - &reftitle.description; - - public - void - EventHttpRequest::clearHeaders - - - - Supprime tous les en-têtes de sortie depuis la liste des en-têtes de la requête. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::addHeader - - - - - - diff --git a/reference/event/eventhttprequest/closeconnection.xml b/reference/event/eventhttprequest/closeconnection.xml deleted file mode 100644 index d4fe3e592a..0000000000 --- a/reference/event/eventhttprequest/closeconnection.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - EventHttpRequest::closeConnection - Ferme les connexions HTTP associées - - - &reftitle.description; - - public - void - EventHttpRequest::closeConnection - - - - Ferme les connexions HTTP associées avec la requête. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/event/eventhttprequest/construct.xml b/reference/event/eventhttprequest/construct.xml deleted file mode 100644 index 7eb830865d..0000000000 --- a/reference/event/eventhttprequest/construct.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - - EventHttpRequest::__construct - Construit un objet EventHttpRequest - - - &reftitle.description; - - public - EventHttpRequest::__construct - - callable - callback - - - mixed - data - &null; - - - - Construit un objet EventHttpRequest. - - - - - &reftitle.parameters; - - - - callback - - - - Fonction de rappel appelée avec le chemin demandé. - Devrait correspondre au prototype suivant : - - - void - callback - - EventHttpRequest - req - &null; - - - mixed - arg - &null; - - - - - - - data - - - - Données utilisateur personnalisées à passer à - la fonction de rappel. - - - - - - - &reftitle.examples; - - - Exemple avec <function>EventHttpRequest::__construct</function> - -getResponseCode(); - - if ($response_code == 0) { - echo "Connexion refusée\n"; - } elseif ($response_code != 200) { - echo "Réponse inattendue : $response_code\n"; - } else { - echo "Succès : $response_code\n"; - $buf = $req->getInputBuffer(); - echo "Corps :\n"; - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - } - } - - $base->exit(NULL); -} - - -$address = "127.0.0.1"; -$port = 80; - -$base = new EventBase(); -$conn = new EventHttpConnection($base, NULL, $address, $port); -$conn->setTimeout(5); -$req = new EventHttpRequest("_request_handler", $base); - -$req->addHeader("Host", $address, EventHttpRequest::OUTPUT_HEADER); -$req->addHeader("Content-Length", "0", EventHttpRequest::OUTPUT_HEADER); -$conn->makeRequest($req, EventHttpRequest::CMD_GET, "/index.cphp"); - -$base->loop(); -?> -]]> - - - - - &reftitle.seealso; - - - EventHttpRequest::cancel - - - EventHttpRequest::addHeader - - - - - diff --git a/reference/event/eventhttprequest/findheader.xml b/reference/event/eventhttprequest/findheader.xml deleted file mode 100644 index 8833c36b3c..0000000000 --- a/reference/event/eventhttprequest/findheader.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - EventHttpRequest::findHeader - Cherche la valeur d'un en-tête - - - &reftitle.description; - - public - void - EventHttpRequest::findHeader - - string - key - - - string - type - - - - Cherche la valeur d'un en-tête. - - - - &reftitle.parameters; - - - - key - - - - Le nom de l'en-tête. - - - - - - type - - - - Une des constantes - - EventHttpRequest::*_HEADER. - - - - - - - &reftitle.returnvalues; - - Retourne &null; si l'en-tête n'a pas été trouvé. - - - - &reftitle.seealso; - - - EventHttpRequest::addHeader - - - - - - diff --git a/reference/event/eventhttprequest/free.xml b/reference/event/eventhttprequest/free.xml deleted file mode 100644 index c4a2e48953..0000000000 --- a/reference/event/eventhttprequest/free.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - EventHttpRequest::free - Libère l'objet et supprime les événements associés - - - &reftitle.description; - - public - void - EventHttpRequest::free - - - - Libère l'objet et supprime les événements associés. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/event/eventhttprequest/getbufferevent.xml b/reference/event/eventhttprequest/getbufferevent.xml deleted file mode 100644 index 428cf9ecd0..0000000000 --- a/reference/event/eventhttprequest/getbufferevent.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - EventHttpRequest::getBufferEvent - Retourne l'objet EventBufferEvent - - - &reftitle.description; - - public - EventBufferEvent - EventHttpRequest::getBufferEvent - - - - Retourne l'objet EventBufferEvent - qui représente l'événement de buffer que la connexion utilise. - - - - Le compteur de référence de l'objet retourné sera incrémenté d'un pour - protéger les structures internes contre des destructions prématurées quand - la méthode est appelée depuis une fonction de rappel. L'objet - EventBufferEvent devrait donc être libéré explicitement - via la méthode EventBufferEvent::free. - Sinon il y aura une fuite de mémoire. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un objet EventBufferEvent. - - - - &reftitle.seealso; - - - EventHttpRequest::getConnection - - - - - diff --git a/reference/event/eventhttprequest/getcommand.xml b/reference/event/eventhttprequest/getcommand.xml deleted file mode 100644 index e3671601a7..0000000000 --- a/reference/event/eventhttprequest/getcommand.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - EventHttpRequest::getCommand - Retourne la commande de la requête (méthode) - - - &reftitle.description; - - public - void - EventHttpRequest::getCommand - - - - Retourne la commande de la requête ; une des constantes - - EventHttpRequest::CMD_* - . - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne la commande de la requête ; une des constantes - - EventHttpRequest::CMD_* - . - - - - - diff --git a/reference/event/eventhttprequest/getconnection.xml b/reference/event/eventhttprequest/getconnection.xml deleted file mode 100644 index 1bf7a53a74..0000000000 --- a/reference/event/eventhttprequest/getconnection.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - EventHttpRequest::getConnection - Retourne un objet EventHttpConnection - - - &reftitle.description; - - public - EventHttpConnection - EventHttpRequest::closeConnection - - - - Retourne un objet EventHttpConnection - qui représente une connexion HTTP associée à la requête. - - - - L'API Libevent autorise les objets de requête HTTP à ne pas - être liés à une connexion HTTP. Toutefois, nous ne pouvons pas - dissocier EventHttpRequest de - EventHttpConnection. Aussi, nous construisons - l'objet EventHttpConnection à la volée. - Vu que nous n'avons aucune information sur l'événement de base, - la base DNS, ni sur la fonction de rappel associée à la fermeture - de la connexion, nous positionnons ces champs indéfinis. - - - - La méthode EventHttpRequest::getConnection - est habituellement utile lorsque nous devons définir une fonction - de rappel à associer à la fermeture de la connexion. Voir la méthode - EventHttpConnection::setCloseCallback. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne un objet EventHttpConnection. - - - - &reftitle.seealso; - - EventHttpConnection::setCloseCallback - EventHttpRequest::getBufferEvent - - - - - diff --git a/reference/event/eventhttprequest/gethost.xml b/reference/event/eventhttprequest/gethost.xml deleted file mode 100644 index 01f5b4d894..0000000000 --- a/reference/event/eventhttprequest/gethost.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - EventHttpRequest::getHost - Retourne l'hôte demandé - - - &reftitle.description; - - public - string - EventHttpRequest::getHost - - - - Retourne l'hôte demandé. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne l'hôte demandé. - - - - &reftitle.seealso; - - - EventHttpRequest::getUri - - - EventHttpRequest::getCommand - - - - - - diff --git a/reference/event/eventhttprequest/getinputbuffer.xml b/reference/event/eventhttprequest/getinputbuffer.xml deleted file mode 100644 index 4170b5d415..0000000000 --- a/reference/event/eventhttprequest/getinputbuffer.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventHttpRequest::getInputBuffer - Retourne le buffer d'entrée - - - &reftitle.description; - - public - EventBuffer - EventHttpRequest::getInputBuffer - - - - Retourne le buffer d'entrée. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne le buffer d'entrée. - - - - &reftitle.seealso; - - - EventHttpRequest::getOutputBuffer - - - - - diff --git a/reference/event/eventhttprequest/getinputheaders.xml b/reference/event/eventhttprequest/getinputheaders.xml deleted file mode 100644 index 7579915475..0000000000 --- a/reference/event/eventhttprequest/getinputheaders.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventHttpRequest::getInputHeaders - Retourne le tableau associatif contenant les en-têtes d'entrée - - - &reftitle.description; - - public - array - EventHttpRequest::getInputHeaders - - - - Retourne le tableau associatif contenant les en-têtes d'entrée. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne le tableau associatif contenant les en-têtes d'entrée. - - - - &reftitle.seealso; - - - EventHttpRequest::getOutputHeaders - - - - - diff --git a/reference/event/eventhttprequest/getoutputbuffer.xml b/reference/event/eventhttprequest/getoutputbuffer.xml deleted file mode 100644 index 41a35df9c2..0000000000 --- a/reference/event/eventhttprequest/getoutputbuffer.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventHttpRequest::getOutputBuffer - Retourne le buffer de sortie de la requête - - - &reftitle.description; - - public - EventBuffer - EventHttpRequest::getOutputBuffer - - - - Retourne le buffer de sortie de la requête. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne le buffer de sortie de la requête. - - - - &reftitle.seealso; - - - EventHttpRequest::getInputBuffer - - - - - diff --git a/reference/event/eventhttprequest/getoutputheaders.xml b/reference/event/eventhttprequest/getoutputheaders.xml deleted file mode 100644 index 0868620204..0000000000 --- a/reference/event/eventhttprequest/getoutputheaders.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - EventHttpRequest::getOutputHeaders - Retourne un tableau associatif contenant les en-têtes de sortie - - - &reftitle.description; - - public - void - EventHttpRequest::getOutputHeaders - - - - Retourne un tableau associatif contenant les en-têtes de sortie. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - - - &reftitle.seealso; - - - EventHttpRequest::getInputHeaders - - - - - diff --git a/reference/event/eventhttprequest/getresponsecode.xml b/reference/event/eventhttprequest/getresponsecode.xml deleted file mode 100644 index 43199ae503..0000000000 --- a/reference/event/eventhttprequest/getresponsecode.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - EventHttpRequest::getResponseCode - Retourne le code de la réponse - - - &reftitle.description; - - public - int - EventHttpRequest::getResponseCode - - - - Retourne le code de la réponse. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne le code de la réponse de la requête. - - - - &reftitle.seealso; - - - EventHttpRequest::getCommand - - - EventHttpRequest::getHost - - - EventHttpRequest::getUri - - - - - diff --git a/reference/event/eventhttprequest/geturi.xml b/reference/event/eventhttprequest/geturi.xml deleted file mode 100644 index f3031e1f4d..0000000000 --- a/reference/event/eventhttprequest/geturi.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - EventHttpRequest::getUri - Retourne l'URI de la requête - - - &reftitle.description; - - public - string - EventHttpRequest::getUri - - - - Retourne l'URI de la requête. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne l'URI de la requête. - - - - &reftitle.seealso; - - - EventHttpRequest::getCommand - - - EventHttpRequest::getHost - - - EventHttpRequest::getResponseCode - - - - - diff --git a/reference/event/eventhttprequest/removeheader.xml b/reference/event/eventhttprequest/removeheader.xml deleted file mode 100644 index 11e2e76006..0000000000 --- a/reference/event/eventhttprequest/removeheader.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - EventHttpRequest::removeHeader - Supprime un en-tête HTTP depuis les en-têtes de la requête - - - &reftitle.description; - - public - void - EventHttpRequest::removeHeader - - string - key - - - string - type - - - - Supprime un en-tête HTTP depuis les en-têtes de la requête. - - - - &reftitle.parameters; - - - - key - - - - Le nom de l'en-tête. - - - - - - type - - - - Une constante EventHttpRequest::*_HEADER. - - - - - - - &reftitle.returnvalues; - - Supprime un en-tête HTTP depuis les en-têtes de la requête. - - - - &reftitle.seealso; - - - EventHttpRequest::addHeader - - - - - diff --git a/reference/event/eventhttprequest/senderror.xml b/reference/event/eventhttprequest/senderror.xml deleted file mode 100644 index 45abb831d1..0000000000 --- a/reference/event/eventhttprequest/senderror.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - EventHttpRequest::sendError - Envoie un message d'erreur HTML au client - - - &reftitle.description; - - public - void - EventHttpRequest::sendError - - int - error - - - string - reason - &null; - - - - Envoie un message d'erreur HTML au client. - - - - &reftitle.parameters; - - - - error - - - - Le code erreur HTTP. - - - - - - reason - - - - Une brève explication de l'erreur. Si vaut &null;, la signification standard - du code erreur sera utilisée. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - Exemple avec <function>EventHttpRequest::sendError</function> - -sendError(400); -} - -$base = new EventBase(); -$http = new EventHttp($base); - -$http->setCallback("/err400", "_http_400"); - -$http->bind("0.0.0.0", 8010); -$base->loop(); -?> -]]> - - - - - &reftitle.seealso; - - - EventHttpRequest::sendReply - - - - - - diff --git a/reference/event/eventhttprequest/sendreply.xml b/reference/event/eventhttprequest/sendreply.xml deleted file mode 100644 index a4df3a1894..0000000000 --- a/reference/event/eventhttprequest/sendreply.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - EventHttpRequest::sendReply - Envoie une réponse HTML au client - - - &reftitle.description; - - public - void - EventHttpRequest::sendReply - - int - code - - - string - reason - - - EventBuffer - buf - - - - Envoie une réponse HTML au client. Le corps de la réponse contient - les données du paramètre optionnel buf. - - - - &reftitle.parameters; - - - - code - - - - Le code réponse HTTP à envoyer. - - - - - - reason - - - - Un bref message à envoyer avec le code réponse. - - - - - - buf - - - - Le corps de la réponse. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::sendError - - - EventHttpRequest::sendReplyChunk - - - - - diff --git a/reference/event/eventhttprequest/sendreplychunk.xml b/reference/event/eventhttprequest/sendreplychunk.xml deleted file mode 100644 index 30e3d91729..0000000000 --- a/reference/event/eventhttprequest/sendreplychunk.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - EventHttpRequest::sendReplyChunk - Envoie un autre bloc de données comme partie d'une réponse fragmentée en cours - - - &reftitle.description; - - public - void - EventHttpRequest::sendReplyChunk - - EventBuffer - buf - - - - Envoie un autre bloc de données comme partie d'une réponse fragmentée en cours. - Après l'appel de cette méthode, le paramètre buf - sera vide. - - - - &reftitle.parameters; - - - - buf - - - - Le bloc de données à envoyer comme partie de la réponse. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::sendReplyStart - - - EventHttpRequest::sendReplyEnd - - - - - diff --git a/reference/event/eventhttprequest/sendreplyend.xml b/reference/event/eventhttprequest/sendreplyend.xml deleted file mode 100644 index aa747d436f..0000000000 --- a/reference/event/eventhttprequest/sendreplyend.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - EventHttpRequest::sendReplyEnd - Complète une réponse fragmentée, en libérant la requête le cas échéant - - - &reftitle.description; - - public - void - EventHttpRequest::sendReplyEnd - - - - Complète une réponse fragmentée, en libérant la requête le cas échéant. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::sendReplyStart - - - EventHttpRequest::sendReplyChunk - - - - - diff --git a/reference/event/eventhttprequest/sendreplystart.xml b/reference/event/eventhttprequest/sendreplystart.xml deleted file mode 100644 index 1b833af96a..0000000000 --- a/reference/event/eventhttprequest/sendreplystart.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - EventHttpRequest::sendReplyStart - Initialise une réponse fragmentée - - - &reftitle.description; - - public - void - EventHttpRequest::sendReplyStart - - int - code - - - string - reason - - - - Initialise une réponse qui utilise les en-têtes - Transfer-Encoding - chunked. - - - Ceci permet à l'appelant de diffuser la réponse au client, et est utile - lorsque toutes les données de la réponse ne sont pas immédiatement - disponibles, ou bien lors d'envoi de réponses trop volumineuses. - - - L'appelant doit fournir les blocs de données avec la méthode - EventHttpRequest::sendReplyChunk et compléter - la réponse en appelant la méthode - EventHttpRequest::sendReplyEnd. - - - - &reftitle.parameters; - - - - code - - - - Le code réponse HTTP à envoyer. - - - - - - reason - - - - Un bref message à envoyer avec le code réponse. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::sendReplyChunk - - - EventHttpRequest::sendReplyEnd - - - - - diff --git a/reference/event/eventlistener.xml b/reference/event/eventlistener.xml deleted file mode 100644 index a4589326d0..0000000000 --- a/reference/event/eventlistener.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - - La classe EventListener - EventListener - - -
- &reftitle.intro; - - Représente une écoute de connexion. - -
- -
- &reftitle.classsynopsis; - - - - - EventListener - - - - - final - EventListener - - - - &Constants; - - const - int - EventListener::OPT_LEAVE_SOCKETS_BLOCKING - 1 - - - const - int - EventListener::OPT_CLOSE_ON_FREE - 2 - - - const - int - EventListener::OPT_CLOSE_ON_EXEC - 4 - - - const - int - EventListener::OPT_REUSEABLE - 8 - - - const - int - EventListener::OPT_THREADSAFE - 16 - - &Properties; - - public - readonly - int - fd - - &Methods; - - - -
-
- &reftitle.properties; - - - - fd - - - - Descripteur de fichier numérique du socket sous-jacent - (Ajout en event-1.6.0). - - - - -
- -
- &reftitle.constants; - - - - EventListener::OPT_LEAVE_SOCKETS_BLOCKING - - - - Par défaut, Libevent passe en mode non bloquant les descripteurs - de fichiers ou sockets sous-jacents. Ce drapeau indique à Libevent de les laisser en mode bloquant. - - - - - - EventListener::OPT_CLOSE_ON_FREE - - - - Si cette option est définie, l'écoute de la connexion ferme son - socket sous-jacent lorsque l'objet EventListener - est libéré. - - - - - - EventListener::OPT_CLOSE_ON_EXEC - - - - Si cette option est définie, l'écoute de la connexion définit - le drapeau de fermeture à l'exécution sur le socket d'écoute - sous-jacent. Voir la documentation de la plateforme - pour plus d'informations sur fcntl et - FD_CLOEXEC. - - - - - - EventListener::OPT_REUSEABLE - - - - Par défaut sur quelques plateformes, une fois qu'un socket d'écoute - est fermé, aucun autre socket ne peut être lié sur le même port - tant qu'un certain temps ne s'est pas écoulé. Le fait de définir - cette option fait que Libevent va marquer ce socket comme réutilisable, - aussi, une fois clos, un autre socket peut être ouvert pour écouter - le même port. - - - - - - EventListener::OPT_THREADSAFE - - - - Verrouillage de l'allocation pour l'écouteur ; ainsi, il est - sécurisé de l'utiliser depuis plusieurs threads. - - - - -
- - - - &reference.event.entities.eventlistener; - - - diff --git a/reference/event/eventlistener/construct.xml b/reference/event/eventlistener/construct.xml deleted file mode 100644 index c40c5cb1f9..0000000000 --- a/reference/event/eventlistener/construct.xml +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - EventListener::__construct - Crée un nouvel écouteur de connexion associé avec l'événement de base - - - &reftitle.description; - - public - EventListener::__construct - - EventBase - base - - - callable - cb - - - mixed - data - - - int - flags - - - int - backlog - - - mixed - target - - - - Crée un nouvel écouteur de connexion associé avec l'événement de base. - - - - &reftitle.parameters; - - - - base - - - - Événement de base associé. - - - - - - cb - - - - Un callable qui sera invoqué lorsqu'une - nouvelle connexion sera reçue. - - - - - - data - - - - Données utilisateur personnalisées attachées au paramètre - cb. - - - - - - flags - - - - Un masque de constantes - EventListener::OPT_*. Voir les - constantes EventListener. - - - - - - backlog - - - - Contrôle le nombre maximal de connexions en attente que la pile réseau - devrait autoriser à patienter dans un statut "non encore accepté" ; voir la documentation - de la fonction listen du système pour plus - de détails. Si le paramètre backlog est négatif, - Libevent tente de récupérer une bonne valeur pour ce paramètre ; - s'il vaut zéro, Event présume que la fonction système listen - a déjà été appelée sur le socket (target). - - - - - - target - - - - Peut être une chaîne de caractères, une ressource de socket, ou un - flux associé avec un socket. Dans le cas où ce paramètre est une - chaîne de caractères, elle sera analysée comme adresse IP. - Elle sera analysée comme socket de domaine UNIX si elle est préfixée - par 'unix:', par exemple, 'unix:/tmp/my.sock'. - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.5.0 - - Le support des sockets de domaine UNIX a été ajouté. - - - - - - - - &reftitle.examples; - - - Exemple avec <function>EventListener::__construct</function> - -bev->free(); - } - - public function __construct($base, $fd) { - $this->base = $base; - - $this->bev = new EventBufferEvent($base, $fd, EventBufferEvent::OPT_CLOSE_ON_FREE); - - $this->bev->setCallbacks(array($this, "echoReadCallback"), NULL, - array($this, "echoEventCallback"), NULL); - - if (!$this->bev->enable(Event::READ)) { - echo "Impossible d'activer READ\n"; - return; - } - } - - public function echoReadCallback($bev, $ctx) { - // Copie toutes les données depuis le buffer d'entrée vers le buffer de sortie - - // Variant #1 - $bev->output->addBuffer($bev->input); - - /* Variant #2 */ - /* - $input = $bev->getInput(); - $output = $bev->getOutput(); - $output->addBuffer($input); - */ - } - - public function echoEventCallback($bev, $events, $ctx) { - if ($events & EventBufferEvent::ERROR) { - echo "Erreur depuis bufferevent\n"; - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - //$bev->free(); - $this->__destruct(); - } - } -} - -class MyListener { - public $base, - $listener, - $socket; - private $conn = array(); - - public function __destruct() { - foreach ($this->conn as &$c) $c = NULL; - } - - public function __construct($port) { - $this->base = new EventBase(); - if (!$this->base) { - echo "Impossible d'ouvrir la base de l'événement"; - exit(1); - } - - // Variant #1 - /* - $this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - if (!socket_bind($this->socket, '0.0.0.0', $port)) { - echo "Impossible de lier le socket\n"; - exit(1); - } - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, - -1, $this->socket); - */ - - // Variant #2 - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, -1, - "0.0.0.0:$port"); - - if (!$this->listener) { - echo "Couldn't create listener"; - exit(1); - } - - $this->listener->setErrorCallback(array($this, "accept_error_cb")); - } - - public function dispatch() { - $this->base->dispatch(); - } - - // Cette fonction de rappel est appelée lorsqu'il y a des données à lire depuis $bev - public function acceptConnCallback($listener, $fd, $address, $ctx) { - // Nous avons une nouvelle connexion ! On lui définit un bufferevent. */ - $base = $this->base; - $this->conn[] = new MyListenerConnection($base, $fd); - } - - public function accept_error_cb($listener, $ctx) { - $base = $this->base; - - fprintf(STDERR, "Erreur reçue %d (%s) sur l'écouteur. " - ."Shutting down.\n", - EventUtil::getLastSocketErrno(), - EventUtil::getLastSocketError()); - - $base->exit(NULL); - } -} - -$port = 9808; - -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Port invalide"); -} - -$l = new MyListener($port); -$l->dispatch(); -?> -]]> - - - - - diff --git a/reference/event/eventlistener/disable.xml b/reference/event/eventlistener/disable.xml deleted file mode 100644 index 7cd1dfd2c4..0000000000 --- a/reference/event/eventlistener/disable.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventListener::disable - Désactive un objet d'écoute d'événement de connexion - - - &reftitle.description; - - public - bool - EventListener::disable - - - - Désactive un objet d'écoute d'événement de connexion. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventListener::enable - - - - - diff --git a/reference/event/eventlistener/enable.xml b/reference/event/eventlistener/enable.xml deleted file mode 100644 index 0364956d05..0000000000 --- a/reference/event/eventlistener/enable.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventListener::enable - Active un objet d'écoute d'événement de connexion - - - &reftitle.description; - - public - bool - EventListener::enable - - - - Active un objet d'écoute d'événement de connexion. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventListener::disable - - - - - diff --git a/reference/event/eventlistener/getbase.xml b/reference/event/eventlistener/getbase.xml deleted file mode 100644 index 4c6cfe063f..0000000000 --- a/reference/event/eventlistener/getbase.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - EventListener::getBase - Retourne l'événement de base associé avec l'écouteur d'événements - - - &reftitle.description; - - public - void - EventListener::getBase - - - - Retourne l'événement de base associé avec l'écouteur d'événements. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retourne l'événement de base associé avec l'écouteur d'événements. - - - - diff --git a/reference/event/eventlistener/getsocketname.xml b/reference/event/eventlistener/getsocketname.xml deleted file mode 100644 index 5be926b640..0000000000 --- a/reference/event/eventlistener/getsocketname.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - EventListener::getSocketName - Récupère l'adresse courante pour laquelle le socket d'écoute est lié - - - &reftitle.description; - - public - static - bool - EventListener::getSocketName - - string - address - - - mixed - port - - - - Récupère l'adresse courante pour laquelle le socket d'écoute est lié. - - - - &reftitle.parameters; - - - - address - - - - Paramètre de sortie. L'adresse IP suivant la famille d'adresse du socket. - - - - - - port - - - - Paramètre de sortie. Le port sur lequel le socket est lié. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventlistener/setcallback.xml b/reference/event/eventlistener/setcallback.xml deleted file mode 100644 index c075808ec8..0000000000 --- a/reference/event/eventlistener/setcallback.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - EventListener::setCallback - Le but de setCallback - - - &reftitle.description; - - public - void - EventListener::setCallback - - callable - cb - - - mixed - arg - &null; - - - - Place une fonction de rappel pour l'événement de connexion, et, optionnellement, - des arguments pour cette fonction de rappel. - - - - &reftitle.parameters; - - - - cb - - - - La nouvelle fonction de rappel pour les nouvelles connexions. - Ignoré si vaut &null;. - - - Devrait correspondre au prototype suivant : - - - void - callback - - EventListener - listener - &null; - - - mixed - fd - &null; - - - array - address - &null; - - - mixed - arg - &null; - - - - - - listener - - - - L'objet EventListener. - - - - - - fd - - - - Le descripteur de fichier ou une ressource associée à l'écoute. - - - - - - address - - - - Tableau de deux éléments : l'adresse IP et le port - du serveur. - - - - - - arg - - - - Données utilisateur personnalisées attachées à la fonction - de rappel. - - - - - - - - - arg - - - - Données utilisateur personnalisées attachées à la fonction - de rappel. Ignoré si vaut &null;. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventlistener/seterrorcallback.xml b/reference/event/eventlistener/seterrorcallback.xml deleted file mode 100644 index 08f170e479..0000000000 --- a/reference/event/eventlistener/seterrorcallback.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - EventListener::setErrorCallback - Définit la fonction de rappel sur l'évènement d'erreur - - - &reftitle.description; - - public - void - EventListener::setErrorCallback - - string - cb - - - - Définit la fonction de rappel sur l'évènement d'erreur. - - - - &reftitle.parameters; - - - - cb - - - - La fonction de rappel pour l'erreur. Devrait correspondre au prototype suivant : - - - void - callback - - EventListener - listener - &null; - - - mixed - data - &null; - - - - - - listener - - - - L'objet EventListener. - - - - - - data - - - - Données personnalisées de l'utilisateur à associer à la fonction - de rappel. - - - - - - - - - - &reftitle.returnvalues; - - - - &reftitle.seealso; - - - EventListener::setCallback - - - - - diff --git a/reference/event/eventsslcontext.xml b/reference/event/eventsslcontext.xml deleted file mode 100644 index afc18108ad..0000000000 --- a/reference/event/eventsslcontext.xml +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - La classe EventSslContext - EventSslContext - - -
- &reftitle.intro; - - Représente la structure SSL_CTX. - Fournit des méthodes et des propriétés pour configurer le contexte SSL. - -
- -
- &reftitle.classsynopsis; - - - - - EventSslContext - - - - - final - EventSslContext - - - - &Constants; - - const - int - EventSslContext::SSLv2_CLIENT_METHOD - 1 - - - const - int - EventSslContext::SSLv3_CLIENT_METHOD - 2 - - - const - int - EventSslContext::SSLv23_CLIENT_METHOD - 3 - - - const - int - EventSslContext::TLS_CLIENT_METHOD - 4 - - - const - int - EventSslContext::SSLv2_SERVER_METHOD - 5 - - - const - int - EventSslContext::SSLv3_SERVER_METHOD - 6 - - - const - int - EventSslContext::SSLv23_SERVER_METHOD - 7 - - - const - int - EventSslContext::TLS_SERVER_METHOD - 8 - - - const - int - EventSslContext::OPT_LOCAL_CERT - 1 - - - const - int - EventSslContext::OPT_LOCAL_PK - 2 - - - const - int - EventSslContext::OPT_PASSPHRASE - 3 - - - const - int - EventSslContext::OPT_CA_FILE - 4 - - - const - int - EventSslContext::OPT_CA_PATH - 5 - - - const - int - EventSslContext::OPT_ALLOW_SELF_SIGNED - 6 - - - const - int - EventSslContext::OPT_VERIFY_PEER - 7 - - - const - int - EventSslContext::OPT_VERIFY_DEPTH - 8 - - - const - int - EventSslContext::OPT_CIPHERS - 9 - - &Properties; - - public - string - local_cert - - - public - string - local_pk - - &Methods; - - - -
- -
- &reftitle.properties; - - - - local_cert - - - - Chemin vers le fichier contenant le certificat sur le système de fichiers. - Ce doit être un fichier encodé PEM qui contient les certificats. - Il peut, optionnellement, contenir la chaîne du certificat - de l'émetteur. - - - - - - local_pk - - - - Chemin vers le fichier contenant la clé privée locale. - - - - -
- - -
- &reftitle.constants; - - - - EventSslContext::SSLv2_CLIENT_METHOD - - - - Méthode cliente SSLv2. Voir la page du manuel sur - SSL_CTX_new(3). - - - - - - EventSslContext::SSLv3_CLIENT_METHOD - - - - Méthode cliente SSLv3. Voir la page du manuel sur - SSL_CTX_new(3). - - - - - - EventSslContext::SSLv23_CLIENT_METHOD - - - - Méthode cliente SSLv23. Voir la page du manuel sur - SSL_CTX_new(3). - - - - - - EventSslContext::TLS_CLIENT_METHOD - - - - Méthode cliente TLS. Voir la page du manuel sur - SSL_CTX_new(3). - - - - - - EventSslContext::SSLv2_SERVER_METHOD - - - - Méthode serveur SSLv2. Voir la page du manuel sur - SSL_CTX_new(3). - - - - - - EventSslContext::SSLv3_SERVER_METHOD - - - - Méthode serveur SSLv3. Voir la page du manuel sur - SSL_CTX_new(3). - - - - - - EventSslContext::SSLv23_SERVER_METHOD - - - - Méthode serveur SSLv23. Voir la page du manuel sur - SSL_CTX_new(3). - - - - - - EventSslContext::TLS_SERVER_METHOD - - - - Méthode serveur TLS. Voir la page du manuel sur - SSL_CTX_new(3). - - - - - - EventSslContext::OPT_LOCAL_CERT - - - - Clé pour un élément du tableau contenant les options, utilisé - dans la méthode EventSslContext::__construct. - Les options pointent vers le chemin du certificat local. - - - - - - EventSslContext::OPT_LOCAL_PK - - - - Clé pour un élément du tableau contenant les options, utilisé - dans la méthode EventSslContext::__construct. - Les options pointent vers le chemin de la clé privée. - - - - - - EventSslContext::OPT_PASSPHRASE - - - - Clé pour un élément du tableau contenant les options, utilisé - dans la méthode EventSslContext::__construct. - Représente la passphrase du certificat. - - - - - - EventSslContext::OPT_CA_FILE - - - - Clé pour un élément du tableau contenant les options, utilisé - dans la méthode EventSslContext::__construct. - Représente le chemin vers le fichier de l'autorité du certificat. - - - - - - EventSslContext::OPT_CA_PATH - - - - Clé pour un élément du tableau contenant les options, utilisé - dans la méthode EventSslContext::__construct. - Représente le chemin dans lequel devrait être cherché le fichier - de l'autorité du certificat. - - - - - - EventSslContext::OPT_ALLOW_SELF_SIGNED - - - - Clé pour un élément du tableau contenant les options, utilisé - dans la méthode EventSslContext::__construct. - Représente une option qui autorise les certificats autosignés. - - - - - - EventSslContext::OPT_VERIFY_PEER - - - - Clé pour un élément du tableau contenant les options, utilisé - dans la méthode EventSslContext::__construct. - Représente une option qui indique à Event de vérifier les pairs. - - - - - - EventSslContext::OPT_VERIFY_DEPTH - - - - Clé pour un élément du tableau contenant les options, utilisé - dans la méthode EventSslContext::__construct. - Représente la profondeur maximale de la vérification de la chaîne - du certificat qui doit être autorisée pour le contexte SSL. - - - - - - EventSslContext::OPT_CIPHERS - - - - Clé pour un élément du tableau contenant les options, utilisé - dans la méthode EventSslContext::__construct. - Représente la liste cipher pour le contexte SSL. - - - - -
- - - - &reference.event.entities.eventsslcontext; - - - diff --git a/reference/event/eventsslcontext/construct.xml b/reference/event/eventsslcontext/construct.xml deleted file mode 100644 index 047b2278f6..0000000000 --- a/reference/event/eventsslcontext/construct.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - EventSslContext::__construct - Construit un contexte OpenSSL à utiliser avec les classes Event - - - &reftitle.description; - - public - EventSslContext::__construct - - string - method - - - string - options - - - - Crée un contexte SSL contenant le pointeur vers SSL_CTX - (voir le manuel système). - - - - &reftitle.parameters; - - - - method - - - - Une des constantes - EventSslContext::*_METHOD. - - - - - - options - - - - Un tableau associatif d'options de contexte SSL. - Une des constantes - EventSslContext::OPT_*. - - - - - - - &reftitle.examples; - - - Exemple avec <function>EventSslContext::__construct</function> - - $local_cert, - EventSslContext::OPT_LOCAL_PK => $local_pk, - EventSslContext::OPT_PASSPHRASE => "echo server", - EventSslContext::OPT_VERIFY_PEER => true, - EventSslContext::OPT_ALLOW_SELF_SIGNED => false, -)); -?> -]]> - - - - - - diff --git a/reference/event/eventutil.xml b/reference/event/eventutil.xml deleted file mode 100644 index 3ba94eaef4..0000000000 --- a/reference/event/eventutil.xml +++ /dev/null @@ -1,489 +0,0 @@ - - - - - - La classe EventUtil - EventUtil - - -
- &reftitle.intro; - - La classe EventUtil est un singleton avec des - méthodes et des constantes supplémentaires. - -
- -
- &reftitle.classsynopsis; - - - - - EventUtil - - - - - final - EventUtil - - - - &Constants; - - const - int - EventUtil::AF_INET - 2 - - - const - int - EventUtil::AF_INET6 - 10 - - - const - int - EventUtil::AF_UNSPEC - 0 - - - const - int - EventUtil::LIBEVENT_VERSION_NUMBER - 33559808 - - - const - int - EventUtil::SO_DEBUG - 1 - - - const - int - EventUtil::SO_REUSEADDR - 2 - - - const - int - EventUtil::SO_KEEPALIVE - 9 - - - const - int - EventUtil::SO_DONTROUTE - 5 - - - const - int - EventUtil::SO_LINGER - 13 - - - const - int - EventUtil::SO_BROADCAST - 6 - - - const - int - EventUtil::SO_OOBINLINE - 10 - - - const - int - EventUtil::SO_SNDBUF - 7 - - - const - int - EventUtil::SO_RCVBUF - 8 - - - const - int - EventUtil::SO_SNDLOWAT - 19 - - - const - int - EventUtil::SO_RCVLOWAT - 18 - - - const - int - EventUtil::SO_SNDTIMEO - 21 - - - const - int - EventUtil::SO_RCVTIMEO - 20 - - - const - int - EventUtil::SO_TYPE - 3 - - - const - int - EventUtil::SO_ERROR - 4 - - - const - int - EventUtil::SOL_SOCKET - 1 - - - const - int - EventUtil::SOL_TCP - 6 - - - const - int - EventUtil::SOL_UDP - 17 - - - const - int - EventUtil::IPPROTO_IP - 0 - - - const - int - EventUtil::IPPROTO_IPV6 - 41 - - &Methods; - - - -
- -
- &reftitle.constants; - - - - EventUtil::AF_INET - - - - Famille d'adresses IPv4 - - - - - - EventUtil::AF_INET6 - - - - Famille d'adresses IPv6 - - - - - - EventUtil::AF_UNSPEC - - - - Famille d'adresses IP non spécifiée - - - - - - EventUtil::SO_DEBUG - - - - Option du socket. Active le débogage du socket. Uniquement autorisé pour - les processus avec la capacité CAP_NET_ADMIN - ou un ID d'utilisateur effectif de 0. - (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_REUSEADDR - - - - Option du socket. Indique que les règles utilisées dans la - validation des adresses fournies dans un appel à - bind(2) devraient autoriser la ré-utilisation - des adresses locales. Voir la page de manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_KEEPALIVE - - - - Option du socket. Active l'envoi de messages keep-alive sur les - sockets de connexion. Attend un drapeau booléen sous forme d'entier. - Voir la page de manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_DONTROUTE - - - - Option du socket. Voir la page de manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_LINGER - - - - Option du socket. Lorsqu'actif, un appel à - close(2) ou à shutdown(2) - ne va pas retourner tant que tous les messages de la file d'attente - du socket n'ont pas été envoyés, ou que le délai d'attente maximal du - linger ne sera pas atteint. Sinon, les appels retournent immédiatement - et la fermeture sera faite en arrière plan. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_BROADCAST - - - - Option du socket. Indique si la transmission des messages - de broadcast est supportée. Voir la page de manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_OOBINLINE - - - - Option du socket. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_SNDBUF - - - - Option du socket. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_RCVBUF - - - - Option du socket. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_SNDLOWAT - - - - Option du socket. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_RCVLOWAT - - - - Option du socket. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_SNDTIMEO - - - - Option du socket. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_RCVTIMEO - - - - Option du socket. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_TYPE - - - - Option du socket. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SO_ERROR - - - - Option du socket. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SOL_SOCKET - - - - Niveau d'option du socket. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SOL_TCP - - - - Niveau d'option du socket. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::SOL_UDP - - - - Niveau d'option du socket. Voir la page du manuel sur - socket(7). (Ajouté en event-1.6.0.) - - - - - - EventUtil::IPPROTO_IP - - - - Voir la page du manuel sur socket(7). - (Ajouté en event-1.6.0.) - - - - - - EventUtil::IPPROTO_IPV6 - - - - Voir la page du manuel sur socket(7). - (Ajouté en event-1.6.0.) - - - - - - EventUtil::LIBEVENT_VERSION_NUMBER - - - - Numéro de version de Libevent au moment où l'extension Event - a été compilée avec la bibliothèque. - - - - -
- - - - &reference.event.entities.eventutil; - - - diff --git a/reference/event/eventutil/construct.xml b/reference/event/eventutil/construct.xml deleted file mode 100644 index d4140e7acd..0000000000 --- a/reference/event/eventutil/construct.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - EventUtil::__construct - Le constructeur abstrait - - - &reftitle.description; - - abstract - public - EventUtil::__construct - - - - EventUtil est un singleton. - Aussi, le constructeur est abstrait, et il est donc impossible - de créer des objets en se basant sur cette classe. - - - - &reftitle.parameters; - &no.function.parameters; - - - - diff --git a/reference/event/eventutil/getlastsocketerrno.xml b/reference/event/eventutil/getlastsocketerrno.xml deleted file mode 100644 index a53bb40a0d..0000000000 --- a/reference/event/eventutil/getlastsocketerrno.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - EventUtil::getLastSocketErrno - Retourne le numéro d'erreur le plus récemment survenu sur le socket - - - &reftitle.description; - - public - static - int - EventUtil::getLastSocketErrno - - mixed - socket - &null; - - - - Retourne le numéro d'erreur le plus récemment survenu sur le socket - (errno). - - - - &reftitle.parameters; - - - - socket - - - - Ressource de socket, flux ou descripteur de fichier de socket. - - - - - - - &reftitle.returnvalues; - - Retourne le numéro d'erreur le plus récemment survenu sur le socket - (errno). - - - - &reftitle.seealso; - - - EventUtil::getLastSocketError - - - - - diff --git a/reference/event/eventutil/getlastsocketerror.xml b/reference/event/eventutil/getlastsocketerror.xml deleted file mode 100644 index a2d127c220..0000000000 --- a/reference/event/eventutil/getlastsocketerror.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - EventUtil::getLastSocketError - Retourne l'erreur la plus récemment survenue sur le socket - - - &reftitle.description; - - public - static - string - EventUtil::getLastSocketError - - mixed - socket - - - - Retourne l'erreur la plus récemment survenue sur le socket. - - - - &reftitle.parameters; - - - - socket - - - - Ressource de socket, flux, ou descripteur de fichier de socket. - - - - - - - &reftitle.returnvalues; - - Retourne l'erreur la plus récemment survenue sur le socket. - - - - &reftitle.seealso; - - - EventUtil::getLastSocketErrno - - - - - diff --git a/reference/event/eventutil/getsocketfd.xml b/reference/event/eventutil/getsocketfd.xml deleted file mode 100644 index 2cfd19ef20..0000000000 --- a/reference/event/eventutil/getsocketfd.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - EventUtil::getSocketFd - Retourne le descripteur de fichier d'un socket ou d'un flux - - - &reftitle.description; - - public - static - int - EventUtil::getSocketFd - - mixed - socket - - - - Retourne le descripteur numérique de fichier d'un socket - ou d'un flux spécifié par le paramètre socket, - comme le fait l'extension Event en interne - pour toutes les méthodes acceptant un socket ou un flux. - - - - &reftitle.parameters; - - - - socket - - - - Socket ou flux. - - - - - - - &reftitle.returnvalues; - - Retourne le descripteur de fichier numérique en cas de succès, &false; sinon. - EventUtil::getSocketFd retourne &false; - dans le cas où le type du fichier n'a pu être reconnu, ou bien lorsque - le descripteur du fichier associé avec le paramètre socket - n'est pas valide. - - - - - diff --git a/reference/event/eventutil/getsocketname.xml b/reference/event/eventutil/getsocketname.xml deleted file mode 100644 index 914d512303..0000000000 --- a/reference/event/eventutil/getsocketname.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - EventUtil::getSocketName - Récupère l'adresse courante liée au socket - - - &reftitle.description; - - public - static - bool - EventUtil::getSocketName - - mixed - socket - - - string - address - - - mixed - port - - - - Récupère l'adresse courante liée au socket. - - - - &reftitle.parameters; - - - - socket - - - - Ressource de socket, flux, ou descripteur de fichier de socket. - - - - - - address - - - - Paramètre de sortie. Adresse IP ou le chemin du domaine UNIX du socket, - suivant la famille d'adresse du socket. - - - - - - port - - - - Paramètre de sortie. Le port lié au socket. N'a pas de sens pour - les sockets de domaine UNIX. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventutil/setsocketoption.xml b/reference/event/eventutil/setsocketoption.xml deleted file mode 100644 index bc1044be82..0000000000 --- a/reference/event/eventutil/setsocketoption.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - EventUtil::setSocketOption - Définit les options du socket - - - &reftitle.description; - - public - static - bool - EventUtil::setSocketOption - - mixed - socket - - - int - level - - - int - optname - - - mixed - optval - - - - Définit les options du socket. - - - - &reftitle.parameters; - - - - socket - - - - Ressource de socket, flux, ou descripteur de fichier numérique associé avec - le socket. - - - - - - level - - - - Une constante EventUtil::SOL_*. - Spécifie le niveau du protocole dans lequel résident les options. - Par exemple, pour récupérer les options au niveau socket, le paramètre - level doit être positionné à la valeur - EventUtil::SOL_SOCKET. Les autres niveaux, - comme TCP, peuvent être utilisés en spécifiant le numéro du protocole - de ce niveau. Les numéros des protocoles peuvent être retrouvés - en utilisant la fonction getprotobyname. Voir - aussi les constantes EventUtil. - - - - - - optname - - - - Nom de l'option (type). A la même signification que le paramètre correspondant - de la fonction socket_get_option. Voir aussi les - constantes EventUtil. - - - - - - optval - - - - Accepte les mêmes valeurs que le paramètre - optval de la fonction - socket_get_option. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - socket_get_option - - - socket_set_option - - - - - diff --git a/reference/event/eventutil/sslrandpoll.xml b/reference/event/eventutil/sslrandpoll.xml deleted file mode 100644 index 24d1d01bfe..0000000000 --- a/reference/event/eventutil/sslrandpoll.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - EventUtil::sslRandPoll - Génère l'entropie via OpenSSL RAND_poll() - - - &reftitle.description; - - public - static - void - EventUtil::sslRandPoll - - - - Génère l'entropie via OpenSSL RAND_poll() - (voir le manuel système). - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/event/examples.xml b/reference/event/examples.xml deleted file mode 100644 index 9f55369cba..0000000000 --- a/reference/event/examples.xml +++ /dev/null @@ -1,1322 +0,0 @@ - - - - - - - &reftitle.examples; - - Client HTTP simple - -input; //$bev->getInput(); - - //$pos = $input->search("TTP"); - $pos = $bev->input->search("TTP"); - - while (($n = $bev->input->remove($buf, 1024)) > 0) { - echo $buf; - } -} - -// Fonction de rappel de l'événement -function eventcb($bev, $events, $base) { - if ($events & EventBufferEvent::CONNECTED) { - echo "Connecté.\n"; - } elseif ($events & (EventBufferEvent::ERROR | EventBufferEvent::EOF)) { - if ($events & EventBufferEvent::ERROR) { - echo "Erreur DNS : ", $bev->getDnsErrorString(), PHP_EOL; - } - - echo "Fermeture\n"; - $base->exit(); - exit("Fait !\n"); - } -} - -if ($argc != 3) { - echo <<setCallbacks("readcb", /* writecb */ NULL, "eventcb", $base); -$bev->enable(Event::READ | Event::WRITE); - -$output = $bev->output; //$bev->getOutput(); -if (!$output->add( - "GET {$argv[2]} HTTP/1.0\r\n". - "Host: {$argv[1]}\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Échec dans l'ajout de la requête dans le buffer de sortie\n"); -} - -if (!$bev->connectHost($dns_base, $argv[1], 80, EventUtil::AF_UNSPEC)) { - exit("Connexion impossible à l'hôte {$argv[1]}\n"); -} - -$base->dispatch(); -?> -]]> - - &example.outputs.similar; - - -301 Moved -

301 Moved

-The document has moved -here. - -Closing -Done -]]> - - - - Client HTTP en utilisant une résolution DNS asynchrone - -getInput(); - - while (($n = $input->remove($buf, 1024)) > 0) { - echo $buf; - } -} - -// Fonction de rappel de l'événement -function eventcb($bev, $events, $base) { - if ($events & EventBufferEvent::CONNECTED) { - echo "Connecté.\n"; - } elseif ($events & (EventBufferEvent::ERROR | EventBufferEvent::EOF)) { - if ($events & EventBufferEvent::ERROR) { - echo "Erreur DNS : ", $bev->getDnsErrorString(), PHP_EOL; - } - - echo "Fermeture\n"; - $base->exit(); - exit("Fait !\n"); - } -} - -$base = new EventBase(); - -echo "étape n°1\n"; -$bev = new EventBufferEvent($base, /* use internal socket */ NULL, - EventBufferEvent::OPT_CLOSE_ON_FREE | EventBufferEvent::OPT_DEFER_CALLBACKS); -if (!$bev) { - exit("Échec lors de la création du socket bufferevent\n"); -} - -echo "étape n°2\n"; -$bev->setCallbacks("readcb", /* writecb */ NULL, "eventcb", $base); -$bev->enable(Event::READ | Event::WRITE); - -echo "étape n°3\n"; -// Envoi de la requête -$output = $bev->getOutput(); -if (!$output->add( - "GET /index.cphp HTTP/1.0\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Échec lors de l'ajout de la requête dans le buffer de sortie\n"); -} - -/* Connexion à l'hôte de façon synchrone. -Nous connaissons l'IP, nous n'avons donc pas besoin de résolution DNS. */ -if (!$bev->connect("127.0.0.1:80")) { - exit("Impossible de se connecter à l'hôte\n"); -} - -// Diffuse les événements en attente -$base->dispatch(); -?> -]]> - - - - - - - Serveur d'affichage - -bev->free(); - } - - public function __construct($base, $fd) { - $this->base = $base; - - $this->bev = new EventBufferEvent($base, $fd, EventBufferEvent::OPT_CLOSE_ON_FREE); - - $this->bev->setCallbacks(array($this, "echoReadCallback"), NULL, - array($this, "echoEventCallback"), NULL); - - if (!$this->bev->enable(Event::READ)) { - echo "Échec dans l'activation de READ\n"; - return; - } - } - - public function echoReadCallback($bev, $ctx) { - // Copie toutes les données depuis le buffer d'entrée vers le buffer de sortie - - // Variant #1 - $bev->output->addBuffer($bev->input); - - /* Variant #2 */ - /* - $input = $bev->getInput(); - $output = $bev->getOutput(); - $output->addBuffer($input); - */ - } - - public function echoEventCallback($bev, $events, $ctx) { - if ($events & EventBufferEvent::ERROR) { - echo "Erreur depuis bufferevent\n"; - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - //$bev->free(); - $this->__destruct(); - } - } -} - -class MyListener { - public $base, - $listener, - $socket; - private $conn = array(); - - public function __destruct() { - foreach ($this->conn as &$c) $c = NULL; - } - - public function __construct($port) { - $this->base = new EventBase(); - if (!$this->base) { - echo "Impossible d'ouvrir l'événement de base"; - exit(1); - } - - // Variant #1 - /* - $this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - if (!socket_bind($this->socket, '0.0.0.0', $port)) { - echo "Impossible de lier le socket\n"; - exit(1); - } - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, - -1, $this->socket); - */ - - // Variant #2 - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, -1, - "0.0.0.0:$port"); - - if (!$this->listener) { - echo "Impossible de créer l'écouteur"; - exit(1); - } - - $this->listener->setErrorCallback(array($this, "accept_error_cb")); - } - - public function dispatch() { - $this->base->dispatch(); - } - - // Cette fonction de rappel est appelée lorsqu'il y a des données à lire sur $bev - public function acceptConnCallback($listener, $fd, $address, $ctx) { - // Nous avons une nouvelle connexion ! On définit un bufferevent pour elle. */ - $base = $this->base; - $this->conn[] = new MyListenerConnection($base, $fd); - } - - public function accept_error_cb($listener, $ctx) { - $base = $this->base; - - fprintf(STDERR, "On reçoit une erreur %d (%s) sur l'écouteur. " - ."Arrêt.\n", - EventUtil::getLastSocketErrno(), - EventUtil::getLastSocketError()); - - $base->exit(NULL); - } -} - -$port = 9808; - -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Port invalide"); -} - -$l = new MyListener($port); -$l->dispatch(); -?> -]]> - - - - Serveur d'affichage SSL - -port = $port; - $this->ctx = $this->init_ssl(); - if (!$this->ctx) { - exit("Échec lors de la création du contexte SSL\n"); - } - - $this->base = new EventBase(); - if (!$this->base) { - exit("Impossible d'ouvrir l'événement de base\n"); - } - - $this->listener = new EventListener($this->base, - array($this, "ssl_accept_cb"), $this->ctx, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, - -1, "$host:$port"); - if (!$this->listener) { - exit("Impossible de créer l'écouteur\n"); - } - - $this->listener->setErrorCallback(array($this, "accept_error_cb")); - } - function dispatch() { - $this->base->dispatch(); - } - - // Cette fonction de rappel est appelée lorsqu'il y a des données à lire sur $bev. - function ssl_read_cb($bev, $ctx) { - $in = $bev->input; //$bev->getInput(); - - printf("Réception de %zu octets\n", $in->length); - printf("----- données ----\n"); - printf("%ld:\t%s\n", (int) $in->length, $in->pullup(-1)); - - $bev->writeBuffer($in); - } - - // Cette fonction de rappel est appelée lorsque des erreurs surviennent sur l'écouteur d'événement, - // i.e. la connexion se ferme, ou une erreur survient - function ssl_event_cb($bev, $events, $ctx) { - if ($events & EventBufferEvent::ERROR) { - // Récupère les erreurs depuis la pile d'erreur SSL - while ($err = $bev->sslError()) { - fprintf(STDERR, "Erreur Bufferevent %s.\n", $err); - } - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - $bev->free(); - } - } - - // Cette fonction de rappel est appelée lorsqu'un client accepte une nouvelle connexion - function ssl_accept_cb($listener, $fd, $address, $ctx) { - // Nous avons une nouvelle connexion ! On définit un bufferevent pour elle. - $this->bev = EventBufferEvent::sslSocket($this->base, $fd, $this->ctx, - EventBufferEvent::SSL_ACCEPTING, EventBufferEvent::OPT_CLOSE_ON_FREE); - - if (!$this->bev) { - echo "Échec lors de la création du buffer SSL\n"; - $this->base->exit(NULL); - exit(1); - } - - $this->bev->enable(Event::READ); - $this->bev->setCallbacks(array($this, "ssl_read_cb"), NULL, - array($this, "ssl_event_cb"), NULL); - } - - // Cette fonction de rappel est appelée lorsqu'on échoue à définir une nouvelle connexion pour un client - function accept_error_cb($listener, $ctx) { - fprintf(STDERR, "On reçoit une erreur %d (%s) sur l'écouteur. " - ."Arrêt.\n", - EventUtil::getLastSocketErrno(), - EventUtil::getLastSocketError()); - - $this->base->exit(NULL); - } - - // Initialise les structures SSL ; crée un EventSslContext - // Optionnellement, crée des certificats autosignés - function init_ssl() { - // Nous *devons* avoir l'entropie. Sinon, il n'y a aucun intérêt à chiffrer. - if (!EventUtil::sslRandPoll()) { - exit("Échec de EventUtil::sslRandPoll\n"); - } - - $local_cert = __DIR__."/cert.pem"; - $local_pk = __DIR__."/privkey.pem"; - - if (!file_exists($local_cert) || !file_exists($local_pk)) { - echo "Impossible de lire le fichier $local_cert ou $local_pk. Pour générer une clé\n", - "et un certificat autosigné, exécutez :\n", - " openssl genrsa -out $local_pk 2048\n", - " openssl req -new -key $local_pk -out cert.req\n", - " openssl x509 -req -days 365 -in cert.req -signkey $local_pk -out $local_cert\n"; - - return FALSE; - } - - $ctx = new EventSslContext(EventSslContext::SSLv3_SERVER_METHOD, array ( - EventSslContext::OPT_LOCAL_CERT => $local_cert, - EventSslContext::OPT_LOCAL_PK => $local_pk, - //EventSslContext::OPT_PASSPHRASE => "echo server", - EventSslContext::OPT_VERIFY_PEER => true, - EventSslContext::OPT_ALLOW_SELF_SIGNED => false, - )); - - return $ctx; - } -} - -// Autorise l'écrasement du port -$port = 9999; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Port invalide\n"); -} - - -$l = new MySslEchoServer($port); -$l->dispatch(); -?> -]]> - - - - Gestionnaire de signal - -base = $base; - } - - function eventSighandler($no, $c) { - echo "On attrape le signal $no\n"; - event_base_loopexit($c->base); - } -} - -$base = event_base_new(); -$c = new MyEventSignal($base); -$no = SIGTERM; -$ev = evsignal_new($base, $no, array($c,'eventSighandler'), $c); - -evsignal_add($ev); - -event_base_loop($base); -?> -]]> - - - - Utilisation d'une boucle libevent pour réaliser les requêtes de l'extension `eio' - -stop(); -}, $base); - -echo "étape 3\n"; - -$event->add(); - -echo "étape 4\n"; - -$base->dispatch(); - -echo "Fait !\n"; -?> -]]> - - - - Divers - -avoidMethod("select")) { - echo "La méthode 'select' a été désactivée\n"; -} - -// Crée un event_base associé à la configuration -$base = new EventBase($cfg); -echo "Méthode d'événement utilisée : ", $base->getMethod(), PHP_EOL; - -echo "fonctionnalités :\n"; -$features = $base->getFeatures(); -($features & EventConfig::FEATURE_ET) and print "ET - E/S déclenchées par front\n"; -($features & EventConfig::FEATURE_O1) and print "O1 - opération O(1) pour l'ajout/suppression d'événements\n"; -($features & EventConfig::FEATURE_FDS) and print "FDS - type de descripteur de fichiers arbitraire, et non uniquement les sockets\n"; - -// Nécessite la fonctionnalité FDS -if ($cfg->requireFeatures(EventConfig::FEATURE_FDS)) { - echo "La fonctionnalité FDS est maintenant requise\n"; - - $base = new EventBase($cfg); - ($base->getFeatures() & EventConfig::FEATURE_FDS) - and print "FDS - type de descripteur de fichiers arbitraire, et non uniquement les sockets\n"; -} -/* }}} */ - -/* {{{ Base */ -$base = new EventBase(); -$event = new Event($base, STDIN, Event::READ | Event::PERSIST, function ($fd, $events, $arg) { - static $max_iterations = 0; - - if (++$max_iterations >= 5) { - /* on sort après 5 itérations avec un délai maximal d'attente de 2.33 secondes */ - echo "Arrêt...\n"; - $arg[0]->exit(2.33); - } - - echo fgets($fd); -}, array (&$base)); - -$event->add(); -$base->loop(); -/* Base }}} */ -?> -]]> - - - - Serveur HTTP simple - -= $max_requests) { - echo "Le compteur a atteint le nombre maximal de requêtes ($max_requests). Sortie !\n"; - exit(); - } - - echo __METHOD__, " appelée\n"; - echo "Requête :"; var_dump($req); - echo "Données :"; var_dump($data); - - echo "\n===== DUMP =====\n"; - echo "Commande :", $req->getCommand(), PHP_EOL; - echo "URI :", $req->getUri(), PHP_EOL; - echo "En-têtes en entrée :"; var_dump($req->getInputHeaders()); - echo "En-têtes en sortie :"; var_dump($req->getOutputHeaders()); - - echo "\n >> Envoi de la réponse ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; - - echo "\n >> Lecture du buffer d'entrée ...\n"; - $buf = $req->getInputBuffer(); - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - echo "Il n'y a plus de données dans le buffer\n"; -} - -function _http_about($req) { - echo __METHOD__, PHP_EOL; - echo "URI : ", $req->getUri(), PHP_EOL; - echo "\n >> Envoi de la réponse ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_default($req, $data) { - echo __METHOD__, PHP_EOL; - echo "URI : ", $req->getUri(), PHP_EOL; - echo "\n >> Envoi de la réponse ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -$port = 8010; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Port invalide"); -} - -$base = new EventBase(); -$http = new EventHttp($base); -$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST); - -$http->setCallback("/dump", "_http_dump", array(4, 8)); -$http->setCallback("/about", "_http_about"); -$http->setDefaultCallback("_http_default", "valeur de données personnalisées"); - -$http->bind("0.0.0.0", 8010); -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - Serveur HTTPS simple - -= $max_requests) { - echo "Le compteur a atteint le nombre maximal de requêtes ($max_requests). Sortie\n"; - exit(); - } - - echo __METHOD__, " appelée\n"; - echo "Requête :"; var_dump($req); - echo "Données :"; var_dump($data); - - echo "\n===== DUMP =====\n"; - echo "Commande :", $req->getCommand(), PHP_EOL; - echo "URI :", $req->getUri(), PHP_EOL; - echo "En-têtes d'entrée :"; var_dump($req->getInputHeaders()); - echo "En-têtes de sortie :"; var_dump($req->getOutputHeaders()); - - echo "\n >> Envoi de la réponse ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; - - $buf = $req->getInputBuffer(); - echo "\n >> Lecture du buffer d'entrée (", $buf->length, ") ...\n"; - while ($s = $buf->read(1024)) { - echo $s; - } - echo "\nIl n'y a plus de données dans le buffer\n"; -} - -function _http_about($req) { - echo __METHOD__, PHP_EOL; - echo "URI : ", $req->getUri(), PHP_EOL; - echo "\n >> Envoi de la réponse ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_default($req, $data) { - echo __METHOD__, PHP_EOL; - echo "URI : ", $req->getUri(), PHP_EOL; - echo "\n >> Envoi de la réponse ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_400($req) { - $req->sendError(400); -} - -function _init_ssl() { - $local_cert = __DIR__."/ssl-echo-server/cert.pem"; - $local_pk = __DIR__."/ssl-echo-server/privkey.pem"; - - $ctx = new EventSslContext(EventSslContext::SSLv3_SERVER_METHOD, array ( - EventSslContext::OPT_LOCAL_CERT => $local_cert, - EventSslContext::OPT_LOCAL_PK => $local_pk, - //EventSslContext::OPT_PASSPHRASE => "test", - EventSslContext::OPT_ALLOW_SELF_SIGNED => true, - )); - - return $ctx; -} - -$port = 9999; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Port invalide"); -} -$ip = '0.0.0.0'; - -$base = new EventBase(); -$ctx = _init_ssl(); -$http = new EventHttp($base, $ctx); -$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST); - -$http->setCallback("/dump", "_http_dump", array(4, 8)); -$http->setCallback("/about", "_http_about"); -$http->setCallback("/err400", "_http_400"); -$http->setDefaultCallback("_http_default", "Valeur des données personnalisées"); - -$http->bind($ip, $port); -$base->dispatch(); -]]> - - - - Connexion OpenSSL - -getResponseCode(); - - if ($response_code == 0) { - echo "Connexion refusée\n"; - } elseif ($response_code != 200) { - echo "Réponse inattendue : $response_code\n"; - } else { - echo "Succès : $response_code\n"; - $buf = $req->getInputBuffer(); - echo "Corps :\n"; - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - } - } - - $base->exit(NULL); -} - -function _init_ssl() { - $ctx = new EventSslContext(EventSslContext::SSLv3_CLIENT_METHOD, array ()); - - return $ctx; -} - - -// Autorise l'écrasement du port -$port = 9999; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Port invalide\n"); -} -$host = '127.0.0.1'; - -$ctx = _init_ssl(); -if (!$ctx) { - trigger_error("Échec lors de la création du contexte SSL", E_USER_ERROR); -} - -$base = new EventBase(); -if (!$base) { - trigger_error("Échec dans l'initialisation de l'événement de base", E_USER_ERROR); -} - -$conn = new EventHttpConnection($base, NULL, $host, $port, $ctx); -$conn->setTimeout(50); - -$req = new EventHttpRequest("_request_handler", $base); -$req->addHeader("Host", $host, EventHttpRequest::OUTPUT_HEADER); -$buf = $req->getOutputBuffer(); -$buf->add("HTML TEST"); -//$req->addHeader("Content-Length", $buf->length, EventHttpRequest::OUTPUT_HEADER); -//$req->addHeader("Connection", "close", EventHttpRequest::OUTPUT_HEADER); -$conn->makeRequest($req, EventHttpRequest::CMD_POST, "/dump"); - -$base->dispatch(); -echo "FIN\n"; -?> -]]> - - - - - Exemple avec <function>EventHttpConnection::makeRequest</function> - -getResponseCode(); - - if ($response_code == 0) { - echo "Connexion refusée\n"; - } elseif ($response_code != 200) { - echo "Réponse inattendue : $response_code\n"; - } else { - echo "Succès : $response_code\n"; - $buf = $req->getInputBuffer(); - echo "Corps :\n"; - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - } - } - - $base->exit(NULL); -} - -$address = "127.0.0.1"; -$port = 80; - -$base = new EventBase(); -$conn = new EventHttpConnection($base, NULL, $address, $port); -$conn->setTimeout(5); -$req = new EventHttpRequest("_request_handler", $base); - -$req->addHeader("Host", $address, EventHttpRequest::OUTPUT_HEADER); -$req->addHeader("Content-Length", "0", EventHttpRequest::OUTPUT_HEADER); -$conn->makeRequest($req, EventHttpRequest::CMD_GET, "/index.cphp"); - -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - Écoute d'une connexion en se basant sur un socket de domaine Unix - -bev) { - $this->bev->free(); - } - } - - public function __construct($base, $fd) { - $this->base = $base; - - $this->bev = new EventBufferEvent($base, $fd, EventBufferEvent::OPT_CLOSE_ON_FREE); - - $this->bev->setCallbacks(array($this, "echoReadCallback"), NULL, - array($this, "echoEventCallback"), NULL); - - if (!$this->bev->enable(Event::READ)) { - echo "Échec dans l'activation de READ\n"; - return; - } - } - - public function echoReadCallback($bev, $ctx) { - // Copie toutes les données depuis le buffer d'entrée dans le buffer de sortie - $bev->output->addBuffer($bev->input); - } - - public function echoEventCallback($bev, $events, $ctx) { - if ($events & EventBufferEvent::ERROR) { - echo "Erreur depuis bufferevent\n"; - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - $bev->free(); - $bev = NULL; - } - } -} - -class MyListener { - public $base, - $listener, - $socket; - private $conn = array(); - - public function __destruct() { - foreach ($this->conn as &$c) $c = NULL; - } - - public function __construct($sock_path) { - $this->base = new EventBase(); - if (!$this->base) { - echo "Impossible d'ouvrir l'événement de base"; - exit(1); - } - - if (file_exists($sock_path)) { - unlink($sock_path); - } - - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, -1, - "unix:$sock_path"); - - if (!$this->listener) { - trigger_error("Impossible de créer l'écouteur", E_USER_ERROR); - } - - $this->listener->setErrorCallback(array($this, "accept_error_cb")); - } - - public function dispatch() { - $this->base->dispatch(); - } - - // Cette fonction de rappel sera appelée lorsqu'il y aura des données à lire sur $bev - public function acceptConnCallback($listener, $fd, $address, $ctx) { - // Nous avons une nouvelle connexion ! On définit un bufferevent pour elle. */ - $base = $this->base; - $this->conn[] = new MyListenerConnection($base, $fd); - } - - public function accept_error_cb($listener, $ctx) { - $base = $this->base; - - fprintf(STDERR, "On reçoit une erreur %d (%s) sur l'écouteur. " - ."Arrêt.\n", - EventUtil::getLastSocketErrno(), - EventUtil::getLastSocketError()); - - $base->exit(NULL); - } -} - -if ($argc <= 1) { - exit("Le chemin vers le socket n'est pas fourni\n"); -} -$sock_path = $argv[1]; - -$l = new MyListener($sock_path); -$l->dispatch(); -?> -]]> - - - - Exemple de serveur SMTP - - - * - * Utilisation : - * 1) On prépare le certificat cert.pem et la clé privée privkey.pem. - * 2) On démarre le script du serveur - * 3) On ouvre la connexion TLS, i.e. : - * $ openssl s_client -connect localhost:25 -starttls smtp -crlf - * 4) On commence à tester les commandes listées dans la méthode `cmd` ci-dessous. - */ - -class Handler { - public $domainName = FALSE; - public $connections = []; - public $buffers = []; - public $maxRead = 256000; - - public function __construct() { - $this->ctx = new EventSslContext(EventSslContext::SSLv3_SERVER_METHOD, [ - EventSslContext::OPT_LOCAL_CERT => 'cert.pem', - EventSslContext::OPT_LOCAL_PK => 'privkey.pem', - //EventSslContext::OPT_PASSPHRASE => '', - EventSslContext::OPT_VERIFY_PEER => false, // modifier en TRUE avec les certificats authentiques - EventSslContext::OPT_ALLOW_SELF_SIGNED => true // modifier en FALSE avec les certificats authentiques - ]); - - $this->base = new EventBase(); - if (!$this->base) { - exit("Impossible d'ouvrir l'événement de base\n"); - } - - if (!$this->listener = new EventListener($this->base, - [$this, 'ev_accept'], - $this->ctx, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, - -1, - '0.0.0.0:25')) - { - exit("Impossible de créer l'écouteur\n"); - } - - $this->listener->setErrorCallback([$this, 'ev_error']); - $this->base->dispatch(); - } - - public function ev_accept($listener, $fd, $address, $ctx) { - static $id = 0; - $id += 1; - - $this->connections[$id]['clientData'] = ''; - $this->connections[$id]['cnx'] = new EventBufferEvent($this->base, $fd, - EventBufferEvent::OPT_CLOSE_ON_FREE); - - if (!$this->connections[$id]['cnx']) { - echo "Échec lors de la création du buffer\n"; - $this->base->exit(NULL); - exit(1); - } - - $this->connections[$id]['cnx']->setCallbacks([$this, "ev_read"], NULL, - [$this, 'ev_error'], $id); - $this->connections[$id]['cnx']->enable(Event::READ | Event::WRITE); - - $this->ev_write($id, '220 '.$this->domainName." wazzzap?\r\n"); - } - - function ev_error($listener, $ctx) { - $errno = EventUtil::getLastSocketErrno(); - - fprintf(STDERR, "On reçoit l'erreur %d (%s) sur l'écouteur. On stoppe.\n", - $errno, EventUtil::getLastSocketError()); - - if ($errno != 0) { - $this->base->exit(NULL); - exit(); - } - } - - public function ev_close($id) { - $this->connections[$id]['cnx']->disable(Event::READ | Event::WRITE); - unset($this->connections[$id]); - } - - protected function ev_write($id, $string) { - echo 'S('.$id.'): '.$string; - $this->connections[$id]['cnx']->write($string); - } - - public function ev_read($buffer, $id) { - while($buffer->input->length > 0) { - $this->connections[$id]['clientData'] .= $buffer->input->read($this->maxRead); - $clientDataLen = strlen($this->connections[$id]['clientData']); - - if($this->connections[$id]['clientData'][$clientDataLen-1] == "\n" - && $this->connections[$id]['clientData'][$clientDataLen-2] == "\r") - { - // Supprime les caractères \r\n à la fin - $line = substr($this->connections[$id]['clientData'], 0, - strlen($this->connections[$id]['clientData']) - 2); - - $this->connections[$id]['clientData'] = ''; - $this->cmd($buffer, $id, $line); - } - } - } - - protected function cmd($buffer, $id, $line) { - switch ($line) { - case strncmp('EHLO ', $line, 4): - $this->ev_write($id, "250-STARTTLS\r\n"); - $this->ev_write($id, "250 OK ehlo\r\n"); - break; - - case strncmp('HELO ', $line, 4): - $this->ev_write($id, "250-STARTTLS\r\n"); - $this->ev_write($id, "250 OK helo\r\n"); - break; - - case strncmp('QUIT', $line, 3): - $this->ev_write($id, "250 OK quit\r\n"); - $this->ev_close($id); - break; - - case strncmp('STARTTLS', $line, 3): - $this->ev_write($id, "220 Ready to start TLS\r\n"); - $this->connections[$id]['cnx'] = EventBufferEvent::sslFilter($this->base, - $this->connections[$id]['cnx'], $this->ctx, - EventBufferEvent::SSL_ACCEPTING, - EventBufferEvent::OPT_CLOSE_ON_FREE); - $this->connections[$id]['cnx']->setCallbacks([$this, "ev_read"], NULL, [$this, 'ev_error'], $id); - $this->connections[$id]['cnx']->enable(Event::READ | Event::WRITE); - break; - - default: - echo 'Commande inconnue : '.$line."\n"; - break; - } - } -} - -new Handler(); -]]> - - - - diff --git a/reference/event/setup.xml b/reference/event/setup.xml deleted file mode 100644 index ffea6f2710..0000000000 --- a/reference/event/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - &reftitle.setup; - -
- &reftitle.required; - - Cette extension requiert la bibliothèque - libevent. - La plupart des distributions modernes fournissent des paquets - pour libevent. - - - Les fonctionnalités OpenSSL requièrent la bibliothèque - OpenSSL. - -
-
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;event. - -
- - diff --git a/reference/expect/book.xml b/reference/expect/book.xml deleted file mode 100644 index 2830e63a81..0000000000 --- a/reference/expect/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - Expect - - - - &reftitle.intro; - - Cette extension autorise l'interaction avec des processus à travers PTY. - Il est possible d'utiliser l'enveloppe expect:// - avec les fonctions de système de - fichiers ce qui fournit une interface plus simple et plus intuitive. - - - - - &reference.expect.setup; - &reference.expect.constants; - &reference.expect.examples; - &reference.expect.reference; - - - diff --git a/reference/expect/configure.xml b/reference/expect/configure.xml deleted file mode 100644 index 3fd14984f5..0000000000 --- a/reference/expect/configure.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - -
- &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;expect. - - - Afin d'utiliser ces fonctions, il faut compiler PHP avec le support - expect en utilisant l'option de configuration . - - - Les utilisateurs de Windows pourront activer - php_expect.dll à l'intérieur du &php.ini; afin - d'utiliser ces fonctions. - &pecl.windows.download; - -
- diff --git a/reference/expect/constants.xml b/reference/expect/constants.xml deleted file mode 100644 index 4dfefe26f9..0000000000 --- a/reference/expect/constants.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - EXP_GLOB - (int) - - - - Indique que le motif est un motif de style de chaîne de caractères glob. - - - - - - EXP_EXACT - (int) - - - - Indique que le motif est une chaîne exacte. - - - - - - EXP_REGEXP - (int) - - - - Indique que le motif est un motif d'expression rationnelle. - - - - - - EXP_EOF - (int) - - - - Valeur, retournée par expect_expectl, lorsque EOF - est atteint. - - - - - - EXP_TIMEOUT - (int) - - - - Valeur, retournée par expect_expectl sur le - dépassement du temps en secondes, spécifiée par la valeur expect.timeout - - - - - - EXP_FULLBUFFER - (int) - - - - Valeur, retournée par expect_expectl si aucun motif - n'a été trouvé. - - - - - - - diff --git a/reference/expect/examples.xml b/reference/expect/examples.xml deleted file mode 100644 index 37322fdcec..0000000000 --- a/reference/expect/examples.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - &reftitle.examples; -
- Exemples d'Utilisation avec Expect - - Exemple d'Utilisation avec Expect - - Cet exemple se connecte à un hôte distant via SSH et affiche le temps - d'utilisation distant. - - - "password:", 1 => PASSWORD) -); - -switch (expect_expectl ($stream, $cases)) { - case PASSWORD: - fwrite ($stream, "password\n"); - break; - - default: - die ("Une erreur s'est produite lors de la connexion à l'hôte distant !\n"); -} - -while ($line = fgets($stream)) { - print $line; -} -fclose ($stream); -?> -]]> - - - - - L'exemple suivant permet de se connecter à un hôte distant, détermine - si le système d'exploitation distant est 32 ou 64 bits, puis, effectue - une mise à jour d'un paquet spécifique. - - - Autre exemple d'utilisation d'Expect - - -]]> - - -
- - diff --git a/reference/expect/functions/expect-expectl.xml b/reference/expect/functions/expect-expectl.xml deleted file mode 100644 index f536dad86a..0000000000 --- a/reference/expect/functions/expect-expectl.xml +++ /dev/null @@ -1,203 +0,0 @@ - - - - - - - expect_expectl - Attend jusqu'à ce que la sortie d'un processus corresponde à un - des motifs, une période de temps spécifique est passée ou un EOF est vu - - - - &reftitle.description; - - intexpect_expectl - resourceexpect - arraycases - arraymatch - - - Attend jusqu'à ce que la sortie d'un processus corresponde à un - des motifs, une période de temps spécifique est passée ou un EOF est vu. - - - Si le paramètre match est fourni, alors il est - rempli avec le résultat de la recherche. - La chaîne de caractères de recherche peut être trouvée dans - match[0]. Les sous-chaînes de recherche (selon les - parenthèses) dans le motif original peuvent être trouvées dans - match[1], match[2] et ainsi - de suite jusqu'à match[9] (limité par libexpect). - - - - &reftitle.parameters; - - - expect - - - Un flux de données Expect, ouvert précédemment avec - expect_popen. - - - - - cases - - - Un tableau des cas expect. Chaque cas expect est un tableau indexé, - comme décrit dans la table suivante : - - Tableau des cas Expect - - - - Clé Index - Type Valeur - Description - Est Obligatoire - Valeur par Défaut - - - - - 0 - string - motif, qui sera vérifié avec la sortie du flux - oui - - - - 1 - mixed - - valeur, qui est retournée par cette fonction, si le motif - concorde - - oui - - - - 2 - integer - - type de motif, un de : - EXP_GLOB, - EXP_EXACT - ou EXP_REGEXP - - non - EXP_GLOB - - - -
- - - - - - - &reftitle.returnvalues; - - Retourne une valeur associée avec le motif qui correspond. - - - En cas d'échec, cette fonction retourne : - EXP_EOF, - EXP_TIMEOUT - ou EXP_FULLBUFFER - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL expect 0.2.1 - - Avant la version 0.2.1, dans le paramètre match, - un résultat en chaîne de caractères était retourné et non un tableau de - sous-chaînes de résultat. - - - - - - - - &reftitle.examples; - - Exemple avec <function>expect_expectl</function> - - -]]> - - - - - &reftitle.seealso; - - expect_popen - - - - diff --git a/reference/expect/functions/expect-popen.xml b/reference/expect/functions/expect-popen.xml deleted file mode 100644 index 120cecb21b..0000000000 --- a/reference/expect/functions/expect-popen.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - expect_popen - Exécute une commande via le shell Bourne, et ouvre le flux PTY - au processus - - - &reftitle.description; - - resourceexpect_popen - stringcommand - - - Exécute une commande via le shell Bourne, et ouvre le flux PTY au processus. - - - - &reftitle.parameters; - - - command - - - Commande à exécuter. - - - - - - - &reftitle.returnvalues; - - Retourne un flux de données PTY ouvert au processus stdio, - stdout et stderr. - - - En cas d'erreur, cette fonction retourne &false;. - - - - &reftitle.examples; - - Exemple avec <function>expect_popen</function> - - -]]> - - - - - &reftitle.seealso; - - popen - - - - diff --git a/reference/expect/ini.xml b/reference/expect/ini.xml deleted file mode 100644 index 4c70fa5a2f..0000000000 --- a/reference/expect/ini.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - -
- &reftitle.runtime; - &extension.runtime; - - Afin de configurer l'extension expect, il y a des options de configuration - dans le fichier de configuration &php.ini;. - - &ConfigureOptions; Expect - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - expect.timeout - "10" - INI_ALL - - - - expect.loguser - "1" - INI_ALL - - - - expect.logfile - "" - INI_ALL - - - - expect.match_max - "" - INI_ALL - - - - -
- &ini.php.constants; - - - &ini.descriptions.title; - - - - - expect.timeout - int - - - - La période de dépassement du temps pour l'attente des données, lors - de l'utilisation de la fonction expect_expectl. - - - Une valeur de "-1" désactive le dépassement de temps. - - - - Une valeur de "0" fait retourner immédiatement la fonction - expect_expectl. - - - - - - - - expect.loguser - bool - - - - Si expect devrait envoyer toutes les données de sortie à partir du - démarrage du processus à stdout. Puisque les programmes interactifs - affichent typiquement leur entrée, ceci suffit habituellement pour - montrer les deux côtés de la conversation. - - - - - - - expect.logfile - string - - - - Nom du fichier, où la sortie à partir du démarrage du processus devrait - être écrite. Si ce fichier n'existe pas, il sera créé. - - - - Si cette configuration n'est pas vide, la sortie est écrite peu importe - la valeur de expect.loguser. - - - - - - - - expect.match_max - int - - - - Modifie la taille par défaut (2000 octets) du tampon - utilisé pour faire correspondre les astérisques dans - le masque. - - - - - -
- diff --git a/reference/expect/reference.xml b/reference/expect/reference.xml deleted file mode 100644 index 5c08a7d467..0000000000 --- a/reference/expect/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - &Functions; Expect -&reference.expect.entities.functions; - - - - diff --git a/reference/expect/setup.xml b/reference/expect/setup.xml deleted file mode 100644 index be541934f4..0000000000 --- a/reference/expect/setup.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - &reftitle.setup; - - -
- &reftitle.required; - - Ce module utilise les fonctions de la bibliothèque expect. - Il est nécessaire d'avoir la libexpect version >= 5.43.0. - -
- - - - &reference.expect.configure; - - - - &reference.expect.ini; - - - -
- &reftitle.resources; - - expect_popen retourne un flux ouvert PTY utilisé par la fonction - expect_expectl. - -
- - - - diff --git a/reference/fann/book.xml b/reference/fann/book.xml deleted file mode 100644 index 0e2eef0b96..0000000000 --- a/reference/fann/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - FANN (Réseau neuronal artificiel rapide - Fast Artificial Neural Network) - FANN - - - &reftitle.intro; - - Le support PHP pour la bibliothèque FANN (Fast Artificial Neural Network) qui implémente des réseaux - de neurones artificiels multicouches avec support pour les réseaux entièrement connectés et les réseaux - connectés de manière éparse. Il inclut un cadre pour la manipulation facile des ensembles de données - d'entraînement. Il est facile à utiliser, polyvalent, bien documenté et rapide. - - - - &reference.fann.setup; - &reference.fann.constants; - &reference.fann.examples; - &reference.fann.reference; - &reference.fann.fannconnection; - - - - diff --git a/reference/fann/configure.xml b/reference/fann/configure.xml deleted file mode 100644 index 0a8f565218..0000000000 --- a/reference/fann/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;fann - - - -
- - - diff --git a/reference/fann/constants.xml b/reference/fann/constants.xml deleted file mode 100644 index 43021e614f..0000000000 --- a/reference/fann/constants.xml +++ /dev/null @@ -1,617 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - Algorithmes d'entraînement - - - FANN_TRAIN_INCREMENTAL - (int) - - - - L'algorithme standard de rétropropagation, où les poids sont mis à jour après chaque motif d'entraînement. - Cela signifie que les poids sont mis à jour de nombreuses fois pendant une seule époque. Pour cette raison, - certains problèmes s'entraîneront très rapidement avec cet algorithme, tandis que d'autres problèmes plus avancés - ne s'entraîneront pas très bien. - - - - - - FANN_TRAIN_BATCH - (int) - - - - L'algorithme standard de rétropropagation, où les poids sont mis à jour après avoir calculé l'erreur quadratique - moyenne pour l'ensemble d'entraînement. Cela signifie que les poids ne sont mis à jour qu'une seule fois pendant - une époque. Pour cette raison, certains problèmes s'entraîneront plus lentement avec cet algorithme. Mais comme - l'erreur quadratique moyenne est calculée plus correctement que dans l'entraînement incrémentiel, certains problèmes - atteindront de meilleures solutions avec cet algorithme. - - - - - - FANN_TRAIN_RPROP - (int) - - - - Un algorithme d'entraînement par lots plus avancé qui donne de bons résultats pour de nombreux problèmes. L'algorithme - d'entraînement RPROP est adaptatif, et n'utilise donc pas le paramètre learning_rate. Cependant, certains autres paramètres - peuvent être définis pour changer la façon dont l'algorithme d'entraînement RPROP fonctionne, mais il est uniquement recommandé - pour les utilisateurs ayant une connaissance de la façon dont l'algorithme d'entraînement RPROP fonctionne. L'algorithme - d'entraînement RPROP est décrit par [Riedmiller et Braun, 1993], mais l'algorithme d'apprentissage réel utilisé ici est - l'algorithme d'entraînement iRPROP- décrit par [Igel et Husken, 2000] qui est une variété de l'algorithme d'entraînement RPROP standard. - - - - - - FANN_TRAIN_QUICKPROP - (int) - - - - Un algorithme d'entraînement par lots plus avancé qui donne de bons résultats pour de nombreux problèmes. L'algorithme - d'entraînement Quickprop utilise le paramètre learning_rate, ainsi que d'autres paramètres plus avancés, mais il est uniquement - recommandé de changer ces paramètres avancés pour les utilisateurs ayant une connaissance de la façon dont l'algorithme - d'entraînement Quickprop fonctionne. L'algorithme d'entraînement Quickprop est décrit par [Fahlman, 1988]. - - - - - - FANN_TRAIN_SARPROP - (int) - - - - Un algorithme d'entraînement encore plus avancé. Seulement pour la version 2.2. - - - - - - Fonctions d'activation - - - FANN_LINEAR - (int) - - - - Fonction d'activation linéaire. - - - - - - FANN_THRESHOLD - (int) - - - - Fonction d'activation de seuil. - - - - - - FANN_THRESHOLD_SYMMETRIC - (int) - - - - Fonction d'activation de seuil. - - - - - - FANN_SIGMOID - (int) - - - - Fonction d'activation sigmoïde. - - - - - - FANN_SIGMOID_STEPWISE - (int) - - - - Approximation linéaire par étapes de la sigmoïde. - - - - - - FANN_SIGMOID_SYMMETRIC - (int) - - - - Fonction d'activation sigmoïde symétrique, alias tanh. - - - - - - FANN_SIGMOID_SYMMETRIC_STEPWISE - (int) - - - - Approximation linéaire par étapes de la sigmoïde symétrique. - - - - - - FANN_GAUSSIAN - (int) - - - - Fonction d'activation gaussienne. - - - - - - FANN_GAUSSIAN_SYMMETRIC - (int) - - - - Fonction d'activation gaussienne symétrique. - - - - - - FANN_GAUSSIAN_STEPWISE - (int) - - - - Fonction d'activation gaussienne par étapes. - - - - - - FANN_ELLIOT - (int) - - - - Fonction d'activation rapide (sigmoïde) définie par David Elliott. - - - - - - FANN_ELLIOT_SYMMETRIC - (int) - - - - Fonction d'activation rapide (sigmoïde symétrique) définie par David Elliott. - - - - - - FANN_LINEAR_PIECE - (int) - - - - Fonction d'activation linéaire bornée. - - - - - - FANN_LINEAR_PIECE_SYMMETRIC - (int) - - - - Fonction d'activation linéaire bornée symétrique. - - - - - - FANN_SIN_SYMMETRIC - (int) - - - - Fonction d'activation sinus symétrique périodique. - - - - - - FANN_COS_SYMMETRIC - (int) - - - - Fonction d'activation cosinus symétrique périodique. - - - - - - FANN_SIN - (int) - - - - Fonction d'activation sinus périodique. - - - - - - FANN_COS - (int) - - - - Fonction d'activation cosinus périodique. - - - - - - Fonction d'erreur utilisée pendant l'entraînement - - - FANN_ERRORFUNC_LINEAR - (int) - - - - Fonction d'erreur linéaire standard. - - - - - - FANN_ERRORFUNC_TANH - (int) - - - - La fonction d'erreur tanh ; généralement meilleure mais peut nécessiter un taux d'apprentissage plus bas. Cette fonction - d'erreur cible agressivement les sorties qui diffèrent beaucoup de la sortie désirée, sans cibler les sorties qui ne diffèrent - que légèrement. Non recommandé pour l'entraînement en cascade ou incrémentiel. - - - - - - Critères d'arrêt utilisés lors de l'entraînement - - - FANN_STOPFUNC_MSE - (int) - - - - Les critères d'arrêt de la valeur de l'erreur quadratique moyenne (MSE). - - - - - - FANN_STOPFUNC_BIT - (int) - - - - Les critères d'arrêt du nombre de bits qui échouent. Le nombre de bits signifie le nombre de neurones de sortie qui diffèrent - de plus que la limite de défaillance de bits (voir fann_get_bit_fail_limit, fann_set_bit_fail_limit). Les bits sont comptés - dans toutes les données d'entraînement, donc ce nombre peut être plus élevé que le nombre de données d'entraînement. - - - - - - Définition des types de réseau utilisés par <function>fann_get_network_type</function> - - - FANN_NETTYPE_LAYER - (int) - - - - Chaque couche n'a de connexions qu'à la couche suivante. - - - - - - FANN_NETTYPE_SHORTCUT - (int) - - - - Chaque couche a des connexions à toutes les couches suivantes. - - - - - - Erreurs - - - FANN_E_NO_ERROR - (int) - - - - Pas d'erreur. - - - - - - FANN_E_CANT_OPEN_CONFIG_R - (int) - - - - Impossible d'ouvrir le fichier de configuration en lecture. - - - - - - FANN_E_CANT_OPEN_CONFIG_W - (int) - - - - Impossible d'ouvrir le fichier de configuration en écriture. - - - - - - FANN_E_WRONG_CONFIG_VERSION - (int) - - - - Mauvaise version du fichier de configuration. - - - - - - FANN_E_CANT_READ_CONFIG - (int) - - - - Erreur de lecture des informations du fichier de configuration. - - - - - - FANN_E_CANT_READ_NEURON - (int) - - - - Erreur de lecture des informations du neurone du fichier de configuration. - - - - - - FANN_E_CANT_READ_CONNECTIONS - (int) - - - - Erreur de lecture des connexions du fichier de configuration. - - - - - - FANN_E_WRONG_NUM_CONNECTIONS - (int) - - - - Le nombre de connexions n'est pas égal au nombre attendu. - - - - - - FANN_E_CANT_OPEN_TD_W - (int) - - - - Impossible d'ouvrir le fichier de données d'entraînement en écriture. - - - - - - FANN_E_CANT_OPEN_TD_R - (int) - - - - Impossible d'ouvrir le fichier de données d'entraînement en lecture. - - - - - - FANN_E_CANT_READ_TD - (int) - - - - Erreur de lecture des données d'entraînement du fichier. - - - - - - FANN_E_CANT_ALLOCATE_MEM - (int) - - - - Impossible d'allouer de la mémoire. - - - - - - FANN_E_CANT_TRAIN_ACTIVATION - (int) - - - - Impossible d'entraîner avec la fonction d'activation sélectionnée. - - - - - - FANN_E_CANT_USE_ACTIVATION - (int) - - - - Impossible d'utiliser la fonction d'activation sélectionnée. - - - - - - FANN_E_TRAIN_DATA_MISMATCH - (int) - - - - Différences irréconciliables entre deux structures fann_train_data. - - - - - - FANN_E_CANT_USE_TRAIN_ALG - (int) - - - - Impossible d'utiliser l'algorithme d'entraînement sélectionné. - - - - - - FANN_E_TRAIN_DATA_SUBSET - (int) - - - - Tentative de prendre un sous-ensemble qui n'est pas dans l'ensemble d'entraînement. - - - - - - FANN_E_INDEX_OUT_OF_BOUND - (int) - - - - L'index est hors limite. - - - - - - FANN_E_SCALE_NOT_PRESENT - (int) - - - - Les paramètres de mise à l'échelle ne sont pas présents. - - - - - - FANN_E_INPUT_NO_MATCH - (int) - - - - Le nombre de neurones d'entrée dans l'ann et les données ne correspondent pas. - - - - - - FANN_E_OUTPUT_NO_MATCH - (int) - - - - Le nombre de neurones de sortie dans l'ann et les données ne correspondent pas. - - - - - - - - diff --git a/reference/fann/examples.xml b/reference/fann/examples.xml deleted file mode 100644 index 382a025e28..0000000000 --- a/reference/fann/examples.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - &reftitle.examples; -
- Entraînement XOR - - Cet exemple montre comment entraîner des données pour la fonction XOR - - Fichier xor.data - - - - - - Entraînement simple - - -]]> - - - - - Cet exemple montre comment lire et exécuter des données pour la fonction XOR - - Test simple - - %f\n", $input[0], $input[1], $calc_out[0]); -fann_destroy($ann); -?> -]]> - - - -
- diff --git a/reference/fann/fannconnection.xml b/reference/fann/fannconnection.xml deleted file mode 100644 index b420dd24d7..0000000000 --- a/reference/fann/fannconnection.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - La classe FANNConnection - FANNConnection - - - - -
- &reftitle.intro; - - FANNConnection est utilisée pour la connexion du réseau de neurones. - Les objets de cette classe sont utilisés dans fann_get_connection_array et fann_set_weight_array. - -
- - -
- &reftitle.classsynopsis; - - - - FANNConnection - - - - - FANNConnection - - - - &Properties; - - public - from_neuron - - - public - to_neuron - - - public - weight - - - - &Methods; - - - - - - - - - -
- - - -
- &reftitle.properties; - - - from_neuron - - Le neurone où la connexion commence. - - - - to_neuron - - Le neurone où la connexion se termine. - - - - weight - - Le poids de la connexion. - - - -
- - - - - - &reference.fann.entities.fannconnection; - - - - diff --git a/reference/fann/fannconnection/construct.xml b/reference/fann/fannconnection/construct.xml deleted file mode 100644 index 64c2cae1d3..0000000000 --- a/reference/fann/fannconnection/construct.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - FANNConnection::__construct - Le constructeur de connexion - - - - &reftitle.description; - - public FANNConnection::__construct - intfrom_neuron - intto_neuron - floatweight - - - Crée une nouvelle connexion et initialise ses paramètres. - Après avoir créé la connexion, seul le poids peut être modifié. - - - - - &reftitle.parameters; - - - from_neuron - - - Le numéro de la position du neurone de départ. - - - - - to_neuron - - - Le numéro de la position du neurone de fin. - - - - - weight - - - La valeur de poids de la connexion. - - - - - - - - diff --git a/reference/fann/fannconnection/getfromneuron.xml b/reference/fann/fannconnection/getfromneuron.xml deleted file mode 100644 index 3c97fd8c5f..0000000000 --- a/reference/fann/fannconnection/getfromneuron.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - FANNConnection::getFromNeuron - Retourne la position du neurone de départ - - - - &reftitle.description; - - public intFANNConnection::getFromNeuron - - - - Retourne la position du neurone de départ. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La position du neurone de départ. - - - - - - - diff --git a/reference/fann/fannconnection/gettoneuron.xml b/reference/fann/fannconnection/gettoneuron.xml deleted file mode 100644 index 01bb3e27e9..0000000000 --- a/reference/fann/fannconnection/gettoneuron.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - FANNConnection::getToNeuron - Retourne la position du neurone de fin - - - - &reftitle.description; - - public intFANNConnection::getToNeuron - - - - Retourne la position du neurone de fin. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La position du neurone de fin. - - - - - - - diff --git a/reference/fann/fannconnection/getweight.xml b/reference/fann/fannconnection/getweight.xml deleted file mode 100644 index b5c41ca43b..0000000000 --- a/reference/fann/fannconnection/getweight.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - FANNConnection::getWeight - Retourne le poids de la connexion - - - - &reftitle.description; - - public voidFANNConnection::getWeight - - - - Retourne le poids de la connexion. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le poids de la connexion. - - - - - - - diff --git a/reference/fann/fannconnection/setweight.xml b/reference/fann/fannconnection/setweight.xml deleted file mode 100644 index 725f371ae7..0000000000 --- a/reference/fann/fannconnection/setweight.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - FANNConnection::setWeight - Définit le poids de la connexion - - - - &reftitle.description; - - public voidFANNConnection::setWeight - floatweight - - - Définit le poids de la connexion. - - - Cette méthode est différente de la fonction fann_set_weight. - Elle ne met pas à jour la valeur du poids sur le réseau. La valeur du réseau - est mise à jour seulement après l'appel à la fonction - fann_set_weight_array. - - - - - &reftitle.parameters; - - - - weight - - - Le poids de la connexion. - - - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - - - diff --git a/reference/fann/functions/fann-cascadetrain-on-data.xml b/reference/fann/functions/fann-cascadetrain-on-data.xml deleted file mode 100644 index 87e3757ac0..0000000000 --- a/reference/fann/functions/fann-cascadetrain-on-data.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - fann_cascadetrain_on_data - Entraîne un réseau de neurones sur un ensemble de données entier, pour une période de temps en utilisant l'algorithme d'entraînement Cascade2 - - - - &reftitle.description; - - boolfann_cascadetrain_on_data - resourceann - resourcedata - intmax_neurons - intneurons_between_reports - floatdesired_error - - - La fraction de changement de sortie en cascade est un nombre compris entre 0 et 1 déterminant quelle fraction - la valeur de fann_get_MSE devrait changer dans fann_get_cascade_output_stagnation_epochs - pendant l'entraînement des connexions de sortie, afin que l'entraînement ne stagne pas. Si l'entraînement stagne, - l'entraînement des connexions de sortie sera terminé et de nouveaux candidats seront préparés. - - - Cet entraînement utilise les paramètres définis en utilisant les fonctions fann_set_cascade_..., - mais il utilise également un autre algorithme d'entraînement comme algorithme d'entraînement interne. Cet algorithme - peut être défini sur FANN_TRAIN_RPROP ou FANN_TRAIN_QUICKPROP par - fann_set_training_algorithm, et les paramètres définis pour ces algorithmes d'entraînement - affecteront également l'entraînement en cascade. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - data - - &fann.train.description; - - - - max_neurons - - - Le nombre maximum de neurones à ajouter au réseau de neurones. - - - - - neurons_between_reports - - - Le nombre de neurones entre l'impression d'un rapport d'état. Une valeur de zéro signifie qu'aucun rapport ne devrait être affiché. - - - - - desired_error - - - La fann_get_MSE ou fann_get_bit_fail désirée, - selon la fonction d'arrêt choisie par fann_set_train_stop_function - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_cascadetrain_on_file - - - - - - - - diff --git a/reference/fann/functions/fann-cascadetrain-on-file.xml b/reference/fann/functions/fann-cascadetrain-on-file.xml deleted file mode 100644 index bd6efcbbed..0000000000 --- a/reference/fann/functions/fann-cascadetrain-on-file.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - fann_cascadetrain_on_file - Entraîne un réseau de neurones sur un ensemble de données entier, pour une période de temps en utilisant l'algorithme d'entraînement Cascade2 - - - - &reftitle.description; - - boolfann_cascadetrain_on_file - resourceann - stringfilename - intmax_neurons - intneurons_between_reports - floatdesired_error - - - Fait la même chose que fann_cascadetrain_on_data, mais lit les données d'entraînement directement à partir d'un fichier. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - filename - - - Un fichier contenant les données pour l'entraînement. - - - - - max_neurons - - - Le nombre maximum de neurones à ajouter au réseau de neurones. - - - - - neurons_between_reports - - - Le nombre de neurones entre l'impression d'un rapport d'état. Une valeur de zéro signifie qu'aucun rapport ne devrait être affiché. - - - - - desired_error - - - La fann_get_MSE ou fann_get_bit_fail désirée, - selon la fonction d'arrêt choisie par fann_set_train_stop_function. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_cascadetrain_on_data - - - - - - - - diff --git a/reference/fann/functions/fann-clear-scaling-params.xml b/reference/fann/functions/fann-clear-scaling-params.xml deleted file mode 100644 index 4f7907f217..0000000000 --- a/reference/fann/functions/fann-clear-scaling-params.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - fann_clear_scaling_params - Efface les paramètres de mise à l'échelle - - - - &reftitle.description; - - boolfann_clear_scaling_params - resourceann - - - Efface les paramètres de mise à l'échelle. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - diff --git a/reference/fann/functions/fann-copy.xml b/reference/fann/functions/fann-copy.xml deleted file mode 100644 index 6fc17d25ac..0000000000 --- a/reference/fann/functions/fann-copy.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - fann_copy - Crée une copie d'une structure fann - - - - &reftitle.description; - - resourcefann_copy - resourceann - - - Crée une copie d'une structure fann. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Retourne une copie du réseau de neurones en cas de succès, ou &false; - si une erreur survient. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_test - - - - - - - diff --git a/reference/fann/functions/fann-create-from-file.xml b/reference/fann/functions/fann-create-from-file.xml deleted file mode 100644 index 34a69afb47..0000000000 --- a/reference/fann/functions/fann-create-from-file.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - fann_create_from_file - Construit un réseau de neurones de rétropropagation à partir d'un fichier - de configuration - - - - &reftitle.description; - - resourcefann_create_from_file - stringconfiguration_file - - - Construit un réseau de neurones de rétropropagation à partir d'un fichier - de configuration, qui a été sauvegardé par la fonction fann_save. - - - - - &reftitle.parameters; - - - configuration_file - - - Le chemin vers le fichier de configuration. - - - - - - - - &reftitle.returnvalues; - &fann.return.ann; - - - - &reftitle.seealso; - - - fann_save - - - - - - - - diff --git a/reference/fann/functions/fann-create-shortcut-array.xml b/reference/fann/functions/fann-create-shortcut-array.xml deleted file mode 100644 index c936d34b83..0000000000 --- a/reference/fann/functions/fann-create-shortcut-array.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - - fann_create_shortcut_array - Crée un réseau de neurones de rétropropagation standard - qui n'est pas totalement connecté, et a des connexions raccourcies - - - - &reftitle.description; - - resourcefann_create_shortcut_array - intnum_layers - arraylayers - - - Crée un réseau de neurones de rétropropagation standard - qui n'est pas totalement connecté, et a des connexions raccourcies - en utilisant un tableau de tailles de couches. - - - - - &reftitle.parameters; - - - num_layers - - - Le nombre total de couches, incluant les couches d'entrée et de sortie. - - - - - layers - - - Un tableau de tailles de couches. - - - - - - - - &reftitle.returnvalues; - - Retourne une ressource représentant le réseau de neurones en cas de succès, - ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_create_shortcut - fann_create_sparse - fann_create_standard - - - - - - - diff --git a/reference/fann/functions/fann-create-shortcut.xml b/reference/fann/functions/fann-create-shortcut.xml deleted file mode 100644 index 54f8bb7a7e..0000000000 --- a/reference/fann/functions/fann-create-shortcut.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - fann_create_shortcut - Créer un réseau de neurones de rétropropagation standard qui n'est pas entièrement connecté et qui a des connexions de raccourci - - - - &reftitle.description; - - resourcefann_create_shortcut - intnum_layers - intnum_neurons1 - intnum_neurons2 - intnum_neuronsN - - - Crée un réseau de neurones de rétropropagation standard qui n'est pas entièrement connecté et qui a des connexions de raccourci. - - - Les connexions de raccourci sont des connexions qui sautent des couches. Un réseau entièrement connecté avec des connexions de raccourci, est un réseau - dans lequel tous les neurones sont connectés à tous les neurones des couches ultérieures. Y compris des connexions directes de la couche d'entrée à la couche de sortie. - - - - - &reftitle.parameters; - - - num_layers - - - Le nombre total de couches, y compris la couche d'entrée et la couche de sortie. - - - - - num_neurons1 - - - Le nombre de neurones dans la première couche. - - - - - num_neurons2 - - - Le nombre de neurones dans la deuxième couche. - - - - - num_neuronsN - - - Le nombre de neurones dans les autres couches. - - - - - - - - &reftitle.returnvalues; - - Renvoie une ressource de réseau de neurones en cas de succès, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_create_shortcut_array - fann_create_sparse - fann_create_standard - - - - - - - diff --git a/reference/fann/functions/fann-create-sparse-array.xml b/reference/fann/functions/fann-create-sparse-array.xml deleted file mode 100644 index f6c05e5c32..0000000000 --- a/reference/fann/functions/fann-create-sparse-array.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - fann_create_sparse_array - Créer un réseau de neurones de rétropropagation standard qui n'est pas entièrement connecté en utilisant un tableau de tailles de couche - - - - &reftitle.description; - - resourcefann_create_sparse_array - floatconnection_rate - intnum_layers - arraylayers - - - Crée un réseau de neurones de rétropropagation standard qui n'est pas entièrement connecté en utilisant un tableau de tailles de couche. - - - - - &reftitle.parameters; - - - connection_rate - - - Le taux de connexion contrôle combien de connexions il y aura dans le réseau. Si le taux de connexion - est défini à 1, le réseau sera entièrement connecté, mais s'il est défini à 0.5 seulement la moitié des connexions - seront définies. Un taux de connexion de 1 donnera le même résultat que fann_create_standard. - - - - - num_layers - - - Le nombre total de couches, y compris la couche d'entrée et la couche de sortie. - - - - - layers - - - Un tableau de tailles de couche. - - - - - - - - &reftitle.returnvalues; - - Renvoie un réseau de neurones en cas de succès, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_create_sparse - fann_create_standard - fann_create_shortcut - - - - - - - diff --git a/reference/fann/functions/fann-create-sparse.xml b/reference/fann/functions/fann-create-sparse.xml deleted file mode 100644 index 18665b7eaa..0000000000 --- a/reference/fann/functions/fann-create-sparse.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - fann_create_sparse - Créer un réseau de neurones de rétropropagation standard qui n'est pas entièrement connecté - - - - &reftitle.description; - - resourcefann_create_sparse - floatconnection_rate - intnum_layers - intnum_neurons1 - intnum_neurons2 - intnum_neuronsN - - - Crée un réseau de neurones de rétropropagation standard qui n'est pas entièrement connecté. - - - - - &reftitle.parameters; - - - connection_rate - - - Le taux de connexion contrôle combien de connexions il y aura dans le réseau. Si le taux de connexion - est défini à 1, le réseau sera entièrement connecté, mais s'il est défini à 0.5 seulement la moitié des connexions - seront définies. Un taux de connexion de 1 donnera le même résultat que fann_create_standard. - - - - - num_layers - - - Le nombre total de couches, y compris la couche d'entrée et la couche de sortie. - - - - - num_neurons1 - - - Le nombre de neurones dans la première couche. - - - - - num_neurons2 - - - Le nombre de neurones dans la deuxième couche. - - - - - num_neuronsN - - - Le nombre de neurones dans les autres couches. - - - - - - - - &reftitle.returnvalues; - - Renvoie un réseau de neurones en cas de succès, ou &false; en cas d'erreur. - - - - - - &reftitle.seealso; - - - fann_create_sparse_array - fann_create_standard - fann_create_shortcut - - - - - - - diff --git a/reference/fann/functions/fann-create-standard-array.xml b/reference/fann/functions/fann-create-standard-array.xml deleted file mode 100644 index 31cc637a66..0000000000 --- a/reference/fann/functions/fann-create-standard-array.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - fann_create_standard_array - Créer un réseau de neurones de rétropropagation standard en utilisant un tableau de tailles de couche - - - - &reftitle.description; - - resourcefann_create_standard_array - intnum_layers - arraylayers - - - Crée un réseau de neurones de rétropropagation standard totalement connecté. - - - Il y aura un neurone de biais dans chaque couche (sauf la couche de sortie), - et ce neurone de biais sera connecté à tous les neurones de la couche suivante. - Lors de l'exécution du réseau, les neurones de biais émettent toujours 1. - - - Pour détruire un réseau de neurones, utiliser la fonction fann_destroy. - - - - - &reftitle.parameters; - - - num_layers - - - Le nombre total de couches, y compris la couche d'entrée et la couche de sortie. - - - - - layers - - - Un tableau de tailles de couche. - - - - - - - - &reftitle.returnvalues; - - Renvoie un réseau de neurones en cas de succès, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_create_standard - fann_create_sparse - fann_create_shortcut - - - - - - - diff --git a/reference/fann/functions/fann-create-standard.xml b/reference/fann/functions/fann-create-standard.xml deleted file mode 100644 index e2f3508e3c..0000000000 --- a/reference/fann/functions/fann-create-standard.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - fann_create_standard - Créer un réseau de neurones de rétropropagation standard totalement connecté - - - - &reftitle.description; - - resourcefann_create_standard - intnum_layers - intnum_neurons1 - intnum_neurons2 - intnum_neuronsN - - - Crée un réseau de neurones de rétropropagation standard totalement connecté. - - - Il y aura un neurone de biais dans chaque couche (sauf la couche de sortie), - et ce neurone de biais sera connecté à tous les neurones de la couche suivante. - Lors de l'exécution du réseau, les neurones de biais émettent toujours 1. - - - Pour détruire un réseau de neurones, il convient d'utiliser la fonction fann_destroy. - - - - - &reftitle.parameters; - - - num_layers - - - Le nombre total de couches, y compris la couche d'entrée et la couche de sortie. - - - - - num_neurons1 - - - Le nombre de neurones dans la première couche. - - - - - num_neurons2 - - - Le nombre de neurones dans la deuxième couche. - - - - - num_neuronsN - - - Le nombre de neurones dans les autres couches. - - - - - - - - &reftitle.returnvalues; - - Renvoie un réseau de neurones en cas de succès, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_create_standard_array - fann_create_sparse - fann_create_shortcut - - - - - - - diff --git a/reference/fann/functions/fann-create-train-from-callback.xml b/reference/fann/functions/fann-create-train-from-callback.xml deleted file mode 100644 index 1d7d4916ea..0000000000 --- a/reference/fann/functions/fann-create-train-from-callback.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - - fann_create_train_from_callback - Crée la structure de données d'entraînement depuis une fonction - fournie par l'utilisateur - - - - &reftitle.description; - - resourcefann_create_train_from_callback - intnum_data - intnum_input - intnum_output - callableuser_function - - - Crée la structure de données d'entraînement depuis une fonction - fournie par l'utilisateur. Sachant que les données d'entraînement - sont numérotées (donnée 1, donnée 2...), l'utilisateur doit écrire - une fonction qui reçoit le numéro du jeu de données d'entraînement - (d'entrée et de sortie) et elle doit retourner le jeu. - - - - - &reftitle.parameters; - - - num_data - - - Le nombre de données d'entraînement - - - - - num_input - - - Le nombre d'entrées par données d'entraînement - - - - - num_output - - - Le nombre de sorties par données d'entraînement - - - - - user_function - - - La fonction fournie par l'utilisateur doit avoir les paramètres suivants : - - - num - Le nombre de données d'entraînement - - - num_input - Le nombre d'entrées par données - d'entraînement - - - num_output - Le nombre de sorties par données d'entraînement - - - - - La fonction devrait retourner un tableau associatif avec les clés - input et output et deux - valeurs de tableaux pour les entrées et les sorties. - - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - &reftitle.examples; - - - Exemple avec <methodname>fann_create_train_from_callback</methodname> - - array_fill(0, $num_input, 1), - "output" => array_fill(0, $num_output, 1), - ); -} - -$num_data = 3; -$num_input = 2; -$num_output = 1; -$train_data = fann_create_train_from_callback($num_data, $num_input, $num_output, "create_train_callback"); -if ($train_data) { - // Faire quelque chose avec $train_data -} -?> -]]> - - - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_read_train_from_file - fann_train_on_data - fann_destroy_train - fann_save_train - - - - - - - - diff --git a/reference/fann/functions/fann-create-train.xml b/reference/fann/functions/fann-create-train.xml deleted file mode 100644 index af967e90a2..0000000000 --- a/reference/fann/functions/fann-create-train.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - fann_create_train - Crée une structure vide de données d'entraînement - - - - &reftitle.description; - - resourcefann_create_train - intnum_data - intnum_input - intnum_output - - - Crée une structure vide de données d'entraînement. - - - - - &reftitle.parameters; - - - num_data - - - Le nombre de données d'entraînement - - - - - num_input - - - Le nombre d'entrées par données d'entraînement - - - - - num_output - - - Le nombre de sorties par données d'entraînement - - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_read_train_from_file - fann_train_on_data - fann_destroy_train - fann_save_train - - - - - - - - diff --git a/reference/fann/functions/fann-descale-input.xml b/reference/fann/functions/fann-descale-input.xml deleted file mode 100644 index 509ce462c9..0000000000 --- a/reference/fann/functions/fann-descale-input.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_descale_input - Dimensionne les données dans le vecteur d'entrée après les avoir obtenues de ann en fonction des paramètres précédemment calculés - - - - &reftitle.description; - - boolfann_descale_input - resourceann - arrayinput_vector - - - Dimensionne les données dans le vecteur d'entrée après les avoir obtenues de ann en fonction des paramètres précédemment calculés. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input_vector - - - Vecteur d'entrée dont l'échelle sera inversée - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_input - fann_descale_output - - - - - - - - diff --git a/reference/fann/functions/fann-descale-output.xml b/reference/fann/functions/fann-descale-output.xml deleted file mode 100644 index 746bad0d6d..0000000000 --- a/reference/fann/functions/fann-descale-output.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_descale_output - Dimensionne les données dans le vecteur de sortie après les avoir obtenues de ann en fonction des paramètres précédemment calculés - - - - &reftitle.description; - - boolfann_descale_output - resourceann - arrayoutput_vector - - - Dimensionne les données dans le vecteur de sortie après les avoir obtenues de ann en fonction des paramètres précédemment calculés. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - output_vector - - - Vecteur de sortie dont l'échelle sera inversée - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_output - fann_descale_input - - - - - - - - diff --git a/reference/fann/functions/fann-descale-train.xml b/reference/fann/functions/fann-descale-train.xml deleted file mode 100644 index 141f29a6a0..0000000000 --- a/reference/fann/functions/fann-descale-train.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - fann_descale_train - Inverse l'échelle des données d'entrée et de sortie en fonction des paramètres calculés précédemment - - - - &reftitle.description; - - boolfann_descale_train - resourceann - resourcetrain_data - - - Inverse l'échelle des données d'entrée et de sortie en fonction des paramètres calculés précédemment. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_train - fann_set_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-destroy-train.xml b/reference/fann/functions/fann-destroy-train.xml deleted file mode 100644 index ae7ffcd09b..0000000000 --- a/reference/fann/functions/fann-destroy-train.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - fann_destroy_train - Détruit les données d'entraînement - - - - &reftitle.description; - - boolfann_destroy_train - resourcetrain_data - - - Détruit les données d'entraînement. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - diff --git a/reference/fann/functions/fann-destroy.xml b/reference/fann/functions/fann-destroy.xml deleted file mode 100644 index 373e5bc8e1..0000000000 --- a/reference/fann/functions/fann-destroy.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - fann_destroy - Détruit le réseau en entier, et libère proprement toute la mémoire associée - - - - &reftitle.description; - - boolfann_destroy - resourceann - - - Détruit le réseau en entier, et libère proprement toute la mémoire associée. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - - diff --git a/reference/fann/functions/fann-duplicate-train-data.xml b/reference/fann/functions/fann-duplicate-train-data.xml deleted file mode 100644 index 9885e366da..0000000000 --- a/reference/fann/functions/fann-duplicate-train-data.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - fann_duplicate_train_data - Retourne une copie exacte des données d'entraînement fann - - - - &reftitle.description; - - resourcefann_duplicate_train_data - resourcedata - - - Retourne une copie exacte des données d'entraînement fann, sous la - forme d'une ressource. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - - diff --git a/reference/fann/functions/fann-get-activation-function.xml b/reference/fann/functions/fann-get-activation-function.xml deleted file mode 100644 index 740a8db041..0000000000 --- a/reference/fann/functions/fann-get-activation-function.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - fann_get_activation_function - Renvoie la fonction d'activation - - - - &reftitle.description; - - intfann_get_activation_function - resourceann - intlayer - intneuron - - - Renvoie la fonction d'activation pour le neurone numéro neuron dans la couche numéro - layer, en comptant la couche d'entrée comme la couche 0. - - - Il n'est pas possible d'obtenir les fonctions d'activation pour les neurones de la couche d'entrée. - - - La valeur de retour est une des constantes de fonctions d'activation. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - layer - - - Numéro de la couche. - - - - - neuron - - - Numéro du neurone. - - - - - - - - &reftitle.returnvalues; - - Une constante de fonctions d'activation ou -1 - si le neurone n'est pas défini dans le réseau de neurones, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_activation_function_layer - fann_set_activation_function_hidden - fann_set_activation_function_output - fann_set_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-get-activation-steepness.xml b/reference/fann/functions/fann-get-activation-steepness.xml deleted file mode 100644 index a85fa923e4..0000000000 --- a/reference/fann/functions/fann-get-activation-steepness.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - fann_get_activation_steepness - Renvoie la raideur d'activation pour le neurone et le numéro de couche fournis - - - - &reftitle.description; - - floatfann_get_activation_steepness - resourceann - intlayer - intneuron - - - Obtenir la raideur d'activation pour le neurone numéro neuron dans la couche numéro - layer, en comptant la couche d'entrée comme la couche 0. - - - Il n'est pas possible d'obtenir la raideur d'activation pour les neurones de la couche d'entrée. - - - La raideur d'une fonction d'activation dit quelque chose sur la rapidité avec laquelle la fonction d'activation passe - du minimum au maximum. Une valeur élevée pour la fonction d'activation donnera également un entraînement plus agressif. - - - Lors de l'entraînement des réseaux de neurones où les valeurs de sortie devraient être aux extrêmes - (généralement 0 et 1, selon la fonction d'activation), une fonction d'activation raide peut être utilisée (par exemple 1.0). - - - La raideur d'activation par défaut est de 0.5. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - layer - - - Le numéro de couche - - - - - neuron - - - Le numéro de neurone - - - - - - - - &reftitle.returnvalues; - - La raideur d'activation pour le neurone ou -1 si le neurone n'est pas défini dans le réseau de neurones, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_activation_function - fann_set_activation_steepness_layer - fann_set_activation_steepness_hidden - fann_set_activation_steepness_output - fann_set_activation_steepness - - - - - - - - diff --git a/reference/fann/functions/fann-get-bias-array.xml b/reference/fann/functions/fann-get-bias-array.xml deleted file mode 100644 index ec6a6e49f9..0000000000 --- a/reference/fann/functions/fann-get-bias-array.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - fann_get_bias_array - Renvoie le nombre de biais dans chaque couche du réseau - - - - &reftitle.description; - - arrayfann_get_bias_array - resourceann - - - Renvoie le nombre de biais dans chaque couche du réseau. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Un tableau de nombres de biais dans chaque couche. - - - - - - - diff --git a/reference/fann/functions/fann-get-bit-fail-limit.xml b/reference/fann/functions/fann-get-bit-fail-limit.xml deleted file mode 100644 index a7a28c2ea8..0000000000 --- a/reference/fann/functions/fann-get-bit-fail-limit.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - fann_get_bit_fail_limit - Renvoie la limite d'échec de bit utilisée pendant l'entraînement - - - - &reftitle.description; - - floatfann_get_bit_fail_limit - resourceann - - - Renvoie la limite d'échec de bit utilisée pendant l'entraînement. - - - La limite du nombre d'échecs de bit est utilisée pendant l'entraînement lorsque la fonction d'arrêt - est définie sur FANN_STOPFUNC_BIT. - - - La limite est la différence maximale acceptée entre la sortie désirée et la sortie réelle pendant l'entraînement. - Chaque sortie qui diverge de plus que cette limite est comptée comme un échec de bit. Cette différence est divisée par deux - lorsqu'il s'agit de fonctions d'activation symétriques, de sorte que les fonctions d'activation symétriques et non symétriques - peuvent utiliser la même limite. - - - La limite d'échec de bit par défaut est de 0.35. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La limite d'échec de bit, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_bit_fail_limit - - - - - - - - diff --git a/reference/fann/functions/fann-get-bit-fail.xml b/reference/fann/functions/fann-get-bit-fail.xml deleted file mode 100644 index 29ed9394be..0000000000 --- a/reference/fann/functions/fann-get-bit-fail.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - fann_get_bit_fail - Le nombre de bits échoués - - - - &reftitle.description; - - intfann_get_bit_fail - resourceann - - - Le nombre de bits échoués; signifie le nombre de neurones de sortie qui diffèrent de plus que la limite de bits échoués - (voir fann_get_bit_fail_limit, fann_set_bit_fail_limit). - Les bits sont comptés dans toutes les données d'entraînement, donc ce nombre peut être plus élevé que le nombre de données d'entraînement. - - - Cette valeur est réinitialisée par fann_reset_MSE et mise à jour par toutes les mêmes fonctions - qui mettent également à jour la valeur MSE (par exemple fann_test_data, fann_train_epoch) - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre de bits échoués, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_get_MSE - fann_reset_MSE - fann_test_data - fann_train_epoch - fann_get_bit_fail_limit - fann_set_bit_fail_limit - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-activation-functions-count.xml b/reference/fann/functions/fann-get-cascade-activation-functions-count.xml deleted file mode 100644 index d8c524ca84..0000000000 --- a/reference/fann/functions/fann-get-cascade-activation-functions-count.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_cascade_activation_functions_count - Renvoie le nombre de fonctions d'activation en cascade - - - - &reftitle.description; - - intfann_get_cascade_activation_functions_count - resourceann - - - Le nombre de fonctions d'activation dans le tableau fann_get_cascade_activation_functions. - - - Le nombre par défaut de fonctions d'activation est 6. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre de fonctions d'activation en cascade, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_functions - fann_set_cascade_activation_functions - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-activation-functions.xml b/reference/fann/functions/fann-get-cascade-activation-functions.xml deleted file mode 100644 index ad0e18a251..0000000000 --- a/reference/fann/functions/fann-get-cascade-activation-functions.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - fann_get_cascade_activation_functions - Renvoie les fonctions d'activation en cascade - - - - &reftitle.description; - - arrayfann_get_cascade_activation_functions - resourceann - - - Le tableau des fonctions d'activation en cascade est un tableau des différentes fonctions d'activation utilisées par les candidats. - - - Voir fann_get_cascade_num_candidates pour une description des neurones candidats qui seront générés par ce tableau. - - - Les fonctions d'activations par défaut sont FANN_SIGMOID, FANN_SIGMOID_SYMMETRIC, - FANN_GAUSSIAN, FANN_GAUSSIAN_SYMMETRIC, FANN_ELLIOT, - FANN_ELLIOT_SYMMETRIC. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le tableau des fonctions d'activation en cascade, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_functions_count - fann_set_cascade_activation_functions - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml b/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml deleted file mode 100644 index d915175d55..0000000000 --- a/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_cascade_activation_steepnesses_count - Le nombre de raideurs d'activation - - - - &reftitle.description; - - intfann_get_cascade_activation_steepnesses_count - resourceann - - - Le nombre de raideurs d'activation dans le tableau fann_get_cascade_activation_steepnesses. - - - Le nombre par défaut de raideurs d'activation est 4. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre de raideurs d'activation, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_steepnesses - fann_set_cascade_activation_functions - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml b/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml deleted file mode 100644 index dae77bc81e..0000000000 --- a/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_get_cascade_activation_steepnesses - Renvoie les raideurs d'activation en cascade - - - - &reftitle.description; - - arrayfann_get_cascade_activation_steepnesses - resourceann - - - Les raideurs d'activation en cascade sont un tableau des différentes fonctions d'activation utilisées par les candidats. - - - Voir fann_get_cascade_num_candidates pour une description des neurones candidats qui seront générés par ce tableau. - - - Les raideurs d'activations par défaut sont {0.25, 0.50, 0.75, 1.00}. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Les raideurs d'activation en cascade, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_steepnesses_count - fann_set_cascade_activation_steepnesses - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml b/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml deleted file mode 100644 index 7ca2ac1de4..0000000000 --- a/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - fann_get_cascade_candidate_change_fraction - Renvoie la fraction de changement de candidat en cascade - - - - &reftitle.description; - - floatfann_get_cascade_candidate_change_fraction - resourceann - - - La fraction de changement de candidat en cascade est un nombre entre 0 et 1 déterminant quelle fraction la valeur de fann_get_MSE - devrait changer dans fann_get_cascade_candidate_stagnation_epochs pendant l'entraînement des neurones candidats, - pour que l'entraînement ne stagne pas. Si l'entraînement stagne, l'entraînement des neurones candidats sera arrêté - et le meilleur candidat sera sélectionné. - - - Cela signifie que si le MSE ne change pas d'une fraction de fann_get_cascade_candidate_change_fraction pendant - une période de fann_get_cascade_candidate_stagnation_epochs, l'entraînement des neurones candidats est arrêté - car l'entraînement a stagné. - - - Si la fraction de changement de candidat en cascade est faible, les neurones candidats seront entraînés davantage et si la fraction est élevée, ils seront moins entraînés. - - - La fraction de changement de candidat en cascade par défaut est de 0.01, ce qui est équivalent à un changement de 1% dans le MSE. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La fraction de changement de candidat en cascade, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_cascade_candidate_change_fraction - fann_get_MSE - fann_get_cascade_candidate_stagnation_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-candidate-limit.xml b/reference/fann/functions/fann-get-cascade-candidate-limit.xml deleted file mode 100644 index dc778083d3..0000000000 --- a/reference/fann/functions/fann-get-cascade-candidate-limit.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_get_cascade_candidate_limit - Renvoie la limite de candidat - - - - &reftitle.description; - - floatfann_get_cascade_candidate_limit - resourceann - - - La limite de candidat est une limite pour combien le neurone candidat peut être entraîné. La limite est une limite - sur la proportion entre le MSE et le score du candidat. - - - Changer cela pour une valeur plus basse peut aider à éviter le surapprentissage et pour une valeur plus haute si le surapprentissage n'est pas un problème. - - - La limite de candidat par défaut est de 1000.0. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La limite de candidat, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_cascade_candidate_limit - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml b/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml deleted file mode 100644 index 77bc371b55..0000000000 --- a/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_get_cascade_candidate_stagnation_epochs - Renvoie le nombre d'époques de stagnation des candidats en cascade - - - - &reftitle.description; - - intfann_get_cascade_candidate_stagnation_epochs - resourceann - - - Le nombre d'époques de stagnation des candidats en cascade détermine le nombre d'époques d'entraînement autorisées à continuer - sans changer le MSE par une fraction de fann_get_cascade_candidate_change_fraction. - - - Voir plus d'informations sur ce paramètre dans fann_get_cascade_candidate_change_fraction. - - - Le nombre d'époques de stagnation des candidats en cascade par défaut est de 12. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre d'époques de stagnation des candidats en cascade, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_cascade_candidate_stagnation_epochs - fann_get_cascade_candidate_change_fraction - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml b/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml deleted file mode 100644 index 54babe232b..0000000000 --- a/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_cascade_max_cand_epochs - Renvoie le nombre maximum d'époques des candidats - - - - &reftitle.description; - - intfann_get_cascade_max_cand_epochs - resourceann - - - Le nombre maximum d'époques des candidats détermine le nombre maximum d'époques d'entraînement - des connexions d'entrée des candidats avant d'ajouter un nouveau neurone candidat. - - - La valeur par défaut du nombre maximum d'époques des candidats est 150. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre maximum d'époques des candidats, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_cascade_max_cand_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-max-out-epochs.xml b/reference/fann/functions/fann-get-cascade-max-out-epochs.xml deleted file mode 100644 index aacc15511c..0000000000 --- a/reference/fann/functions/fann-get-cascade-max-out-epochs.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_cascade_max_out_epochs - Renvoie le nombre maximum d'époques de sortie - - - - &reftitle.description; - - intfann_get_cascade_max_out_epochs - resourceann - - - Le nombre maximum d'époques de sortie détermine le nombre maximum d'époques d'entraînement - des connexions de sortie après avoir ajouté un nouveau neurone candidat. - - - Le nombre maximum d'époques de sortie par défaut est de 150. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre maximum d'époques de sortie, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_cascade_max_out_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml b/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml deleted file mode 100644 index 05162a4cd2..0000000000 --- a/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - fann_get_cascade_min_cand_epochs - Renvoie le nombre minimum d'époques des candidats - - - - &reftitle.description; - - intfann_get_cascade_min_cand_epochs - resourceann - - - Le nombre minimum d'époques des candidats détermine le nombre minimum d'époques d'entraînement - des connexions d'entrée des candidats avant d'ajouter un nouveau neurone candidat. - - - Le nombre minimum d'époques des candidats par défaut est de 50. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre minimum d'époques des candidats, ou &false; en cas d'erreur. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_cascade_min_cand_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-min-out-epochs.xml b/reference/fann/functions/fann-get-cascade-min-out-epochs.xml deleted file mode 100644 index d466b6be24..0000000000 --- a/reference/fann/functions/fann-get-cascade-min-out-epochs.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - fann_get_cascade_min_out_epochs - Renvoie le nombre minimum d'époques de sortie - - - - &reftitle.description; - - intfann_get_cascade_min_out_epochs - resourceann - - - Le nombre minimum d'époques de sortie détermine le nombre minimum d'époques d'entraînement des connexions de sortie - après avoir ajouté un nouveau neurone candidat. - - - La valeur par défaut du nombre minimum d'époques de sortie est de 50. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre minimum d'époques de sortie, ou &false; en cas d'erreur. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_cascade_min_out_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml b/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml deleted file mode 100644 index 9aaf1fba6f..0000000000 --- a/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - fann_get_cascade_num_candidate_groups - Renvoie le nombre de groupes de candidats - - - - &reftitle.description; - - intfann_get_cascade_num_candidate_groups - resourceann - - - Le nombre de groupes de candidats est le nombre de groupes de candidats identiques qui seront utilisés pendant l'entraînement. - - - Ce nombre peut être utilisé pour avoir plus de candidats sans avoir à définir de nouveaux paramètres pour les candidats. - - - Voir fann_get_cascade_num_candidates pour une description des - candidats qui seront générés par ce paramètre. - - - Le nombre de groupes de candidats par défaut est de 2. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre de groupes de candidats, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_cascade_num_candidate_groups - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-num-candidates.xml b/reference/fann/functions/fann-get-cascade-num-candidates.xml deleted file mode 100644 index 5dcc855738..0000000000 --- a/reference/fann/functions/fann-get-cascade-num-candidates.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - fann_get_cascade_num_candidates - Renvoie le nombre de candidats utilisés pendant l'entraînement - - - - &reftitle.description; - - intfann_get_cascade_num_candidates - resourceann - - - Le nombre de candidats utilisés pendant l'entraînement (calculé en multipliant - fann_get_cascade_activation_functions_count, - fann_get_cascade_activation_steepnesses_count et - fann_get_cascade_num_candidate_groups). - - - Les candidats sont définis par les tableaux fann_get_cascade_activation_functions et - fann_get_cascade_activation_steepnesses. Ces tableaux définissent les fonctions d'activation et - les raideurs d'activation utilisées pour les neurones candidats. S'il y a 2 fonctions d'activation dans le tableau de fonctions - d'activation et 3 raideurs dans le tableau de raideurs, alors il y aura 2x3=6 candidats différents qui seront entraînés. Ces 6 - candidats différents peuvent être copiés dans plusieurs groupes de candidats, où la seule différence entre ces groupes est les poids initiaux. - Si le nombre de groupes est défini à 2, alors le nombre de neurones candidats sera de 2x3x2=12. - Le nombre de groupes de candidats est défini par fann_set_cascade_num_candidate_groups. - - - La valeur par défaut du nombre de candidats est de 6x4x2=48 - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre de candidats utilisés pendant l'entraînement, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_functions - fann_get_cascade_activation_functions_count - fann_get_cascade_activation_steepnesses - fann_get_cascade_activation_steepnesses_count - fann_get_cascade_num_candidate_groups - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-output-change-fraction.xml b/reference/fann/functions/fann-get-cascade-output-change-fraction.xml deleted file mode 100644 index 5df15386ae..0000000000 --- a/reference/fann/functions/fann-get-cascade-output-change-fraction.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - fann_get_cascade_output_change_fraction - Renvoie la fraction de changement de sortie en cascade - - - - &reftitle.description; - - floatfann_get_cascade_output_change_fraction - resourceann - - - La fraction de changement de sortie en cascade est un nombre entre 0 et 1 déterminant quelle fraction de la valeur de fann_get_MSE - doit changer dans fann_get_cascade_output_stagnation_epochs pendant l'entraînement des connexions de sortie, - pour que l'entraînement ne stagne pas. Si l'entraînement stagne, l'entraînement des connexions de sortie - sera arrêté et de nouveaux candidats seront préparés. - - - Cela signifie que si le MSE ne change pas d'une fraction de fann_get_cascade_output_change_fraction pendant - une période de fann_get_cascade_output_stagnation_epochs, l'entraînement des connexions de sortie est - arrêté car l'entraînement a stagné. - - - Si la fraction de changement de sortie en cascade est faible, les connexions de sortie seront entraînées plus et si la fraction est élevée, - elles seront entraînées moins. - - - La fraction de changement de sortie en cascade par défaut est de 0.01, ce qui est équivalent à un changement de 1% du MSE. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La fraction de changement de sortie en cascade, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_cascade_output_change_fraction - fann_get_MSE - fann_get_cascade_output_stagnation_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml b/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml deleted file mode 100644 index a091dc15ae..0000000000 --- a/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_get_cascade_output_stagnation_epochs - Renvoie le nombre d'époques de stagnation de sortie en cascade - - - - &reftitle.description; - - intfann_get_cascade_output_stagnation_epochs - resourceann - - - Le nombre d'époques de stagnation de sortie en cascade détermine le nombre d'époques d'entraînement autorisées à continuer - sans changer le MSE par une fraction de fann_get_cascade_output_change_fraction. - - - Voir plus d'informations sur ce paramètre dans fann_get_cascade_output_change_fraction. - - - La valeur par défaut du nombre d'époques de stagnation de sortie en cascade est de 12. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre d'époques de stagnation de sortie en cascade, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_cascade_output_stagnation_epochs - fann_get_cascade_output_change_fraction - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-weight-multiplier.xml b/reference/fann/functions/fann-get-cascade-weight-multiplier.xml deleted file mode 100644 index 3e6672cca0..0000000000 --- a/reference/fann/functions/fann-get-cascade-weight-multiplier.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_cascade_weight_multiplier - Renvoie le multiplicateur de poids - - - - &reftitle.description; - - floatfann_get_cascade_weight_multiplier - resourceann - - - Le multiplicateur de poids est un paramètre qui est utilisé pour multiplier les poids du neurone candidat avant d'ajouter - le neurone au réseau de neurones. Ce paramètre est généralement compris entre 0 et 1, et est utilisé pour rendre l'entraînement un peu moins agressif. - - - Le multiplicateur de poids par défaut est de 0.4. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le multiplicateur de poids, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_cascade_weight_multiplier - - - - - - - - diff --git a/reference/fann/functions/fann-get-connection-array.xml b/reference/fann/functions/fann-get-connection-array.xml deleted file mode 100644 index 446c93fafa..0000000000 --- a/reference/fann/functions/fann-get-connection-array.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_connection_array - Récupère les connexions dans le réseau - - - - &reftitle.description; - - arrayfann_get_connection_array - resourceann - - - Récupère les connexions dans le réseau. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Un tableau de connexions dans le réseau. - - - - - - - diff --git a/reference/fann/functions/fann-get-connection-rate.xml b/reference/fann/functions/fann-get-connection-rate.xml deleted file mode 100644 index 22df7b97b7..0000000000 --- a/reference/fann/functions/fann-get-connection-rate.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - fann_get_connection_rate - Récupère le taux de connexion lorsque le réseau a été créé - - - - &reftitle.description; - - floatfann_get_connection_rate - resourceann - - - Récupère le taux de connexion lorsque le réseau a été créé. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le taux de connexion utilisé lorsque le réseau a été créé, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/fann/functions/fann-get-errno.xml b/reference/fann/functions/fann-get-errno.xml deleted file mode 100644 index 5db5d5698f..0000000000 --- a/reference/fann/functions/fann-get-errno.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - fann_get_errno - Retourne le numéro de la dernière erreur - - - - &reftitle.description; - - intfann_get_errno - resourceerrdat - - - Retourne le numéro de la dernière erreur. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - - Le numéro de l'erreur, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_reset_errno - fann_get_errstr - - - - - - - - diff --git a/reference/fann/functions/fann-get-errstr.xml b/reference/fann/functions/fann-get-errstr.xml deleted file mode 100644 index 03c1dffafd..0000000000 --- a/reference/fann/functions/fann-get-errstr.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - fann_get_errstr - Retourne le dernier message d'erreur - - - - &reftitle.description; - - stringfann_get_errstr - resourceerrdat - - - Retourne le dernier message d'erreur. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - - Le dernier message d'erreur, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_reset_errstr - fann_get_errno - - - - - - - - diff --git a/reference/fann/functions/fann-get-layer-array.xml b/reference/fann/functions/fann-get-layer-array.xml deleted file mode 100644 index a0cfcff9d7..0000000000 --- a/reference/fann/functions/fann-get-layer-array.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - fann_get_layer_array - Renvoie le nombre de neurones dans chaque couche du réseau - - - - &reftitle.description; - - arrayfann_get_layer_array - resourceann - - - Renvoie le nombre de neurones dans chaque couche du réseau de neurones. - - - Le biais n'est pas inclus pour que les couches correspondent aux fonctions fann_create. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Un tableau de nombres de neurones dans chaque couche. - - - - - - diff --git a/reference/fann/functions/fann-get-learning-momentum.xml b/reference/fann/functions/fann-get-learning-momentum.xml deleted file mode 100644 index e52bb4ba7c..0000000000 --- a/reference/fann/functions/fann-get-learning-momentum.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_get_learning_momentum - Renvoie l'élan d'apprentissage - - - - &reftitle.description; - - floatfann_get_learning_momentum - resourceann - - - L'élan d'apprentissage est utilisé pour accélérer l'entraînement FANN_TRAIN_INCREMENTAL. - Un élan d'apprentissage trop élevé n'améliorera cependant pas l'entraînement. Mettre l'élan à 0 sera le même que - de ne pas utiliser le paramètre d'élan. La valeur recommandée de ce paramètre est comprise entre 0.0 et 1.0. - - - Le paramètre d'élan d'apprentissage par défaut est de 0. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - L'élan d'apprentissage, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_learning_momentum - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-get-learning-rate.xml b/reference/fann/functions/fann-get-learning-rate.xml deleted file mode 100644 index 3e3a97c4b6..0000000000 --- a/reference/fann/functions/fann-get-learning-rate.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - fann_get_learning_rate - Renvoie le taux d'apprentissage - - - - &reftitle.description; - - floatfann_get_learning_rate - resourceann - - - Le taux d'apprentissage est utilisé pour déterminer à quel point l'entraînement doit être agressif pour certains des algorithmes d'entraînement - (FANN_TRAIN_INCREMENTAL, FANN_TRAIN_BATCH, FANN_TRAIN_QUICKPROP). - Cependant il n'est pas utilisé dans FANN_TRAIN_RPROP. - - - Le taux d'apprentissage par défaut est de 0.7. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le taux d'apprentissage, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_learning_rate - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-get-mse.xml b/reference/fann/functions/fann-get-mse.xml deleted file mode 100644 index a193cc3680..0000000000 --- a/reference/fann/functions/fann-get-mse.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - fann_get_MSE - Lit le taux d'erreur quadratique moyen du réseau - - - - &reftitle.description; - - floatfann_get_MSE - resourceann - - - Lit le taux d'erreur quadratique moyen du réseau - - - Lit le taux d'erreur quadratique moyen du réseau. Cette valeur est calculée pendant l'entraînement ou le test et peut - donc parfois être un peu faussée si les poids ont été modifiés depuis le dernier calcul de la valeur. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le taux d'erreur quadratique moyen, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_test_data - - - - - - - diff --git a/reference/fann/functions/fann-get-network-type.xml b/reference/fann/functions/fann-get-network-type.xml deleted file mode 100644 index 7176c41b4c..0000000000 --- a/reference/fann/functions/fann-get-network-type.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - fann_get_network_type - Renvoie le type de réseau de neurones pour lequel il a été créé - - - - &reftitle.description; - - intfann_get_network_type - resourceann - - - Renvoie le type de réseau de neurones pour lequel il a été créé. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La constante type de réseau, ou &false; en cas d'erreur. - - - - - - - diff --git a/reference/fann/functions/fann-get-num-input.xml b/reference/fann/functions/fann-get-num-input.xml deleted file mode 100644 index 70528b6001..0000000000 --- a/reference/fann/functions/fann-get-num-input.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_num_input - Récupère le nombre de neurones entrants - - - - &reftitle.description; - - intfann_get_num_input - resourceann - - - Récupère le nombre de neurones entrants. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre de neurones entrants, ou &false; si une erreur survient. - - - - - - - diff --git a/reference/fann/functions/fann-get-num-layers.xml b/reference/fann/functions/fann-get-num-layers.xml deleted file mode 100644 index 8b0db4597b..0000000000 --- a/reference/fann/functions/fann-get-num-layers.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_num_layers - Récupère le nombre de couches du réseau neuronal - - - - &reftitle.description; - - intfann_get_num_layers - resourceann - - - Récupère le nombre de couches du réseau neuronal. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre de couches du réseau neuronal, ou &false; si une erreur survient. - - - - - - - diff --git a/reference/fann/functions/fann-get-num-output.xml b/reference/fann/functions/fann-get-num-output.xml deleted file mode 100644 index 7a657c5019..0000000000 --- a/reference/fann/functions/fann-get-num-output.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_num_output - Récupère le nombre de neurones sortants - - - - &reftitle.description; - - intfann_get_num_output - resourceann - - - Récupère le nombre de neurones sortants. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre de neurones sortants, ou &false; si une erreur survient. - - - - - - - diff --git a/reference/fann/functions/fann-get-quickprop-decay.xml b/reference/fann/functions/fann-get-quickprop-decay.xml deleted file mode 100644 index 3319d9e4a8..0000000000 --- a/reference/fann/functions/fann-get-quickprop-decay.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_quickprop_decay - Renvoie la décroissance qui est un facteur qui pondère la diminution des poids à chaque itération lors de l'entraînement quickprop - - - - &reftitle.description; - - floatfann_get_quickprop_decay - resourceann - - - La décroissance est un petit nombre négatif qui est un facteur que les poids doivent diminuer à chaque itération - lors de l'entraînement quickprop. Cela est utilisé pour s'assurer que les poids ne deviennent pas trop élevés pendant l'entraînement. - - - La décroissance par défaut est de -0.0001. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La décroissance, ou &false; en cas d'erreur. - - - - - &reftitle.seealso; - - - fann_set_quickprop_decay - - - - - - - - diff --git a/reference/fann/functions/fann-get-quickprop-mu.xml b/reference/fann/functions/fann-get-quickprop-mu.xml deleted file mode 100644 index 88493e245b..0000000000 --- a/reference/fann/functions/fann-get-quickprop-mu.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - fann_get_quickprop_mu - Retourne le facteur mu - - - - &reftitle.description; - - floatfann_get_quickprop_mu - resourceann - - - Le facteur mu est utilisé pour accroître et décroitre la taille de l'étape - durant l'entraînement quickprop. Le facteur mu devrait toujours être supérieur - à 1, sachant que sinon, il va décroitre la taille de l'étape alors qu'il - est supposé l'accroitre. - - - Le facteur mu par défaut est 1.75. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le facteur mu, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_set_quickprop_mu - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-decrease-factor.xml b/reference/fann/functions/fann-get-rprop-decrease-factor.xml deleted file mode 100644 index c226b54a12..0000000000 --- a/reference/fann/functions/fann-get-rprop-decrease-factor.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - fann_get_rprop_decrease_factor - Retourne le facteur de décroissement utilisé pendant l'entraînement RPROP - - - - &reftitle.description; - - floatfann_get_rprop_decrease_factor - resourceann - - - Le facteur de décroissement est une valeur plus petite que 1, qui est utilisée - pour décroitre la taille de l'étape pendant l'entraînement RPROP. - - - Le facteur de décroissement par défaut est 0.5. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le facteur de décroissement, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_set_rprop_decrease_factor - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-delta-max.xml b/reference/fann/functions/fann-get-rprop-delta-max.xml deleted file mode 100644 index 3f00e50b4f..0000000000 --- a/reference/fann/functions/fann-get-rprop-delta-max.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - fann_get_rprop_delta_max - Retourne la taille maximale de l'étape - - - - &reftitle.description; - - floatfann_get_rprop_delta_max - resourceann - - - La taille maximale de l'étape est un nombre positif déterminant combien - la taille de l'étape peut être au maximum. - - - Le delta maximal par défaut est de 50.0. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La taille maximale de l'étape, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_set_rprop_delta_max - fann_get_rprop_delta_min - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-delta-min.xml b/reference/fann/functions/fann-get-rprop-delta-min.xml deleted file mode 100644 index 1bfdc41fe9..0000000000 --- a/reference/fann/functions/fann-get-rprop-delta-min.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - fann_get_rprop_delta_min - Retourne la taille minimale de l'étape - - - - &reftitle.description; - - floatfann_get_rprop_delta_min - resourceann - - - La taille minimale de l'étape est un petit nombre positif déterminant - combien la taille de l'étape peut être au minimum. - - - La valeur minimale du delta par défaut est de 0.0. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La taille minimale de l'étape, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_set_rprop_delta_min - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-delta-zero.xml b/reference/fann/functions/fann-get-rprop-delta-zero.xml deleted file mode 100644 index a4cac7763f..0000000000 --- a/reference/fann/functions/fann-get-rprop-delta-zero.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - fann_get_rprop_delta_zero - Retourne la taille initiale de l'étape - - - - &reftitle.description; - - intfann_get_rprop_delta_zero - resourceann - - - La taille initiale de l'étape est un nombre positif déterminant - la taille initiale de l'étape. - - - Le delta par défaut est de 0.1. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La taille initiale de l'étape, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_set_rprop_delta_zero - fann_get_rprop_delta_min - fann_get_rprop_delta_max - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-increase-factor.xml b/reference/fann/functions/fann-get-rprop-increase-factor.xml deleted file mode 100644 index 6da7796bea..0000000000 --- a/reference/fann/functions/fann-get-rprop-increase-factor.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - fann_get_rprop_increase_factor - Retourne le facteur croissant utilisé pendant l'entraînement RPROP - - - - &reftitle.description; - - floatfann_get_rprop_increase_factor - resourceann - - - Le facteur croissant est une valeur supérieure à 1, qui est utilisée pour - croitre la taille de l'étape pendant l'entraînement RPROP. - - - Le facteur croissant par défaut est de 1.2. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le facteur croissant, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_set_rprop_increase_factor - - - - - - - - diff --git a/reference/fann/functions/fann-get-sarprop-step-error-shift.xml b/reference/fann/functions/fann-get-sarprop-step-error-shift.xml deleted file mode 100644 index af188a979a..0000000000 --- a/reference/fann/functions/fann-get-sarprop-step-error-shift.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - fann_get_sarprop_step_error_shift - Retourne le décalage de l'erreur lors de l'étape sarprop - - - - &reftitle.description; - - floatfann_get_sarprop_step_error_shift - resourceann - - - Retourne le décalage de l'erreur lors de l'étape sarprop. - - - Le décalage par défaut de l'erreur lors de l'étape est 1.385. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le décalage de l'erreur lors de l'étape sarprop, ou &false; si - une erreur survient. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_sarprop_step_error_shift - - - - - - - - diff --git a/reference/fann/functions/fann-get-sarprop-step-error-threshold-factor.xml b/reference/fann/functions/fann-get-sarprop-step-error-threshold-factor.xml deleted file mode 100644 index ed9bacdcd7..0000000000 --- a/reference/fann/functions/fann-get-sarprop-step-error-threshold-factor.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - fann_get_sarprop_step_error_threshold_factor - Retourne le facteur de seuil d'erreur lors de l'étape sarprop - - - - &reftitle.description; - - floatfann_get_sarprop_step_error_threshold_factor - resourceann - - - Retourne le facteur de seuil d'erreur lors de l'étape sarprop. - - - Le facteur par défaut est 0.1. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le facteur de seuil d'erreur lors de l'étape sarprop, ou &false; - si une erreur survient. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_sarprop_step_error_threshold_factor - - - - - - - - diff --git a/reference/fann/functions/fann-get-sarprop-temperature.xml b/reference/fann/functions/fann-get-sarprop-temperature.xml deleted file mode 100644 index 469785d580..0000000000 --- a/reference/fann/functions/fann-get-sarprop-temperature.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - fann_get_sarprop_temperature - Retourne la température sarprop - - - - &reftitle.description; - - floatfann_get_sarprop_temperature - resourceann - - - Retourne la température sarprop. - - - La température par défaut est 0.015. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La température sarprop, ou &false; si une erreur survient. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_sarprop_temperature - - - - - - - - diff --git a/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml b/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml deleted file mode 100644 index b5b6075d4d..0000000000 --- a/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - fann_get_sarprop_weight_decay_shift - Retourne le changement décroissant du poids sarprop - - - - &reftitle.description; - - floatfann_get_sarprop_weight_decay_shift - resourceann - - - Le changement décroissant du poids sarprop. - - - Le delta maximal par défaut est -6.644. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le changement décroissant du poids sarprop, ou &false; si une erreur - survient. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_sarprop_weight_decay_shift - - - - - - - - diff --git a/reference/fann/functions/fann-get-total-connections.xml b/reference/fann/functions/fann-get-total-connections.xml deleted file mode 100644 index 0a520a4f25..0000000000 --- a/reference/fann/functions/fann-get-total-connections.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - fann_get_total_connections - Récupère le nombre total de connexions dans la totalité du réseau - - - - &reftitle.description; - - intfann_get_total_connections - resourceann - - - Récupère le nombre total de connexions dans la totalité du réseau. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre total de connexions dans la totalité du réseau, ou &false; - si une erreur survient. - - - - - - - diff --git a/reference/fann/functions/fann-get-total-neurons.xml b/reference/fann/functions/fann-get-total-neurons.xml deleted file mode 100644 index 05142ef5fb..0000000000 --- a/reference/fann/functions/fann-get-total-neurons.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - fann_get_total_neurons - Récupère le nombre total de neurones dans la totalité du réseau - - - - &reftitle.description; - - intfann_get_total_neurons - resourceann - - - Récupère le nombre total de neurones dans la totalité du réseau. - Ce nombre inclut aussi les neurones de polarisation - - un réseau 2-4-2 a 2+4+2 +2(polarisants) = 10 neurones. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Le nombre total de neurones dans la totalité du réseau, - ou &false; si une erreur survient. - - - - - - diff --git a/reference/fann/functions/fann-get-train-error-function.xml b/reference/fann/functions/fann-get-train-error-function.xml deleted file mode 100644 index 10bf13d2d3..0000000000 --- a/reference/fann/functions/fann-get-train-error-function.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - fann_get_train_error_function - Retourne la fonction d'erreur utilisée pendant l'entraînement - - - - &reftitle.description; - - intfann_get_train_error_function - resourceann - - - Retourne la fonction d'erreur utilisée pendant l'entraînement. - - - Les fonctions d'erreur sont décrites dans la page sur les constantes des - fonctions d'erreur. - - - La fonction d'erreur par défaut est FANN_ERRORFUNC_TANH. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La constante de fonction d'erreur - ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_set_train_error_function - - - - - - - - diff --git a/reference/fann/functions/fann-get-train-stop-function.xml b/reference/fann/functions/fann-get-train-stop-function.xml deleted file mode 100644 index b01c2b92b7..0000000000 --- a/reference/fann/functions/fann-get-train-stop-function.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - fann_get_train_stop_function - Retourne la fonction d'arrêt utilisée pendant l'entraînement - - - - &reftitle.description; - - intfann_get_train_stop_function - resourceann - - - Retourne la fonction d'arrêt utilisée pendant l'entraînement. - - - Les fonctions d'arrêt sont décrites dans les constantes - des fonctions d'arrêt. - - - La fonction d'arrêt par défaut est FANN_STOPFUNC_MSE. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La constante de fonction d'arrêt, - ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_set_train_stop_function - - - - - - - - diff --git a/reference/fann/functions/fann-get-training-algorithm.xml b/reference/fann/functions/fann-get-training-algorithm.xml deleted file mode 100644 index 23f660924c..0000000000 --- a/reference/fann/functions/fann-get-training-algorithm.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - fann_get_training_algorithm - Retourne l'algorithme d'entraînement - - - - &reftitle.description; - - intfann_get_training_algorithm - resourceann - - - Retourne l'algorithme d'entraînement. Cet algorithme d'entraînement est - utilisé par fann_train_on_data et les fonctions - associées. - - - Il est à noter que cet algorithme est également utilisé pendant - fann_cascadetrain_on_data, bien que seules les - constantes FANN_TRAIN_RPROP et FANN_TRAIN_QUICKPROP - soient autorisées pendant l'entraînement en cascade. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La constante de l'algorithme d'entraînement - ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-init-weights.xml b/reference/fann/functions/fann-init-weights.xml deleted file mode 100644 index caa5865c5e..0000000000 --- a/reference/fann/functions/fann-init-weights.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - fann_init_weights - Initialise les poids en utilisant l'algorithme de Widrow et Nguyen - - - - &reftitle.description; - - boolfann_init_weights - resourceann - resourcetrain_data - - - Initialise les poids en utilisant l'algorithme de Widrow et Nguyen. - - - Cette fonction a un fonctionnement similaire à la fonction - fann_randomize_weights. Elle va utiliser l'algorithme - développé par Derrick Nguyen et Bernard Widrow pour définir les poids - de telle façon à ce que l'entraînement devienne plus rapide. Cette technique - n'est pas toujours couronnée de succès, et dans quelques cas, peut être - moins efficace qu'une initialisation purement aléatoire. - - - L'algorithme requiert l'accès à l'intervalle de données entrantes (par exemple, - les entrées la plus petite et la plus grande), et accepte aussi un second - argument, les données, qui sont les données d'entraînement qui seront - utilisées pour l'entraînement du réseau. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_randomize_weights - fann_read_train_from_file - - - - - - - - diff --git a/reference/fann/functions/fann-length-train-data.xml b/reference/fann/functions/fann-length-train-data.xml deleted file mode 100644 index 5372d1bf59..0000000000 --- a/reference/fann/functions/fann-length-train-data.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_length_train_data - Retourne le nombre de masques d'entraînement dans les données d'entraînement - - - - &reftitle.description; - - intfann_length_train_data - resourcedata - - - Retourne le nombre de masques d'entraînement dans les données d'entraînement. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - Le nombre d'éléments dans les données d'entraînement, ou &false; - si une erreur survient. - - - - - - diff --git a/reference/fann/functions/fann-merge-train-data.xml b/reference/fann/functions/fann-merge-train-data.xml deleted file mode 100644 index 49aeba63c4..0000000000 --- a/reference/fann/functions/fann-merge-train-data.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - fann_merge_train_data - Fusionne les données d'entraînement - - - - &reftitle.description; - - resourcefann_merge_train_data - resourcedata1 - resourcedata2 - - - Fusionne les données data1 et data2 dans un nouveau jeu - de données d'entraînement. - - - - - &reftitle.parameters; - - - data1 - - &fann.train.description; - - - - data2 - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - Nouveau jeu de données d'entraînement, ou &false; si une erreur survient. - - - - - - diff --git a/reference/fann/functions/fann-num-input-train-data.xml b/reference/fann/functions/fann-num-input-train-data.xml deleted file mode 100644 index d2f7b3d4d0..0000000000 --- a/reference/fann/functions/fann-num-input-train-data.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - fann_num_input_train_data - Retourne le nombre d'entrées dans chaque masque d'entraînement dans les données d'entraînement - - - - &reftitle.description; - - intfann_num_input_train_data - resourcedata - - - Retourne le nombre d'entrées dans chaque masque d'entraînement dans les - données d'entraînement. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - Le nombre d'entrées, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_length_train_data - fann_num_output_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-num-output-train-data.xml b/reference/fann/functions/fann-num-output-train-data.xml deleted file mode 100644 index 0ded8fe592..0000000000 --- a/reference/fann/functions/fann-num-output-train-data.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - fann_num_output_train_data - Retourne le nombre de sorties dans chaque masque d'entraînement dans les données d'entraînement - - - - &reftitle.description; - - intfann_num_output_train_data - resourcedata - - - Retourne le nombre de sorties dans chaque masque d'entraînement dans les - données d'entraînement. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - Le nombre de sorties, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_length_train_data - fann_num_input_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-print-error.xml b/reference/fann/functions/fann-print-error.xml deleted file mode 100644 index 8719a99f02..0000000000 --- a/reference/fann/functions/fann-print-error.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - fann_print_error - Affiche le message d'erreur - - - - &reftitle.description; - - voidfann_print_error - resourceerrdat - - - Affiche le message d'erreur. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - &reftitle.seealso; - - - fann_get_errstr - - - - - - - - diff --git a/reference/fann/functions/fann-randomize-weights.xml b/reference/fann/functions/fann-randomize-weights.xml deleted file mode 100644 index f9af3e1eb2..0000000000 --- a/reference/fann/functions/fann-randomize-weights.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - fann_randomize_weights - Donne à chaque connexion un poids aléatoire compris entre - min_weight et max_weight - - - - &reftitle.description; - - boolfann_randomize_weights - resourceann - floatmin_weight - floatmax_weight - - - Donne à chaque connexion un poids aléatoire compris entre - min_weight et max_weight. - - - Depuis le début, les poids sont aléatoires, dans un intervalle - -0.1 et 0.1. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - min_weight - - - Valeur minimale du poids - - - - - max_weight - - - Valeur maximale du poids - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_init_weights - - - - - - - - diff --git a/reference/fann/functions/fann-read-train-from-file.xml b/reference/fann/functions/fann-read-train-from-file.xml deleted file mode 100644 index f5c895f8ea..0000000000 --- a/reference/fann/functions/fann-read-train-from-file.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - fann_read_train_from_file - Lit un fichier contenant les données d'entraînement - - - - &reftitle.description; - - resourcefann_read_train_from_file - stringfilename - - - Lit un fichier contenant les données d'entraînement. - - - - - &reftitle.parameters; - - - filename - - - Le fichier d'entrée au format suivant : - - - - - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - &reftitle.examples; - - - Exemple avec <methodname>fann_read_train_from_file</methodname> - - -]]> - - Contenu de xor.data - - - - - - - - - &reftitle.seealso; - - - fann_train_on_data - fann_destroy_train - fann_save_train - - - - - - - diff --git a/reference/fann/functions/fann-reset-errno.xml b/reference/fann/functions/fann-reset-errno.xml deleted file mode 100644 index 0502446734..0000000000 --- a/reference/fann/functions/fann-reset-errno.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - fann_reset_errno - Réinitialise le numéro de la dernière erreur - - - - &reftitle.description; - - voidfann_reset_errno - resourceerrdat - - - Réinitialise le numéro de la dernière erreur. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - &reftitle.seealso; - - - fann_get_errno - fann_reset_errstr - - - - - - - - diff --git a/reference/fann/functions/fann-reset-errstr.xml b/reference/fann/functions/fann-reset-errstr.xml deleted file mode 100644 index 6761b0fa01..0000000000 --- a/reference/fann/functions/fann-reset-errstr.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - fann_reset_errstr - Réinitialise le message de la dernière erreur - - - - &reftitle.description; - - voidfann_reset_errstr - resourceerrdat - - - Réinitialise le message de la dernière erreur. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - &reftitle.seealso; - - - fann_get_errstr - fann_reset_errno - - - - - - - - diff --git a/reference/fann/functions/fann-reset-mse.xml b/reference/fann/functions/fann-reset-mse.xml deleted file mode 100644 index a262061a97..0000000000 --- a/reference/fann/functions/fann-reset-mse.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - fann_reset_MSE - Réinitialise l'erreur quadratique moyenne du réseau - - - - &reftitle.description; - - boolfann_reset_MSE - stringann - - - Réinitialise l'erreur quadratique moyenne du réseau. - - - Cette fonction réinitialise également le nombre de bits en échec. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_MSE - fann_get_bit_fail - fann_get_bit_fail_limit - - - - - - - diff --git a/reference/fann/functions/fann-run.xml b/reference/fann/functions/fann-run.xml deleted file mode 100644 index 1b5a2d6bee..0000000000 --- a/reference/fann/functions/fann-run.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - fann_run - Exécute les entrées via le réseau neuronal - - - - &reftitle.description; - - arrayfann_run - resourceann - arrayinput - - - Exécute les entrées via le réseau neuronal, retourne un tableau - de sorties, le nombre de neurones dans la couche de sortie. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input - - - Tableau de valeurs d'entrées - - - - - - - - &reftitle.returnvalues; - - Tableau de valeurs de sorties, ou &false; si une erreur survient. - - - - - - diff --git a/reference/fann/functions/fann-save-train.xml b/reference/fann/functions/fann-save-train.xml deleted file mode 100644 index d3f649e3f8..0000000000 --- a/reference/fann/functions/fann-save-train.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - fann_save_train - Sauvegarde la structure d'entraînement dans un fichier - - - - &reftitle.description; - - boolfann_save_train - resourcedata - stringfile_name - - - Sauvegarde la structure d'entraînement dans un fichier, - dont le format est spécifié dans la fonction - fann_read_train_from_file. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - file_name - - - Le nom du fichier où la sauvegarde a lieu. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_read_train_from_file - - - - - - - - diff --git a/reference/fann/functions/fann-save.xml b/reference/fann/functions/fann-save.xml deleted file mode 100644 index 8c401c4eeb..0000000000 --- a/reference/fann/functions/fann-save.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - fann_save - Sauvegarde le réseau complet dans un fichier de configuration - - - - &reftitle.description; - - boolfann_save - resourceann - stringconfiguration_file - - - Sauvegarde le réseau complet dans un fichier de configuration. - - - Le fichier de configuration contient toutes les informations sur le réseau - neuronal, et active la fonction fann_create_from_file - pour créer une copie exacte du réseau neuronal, et tous les paramètres - associés au réseau neuronal. - - - Ces trois paramètres (fann_set_callback, fann_set_error_log, - fann_set_user_data) ne sont PAS sauvegardés dans le fichier - car ils ne peuvent pas être portés en toute sécurité dans un endroit - différent. De même, les paramètres temporaires générés pendant - l'entraînement comme fann_get_MSE ne sont pas sauvegardés. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - configuration_file - - - Le chemin vers le fichier de configuration. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_create_from_file - - - - - - - - diff --git a/reference/fann/functions/fann-scale-input-train-data.xml b/reference/fann/functions/fann-scale-input-train-data.xml deleted file mode 100644 index bb5d03bab8..0000000000 --- a/reference/fann/functions/fann-scale-input-train-data.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - fann_scale_input_train_data - Met à l'échelle les entrées dans les données d'entraînement - à l'intervalle spécifié - - - - &reftitle.description; - - boolfann_scale_input_train_data - resourcetrain_data - floatnew_min - floatnew_max - - - Met à l'échelle les entrées dans les données d'entraînement - à l'intervalle spécifié. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - new_min - - - Nouveau minimum après la mise à l'échelle des entrées - dans les données d'entraînement. - - - - - new_max - - - Nouveau maximum après la mise à l'échelle des entrées - dans les données d'entraînement. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_output_train_data - fann_scale_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-scale-input.xml b/reference/fann/functions/fann-scale-input.xml deleted file mode 100644 index dc5d9f2c81..0000000000 --- a/reference/fann/functions/fann-scale-input.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - fann_scale_input - Met à l'échelle les données dans le vecteur d'entrée - avant de les donner à ANN, en se basant sur les paramètres précédemment calculés - - - - &reftitle.description; - - boolfann_scale_input - resourceann - arrayinput_vector - - - Met à l'échelle les données dans le vecteur d'entrée avant de les donner - à ANN, en se basant sur les paramètres précédemment calculés. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input_vector - - - Vecteur d'entrée qui va être mis à l'échelle - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_descale_input - fann_scale_output - - - - - - - - diff --git a/reference/fann/functions/fann-scale-output-train-data.xml b/reference/fann/functions/fann-scale-output-train-data.xml deleted file mode 100644 index 293a44f0cd..0000000000 --- a/reference/fann/functions/fann-scale-output-train-data.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - fann_scale_output_train_data - Met à l'échelle les sorties dans les données d'entraînement - à l'intervalle spécifié - - - - &reftitle.description; - - boolfann_scale_output_train_data - resourcetrain_data - floatnew_min - floatnew_max - - - Met à l'échelle les sorties dans les données d'entraînement - à l'intervalle spécifié. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - new_min - - - Nouveau minimum après la mise à l'échelle des sorties dans - les données d'entraînement. - - - - - new_max - - - Nouveau maximum après la mise à l'échelle des sorties dans - les données d'entraînement. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_input_train_data - fann_scale_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-scale-output.xml b/reference/fann/functions/fann-scale-output.xml deleted file mode 100644 index ca58054a79..0000000000 --- a/reference/fann/functions/fann-scale-output.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - fann_scale_output - Met à l'échelle les données dans le vecteur de sortie - avant de les passer à ANN, en se basant sur les paramètres précédemment calculés - - - - &reftitle.description; - - boolfann_scale_output - resourceann - arrayoutput_vector - - - Met à l'échelle les données dans le vecteur de sortie - avant de les passer à ANN, en se basant sur les paramètres précédemment calculés. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - output_vector - - - Vecteur de sortie qui sera mis à l'échelle - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_descale_output - fann_scale_input - - - - - - - - diff --git a/reference/fann/functions/fann-scale-train-data.xml b/reference/fann/functions/fann-scale-train-data.xml deleted file mode 100644 index c129817d07..0000000000 --- a/reference/fann/functions/fann-scale-train-data.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - fann_scale_train_data - Met à l'échelle les entrées et les sorties dans les données - d'entraînement à l'intervalle spécifié - - - - &reftitle.description; - - boolfann_scale_train_data - resourcetrain_data - floatnew_min - floatnew_max - - - Met à l'échelle les entrées et les sorties dans les données - d'entraînement à l'intervalle spécifié. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - new_min - - - Nouvelle valeur minimale après la mise à l'échelle des entrées - et des sorties dans les données d'entraînement. - - - - - new_max - - - Nouvelle valeur maximale après la mise à l'échelle des entrées - et des sorties dans les données d'entraînement. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_output_train_data - fann_scale_input_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-scale-train.xml b/reference/fann/functions/fann-scale-train.xml deleted file mode 100644 index c694e49863..0000000000 --- a/reference/fann/functions/fann-scale-train.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - fann_scale_train - Met à l'échelle les données d'entrée et de sortie - en se basant sur les paramètres précédemment calculés - - - - &reftitle.description; - - boolfann_scale_train - resourceann - resourcetrain_data - - - Met à l'échelle les données d'entrée et de sortie - en se basant sur les paramètres précédemment calculés. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_descale_train - fann_set_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-function-hidden.xml b/reference/fann/functions/fann-set-activation-function-hidden.xml deleted file mode 100644 index 720c8402a4..0000000000 --- a/reference/fann/functions/fann-set-activation-function-hidden.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - fann_set_activation_function_hidden - Définit la fonction d'activation pour toutes les couches cachées - - - - &reftitle.description; - - boolfann_set_activation_function_hidden - resourceann - intactivation_function - - - Définit la fonction d'activation pour toutes les couches cachées. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_function - - - La constante de fonctions - d'activation. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_function - fann_set_activation_function_layer - fann_set_activation_function_output - fann_set_activation_steepness - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-function-layer.xml b/reference/fann/functions/fann-set-activation-function-layer.xml deleted file mode 100644 index 4b4189e1cd..0000000000 --- a/reference/fann/functions/fann-set-activation-function-layer.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - fann_set_activation_function_layer - Définit la fonction d'activation pour tous les neurones de la couche spécifiée - - - - &reftitle.description; - - boolfann_set_activation_function_layer - resourceann - intactivation_function - intlayer - - - Définit la fonction d'activation pour tous les neurones de la couche dont - le numéro est layer, en comptant la couche d'entrée - comme étant la couche numéro 0. - - - Il n'est pas possible de définir les fonctions d'activation pour - les neurones de la couche d'entrée. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_function - - - La constante de fonctions - d'activation. - - - - - layer - - - Le numéro de la couche. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_function - fann_set_activation_function_hidden - fann_set_activation_function_output - fann_set_activation_steepness - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-function-output.xml b/reference/fann/functions/fann-set-activation-function-output.xml deleted file mode 100644 index e0495ee3e2..0000000000 --- a/reference/fann/functions/fann-set-activation-function-output.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - fann_set_activation_function_output - Définit la fonction d'activation pour la couche de sortie - - - - &reftitle.description; - - boolfann_set_activation_function_output - resourceann - intactivation_function - - - Définit la fonction d'activation pour la couche de sortie. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_function - - - La constante de fonctions - d'activation. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_function - fann_set_activation_function_layer - fann_set_activation_function_hidden - fann_set_activation_steepness - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-function.xml b/reference/fann/functions/fann-set-activation-function.xml deleted file mode 100644 index cb8f2ab314..0000000000 --- a/reference/fann/functions/fann-set-activation-function.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - fann_set_activation_function - Définit la fonction d'activation pour le neurone et la couche spécifiés - - - - &reftitle.description; - - boolfann_set_activation_function - resourceann - intactivation_function - intlayer - intneuron - - - Définit la fonction d'activation pour le neurone numéro neuron - dans la couche numéro layer, en comptant la couche - d'entrée comme étant la couche numéro 0. - - - Il n'est pas possible de définir les fonctions d'activation pour les - neurones de la couche d'entrée. - - - Lors du choix d'une fonction d'activation, il est important de noter que - les fonctions d'activation ont un intervalle différent. - FANN_SIGMOID est, c.-à-d. dans l'intervalle 0 - 1 alors - que FANN_SIGMOID_SYMMETRIC est dans l'intervalle - -1 - 1 et FANN_LINEAR n'est pas lié. - - - La valeur de la fonction d'activation fournie doit être une constante - parmi les - fonctions d'activation. - - - La valeur retournée est une constante parmi les - fonctions d'activation. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_function - - - La constante de fonctions d'activation. - - - - - layer - - - Le numéro de la couche. - - - - - neuron - - - Le numéro du neurone. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_function_layer - fann_set_activation_function_hidden - fann_set_activation_function_output - fann_set_activation_steepness - fann_get_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-steepness-hidden.xml b/reference/fann/functions/fann-set-activation-steepness-hidden.xml deleted file mode 100644 index bb31705f80..0000000000 --- a/reference/fann/functions/fann-set-activation-steepness-hidden.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - fann_set_activation_steepness_hidden - Définit la raideur de la pente d'activation pour tous les neurones - des couches cachées - - - - &reftitle.description; - - boolfann_set_activation_steepness_hidden - resourceann - floatactivation_steepness - - - Définit la raideur de la pente d'activation pour tous les neurones - des couches cachées. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_steepness - - - La pente d'activation. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_steepness - fann_set_activation_steepness_layer - fann_set_activation_steepness_output - fann_get_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-steepness-layer.xml b/reference/fann/functions/fann-set-activation-steepness-layer.xml deleted file mode 100644 index 485ad1498b..0000000000 --- a/reference/fann/functions/fann-set-activation-steepness-layer.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - fann_set_activation_steepness_layer - Définit la pente d'activation pour tous les neurones dans la couche dont le numéro est fourni - - - - &reftitle.description; - - boolfann_set_activation_steepness_layer - resourceann - floatactivation_steepness - intlayer - - - Définit la pente d'activation pour tous les neurones dans la couche numéro layer, - en comptant la couche d'entrée comme la couche numéro 0. - - - Il n'est pas possible de définir la pente d'activation pour les neurones de la couche - d'entrée. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_steepness - - - La pente d'activation. - - - - - layer - - - Le numéro de la couche. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_steepness - fann_set_activation_steepness_hidden - fann_set_activation_steepness_output - fann_get_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-steepness-output.xml b/reference/fann/functions/fann-set-activation-steepness-output.xml deleted file mode 100644 index c01fd1a965..0000000000 --- a/reference/fann/functions/fann-set-activation-steepness-output.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - fann_set_activation_steepness_output - Définit la raideur de la pente d'activation dans la couche de sortie - - - - &reftitle.description; - - boolfann_set_activation_steepness_output - resourceann - floatactivation_steepness - - - Définit la raideur de la pente d'activation dans la couche de sortie. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_steepness - - - La raideur de la pente d'activation. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_steepness - fann_set_activation_steepness_layer - fann_set_activation_steepness_hidden - fann_get_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-steepness.xml b/reference/fann/functions/fann-set-activation-steepness.xml deleted file mode 100644 index b59ef7f9bf..0000000000 --- a/reference/fann/functions/fann-set-activation-steepness.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - fann_set_activation_steepness - Définit la pente d'activation pour le neurone et le numéro de couche donnés - - - - &reftitle.description; - - boolfann_set_activation_steepness - resourceann - floatactivation_steepness - intlayer - intneuron - - - Définit la pente d'activation pour le neurone numéro neuron - dans la couche numéro layer, en comptant la couche d'entrée - comme la couche numéro 0. - - - Il n'est pas possible de définir la pente d'activation pour les neurones - dans la couche d'entrée. - - - La pente d'une fonction d'activation indique une valeur signifiant la rapidité de la fonction - d'activation pour aller du minimum au maximum. Une valeur haute pour la fonction - d'activation va également produire un entraînement plus agressif. - - - Lors d'un entraînement sur des réseaux neuronaux, où les valeurs de sortie doivent - être aux extrêmes (habituellement, 0 et 1, suivant la fonction d'activation), - une fonction de pente d'activation peut être utilisée (c.-à-d. 1.0). - - - La pente d'activation par défaut est 0.5. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_steepness - - - La pente d'activation. - - - - - layer - - - Le numéro de la couche. - - - - - neuron - - - Le numéro du neurone. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_steepness_layer - fann_set_activation_steepness_hidden - fann_set_activation_steepness_output - fann_get_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-bit-fail-limit.xml b/reference/fann/functions/fann-set-bit-fail-limit.xml deleted file mode 100644 index 96f2257adc..0000000000 --- a/reference/fann/functions/fann-set-bit-fail-limit.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - fann_set_bit_fail_limit - Définit la limite d'échec de bit, utilisée pendant l'entraînement - - - - &reftitle.description; - - boolfann_set_bit_fail_limit - resourceann - floatbit_fail_limit - - - Définit la limite d'échec de bit, utilisée pendant l'entraînement. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - bit_fail_limit - - - La limite d'échec de bit. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_bit_fail_limit - - - - - - - diff --git a/reference/fann/functions/fann-set-callback.xml b/reference/fann/functions/fann-set-callback.xml deleted file mode 100644 index 36a1584f4d..0000000000 --- a/reference/fann/functions/fann-set-callback.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - - fann_set_callback - Définit la fonction de rappel à utiliser pendant l'entraînement - - - - &reftitle.description; - - boolfann_set_callback - resourceann - callablecallback - - - Définit la fonction de rappel à utiliser pendant l'entraînement. - Elle sera appelée depuis la fonction - fann_train_on_data ou la fonction - fann_train_on_file. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - callback - - - La fonction de rappel fournie prendra les paramètres suivants : - - - ann - Une ressource représentant le réseau neuronal - - - train - Une ressource représentant - les données d'entraînement ou &null; si appelé depuis la fonction - fann_train_on_file - - - max_epochs - Le nombre maximal d'époques que - l'entraînement doit continuer - - - epochs_between_reports - Le nombre d'époques - entre les appels à cette fonction - - - desired_error - Le choix entre - fann_get_MSE et - fann_get_bit_fail, suivant la fonction d'arrêt - choisie par la fonction fann_set_train_stop_function - - - epochs - L'époque courante - - - - - La fonction de rappel doit retourner &true;. Si elle retourne &false;, - l'entraînement se terminera. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_train_on_file - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-activation-functions.xml b/reference/fann/functions/fann-set-cascade-activation-functions.xml deleted file mode 100644 index 5facbd96b5..0000000000 --- a/reference/fann/functions/fann-set-cascade-activation-functions.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - fann_set_cascade_activation_functions - Définit le tableau des fonctions d'activation candidate en cascade - - - - &reftitle.description; - - boolfann_set_cascade_activation_functions - resourceann - arraycascade_activation_functions - - - Définit le tableau des fonctions d'activation candidate en cascade. - - - Voir la fonction fann_get_cascade_num_candidates - pour savoir quels neurones candidats seront générés par ce tableau. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_activation_functions - - - Le tableau des fonctions d'activation candidate en cascade. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_activation_functions_count - fann_set_cascade_activation_functions - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml b/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml deleted file mode 100644 index 6934776884..0000000000 --- a/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - fann_set_cascade_activation_steepnesses - Définit le tableau des raideurs d'activation candidate en cascade - - - - &reftitle.description; - - boolfann_set_cascade_activation_steepnesses - resourceann - arraycascade_activation_steepnesses_count - - - Définit le tableau des raideurs d'activation candidate en cascade. - - - Voir la fonction fann_get_cascade_num_candidates - pour savoir quels neurones candidats seront générés par ce tableau. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_activation_steepnesses_count - - - Le tableau des raideurs d'activation candidate en cascade. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_activation_steepnesses - fann_get_cascade_activation_steepnesses_count - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml b/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml deleted file mode 100644 index 181adee188..0000000000 --- a/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_candidate_change_fraction - Définit la fraction de modification candidate en cascade - - - - &reftitle.description; - - boolfann_set_cascade_candidate_change_fraction - resourceann - floatcascade_candidate_change_fraction - - - Définit la fraction de modification candidate en cascade. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_candidate_change_fraction - - - La fraction de modification candidate en cascade. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_candidate_change_fraction - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-candidate-limit.xml b/reference/fann/functions/fann-set-cascade-candidate-limit.xml deleted file mode 100644 index f44bbec503..0000000000 --- a/reference/fann/functions/fann-set-cascade-candidate-limit.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_candidate_limit - Définit la limite candidate - - - - &reftitle.description; - - boolfann_set_cascade_candidate_limit - resourceann - floatcascade_candidate_limit - - - Définit la limite candidate. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_candidate_limit - - - La limite candidate. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_candidate_limit - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-candidate-stagnation-epochs.xml b/reference/fann/functions/fann-set-cascade-candidate-stagnation-epochs.xml deleted file mode 100644 index ab8ea5bcbc..0000000000 --- a/reference/fann/functions/fann-set-cascade-candidate-stagnation-epochs.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_candidate_stagnation_epochs - Définit le nombre d'époques de stagnation candidates en cascade - - - - &reftitle.description; - - boolfann_set_cascade_candidate_stagnation_epochs - resourceann - intcascade_candidate_stagnation_epochs - - - Définit le nombre d'époques de stagnation candidates en cascade. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_candidate_stagnation_epochs - - - Le nombre d'époques de stagnation candidates en cascade. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_candidate_stagnation_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-max-cand-epochs.xml b/reference/fann/functions/fann-set-cascade-max-cand-epochs.xml deleted file mode 100644 index 01e03d619b..0000000000 --- a/reference/fann/functions/fann-set-cascade-max-cand-epochs.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_max_cand_epochs - Définit l'époque maximale candidate - - - - &reftitle.description; - - boolfann_set_cascade_max_cand_epochs - resourceann - intcascade_max_cand_epochs - - - Définit l'époque maximale candidate. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_max_cand_epochs - - - L'époque maximale candidate. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_max_cand_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-max-out-epochs.xml b/reference/fann/functions/fann-set-cascade-max-out-epochs.xml deleted file mode 100644 index e207446a11..0000000000 --- a/reference/fann/functions/fann-set-cascade-max-out-epochs.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_max_out_epochs - Définit l'époque maximale de sortie - - - - &reftitle.description; - - boolfann_set_cascade_max_out_epochs - resourceann - intcascade_max_out_epochs - - - Définit l'époque maximale de sortie. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_max_out_epochs - - - L'époque maximale de sortie. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_max_out_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-min-cand-epochs.xml b/reference/fann/functions/fann-set-cascade-min-cand-epochs.xml deleted file mode 100644 index b478e2e33e..0000000000 --- a/reference/fann/functions/fann-set-cascade-min-cand-epochs.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - fann_set_cascade_min_cand_epochs - Définit l'époque minimale candidate - - - - &reftitle.description; - - boolfann_set_cascade_min_cand_epochs - resourceann - intcascade_min_cand_epochs - - - Définit l'époque minimale candidate. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_min_cand_epochs - - - L'époque minimale candidate. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_cascade_min_cand_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-min-out-epochs.xml b/reference/fann/functions/fann-set-cascade-min-out-epochs.xml deleted file mode 100644 index bb860ce5ea..0000000000 --- a/reference/fann/functions/fann-set-cascade-min-out-epochs.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - fann_set_cascade_min_out_epochs - Définit l'époque minimale de sortie - - - - &reftitle.description; - - boolfann_set_cascade_min_out_epochs - resourceann - intcascade_min_out_epochs - - - Définit l'époque minimale de sortie. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_min_out_epochs - - - L'époque minimale de sortie. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_cascade_min_out_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-num-candidate-groups.xml b/reference/fann/functions/fann-set-cascade-num-candidate-groups.xml deleted file mode 100644 index 5c37aa06f7..0000000000 --- a/reference/fann/functions/fann-set-cascade-num-candidate-groups.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_num_candidate_groups - Définit le nombre de groupes candidats - - - - &reftitle.description; - - boolfann_set_cascade_num_candidate_groups - resourceann - intcascade_num_candidate_groups - - - Définit le nombre de groupes candidats. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_num_candidate_groups - - - Le nombre de groupes candidats. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_num_candidate_groups - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-output-change-fraction.xml b/reference/fann/functions/fann-set-cascade-output-change-fraction.xml deleted file mode 100644 index a6e542afe3..0000000000 --- a/reference/fann/functions/fann-set-cascade-output-change-fraction.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_output_change_fraction - Définit la fraction de modification de sortie en cascade - - - - &reftitle.description; - - boolfann_set_cascade_output_change_fraction - resourceann - floatcascade_output_change_fraction - - - Définit la fraction de modification de sortie en cascade. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_output_change_fraction - - - La fraction de modification de sortie en cascade. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_output_change_fraction - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-output-stagnation-epochs.xml b/reference/fann/functions/fann-set-cascade-output-stagnation-epochs.xml deleted file mode 100644 index 3e79b965d2..0000000000 --- a/reference/fann/functions/fann-set-cascade-output-stagnation-epochs.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_output_stagnation_epochs - Définit le nombre d'époques de stagnation en cascade de sortie - - - - &reftitle.description; - - boolfann_set_cascade_output_stagnation_epochs - resourceann - intcascade_output_stagnation_epochs - - - Définit le nombre d'époques de stagnation en cascade de sortie. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_output_stagnation_epochs - - - Le nombre d'époques de stagnation en cascade de sortie. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_output_stagnation_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-weight-multiplier.xml b/reference/fann/functions/fann-set-cascade-weight-multiplier.xml deleted file mode 100644 index 4b326feded..0000000000 --- a/reference/fann/functions/fann-set-cascade-weight-multiplier.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_weight_multiplier - Définit le multiplicateur de poids - - - - &reftitle.description; - - boolfann_set_cascade_weight_multiplier - resourceann - floatcascade_weight_multiplier - - - Définit le multiplicateur de poids. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_weight_multiplier - - - Le multiplicateur de poids. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_weight_multiplier - - - - - - - - diff --git a/reference/fann/functions/fann-set-error-log.xml b/reference/fann/functions/fann-set-error-log.xml deleted file mode 100644 index 0145cfabbf..0000000000 --- a/reference/fann/functions/fann-set-error-log.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - fann_set_error_log - Définit l'endroit où les erreurs seront historisées - - - - &reftitle.description; - - voidfann_set_error_log - resourceerrdat - stringlog_file - - - Définit l'endroit où les erreurs seront historisées. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - log_file - - - Le chemin du fichier d'historisation. - - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - - diff --git a/reference/fann/functions/fann-set-input-scaling-params.xml b/reference/fann/functions/fann-set-input-scaling-params.xml deleted file mode 100644 index ba21ca3977..0000000000 --- a/reference/fann/functions/fann-set-input-scaling-params.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - fann_set_input_scaling_params - Calcule les paramètres d'échelle d'entrée pour une utilisation - future, en se basant sur les données d'entraînement - - - - &reftitle.description; - - boolfann_set_input_scaling_params - resourceann - resourcetrain_data - floatnew_input_min - floatnew_input_max - - - Calcule les paramètres d'échelle d'entrée pour une utilisation - future, en se basant sur les données d'entraînement. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - new_input_min - - - La limite inférieure souhaitée dans les données d'entrée après - mise à l'échelle (pas strictement suivie) - - - - - new_input_max - - - La limite supérieure souhaitée dans les données d'entrée après - mise à l'échelle (pas strictement suivie) - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_output_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-set-learning-momentum.xml b/reference/fann/functions/fann-set-learning-momentum.xml deleted file mode 100644 index d230800ed6..0000000000 --- a/reference/fann/functions/fann-set-learning-momentum.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - fann_set_learning_momentum - Définit la dynamique d'apprentissage - - - - &reftitle.description; - - boolfann_set_learning_momentum - resourceann - floatlearning_momentum - - - Définit la dynamique d'apprentissage. - - - Plus d'informations disponibles sur la page de documentation - de la fonction fann_get_learning_momentum. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - learning_momentum - - - La dynamique d'apprentissage. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_learning_momentum - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-set-learning-rate.xml b/reference/fann/functions/fann-set-learning-rate.xml deleted file mode 100644 index 842a3d09f8..0000000000 --- a/reference/fann/functions/fann-set-learning-rate.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - fann_set_learning_rate - Définit le taux d'apprentissage - - - - &reftitle.description; - - boolfann_set_learning_rate - resourceann - floatlearning_rate - - - Définit le taux d'apprentissage. - - - Plus d'informations disponibles sur la page de la documentation - de la fonction fann_get_learning_rate. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - learning_rate - - - Le taux d'apprentissage. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_learning_rate - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-set-output-scaling-params.xml b/reference/fann/functions/fann-set-output-scaling-params.xml deleted file mode 100644 index 435970218b..0000000000 --- a/reference/fann/functions/fann-set-output-scaling-params.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - fann_set_output_scaling_params - Calcule les paramètres d'échelle de sortie pour une utilisation future, - en se basant sur les données d'entraînement - - - - &reftitle.description; - - boolfann_set_output_scaling_params - resourceann - resourcetrain_data - floatnew_output_min - floatnew_output_max - - - Calcule les paramètres d'échelle de sortie pour une utilisation future, - en se basant sur les données d'entraînement. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - new_output_min - - - La limite inférieure souhaitée dans les données de sortie - après mise à l'échelle (pas strictement suivie) - - - - - new_output_max - - - La limite supérieure souhaitée dans les données de sortie - après mise à l'échelle (pas strictement suivie) - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_input_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-set-quickprop-decay.xml b/reference/fann/functions/fann-set-quickprop-decay.xml deleted file mode 100644 index d8484a16e1..0000000000 --- a/reference/fann/functions/fann-set-quickprop-decay.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_quickprop_decay - Définit le facteur décroissant quickprop - - - - &reftitle.description; - - boolfann_set_quickprop_decay - resourceann - floatquickprop_decay - - - Définit le facteur décroissant quickprop. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - quickprop_decay - - - Le facteur décroissant quickprop. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_quickprop_decay - - - - - - - - diff --git a/reference/fann/functions/fann-set-quickprop-mu.xml b/reference/fann/functions/fann-set-quickprop-mu.xml deleted file mode 100644 index 03721f4ac0..0000000000 --- a/reference/fann/functions/fann-set-quickprop-mu.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_quickprop_mu - Définit le facteur quickprop mu - - - - &reftitle.description; - - boolfann_set_quickprop_mu - resourceann - floatquickprop_mu - - - Définit le facteur quickprop mu. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - quickprop_mu - - - Le facteur mu. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_quickprop_mu - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-decrease-factor.xml b/reference/fann/functions/fann-set-rprop-decrease-factor.xml deleted file mode 100644 index bf43081195..0000000000 --- a/reference/fann/functions/fann-set-rprop-decrease-factor.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_rprop_decrease_factor - Définit le facteur de diminution utilisé pendant l'entraînement RPROP - - - - &reftitle.description; - - boolfann_set_rprop_decrease_factor - resourceann - floatrprop_decrease_factor - - - Définit le facteur de diminution utilisé pendant l'entraînement RPROP. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_decrease_factor - - - Le facteur de diminution. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_decrease_factor - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-delta-max.xml b/reference/fann/functions/fann-set-rprop-delta-max.xml deleted file mode 100644 index 46232e0021..0000000000 --- a/reference/fann/functions/fann-set-rprop-delta-max.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - fann_set_rprop_delta_max - Définit la taille maximale de l'étape - - - - &reftitle.description; - - boolfann_set_rprop_delta_max - resourceann - floatrprop_delta_max - - - La taille maximale de l'étape est un nombre positif déterminant - combien la taille maximale de l'étape peut être. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_delta_max - - - La taille maximale de l'étape. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_delta_max - fann_get_rprop_delta_min - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-delta-min.xml b/reference/fann/functions/fann-set-rprop-delta-min.xml deleted file mode 100644 index f41b492f11..0000000000 --- a/reference/fann/functions/fann-set-rprop-delta-min.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - fann_set_rprop_delta_min - Définit la taille minimale de l'étape - - - - &reftitle.description; - - boolfann_set_rprop_delta_min - resourceann - floatrprop_delta_min - - - La taille minimale de l'étape est un petit nombre positif - déterminant combien la taille minimale de l'étape peut être. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_delta_min - - - La taille minimale de l'étape. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_delta_min - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-delta-zero.xml b/reference/fann/functions/fann-set-rprop-delta-zero.xml deleted file mode 100644 index 248726a071..0000000000 --- a/reference/fann/functions/fann-set-rprop-delta-zero.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - fann_set_rprop_delta_zero - Définit la taille de l'étape initiale - - - - &reftitle.description; - - boolfann_set_rprop_delta_zero - resourceann - floatrprop_delta_zero - - - Définit la taille de l'étape initiale ; doit être un nombre positif. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_delta_zero - - - La taille de l'étape initiale. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_delta_zero - fann_get_rprop_delta_min - fann_get_rprop_delta_max - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-increase-factor.xml b/reference/fann/functions/fann-set-rprop-increase-factor.xml deleted file mode 100644 index 1a7f64c40d..0000000000 --- a/reference/fann/functions/fann-set-rprop-increase-factor.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_rprop_increase_factor - Définit le facteur d'augmentation utilisé pendant l'entraînement RPROP - - - - &reftitle.description; - - boolfann_set_rprop_increase_factor - resourceann - floatrprop_increase_factor - - - Définit le facteur d'augmentation utilisé pendant l'entraînement RPROP. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_increase_factor - - - Le facteur d'augmentation. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_increase_factor - - - - - - - - diff --git a/reference/fann/functions/fann-set-sarprop-step-error-shift.xml b/reference/fann/functions/fann-set-sarprop-step-error-shift.xml deleted file mode 100644 index 76ff325c0b..0000000000 --- a/reference/fann/functions/fann-set-sarprop-step-error-shift.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - fann_set_sarprop_step_error_shift - Définit le changement de l'étape d'erreur sarprop - - - - &reftitle.description; - - boolfann_set_sarprop_step_error_shift - resourceann - floatsarprop_step_error_shift - - - Définit le changement de l'étape d'erreur sarprop. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - sarprop_step_error_shift - - - Le changement de l'étape d'erreur sarprop. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_sarprop_step_error_shift - - - - - - - - diff --git a/reference/fann/functions/fann-set-sarprop-step-error-threshold-factor.xml b/reference/fann/functions/fann-set-sarprop-step-error-threshold-factor.xml deleted file mode 100644 index 43f7568c94..0000000000 --- a/reference/fann/functions/fann-set-sarprop-step-error-threshold-factor.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - fann_set_sarprop_step_error_threshold_factor - Définit le facteur de seuil de l'étape d'erreur sarprop - - - - &reftitle.description; - - boolfann_set_sarprop_step_error_threshold_factor - resourceann - floatsarprop_step_error_threshold_factor - - - Définit le facteur de seuil de l'étape d'erreur sarprop. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - sarprop_step_error_threshold_factor - - - Le facteur de seuil de l'étape d'erreur sarprop. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_sarprop_step_error_threshold_factor - - - - - - - - diff --git a/reference/fann/functions/fann-set-sarprop-temperature.xml b/reference/fann/functions/fann-set-sarprop-temperature.xml deleted file mode 100644 index 64a99de912..0000000000 --- a/reference/fann/functions/fann-set-sarprop-temperature.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - fann_set_sarprop_temperature - Définit la température sarprop - - - - &reftitle.description; - - boolfann_set_sarprop_temperature - resourceann - floatsarprop_temperature - - - Définit la température sarprop. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - sarprop_temperature - - - La température sarprop. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_sarprop_temperature - - - - - - - - diff --git a/reference/fann/functions/fann-set-sarprop-weight-decay-shift.xml b/reference/fann/functions/fann-set-sarprop-weight-decay-shift.xml deleted file mode 100644 index 544f867218..0000000000 --- a/reference/fann/functions/fann-set-sarprop-weight-decay-shift.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - fann_set_sarprop_weight_decay_shift - Définit le changement décroissant du poids de sarprop - - - - &reftitle.description; - - boolfann_set_sarprop_weight_decay_shift - resourceann - floatsarprop_weight_decay_shift - - - Définit le changement décroissant du poids de sarprop. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - sarprop_weight_decay_shift - - - Le changement décroissant du poids de sarprop. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_sarprop_weight_decay_shift - - - - - - - - diff --git a/reference/fann/functions/fann-set-scaling-params.xml b/reference/fann/functions/fann-set-scaling-params.xml deleted file mode 100644 index 3d3ce5b9f1..0000000000 --- a/reference/fann/functions/fann-set-scaling-params.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - fann_set_scaling_params - Calcule les paramètres d'échelles d'entrée et de sortie - utilisés en se basant sur les données d'entraînement - - - - &reftitle.description; - - boolfann_set_scaling_params - resourceann - resourcetrain_data - floatnew_input_min - floatnew_input_max - floatnew_output_min - floatnew_output_max - - - Calcule les paramètres d'échelles d'entrée et de sortie - utilisés en se basant sur les données d'entraînement. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - new_input_min - - - La limite inférieure souhaitée dans les données d'entrée - après mise à l'échelle (pas strictement suivie) - - - - - new_input_max - - - La limite supérieure souhaitée dans les données d'entrée - après mise à l'échelle (pas strictement suivie) - - - - - new_output_min - - - La limite inférieure souhaitée dans les données de sortie - après mise à l'échelle (pas strictement suivie) - - - - - new_output_max - - - La limite supérieure souhaitée dans les données de sortie - après mise à l'échelle (pas strictement suivie) - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_input_scaling_params - fann_set_output_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-set-train-error-function.xml b/reference/fann/functions/fann-set-train-error-function.xml deleted file mode 100644 index 92795119bc..0000000000 --- a/reference/fann/functions/fann-set-train-error-function.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - fann_set_train_error_function - Définit la fonction d'erreur utilisée pendant l'entraînement - - - - &reftitle.description; - - boolfann_set_train_error_function - resourceann - interror_function - - - Définit la fonction d'erreur utilisée pendant l'entraînement. - - - Les fonctions d'erreur sont décrites dans la page de la documentation - sur les constantes des fonctions - d'erreur. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - error_function - - - Une constante de fonction - d'erreur - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_train_error_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-train-stop-function.xml b/reference/fann/functions/fann-set-train-stop-function.xml deleted file mode 100644 index 1c09e4fd3c..0000000000 --- a/reference/fann/functions/fann-set-train-stop-function.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - fann_set_train_stop_function - Définit la fonction d'arrêt à utiliser durant l'entraînement - - - - &reftitle.description; - - boolfann_set_train_stop_function - resourceann - intstop_function - - - Définit la fonction d'arrêt à utiliser durant l'entraînement. - - - Les fonctions d'arrêt sont décrites dans la page de la documentation - sur les constantes des - fonctions d'arrêt. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - stop_function - - - Une constante de fonction - d'arrêt. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_train_stop_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-training-algorithm.xml b/reference/fann/functions/fann-set-training-algorithm.xml deleted file mode 100644 index 59ba454cf4..0000000000 --- a/reference/fann/functions/fann-set-training-algorithm.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - fann_set_training_algorithm - Définit l'algorithme d'entraînement - - - - &reftitle.description; - - boolfann_set_training_algorithm - resourceann - inttraining_algorithm - - - Définit l'algorithme d'entraînement. - - - Plus d'informations disponibles sur la page de la fonction - fann_get_training_algorithm. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - training_algorithm - - - Une constante d'algorithme - d'entraînement - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-set-weight-array.xml b/reference/fann/functions/fann-set-weight-array.xml deleted file mode 100644 index f799ce7cc9..0000000000 --- a/reference/fann/functions/fann-set-weight-array.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - fann_set_weight_array - Définit les connexions dans le réseau - - - - &reftitle.description; - - boolfann_set_weight_array - resourceann - arrayconnections - - - Définit les connexions dans le réseau. - - - Seuls les poids peuvent être changés ; les connexions - et les poids sont ignorés s'ils n'existent pas déjà dans - le réseau. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - connections - - - Un tableau d'objets FANNConnection - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - - diff --git a/reference/fann/functions/fann-set-weight.xml b/reference/fann/functions/fann-set-weight.xml deleted file mode 100644 index 4176317a0e..0000000000 --- a/reference/fann/functions/fann-set-weight.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - fann_set_weight - Définit une connexion dans le réseau - - - - &reftitle.description; - - boolfann_set_weight - resourceann - intfrom_neuron - intto_neuron - floatweight - - - Définit une connexion dans le réseau. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - from_neuron - - - Le neurone où la connexion commence - - - - - to_neuron - - - Le neurone où la connexion se termine - - - - - weight - - - Poids de la connexion - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - - diff --git a/reference/fann/functions/fann-shuffle-train-data.xml b/reference/fann/functions/fann-shuffle-train-data.xml deleted file mode 100644 index e3e846959e..0000000000 --- a/reference/fann/functions/fann-shuffle-train-data.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - fann_shuffle_train_data - Mélange les données d'entraînement, et rend aléatoire leur ordre - - - - &reftitle.description; - - boolfann_shuffle_train_data - resourcetrain_data - - - Mélange les données d'entraînement, et rend aléatoire leur ordre. - Ceci est recommandé pour un entraînement incrémental, alors qu'il n'a - aucune influence sur le lot d'entraînement. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - diff --git a/reference/fann/functions/fann-subset-train-data.xml b/reference/fann/functions/fann-subset-train-data.xml deleted file mode 100644 index bc59f9ad4d..0000000000 --- a/reference/fann/functions/fann-subset-train-data.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - fann_subset_train_data - Retourne une copie d'un sous-jeu de données d'entraînement - - - - &reftitle.description; - - resourcefann_subset_train_data - resourcedata - intpos - intlength - - - Retourne une copie du sous-jeu de données d'entraînement, - en commençant à la position pos et - des length éléments suivants. - - - Le code fann_subset_train_data(train_data, - 0, fann_length_train_data(train_data)) réalise la - même chose que la fonction fann_duplicate_train_data. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - pos - - - Position de départ. - - - - - length - - - Le nombre d'éléments copiés. - - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - &reftitle.seealso; - - - fann_duplicate_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-test-data.xml b/reference/fann/functions/fann-test-data.xml deleted file mode 100644 index 6c289fe5f5..0000000000 --- a/reference/fann/functions/fann-test-data.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - fann_test_data - Effectue un test sur un jeu de données d'entraînement - et calcule le MSE pour ces données - - - - &reftitle.description; - - floatfann_test_data - resourceann - resourcedata - - - Effectue un test sur un jeu de données d'entraînement - et calcule le MSE pour ces données. - - - Cette fonction met à jour le MSE et les valeurs de bits échoués. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - Le MSE mis à jour, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_train_on_data - fann_train_epoch - fann_get_bit_fail - fann_get_MSE - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-test.xml b/reference/fann/functions/fann-test.xml deleted file mode 100644 index 82e1263f5d..0000000000 --- a/reference/fann/functions/fann-test.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - fann_test - Effectue un test avec un jeu d'entrées et un jeu de sorties désirées - - - - &reftitle.description; - - arrayfann_test - resourceann - arrayinput - arraydesired_output - - - Effectue un test avec un jeu d'entrées et un jeu de sorties désirées. - Cette opération met à jour l'erreur quadratique moyenne, mais - ne modifie en aucune façon le réseau. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input - - - Un tableau d'entrées. Ce tableau doit être d'une longueur exacte - de fann_get_num_input. - - - - - desired_output - - - Un tableau de sorties désirées. Ce tableau doit être d'une longueur exacte - de fann_get_num_output. - - - - - - - - &reftitle.returnvalues; - Retourne les sorties de test en cas de succès, ou &false; en cas d'erreur. - - - - &reftitle.seealso; - - - fann_test_data - fann_train - fann_get_num_input - fann_get_num_output - - - - - - - - diff --git a/reference/fann/functions/fann-train-epoch.xml b/reference/fann/functions/fann-train-epoch.xml deleted file mode 100644 index c6caa0faf3..0000000000 --- a/reference/fann/functions/fann-train-epoch.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - fann_train_epoch - Effectue un entraînement avec un jeu de données d'entraînement - - - - &reftitle.description; - - floatfann_train_epoch - resourceann - resourcedata - - - Effectue un entraînement avec un jeu de données d'entraînement. - Une époque correspond au fait que toutes les données d'entraînement - sont considérées exactement une fois. - - - Cette fonction retourne l'erreur MSE sachant qu'elle est calculée - soit avant, soit pendant l'entraînement actuel. Ce n'est pas le - MSE actuel après l'époque d'entraînement, sachant que ce calcul - nécessite le parcours de la totalité du jeu de données d'entraînement - au moins une fois. Il est donc plus adéquat d'utiliser cette valeur - pendant l'entraînement. - - - L'algorithme d'entraînement utilisé par cette fonction est choisi - par la fonction fann_set_training_algorithm. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - Le MSE, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - fann_train_on_data - fann_test_data - fann_get_MSE - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-train-on-data.xml b/reference/fann/functions/fann-train-on-data.xml deleted file mode 100644 index 9ade95b38a..0000000000 --- a/reference/fann/functions/fann-train-on-data.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - - fann_train_on_data - Effectue un entraînement sur un jeu de données complet pour une période de temps - - - - &reftitle.description; - - boolfann_train_on_data - resourceann - resourcedata - intmax_epochs - intepochs_between_reports - floatdesired_error - - - Effectue un entraînement sur un jeu de données complet pour une période de - temps. - - - Cet entraînement utilise l'algorithme d'entraînement choisi - par la fonction fann_set_training_algorithm et - le jeu de paramètres pour ces algorithmes d'entraînement. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - data - - &fann.train.description; - - - - max_epochs - - - Le nombre maximal d'époques que l'entraînement doit durer - - - - - epochs_between_reports - - - Le nombre d'époques entre les appels à la fonction de rappel. - Une valeur de zéro signifie que la fonction utilisateur - ne sera jamais appelée. - - - - - desired_error - - - Le fann_get_MSE ou le - fann_get_bit_fail voulu, suivant la - fonction d'arrêt choisie par la fonction - fann_set_train_stop_function - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_file - fann_train_epoch - fann_get_bit_fail - fann_get_MSE - fann_set_train_stop_function - fann_set_training_algorithm - fann_set_callback - - - - - - - - diff --git a/reference/fann/functions/fann-train-on-file.xml b/reference/fann/functions/fann-train-on-file.xml deleted file mode 100644 index 075e03a24b..0000000000 --- a/reference/fann/functions/fann-train-on-file.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - fann_train_on_file - Effectue un entraînement sur un jeu complet de données, - qui peut être lu depuis un fichier, pour une période de temps - - - - &reftitle.description; - - boolfann_train_on_file - resourceann - stringfilename - intmax_epochs - intepochs_between_reports - floatdesired_error - - - Effectue un entraînement sur un jeu complet de données, - qui peut être lu depuis un fichier, pour une période de temps. - - - Cet entraînement utilise l'algorithme d'entraînement choisi par - la fonction fann_set_training_algorithm et le - jeu de paramètres pour ces algorithmes d'entraînement. - - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - filename - - - Le fichier contenant les données d'entraînement - - - - - max_epochs - - - Le nombre maximal d'époques que l'entraînement doit traiter - - - - - epochs_between_reports - - - Le nombre maximal d'époques entre l'appel à la fonction utilisateur. - Une valeur de zéro signifie que la fonction utilisateur n'est - pas appelée. - - - - - desired_error - - - Le fann_get_MSE ou le - fann_get_bit_fail voulu, - suivant la fonction d'arrêt choisie par la fonction - fann_set_train_stop_function - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_train_epoch - fann_get_bit_fail - fann_get_MSE - fann_set_train_stop_function - fann_set_training_algorithm - fann_set_callback - - - - - - - - diff --git a/reference/fann/functions/fann-train.xml b/reference/fann/functions/fann-train.xml deleted file mode 100644 index 7e3676f738..0000000000 --- a/reference/fann/functions/fann-train.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - fann_train - Effectue un entraînement sur une itération avec un jeu d'entrées, - et un jeu de sorties désirées - - - - &reftitle.description; - - boolfann_train - resourceann - arrayinput - arraydesired_output - - - Effectue un entraînement sur une itération avec un jeu d'entrées, - et un jeu de sorties désirées. Cet entraînement est toujours un - entraînement incrémental, sachant que seulement un motif est présenté. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input - - - Un tableau d'entrées. Ce tableau doit être exactement d'une longueur - de fann_get_num_input. - - - - - desired_output - - - Un tableau de sorties désirées. Ce tableau doit être exactement d'une - longueur de fann_get_num_output. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_train_epoch - fann_get_num_input - fann_get_num_output - - - - - - - - diff --git a/reference/fann/reference.xml b/reference/fann/reference.xml deleted file mode 100644 index b97f80c5a9..0000000000 --- a/reference/fann/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; Fann - - &reference.fann.entities.functions; - - - - diff --git a/reference/fann/setup.xml b/reference/fann/setup.xml deleted file mode 100644 index 5d8045d9cc..0000000000 --- a/reference/fann/setup.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - PHP >= 5.2.0 et libfann >= 2.1.0 - -
- -
- &reftitle.install; - - L'extension FANN PHP devrait fonctionner sur tous les systèmes Linux. - - - - - - - - - - - - - - -
- - Installation de la bibliothèque FANN - - - Avant de commencer l'installation, il faut s'assurer que libfann est installé - sur le système. Il fait partie du dépôt principal dans la plupart des distributions Linux - (recherchez fann). La version de développement de la bibliothèque est nécessaire. - - - Si ce n'est pas installé, il faut d'abord l'installer. Téléchargez-le depuis le - site officiel ou obtenez-le depuis le dépôt de la - distribution. Par exemple sur Fedora: - - - - ou Ubuntu : - - - - - - Si la bibliothèque est ré-installée manuellement, alors tous les anciens fichiers de la bibliothèque - doivent être supprimés avant de ré-installer sinon l'ancienne version de la bibliothèque pourrait être liée. - -
- -
- - Installation PECL - - - Cette extension est disponible sur PECL. L'installation est très simple. Exécuter simplement : - - - - -
- -
- - Installation manuelle - - - Pour les développeurs et les personnes intéressées par les derniers changements, l'on - peut compiler le pilote à partir du code source le plus récent sur - Github. - Allez sur Github et cliquez sur le bouton "Download ZIP". Ensuite exécutez: - - - - - - - - Appliquez les changements suivants à php.ini: - - - - - Il faut s'assurer que la variable extension_dir pointe vers - le répertoire contenant fann.so. La construction affichera où - il installe le pilote PHP avec une sortie qui ressemble à: - - - - - Il faut s'assurer que c'est le même que le répertoire d'extension PHP en exécutant: - - - /usr/lib/php/extensions/no-debug-non-zts-20060613 => - /usr/lib/php/extensions/no-debug-non-zts-20060613 - -]]> - - - Si ce n'est pas le cas, changez la variable extension_dir dans php.ini ou - déplacez fann.so. - - - - - Pour charger l'extension au démarrage de PHP, ajoutez une ligne: - - - - - - - - - -
-
- -
- &reftitle.resources; - - - -
- - - - diff --git a/reference/fdf/book.xml b/reference/fdf/book.xml deleted file mode 100644 index 6c6bad0a98..0000000000 --- a/reference/fdf/book.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - Format de formulaire - FDF - - - - &reftitle.intro; - - Forms Data Format (FDF) est un format de formulaire pour les documents - PDF. Il est possible de lire la documentation (en anglais) à - &spec.pdf.fdf; - pour plus de détails sur les tenants et les aboutissants. - - - L'esprit de FDF est similaire à celui des formulaires HTML. Les - différences résident dans les moyens de transmission des - données au serveur, lorsque le bouton "submit" (soumettre) est - pressé (ce qui est du ressort de Form Data Format) et le format de - formulaire lui-même (qui est plutôt du ressort de Portable Document - Format, PDF). Gérer des données FDF est un des objectifs des - fonctions FDF. Mais il y en a d'autres. Il est aussi possible de prendre un - formulaire PDF, et préremplir les champs, sans modifier le - formulaire lui-même. Dans ce cas, on va créer un document FDF - (fdf_create), remplir les champs - (fdf_set_value) et l'associer à un fichier PDF - (fdf_set_file). Finalement, le tout sera envoyé - au client, avec le type MIME application/vnd.fdf. Le module "Acrobat reader" - du navigateur va reconnaître ce type MIME, et lire le fichier - PDF, puis le remplir avec FDF. - - - - En éditant un fichier FDF avec un éditeur de texte, se trouve - un catalogue d'objets avec le nom de FDF. Cet objet - peut contenir des entrées telles que Fields, - F, Status etc. - Les entrées les plus couramment utilisées sont - Fields, qui indique une liste de champs de contrôle, - et F qui contient le nom du fichier PDF auquel - appartiennent ces données. Ces entrées sont désignées dans la documentation - PDF sous le nom de /F-Key ou /Status-Key. - La modification de ces entrées est possible avec les fonctions - fdf_set_file et fdf_set_status. - Les champs sont modifiables avec les fonctions - fdf_set_value, fdf_set_opt etc. - - - - - &reference.fdf.setup; - &reference.fdf.constants; - &reference.fdf.examples; - &reference.fdf.reference; - - - - diff --git a/reference/fdf/configure.xml b/reference/fdf/configure.xml deleted file mode 100644 index beb56af2a0..0000000000 --- a/reference/fdf/configure.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - -
- &reftitle.install; - - &pecl.info.dead; - &url.pecl.vcs;fdf. - - - Cette extension n'est plus fournie avec PHP. - - - - En cas de problèmes lors de la configuration de FDF - avec le support fdftk, vérifiez que le fichier d'en-tête - fdftk.h et la bibliothèque - libfdftk.so sont à leur place. Le script - configure supporte la hiérarchie de dossiers de la distribution - FDF SDK et l'organisation classique DIR/include et - DIR/lib : il est donc possible d'utiliser l'un ou l'autre - directement avec la distribution décompressée, ou bien en incluant le - fichier d'en-têtes et la bibliothèque appropriée dans le système, c'est-à-dire - dans /usr/local/include et - /usr/local/lib. Il ne reste plus qu'à configurer - avec . - - - - Note aux utilisateurs Win32 - - &ext.windows.path.dll; - fdftk.dll - - -
- diff --git a/reference/fdf/constants.xml b/reference/fdf/constants.xml deleted file mode 100644 index f832d3806c..0000000000 --- a/reference/fdf/constants.xml +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - FDFValue - (int) - - - - - - - - - - FDFStatus - (int) - - - - - - - - - - FDFFile - (int) - - - - - - - - - - FDFID - (int) - - - - - - - - - - FDFFf - (int) - - - - - - - - - - FDFSetFf - (int) - - - - - - - - - - FDFClearFf - (int) - - - - - - - - - - FDFFlags - (int) - - - - - - - - - - FDFSetF - (int) - - - - - - - - - - FDFClrF - (int) - - - - - - - - - - FDFAP - (int) - - - - - - - - - - FDFAS - (int) - - - - - - - - - - FDFAction - (int) - - - - - - - - - - FDFAA - (int) - - - - - - - - - - FDFAPRef - (int) - - - - - - - - - - FDFIF - (int) - - - - - - - - - - FDFEnter - (int) - - - - - - - - - - FDFExit - (int) - - - - - - - - - - FDFDown - (int) - - - - - - - - - - FDFUp - (int) - - - - - - - - - - FDFFormat - (int) - - - - - - - - - - FDFValidate - (int) - - - - - - - - - - FDFKeystroke - (int) - - - - - - - - - - FDFCalculate - (int) - - - - - - - - - - FDFNormalAP - (int) - - - - - - - - - - FDFRolloverAP - (int) - - - - - - - - - - FDFDownAP - (int) - - - - - - - - - - - diff --git a/reference/fdf/examples.xml b/reference/fdf/examples.xml deleted file mode 100644 index f285d45aff..0000000000 --- a/reference/fdf/examples.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - &reftitle.examples; - - Les exemples suivants montrent comment évaluer les données - du formulaire. - - Évaluer un document FDF - -' . $volume . '"
'; - -$date = fdf_get_value($fdf, "date"); -echo 'La valeur du champ date était "' . $date . '"
'; - -$comment = fdf_get_value($fdf, "comment"); -echo 'La valeur du champ comment était "' . $comment . '"
'; - -if (fdf_get_value($fdf, "show_publisher") == "On") { - $publisher = fdf_get_value($fdf, "publisher"); - echo "La valeur du champ Publisher était : '" . $publisher . "
"; -} else - echo 'La valeur du champ Publisher ne doit pas être affichée.
'; - -if (fdf_get_value($fdf, "show_preparer") == "On") { - $preparer = fdf_get_value($fdf, "preparer"); - echo 'La valeur du champ Preparer était "' . $preparer . '"
'; -} else - echo 'La valeur du champ Preparer ne doit pas être affichée.
'; -fdf_close($fdf); -?> -]]> - - - - - - diff --git a/reference/fdf/functions/fdf-add-doc-javascript.xml b/reference/fdf/functions/fdf-add-doc-javascript.xml deleted file mode 100755 index f8611eeac0..0000000000 --- a/reference/fdf/functions/fdf-add-doc-javascript.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - fdf_add_doc_javascript - Ajoute du code javascript dans un document FDF - - - - &reftitle.description; - - boolfdf_add_doc_javascript - resourcefdf_document - stringscript_name - stringscript_code - - - Ajoute le code javascript script_code - dans le document fdf_document, qu'Acrobat ajoutera aux scripts de - niveau document, une fois le FDF importé. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - script_name - - - Le nom du script. - - - - - script_code - - - Le code du script. Il est fortement recommandé d'utiliser \r - comme séparateur de lignes dans le code script_code. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ajout de code JavaScript à un document FDF - - -]]> - - - Cet exemple va créer un document FDF comme celui-ci : - - -> >> ->> -endobj -trailer -<< -/Root 1 0 R - ->> -%%EOF -]]> - - - - - - diff --git a/reference/fdf/functions/fdf-add-template.xml b/reference/fdf/functions/fdf-add-template.xml deleted file mode 100755 index b9880c0a60..0000000000 --- a/reference/fdf/functions/fdf-add-template.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - - fdf_add_template - Ajoute un template dans le document FDF - - - - &reftitle.description; - - boolfdf_add_template - resourcefdf_document - intnewpage - stringfilename - stringtemplate - intrename - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-close.xml b/reference/fdf/functions/fdf-close.xml deleted file mode 100644 index 4f382182e4..0000000000 --- a/reference/fdf/functions/fdf-close.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - fdf_close - Ferme un document FDF - - - - &reftitle.description; - - voidfdf_close - resourcefdf_document - - - Ferme le document FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - fdf_open - - - - diff --git a/reference/fdf/functions/fdf-create.xml b/reference/fdf/functions/fdf-create.xml deleted file mode 100644 index 504925bc88..0000000000 --- a/reference/fdf/functions/fdf-create.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - fdf_create - Crée un nouveau document FDF - - - - &reftitle.description; - - resourcefdf_create - - - - Crée un nouveau document FDF. - - - Cette fonction est nécessaire pour ceux qui veulent préremplir - les champs d'un formulaire dans un fichier PDF. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un gestionnaire de document FDF, ou &false; - si une erreur survient. - - - - - &reftitle.examples; - - Préremplir un formulaire PDF - - -]]> - - - - - - &reftitle.seealso; - - fdf_close - fdf_save - fdf_open - - - - - diff --git a/reference/fdf/functions/fdf-enum-values.xml b/reference/fdf/functions/fdf-enum-values.xml deleted file mode 100644 index 63ab3aa156..0000000000 --- a/reference/fdf/functions/fdf-enum-values.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - fdf_enum_values - Appelle une fonction utilisateur à chaque valeur FDF - - - - &reftitle.description; - - boolfdf_enum_values - resourcefdf_document - callablefunction - mixeduserdata - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-errno.xml b/reference/fdf/functions/fdf-errno.xml deleted file mode 100755 index 86f58f8c25..0000000000 --- a/reference/fdf/functions/fdf-errno.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - fdf_errno - Retourne le code d'erreur de la dernière opération FDF - - - - &reftitle.description; - - intfdf_errno - - - - Récupère le code d'erreur de la dernière opération FDF. - - - Un message d'erreur est accessible via la fonction - fdf_error. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le code erreur sous la forme d'un &integer; ou &zero; si aucune - erreur n'est survenue. - - - - - &reftitle.seealso; - - fdf_error - - - - diff --git a/reference/fdf/functions/fdf-error.xml b/reference/fdf/functions/fdf-error.xml deleted file mode 100755 index 693b1a8830..0000000000 --- a/reference/fdf/functions/fdf-error.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - fdf_error - Retourne le message d'erreur FDF - - - - &reftitle.description; - - stringfdf_error - interror_code-1 - - - Retourne une description textuelle du code d'erreur FDF fourni dans - error_code. - - - - - &reftitle.parameters; - - - error_code - - - Un code erreur obtenu avec la fonction - fdf_errno. S'il n'est pas fourni, cette fonction - utilise le code erreur interne défini par la dernière opération. - - - - - - - - &reftitle.returnvalues; - - Retourne le message d'erreur sous la forme d'une &string; ou - la chaîne no error s'il n'y en a pas. - - - - - &reftitle.seealso; - - fdf_errno - - - - - diff --git a/reference/fdf/functions/fdf-get-ap.xml b/reference/fdf/functions/fdf-get-ap.xml deleted file mode 100755 index 3cbfd8f622..0000000000 --- a/reference/fdf/functions/fdf-get-ap.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - fdf_get_ap - Lit l'apparence d'un champ - - - - &reftitle.description; - - boolfdf_get_ap - resourcefdf_document - stringfield - intface - stringfilename - - - Lit l'apparence du champ field (c.-à-d. la valeur - de la clé /AP) et le stocke dans le fichier filename. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - field - - - - - - - face - - - Les valeurs possibles sont FDFNormalAP, - FDFRolloverAP et FDFDownAP. - - - - - filename - - - L'apparence sera stockée dans ce paramètre. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/fdf/functions/fdf-get-attachment.xml b/reference/fdf/functions/fdf-get-attachment.xml deleted file mode 100755 index 5901c8fcc0..0000000000 --- a/reference/fdf/functions/fdf-get-attachment.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - fdf_get_attachment - Extrait un fichier téléversé intégré dans un document FDF - - - - &reftitle.description; - - arrayfdf_get_attachment - resourcefdf_document - stringfieldname - stringsavepath - - - Extrait le fichier fieldname - téléversé par le biais du champ "file selection", - puis le stocke dans le fichier savepath. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - fieldname - - - - - - - savepath - - - Peut être le nom d'un fichier ou bien un dossier dans lequel le - fichier téléversé sera créé sous son nom original. Tout fichier - déjà existant avec le même nom sera écrasé. - - - - Il semble qu'il n'y ait pas d'autre moyen pour connaître le nom du fichier téléversé - que de le stocker dans un dossier avec savepath puis - de lire son nom dans le dossier. - - - - - - - - - &reftitle.returnvalues; - - Le tableau retourné contient les champs suivants : - - - path - chemin où le fichier a été stocké - - - size - taille du fichier stocké en octets - - - type - Type MIME du fichier, s'il a été fourni dans le document FDF - - - - - - - &reftitle.examples; - - Enregistrement d'un fichier téléversé - - -]]> - - - - - - diff --git a/reference/fdf/functions/fdf-get-encoding.xml b/reference/fdf/functions/fdf-get-encoding.xml deleted file mode 100755 index 98c877d0a0..0000000000 --- a/reference/fdf/functions/fdf-get-encoding.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - fdf_get_encoding - Lit la valeur de la clé /Encoding - - - - &reftitle.description; - - stringfdf_get_encoding - resourcefdf_document - - - Récupère la valeur de la clé /Encoding. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Retourne l'encodage, sous la forme d'une &string;. Une chaîne vide - est retournée si le schéma par défaut PDFDocEncoding/Unicode - est utilisé. - - - - - &reftitle.seealso; - - fdf_set_encoding - - - - - diff --git a/reference/fdf/functions/fdf-get-file.xml b/reference/fdf/functions/fdf-get-file.xml deleted file mode 100644 index a2fcedfd56..0000000000 --- a/reference/fdf/functions/fdf-get-file.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - fdf_get_file - Lit la valeur de la clé /F - - - - &reftitle.description; - - stringfdf_get_file - resourcefdf_document - - - Lit la valeur de la clé /F. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur de la clé, sous la forme d'une &string;. - - - - - &reftitle.seealso; - - fdf_set_file - - - - - diff --git a/reference/fdf/functions/fdf-get-flags.xml b/reference/fdf/functions/fdf-get-flags.xml deleted file mode 100644 index a71b8385ec..0000000000 --- a/reference/fdf/functions/fdf-get-flags.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - fdf_get_flags - Lit les attributs d'un champ FDF - - - - &reftitle.description; - - intfdf_get_flags - resourcefdf_document - stringfieldname - intwhichflags - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-get-opt.xml b/reference/fdf/functions/fdf-get-opt.xml deleted file mode 100644 index 99f55c5c5a..0000000000 --- a/reference/fdf/functions/fdf-get-opt.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - fdf_get_opt - Lit une valeur dans un tableau de valeurs d'un champ FDF - - - - &reftitle.description; - - mixedfdf_get_opt - resourcefdf_document - stringfieldname - intelement-1 - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-get-status.xml b/reference/fdf/functions/fdf-get-status.xml deleted file mode 100644 index 72006de7a6..0000000000 --- a/reference/fdf/functions/fdf-get-status.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - fdf_get_status - Lit la valeur de la clé /STATUS - - - - &reftitle.description; - - stringfdf_get_status - resourcefdf_document - - - Lit la valeur de la clé /STATUS. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur de la clé, sous la forme d'une &string;. - - - - - &reftitle.seealso; - - fdf_set_status - - - - - diff --git a/reference/fdf/functions/fdf-get-value.xml b/reference/fdf/functions/fdf-get-value.xml deleted file mode 100644 index db5592f9c6..0000000000 --- a/reference/fdf/functions/fdf-get-value.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - fdf_get_value - Retourne la valeur d'un champ FDF - - - - &reftitle.description; - - mixedfdf_get_value - resourcefdf_document - stringfieldname - intwhich-1 - - - Retourne la valeur d'un champ FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - fieldname - - - Nom du champ FDF, sous la forme d'une &string;. - - - - - which - - - Les éléments d'un champ tableau peuvent être lus en fournissant ce - paramètre optionnel, sous la forme d'un entier dont la plus petite - valeur sera &zero;. Pour les champs qui ne sont pas des tableaux, ce paramètre - optionnel sera ignoré. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur du champ. - - - - - &reftitle.seealso; - - fdf_set_value - - - - - diff --git a/reference/fdf/functions/fdf-get-version.xml b/reference/fdf/functions/fdf-get-version.xml deleted file mode 100755 index dd98287fe0..0000000000 --- a/reference/fdf/functions/fdf-get-version.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - fdf_get_version - Lit le numéro de version de l'API ou du fichier FDF - - - - &reftitle.description; - - stringfdf_get_version - resourcefdf_document - - - Retourne le numéro de version FDF pour le document - fdf_document, ou le numéro de version de l'API - du toolkit si aucun paramètre n'est donné. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Retourne la version, sous la forme d'une &string;. - Pour la version actuelle du FDF toolkit 5.0, le numéro de version est - 5.0 et le numéro de version de document est - 1.2, 1.3 ou 1.4. - - - - - &reftitle.seealso; - - fdf_set_version - - - - - diff --git a/reference/fdf/functions/fdf-header.xml b/reference/fdf/functions/fdf-header.xml deleted file mode 100755 index 97fcb26100..0000000000 --- a/reference/fdf/functions/fdf-header.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - fdf_header - Émet les en-têtes HTTP spécifiques à FDF - - - - &reftitle.description; - - voidfdf_header - - - - fdf_header est une fonction de confort, - pour émettre les en-têtes HTTP spécifiques à FDF. Elle permet - d'envoyer le type Content-type: - avec la valeur application/vnd.fdf. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/fdf/functions/fdf-next-field-name.xml b/reference/fdf/functions/fdf-next-field-name.xml deleted file mode 100644 index 943709ea3d..0000000000 --- a/reference/fdf/functions/fdf-next-field-name.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - fdf_next_field_name - Lit le nom du champ FDF suivant - - - - &reftitle.description; - - stringfdf_next_field_name - resourcefdf_document - stringfieldname - - - Lit le nom du champ FDF suivant. Ce nom pourra être utilisé dans plusieurs fonctions. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - fieldname - - - Nom du champ FDF, sous la forme d'une &string;. S'il n'est pas fourni, - le premier champ est retourné. - - - - - - - - &reftitle.returnvalues; - - Retourne le nom du champ, sous la forme d'une &string;. - - - - - &reftitle.examples; - - Détecter tous les noms d'un formulaire FDF - - -]]> - - - - - - &reftitle.seealso; - - fdf_get_value - - - - - diff --git a/reference/fdf/functions/fdf-open-string.xml b/reference/fdf/functions/fdf-open-string.xml deleted file mode 100755 index 0d832f31ef..0000000000 --- a/reference/fdf/functions/fdf-open-string.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - fdf_open_string - Lit un document FDF à partir d'une &string; - - - - &reftitle.description; - - resourcefdf_open_string - stringfdf_data - - - Lit les données de formulaire à partir d'une &string;. - - - Il est possible d'utiliser fdf_open_string avec la variable - $HTTP_FDF_DATA pour traiter des données - de formulaires issues de clients distants. - - - - - &reftitle.parameters; - - - fdf_data - - - Les données, comme retournées depuis un formulaire PDF - ou créées en utilisant les fonctions - fdf_create et - fdf_save_string. - - - - - - - - &reftitle.returnvalues; - - Retourne un gestionnaire de document FDF, ou &false; - si une erreur survient. - - - - - &reftitle.examples; - - Accès aux données de formulaire FDF - - -]]> - - - - - - &reftitle.seealso; - - fdf_open - fdf_close - fdf_create - fdf_save_string - - - - - diff --git a/reference/fdf/functions/fdf-open.xml b/reference/fdf/functions/fdf-open.xml deleted file mode 100644 index fcf8822c3e..0000000000 --- a/reference/fdf/functions/fdf-open.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - fdf_open - Ouvre un document FDF - - - - &reftitle.description; - - resourcefdf_open - stringfilename - - - Ouvre un fichier contenant des données de formulaire. - - - Il est également possible d'utiliser la fonction - fdf_open_string pour traiter le résultat - d'un formulaire PDF issu d'une méthode POST. - - - - - &reftitle.parameters; - - - filename - - - Chemin vers le fichier FDF. Ce fichier doit contenir les données telles - que retournées par un formulaire PDF ou créées en utilisant les fonctions - fdf_create et fdf_save. - - - - - - - - &reftitle.returnvalues; - - Retourne un gestionnaire de document FDF, ou &false; - si une erreur survient. - - - - - &reftitle.examples; - - Accéder aux données du formulaire - - -]]> - - - - - - &reftitle.seealso; - - fdf_open_string - fdf_close - fdf_create - fdf_save - - - - - diff --git a/reference/fdf/functions/fdf-remove-item.xml b/reference/fdf/functions/fdf-remove-item.xml deleted file mode 100644 index 7130c93c94..0000000000 --- a/reference/fdf/functions/fdf-remove-item.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - fdf_remove_item - Configure le cadre FDF de destination pour le formulaire - - - - &reftitle.description; - - boolfdf_remove_item - resourcefdf_document - stringfieldname - intitem - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-save-string.xml b/reference/fdf/functions/fdf-save-string.xml deleted file mode 100755 index 266b7a1c49..0000000000 --- a/reference/fdf/functions/fdf-save-string.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - fdf_save_string - Retourne un document FDF sous forme d'une &string; - - - - &reftitle.description; - - stringfdf_save_string - resourcefdf_document - - - Retourne un document FDF sous forme d'une &string;. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Retourne le document, sous la forme d'une &string;, ou - &false; si une erreur survient. - - - - - &reftitle.examples; - - Lire un document FDF sous forme de &string; - - -]]> - - &example.outputs; - -> ->> -endobj -2 0 obj -[ -<< /T (foo)/V (bar)>> -] -endobj -trailer -<< -/Root 1 0 R - ->> -%%EOF -]]> - - - - - - &reftitle.seealso; - - fdf_open_string - fdf_close - fdf_create - fdf_save - - - - - diff --git a/reference/fdf/functions/fdf-save.xml b/reference/fdf/functions/fdf-save.xml deleted file mode 100644 index 9dda297b0d..0000000000 --- a/reference/fdf/functions/fdf-save.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - fdf_save - Sauvegarde un document FDF - - - - &reftitle.description; - - boolfdf_save - resourcefdf_document - stringfilename - - - Sauvegarde un document FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - filename - - - Si fourni, le FDF résultant sera écrit dans ce paramètre. - Sinon, cette fonction écrira le FDF dans la sortie standard PHP. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_close - fdf_create - fdf_save_string - - - - - diff --git a/reference/fdf/functions/fdf-set-ap.xml b/reference/fdf/functions/fdf-set-ap.xml deleted file mode 100644 index 7618c41a03..0000000000 --- a/reference/fdf/functions/fdf-set-ap.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - fdf_set_ap - Fixe l'apparence d'un champ FDF - - - - &reftitle.description; - - boolfdf_set_ap - resourcefdf_document - stringfield_name - intface - stringfilename - intpage_number - - - Fixe l'apparence d'un champ FDF (c.-à-d. la valeur de la clé - /AP). - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - field_name - - - - - - - face - - - Les valeurs possibles sont : FDFNormalAP, - FDFRolloverAP et - FDFDownAP. - - - - - filename - - - - - - - page_number - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/fdf/functions/fdf-set-encoding.xml b/reference/fdf/functions/fdf-set-encoding.xml deleted file mode 100644 index 0b9cc06907..0000000000 --- a/reference/fdf/functions/fdf-set-encoding.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - fdf_set_encoding - Modifie l'encodage des caractères - - - - &reftitle.description; - - boolfdf_set_encoding - resourcefdf_document - stringencoding - - - Modifie l'encodage des caractères du document FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - encoding - - - Le nom de l'encodage. Les valeurs suivantes sont supportées : - "Shift-JIS", "UHC", - "GBK" et "BigFive". - - - Une &string; vide réinitialise l'encodage au - schéma PDFDocEncoding/Unicode par défaut. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/fdf/functions/fdf-set-file.xml b/reference/fdf/functions/fdf-set-file.xml deleted file mode 100644 index c91e2928ce..0000000000 --- a/reference/fdf/functions/fdf-set-file.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - fdf_set_file - Définit le document PDF dans lequel afficher les données FDF - - - - &reftitle.description; - - boolfdf_set_file - resourcefdf_document - stringurl - stringtarget_frame - - - Sélectionne un document PDF différent de celui dont le formulaire est - issu, afin d'y afficher les résultats du formulaire. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - url - - - Doit être fourni sous la forme d'une URL absolue. - - - - - target_frame - - - Ce paramètre permet de spécifier le cadre dans lequel le document - sera affiché. Il est également possible de définir la valeur par défaut de ce paramètre - en utilisant la fonction fdf_set_target_frame. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Passer des données FDF à un second formulaire - - -]]> - - - - - - &reftitle.seealso; - - fdf_get_file - fdf_set_target_frame - - - - - diff --git a/reference/fdf/functions/fdf-set-flags.xml b/reference/fdf/functions/fdf-set-flags.xml deleted file mode 100644 index 4a6fe3bb40..0000000000 --- a/reference/fdf/functions/fdf-set-flags.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - fdf_set_flags - Modifie une option d'un champ - - - - &reftitle.description; - - boolfdf_set_flags - resourcefdf_document - stringfieldname - intwhichFlags - intnewFlags - - - Modifie une option d'un champ. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - fieldname - - - Nom du champ FDF, sous la forme d'une &string;. - - - - - whichFlags - - - - - - - newFlags - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_set_opt - - - - - diff --git a/reference/fdf/functions/fdf-set-javascript-action.xml b/reference/fdf/functions/fdf-set-javascript-action.xml deleted file mode 100644 index e570219233..0000000000 --- a/reference/fdf/functions/fdf-set-javascript-action.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - fdf_set_javascript_action - Modifie l'action javascript d'un champ - - - - &reftitle.description; - - boolfdf_set_javascript_action - resourcefdf_document - stringfieldname - inttrigger - stringscript - - - Modifie l'action javascript d'un champ donné. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction fdf_open_string. - - - - - fieldname - - - Nom du champ FDF, sous la forme d'une &string;. - - - - - trigger - - - - - - - script - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_set_submit_form_action - - - - - diff --git a/reference/fdf/functions/fdf-set-on-import-javascript.xml b/reference/fdf/functions/fdf-set-on-import-javascript.xml deleted file mode 100644 index 067b32716a..0000000000 --- a/reference/fdf/functions/fdf-set-on-import-javascript.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - fdf_set_on_import_javascript - Ajoute du code Javascript à être exécuté lorsque Acrobat ouvre un FDF - - - - &reftitle.description; - - boolfdf_set_on_import_javascript - resourcefdf_document - stringscript - boolbefore_data_import - - &warn.undocumented.func; - - - - &reftitle.seealso; - - fdf_add_doc_javascript - fdf_set_javascript_action - - - - - diff --git a/reference/fdf/functions/fdf-set-opt.xml b/reference/fdf/functions/fdf-set-opt.xml deleted file mode 100644 index 0c9b585ae5..0000000000 --- a/reference/fdf/functions/fdf-set-opt.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - fdf_set_opt - Modifie une option d'un champ - - - - &reftitle.description; - - boolfdf_set_opt - resourcefdf_document - stringfieldname - intelement - stringstr1 - stringstr2 - - - Modifie une option d'un champ donné. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction fdf_open_string. - - - - - fieldname - - - Nom du champ FDF, sous la forme d'une &string;. - - - - - element - - - - - - - str1 - - - - - - - str2 - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_set_flags - - - - - diff --git a/reference/fdf/functions/fdf-set-status.xml b/reference/fdf/functions/fdf-set-status.xml deleted file mode 100644 index ff02a68746..0000000000 --- a/reference/fdf/functions/fdf-set-status.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - fdf_set_status - Fixe la valeur de la clé /STATUS - - - - &reftitle.description; - - boolfdf_set_status - resourcefdf_document - stringstatus - - - Fixe la valeur de la clé /STATUS. Lorsqu'un client - reçoit un FDF avec un statut positionné, sa valeur sera présentée dans - une boîte d'alerte. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - status - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_get_status - - - - - diff --git a/reference/fdf/functions/fdf-set-submit-form-action.xml b/reference/fdf/functions/fdf-set-submit-form-action.xml deleted file mode 100644 index e88c2c8807..0000000000 --- a/reference/fdf/functions/fdf-set-submit-form-action.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - fdf_set_submit_form_action - Définit une action de soumission de formulaire pour un champ - - - - &reftitle.description; - - boolfdf_set_submit_form_action - resourcefdf_document - stringfieldname - inttrigger - stringscript - intflags - - - Définit une action de soumission de formulaire pour le champ donné. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - fieldname - - - Nom du champ FDF, sous la forme d'une &string;. - - - - - trigger - - - - - - - script - - - - - - - flags - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_set_javascript_action - - - - - diff --git a/reference/fdf/functions/fdf-set-target-frame.xml b/reference/fdf/functions/fdf-set-target-frame.xml deleted file mode 100755 index 89e0b43680..0000000000 --- a/reference/fdf/functions/fdf-set-target-frame.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - fdf_set_target_frame - Configure le cadre de destination pour l'affichage du formulaire - - - - &reftitle.description; - - boolfdf_set_target_frame - resourcefdf_document - stringframe_name - - - Configure le cadre de destination pour l'affichage du résultat - PDF défini par fdf_save_file. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - frame_name - - - Le nom du cadre, sous la forme d'une &string;. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_save_file - - - - - diff --git a/reference/fdf/functions/fdf-set-value.xml b/reference/fdf/functions/fdf-set-value.xml deleted file mode 100644 index b5e0c9f31a..0000000000 --- a/reference/fdf/functions/fdf-set-value.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - fdf_set_value - Modifie la valeur d'un champ FDF - - - - &reftitle.description; - - boolfdf_set_value - resourcefdf_document - stringfieldname - mixedvalue - intisName - - - Modifie la valeur d'un champ FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - fieldname - - - Nom du champ FDF, sous la forme d'une &string;. - - - - - value - - - Ce paramètre sera stocké comme une chaîne de caractères - sauf si c'est un tableau. Dans ce cas, tous les éléments du tableau - seront stockés comme un tableau de valeurs. - - - - - isName - - - - Dans les anciennes versions de la suite FDF, le dernier paramètre déterminait si la valeur - du champ devait être convertie en un nom PDF (isName = 1) - ou positionnée comme une chaîne de caractères (isName = 0). - - - La valeur n'est plus utilisée dans la suite actuelle, version 5.0. Pour des raisons de compatibilité, - cela est toujours supporté comme un paramètre optionnel, mais ignoré en - interne. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_get_value - fdf_remove_item - - - - - diff --git a/reference/fdf/functions/fdf-set-version.xml b/reference/fdf/functions/fdf-set-version.xml deleted file mode 100755 index 6a50674016..0000000000 --- a/reference/fdf/functions/fdf-set-version.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - fdf_set_version - Modifie le numéro de version du fichier FDF - - - - &reftitle.description; - - boolfdf_set_version - resourcefdf_document - stringversion - - - Modifie le numéro de version du document FDF courant. - - - Certaines fonctionnalités supportées par cette extension ne sont - disponibles que pour les nouvelles versions de FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - Le gestionnaire de document FDF, retourné par la fonction - fdf_create, la fonction - fdf_open ou la fonction - fdf_open_string. - - - - - version - - - Le numéro de version. Pour le toolkit FDF courant 5.0, ce peut être - 1.2, 1.3 ou - 1.4. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_get_version - - - - - diff --git a/reference/fdf/reference.xml b/reference/fdf/reference.xml deleted file mode 100644 index bf0534929b..0000000000 --- a/reference/fdf/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - &Functions; FDF - - &reference.fdf.entities.functions; - - - - diff --git a/reference/fdf/setup.xml b/reference/fdf/setup.xml deleted file mode 100644 index 7f9d670be3..0000000000 --- a/reference/fdf/setup.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - &reftitle.setup; - - -
- &reftitle.required; - - Il est nécessaire de disposer du FDF toolkit SDK, disponible sur le site - &spec.pdf.fdf;. - À partir de PHP 4.3.0, il faudra le SDK version 5.0. - La bibliothèque FDF toolkit est disponible sous forme de bibliothèque - compilée, éditée par Adobe, sur les systèmes d'exploitation Win32, - Linux, Solaris et AIX. - -
- - - - &reference.fdf.configure; - - - -
- &reftitle.resources; - - La plupart des fonctions FDF nécessitent une ressource de type - fdf comme premier argument. Une ressource - fdf est un gestionnaire vers un - fichier FDF ouvert. Il est possible de créer des ressources fdf - avec les fonctions fdf_create, - fdf_open et fdf_open_string. - -
- - - - diff --git a/reference/gearman/book.xml b/reference/gearman/book.xml deleted file mode 100644 index 33cd59410a..0000000000 --- a/reference/gearman/book.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - Gearman - Gearman - - - &reftitle.intro; - - Gearman est un framework applicatif générique pour distribuer - des tâches à plusieurs machines ou plusieurs processus. Il permet à une application d'effectuer des tâches - en parallèle, de distribuer la charge de calcul et de faire des appels de fonctions entre plusieurs langages. - Ce framework peut être utilisé dans nombre d'applications, des sites web haute-disponibilité au transport - d'événements de réplication de base de données. - - - Cette extension fournit des classes pour écrire des clients ou des agents Gearman. - - - - &reference.gearman.setup; - &reference.gearman.constants; - &reference.gearman.examples; - &reference.gearman.gearmanclient; - &reference.gearman.gearmanjob; - &reference.gearman.gearmantask; - &reference.gearman.gearmanworker; - &reference.gearman.gearmanexception; - - - diff --git a/reference/gearman/configure.xml b/reference/gearman/configure.xml deleted file mode 100644 index a5e1410224..0000000000 --- a/reference/gearman/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;gearman - - -
- diff --git a/reference/gearman/constants.xml b/reference/gearman/constants.xml deleted file mode 100644 index a28e86654a..0000000000 --- a/reference/gearman/constants.xml +++ /dev/null @@ -1,583 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - Valeurs de retour. Cherchez toujours une chaîne de caractères d'erreur dans - GearmanClient::error ou GearmanWorker car - davantage de détails peuvent être disponibles : - - - - - GEARMAN_SUCCESS - (int) - - - - Quelle que soit l'action entreprise, elle a été couronnée de succès. - - - - - - GEARMAN_IO_WAIT - (int) - - - - En mode non-bloquant, un événement qui aurait été bloquant a été atteint. - - - - - - GEARMAN_ERRNO - (int) - - - - Une erreur système. Cherchez dans GearmanClient::errno ou - GearmanWorker::errno le code d'erreur système qui a été - retourné. - - - - - - GEARMAN_NO_ACTIVE_FDS - (int) - - - - GearmanClient::wait ou GearmanWorker a - été appelé sans connexion. - - - - - - GEARMAN_UNEXPECTED_PACKET - (int) - - - - Indique que quelque chose de grave est survenu dans gearmand. S'applique seulement à - GearmanWorker. - - - - - - GEARMAN_GETADDRINFO - (int) - - - - La résolution DNS a échoué (hôte ou port invalide, etc). - - - - - - GEARMAN_NO_SERVERS - (int) - - - - Aucun appel à GearmanClient::addServer n'a été fait avant de soumettre une - tâche. - - - - - - GEARMAN_LOST_CONNECTION - (int) - - - - Perte de connexion pendant une requête. - - - - - - GEARMAN_MEMORY_ALLOCATION_FAILURE - (int) - - - - L'allocation mémoire a échoué (plus de mémoire disponible). - - - - - - GEARMAN_SERVER_ERROR - (int) - - - - Quelque chose s'est mal passé avec le serveur Gearman qui n'a pas pu traiter - la requête comme il se doit. - - - - - - GEARMAN_WORK_DATA - (int) - - - - Un code d'erreur de notification obtenu avec GearmanClient::returnCode - lors de l'utilisation de GearmanClient::do. Envoyé pour mettre à jour le - client avec les données de la tâche courante. Un agent l'utilise quand il a besoin d'envoyer des - mises à jour, d'envoyer des résultats partiels ou pour évacuer les données lors de tâches longues. - - - - - - GEARMAN_WORK_WARNING - (int) - - - - Un code d'erreur de notification obtenu avec GearmanClient::returnCode - lors de l'utilisation de GearmanClient::do. Met à jour le client avec - un avertissement. Le comportement est le même qu'avec GEARMAN_WORK_DATA, sauf - qu'il devrait être traité comme un avertissement plutôt que comme les données d'une réponse normale. - - - - - - GEARMAN_WORK_STATUS - (int) - - - - Un code d'erreur de notification obtenu avec GearmanClient::returnCode - lors de l'utilisation de GearmanClient::do. Envoyé pour mettre à jour le statut - d'une tâche longue. Utiliser GearmanClient::doStatus pour obtenir le pourcentage - de complétion de la tâche. - - - - - - GEARMAN_WORK_EXCEPTION - (int) - - - - Un code d'erreur de notification obtenu avec GearmanClient::returnCode - lors de l'utilisation de GearmanClient::do. Indique qu'une tâche a échoué - en levant une exception donnée. - - - - - - GEARMAN_WORK_FAIL - (int) - - - - Un code d'erreur de notification obtenu avec GearmanClient::returnCode - lors de l'utilisation de GearmanClient::do. Indique qu'une tâche a échoué. - - - - - - GEARMAN_COULD_NOT_CONNECT - (int) - - - - Échec de la connexion aux serveurs. - - - - - - GEARMAN_INVALID_FUNCTION_NAME - (int) - - - - Tentative de référencement d'une fonction avec un nom NULL ou utilisation de l'interface de rappel - sans spécifier les rappels. - - - - - - GEARMAN_INVALID_WORKER_FUNCTION - (int) - - - - Tentative de référencement d'une fonction avec une fonction de rappel NULL. - - - - - - GEARMAN_NO_REGISTERED_FUNCTIONS - (int) - - - - Quand un agent reçoit une tâche pour une fonction qu'il n'a pas référencée. - - - - - - GEARMAN_NO_JOBS - (int) - - - - Pour un agent non-bloquant, quand GearmanWorker::work n'a aucune tâche - active. - - - - - - GEARMAN_ECHO_DATA_CORRUPTION - (int) - - - - Après GearmanClient::echo ou GearmanWorker::echo, - les données retournées ne correspondent pas aux données envoyées. - - - - - - GEARMAN_NEED_WORKLOAD_FN - (int) - - - - Quand le client a fait le choix de diffuser la charge de travail sur une tâche, mais n'a pas - spécifié de fonction de retour de la charge de travail. - - - - - - GEARMAN_PAUSE - (int) - - - - Pour l'interface de tâche cliente non-bloquante, peut être retourné à partir du retour de la tâche - pour "mettre en pause" l'appel et le retour de GearmanClient::runTasks. - Appelez de nouveau GearmanClient::runTasks pour continuer. - - - - - - GEARMAN_UNKNOWN_STATE - (int) - - - - Erreur d'état client/agent interne. - - - - - - GEARMAN_SEND_BUFFER_TOO_SMALL - (int) - - - - Erreur interne : a essayé d'évacuer davantage de données que possible dans un paquet atomique, - à cause de tailles de tampons codées en dur. - - - - - - GEARMAN_TIMEOUT - (int) - - - - La limite de temps de l'agent/du client a été atteinte. - - - - - - - Les options GearmanClient : - - - - - GEARMAN_CLIENT_GENERATE_UNIQUE - (int) - - - - Génère un identifiant unique (UUID) pour chaque tâche. - - - - - - - GEARMAN_CLIENT_NON_BLOCKING - (int) - - - - Lance le client en mode non-bloquant. - - - - - - GEARMAN_CLIENT_UNBUFFERED_RESULT - (int) - - - - Permet au client de lire les données par paquets plutôt que ce soit la bibliothèque qui mette - en tampon les données et les transmette. - - - - - - GEARMAN_CLIENT_FREE_TASKS - (int) - - - - Libère automatiquement les objets des tâches une fois celles-ci effectuées. C'est le paramétrage par - défaut de cette extension pour éviter les fuites de mémoire. - - - - - - - Les options GearmanWorker : - - - - - GEARMAN_WORKER_NON_BLOCKING - (int) - - - - Lance l'agent en mode non-bloquant. - - - - - - GEARMAN_WORKER_GRAB_UNIQ - (int) - - - - Retourne l'identifiant unique alloué au client en plus du descripteur de tâche. - - - - - - - Configuration de base de Gearman : - - - - - GEARMAN_DEFAULT_TCP_HOST - (string) - - - - - - - - - GEARMAN_DEFAULT_TCP_PORT - (int) - - - - - - - - - GEARMAN_DEFAULT_SOCKET_TIMEOUT - (int) - - - - - - - - - GEARMAN_DEFAULT_SOCKET_SEND_SIZE - (int) - - - - - - - - - GEARMAN_DEFAULT_SOCKET_RECV_SIZE - (int) - - - - - - - - - GEARMAN_MAX_ERROR_SIZE - (int) - - - - - - - - - GEARMAN_PACKET_HEADER_SIZE - (int) - - - - - - - - - GEARMAN_JOB_HANDLE_SIZE - (int) - - - - - - - - - GEARMAN_OPTION_SIZE - (int) - - - - - - - - - GEARMAN_UNIQUE_SIZE - (int) - - - - - - - - - GEARMAN_MAX_COMMAND_ARGS - (int) - - - - - - - - - GEARMAN_ARGS_BUFFER_SIZE - (int) - - - - - - - - - GEARMAN_SEND_BUFFER_SIZE - (int) - - - - - - - - - GEARMAN_RECV_BUFFER_SIZE - (int) - - - - - - - - - GEARMAN_WORKER_WAIT_TIMEOUT - (int) - - - - - - - - - diff --git a/reference/gearman/examples.xml b/reference/gearman/examples.xml deleted file mode 100644 index a243d508d6..0000000000 --- a/reference/gearman/examples.xml +++ /dev/null @@ -1,470 +0,0 @@ - - - - - &reftitle.examples; -
- Utilisation simple - - Client et agent Gearman simple - - Cet exemple montre un client et un agent simple. Le client - envoie une &string; au serveur de travaux, et l'agent inverse - la &string; et la retourne. Le travail est exécuté de façon synchronisée. - - -addServer(); - -echo "Envoi de la tâche\n"; - -# Envoi de la tâche inverse -do -{ - $result = $gmclient->doNormal("reverse", "Hello!"); - - # Vérification des différents paquets de retour et des erreurs. - switch($gmclient->returnCode()) - { - case GEARMAN_WORK_DATA: - echo "Données : $result\n"; - break; - case GEARMAN_WORK_STATUS: - list($numerator, $denominator)= $gmclient->doStatus(); - echo "Statut : $numerator/$denominator terminé\n"; - break; - case GEARMAN_WORK_FAIL: - echo "Échec\n"; - exit; - case GEARMAN_SUCCESS: - echo "Succès : $result\n"; - break; - default: - echo "RET : " . $gmclient->returnCode() . "\n"; - exit; - } -} -while($gmclient->returnCode() != GEARMAN_SUCCESS); - -?> -]]> - - -addServer(); - -# Enregistre la fonction "reverse" avec le serveur. Modifie la fonction -# de l'agent en "reverse_fn_fast" pour en améliorer la rapidité avec aucun affichage. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Attente d'un travail...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Travail reçu : " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Charge de travail : $workload ($workload_size)\n"; - - # Cette boucle n'est pas nécessaire, mais montre simplement le fonctionnement - for ($x= 0; $x < $workload_size; $x++) - { - echo "Envoi du statut : " . ($x + 1) . "/$workload_size terminé\n"; - $job->sendStatus($x, $workload_size); - sleep(1); - } - - $result= strrev($workload); - echo "Résultat : $result\n"; - - # On retourne ce que l'on veut au client. - return $result; -} - -# Une version plus simple et moins verbeuse de la fonction ci-dessus pourrait être : -function reverse_fn_fast($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - -
-
- Client et agent Gearman simple, en arrière-plan - - Client et agent Gearman simple, en arrière-plan - - Cet exemple montre un client et un agent simple. Le client envoie une &string; - au serveur de travaux en tant que travail d'arrière-plan, et l'agent - renverse la &string;. Il est à noter que vu l'exécution asynchrone de l'agent, le - client n'attend pas la fin et qu'il sort (et donc le client ne reçoit jamais les résultats). - - -addServer(); - -# Exécute le client en arrière-plan -$job_handle = $gmclient->doBackground("reverse", "this is a test"); - -if ($gmclient->returnCode() != GEARMAN_SUCCESS) -{ - echo "bad return code\n"; - exit; -} - -echo "done!\n"; - -?> -]]> - - -addServer(); - -# Enregistre la fonction "reverse" sur le serveur. Modifie la fonction de l'agent en -# "reverse_fn_fast" pour une exécution plus rapide sans affichage. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Attente d'un travail...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code : " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Travail reçu : " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Charge de travail : $workload ($workload_size)\n"; - - # Cette boucle n'est pas nécessaire, mais nous l'utilisons pour en comprendre le fonctionnement - for ($x= 0; $x < $workload_size; $x++) - { - echo "Envoi du statut : " . ($x + 1) . "/$workload_size terminé\n"; - $job->sendStatus($x, $workload_size); - sleep(1); - } - - $result= strrev($workload); - echo "Résultat : $result\n"; - - # Retourne ce que l'on veut au client. - return $result; -} - -# Une version plus simple et moins verbeuse de la fonction ci-dessus serait : -function reverse_fn_fast($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - -
-
- Client et agent Gearman simple, avec la soumission de tâches - - Client et agent Gearman simple, avec la soumission de tâches - - Dans cet exemple, le client "reverse" a été étendu pour exécuter 2 tâches en parallèle. - L'agent "reverse" est inchangé, mis à part qu'il retourne des données durant le processus. - - -addServer(); - -# Enregistre quelques fonctions de rappel -$gmc->setCreatedCallback("reverse_created"); -$gmc->setDataCallback("reverse_data"); -$gmc->setStatusCallback("reverse_status"); -$gmc->setCompleteCallback("reverse_complete"); -$gmc->setFailCallback("reverse_fail"); - -# Définit quelques données applicatives arbitraires -$data['foo'] = 'bar'; - -# Ajoute deux tâches -$task= $gmc->addTask("reverse", "foo", $data); -$task2= $gmc->addTaskLow("reverse", "bar", NULL); - -# Exécute les tâches en parallèle (en supposant plusieurs agents) -if (! $gmc->runTasks()) -{ - echo "ERROR " . $gmc->error() . "\n"; - exit; -} - -echo "DONE\n"; - -function reverse_created($task) -{ - echo "CREATED: " . $task->jobHandle() . "\n"; -} - -function reverse_status($task) -{ - echo "STATUS: " . $task->jobHandle() . " - " . $task->taskNumerator() . - "/" . $task->taskDenominator() . "\n"; -} - -function reverse_complete($task) -{ - echo "COMPLETE: " . $task->jobHandle() . ", " . $task->data() . "\n"; -} - -function reverse_fail($task) -{ - echo "FAILED: " . $task->jobHandle() . "\n"; -} - -function reverse_data($task) -{ - echo "DATA: " . $task->data() . "\n"; -} - -?> -]]> - - -addServer(); - -# Enregistre la fonction "reverse" avec le serveur. Modifie la fonction de l'agent en -# "reverse_fn_fast" pour être plus rapide sans affichage. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Received job: " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Workload: $workload ($workload_size)\n"; - - # Cette boucle n'est pas nécessaire, mais nous l'utilisons pour en comprendre le fonctionnement - for ($x= 0; $x < $workload_size; $x++) - { - echo "Sending status: " . ($x + 1) . "/$workload_size complete\n"; - $job->sendStatus($x+1, $workload_size); - $job->sendData(substr($workload, $x, 1)); - sleep(1); - } - - $result= strrev($workload); - echo "Result: $result\n"; - - # Retourne ce que l'on veut au client. - return $result; -} - -# Une version plus simple et moins verbeuse de la fonction ci-dessus serait : -function reverse_fn_fast($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - -
- - diff --git a/reference/gearman/gearmanclient.xml b/reference/gearman/gearmanclient.xml deleted file mode 100644 index 28de8697a1..0000000000 --- a/reference/gearman/gearmanclient.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - La classe GearmanClient - GearmanClient - - - - -
- &reftitle.intro; - - Représente une classe pour se connecter à un serveur de tâches Gearman et lui soumettre des requêtes - pour appliquer des fonctions sur les données fournies. La fonction appliquée doit faire partie de celles - référencées par un agent Gearman et les données traitées restent opaques du point de vue du serveur de tâches. - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanClient - - - &Methods; - - - - - - - - - -
- - - - &reference.gearman.entities.gearmanclient; - - - diff --git a/reference/gearman/gearmanclient/addoptions.xml b/reference/gearman/gearmanclient/addoptions.xml deleted file mode 100644 index a6652bb9d2..0000000000 --- a/reference/gearman/gearmanclient/addoptions.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - GearmanClient::addOptions - Ajoute des options au client - - - - &reftitle.description; - - public boolGearmanClient::addOptions - intoption - - - Ajoute une ou plusieurs options à celles déjà présentes. - - - - - &reftitle.parameters; - - - option - - - Les options à ajouter. - Une des constantes suivantes ou la combinaison de constantes en utilisant - l'opérateur OU bit à bit (|): - GEARMAN_CLIENT_GENERATE_UNIQUE, - GEARMAN_CLIENT_NON_BLOCKING, - GEARMAN_CLIENT_UNBUFFERED_RESULT ou - GEARMAN_CLIENT_FREE_TASKS. - - - - - - - - &reftitle.returnvalues; - - Retourne toujours &true;. - - - - - diff --git a/reference/gearman/gearmanclient/addserver.xml b/reference/gearman/gearmanclient/addserver.xml deleted file mode 100644 index 66e9d36826..0000000000 --- a/reference/gearman/gearmanclient/addserver.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - GearmanClient::addServer - Ajoute un serveur de tâches au client - - - - &reftitle.description; - - public boolGearmanClient::addServer - stringhost&null; - intport0 - boolsetupExceptionHandler&true; - - - Ajoute un serveur de tâches à une liste de serveurs qui peuvent être utilisés pour accomplir une tâche. - Aucune entrée/sortie sur un socket n'est faite ici; le serveur est juste ajouté à la liste. - - - - - - &reftitle.parameters; - - - host - - - &gearman.parameter.host; - - - - - port - - - &gearman.parameter.port; - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ajout de deux serveurs - -addServer("10.0.0.1"); -$gmclient->addServer("10.0.0.2", 7003); - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanClient::addServers - - - - - diff --git a/reference/gearman/gearmanclient/addservers.xml b/reference/gearman/gearmanclient/addservers.xml deleted file mode 100644 index 1268639012..0000000000 --- a/reference/gearman/gearmanclient/addservers.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - GearmanClient::addServers - Ajoute une liste de serveurs de tâches au client - - - - &reftitle.description; - - public boolGearmanClient::addServers - stringservers&null; - boolsetupExceptionHandler&true; - - - Ajoute une liste de serveurs de tâches qui peuvent être utilisés pour accomplir une tâche. - Aucune entrée/sortie sur un socket n'est faite ici; les serveurs sont juste ajoutés à la liste complète de serveurs. - - - - - - &reftitle.parameters; - - - servers - - - Une liste de serveurs, séparés par des virgules, chacun étant spécifié selon le format 'host:port'. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ajout de deux serveurs - -addServers("10.0.0.1,10.0.0.2:7003"); - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanClient::addServer - - - - - diff --git a/reference/gearman/gearmanclient/addtask.xml b/reference/gearman/gearmanclient/addtask.xml deleted file mode 100644 index 67fbbbe464..0000000000 --- a/reference/gearman/gearmanclient/addtask.xml +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - GearmanClient::addTask - Ajoute une tâche à exécuter en parallèle - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTask - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Ajoute une tâche à exécuter en parallèle d'autres tâches. Appelez cette - méthode pour toutes les tâches à exécuter en parallèle, puis, appelez - la méthode GearmanClient::runTasks pour exécuter les - tâches. Il est à noter qu'il est nécessaire d'avoir assez d'agents disponibles pour exécuter - en parallèle toutes les tâches. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un objet GearmanTask ou &false; - si la tâche n'a pu être ajoutée. - - - - - &reftitle.examples; - - - Ajout de 2 tâches - -addServer(); - -# Définit une fonction à appeler lorsque le travail est terminé -$gmclient->setCompleteCallback("complete"); - -# Ajoute une tâche exécutant la fonction "reverse" sur la chaîne "Hello World!" -$gmclient->addTask("reverse", "Hello World!", null, "1"); - -# Ajoute une autre tâche exécutant la fonction "reverse" sur la chaîne "!dlroW olleH" -$gmclient->addTask("reverse", "!dlroW olleH", null, "2"); - -# Exécute les tâches -$gmclient->runTasks(); - -function complete($task) -{ - print "Terminé : " . $task->unique() . ", " . $task->data() . "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - Ajout de 2 tâches en passant le contexte de l'application - -addServer(); - -# Définit une fonction à appeler lorsque le travail est terminé -$client->setCompleteCallback("reverse_complete"); - -# Ajout de quelques tâches contenant un marqueur à l'emplacement duquel le résultat doit être placé -$results = array(); -$client->addTask("reverse", "Hello World!", $results, "t1"); -$client->addTask("reverse", "!dlroW olleH", $results, "t2"); - -$client->runTasks(); - -# Le résultat doit être maintenant contenu dans les fonctions de rappel -foreach ($results as $id => $result) - echo $id . ": " . $result['handle'] . ", " . $result['data'] . "\n"; - - -function reverse_complete($task, $results) -{ - $results[$task->unique()] = array("handle"=>$task->jobHandle(), "data"=>$task->data()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - GearmanClient::addTaskHigh - GearmanClient::addTaskLow - GearmanClient::addTaskBackground - GearmanClient::addTaskHighBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtaskbackground.xml b/reference/gearman/gearmanclient/addtaskbackground.xml deleted file mode 100644 index df6376bb66..0000000000 --- a/reference/gearman/gearmanclient/addtaskbackground.xml +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - GearmanClient::addTaskBackground - Ajoute une tâche d'arrière-plan pour une exécution en parallèle - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskBackground - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Ajoute une tâche d'arrière-plan pour une exécution en parallèle d'autres tâches. - Appelez cette méthode pour toutes les tâches à exécuter en parallèle, puis, appelez - la méthode GearmanClient::runTasks pour réaliser les tâches. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un objet GearmanTask ou &false; si la tâche - n'a pu être ajoutée. - - - - - &reftitle.examples; - - 2 tâches dont une en arrière-plan - - Cet exemple montre la différence entre l'exécution en arrière-plan - et une exécution normale. Le client ajoute 2 tâches qui doivent exécuter - la même fonction, mais une a été ajoutée avec la méthode - addTaskBackground. Une fonction de rappel est définie - afin de surveiller la progression du travail. Un agent simple avec un délai artificiel - rapporte la progression et le client la traite via la fonction de rappel. - 2 agents sont exécutés dans cet exemple. Il est à noter que la tâche en arrière-plan - n'est pas affichée par le client. - - -addServer(); - -# Définit 2 fonctions de rappel afin de surveiller la progression -$gmc->setCompleteCallback("reverse_complete"); -$gmc->setStatusCallback("reverse_status"); - -# Ajoute une tâche pour la fonction "reverse" -$task= $gmc->addTask("reverse", "Hello World!", null, "1"); - -# Ajoute une autre tâche, mais cette fois, en arrière-plan -$task= $gmc->addTaskBackground("reverse", "!dlroW olleH", null, "2"); - -if (! $gmc->runTasks()) -{ - echo "ERREUR " . $gmc->error() . "\n"; - exit; -} - -echo "FAIT\n"; - -function reverse_status($task) -{ - echo "STATUT : " . $task->unique() . ", " . $task->jobHandle() . " - " . $task->taskNumerator() . - "/" . $task->taskDenominator() . "\n"; -} - -function reverse_complete($task) -{ - echo "TERMINÉ : " . $task->unique() . ", " . $task->data() . "\n"; -} - -?> -]]> - - -addServer(); - -# Enregistre la fonction "reverse" sur ce serveur. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Attente d'un travail...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Travail reçu : " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Charge de l'agent : $workload ($workload_size)\n"; - - # Cette boucle n'est pas nécessaire, mais permet de comprendre le fonctionnement - for ($x= 0; $x < $workload_size; $x++) - { - echo "Envoi du statut : " . ($x + 1) . "/$workload_size terminé\n"; - $job->sendStatus($x+1, $workload_size); - $job->sendData(substr($workload, $x, 1)); - sleep(1); - } - - $result= strrev($workload); - echo "Résultat : $result\n"; - - # On retourne au client ce que l'on veut. - return $result; -} - -?> -]]> - - - L'agent affiche, pour les 2 travaux : - - - - - - Affichage du client : - - - - - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskHigh - GearmanClient::addTaskLow - GearmanClient::addTaskHighBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtaskhigh.xml b/reference/gearman/gearmanclient/addtaskhigh.xml deleted file mode 100644 index 7fbb9da326..0000000000 --- a/reference/gearman/gearmanclient/addtaskhigh.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - GearmanClient::addTaskHigh - Ajoute une tâche de forte priorité à effectuer en parallèle - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskHigh - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Ajoute une tâche de forte priorité à effectuer en parallèle d'autres tâches. - Appelez cette méthode pour que toutes les tâches soient menées de front, puis appelez - GearmanClient::runTasks pour faire le travail. Les tâches avec une forte priorité - seront sélectionnées dans la queue avant celles de priorité normale ou plus faible. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un objet GearmanTask ou &false; si la tâche ne peut pas être ajoutée. - - - - - &reftitle.examples; - - Une tâche de forte priorité en même temps que deux tâches normales - - Une tâche de forte priorité est ajoutée en plus de deux autres tâches. Un seul agent - est disponible, de telle façon que les tâches s'exécutent une à une, avec celle de forte priorité - en premier. - - -addServer(); - -# fixe le retour quand la tâche est complétée -$gmc->setCompleteCallback("inverse_complete"); - -# ajoute des tâches, l'une ayant une forte priorité -$task= $gmc->addTask("inverse", "Bonjour le monde!", null, "1"); -$task= $gmc->addTaskHigh("inverse", "!ednom el ruojnoB", null, "2"); -$task= $gmc->addTask("inverse", "Bonjour le monde!", null, "3"); - -if (! $gmc->runTasks()) -{ - echo "ERROR " . $gmc->error() . "\n"; - exit; -} -echo "Fait\n"; - -function inverse_complete($task) -{ - echo "Complétée : " . $task->unique() . ", " . $task->data() . "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskLow - GearmanClient::addTaskBackground - GearmanClient::addTaskHighBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtaskhighbackground.xml b/reference/gearman/gearmanclient/addtaskhighbackground.xml deleted file mode 100644 index 90c493af52..0000000000 --- a/reference/gearman/gearmanclient/addtaskhighbackground.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - GearmanClient::addTaskHighBackground - Ajoute une tâche de fond de forte priorité à effectuer en parallèle - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskHighBackground - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Ajoute une tâche de fond de forte priorité à effectuer en parallèle d'autres tâches. - Appelez cette méthode pour que toutes les tâches soient menées de front, puis appelez - GearmanClient::runTasks pour faire le travail. Les tâches avec une forte priorité - seront sélectionnées dans la queue avant celles de priorité normale ou plus faible. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un objet GearmanTask ou &false; si la tâche ne peut pas être ajoutée. - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskHigh - GearmanClient::addTaskLow - GearmanClient::addTaskBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtasklow.xml b/reference/gearman/gearmanclient/addtasklow.xml deleted file mode 100644 index 755e0b923a..0000000000 --- a/reference/gearman/gearmanclient/addtasklow.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - GearmanClient::addTaskLow - Ajoute une tâche de faible priorité à effectuer en parallèle - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskLow - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Ajoute une tâche de faible priorité à effectuer en parallèle d'autres tâches. - Appelez cette méthode pour que toutes les tâches soient menées de front, puis appelez - GearmanClient::runTasks pour faire le travail. Les tâches avec une faible priorité - seront sélectionnées dans la queue après celles de priorité normale ou haute. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un objet GearmanTask ou &false; si la tâche ne peut pas être ajoutée. - - - - - &reftitle.examples; - - Une tâche de faible priorité en même temps que deux tâches normales - - Une tâche de faible priorité est ajoutée en plus de deux autres tâches. Un seul agent - est disponible, de telle façon que les tâches s'exécutent une à une, avec celle de faible priorité - en dernier. - - -addServer(); - -# fixe le retour quand la tâche est complétée -$gmc->setCompleteCallback("inverse_complete"); - -# ajoute des tâches, l'une ayant une faible priorité -$task= $gmc->addTask("inverse", "Bonjour le monde!", null, "1"); -$task= $gmc->addTaskLow("inverse", "!ednom el ruojnoB", null, "2"); -$task= $gmc->addTask("inverse", "Bonjour le monde!", null, "3"); - -if (! $gmc->runTasks()) -{ - echo "ERROR " . $gmc->error() . "\n"; - exit; -} -echo "Fait\n"; - -function inverse_complete($task) -{ - echo "Complétée : " . $task->unique() . ", " . $task->data() . "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskHigh - GearmanClient::addTaskBackground - GearmanClient::addTaskHighBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtasklowbackground.xml b/reference/gearman/gearmanclient/addtasklowbackground.xml deleted file mode 100644 index 4a5d5f0b9d..0000000000 --- a/reference/gearman/gearmanclient/addtasklowbackground.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - GearmanClient::addTaskLowBackground - Ajoute une tâche de fond de faible priorité à effectuer en parallèle - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskLowBackground - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Ajoute une tâche de fond de faible priorité à effectuer en parallèle d'autres tâches. - Appelez cette méthode pour que toutes les tâches soient menées de front, puis appelez - GearmanClient::runTasks pour faire le travail. Les tâches avec une faible priorité - seront sélectionnées dans la queue après celles de priorité normale ou haute. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un objet GearmanTask ou &false; si la tâche ne peut pas être ajoutée. - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskHigh - GearmanClient::addTaskLow - GearmanClient::addTaskBackground - GearmanClient::addTaskHighBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtaskstatus.xml b/reference/gearman/gearmanclient/addtaskstatus.xml deleted file mode 100644 index be1751cbf1..0000000000 --- a/reference/gearman/gearmanclient/addtaskstatus.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - GearmanClient::addTaskStatus - Ajoute une tâche pour obtenir le statut - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskStatus - stringjob_handle - mixedcontext&null; - - - Utilisé pour demander le statut au serveur Gearman, qui appellera la fonction de rappel de statut - spécifiée (grâce à GearmanClient::setStatusCallback). - - - - - &reftitle.parameters; - - - job_handle - - - Le descripteur pour la tâche dont on souhaite le statut - - - - - context - - - Les données à passer à la fonction de rappel de statut, généralement une référence à un tableau ou à un objet - - - - - - - - &reftitle.returnvalues; - - Un objet GearmanTask ou &false; en cas d'échec. - - - - - &reftitle.examples; - - Surveiller l'accomplissement de plusieurs tâches de fond - - Un délai artificiel est introduit dans l'agent de cet exemple pour simuler un - processus long. Il n'y a qu'un agent qui est lancé dans cet exemple. - - -addServer(); - -/* lance une tâche de fond et sauvegarde les descripteurs */ -$handles = array(); -$handles[0] = $gmclient->doBackground("inverse", "Bonjour le monde!"); -$handles[1] = $gmclient->doBackground("inverse", "!ednom el ruojnoB"); - -$gmclient->setStatusCallback("inverse_statut"); - -/* Interroge le serveur pour voir quand les tâches de fond se terminent; */ -/* une meilleure méthode consiste à appeler les retours d'événement */ -do -{ - /* Utilise la variable de contexte pour savoir combien de tâches ont été effectuées */ - $done = 0; - $gmclient->addTaskStatus($handles[0], $done); - $gmclient->addTaskStatus($handles[1], $done); - $gmclient->runTasks(); - echo "Fait : $done\n"; - sleep(1); -} -while ($done != 2); - -function inverse_statut($task, $done) -{ - if (!$task->isKnown()) - $done++; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::setStatusCallback - - - - - diff --git a/reference/gearman/gearmanclient/clearcallbacks.xml b/reference/gearman/gearmanclient/clearcallbacks.xml deleted file mode 100644 index 464c1055d5..0000000000 --- a/reference/gearman/gearmanclient/clearcallbacks.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - GearmanClient::clearCallbacks - Efface toutes les fonctions de rappel des tâches - - - - &reftitle.description; - - public boolGearmanClient::clearCallbacks - - - - Efface toutes les fonctions de rappel des tâches précédemment définies. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne toujours &true;. - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/clone.xml b/reference/gearman/gearmanclient/clone.xml deleted file mode 100644 index 28a77e5f33..0000000000 --- a/reference/gearman/gearmanclient/clone.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - GearmanClient::clone - Crée une copie de l'objet GearmanClient - - - - &reftitle.description; - - public GearmanClientGearmanClient::clone - - - - Crée une copie de l'objet GearmanClient. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une classe GearmanClient en cas de succès, - &false; si une erreur survient. - - - - - diff --git a/reference/gearman/gearmanclient/construct.xml b/reference/gearman/gearmanclient/construct.xml deleted file mode 100644 index 25305e216c..0000000000 --- a/reference/gearman/gearmanclient/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanClient::__construct - Crée une instance GearmanClient - - - - &reftitle.description; - - public GearmanClient::__construct - - - - Crée une instance GearmanClient représentant un client - qui se connecte à un serveur de tâches et y enregistre des tâches à effectuer. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet GearmanClient. - - - - - &reftitle.seealso; - - GearmanClient::clone - - - - - diff --git a/reference/gearman/gearmanclient/context.xml b/reference/gearman/gearmanclient/context.xml deleted file mode 100644 index 2fb945f2af..0000000000 --- a/reference/gearman/gearmanclient/context.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanClient::context - Récupère le contexte de l'application - - - - &reftitle.description; - - public stringGearmanClient::context - - - - Récupère le contexte de l'application précédemment définie - avec la méthode GearmanClient::setContext. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Les données de contexte identiques à celles définies - avec la méthode GearmanClient::setContext - - - - - &reftitle.seealso; - - GearmanClient::setContext - - - - - diff --git a/reference/gearman/gearmanclient/data.xml b/reference/gearman/gearmanclient/data.xml deleted file mode 100644 index 9b4916d0c6..0000000000 --- a/reference/gearman/gearmanclient/data.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - GearmanClient::data - Récupère les données de l'application (obsolète) - - - - &reftitle.description; - - public stringGearmanClient::data - - - - Récupère les données de l'application précédemment - définies avec la méthode GearmanClient::setData. - - - - Cette méthode a été remplacée par la méthode - GearmanClient::setContext en version - 0.6.0 de l'extension Gearman. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Les mêmes données que celles définies avec la méthode - GearmanClient::setData - - - - - &reftitle.seealso; - - GearmanClient::setData - - - - - diff --git a/reference/gearman/gearmanclient/do.xml b/reference/gearman/gearmanclient/do.xml deleted file mode 100644 index 8ff9e66860..0000000000 --- a/reference/gearman/gearmanclient/do.xml +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - GearmanClient::do - Exécute une seule tâche et retourne le résultat (obsolète) - - - - &reftitle.description; - - public stringGearmanClient::do - stringfunction_name - stringworkload - stringunique - - - La méthode GearmanClient::do est obsolète - depuis pecl/gearman 1.0.0. Utiliser la méthode - GearmanClient::doNormal à la place. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Une représentation sous forme de &string; du résultat de l'exécution - de la tâche. - - - - - &reftitle.examples; - - - Soumission d'une seule tâche avec un retour immédiat - -addServer(); - -echo "Envoi d'un travail\n"; - -$result = $gmclient->doNormal("reverse", "Hello!"); - -echo "Succès : $result\n"; - -?> -]]> - - -addServer(); - -# Enregistre la fonction "reverse" avec le serveur. Modifie la fonction en -# "reverse_fn_fast" pour une exécution plus rapide sans affichage. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Attente d'un travail...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - Soumission d'un travail et récupération incrémentale du statut - - Un travail est soumis et le script boucle pour récupérer les informations - de statut. L'agent a un délai artificiel qui résulte en un travail - de longue durée et envoie le statut et les données au fur et à mesure - du traitement. Chaque appel suivant à la méthode - GearmanClient::do produit des - informations de statut sur le travail en cours. - - -addServer(); - -echo "Envoi d'un travail\n"; - -# Envoi du travail -do -{ - $result = $gmclient->doNormal("reverse", "Hello!"); - # Vérifie les paquets et les erreurs retournés. - - switch($gmclient->returnCode()) - { - case GEARMAN_WORK_DATA: - echo "Données : $result\n"; - break; - case GEARMAN_WORK_STATUS: - list($numerator, $denominator)= $gmclient->doStatus(); - echo "Statut : $numerator/$denominator terminé\n"; - break; - case GEARMAN_WORK_FAIL: - echo "Échec\n"; - exit; - case GEARMAN_SUCCESS: - break; - default: - echo "RET : " . $gmclient->returnCode() . "\n"; - echo "Erreur : " . $gmclient->error() . "\n"; - echo "N° de l'erreur : " . $gmclient->getErrno() . "\n"; - exit; - } -} -while($gmclient->returnCode() != GEARMAN_SUCCESS); - -echo "Succès : $result\n"; - -?> -]]> - - -addServer(); - -# Enregistre la fonction "reverse" avec le serveur. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Attente d'un travail...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Travail reçu : " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Charge de l'agent: $workload ($workload_size)\n"; - - # Cette boucle n'est pas nécessaire, mais montre le fonctionnement - for ($x= 0; $x < $workload_size; $x++) - { - echo "Envoi du statut : " + $x + 1 . "/$workload_size terminé\n"; - $job->sendStatus($x+1, $workload_size); - $job->sendData(substr($workload, $x, 1)); - sleep(1); - } - - $result= strrev($workload); - echo "Résultat : $result\n"; - - # Nous retournons ce que l'on souhaite au client. - return $result; -} - -?> -]]> - - &example.outputs.similar; - - L'agent affiche : - - - - - - Le client affiche : - - - - - - - - - - &reftitle.seealso; - - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dobackground.xml b/reference/gearman/gearmanclient/dobackground.xml deleted file mode 100644 index 46621e36ca..0000000000 --- a/reference/gearman/gearmanclient/dobackground.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - GearmanClient::doBackground - Exécute une tâche en arrière-plan - - - - &reftitle.description; - - public stringGearmanClient::doBackground - stringfunction - stringworkload - stringnullunique&null; - - - Exécute une tâche en arrière-plan, retourne le gestionnaire de travaux - qui pourra être utilisé pour récupérer le statut de la tâche en cours. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Le gestionnaire de travaux pour la tâche soumise. - - - - - &reftitle.examples; - - Soumet et surveille un travail en arrière-plan - - L'agent de cet exemple a un délai artificiel introduit pour simuler - un travail dont l'exécution prend beaucoup de temps. Le script du - client vérifie périodiquement le statut du travail en cours. - - -addServer(); - -/* Exécute le client */ -$job_handle = $gmclient->doBackground("reverse", "this is a test"); - -if ($gmclient->returnCode() != GEARMAN_SUCCESS) -{ - echo "Code retour erroné\n"; - exit; -} - -$done = false; -do -{ - sleep(3); - $stat = $gmclient->jobStatus($job_handle); - if (!$stat[0]) // the job is known so it is not done - $done = true; - echo "Exécution : " . ($stat[1] ? "true" : "false") . ", numérateur : " . $stat[2] . ", dénominateur : " . $stat[3] . "\n"; -} -while(!$done); - -echo "fait !\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dohigh.xml b/reference/gearman/gearmanclient/dohigh.xml deleted file mode 100644 index 1be160c821..0000000000 --- a/reference/gearman/gearmanclient/dohigh.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - GearmanClient::doHigh - Exécute une seule tâche en priorité haute - - - - &reftitle.description; - - public stringGearmanClient::doHigh - stringfunction - stringworkload - stringnullunique&null; - - - Exécute une seule tâche en priorité haute et retourne une représentation - du résultat sous la forme d'une &string;. C'est aux fonctions - GearmanClient et GearmanWorker d'accorder - le format du résultat. Les tâches en priorités hautes seront exécutées avant celles - dont la priorité est normale, voire basse dans la file d'attente. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Le résultat de la tâche sous la forme d'une &string;. - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dohighbackground.xml b/reference/gearman/gearmanclient/dohighbackground.xml deleted file mode 100644 index 3f6a4320c1..0000000000 --- a/reference/gearman/gearmanclient/dohighbackground.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - GearmanClient::doHighBackground - Exécute une tâche en priorité haute en arrière plan - - - - &reftitle.description; - - public stringGearmanClient::doHighBackground - stringfunction - stringworkload - stringnullunique&null; - - - Exécute une tâche en priorité haute en arrière plan, et retourne - un gestionnaire de travail qui peut être utilisé pour récupérer - le statut de la tâche. Les tâches en priorité haute seront exécutées - avant les normales et les basses de la file d'attente. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Le gestionnaire de travail de la tâche ajoutée. - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dojobhandle.xml b/reference/gearman/gearmanclient/dojobhandle.xml deleted file mode 100644 index 55f199e51f..0000000000 --- a/reference/gearman/gearmanclient/dojobhandle.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - GearmanClient::doJobHandle - Récupère le gestionnaire de travaux pour la tâche en cours - - - - &reftitle.description; - - public stringGearmanClient::doJobHandle - - - - Récupère le gestionnaire de travaux pour la tâche en cours. Il peut être - utilisé lors de multiples appels à la méthode GearmanClient::doNormal. - Le gestionnaire de travaux peut alors être utilisé pour récupérer les informations - sur la tâche. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le gestionnaire de travaux pour la tâche en cours. - - - - - &reftitle.seealso; - - GearmanClient::jobStatus - - - - - diff --git a/reference/gearman/gearmanclient/dolow.xml b/reference/gearman/gearmanclient/dolow.xml deleted file mode 100644 index 0011cf95c9..0000000000 --- a/reference/gearman/gearmanclient/dolow.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - GearmanClient::doLow - Exécute une seule tâche en priorité basse - - - - &reftitle.description; - - public stringGearmanClient::doLow - stringfunction - stringworkload - stringnullunique&null; - - - Exécute une seule tâche en priorité basse et retourne une représentation sous - forme de &string; du résultat. Il convient aux méthodes - GearmanClient et GearmanWorker de valider - le format du résultat. Les tâches dont la priorité est normale ou haute seront - traitées en priorité par rapport aux tâches dont la priorité est basse dans la file - d'attente. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Une représentation sous forme de &string; du résultat de la tâche en cours. - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doHigh - GearmanClient::doBackground - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dolowbackground.xml b/reference/gearman/gearmanclient/dolowbackground.xml deleted file mode 100644 index 0b20825e47..0000000000 --- a/reference/gearman/gearmanclient/dolowbackground.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - GearmanClient::doLowBackground - Exécute une tâche en priorité basse en arrière-plan - - - - &reftitle.description; - - public stringGearmanClient::doLowBackground - stringfunction - stringworkload - stringnullunique&null; - - - Exécute une tâche en priorité basse en arrière-plan, puis, retourne - le gestionnaire de travaux qui pourra être utilisé pour récupérer le statut - de la tâche en cours. Les tâches dont la priorité est normale et haute auront la - priorité sur celle dont la priorité est basse dans la file d'attente. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Le gestionnaire de travaux de la tâche soumise. - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doHighBackground - - - - - diff --git a/reference/gearman/gearmanclient/donormal.xml b/reference/gearman/gearmanclient/donormal.xml deleted file mode 100644 index 3f30ae8017..0000000000 --- a/reference/gearman/gearmanclient/donormal.xml +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - GearmanClient::doNormal - Exécute une tâche et retourne le résultat - - - - &reftitle.description; - - public stringGearmanClient::doNormal - stringfunction - stringworkload - stringnullunique&null; - - - Exécute une tâche et retourne une &string; représentant le - résultat. Il appartient aux classes GearmanClient - et GearmanWorker d'accepter le format du résultat. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Une &string; représentant le résultat de la tâche exécutée. - - - - - &reftitle.examples; - - - Soumission d'une tâche avec un retour immédiat - - -]]> - - -addServer(); - -echo "Envoi de la tâche\n"; - -$result = $gmclient->doNormal("reverse", "Hello!"); - -echo "Succès : $result\n"; - -?> -]]> - - -addServer(); - -# Enregistre la fonction "reverse" avec le serveur. Modifie la fonction worker -# en "reverse_fn_fast" pour un worker plus rapide avec aucune sortie. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Attente d'une tâche...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code : " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - Soumission d'une tâche et récupération incrémentale du statut - - Une tâche est soumise et le script boucle pour récupérer les informations - de statut. Le worker a un délai artificiel qui le transforme en une tâche longue - et envoie le statut et les données lorsque l'exécution survient. - Chaque sous-appel à la fonction GearmanClient::doNormal - produit des informations de statut sur la tâche en cours. - - -addServer(); - -echo "Envoi de la tâche\n"; - -# Envoi de la tâche reverse -do -{ - $result = $gmclient->doNormal("reverse", "Hello!"); - # Vérifie les paquets retournés ainsi que les erreurs. - - switch($gmclient->returnCode()) - { - case GEARMAN_WORK_DATA: - echo "Données : $result\n"; - break; - case GEARMAN_WORK_STATUS: - list($numerator, $denominator)= $gmclient->doStatus(); - echo "Statut : $numerator/$denominator terminé\n"; - break; - case GEARMAN_WORK_FAIL: - echo "Échec\n"; - exit; - case GEARMAN_SUCCESS: - break; - default: - echo "RET : " . $gmclient->returnCode() . "\n"; - echo "Erreur : " . $gmclient->error() . "\n"; - echo "Errno : " . $gmclient->getErrno() . "\n"; - exit; - } -} -while($gmclient->returnCode() != GEARMAN_SUCCESS); - -echo "Succès : $result\n"; - -?> -]]> - - -addServer(); - -# Enregistre la fonction "reverse" avec le serveur. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Attente d'une tâche...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code : " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Tâche reçue : " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Charge de travail : $workload ($workload_size)\n"; - - # Cette boucle de statut n'est pas nécessaire, elle montre juste le fonctionnement - for ($x= 0; $x < $workload_size; $x++) - { - echo "Envoi du statut : " + $x + 1 . "/$workload_size terminé\n"; - $job->sendStatus($x+1, $workload_size); - $job->sendData(substr($workload, $x, 1)); - sleep(1); - } - - $result= strrev($workload); - echo "Résultat : $result\n"; - - # Retourne ce que l'on souhaite retourner au client. - return $result; -} - -?> -]]> - - &example.outputs.similar; - - Sortie du worker : - - - - - - Sortie client : - - - - - - - - - - &reftitle.seealso; - - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dostatus.xml b/reference/gearman/gearmanclient/dostatus.xml deleted file mode 100644 index 580c7f7cb4..0000000000 --- a/reference/gearman/gearmanclient/dostatus.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - GearmanClient::doStatus - Récupère le statut de la tâche en cours - - - - &reftitle.description; - - public arrayGearmanClient::doStatus - - - - Retourne le statut de la tâche en cours. Il pourra être utilisé lors - de multiples appels à la méthode GearmanClient::doNormal. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau représentant le pourcentage de réalisation fourni sous la forme - d'une fraction, dont le premier élément est le numérateur, et le second, - le dénominateur. - - - - - &reftitle.examples; - - Récupère le statut d'un travail dont l'exécution prend du temps - - L'agent dans cet exemple a un délai artificiel ajouté lors de l'exécution de la - fonction. Après chaque délai, il appelle la méthode GearmanJob::status - dont le client récupère l'information. - - -addServer(); - -echo "Envoi d'un travail\n"; - -# Envoi du travail -do -{ - $result = $gmclient->doNormal("reverse", "Hello!"); - - # Vérifie les différents paquets et erreurs retournés. - switch($gmclient->returnCode()) - { - case GEARMAN_WORK_DATA: - break; - case GEARMAN_WORK_STATUS: - # Récupère le statut du travail en cours - list($numerator, $denominator)= $gmclient->doStatus(); - echo "Statut : $numerator/$denominator terminé\n"; - break; - case GEARMAN_WORK_FAIL: - echo "Échec \n"; - exit; - case GEARMAN_SUCCESS: - break; - default: - echo "RET : " . $gmclient->returnCode() . "\n"; - exit; - } -} -while($gmclient->returnCode() != GEARMAN_SUCCESS); - -echo "Succès : $result\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanJob::status - - - - - diff --git a/reference/gearman/gearmanclient/echo.xml b/reference/gearman/gearmanclient/echo.xml deleted file mode 100644 index 2790a41dc0..0000000000 --- a/reference/gearman/gearmanclient/echo.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - GearmanClient::echo - Envoie des données à tous les serveurs de travaux afin de vérifier qu'ils les affichent en retour (obsolète) - - - - &reftitle.description; - - public boolGearmanClient::echo - stringworkload - - - La méthode GearmanClient::echo est obsolète - depuis pecl/gearman 1.0.0. Utiliser la méthode - GearmanClient::ping à la place. - - - - - &reftitle.parameters; - - - workload - - - Données arbitraires sérialisées - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/gearman/gearmanclient/error.xml b/reference/gearman/gearmanclient/error.xml deleted file mode 100644 index 18e14c5ebe..0000000000 --- a/reference/gearman/gearmanclient/error.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanClient::error - Retourne la dernière erreur rencontrée sous forme de &string; - - - - &reftitle.description; - - public stringfalseGearmanClient::error - - - - Retourne la dernière erreur rencontrée sous forme de &string;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une &string; humainement lisible représentant la dernière erreur survenue, - ou &false; s'il n'y a pas de message d'erreur disponible. - - - - - &reftitle.seealso; - - GearmanClient::getErrno - - - - - diff --git a/reference/gearman/gearmanclient/geterrno.xml b/reference/gearman/gearmanclient/geterrno.xml deleted file mode 100644 index ddb802ecde..0000000000 --- a/reference/gearman/gearmanclient/geterrno.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanClient::getErrno - Récupère la valeur d'errno - - - - &reftitle.description; - - public intGearmanClient::getErrno - - - - Retourne la valeur d'errno dans le cas d'une valeur de retour GEARMAN_ERRNO. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une valeur d'errno Gearman valide. - - - - - &reftitle.seealso; - - GearmanClient::error - - - - - diff --git a/reference/gearman/gearmanclient/jobstatus.xml b/reference/gearman/gearmanclient/jobstatus.xml deleted file mode 100644 index 604773ce37..0000000000 --- a/reference/gearman/gearmanclient/jobstatus.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - GearmanClient::jobStatus - gearman_job_status - Récupère le statut d'un travail en arrière-plan - - - - &reftitle.description; - &style.oop; (méthode) : - - public arrayGearmanClient::jobStatus - stringjob_handle - - - Récupère le statut d'un travail en arrière-plan pour le gestionnaire de - travaux fourni. Les informations de statut spécifient si le travail est connu, - si le travail est actuellement en cours d'exécution, ainsi que le pourcentage - de réalisation. - - - - - &reftitle.parameters; - - - job_handle - - - &gearman.parameter.jobhandle; - - - - - - - - &reftitle.returnvalues; - - Un tableau contenant les informations de statut pour le travail - correspondant au gestionnaire de travaux fourni. Le premier élément est un - booléen indiquant si le travail est connu, le second est un booléen indiquant - si le travail est en cours d'exécution, le troisième et le quatrième - correspondent au numérateur et dénominateur du pourcentage de réalisation. - - - - - &reftitle.examples; - - Surveille le statut d'un travail en arrière-plan mettant du temps à s'exécuter - -addServer(); - -/* Exécute le client */ -$job_handle = $gmclient->doBackground("reverse", "this is a test"); - -if ($gmclient->returnCode() != GEARMAN_SUCCESS) -{ - echo "Mauvais code retour\n"; - exit; -} - -$done = false; -do -{ - sleep(3); - $stat = $gmclient->jobStatus($job_handle); - if (!$stat[0]) // le travail est connu, signifiant qu'il n'est pas terminé - $done = true; - echo "Exécution : " . ($stat[1] ? "true" : "false") . ", numérateur : " . $stat[2] . ", dénominateur : " . $stat[3] . "\n"; -} -while(!$done); - -echo "fait !\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::doStatus - - - - - diff --git a/reference/gearman/gearmanclient/ping.xml b/reference/gearman/gearmanclient/ping.xml deleted file mode 100644 index fc92c8a2e3..0000000000 --- a/reference/gearman/gearmanclient/ping.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - GearmanClient::ping - Envoie des données à tous les serveurs de tâches pour s'assurer qu'ils sont toujours en fonctionnement - - - - &reftitle.description; - - public boolGearmanClient::ping - stringworkload - - - Envoie des données arbitraires à tous les serveurs de tâches pour - s'assurer qu'ils sont bien en fonctionnement. Les données envoyées - ne sont en aucun cas utilisées ou analysées. L'utilisation - primaire de cette fonction est lors des tests et du débogage. - - - - - &reftitle.parameters; - - - workload - - - Quelques données arbitraires qui sont retournées. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/gearman/gearmanclient/removeoptions.xml b/reference/gearman/gearmanclient/removeoptions.xml deleted file mode 100644 index 24682b7aa9..0000000000 --- a/reference/gearman/gearmanclient/removeoptions.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanClient::removeOptions - Supprime les options du client - - - - &reftitle.description; - - public boolGearmanClient::removeOptions - intoption - - - Supprime une ou plusieurs options. - - - - - &reftitle.parameters; - - - option - - - Les options à supprimer. - - - - - - - - &reftitle.returnvalues; - - Retourne toujours &true;. - - - - - diff --git a/reference/gearman/gearmanclient/returncode.xml b/reference/gearman/gearmanclient/returncode.xml deleted file mode 100644 index a03930c5e5..0000000000 --- a/reference/gearman/gearmanclient/returncode.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - GearmanClient::returnCode - Récupère le dernier code Gearman retourné - - - - &reftitle.description; - - public intGearmanClient::returnCode - - - - Retourne le dernier code Gearman retourné. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un code retour Gearman valide. - - - - - diff --git a/reference/gearman/gearmanclient/runtasks.xml b/reference/gearman/gearmanclient/runtasks.xml deleted file mode 100644 index be482bde65..0000000000 --- a/reference/gearman/gearmanclient/runtasks.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - GearmanClient::runTasks - Exécute une liste de tâches en parallèle - - - - &reftitle.description; - - public boolGearmanClient::runTasks - - - - Pour un jeu de tâches précédemment ajoutées avec les méthodes GearmanClient::addTask, - GearmanClient::addTaskHigh, GearmanClient::addTaskLow, - GearmanClient::addTaskBackground, GearmanClient::addTaskHighBackground, ou - GearmanClient::addTaskLowBackground, cette méthode - démarre l'exécution des tâches en parallèle. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::addTask - - - - - diff --git a/reference/gearman/gearmanclient/setclientcallback.xml b/reference/gearman/gearmanclient/setclientcallback.xml deleted file mode 100644 index 2f3b1b13a5..0000000000 --- a/reference/gearman/gearmanclient/setclientcallback.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - GearmanClient::setClientCallback - Définit une fonction de rappel lorsqu'un paquet de données est reçu pour une tâche (obsolète) - - - - &reftitle.description; - - public voidGearmanClient::setClientCallback - callablecallback - - - Définit une fonction de rappel lorsqu'un paquet de données est reçu pour une tâche. - - - - Cette méthode a été remplacée par la méthode - GearmanClient::setDataCallback depuis - la version 0.6.0 de l'extension Gearman. - - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setDataCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setcompletecallback.xml b/reference/gearman/gearmanclient/setcompletecallback.xml deleted file mode 100644 index 8a4c899e79..0000000000 --- a/reference/gearman/gearmanclient/setcompletecallback.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - GearmanClient::setCompleteCallback - Définit une fonction à appeler une fois la tâche terminée - - - - &reftitle.description; - - public boolGearmanClient::setCompleteCallback - callablecallback - - - Définit une fonction de rappel à appeler lorsqu'une GearmanTask - se termine, ou quand GearmanJob::sendComplete est - appelé par le worker (selon ce qui se passe en premier). - - - Cette fonction de rappel est exécutée uniquement lors de l'exécution d'une GearmanTask à l'aide de GearmanClient::runTasks. - Elle n'est pas utilisée pour des travaux individuels. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setcontext.xml b/reference/gearman/gearmanclient/setcontext.xml deleted file mode 100644 index 202b87dd16..0000000000 --- a/reference/gearman/gearmanclient/setcontext.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanClient::setContext - Définit le contexte d'une application - - - - &reftitle.description; - - public boolGearmanClient::setContext - stringdata - - - Définit une chaîne arbitraire à fournir comme contexte de - l'application qui pourra être récupérée plus tard via la méthode - GearmanClient::context. - - - - - &reftitle.parameters; - - - data - - - Données de contexte - - - - - - - - &reftitle.returnvalues; - - Retourne toujours &true;. - - - - - &reftitle.seealso; - - GearmanClient::context - - - - - diff --git a/reference/gearman/gearmanclient/setcreatedcallback.xml b/reference/gearman/gearmanclient/setcreatedcallback.xml deleted file mode 100644 index ad414320ee..0000000000 --- a/reference/gearman/gearmanclient/setcreatedcallback.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - GearmanClient::setCreatedCallback - Définit une fonction de rappel à appeler lorsqu'une tâche est placée dans la file d'attente - - - - &reftitle.description; - - public boolGearmanClient::setCreatedCallback - callablecallback - - - Définit une fonction de rappel à appeler lorsqu'une tâche est placée dans la file d'attente - du serveur de travaux gearman. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setdata.xml b/reference/gearman/gearmanclient/setdata.xml deleted file mode 100644 index a9c024526d..0000000000 --- a/reference/gearman/gearmanclient/setdata.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - GearmanClient::setData - Définit les données de l'application (obsolète) - - - - &reftitle.description; - - public boolGearmanClient::setData - stringdata - - - Définit les données de l'application qui pourront ensuite être récupérées - via la méthode GearmanClient::data. - - - - Cette méthode a été remplacée par la méthode - GearmanClient::setContext à partir de la version - 0.6.0 de l'extension Gearman. - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - &reftitle.returnvalues; - - Retourne toujours &true;. - - - - - &reftitle.seealso; - - GearmanClient::data - - - - - diff --git a/reference/gearman/gearmanclient/setdatacallback.xml b/reference/gearman/gearmanclient/setdatacallback.xml deleted file mode 100644 index 86d565e8ca..0000000000 --- a/reference/gearman/gearmanclient/setdatacallback.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - GearmanClient::setDataCallback - Définit une fonction de rappel à appeler lorsqu'un paquet de données est reçu pour une tâche - - - - &reftitle.description; - - public boolGearmanClient::setDataCallback - callablecallback - - - Définit une fonction de rappel à appeler lorsqu'un paquet de données est reçu pour une tâche. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setexceptioncallback.xml b/reference/gearman/gearmanclient/setexceptioncallback.xml deleted file mode 100644 index da460b27cb..0000000000 --- a/reference/gearman/gearmanclient/setexceptioncallback.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - GearmanClient::setExceptionCallback - Définit une fonction de rappel pour les exceptions émises par l'agent - - - - &reftitle.description; - - public boolGearmanClient::setExceptionCallback - callablecallback - - - Spécifie une fonction de rappel à appeler lorsqu'un agent émet une exception. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setfailcallback.xml b/reference/gearman/gearmanclient/setfailcallback.xml deleted file mode 100644 index f3f32e2e27..0000000000 --- a/reference/gearman/gearmanclient/setfailcallback.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - GearmanClient::setFailCallback - Définit une fonction de rappel à appeler lorsqu'un travail échoue - - - - &reftitle.description; - - public boolGearmanClient::setFailCallback - callablecallback - - - Définit une fonction de rappel à utiliser lorsqu'une tâche échoue. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setoptions.xml b/reference/gearman/gearmanclient/setoptions.xml deleted file mode 100644 index 2389cb1edf..0000000000 --- a/reference/gearman/gearmanclient/setoptions.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanClient::setOptions - Définit les options du client - - - - &reftitle.description; - - public boolGearmanClient::setOptions - intoption - - - Définit une ou plusieurs options du client. - - - - - &reftitle.parameters; - - - option - - - Les options à définir. - - - - - - - - &reftitle.returnvalues; - - Retourne toujours &true;. - - - - - diff --git a/reference/gearman/gearmanclient/setstatuscallback.xml b/reference/gearman/gearmanclient/setstatuscallback.xml deleted file mode 100644 index 51496b4c8e..0000000000 --- a/reference/gearman/gearmanclient/setstatuscallback.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - GearmanClient::setStatusCallback - Définit une fonction de rappel pour collecter les statuts d'une tâche - - - - &reftitle.description; - - public boolGearmanClient::setStatusCallback - callablecallback - - - Définit une fonction de rappel à utiliser pour récupérer les informations - de statut mises à jour depuis l'agent. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/settimeout.xml b/reference/gearman/gearmanclient/settimeout.xml deleted file mode 100644 index a16b01006b..0000000000 --- a/reference/gearman/gearmanclient/settimeout.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanClient::setTimeout - Définit le délai d'attente d'une activité du socket I/O - - - - &reftitle.description; - - public boolGearmanClient::setTimeout - inttimeout - - - Définit le délai d'attente d'une activité du socket I/O. - - - - - &reftitle.parameters; - - - timeout - - - Un intervalle de temps, en millisecondes. - - - - - - - - &reftitle.returnvalues; - - Retourne toujours &true;. - - - - - diff --git a/reference/gearman/gearmanclient/setwarningcallback.xml b/reference/gearman/gearmanclient/setwarningcallback.xml deleted file mode 100644 index 3cd793f652..0000000000 --- a/reference/gearman/gearmanclient/setwarningcallback.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - GearmanClient::setWarningCallback - Définit une fonction de rappel lors de l'émission d'alerte depuis l'agent - - - - &reftitle.description; - - public boolGearmanClient::setWarningCallback - callablecallback - - - Définit une fonction de rappel à appeler lorsqu'un agent lance une alerte. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setworkloadcallback.xml b/reference/gearman/gearmanclient/setworkloadcallback.xml deleted file mode 100644 index 9026fa9085..0000000000 --- a/reference/gearman/gearmanclient/setworkloadcallback.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - GearmanClient::setWorkloadCallback - Définit une fonction de rappel lors de la réception de mises à jour de données incrémentales - - - - &reftitle.description; - - public boolGearmanClient::setWorkloadCallback - callablecallback - - - Définit une fonction de rappel à appeler lorsqu'un agent a besoin d'envoyer des données avant - la fin d'un travail. Un agent peut le faire lorsqu'il doit envoyer des mises à jour, - envoyer des résultats partiels, ou envoyer des données en temps réel lors de l'exécution - de travaux qui prennent beaucoup de temps. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - - - - - diff --git a/reference/gearman/gearmanclient/timeout.xml b/reference/gearman/gearmanclient/timeout.xml deleted file mode 100644 index e9af568c60..0000000000 --- a/reference/gearman/gearmanclient/timeout.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanClient::timeout - Récupère la valeur du délai d'activité du socket I/O - - - - &reftitle.description; - - public intGearmanClient::timeout - - - - Retourne la valeur du délai, en millisecondes, à attendre une activité du socket I/O. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le délai d'attente, en millisecondes, d'une activité I/O. - Une valeur négative signifie que le délai est infini. - - - - - &reftitle.seealso; - - GearmanClient::setTimeout - - - - - diff --git a/reference/gearman/gearmanclient/wait.xml b/reference/gearman/gearmanclient/wait.xml deleted file mode 100644 index fb8f2a06f3..0000000000 --- a/reference/gearman/gearmanclient/wait.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanClient::wait - Attend l'activité d'E/S sur toutes les connexions d'un client - - - - &reftitle.description; - - public boolGearmanClient::wait - - - - Cela attend l'activité de n'importe lequel des serveurs connectés. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; en cas de succès &false; en cas d'erreur. - - - - - &reftitle.seealso; - - GearmanWorker::wait - - - - - diff --git a/reference/gearman/gearmanexception.xml b/reference/gearman/gearmanexception.xml deleted file mode 100644 index 3ca0c8d720..0000000000 --- a/reference/gearman/gearmanexception.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - La classe GearmanException - GearmanException - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanException - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/gearman/gearmanjob.xml b/reference/gearman/gearmanjob.xml deleted file mode 100644 index 60a080f3b5..0000000000 --- a/reference/gearman/gearmanjob.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - La classe GearmanJob - GearmanJob - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanJob - - - &Methods; - - - - - - -
- - - - &reference.gearman.entities.gearmanjob; - - - diff --git a/reference/gearman/gearmanjob/complete.xml b/reference/gearman/gearmanjob/complete.xml deleted file mode 100644 index ad7e75ae0d..0000000000 --- a/reference/gearman/gearmanjob/complete.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - GearmanJob::complete - Envoie les résultats ainsi que le statut complet (obsolète) - - - - &reftitle.description; - - public boolGearmanJob::complete - stringresult - - - Envoie les résultats ainsi que le statut complet mis à jour - pour ce travail. - - - - Cette méthode a été remplacée par la méthode - GearmanJob::sendComplete dans la version - 0.6.0 de l'extension Gearman. - - - - - - &reftitle.parameters; - - - result - - - Les données sérialisées du résultat. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendFail - GearmanJob::setReturn - - - - - diff --git a/reference/gearman/gearmanjob/construct.xml b/reference/gearman/gearmanjob/construct.xml deleted file mode 100644 index 7cc31bea7b..0000000000 --- a/reference/gearman/gearmanjob/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - GearmanJob::__construct - Crée une nouvelle instance GearmanJob - - - - &reftitle.description; - - public GearmanJob::__construct - - - - Crée une nouvelle instance GearmanJob - représentant un travail assigné à un agent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet GearmanJob. - - - - - diff --git a/reference/gearman/gearmanjob/data.xml b/reference/gearman/gearmanjob/data.xml deleted file mode 100644 index 41ef4e6d27..0000000000 --- a/reference/gearman/gearmanjob/data.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - GearmanJob::data - Envoie des données pour un travail en cours d'exécution (obsolète) - - - - &reftitle.description; - - public boolGearmanJob::data - stringdata - - - Envoie des données vers un serveur de travaux (et à tous les clients à - l'écoute) pour ce travail. - - - - Cette méthode a été remplacée par la méthode - GearmanJob::sendData depuis la version - 0.6.0 de l'extension Gearman. - - - - - - &reftitle.parameters; - - - data - - - Données sérialisées arbitraires. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::workload - GearmanTask::data - - - - - diff --git a/reference/gearman/gearmanjob/exception.xml b/reference/gearman/gearmanjob/exception.xml deleted file mode 100644 index db17afc905..0000000000 --- a/reference/gearman/gearmanjob/exception.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - GearmanJob::exception - Envoie une exception pour un travail en cours d'exécution (obsolète) - - - - &reftitle.description; - - public boolGearmanJob::exception - stringexception - - - Envoie l'exception fournie lorsque ce travail est en cours d'exécution. - - - - Cette méthode a été remplacée par la méthode - GearmanJob::sendException depuis la version - 0.6.0 de l'extension Gearman. - - - - - - &reftitle.parameters; - - - exception - - - Une description d'exception. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::setReturn - GearmanJob::sendStatus - GearmanJob::sendWarning - - - - - diff --git a/reference/gearman/gearmanjob/fail.xml b/reference/gearman/gearmanjob/fail.xml deleted file mode 100644 index b9402bcf23..0000000000 --- a/reference/gearman/gearmanjob/fail.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - GearmanJob::fail - Envoie un statut d'échec (obsolète) - - - - &reftitle.description; - - public boolGearmanJob::fail - - - - Envoie un statut d'échec pour ce travail, indiquant que le travail a échoué - de façon prévue (a contrario d'un échec dû à l'émission d'une exception). - - - - Cette méthode a été remplacée par la méthode - GearmanJob::sendFail depuis la version - 0.6.0 de l'extension Gearman. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendException - GearmanJob::setReturn - GearmanJob::sendStatus - GearmanJob::sendWarning - - - - - diff --git a/reference/gearman/gearmanjob/functionname.xml b/reference/gearman/gearmanjob/functionname.xml deleted file mode 100644 index 039f2cdbe5..0000000000 --- a/reference/gearman/gearmanjob/functionname.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanJob::functionName - Récupère le nom de la fonction - - - - &reftitle.description; - - public falsestringGearmanJob::functionName - - - - Retourne le nom de la fonction pour ce travail. C'est la fonction exécutée - par l'agent pour exécuter le travail. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom de la fonction, ou &false; si le travail n'a pas été initialisé. - - - - - &reftitle.seealso; - - GearmanTask::function - - - - - diff --git a/reference/gearman/gearmanjob/handle.xml b/reference/gearman/gearmanjob/handle.xml deleted file mode 100644 index 98e6f00a39..0000000000 --- a/reference/gearman/gearmanjob/handle.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanJob::handle - Récupère le gestionnaire de travaux - - - - &reftitle.description; - - public falsestringGearmanJob::handle - - - - Retourne le gestionnaire de travaux assigné par le serveur de travaux. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un gestionnaire de travaux, ou &false; si le travail n'a pas été initialisé. - - - - - &reftitle.seealso; - - GearmanTask::jobHandle - - - - - diff --git a/reference/gearman/gearmanjob/returncode.xml b/reference/gearman/gearmanjob/returncode.xml deleted file mode 100644 index ed781ee5e9..0000000000 --- a/reference/gearman/gearmanjob/returncode.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanJob::returnCode - Récupère le dernier code retourné - - - - &reftitle.description; - - public intGearmanJob::returnCode - - - - Retourne le dernier code retourné par le serveur de travaux. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un code de retour valide Gearman. - - - - - &reftitle.seealso; - - GearmanTask::returnCode - - - - - diff --git a/reference/gearman/gearmanjob/sendcomplete.xml b/reference/gearman/gearmanjob/sendcomplete.xml deleted file mode 100644 index 59cd73816d..0000000000 --- a/reference/gearman/gearmanjob/sendcomplete.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanJob::sendComplete - Envoie le résultat ainsi que le statut complet - - - - &reftitle.description; - - public boolGearmanJob::sendComplete - stringresult - - - Envoie les données du résultat ainsi que le statut complet mis - à jour pour ce travail. - - - - - &reftitle.parameters; - - - result - - - Les données sérialisées du résultat. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendFail - GearmanJob::setReturn - - - - - diff --git a/reference/gearman/gearmanjob/senddata.xml b/reference/gearman/gearmanjob/senddata.xml deleted file mode 100644 index 809b170062..0000000000 --- a/reference/gearman/gearmanjob/senddata.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanJob::sendData - Envoie les données pour un travail en cours d'exécution - - - - &reftitle.description; - - public boolGearmanJob::sendData - stringdata - - - Envoie les données au serveur de travaux (et à tous les clients à l'écoute) - pour ce travail. - - - - - &reftitle.parameters; - - - data - - - Données sérialisées arbitraires. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::workload - GearmanTask::data - - - - - diff --git a/reference/gearman/gearmanjob/sendexception.xml b/reference/gearman/gearmanjob/sendexception.xml deleted file mode 100644 index 27cd5a2b33..0000000000 --- a/reference/gearman/gearmanjob/sendexception.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanJob::sendException - Envoie une exception pour un travail en cours d'exécution - - - - &reftitle.description; - - public boolGearmanJob::sendException - stringexception - - - Envoie l'exception fournie lors de l'exécution de ce travail. - - - - - &reftitle.parameters; - - - exception - - - Une description d'exception. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::setReturn - GearmanJob::sendStatus - GearmanJob::sendWarning - - - - - diff --git a/reference/gearman/gearmanjob/sendfail.xml b/reference/gearman/gearmanjob/sendfail.xml deleted file mode 100644 index b3d4a6d6c9..0000000000 --- a/reference/gearman/gearmanjob/sendfail.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - GearmanJob::sendFail - Envoie un statut d'échec - - - - &reftitle.description; - - public boolGearmanJob::sendFail - - - - Envoie un statut d'échec pour ce travail, indiquant que le travail a échoué - de façon prévue (a contrario d'un échec dû à l'émission d'une exception). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendException - GearmanJob::setReturn - GearmanJob::sendStatus - GearmanJob::sendWarning - - - - - diff --git a/reference/gearman/gearmanjob/sendstatus.xml b/reference/gearman/gearmanjob/sendstatus.xml deleted file mode 100644 index 3fe48e5d59..0000000000 --- a/reference/gearman/gearmanjob/sendstatus.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - GearmanJob::sendStatus - Envoie un statut - - - - &reftitle.description; - - public boolGearmanJob::sendStatus - intnumerator - intdenominator - - - Envoie des informations de statut au serveur de travaux - ainsi qu'à tous les clients à l'écoute. Utiliser cette méthode - pour spécifier le pourcentage de réalisation du travail courant. - - - - - &reftitle.parameters; - - - numerator - - - Le numérateur du taux de réalisation, sous forme d'une fraction. - - - - - denominator - - - Le dénominateur du taux de réalisation, sous forme d'une fraction. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::jobStatus - GearmanTask::taskDenominator - GearmanTask::taskNumerator - - - - - diff --git a/reference/gearman/gearmanjob/sendwarning.xml b/reference/gearman/gearmanjob/sendwarning.xml deleted file mode 100644 index b6580ab8db..0000000000 --- a/reference/gearman/gearmanjob/sendwarning.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanJob::sendWarning - Envoie une alerte - - - - &reftitle.description; - - public boolGearmanJob::sendWarning - stringwarning - - - Envoie une alerte pour ce travail pendant son exécution. - - - - - &reftitle.parameters; - - - warning - - - Un message d'alerte. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendComplete - GearmanJob::sendException - GearmanJob::sendFail - - - - - diff --git a/reference/gearman/gearmanjob/setreturn.xml b/reference/gearman/gearmanjob/setreturn.xml deleted file mode 100644 index c8f4a6d453..0000000000 --- a/reference/gearman/gearmanjob/setreturn.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanJob::setReturn - Définit une valeur de retour - - - - &reftitle.description; - - public boolGearmanJob::setReturn - intgearman_return_t - - - Définit une valeur de retour pour ce travail, indiquant la façon dont - s'est terminé ce travail. - - - - - &reftitle.parameters; - - - gearman_return_t - - - Une valeur de retour valide Gearman. - - - - - - - - &reftitle.returnvalues; - - - - - - diff --git a/reference/gearman/gearmanjob/status.xml b/reference/gearman/gearmanjob/status.xml deleted file mode 100644 index f3a09834ff..0000000000 --- a/reference/gearman/gearmanjob/status.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - GearmanJob::status - Envoie un statut (obsolète) - - - - &reftitle.description; - - public boolGearmanJob::status - intnumerator - intdenominator - - - Envoie des informations de statut au serveur de travaux ainsi qu'à tous - les clients à l'écoute. Utiliser cette méthode pour spécifier le pourcentage - de réalisation d'un travail. - - - - Cette méthode a été remplacée par la méthode - GearmanJob::sendStatus depuis la version - 0.6.0 de l'extension Gearman. - - - - - - &reftitle.parameters; - - - numerator - - - Le numérateur du taux de réalisation, sous forme d'une fraction. - - - - - denominator - - - Le dénominateur du taux de réalisation, sous forme d'une fraction. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::jobStatus - GearmanTask::taskDenominator - GearmanTask::taskNumerator - - - - - diff --git a/reference/gearman/gearmanjob/unique.xml b/reference/gearman/gearmanjob/unique.xml deleted file mode 100644 index b149340862..0000000000 --- a/reference/gearman/gearmanjob/unique.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanJob::unique - Récupère l'identifiant unique - - - - &reftitle.description; - - public falsestringGearmanJob::unique - - - - Retourne l'identifiant unique pour ce travail. - L'identifiant est assigné par le client. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'identifiant unique, ou &false; si le travail n'a pas été initialisé. - - - - - &reftitle.seealso; - - GearmanClient::do - GearmanTask::uuid - - - - - diff --git a/reference/gearman/gearmanjob/warning.xml b/reference/gearman/gearmanjob/warning.xml deleted file mode 100644 index efb0158359..0000000000 --- a/reference/gearman/gearmanjob/warning.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - GearmanJob::warning - Envoie une alerte (obsolète) - - - - &reftitle.description; - - public boolGearmanJob::warning - stringwarning - - - Envoie une alerte pour ce travail lors de son exécution. - - - - Cette méthode a été remplacée par la méthode - GearmanJob::sendWarning depuis la version - 0.6.0 de l'extension Gearman. - - - - - - &reftitle.parameters; - - - warning - - - Un message d'alerte. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendComplete - GearmanJob::sendException - GearmanJob::sendFail - - - - - diff --git a/reference/gearman/gearmanjob/workload.xml b/reference/gearman/gearmanjob/workload.xml deleted file mode 100644 index 1f7e7a6cd8..0000000000 --- a/reference/gearman/gearmanjob/workload.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanJob::workload - Récupère la charge de travail - - - - &reftitle.description; - - public stringGearmanJob::workload - - - - Récupère la charge pour ce travail. Ce sont les données sérialisées - à analyser par l'agent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Les données sérialisées. - - - - - &reftitle.seealso; - - GearmanClient::do - GearmanJob::workloadSize - - - - - diff --git a/reference/gearman/gearmanjob/workloadsize.xml b/reference/gearman/gearmanjob/workloadsize.xml deleted file mode 100644 index 48f19545a4..0000000000 --- a/reference/gearman/gearmanjob/workloadsize.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanJob::workloadSize - Récupère la taille de la charge de travail - - - - &reftitle.description; - - public intGearmanJob::workloadSize - - - - Retourne la taille de la charge pour ce travail (les données que l'agent doit traiter) - en octets. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La taille, en octets. - - - - - &reftitle.seealso; - - GearmanJob::workload - - - - - diff --git a/reference/gearman/gearmantask.xml b/reference/gearman/gearmantask.xml deleted file mode 100644 index 9751627253..0000000000 --- a/reference/gearman/gearmantask.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La classe GearmanTask - GearmanTask - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanTask - - - &Methods; - - - - - - - - - -
- - - - &reference.gearman.entities.gearmantask; - - - diff --git a/reference/gearman/gearmantask/construct.xml b/reference/gearman/gearmantask/construct.xml deleted file mode 100644 index d70759c1b2..0000000000 --- a/reference/gearman/gearmantask/construct.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - GearmanTask::__construct - Crée une instance GearmanTask - - - - &reftitle.description; - - public GearmanTask::__construct - - - - Crée une instance GearmanTask représentant une tâche - à soumettre au serveur de tâches. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet GearmanTask. - - - - - diff --git a/reference/gearman/gearmantask/create.xml b/reference/gearman/gearmantask/create.xml deleted file mode 100644 index 252f781850..0000000000 --- a/reference/gearman/gearmantask/create.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - GearmanTask::create - Crée une tâche (obsolète) - - - - &reftitle.description; - - public GearmanTaskfalseGearmanTask::create - - - - Retourne un nouvel objet GearmanTask. - - - - Cette méthode a été supprimée depuis la version - 0.6.0 de l'extension Gearman. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet GearmanTask&return.falseforfailure;. - - - - - diff --git a/reference/gearman/gearmantask/data.xml b/reference/gearman/gearmantask/data.xml deleted file mode 100644 index f9386fedb2..0000000000 --- a/reference/gearman/gearmantask/data.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanTask::data - Récupère les données retournées par une tâche - - - - &reftitle.description; - - public falsestringGearmanTask::data - - - - Retourne les données retournées d'une tâche par un agent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Les données sérialisées, ou &false; s'il n'y a aucune donnée. - - - - - &reftitle.seealso; - - GearmanTask::dataSize - - - - - diff --git a/reference/gearman/gearmantask/datasize.xml b/reference/gearman/gearmantask/datasize.xml deleted file mode 100644 index 30adf70d87..0000000000 --- a/reference/gearman/gearmantask/datasize.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanTask::dataSize - Récupère la taille des données retournées - - - - &reftitle.description; - - public intfalseGearmanTask::dataSize - - - - Retourne la taille des données retournées d'une tâche. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La taille des données, ou &false; s'il n'y a pas de données. - - - - - &reftitle.seealso; - - GearmanTask::data - - - - - diff --git a/reference/gearman/gearmantask/function.xml b/reference/gearman/gearmantask/function.xml deleted file mode 100644 index 9edf289b19..0000000000 --- a/reference/gearman/gearmantask/function.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - GearmanTask::function - Récupère le nom de la fonction associée (obsolète) - - - - &reftitle.description; - - public stringGearmanTask::function - - - - Retourne le nom de la fonction associée à cette tâche, c.-à-d., la fonction - appelée par l'agent Gearman. - - - - Cette méthode a été remplacée par la méthode - GearmanTask::functionName depuis la - version 0.6.0 de l'extension Gearman. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un nom de fonction. - - - - - diff --git a/reference/gearman/gearmantask/functionname.xml b/reference/gearman/gearmantask/functionname.xml deleted file mode 100644 index edb2e47f35..0000000000 --- a/reference/gearman/gearmantask/functionname.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - GearmanTask::functionName - Récupère le nom de la fonction associée - - - - &reftitle.description; - - public falsestringGearmanTask::functionName - - - - Retourne le nom de la fonction associée à cette tâche, c'est-à-dire, - la fonction appelée par l'agent Gearman. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un nom de fonction, ou &false; si la tâche n'a pas encore été créée. - - - - - diff --git a/reference/gearman/gearmantask/isknown.xml b/reference/gearman/gearmantask/isknown.xml deleted file mode 100644 index fced3fedd5..0000000000 --- a/reference/gearman/gearmantask/isknown.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - GearmanTask::isKnown - Vérifie si une tâche est connue - - - - &reftitle.description; - - public boolGearmanTask::isKnown - - - - Récupère les informations de statut si la tâche est connue sur le serveur - de travaux. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si la tâche est connue, &false; sinon. - - - - - diff --git a/reference/gearman/gearmantask/isrunning.xml b/reference/gearman/gearmantask/isrunning.xml deleted file mode 100644 index d111d15a86..0000000000 --- a/reference/gearman/gearmantask/isrunning.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - GearmanTask::isRunning - Vérifie si la tâche est actuellement en fonctionnement - - - - &reftitle.description; - - public boolGearmanTask::isRunning - - - - Indique si la tâche est actuellement en fonctionnement. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si la tâche est en fonctionnement, &false; sinon. - - - - - diff --git a/reference/gearman/gearmantask/jobhandle.xml b/reference/gearman/gearmantask/jobhandle.xml deleted file mode 100644 index 6e7bbe2d68..0000000000 --- a/reference/gearman/gearmantask/jobhandle.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanTask::jobHandle - gearman_job_handle - Récupère le gestionnaire de travaux - - - - &reftitle.description; - - public falsestringGearmanTask::jobHandle - - - - Récupère le gestionnaire de travaux pour cette tâche. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le gestionnaire de travaux, ou &false; si la tâche n'a pas encore été créée. - - - - - &reftitle.seealso; - - GearmanClient::doJobHandle - - - - - diff --git a/reference/gearman/gearmantask/recvdata.xml b/reference/gearman/gearmantask/recvdata.xml deleted file mode 100644 index 47bc53a746..0000000000 --- a/reference/gearman/gearmantask/recvdata.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanTask::recvData - Lit le travail ou les données retournées par une tâche dans un buffer - - - - &reftitle.description; - - public falsearrayGearmanTask::recvData - intdata_len - - - - &warn.experimental.func; - - - - &reftitle.parameters; - - - data_len - - - Longueur des données à lire. - - - - - - - - &reftitle.returnvalues; - - Un tableau dont le premier élément est la longueur des données - lues, et le second, le buffer de données. - Retourne &false; si la lecture échoue. - - - - - &reftitle.seealso; - - GearmanTask::sendData - - - - - diff --git a/reference/gearman/gearmantask/returncode.xml b/reference/gearman/gearmantask/returncode.xml deleted file mode 100644 index 0024a8c53e..0000000000 --- a/reference/gearman/gearmantask/returncode.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanTask::returnCode - Récupère le dernier code retourné - - - - &reftitle.description; - - public intGearmanTask::returnCode - - - - Retourne le dernier code retourné par Gearman pour une tâche. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un code valide de retour Gearman. - - - - - &reftitle.seealso; - - GearmanClient::returnCode - - - - - diff --git a/reference/gearman/gearmantask/senddata.xml b/reference/gearman/gearmantask/senddata.xml deleted file mode 100644 index 21ef4a8bb9..0000000000 --- a/reference/gearman/gearmantask/senddata.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - GearmanTask::sendData - Envoie des données pour une tâche (obsolète) - - - - &reftitle.description; - - public intGearmanTask::sendData - stringdata - - - - &warn.experimental.func; - - - - &reftitle.parameters; - - - data - - - Données à envoyer à l'agent. - - - - - - - - &reftitle.returnvalues; - - La longueur des données envoyées, ou &false; si l'envoi - a échoué. - - - - - &reftitle.seealso; - - GearmanTask::recvData - - - - - diff --git a/reference/gearman/gearmantask/sendworkload.xml b/reference/gearman/gearmantask/sendworkload.xml deleted file mode 100644 index 85ab12a465..0000000000 --- a/reference/gearman/gearmantask/sendworkload.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanTask::sendWorkload - Envoie les données pour une tâche - - - - &reftitle.description; - - public intfalseGearmanTask::sendWorkload - stringdata - - - - &warn.experimental.func; - - - - - &reftitle.parameters; - - - data - - - Données à envoyer à l'agent. - - - - - - - - &reftitle.returnvalues; - - La longueur des données à envoyer, ou &false; - si l'envoi échoue. - - - - - &reftitle.seealso; - - GearmanTask::recvData - - - - - diff --git a/reference/gearman/gearmantask/taskdenominator.xml b/reference/gearman/gearmantask/taskdenominator.xml deleted file mode 100644 index b4f5efe4e4..0000000000 --- a/reference/gearman/gearmantask/taskdenominator.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanTask::taskDenominator - Récupère le dénominateur du taux de réalisation - - - - &reftitle.description; - - public falseintGearmanTask::taskDenominator - - - - Retourne le dénominateur du taux de réalisation de la tâche. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un nombre entre 0 et 100, ou &false; s'il ne peut être déterminé. - - - - - &reftitle.seealso; - - GearmanTask::taskNumerator - - - - - diff --git a/reference/gearman/gearmantask/tasknumerator.xml b/reference/gearman/gearmantask/tasknumerator.xml deleted file mode 100644 index 8f6ae95f2b..0000000000 --- a/reference/gearman/gearmantask/tasknumerator.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanTask::taskNumerator - Récupère le numérateur du taux de réalisation - - - - &reftitle.description; - - public falseintGearmanTask::taskNumerator - - - - Retourne le numérateur du taux de réalisation de la tâche. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un nombre entre 0 et 100, ou &false; s'il ne peut être déterminé. - - - - - &reftitle.seealso; - - GearmanTask::taskDenominator - - - - - diff --git a/reference/gearman/gearmantask/unique.xml b/reference/gearman/gearmantask/unique.xml deleted file mode 100644 index 10298b7a1c..0000000000 --- a/reference/gearman/gearmantask/unique.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - GearmanTask::unique - Récupère l'identifiant unique de la tâche - - - - &reftitle.description; - - public falsestringGearmanTask::unique - - - - Retourne l'identifiant unique de la tâche. Il est assigné par la méthode - GearmanClient, contrairement au gestionnaire - de travaux qui est défini par le serveur de travaux Gearman. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'identifiant unique, ou &false; si aucun identifiant n'a été assigné. - - - - - &reftitle.seealso; - - GearmanClient::do - GearmanClient::addTask - - - - - diff --git a/reference/gearman/gearmantask/uuid.xml b/reference/gearman/gearmantask/uuid.xml deleted file mode 100644 index ecba5a8fe2..0000000000 --- a/reference/gearman/gearmantask/uuid.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - GearmanTask::uuid - Récupère l'identifiant unique pour une tâche (obsolète) - - - - &reftitle.description; - - public stringGearmanTask::uuid - - - - Retourne l'identifiant unique pour une tâche. Il est assigné par la - méthode GearmanClient, contrairement au gestionnaire - de travaux qui est défini par le serveur de travaux Gearman. - - - - Cette méthode a été remplacée par la méthode - GearmanTask::unique depuis la version - 0.6.0 de l'extension Gearman. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'identifiant unique, ou &false; si aucun identifiant n'est assigné. - - - - - &reftitle.seealso; - - GearmanClient::do - GearmanClient::addTask - - - - - diff --git a/reference/gearman/gearmanworker.xml b/reference/gearman/gearmanworker.xml deleted file mode 100644 index 13e69fb554..0000000000 --- a/reference/gearman/gearmanworker.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La classe GearmanWorker - GearmanWorker - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanWorker - - - &Methods; - - - - - - - - - -
- - - - &reference.gearman.entities.gearmanworker; - - - diff --git a/reference/gearman/gearmanworker/addfunction.xml b/reference/gearman/gearmanworker/addfunction.xml deleted file mode 100644 index d8291af12d..0000000000 --- a/reference/gearman/gearmanworker/addfunction.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - GearmanWorker::addFunction - Enregistre et ajoute une fonction de rappel - - - - &reftitle.description; - - public boolGearmanWorker::addFunction - stringfunction_name - callablefunction - mixedcontext&null; - inttimeout0 - - - Enregistre une fonction de rappel avec le serveur de travaux - et spécifie un rappel correspondant à cette fonction. Optionnellement, - fixe des données de contexte de l'application à utiliser lorsque - la fonction de rappel est appelée, ainsi qu'un délai maximal d'exécution. - - - - - &reftitle.parameters; - - - function_name - - - Le nom de la fonction à enregistrer avec le serveur de travaux - - - - - function - - - Une fonction de rappel à appeler lorsqu'un travail est soumis - - - - - context - - - Une référence à des données de contexte de l'application - qui peuvent être modifiées par la fonction de l'agent. - - - - - timeout - - - Un intervalle de temps, en secondes. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Agent simple qui utilise des données de contexte de l'application - -addServer(); - -# Définit une variable qui contient les données de l'application -$count= 0; - -# Ajoute la fonction "reverse" -$worker->addFunction("reverse", "reverse_cb", $count); - -# Démarre l'agent -while ($worker->work()); - -function reverse_cb($job, &$count) -{ - $count++; - return "$count: " . strrev($job->workload()); -} - -?> -]]> - - - Exécution d'un client qui soumet 2 travaux pour la fonction reverse affichera - quelque chose comme : - - - - - - - - - &reftitle.seealso; - - GearmanClient::do - - - - - diff --git a/reference/gearman/gearmanworker/addoptions.xml b/reference/gearman/gearmanworker/addoptions.xml deleted file mode 100644 index 2defc0f49a..0000000000 --- a/reference/gearman/gearmanworker/addoptions.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanWorker::addOptions - Ajout des options à l'agent - - - - &reftitle.description; - - public trueGearmanWorker::addOptions - intoption - - - Ajoute une ou des options à l'agent. - - - - - &reftitle.parameters; - - - option - - - Les options à ajouter - - - - - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.seealso; - - GearmanWorker::options - GearmanClient::setOptions - GearmanClient::removeOptions - - - - - diff --git a/reference/gearman/gearmanworker/addserver.xml b/reference/gearman/gearmanworker/addserver.xml deleted file mode 100644 index 8b22cc1981..0000000000 --- a/reference/gearman/gearmanworker/addserver.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - GearmanWorker::addServer - Ajoute un serveur de travaux - - - - &reftitle.description; - - public boolGearmanWorker::addServer - stringhost&null; - intport0 - boolsetupExceptionHandler&true; - - - Ajoute un serveur de travaux à cet agent. Il sera ajouté à une liste de - serveurs à utiliser pour exécuter les travaux. - Aucun socket I/O n'intervient ici. - - - - - &reftitle.parameters; - - - host - - - &gearman.parameter.host; - - - - - port - - - &gearman.parameter.port; - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ajout de serveurs Gearman - -addServer("10.0.0.1"); -$worker->addServer("10.0.0.2", 7003); -?> -]]> - - - - - - &reftitle.seealso; - - GearmanWorker::addServers - - - - - diff --git a/reference/gearman/gearmanworker/addservers.xml b/reference/gearman/gearmanworker/addservers.xml deleted file mode 100644 index 532d9acb8e..0000000000 --- a/reference/gearman/gearmanworker/addservers.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - GearmanWorker::addServers - Ajoute plusieurs serveurs de travaux - - - - &reftitle.description; - - public boolGearmanWorker::addServers - stringservers&null; - boolsetupExceptionHandler&true; - - - Ajoute un ou plusieurs serveurs de travaux à l'agent. - Ils seront ajoutés à une liste de serveurs qui pourront - être utilisés pour exécuter des travaux. Aucun socket I/O - n'intervient ici. - - - - - &reftitle.parameters; - - - servers - - - Une liste de serveurs de travaux séparés par une virgule, au format - hôte:port. Si le port n'est pas spécifié, la valeur par défaut utilisée - sera 4730. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ajout de 2 serveurs de travaux - -addServers("10.0.0.1,10.0.0.2:7003"); - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanWorker::addServer - - - - - diff --git a/reference/gearman/gearmanworker/clone.xml b/reference/gearman/gearmanworker/clone.xml deleted file mode 100644 index 7eb3df4a34..0000000000 --- a/reference/gearman/gearmanworker/clone.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - GearmanWorker::clone - Crée une copie d'un agent - - - - &reftitle.description; - - public voidGearmanWorker::clone - - - - Crée une copie d'un agent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet GearmanWorker. - - - - - diff --git a/reference/gearman/gearmanworker/construct.xml b/reference/gearman/gearmanworker/construct.xml deleted file mode 100644 index c3aa573d5e..0000000000 --- a/reference/gearman/gearmanworker/construct.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanWorker::__construct - Crée une instance GearmanWorker - - - - &reftitle.description; - - public GearmanWorker::__construct - - - - Crée une nouvelle instance de GearmanWorker - représentant un agent qui se connecte au serveur de travaux et accepte - des tâches à exécuter. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet GearmanWorker. - - - - - &reftitle.seealso; - - GearmanWorker::clone - - - - - diff --git a/reference/gearman/gearmanworker/echo.xml b/reference/gearman/gearmanworker/echo.xml deleted file mode 100644 index 777bdff5a9..0000000000 --- a/reference/gearman/gearmanworker/echo.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - GearmanWorker::echo - Teste la réponse d'un serveur de travaux - - - - &reftitle.description; - - public boolGearmanWorker::echo - stringworkload - - - Envoie les données à tous les serveurs de travaux pour vérifier - s'ils les retournent. C'est une fonction de test pour vérifier - si les serveurs de travaux répondent correctement. - - - - - &reftitle.parameters; - - - workload - - - Données sérialisées arbitraires. - - - - - - - - &reftitle.returnvalues; - - Retourne une valeur standard Gearman. - - - - - &reftitle.seealso; - - GearmanClient::echo - - - - - diff --git a/reference/gearman/gearmanworker/error.xml b/reference/gearman/gearmanworker/error.xml deleted file mode 100644 index f5fbe6ca96..0000000000 --- a/reference/gearman/gearmanworker/error.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanWorker::error - Récupère la dernière erreur survenue - - - - &reftitle.description; - - public stringfalseGearmanWorker::error - - - - Retourne la dernière erreur survenue, sous la forme d'une &string;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une &string; humainement lisible représentant la dernière erreur survenue, - ou &false; s'il n'y a pas de message d'erreur disponible. - - - - - &reftitle.seealso; - - GearmanWorker::getErrno - - - - - diff --git a/reference/gearman/gearmanworker/geterrno.xml b/reference/gearman/gearmanworker/geterrno.xml deleted file mode 100644 index c4f89e7f85..0000000000 --- a/reference/gearman/gearmanworker/geterrno.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanWorker::getErrno - Récupère la errno - - - - &reftitle.description; - - public intGearmanWorker::getErrno - - - - Retourne la valeur de errno dans le cas d'une valeur de retour - GEARMAN_ERRNO. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une errno valide. - - - - - &reftitle.seealso; - - GearmanWorker::error - - - - - diff --git a/reference/gearman/gearmanworker/options.xml b/reference/gearman/gearmanworker/options.xml deleted file mode 100644 index adb994d214..0000000000 --- a/reference/gearman/gearmanworker/options.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanWorker::options - Récupère les options de l'agent - - - - &reftitle.description; - - public intGearmanWorker::options - - - - Récupère les options précédemment définies pour l'agent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Les options actuellement définies pour l'agent. - - - - - &reftitle.seealso; - - GearmanWorker::setOptions - - - - - diff --git a/reference/gearman/gearmanworker/register.xml b/reference/gearman/gearmanworker/register.xml deleted file mode 100644 index 984b9f2de3..0000000000 --- a/reference/gearman/gearmanworker/register.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - GearmanWorker::register - Enregistre une fonction sur un serveur de travaux - - - - &reftitle.description; - - public boolGearmanWorker::register - stringfunction_name - inttimeout0 - - - Enregistre un nom de fonction avec un serveur de travaux avec un optionnel - délai maximal d'exécution. Ce délai spécifie le nombre de secondes que le serveur - doit attendre avant de marquer une tâche comme ayant échoué. Si ce délai - est défini à zéro, il n'y aura aucun délai. - - - - - &reftitle.parameters; - - - function_name - - - Le nom de la fonction à enregistrer avec le serveur de travaux. - - - - - timeout - - - Un intervalle de temps, en secondes. - - - - - - - - &reftitle.returnvalues; - - Une valeur de retour Gearman standard. - - - - - &reftitle.seealso; - - GearmanWorker::unregister - GearmanWorker::unregisterAll - - - - - diff --git a/reference/gearman/gearmanworker/removeoptions.xml b/reference/gearman/gearmanworker/removeoptions.xml deleted file mode 100644 index 9b0480613d..0000000000 --- a/reference/gearman/gearmanworker/removeoptions.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanWorker::removeOptions - Supprime des options de l'agent - - - - &reftitle.description; - - public trueGearmanWorker::removeOptions - intoption - - - Supprime une ou plusieurs options de l'agent. - - - - - &reftitle.parameters; - - - option - - - Les options à supprimer - - - - - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.seealso; - - GearmanWorker::options - GearmanWorker::setOptions - GearmanWorker::addOptions - - - - - diff --git a/reference/gearman/gearmanworker/returncode.xml b/reference/gearman/gearmanworker/returncode.xml deleted file mode 100644 index c3c4ee296c..0000000000 --- a/reference/gearman/gearmanworker/returncode.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanWorker::returnCode - Récupère le dernier code Gearman retourné - - - - &reftitle.description; - - public intGearmanWorker::returnCode - - - - Retourne le dernier code Gearman retourné. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un code de retour Gearman valide. - - - - - &reftitle.seealso; - - GearmanWorker::error - GearmanWorker::getErrno - - - - - diff --git a/reference/gearman/gearmanworker/setid.xml b/reference/gearman/gearmanworker/setid.xml deleted file mode 100644 index 6ca795ec8d..0000000000 --- a/reference/gearman/gearmanworker/setid.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - GearmanWorker::setId - Définit un identifiant à l'agent - - - - &reftitle.description; - - public boolGearmanWorker::setId - stringid - - - Assigne à l'agent un identifiant, permettant ainsi qu'il soit identifiable lorsque - gearman demande la liste des agents disponibles. - - - - - &reftitle.parameters; - - - id - - - Un identifiant. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>GearmanWorker::setId</function> - - Définit un identifiant à un worker simple. - - -setId('test'); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/gearman/gearmanworker/setoptions.xml b/reference/gearman/gearmanworker/setoptions.xml deleted file mode 100644 index d163e0da8e..0000000000 --- a/reference/gearman/gearmanworker/setoptions.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - GearmanWorker::setOptions - Définit les options de l'agent - - - - &reftitle.description; - - public trueGearmanWorker::setOptions - intoption - - - Définit une ou plusieurs options de l'agent. - - - - - &reftitle.parameters; - - - option - - - Les options à définir. - - - - - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.seealso; - - GearmanWorker::options - GearmanWorker::addOptions - GearmanWorker::removeOptions - GearmanClient::setOptions - - - - - diff --git a/reference/gearman/gearmanworker/settimeout.xml b/reference/gearman/gearmanworker/settimeout.xml deleted file mode 100644 index 2c86d2d0d0..0000000000 --- a/reference/gearman/gearmanworker/settimeout.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - GearmanWorker::setTimeout - Définit le délai d'attente maximal d'activité du socket I/O - - - - &reftitle.description; - - public trueGearmanWorker::setTimeout - inttimeout - - - Définit l'intervalle de temps à attendre une activité du socket I/O. - - - - - &reftitle.parameters; - - - timeout - - - Un intervalle de temps, en millisecondes. Une valeur négative indique - que le délai sera infini. - - - - - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.examples; - - Un agent simple qui attend 5 secondes - -addServer(); - -# Enregistre une fonction "reverse" avec le serveur. -$gmworker->addFunction("reverse", "reverse_fn"); - -# Définit le délai d'attente à 5 secondes -$gmworker->setTimeout(5000); - -echo "Attente d'un travail...\n"; -while(@$gmworker->work() || $gmworker->returnCode() == GEARMAN_TIMEOUT) -{ - if ($gmworker->returnCode() == GEARMAN_TIMEOUT) - { - # Normalement, vous devriez faire quelques lignes utiles ici... - echo "Délai d'attente expiré. Attente du prochain travail...\n"; - continue; - } - - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -echo "Fait\n"; - -function reverse_fn($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - - L'exécution d'un agent avec aucun travail de soumis générera un affichage - qui ressemblera à quelque chose comme : - - - - - - - - - &reftitle.seealso; - - GearmanWorker::timeout - - - - - diff --git a/reference/gearman/gearmanworker/timeout.xml b/reference/gearman/gearmanworker/timeout.xml deleted file mode 100644 index cee02a9b9d..0000000000 --- a/reference/gearman/gearmanworker/timeout.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanWorker::timeout - Récupère le délai d'attente de l'activité du socket I/O - - - - &reftitle.description; - - public intGearmanWorker::timeout - - - - Retourne le délai d'attente courant, en millisecondes, de l'activité - du socket I/O. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une période de temps, en millisecondes. Une valeur négative indique - que le délai est infini. - - - - - &reftitle.seealso; - - GearmanWorker::setTimeout - - - - - diff --git a/reference/gearman/gearmanworker/unregister.xml b/reference/gearman/gearmanworker/unregister.xml deleted file mode 100644 index b5b4099e94..0000000000 --- a/reference/gearman/gearmanworker/unregister.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanWorker::unregister - Supprime une fonction des serveurs de travaux - - - - &reftitle.description; - - public boolGearmanWorker::unregister - stringfunction_name - - - Supprime une fonction des serveurs de travaux, faisant ainsi qu'aucun travail - ne sera envoyé à l'agent pour cette fonction. - - - - - &reftitle.parameters; - - - function_name - - - Le nom d'une fonction à supprimer du serveur de travaux. - - - - - - - - &reftitle.returnvalues; - - Une valeur de retour standard Gearman. - - - - - &reftitle.seealso; - - GearmanWorker::register - GearmanWorker::unregisterAll - - - - - diff --git a/reference/gearman/gearmanworker/unregisterall.xml b/reference/gearman/gearmanworker/unregisterall.xml deleted file mode 100644 index f09027213b..0000000000 --- a/reference/gearman/gearmanworker/unregisterall.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanWorker::unregisterAll - Supprime toutes les fonctions des serveurs de travaux - - - - &reftitle.description; - - public boolGearmanWorker::unregisterAll - - - - Supprime toutes les fonctions précédemment enregistrées, s'assurant ainsi - qu'aucun travail ne sera envoyé à l'agent avec ces fonctions. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une valeur de retour standard Gearman. - - - - - &reftitle.seealso; - - GearmanWorker::register - GearmanWorker::unregister - - - - - diff --git a/reference/gearman/gearmanworker/wait.xml b/reference/gearman/gearmanworker/wait.xml deleted file mode 100644 index 5ce3bd45ce..0000000000 --- a/reference/gearman/gearmanworker/wait.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - GearmanWorker::wait - Attend une activité d'un ou plusieurs serveurs de travaux - - - - &reftitle.description; - - public boolGearmanWorker::wait - - - - Met en attente l'agent d'une activité d'un ou plusieurs serveurs de travaux lors - d'un fonctionnement en mode I/O non bloquant. En cas d'échec, une alerte de niveau - E_WARNING sera émise avec le contenu de la dernière erreur Gearman - survenue. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exécution d'un agent en mode non bloquant - -addOptions(GEARMAN_WORKER_NON_BLOCKING); - -# Ajoute un serveur par défaut (localhost, port 4730) -$worker->addServer(); - -# Ajoute une fonction "reverse" -$worker->addFunction('reverse', 'reverse_fn'); - -# Tente de récupérer un travail -while (@$worker->work() || - $worker->returnCode() == GEARMAN_IO_WAIT || - $worker->returnCode() == GEARMAN_NO_JOBS) -{ - if ($worker->returnCode() == GEARMAN_SUCCESS) - continue; - - echo "Attente du premier travail...\n"; - if (!@$worker->wait()) - { - if ($worker->returnCode() == GEARMAN_NO_ACTIVE_FDS) - { - # Nous ne sommes connectés à aucun serveur ; nous attendons donc un peu - # avant de tenter une reconnexion. - sleep(5); - continue; - } - break; - } -} - -echo "Erreur de l'agent : " . $worker->error() . "\n"; - -function reverse_fn($job) -{ - return strrev($job->workload()); -} - - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanWorker::work - - - - - diff --git a/reference/gearman/gearmanworker/work.xml b/reference/gearman/gearmanworker/work.xml deleted file mode 100644 index b94b6152a7..0000000000 --- a/reference/gearman/gearmanworker/work.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - GearmanWorker::work - Attend et exécute un travail - - - - &reftitle.description; - - public boolGearmanWorker::work - - - - Attend un travail et appelle la fonction de rappel correspondante. - Émet une alerte de type E_WARNING contenant la - dernière erreur Gearman survenue si le code retourné n'est pas une - des constantes suivantes : GEARMAN_SUCCESS, GEARMAN_IO_WAIT, - ou GEARMAN_WORK_FAIL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <methodname>GearmanWorker::work</methodname> - -addServer(); - -# Ajoute la fonction "reverse" -$worker->addFunction("reverse", "my_reverse_function"); - -# Démarre l'écoute de l'agent afin de récupérer un travail -while ($worker->work()); - -function my_reverse_function($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanWorker::addFunction - - - - - diff --git a/reference/gearman/setup.xml b/reference/gearman/setup.xml deleted file mode 100644 index c15e103834..0000000000 --- a/reference/gearman/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - &reftitle.setup; - -
- &reftitle.required; - - - Cette extension nécessite les bibliothèques - libgearman, - libevent et - uuid ainsi qu'un - serveur Gearman. - -
- - - &reference.gearman.configure; - - - - diff --git a/reference/gender/book.xml b/reference/gender/book.xml deleted file mode 100644 index 46a57ab0c0..0000000000 --- a/reference/gender/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - Détermine le sexe d'un prénom - Gender - - - &reftitle.intro; - - L'extension PHP Gender est un port du programme gender.c - originalement écrit par Joerg Michael. Le but premier de - ce programme est de trouver le sexe d'un prénom. La base de données - courante contient plus de 40000 prénoms de 54 pays. - - - - &reference.gender.setup; - &reference.gender.examples; - &reference.gender.gender; - - - diff --git a/reference/gender/configure.xml b/reference/gender/configure.xml deleted file mode 100644 index ba729da9c9..0000000000 --- a/reference/gender/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;gender - - - -
- diff --git a/reference/gender/examples.xml b/reference/gender/examples.xml deleted file mode 100644 index c2f4466351..0000000000 --- a/reference/gender/examples.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - &reftitle.examples; -
- Exemple d'utilisation - - Exemple d'utilisation de la classe Gender. - - - Exemple d'utilisation - -get($name, $country); - -$data = $gender->country($country); - -switch($result) { - case Gender::IS_FEMALE: - printf("Le prénom %s est de sexe féminin pour le pays %s\n", $name, $data['country']); - break; - - - case Gender::IS_MOSTLY_FEMALE: - printf("Le prénom %s est le plus souvent de sexe féminin pour le pays %s\n", $name, $data['country']); - break; - - - case Gender::IS_MALE: - printf("Le prénom %s est de sexe masculin pour le pays %s\n", $name, $data['country']); - break; - - - case Gender::IS_MOSTLY_MALE: - printf("Le prénom %s est le plus souvent de sexe masculin pour le pays %s\n", $name, $data['country']); - break; - - - case Gender::IS_UNISEX_NAME: - printf("Le prénom %s est unisexe pour le pays %s\n", $name, $data['country']); - break; - - - case Gender::IS_A_COUPLE: - printf("Le prénom %s est à la fois masculin et féminin pour le pays %s\n", $name, $data['country']); - break; - - - case Gender::NAME_NOT_FOUND: - printf("Le prénom %s n'a pas été trouvé pour le pays %s\n", $name, $data['country']); - break; - - - case Gender::ERROR_IN_NAME: - echo "Il y a une erreur dans le prénom fourni !\n"; - break; - - default: - echo "Une erreur est survenue !\n"; - break; - -} -]]> - - -
- - diff --git a/reference/gender/gender.xml b/reference/gender/gender.xml deleted file mode 100644 index fd3b1ed7d2..0000000000 --- a/reference/gender/gender.xml +++ /dev/null @@ -1,889 +0,0 @@ - - - - - - - La classe Gender\Gender - Gender\Gender - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - Gender\Gender - - - - - Gender\Gender - - - - &Constants; - - const - int - Gender\Gender::IS_FEMALE - 70 - - - const - int - Gender\Gender::IS_MOSTLY_FEMALE - 102 - - - const - int - Gender\Gender::IS_MALE - 77 - - - const - int - Gender\Gender::IS_MOSTLY_MALE - 109 - - - const - int - Gender\Gender::IS_UNISEX_NAME - 63 - - - const - int - Gender\Gender::IS_A_COUPLE - 67 - - - const - int - Gender\Gender::NAME_NOT_FOUND - 32 - - - const - int - Gender\Gender::ERROR_IN_NAME - 69 - - - const - int - Gender\Gender::ANY_COUNTRY - 0 - - - const - int - Gender\Gender::BRITAIN - 1 - - - const - int - Gender\Gender::IRELAND - 2 - - - const - int - Gender\Gender::USA - 3 - - - const - int - Gender\Gender::SPAIN - 4 - - - const - int - Gender\Gender::PORTUGAL - 5 - - - const - int - Gender\Gender::ITALY - 6 - - - const - int - Gender\Gender::MALTA - 7 - - - const - int - Gender\Gender::FRANCE - 8 - - - const - int - Gender\Gender::BELGIUM - 9 - - - const - int - Gender\Gender::LUXEMBOURG - 10 - - - const - int - Gender\Gender::NETHERLANDS - 11 - - - const - int - Gender\Gender::GERMANY - 12 - - - const - int - Gender\Gender::EAST_FRISIA - 13 - - - const - int - Gender\Gender::AUSTRIA - 14 - - - const - int - Gender\Gender::SWISS - 15 - - - const - int - Gender\Gender::ICELAND - 16 - - - const - int - Gender\Gender::DENMARK - 17 - - - const - int - Gender\Gender::NORWAY - 18 - - - const - int - Gender\Gender::SWEDEN - 19 - - - const - int - Gender\Gender::FINLAND - 20 - - - const - int - Gender\Gender::ESTONIA - 21 - - - const - int - Gender\Gender::LATVIA - 22 - - - const - int - Gender\Gender::LITHUANIA - 23 - - - const - int - Gender\Gender::POLAND - 24 - - - const - int - Gender\Gender::CZECH_REP - 25 - - - const - int - Gender\Gender::SLOVAKIA - 26 - - - const - int - Gender\Gender::HUNGARY - 27 - - - const - int - Gender\Gender::ROMANIA - 28 - - - const - int - Gender\Gender::BULGARIA - 29 - - - const - int - Gender\Gender::BOSNIA - 30 - - - const - int - Gender\Gender::CROATIA - 31 - - - const - int - Gender\Gender::KOSOVO - 32 - - - const - int - Gender\Gender::MACEDONIA - 33 - - - const - int - Gender\Gender::MONTENEGRO - 34 - - - const - int - Gender\Gender::SERBIA - 35 - - - const - int - Gender\Gender::SLOVENIA - 36 - - - const - int - Gender\Gender::ALBANIA - 37 - - - const - int - Gender\Gender::GREECE - 38 - - - const - int - Gender\Gender::RUSSIA - 39 - - - const - int - Gender\Gender::BELARUS - 40 - - - const - int - Gender\Gender::MOLDOVA - 41 - - - const - int - Gender\Gender::UKRAINE - 42 - - - const - int - Gender\Gender::ARMENIA - 43 - - - const - int - Gender\Gender::AZERBAIJAN - 44 - - - const - int - Gender\Gender::GEORGIA - 45 - - - const - int - Gender\Gender::KAZAKH_UZBEK - 46 - - - const - int - Gender\Gender::TURKEY - 47 - - - const - int - Gender\Gender::ARABIA - 48 - - - const - int - Gender\Gender::ISRAEL - 49 - - - const - int - Gender\Gender::CHINA - 50 - - - const - int - Gender\Gender::INDIA - 51 - - - const - int - Gender\Gender::JAPAN - 52 - - - const - int - Gender\Gender::KOREA - 53 - - - &Methods; - - - - - - - - - -
- - -
- &reftitle.constants; - - - - Gender\Gender::IS_FEMALE - - - - - - - Gender\Gender::IS_MOSTLY_FEMALE - - - - - - - Gender\Gender::IS_MALE - - - - - - - Gender\Gender::IS_MOSTLY_MALE - - - - - - - Gender\Gender::IS_UNISEX_NAME - - - - - - - Gender\Gender::IS_A_COUPLE - - - - - - - Gender\Gender::NAME_NOT_FOUND - - - - - - - Gender\Gender::ERROR_IN_NAME - - - - - - - Gender\Gender::ANY_COUNTRY - - - - - - - Gender\Gender::BRITAIN - - - - - - - Gender\Gender::IRELAND - - - - - - - Gender\Gender::USA - - - - - - - Gender\Gender::SPAIN - - - - - - - Gender\Gender::PORTUGAL - - - - - - - Gender\Gender::ITALY - - - - - - - Gender\Gender::MALTA - - - - - - - Gender\Gender::FRANCE - - - - - - - Gender\Gender::BELGIUM - - - - - - - Gender\Gender::LUXEMBOURG - - - - - - - Gender\Gender::NETHERLANDS - - - - - - - Gender\Gender::GERMANY - - - - - - - Gender\Gender::EAST_FRISIA - - - - - - - Gender\Gender::AUSTRIA - - - - - - - Gender\Gender::SWISS - - - - - - - Gender\Gender::ICELAND - - - - - - - Gender\Gender::DENMARK - - - - - - - Gender\Gender::NORWAY - - - - - - - Gender\Gender::SWEDEN - - - - - - - Gender\Gender::FINLAND - - - - - - - Gender\Gender::ESTONIA - - - - - - - Gender\Gender::LATVIA - - - - - - - Gender\Gender::LITHUANIA - - - - - - - Gender\Gender::POLAND - - - - - - - Gender\Gender::CZECH_REP - - - - - - - Gender\Gender::SLOVAKIA - - - - - - - Gender\Gender::HUNGARY - - - - - - - Gender\Gender::ROMANIA - - - - - - - Gender\Gender::BULGARIA - - - - - - - Gender\Gender::BOSNIA - - - - - - - Gender\Gender::CROATIA - - - - - - - Gender\Gender::KOSOVO - - - - - - - Gender\Gender::MACEDONIA - - - - - - - Gender\Gender::MONTENEGRO - - - - - - - Gender\Gender::SERBIA - - - - - - - Gender\Gender::SLOVENIA - - - - - - - Gender\Gender::ALBANIA - - - - - - - Gender\Gender::GREECE - - - - - - - Gender\Gender::RUSSIA - - - - - - - Gender\Gender::BELARUS - - - - - - - Gender\Gender::MOLDOVA - - - - - - - Gender\Gender::UKRAINE - - - - - - - Gender\Gender::ARMENIA - - - - - - - Gender\Gender::AZERBAIJAN - - - - - - - Gender\Gender::GEORGIA - - - - - - - Gender\Gender::KAZAKH_UZBEK - - - - - - - Gender\Gender::TURKEY - - - - - - - Gender\Gender::ARABIA - - - - - - - Gender\Gender::ISRAEL - - - - - - - Gender\Gender::CHINA - - - - - - - Gender\Gender::INDIA - - - - - - - Gender\Gender::JAPAN - - - - - - - Gender\Gender::KOREA - - - - - - -
- - - - - - &reference.gender.entities.gender; - - - diff --git a/reference/gender/gender/connect.xml b/reference/gender/gender/connect.xml deleted file mode 100644 index 3306e327e4..0000000000 --- a/reference/gender/gender/connect.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gender\Gender::connect - Connexion à un dictionnaire externe - - - - &reftitle.description; - - public boolGender\Gender::connect - stringdsn - - - Connexion à un dictionnaire externe. - Actuellement, seuls les flux sont supportés. - - - - - &reftitle.parameters; - - - dsn - - - DSN à ouvrir. - - - - - - - - &reftitle.returnvalues; - - Un booléen en cas de succès ou d'échec. - - - - diff --git a/reference/gender/gender/construct.xml b/reference/gender/gender/construct.xml deleted file mode 100644 index 8b1040d6c2..0000000000 --- a/reference/gender/gender/construct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - Gender\Gender::__construct - Construit un objet Gender - - - - &reftitle.description; - - public Gender\Gender::__construct - stringdsn - - - Crée un objet Gender, en se connectant, optionnellement, à un - dictionnaire externe. Lorsqu'aucune base de données n'est fournie, - les données compilées en interne seront utilisées. - - - - - &reftitle.parameters; - - - dsn - - - DSN à ouvrir. - - - - - - - - diff --git a/reference/gender/gender/country.xml b/reference/gender/gender/country.xml deleted file mode 100644 index ba4f8b9545..0000000000 --- a/reference/gender/gender/country.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - Gender\Gender::country - Récupère la représentation textuelle d'un pays - - - - &reftitle.description; - - public arrayfalseGender\Gender::country - intcountry - - - Récupère la représentation textuelle d'un pays depuis - la constante de la classe Gender. - - - - - &reftitle.parameters; - - - country - - - Identifiant du pays (correspond à une constante de la classe - Gender\Gender). - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les noms courts et longs - du pays en cas de succès &return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <methodname>Gender\Gender::country</methodname> - -country(Gender\Gender::BRITAIN)); -]]> - - &example.outputs; - - - string(2) "UK" - 'country' => - string(13) "Great Britain" -} -]]> - - - - - diff --git a/reference/gender/gender/get.xml b/reference/gender/gender/get.xml deleted file mode 100644 index 883a4ba56a..0000000000 --- a/reference/gender/gender/get.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Gender\Gender::get - Récupère le sexe d'un prénom - - - - &reftitle.description; - - public intGender\Gender::get - stringname - intcountry - - - Récupère le sexe d'un prénom pour un pays spécifique. - - - - - &reftitle.parameters; - - - name - - - Le prénom à vérifier. - - - - - country - - - L'identifiant du pays (une constante de la classe Gender). - - - - - - - - &reftitle.returnvalues; - - Retourne le sexe du prénom. - - - - - - diff --git a/reference/gender/gender/isnick.xml b/reference/gender/gender/isnick.xml deleted file mode 100644 index 5128e6756e..0000000000 --- a/reference/gender/gender/isnick.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Gender\Gender::isNick - Vérifie si name0 est un alias de name1 - - - - &reftitle.description; - - public arrayGender\Gender::isNick - stringname0 - stringname1 - intcountry - - - Vérifie si name0 est un alias de name1. - - - - - &reftitle.parameters; - - - name0 - - - Nom à vérifier. - - - - - name1 - - - Nom à vérifier. - - - - - country - - - Identifiant du pays, identifié par la constante de la - classe Gender. Si omis, ANY_COUNTRY sera utilisé. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/gender/gender/similarnames.xml b/reference/gender/gender/similarnames.xml deleted file mode 100644 index 38dd1e2e9a..0000000000 --- a/reference/gender/gender/similarnames.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - Gender\Gender::similarNames - Récupère des noms similaires - - - - &reftitle.description; - - public arrayGender\Gender::similarNames - stringname - intcountry - - - Récupère des noms similaires pour le nom et le pays fourni. - - - - - &reftitle.parameters; - - - name - - - Nom à vérifier. - - - - - country - - - Identifiant du pays, identifié par la constante de classe - Gender. Si omis, ANY_COUNTRY sera utilisé. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les noms similaires trouvés. - - - - - - diff --git a/reference/gender/setup.xml b/reference/gender/setup.xml deleted file mode 100644 index 615270d753..0000000000 --- a/reference/gender/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - &reftitle.setup; - - - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;gender. - -
- - - - - diff --git a/reference/geoip/book.xml b/reference/geoip/book.xml deleted file mode 100644 index d1b1f04a31..0000000000 --- a/reference/geoip/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Localisation géographique des IPs - GeoIP - - - &reftitle.intro; - - L'extension GeoIP permet de localiser une adresse IP. La ville, l'état, le pays, - la longitude, la latitude et d'autres informations comme l'ISP et le type de connexion - peuvent être obtenus grâce à GeoIP. - - - - Cette extension ne supporte pas les bases de données "GeoIP2" - actuelles de MaxMind, uniquement les fichiers de base de données "GeoIP Legacy". - - - - - &reference.geoip.setup; - &reference.geoip.constants; - &reference.geoip.reference; - - - diff --git a/reference/geoip/constants.xml b/reference/geoip/constants.xml deleted file mode 100644 index c9098ec504..0000000000 --- a/reference/geoip/constants.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - GEOIP_COUNTRY_EDITION - (int) - - - - - - - - - - GEOIP_REGION_EDITION_REV0 - (int) - - - - - - - - - - GEOIP_CITY_EDITION_REV0 - (int) - - - - - - - - - - GEOIP_ORG_EDITION - (int) - - - - - - - - - - GEOIP_ISP_EDITION - (int) - - - - - - - - - - GEOIP_CITY_EDITION_REV1 - (int) - - - - - - - - - - GEOIP_REGION_EDITION_REV1 - (int) - - - - - - - - - - GEOIP_PROXY_EDITION - (int) - - - - - - - - - - GEOIP_ASNUM_EDITION - (int) - - - - - - - - - - GEOIP_NETSPEED_EDITION - (int) - - - - - - - - - - GEOIP_DOMAIN_EDITION - (int) - - - - - - - - - - Les constantes suivantes sont utilisées pour la rapidité réseau : - - - - - GEOIP_UNKNOWN_SPEED - (int) - - - - - - - - GEOIP_DIALUP_SPEED - (int) - - - - - - - - GEOIP_CABLEDSL_SPEED - (int) - - - - - - - - GEOIP_CORPORATE_SPEED - (int) - - - - - - - - diff --git a/reference/geoip/functions/geoip-asnum-by-name.xml b/reference/geoip/functions/geoip-asnum-by-name.xml deleted file mode 100644 index 7735b72979..0000000000 --- a/reference/geoip/functions/geoip-asnum-by-name.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - geoip_asnum_by_name - Récupère l'ASN (Autonomous System Numbers) - - - &reftitle.description; - - stringgeoip_asnum_by_name - stringhostname - - - - La fonction geoip_asnum_by_name va récupérer l'ASN - (Autonomous System Numbers) associé avec l'adresse IP. - - - - - &reftitle.parameters; - - - hostname - - - Le nom d'hôte ou l'adresse IP. - - - - - - - &reftitle.returnvalues; - - Retourne l'ASN en cas de succès, ou &false; si l'adresse ne peut - être trouvée dans la base de données. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_asnum_by_name</function> - - Cet exemple va afficher l'ASN pour l'hôte www.example.com. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-continent-code-by-name.xml b/reference/geoip/functions/geoip-continent-code-by-name.xml deleted file mode 100644 index 1d909fdc00..0000000000 --- a/reference/geoip/functions/geoip-continent-code-by-name.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - geoip_continent_code_by_name - Lit le code de continent d'une IP - - - &reftitle.description; - - stringgeoip_continent_code_by_name - stringhostname - - - - geoip_continent_code_by_name retourne le code en deux - lettres du continent correspondant à un nom d'hôte ou une adresse IP. - - - - - &reftitle.parameters; - - - hostname - - - Le nom d'hôte ou l'adresse IP qui est étudiée. - - - - - - - &reftitle.returnvalues; - - Retourne le code en deux lettres du nom de continent, en cas de succès, - et &false; si l'adresse n'a pas pu être trouvée dans la base. - - - Continent codes - - - - Code - Nom du continent - - - - - AF - Afrique - - - AN - Antarctique - - - AS - Asie - - - EU - Europe - - - NA - Amérique du nord - - - OC - Océanie - - - SA - Amérique du sud - - - -
- - - - &reftitle.examples; - - Exemple avec <function>geoip_continent_code_by_name</function> - - Ce script va afficher le continent de l'hôte example.com. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - geoip_country_code_by_name - - - - - diff --git a/reference/geoip/functions/geoip-country-code-by-name.xml b/reference/geoip/functions/geoip-country-code-by-name.xml deleted file mode 100644 index 2d48ae69b0..0000000000 --- a/reference/geoip/functions/geoip-country-code-by-name.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - geoip_country_code_by_name - Récupère les deux lettres du code pays - - - &reftitle.description; - - stringgeoip_country_code_by_name - stringhostname - - - - La fonction geoip_country_code_by_name - retourne les deux lettres du code pays correspondant au nom de l'hôte ou - à l'adresse IP. - - - - - &reftitle.parameters; - - - hostname - - - Le nom de l'hôte ou l'adresse IP - - - - - - - &reftitle.returnvalues; - - Retourne les deux lettres du code pays ISO en cas de succès, ou - &false; si l'adresse n'a pu être trouvée dans la base de données. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_country_code_by_name</function> - - Cet exemple affiche la localisation de l'hôte example.com. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - Se reporter à la page - &url.maxmind.iso3166; - pour une liste complète des valeurs retournées possibles, incluant - les codes spéciaux. - - - - - - &reftitle.seealso; - - geoip_country_code3_by_name - geoip_country_name_by_name - - - - - diff --git a/reference/geoip/functions/geoip-country-code3-by-name.xml b/reference/geoip/functions/geoip-country-code3-by-name.xml deleted file mode 100644 index 218f701bd1..0000000000 --- a/reference/geoip/functions/geoip-country-code3-by-name.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - geoip_country_code3_by_name - Récupère les trois lettres du code pays - - - &reftitle.description; - - stringgeoip_country_code3_by_name - stringhostname - - - - La fonction geoip_country_code3_by_name - retourne les trois lettres du code pays correspondant au nom de l'hôte ou - à l'adresse IP. - - - - - &reftitle.parameters; - - - hostname - - - Le nom de l'hôte ou l'adresse IP - - - - - - - &reftitle.returnvalues; - - Retourne les trois lettres du code pays en cas de succès, ou &false; - si l'adresse n'a pu être trouvée dans la base de données. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_country_code3_by_name</function> - - Cet exemple affiche où est localisé l'hôte example.com. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - geoip_country_code_by_name - geoip_country_name_by_name - - - - diff --git a/reference/geoip/functions/geoip-country-name-by-name.xml b/reference/geoip/functions/geoip-country-name-by-name.xml deleted file mode 100644 index b801084e7d..0000000000 --- a/reference/geoip/functions/geoip-country-name-by-name.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - geoip_country_name_by_name - Récupère le nom complet du pays - - - &reftitle.description; - - stringgeoip_country_name_by_name - stringhostname - - - - La fonction geoip_country_name_by_name retourne - le nom complet du pays correspondant au nom de l'hôte ou à l'adresse - IP. - - - - - &reftitle.parameters; - - - hostname - - - Le nom de l'hôte ou l'adresse IP - - - - - - - &reftitle.returnvalues; - - Retourne le nom du pays en cas de succès, ou &false; si l'adresse - n'a pu être trouvée dans la base de données. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_country_name_by_name</function> - - Cet exemple affiche la localisation de l'hôte example.com. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - geoip_country_code_by_name - geoip_country_code3_by_name - - - - - diff --git a/reference/geoip/functions/geoip-database-info.xml b/reference/geoip/functions/geoip-database-info.xml deleted file mode 100644 index ffbdca2fa1..0000000000 --- a/reference/geoip/functions/geoip-database-info.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - geoip_database_info - Récupère les informations de la base de données GeoIP - - - &reftitle.description; - - stringgeoip_database_info - intdatabaseGEOIP_COUNTRY_EDITION - - - - La fonction geoip_database_info retourne - la version de la base de données GeoIP telle que définie dans le fichier binaire. - - - - Si cette fonction est appelée sans argument, elle retourne la version - de la GeoIP Free Country Edition. - - - - - &reftitle.parameters; - - - database - - - Le type de base de données, en tant qu'entier. Il est possible d'utiliser - diverses constantes définies - avec cette extension (ie: GEOIP_*_EDITION). - - - - - - - - &reftitle.returnvalues; - - Retourne la version correspondante de la base de données, ou &null; - si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_database_info</function> - - Cet exemple affiche les informations contenues dans la base de données. - - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/geoip/functions/geoip-db-avail.xml b/reference/geoip/functions/geoip-db-avail.xml deleted file mode 100644 index 182c722148..0000000000 --- a/reference/geoip/functions/geoip-db-avail.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - geoip_db_avail - Vérifie si la base de données GeoIP est disponible - - - &reftitle.description; - - boolgeoip_db_avail - intdatabase - - - - La fonction geoip_db_avail vérifie si la base - de données correspondante est disponible et peut être ouverte sur le disque. - - - - La fonction n'indique pas si le fichier est une base de données valide, - mais uniquement si elle est lisible. - - - - - &reftitle.parameters; - - - database - - - Le type de base de données, sous la forme d'un &integer;. - Il est possible d'utiliser diverses constantes, - définies avec cette extension (ie: GEOIP_*_EDITION). - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si la base de données existe, &false; si elle n'est pas trouvée, - ou &null; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_db_avail</function> - - Ceci affichera la version de la base de données courante. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-db-filename.xml b/reference/geoip/functions/geoip-db-filename.xml deleted file mode 100644 index 85e94c9605..0000000000 --- a/reference/geoip/functions/geoip-db-filename.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - geoip_db_filename - Retourne le nom du fichier contenant la base de données GeoIP spécifiée - - - &reftitle.description; - - stringgeoip_db_filename - intdatabase - - - - La fonction geoip_db_filename retourne le nom - du fichier contenant la base de données GeoIP spécifiée. - - - - La fonction n'indique pas si le fichier existe ou non sur le disque, mais - uniquement l'endroit dans lequel la bibliothèque cherche la base de données. - - - - - &reftitle.parameters; - - - database - - - Le type de base de données, sous la forme d'un &integer;. Il est possible d'utiliser diverses constantes, - définies avec cette extension (ie: GEOIP_*_EDITION). - - - - - - - - &reftitle.returnvalues; - - Retourne le nom du fichier de la base de données correspondant, ou - &null; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_db_filename</function> - - Ceci affichera le nom du fichier correspondant à la base de données. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-db-get-all-info.xml b/reference/geoip/functions/geoip-db-get-all-info.xml deleted file mode 100644 index 18d76d51ba..0000000000 --- a/reference/geoip/functions/geoip-db-get-all-info.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - geoip_db_get_all_info - Retourne des informations détaillées sur tous les types de bases de données GeoIP - - - &reftitle.description; - - arraygeoip_db_get_all_info - - - - - La fonction geoip_db_get_all_info retourne des informations - détaillées, sous la forme d'un tableau multidimensionnel, sur - tous les types de bases de données GeoIP. - - - Cette fonction est disponible même si aucune base de données n'est installée. - Elle listera simplement les bases de données comme étant non disponibles. - - - Les noms des différentes clés du tableau associatif retourné, sont les suivantes : - - - - - "available" : Booléen, indique si la base de données est disponible (voir la fonction - geoip_db_avail) - - - - - "description" : La description de la base de données - - - - - "filename" : Le nom du fichier contenant la base de données sur le disque (voir la fonction - geoip_db_filename) - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau associatif. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_db_get_all_info</function> - - Ceci affichera un tableau contenant toutes les informations. - - - -]]> - - &example.outputs; - - - array(3) { - ["available"]=> - bool(true) - ["description"]=> - string(21) "GeoIP Country Edition" - ["filename"]=> - string(32) "/usr/share/GeoIP/GeoIP.dat" - } - -[ ... ] - - [11]=> - array(3) { - ["available"]=> - bool(false) - ["description"]=> - string(25) "GeoIP Domain Name Edition" - ["filename"]=> - string(38) "/usr/share/GeoIP/GeoIPDomain.dat" - } -} -]]> - - - - - Exemple avec <function>geoip_db_get_all_info</function> - - Il est possible d'utiliser diverses constantes comme clés, pour récupérer uniquement - des parties d'informations. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-domain-by-name.xml b/reference/geoip/functions/geoip-domain-by-name.xml deleted file mode 100644 index 1ac6ba9021..0000000000 --- a/reference/geoip/functions/geoip-domain-by-name.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - geoip_domain_by_name - Récupère le second niveau du nom de domaine - - - &reftitle.description; - - stringgeoip_domain_by_name - stringhostname - - - - La fonction geoip_domain_by_name va retourner le - second niveau du domaine associé avec un nom d'hôte ou l'adresse IP. - - - Cette fonction n'est actuellement disponible que pour les utilisateurs qui - ont acheté une édition commerciale GeoIP Domain. Une alerte sera émise - si la bonne base de données ne peut être trouvée. - - - - - &reftitle.parameters; - - - hostname - - - Le nom d'hôte ou l'adresse IP. - - - - - - - &reftitle.returnvalues; - - Retourne le nom de domaine en cas de succès, ou &false; si l'adresse - ne peut être trouvée dans la base de données. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_domain_by_name</function> - - Cet exemple va afficher le domaine associé avec l'IP 61.106.139.1. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-id-by-name.xml b/reference/geoip/functions/geoip-id-by-name.xml deleted file mode 100644 index 9387ad368f..0000000000 --- a/reference/geoip/functions/geoip-id-by-name.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - geoip_id_by_name - Récupère le type de la connexion Internet - - - &reftitle.description; - - intgeoip_id_by_name - stringhostname - - - - La fonction geoip_id_by_name - retourne le type de connexion internet correspondant au nom de l'hôte ou - à l'adresse IP. - - - La valeur retournée est de type numérique et peut être comparée aux - constantes suivantes : - - - - - GEOIP_UNKNOWN_SPEED - - - - - GEOIP_DIALUP_SPEED - - - - - GEOIP_CABLEDSL_SPEED - - - - - GEOIP_CORPORATE_SPEED - - - - - - - &reftitle.parameters; - - - hostname - - - Le nom d'hôte ou l'adresse IP dont le type de connexion doit être examiné. - - - - - - - &reftitle.returnvalues; - - Retourne le type de connexion. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_id_by_name</function> - - Cet exemple affiche le type de connexion de l'hôte example.com. - - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/geoip/functions/geoip-isp-by-name.xml b/reference/geoip/functions/geoip-isp-by-name.xml deleted file mode 100644 index 43d343e43e..0000000000 --- a/reference/geoip/functions/geoip-isp-by-name.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - geoip_isp_by_name - Récupère le nom du fournisseur d'accès - - - &reftitle.description; - - stringgeoip_isp_by_name - stringhostname - - - - La fonction geoip_isp_by_name retourne le nom - de l'ISP dont l'IP est assignée. - - - Cette fonction est actuellement uniquement disponible aux utilisateurs qui ont - acheté une édition commerciale de GeoIP ISP. Un avertissement sera émis - si la base de données ne peut être localisée. - - - - - &reftitle.parameters; - - - hostname - - - Le nom d'hôte ou l'adresse IP. - - - - - - - &reftitle.returnvalues; - - Retourne le nom ISP en cas de succès, ou &false; si l'adresse - n'a pu être trouvée dans la base de données. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_isp_by_name</function> - - Ceci affichera le nom ISP pour l'hôte example.com. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-netspeedcell-by-name.xml b/reference/geoip/functions/geoip-netspeedcell-by-name.xml deleted file mode 100644 index fe6bbb9631..0000000000 --- a/reference/geoip/functions/geoip-netspeedcell-by-name.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - geoip_netspeedcell_by_name - Récupère la vitesse de la connexion Internet - - - &reftitle.description; - - stringgeoip_netspeedcell_by_name - stringhostname - - - - La fonction geoip_netspeedcell_by_name va retourner - le type de connexion Internet ainsi que sa vitesse, suivant un - nom d'hôte ou une adresse IP. - - - Cette fonction n'est disponible que lors de l'utilisation de la version - 1.4.8 de la bibliothèque GeoIP, ou supérieures. - - - Cette fonction est actuellement uniquement disponible pour les utilisateurs - qui ont acheté une édition commerciale GeoIP NetSpeedCell. Une alerte - sera émise si la bonne base de données ne peut être trouvée. - - - La valeur retournée sera une chaîne de caractères dont les valeurs communes sont : - - - - - Cable/DSL - - - - - Dialup - - - - - Cellular - - - - - Corporate - - - - - - - &reftitle.parameters; - - - hostname - - - Le nom d'hôte, ou l'adresse IP. - - - - - - - &reftitle.returnvalues; - - Retourne la vitesse de la connexion en cas de succès, ou &false; si - l'adresse ne peut être trouvée dans la base de données. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_netspeedcell_by_name</function> - - Cet exemple va afficher la vitesse de la connexion de l'hôte example.com. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-org-by-name.xml b/reference/geoip/functions/geoip-org-by-name.xml deleted file mode 100644 index 2001f8975a..0000000000 --- a/reference/geoip/functions/geoip-org-by-name.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - geoip_org_by_name - Récupère le nom de l'organisation - - - &reftitle.description; - - stringgeoip_org_by_name - stringhostname - - - - La fonction geoip_org_by_name retourne - le nom de l'organisation à laquelle l'adresse IP est assignée. - - - Cette fonction est actuellement uniquement disponible aux utilisateurs - qui ont acheté une licence commerciale GeoIP Organization, - ISP ou AS Edition. - Une alerte sera émise si la base de données ne peut pas être trouvée. - - - - &reftitle.parameters; - - - hostname - - - Le nom de l'hôte ou l'adresse IP - - - - - - - &reftitle.returnvalues; - - Retourne le nom de l'organisation en cas de succès, ou &false; - si l'adresse n'a pu être trouvée dans la base de données. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_org_by_name</function> - - Cet exemple affiche le nom de l'organisation pour l'hôte example.com. - - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/geoip/functions/geoip-record-by-name.xml b/reference/geoip/functions/geoip-record-by-name.xml deleted file mode 100644 index 594450f191..0000000000 --- a/reference/geoip/functions/geoip-record-by-name.xml +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - geoip_record_by_name - Récupère les informations enregistrées correspondant au nom de l'hôte ou à l'adresse IP, trouvées dans la base de données GeoIP - - - &reftitle.description; - - arraygeoip_record_by_name - stringhostname - - - - La fonction geoip_record_by_name retourne - les informations enregistrées correspondant au nom de l'hôte ou - à l'adresse IP. - - - Cette fonction est disponible pour les bases de données GeoLite City Edition et - la version commerciale GeoIP City Edition. - Une alerte sera émise si la base de données n'a pu être trouvée. - - - Les noms des différentes clés du tableau associatif retourné sont les suivants : - - - - - "continent_code" : Code du continent sur 2 lettres (disponible depuis - la version 1.0.4 avec libgeoip 1.4.3 ou supérieure) - - - - - "country_code" : Les deux lettres du code pays (Voir - geoip_country_code_by_name) - - - - - "country_code3" : Code pays sur 3 lettres (Voir la fonction - geoip_country_code3_by_name) - - - - - "country_name" : Nom du pays (Voir la fonction - geoip_country_name_by_name) - - - - - "region" : Le code région (ex: CA pour California) - - - - - "city" : La ville. - - - - - "postal_code" : Le code postal, FSA ou Zip. - - - - - "latitude" : La latitude en tant que float signé. - - - - - "longitude" : La longitude en tant que float signé. - - - - - "dma_code" : Code de la zone de marché (Uniquement pour les USA - et le Canada) - - - - - "area_code" : Le code PSTN (ex : 212) - - - - - - - &reftitle.parameters; - - - hostname - - - Le nom de l'hôte ou l'adresse IP - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif en cas de succès, ou &false; si l'adresse - n'a pu être trouvée dans la base de données. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL geoip 1.0.4 - - Ajout de continent_code avec la bibliothèque GeoIP 1.4.3 ou supérieure uniquement - - - - PECL geoip 1.0.3 - - Ajout de country_code3 et de country_name - - - - - - - - - &reftitle.examples; - - Exemple avec <function>geoip_record_by_name</function> - - Cet exemple affiche le tableau contenant l'enregistrement de l'hôte - example.com. - - - -]]> - - &example.outputs; - - NA - [country_code] => US - [country_code3] => USA - [country_name] => United States - [region] => CA - [city] => Marina Del Rey - [postal_code] => - [latitude] => 33.9776992798 - [longitude] => -118.435096741 - [dma_code] => 803 - [area_code] => 310 -) -]]> - - - - - diff --git a/reference/geoip/functions/geoip-region-by-name.xml b/reference/geoip/functions/geoip-region-by-name.xml deleted file mode 100644 index 1d315dbb50..0000000000 --- a/reference/geoip/functions/geoip-region-by-name.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - geoip_region_by_name - Récupère le code pays et la région - - - &reftitle.description; - - arraygeoip_region_by_name - stringhostname - - - - La fonction geoip_region_by_name retourne - le pays et la région correspondant au nom de l'hôte ou à l'adresse IP. - - - Cette fonction est actuellement uniquement disponible pour les utilisateurs - qui ont acheté une licence commerciale GeoIP Region Edition. Une alerte - sera émise si la base de données n'a pu être trouvée. - - - Les noms des différentes clés du tableau retourné sont les suivants : - - - - - "country_code" : Les deux lettres du code pays (Voir la fonction - geoip_country_code_by_name) - - - - - "region" : Le code région (ex: CA pour California) - - - - - - &reftitle.parameters; - - - hostname - - - Le nom de l'hôte ou l'adresse IP - - - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif en cas de succès, ou &false; si l'adresse - n'a pu être trouvée dans la base de données. - - - - - &reftitle.examples; - - Exemple avec <function>geoip_region_by_name</function> - - Cet exemple affiche le tableau contenant le code pays et la région - de l'hôte example.com. - - - -]]> - - &example.outputs; - - US - [region] => CA -) -]]> - - - - - diff --git a/reference/geoip/functions/geoip-region-name-by-code.xml b/reference/geoip/functions/geoip-region-name-by-code.xml deleted file mode 100644 index 4190454944..0000000000 --- a/reference/geoip/functions/geoip-region-name-by-code.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - geoip_region_name_by_code - Retourne le nom de la région pour un pays et un code de région - - - &reftitle.description; - - stringgeoip_region_name_by_code - stringcountry_code - stringregion_code - - - - geoip_region_name_by_code retourne le nom de la région correspondant - à un couple pays et région. - - - Aux États-Unis d'Amérique, la région correspond à l'abréviation en deux lettres de - l'état. Au Canada, cette région correspond à l'abréviation de la province ou du - territoire, tel qu'attribué par Poste Canada. - - - Pour le reste du monde, GeoIP utilise les codes FIPS 10-4 pour représenter les régions. - Il est possible de vérifier le site &url.maxmind.fips; - pour une liste détaillée des codes FIPS 10-4. - - - Cette fonction est toujours disponible, si l'on utilise GeoIP Library version 1.4.1 ou plus - récent. Les données sont issues directement de GeoIP Library et non pas d'une table de référence. - - - - &reftitle.parameters; - - - country_code - - - Le code de pays, en deux lettres (voir - geoip_country_code_by_name) - - - - - region_code - - - Le code de région en deux lettres (voir - geoip_region_by_name) - - - - - - - &reftitle.returnvalues; - - Retourne le nom de la région en cas de succès, ou &false; si le pays, la région ou la combinaison - des deux n'a pas pu être trouvée. - - - - - &reftitle.examples; - - - Exemple avec <function>geoip_region_name_by_code</function> pour les USA et le Canada - - Ce script va afficher le nom de la région pour la région QC au CA. - - - -]]> - - &example.outputs; - - - - - - Exemple avec <function>geoip_region_name_by_code</function> en utilisant les codes FIPS - - Ce script va afficher le nom de la région pour la région 01 au JP (Japon). - - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/geoip/functions/geoip-setup-custom-directory.xml b/reference/geoip/functions/geoip-setup-custom-directory.xml deleted file mode 100644 index 9e1596b124..0000000000 --- a/reference/geoip/functions/geoip-setup-custom-directory.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - geoip_setup_custom_directory - Définit un dossier personnalisé pour la base de données GeoIP - - - &reftitle.description; - - voidgeoip_setup_custom_directory - stringpath - - - - La fonction geoip_setup_custom_directory - va modifier le dossier par défaut de la base de données GeoIP. - Ceci est équivalent à modifier l'option de configuration - geoip.custom_directory. - - - - - &reftitle.parameters; - - - path - - - Le chemin complet où se trouve la base de données GeoIP sur le disque. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple avec <function>geoip_setup_custom_directory</function> - - Cet exemple va modifier le chemin par défaut vers la base de données GeoIP. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-time-zone-by-country-and-region.xml b/reference/geoip/functions/geoip-time-zone-by-country-and-region.xml deleted file mode 100644 index b5bdf4f674..0000000000 --- a/reference/geoip/functions/geoip-time-zone-by-country-and-region.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - geoip_time_zone_by_country_and_region - Retourne le fuseau horaire de certains pays et région du globe - - - &reftitle.description; - - stringgeoip_time_zone_by_country_and_region - stringcountry_code - stringregion_code - - - - geoip_time_zone_by_country_and_region retourne le fuseau horaire - correspondant à un pays et une région. - - - Aux États-Unis d'Amérique, la région correspond à l'abréviation en deux lettres de - l'état. Au Canada, cette région correspond à l'abréviation de la province ou du - territoire, tel qu'attribué par Poste Canada. - - - Pour le reste du monde, GeoIP utilise les codes FIPS 10-4 pour représenter les régions. - Il est possible de vérifier le site &url.maxmind.fips; - pour une liste détaillée des codes FIPS 10-4. - - - Cette fonction est toujours disponible, si l'on utilise GeoIP Library - version 1.4.1 ou plus récent. Les données sont issues directement de GeoIP - Library et non pas d'une table de référence. - - - - &reftitle.parameters; - - - country_code - - - Le code de pays, en deux lettres (voir - geoip_country_code_by_name) - - - - - region_code - - - Le code de région en deux lettres (voir - geoip_region_by_name) - - - - - - - &reftitle.returnvalues; - - Retourne le fuseau horaire en cas de succès, et &false; si le pays, - la région ou la combinaison des deux n'a pas pu être trouvée. - - - - - &reftitle.examples; - - - Exemple avec <function>geoip_time_zone_by_country_and_region</function> pour les USA et Canada - - Ce script va afficher le fuseau horaire pour le Québec, au Canada. - - - -]]> - - &example.outputs; - - - - - - Exemple avec <function>geoip_time_zone_by_country_and_region</function> et les codes FIPS - - Ce script va afficher le fuseau horaire du Japon, région 01 (Aichi). - - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/geoip/ini.xml b/reference/geoip/ini.xml deleted file mode 100644 index 481a3206c0..0000000000 --- a/reference/geoip/ini.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - -
- &reftitle.runtime; - &extension.runtime; - - GeoIP &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - geoip.custom_directory - "" - INI_ALL - - - - -
- - &ini.descriptions.title; - - - - - geoip.custom_directory - string - - - - Vide par défaut, mais peut être utilisé pour charger une base - de données différente de celle incluse dans la bibliothèque. - - - - -
diff --git a/reference/geoip/reference.xml b/reference/geoip/reference.xml deleted file mode 100644 index a003a452de..0000000000 --- a/reference/geoip/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - &Functions; GeoIP - &reference.geoip.entities.functions; - - - diff --git a/reference/geoip/setup.xml b/reference/geoip/setup.xml deleted file mode 100644 index 6052f87d8f..0000000000 --- a/reference/geoip/setup.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - &reftitle.setup; - -
- &reftitle.required; - - Cette extension nécessite la bibliothèque GeoIP version 1.4.0 ou suivant. - Il est possible de récupérer la dernière version sur - &url.maxmind.geoip; - et la compiler soi-même. - - - Par défaut, il n'est possible que d'accéder à la base de données - Free GeoIP Country ou GeoLite - City. Bien que ce module puisse fonctionner avec d'autres types - de bases de données, il faut acheter une licence commerciale sur - Maxmind. - -
- -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;geoip. - -
- - &reference.geoip.ini; - - - diff --git a/reference/gmagick/book.xml b/reference/gmagick/book.xml deleted file mode 100644 index 7c89e296ad..0000000000 --- a/reference/gmagick/book.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Gmagick - Gmagick - - - &reftitle.intro; - &warn.experimental; - - Gmagick est une extension PHP pour créer, modifier et obtenir des informations méta sur des - images en utilisant l'API GraphicsMagick. - - - GraphicsMagick s'enorgueillit d'être le couteau suisse du traitement de l'image. - Il fonctionne avec quelque 88 formats majeurs, incluant des formats importants comme - DPX, GIF, JPEG, JPEG-2000, PNG, PDF, PNM, et TIFF. - - - Gmagick est composé d'une classe principale Gmagick, d'une classe GmagickDraw qui - s'occupe du dessin et d'une classe GmagickPixel dont les instances représentent un - seul pixel d'une image (couleur, opacité). - - - - &reference.gmagick.setup; - &reference.gmagick.constants; - &reference.gmagick.examples; - &reference.gmagick.gmagick; - &reference.gmagick.gmagickdraw; - &reference.gmagick.gmagickpixel; - &reference.gmagick.gmagickexception; - &reference.gmagick.gmagickpixelexception; - - diff --git a/reference/gmagick/constants.xml b/reference/gmagick/constants.xml deleted file mode 100644 index 9d3468f560..0000000000 --- a/reference/gmagick/constants.xml +++ /dev/null @@ -1,3139 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Constantes relatives aux types de couleur - - - Gmagick::COLOR_BLACK - (int) - - - - Noir - - - - - - Gmagick::COLOR_BLUE - (int) - - - - Bleu - - - - - - Gmagick::COLOR_CYAN - (int) - - - - Cyan - - - - - - Gmagick::COLOR_GREEN - (int) - - - - Vert - - - - - - Gmagick::COLOR_RED - (int) - - - - Rouge - - - - - - Gmagick::COLOR_YELLOW - (int) - - - - Jaune - - - - - - Gmagick::COLOR_MAGENTA - (int) - - - - Magenta - - - - - - Gmagick::COLOR_OPACITY - (int) - - - - Opacité - - - - - - Gmagick::COLOR_ALPHA - (int) - - - - Alpha - - - - - - Gmagick::COLOR_FUZZ - (int) - - - - Fuzz - - - - - - Constantes relatives aux opérateurs composite - - - Gmagick::COMPOSITE_DEFAULT - (int) - - - - L'opérateur composite par défaut - - - - - - Gmagick::COMPOSITE_UNDEFINED - (int) - - - - Opérateur composite indéfini - - - - - - Gmagick::COMPOSITE_NO - (int) - - - - Aucun opérateur composite de défini - - - - - - Gmagick::COMPOSITE_ADD - (int) - - - - Le résultat d'une image + une image - - - - - - Gmagick::COMPOSITE_ATOP - (int) - - - - Le résultat est la même forme qu'une image ; là où l'image composite - obscurcie l'image, l'image de la forme la superpose. - - - - - - Gmagick::COMPOSITE_BLEND - (int) - - - - Mélange l'image - - - - - - Gmagick::COMPOSITE_BUMPMAP - (int) - - - - Identique à COMPOSITE_MULTIPLY, mis à part que la source - est convertie d'abord en niveaux de gris. - - - - - - Gmagick::COMPOSITE_CLEAR - (int) - - - - Rend la cible de l'image transparente - - - - - - Gmagick::COMPOSITE_COLORBURN - (int) - - - - Noircit l'image de destination pour refléter l'image source - - - - - - Gmagick::COMPOSITE_COLORDODGE - (int) - - - - Éclaircit l'image de destination pour refléter l'image source - - - - - - Gmagick::COMPOSITE_COLORIZE - (int) - - - - Colorise l'image cible en utilisant l'image composite - - - - - - Gmagick::COMPOSITE_COPYBLACK - (int) - - - - Copie les noirs depuis la source vers la cible - - - - - - Gmagick::COMPOSITE_COPYBLUE - (int) - - - - Copie les bleus depuis la source vers la cible - - - - - - Gmagick::COMPOSITE_COPY - (int) - - - - Copie l'image source sur l'image cible - - - - - - Gmagick::COMPOSITE_COPYCYAN - (int) - - - - Copie le cyan depuis la source vers la cible - - - - - - Gmagick::COMPOSITE_COPYGREEN - (int) - - - - Copie le vert depuis la source vers la cible - - - - - - Gmagick::COMPOSITE_COPYMAGENTA - (int) - - - - Copie le magenta depuis la source vers la cible - - - - - - Gmagick::COMPOSITE_COPYOPACITY - (int) - - - - Copie l'opacité depuis la source vers la cible - - - - - - Gmagick::COMPOSITE_COPYRED - (int) - - - - Copie le rouge depuis la source vers la cible - - - - - - Gmagick::COMPOSITE_COPYYELLOW - (int) - - - - Copie le jaune depuis la source vers la cible - - - - - - Gmagick::COMPOSITE_DARKEN - (int) - - - - Assombrit l'image cible - - - - - - Gmagick::COMPOSITE_DSTATOP - (int) - - - - La partie de la destination située à l'intérieur de la source - devient composite sur la source et remplace la destination - - - - - - Gmagick::COMPOSITE_DST - (int) - - - - La cible est conservée sans modification - - - - - - Gmagick::COMPOSITE_DSTIN - (int) - - - - La partie de la source remplace la cible - - - - - - Gmagick::COMPOSITE_DSTOUT - (int) - - - - La partie à l'extérieur de la source remplace la cible - - - - - - Gmagick::COMPOSITE_DSTOVER - (int) - - - - La cible remplace la source - - - - - - Gmagick::COMPOSITE_DIFFERENCE - (int) - - - - Soustrait la plus sombre des deux couleurs élémentaires depuis - la plus claire - - - - - - Gmagick::COMPOSITE_DISPLACE - (int) - - - - Décale les pixels de l'image cible tel que défini par la source - - - - - - Gmagick::COMPOSITE_DISSOLVE - (int) - - - - Dissous la source dans la cible - - - - - - Gmagick::COMPOSITE_EXCLUSION - (int) - - - - Produit un effet similaire à Gmagick::COMPOSITE_DIFFERENCE, - mais apparaît avec un contraste plus faible - - - - - - Gmagick::COMPOSITE_HARDLIGHT - (int) - - - - Multiplie ou superpose les couleurs, en fonction de la valeur de couleur de source - - - - - - Gmagick::COMPOSITE_HUE - (int) - - - - Modifie la teinte de la cible telle que définie par la source - - - - - - Gmagick::COMPOSITE_IN - (int) - - - - Effectue un composite de la source dans la cible - - - - - - Gmagick::COMPOSITE_LIGHTEN - (int) - - - - Éclaircit la cible telle que définie par la source - - - - - - Gmagick::COMPOSITE_LUMINIZE - (int) - - - - Illumine la cible telle que définie par la source - - - - - - Gmagick::COMPOSITE_MINUS - (int) - - - - Soustrait la source de la cible - - - - - - Gmagick::COMPOSITE_MODULATE - (int) - - - - Module la luminosité cible, la saturation et la teinte tel que défini - par la source - - - - - - Gmagick::COMPOSITE_MULTIPLY - (int) - - - - Multiplie la cible à la source - - - - - - Gmagick::COMPOSITE_OUT - (int) - - - - Effectue un composite des parties extérieures de la - source sur la cible - - - - - - Gmagick::COMPOSITE_OVER - (int) - - - - Effectue un composite par dessus la cible - - - - - - Gmagick::COMPOSITE_OVERLAY - (int) - - - - Superpose la source sur la cible - - - - - - Gmagick::COMPOSITE_PLUS - (int) - - - - Ajoute la source à la cible - - - - - - Gmagick::COMPOSITE_REPLACE - (int) - - - - Remplace la cible par la source - - - - - - Gmagick::COMPOSITE_SATURATE - (int) - - - - Sature la cible tel que défini par la source - - - - - - Gmagick::COMPOSITE_SCREEN - (int) - - - - La source et la destination sont complémentés, puis multipliés, puis - remplace la destination - - - - - - Gmagick::COMPOSITE_SOFTLIGHT - (int) - - - - Assombrit ou éclaire les couleurs, suivant la source - - - - - - Gmagick::COMPOSITE_SRCATOP - (int) - - - - La partie de la source se trouvant dans la destination est composée - sur la destination - - - - - - Gmagick::COMPOSITE_SRC - (int) - - - - La source est copiée vers la destination - - - - - - Gmagick::COMPOSITE_SRCIN - (int) - - - - La partie de la source se trouvant dans la destination remplace la destination - - - - - - Gmagick::COMPOSITE_SRCOUT - (int) - - - - La partie de la source se trouvant en dehors de la destination remplace la destination - - - - - - Gmagick::COMPOSITE_SRCOVER - (int) - - - - La source remplace la destination - - - - - - Gmagick::COMPOSITE_SUBTRACT - (int) - - - - Soustrait les couleurs de l'image source dans l'image de destination - - - - - - Gmagick::COMPOSITE_THRESHOLD - (int) - - - - La source est composée de la cible, telle que définie par la source - - - - - - Gmagick::COMPOSITE_XOR - (int) - - - - La partie de la source qui se trouve en dehors de la destination est - combinée avec la partie de la destination se trouvant en dehors de la source - - - - - - Constantes de mode Montage - - - Gmagick::MONTAGEMODE_FRAME - (int) - - - - - - - - - - Gmagick::MONTAGEMODE_UNFRAME - (int) - - - - - - - - - - Gmagick::MONTAGEMODE_CONCATENATE - (int) - - - - - - - - - - Constantes de style - - - Gmagick::STYLE_NORMAL - (int) - - - - - - - - - - Gmagick::STYLE_ITALIC - (int) - - - - - - - - - - Gmagick::STYLE_OBLIQUE - (int) - - - - - - - - - - Gmagick::STYLE_ANY - (int) - - - - - - - - - - Constantes de filtre - - - Gmagick::FILTER_UNDEFINED - (int) - - - - - - - - - - Gmagick::FILTER_POINT - (int) - - - - - - - - - - Gmagick::FILTER_BOX - (int) - - - - - - - - - - Gmagick::FILTER_TRIANGLE - (int) - - - - - - - - - - Gmagick::FILTER_HERMITE - (int) - - - - - - - - - - Gmagick::FILTER_HANNING - (int) - - - - - - - - - - Gmagick::FILTER_HAMMING - (int) - - - - - - - - - - Gmagick::FILTER_BLACKMAN - (int) - - - - - - - - - - Gmagick::FILTER_GAUSSIAN - (int) - - - - - - - - - - Gmagick::FILTER_QUADRATIC - (int) - - - - - - - - - - Gmagick::FILTER_CUBIC - (int) - - - - - - - - - - Gmagick::FILTER_CATROM - (int) - - - - - - - - - - Gmagick::FILTER_MITCHELL - (int) - - - - - - - - - - Gmagick::FILTER_LANCZOS - (int) - - - - - - - - - - Gmagick::FILTER_BESSEL - (int) - - - - - - - - - - Gmagick::FILTER_SINC - (int) - - - - - - - - - - Constantes de type d'image - - - Gmagick::IMGTYPE_UNDEFINED - (int) - - - - - - - - - - Gmagick::IMGTYPE_BILEVEL - (int) - - - - - - - - - - Gmagick::IMGTYPE_GRAYSCALE - (int) - - - - - - - - - - Gmagick::IMGTYPE_GRAYSCALEMATTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_PALETTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_PALETTEMATTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_TRUECOLOR - (int) - - - - - - - - - - Gmagick::IMGTYPE_TRUECOLORMATTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_COLORSEPARATION - (int) - - - - - - - - - - Gmagick::IMGTYPE_COLORSEPARATIONMATTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_OPTIMIZE - (int) - - - - - - - - - - Constantes de résolution - - - Gmagick::RESOLUTION_UNDEFINED - (int) - - - - - - - - - - Gmagick::RESOLUTION_PIXELSPERINCH - (int) - - - - - - - - - - Gmagick::RESOLUTION_PIXELSPERCENTIMETER - (int) - - - - - - - - - - Constantes de compression - - - Gmagick::COMPRESSION_UNDEFINED - (int) - - - - - - - - - - Gmagick::COMPRESSION_NO - (int) - - - - - - - - - - Gmagick::COMPRESSION_BZIP - (int) - - - - - - - - - - Gmagick::COMPRESSION_FAX - (int) - - - - - - - - - - Gmagick::COMPRESSION_GROUP4 - (int) - - - - - - - - - - Gmagick::COMPRESSION_JPEG - (int) - - - - - - - - - - Gmagick::COMPRESSION_JPEG2000 - (int) - - - - - - - - - - Gmagick::COMPRESSION_LOSSLESSJPEG - (int) - - - - - - - - - - Gmagick::COMPRESSION_LZW - (int) - - - - - - - - - - Gmagick::COMPRESSION_RLE - (int) - - - - - - - - - - Gmagick::COMPRESSION_ZIP - (int) - - - - - - - - - - Constantes de dessin - - - Gmagick::PAINT_POINT - (int) - - - - - - - - - - Gmagick::PAINT_REPLACE - (int) - - - - - - - - - - Gmagick::PAINT_FLOODFILL - (int) - - - - - - - - - - Gmagick::PAINT_FILLTOBORDER - (int) - - - - - - - - - - Gmagick::PAINT_RESET - (int) - - - - - - - - - - Constantes de gravité - - - Gmagick::GRAVITY_NORTHWEST - (int) - - - - - - - - - - Gmagick::GRAVITY_NORTH - (int) - - - - - - - - - - Gmagick::GRAVITY_NORTHEAST - (int) - - - - - - - - - - Gmagick::GRAVITY_WEST - (int) - - - - - - - - - - Gmagick::GRAVITY_CENTER - (int) - - - - - - - - - - Gmagick::GRAVITY_EAST - (int) - - - - - - - - - - Gmagick::GRAVITY_SOUTHWEST - (int) - - - - - - - - - - Gmagick::GRAVITY_SOUTH - (int) - - - - - - - - - - Gmagick::GRAVITY_SOUTHEAST - (int) - - - - - - - - - - Constantes d'étirement - - - Gmagick::STRETCH_NORMAL - (int) - - - - - - - - - - Gmagick::STRETCH_ULTRACONDENSED - (int) - - - - - - - - - - Gmagick::STRETCH_CONDENSED - (int) - - - - - - - - - - Gmagick::STRETCH_SEMICONDENSED - (int) - - - - - - - - - - Gmagick::STRETCH_SEMIEXPANDED - (int) - - - - - - - - - - Gmagick::STRETCH_EXPANDED - (int) - - - - - - - - - - Gmagick::STRETCH_EXTRAEXPANDED - (int) - - - - - - - - - - Gmagick::STRETCH_ULTRAEXPANDED - (int) - - - - - - - - - - Gmagick::STRETCH_ANY - (int) - - - - - - - - - - Constantes d'alignement - - - Gmagick::ALIGN_UNDEFINED - (int) - - - - - - - - - - Gmagick::ALIGN_LEFT - (int) - - - - - - - - - - Gmagick::ALIGN_CENTER - (int) - - - - - - - - - - Gmagick::ALIGN_RIGHT - (int) - - - - - - - - - - Constantes de décoration - - - Gmagick::DECORATION_NO - (int) - - - - - - - - - - Gmagick::DECORATION_UNDERLINE - (int) - - - - - - - - - - Gmagick::DECORATION_OVERLINE - (int) - - - - - - - - - - Gmagick::DECORATION_LINETROUGH - (int) - - - - - - - - - - Constantes de bruit - - - Gmagick::NOISE_UNIFORM - (int) - - - - - - - - - - Gmagick::NOISE_GAUSSIAN - (int) - - - - - - - - - - Gmagick::NOISE_MULTIPLICATIVEGAUSSIAN - (int) - - - - - - - - - - Gmagick::NOISE_IMPULSE - (int) - - - - - - - - - - Gmagick::NOISE_LAPLACIAN - (int) - - - - - - - - - - Gmagick::NOISE_POISSON - (int) - - - - - - - - - - Constantes de canal - - - Gmagick::CHANNEL_UNDEFINED - (int) - - - - - - - - - - Gmagick::CHANNEL_RED - (int) - - - - - - - - - - Gmagick::CHANNEL_GRAY - (int) - - - - - - - - - - Gmagick::CHANNEL_CYAN - (int) - - - - - - - - - - Gmagick::CHANNEL_GREEN - (int) - - - - - - - - - - Gmagick::CHANNEL_MAGENTA - (int) - - - - - - - - - - Gmagick::CHANNEL_BLUE - (int) - - - - - - - - - - Gmagick::CHANNEL_YELLOW - (int) - - - - - - - - - - Gmagick::CHANNEL_ALPHA - (int) - - - - - - - - - - Gmagick::CHANNEL_OPACITY - (int) - - - - - - - - - - Gmagick::CHANNEL_MATTE - (int) - - - - - - - - - - Gmagick::CHANNEL_BLACK - (int) - - - - - - - - - - Gmagick::CHANNEL_INDEX - (int) - - - - - - - - - - Gmagick::CHANNEL_ALL - (int) - - - - - - - - - - Constantes de mesure - - - Gmagick::METRIC_UNDEFINED - (int) - - - - - - - - - - Gmagick::METRIC_MEANABSOLUTEERROR - (int) - - - - - - - - - - Gmagick::METRIC_MEANSQUAREERROR - (int) - - - - - - - - - - Gmagick::METRIC_PEAKABSOLUTEERROR - (int) - - - - - - - - - - Gmagick::METRIC_PEAKSIGNALTONOISERATIO - (int) - - - - - - - - - - Gmagick::METRIC_ROOTMEANSQUAREDERROR - (int) - - - - - - - - - - Constantes de pixel - - - Gmagick::PIXEL_CHAR - (int) - - - - - - - - - - Gmagick::PIXEL_DOUBLE - (int) - - - - - - - - - - Gmagick::PIXEL_FLOAT - (int) - - - - - - - - - - Gmagick::PIXEL_INTEGER - (int) - - - - - - - - - - Gmagick::PIXEL_LONG - (int) - - - - - - - - - - Gmagick::PIXEL_QUANTUM - (int) - - - - - - - - - - Gmagick::PIXEL_SHORT - (int) - - - - - - - - - - Constantes d'espace de couleurs - - - Gmagick::COLORSPACE_UNDEFINED - (int) - - - - - - - - - - Gmagick::COLORSPACE_RGB - (int) - - - - - - - - - - Gmagick::COLORSPACE_GRAY - (int) - - - - - - - - - - Gmagick::COLORSPACE_TRANSPARENT - (int) - - - - - - - - - - Gmagick::COLORSPACE_OHTA - (int) - - - - - - - - - - Gmagick::COLORSPACE_LAB - (int) - - - - - - - - - - Gmagick::COLORSPACE_XYZ - (int) - - - - - - - - - - Gmagick::COLORSPACE_YCBCR - (int) - - - - - - - - - - Gmagick::COLORSPACE_YCC - (int) - - - - - - - - - - Gmagick::COLORSPACE_YIQ - (int) - - - - - - - - - - Gmagick::COLORSPACE_YPBPR - (int) - - - - - - - - - - Gmagick::COLORSPACE_YUV - (int) - - - - - - - - - - Gmagick::COLORSPACE_CMYK - (int) - - - - - - - - - - Gmagick::COLORSPACE_SRGB - (int) - - - - - - - - - - Gmagick::COLORSPACE_HSB - (int) - - - - - - - - - - Gmagick::COLORSPACE_HSL - (int) - - - - - - - - - - Gmagick::COLORSPACE_HWB - (int) - - - - - - - - - - Gmagick::COLORSPACE_REC601LUMA - (int) - - - - - - - - - - Gmagick::COLORSPACE_REC709LUMA - (int) - - - - - - - - - - Gmagick::COLORSPACE_LOG - (int) - - - - - - - - - - Constantes de méthode pour les pixels virtuels - - - Gmagick::VIRTUALPIXELMETHOD_UNDEFINED - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_BACKGROUND - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_CONSTANT - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_EDGE - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_MIRROR - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_TILE - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_TRANSPARENT - (int) - - - - - - - - - - Constantes de prévisualisation - - - Gmagick::PREVIEW_UNDEFINED - (int) - - - - - - - - - - Gmagick::PREVIEW_ROTATE - (int) - - - - - - - - - - Gmagick::PREVIEW_SHEAR - (int) - - - - - - - - - - Gmagick::PREVIEW_ROLL - (int) - - - - - - - - - - Gmagick::PREVIEW_HUE - (int) - - - - - - - - - - Gmagick::PREVIEW_SATURATION - (int) - - - - - - - - - - Gmagick::PREVIEW_BRIGHTNESS - (int) - - - - - - - - - - Gmagick::PREVIEW_GAMMA - (int) - - - - - - - - - - Gmagick::PREVIEW_SPIFF - (int) - - - - - - - - - - Gmagick::PREVIEW_DULL - (int) - - - - - - - - - - Gmagick::PREVIEW_GRAYSCALE - (int) - - - - - - - - - - Gmagick::PREVIEW_QUANTIZE - (int) - - - - - - - - - - Gmagick::PREVIEW_DESPECKLE - (int) - - - - - - - - - - Gmagick::PREVIEW_REDUCENOISE - (int) - - - - - - - - - - Gmagick::PREVIEW_ADDNOISE - (int) - - - - - - - - - - Gmagick::PREVIEW_SHARPEN - (int) - - - - - - - - - - Gmagick::PREVIEW_BLUR - (int) - - - - - - - - - - Gmagick::PREVIEW_THRESHOLD - (int) - - - - - - - - - - Gmagick::PREVIEW_EDGEDETECT - (int) - - - - - - - - - - Gmagick::PREVIEW_SPREAD - (int) - - - - - - - - - - Gmagick::PREVIEW_SOLARIZE - (int) - - - - - - - - - - Gmagick::PREVIEW_SHADE - (int) - - - - - - - - - - Gmagick::PREVIEW_RAISE - (int) - - - - - - - - - - Gmagick::PREVIEW_SEGMENT - (int) - - - - - - - - - - Gmagick::PREVIEW_SWIRL - (int) - - - - - - - - - - Gmagick::PREVIEW_IMPLODE - (int) - - - - - - - - - - Gmagick::PREVIEW_WAVE - (int) - - - - - - - - - - Gmagick::PREVIEW_OILPAINT - (int) - - - - - - - - - - Gmagick::PREVIEW_CHARCOALDRAWING - (int) - - - - - - - - - - Gmagick::PREVIEW_JPEG - (int) - - - - - - - - - - Constantes de rendu - - - Gmagick::RENDERINGINTENT_UNDEFINED - (int) - - - - - - - - - - Gmagick::RENDERINGINTENT_SATURATION - (int) - - - - - - - - - - Gmagick::RENDERINGINTENT_PERCEPTUAL - (int) - - - - - - - - - - Gmagick::RENDERINGINTENT_ABSOLUTE - (int) - - - - - - - - - - Gmagick::RENDERINGINTENT_RELATIVE - (int) - - - - - - - - - - Constantes de règle de remplissage - - - Gmagick::FILLRULE_UNDEFINED - (int) - - - - - - - - - - Gmagick::FILLRULE_EVENODD - (int) - - - - - - - - - - Gmagick::FILLRULE_NONZERO - (int) - - - - - - - - - - Constantes Pathunit - - - Gmagick::PATHUNITS_UNDEFINED - (int) - - - - - - - - - - Gmagick::PATHUNITS_USERSPACE - (int) - - - - - - - - - - Gmagick::PATHUNITS_USERSPACEONUSE - (int) - - - - - - - - - - Gmagick::PATHUNITS_OBJECTBOUNDINGBOX - (int) - - - - - - - - - - Constantes Linecap - - - Gmagick::LINECAP_UNDEFINED - (int) - - - - - - - - - - Gmagick::LINECAP_BUTT - (int) - - - - - - - - - - Gmagick::LINECAP_ROUND - (int) - - - - - - - - - - Gmagick::LINECAP_SQUARE - (int) - - - - - - - - - - Constantes de jointure de lignes - - - Gmagick::LINEJOIN_UNDEFINED - (int) - - - - - - - - - - Gmagick::LINEJOIN_MITER - (int) - - - - - - - - - - Gmagick::LINEJOIN_ROUND - (int) - - - - - - - - - - Gmagick::LINEJOIN_BEVEL - (int) - - - - - - - - - - Constantes de type de ressources - - - Gmagick::RESOURCETYPE_UNDEFINED - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_AREA - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_DISK - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_FILE - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_MAP - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_MEMORY - (int) - - - - - - - - - - Constantes d'orientation - - - Gmagick::ORIENTATION_UNDEFINED - (int) - - - - - - - - - - Gmagick::ORIENTATION_TOPLEFT - (int) - - - - - - - - - - Gmagick::ORIENTATION_TOPRIGHT - (int) - - - - - - - - - - Gmagick::ORIENTATION_BOTTOMRIGHT - (int) - - - - - - - - - - Gmagick::ORIENTATION_BOTTOMLEFT - (int) - - - - - - - - - - Gmagick::ORIENTATION_LEFTTOP - (int) - - - - - - - - - - Gmagick::ORIENTATION_RIGHTTOP - (int) - - - - - - - - - - Gmagick::ORIENTATION_RIGHTBOTTOM - (int) - - - - - - - - - - Gmagick::ORIENTATION_LEFTBOTTOM - (int) - - - - - - - - - - Constantes d'entrelacement - - - Gmagick::INTERLACE_UNDEFINED - (int) - - - - - - - - - - Gmagick::INTERLACE_NO - (int) - - - - - - - - - - Gmagick::INTERLACE_NONE - (int) - - - - - - - - - - Gmagick::INTERLACE_LINE - (int) - - - - - - - - - - Gmagick::INTERLACE_PLANE - (int) - - - - - - - - - - Gmagick::INTERLACE_PARTITION - (int) - - - - - - - - - - - - diff --git a/reference/gmagick/examples.xml b/reference/gmagick/examples.xml deleted file mode 100644 index f847530758..0000000000 --- a/reference/gmagick/examples.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - &reftitle.examples; - - Ce qui suit montre quelques opérations communes avec Gmagick. - - - Exemple Gmagick - -thumbnailimage(100, 0); - -// Crée une bordure autour de l'image, puis, simule la façon dont sera rendue l'image -// après un rendu à la peinture à l'huile. -// Notez le chaînage des méthodes supporté par Gmagick -$image->borderimage("yellow", 8, 8)->oilpaintimage(0.3); - -// Ecrit l'image courante dans un fichier -$image->write('example_thumbnail.jpg'); -?> -]]> - - - - diff --git a/reference/gmagick/gmagick.xml b/reference/gmagick/gmagick.xml deleted file mode 100644 index 80b712a47e..0000000000 --- a/reference/gmagick/gmagick.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - La classe Gmagick - Gmagick - - - - -
- &reftitle.intro; - - -
- - -
- &reftitle.classsynopsis; - - - - Gmagick - - - - - Gmagick - - - - &Methods; - - - - - - - - - -
- - - &reference.gmagick.entities.gmagick; - - - diff --git a/reference/gmagick/gmagick/addimage.xml b/reference/gmagick/gmagick/addimage.xml deleted file mode 100644 index 7a915764a7..0000000000 --- a/reference/gmagick/gmagick/addimage.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::addimage - Ajoute une nouvelle image à la liste des images de l'objet Gmagick - - - - &reftitle.description; - - public GmagickGmagick::addimage - Gmagicksource - - - Ajoute une nouvelle image à l'objet Gmagick depuis la position - courante de l'objet source. Après l'opération, l'itérateur de position - est déplacé à la fin de la liste. - - - - - &reftitle.parameters; - - - source - - - L'objet Gmagick source - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick contenant la nouvelle image chargée. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/addnoiseimage.xml b/reference/gmagick/gmagick/addnoiseimage.xml deleted file mode 100644 index fbc4c15370..0000000000 --- a/reference/gmagick/gmagick/addnoiseimage.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::addnoiseimage - Ajoute du bruit aléatoirement dans l'image - - - - &reftitle.description; - - public GmagickGmagick::addnoiseimage - intnoise_type - - - Ajoute du bruit aléatoirement dans l'image. - - - - - &reftitle.parameters; - - - noise_type - - - Le type de bruit. Se reporter à la liste des - constantes relatives au bruit. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick dont le bruit a été ajouté. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/annotateimage.xml b/reference/gmagick/gmagick/annotateimage.xml deleted file mode 100644 index d34aec8083..0000000000 --- a/reference/gmagick/gmagick/annotateimage.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - Gmagick::annotateimage - Annote une image avec du texte - - - - &reftitle.description; - - public GmagickGmagick::annotateimage - GmagickDrawGmagickDraw - floatx - floaty - floatangle - stringtext - - - Annote une image avec du texte. - - - - - &reftitle.parameters; - - - GmagickDraw - - - L'objet GmagickDraw contenant la configuration afin de dessiner le texte. - - - - - x - - - Position horizontale, en pixels, du bord gauche du texte. - - - - - y - - - Position verticale, en pixels, du bas du texte. - - - - - angle - - - L'angle utilisé pour écrire le texte. - - - - - text - - - Le texte à dessiner. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick contenant l'annotation. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/blurimage.xml b/reference/gmagick/gmagick/blurimage.xml deleted file mode 100644 index f46e8794c8..0000000000 --- a/reference/gmagick/gmagick/blurimage.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::blurimage - Ajoute un filtre flou à l'image - - - - &reftitle.description; - - public GmagickGmagick::blurimage - floatradius - floatsigma - intchannel - - - Ajoute un filtre flou à l'image. - - - - - &reftitle.parameters; - - - radius - - - Rayon utilisé pour le flou - - - - - sigma - - - Déviation standard - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick flouté. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/borderimage.xml b/reference/gmagick/gmagick/borderimage.xml deleted file mode 100644 index cedbd6d030..0000000000 --- a/reference/gmagick/gmagick/borderimage.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - Gmagick::borderimage - Ajoute une bordure à l'image - - - - &reftitle.description; - - public GmagickGmagick::borderimage - GmagickPixelcolor - intwidth - intheight - - - Ajoute une bordure à l'image dont la couleur sera définie par l'objet - GmagickPixel ou une couleur sous forme de &string;. - - - - - &reftitle.parameters; - - - color - - - Objet GmagickPixel ou une &string; contenant la couleur de la bordure. - - - - - width - - - Épaisseur de la bordure. - - - - - height - - - Hauteur de la bordure. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick dont la bordure a été ajoutée - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/charcoalimage.xml b/reference/gmagick/gmagick/charcoalimage.xml deleted file mode 100644 index 03991c817a..0000000000 --- a/reference/gmagick/gmagick/charcoalimage.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::charcoalimage - Simule un dessin au fusain - - - - &reftitle.description; - - public GmagickGmagick::charcoalimage - floatradius - floatsigma - - - Simule un dessin au fusain. - - - - - &reftitle.parameters; - - - radius - - - Le rayon du Gaussien, en pixels, sans compter le pixel central. - - - - - sigma - - - La déviation standard du Gaussien, en pixels. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick contenant la simulation du dessin au fusain. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/chopimage.xml b/reference/gmagick/gmagick/chopimage.xml deleted file mode 100644 index 7a98fdcd48..0000000000 --- a/reference/gmagick/gmagick/chopimage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - Gmagick::chopimage - Supprime une région de l'image - - - - &reftitle.description; - - public GmagickGmagick::chopimage - intwidth - intheight - intx - inty - - - Supprime une région de l'image et la repositionne afin d'occuper la portion effacée. - - - - - &reftitle.parameters; - - - width - - - Longueur de la région à supprimer. - - - - - height - - - Hauteur de la région à supprimer. - - - - - x - - - Origine en X de la région à supprimer. - - - - - y - - - Origine en Y de la région à supprimer. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick dont la région a été supprimée. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/clear.xml b/reference/gmagick/gmagick/clear.xml deleted file mode 100644 index c871662376..0000000000 --- a/reference/gmagick/gmagick/clear.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::clear - Efface toutes les ressources associées à l'objet Gmagick - - - - &reftitle.description; - - public GmagickGmagick::clear - - - - Efface toutes les ressources associées à l'objet Gmagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Gmagick nettoyé. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/commentimage.xml b/reference/gmagick/gmagick/commentimage.xml deleted file mode 100644 index dd349b8641..0000000000 --- a/reference/gmagick/gmagick/commentimage.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::commentimage - Ajoute un commentaire à l'image - - - - &reftitle.description; - - public GmagickGmagick::commentimage - stringcomment - - - Ajoute un commentaire à l'image. - - - - - &reftitle.parameters; - - - comment - - - Le commentaire à ajouter. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick contenant le commentaire. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/compositeimage.xml b/reference/gmagick/gmagick/compositeimage.xml deleted file mode 100644 index b7e10dcb72..0000000000 --- a/reference/gmagick/gmagick/compositeimage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - Gmagick::compositeimage - Assemble 2 images - - - - &reftitle.description; - - public GmagickGmagick::compositeimage - Gmagicksource - intCOMPOSE - intx - inty - - - Assemble 2 images à une position spécifique. - - - - - &reftitle.parameters; - - - source - - - L'objet Gmagick qui contient l'image à assembler. - - - - - COMPOSE - - - L'opérateur d'assemblage. - - - - - x - - - La position de la colonne de l'image assemblée. - - - - - y - - - La position de la ligne de l'image assemblée. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick contenant l'assemblage. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/construct.xml b/reference/gmagick/gmagick/construct.xml deleted file mode 100644 index 799cd937da..0000000000 --- a/reference/gmagick/gmagick/construct.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - Gmagick::__construct - Le constructeur Gmagick - - - - &reftitle.description; - - public Gmagick::__construct - stringfilename - - - Le constructeur Gmagick. - - - - - - &reftitle.parameters; - - - filename - - - Le chemin vers une image à charger ou un tableau de chemins. - - - - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/cropimage.xml b/reference/gmagick/gmagick/cropimage.xml deleted file mode 100644 index 2186f565f3..0000000000 --- a/reference/gmagick/gmagick/cropimage.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Gmagick::cropimage - Extrait une portion d'une image - - - - &reftitle.description; - - public GmagickGmagick::cropimage - - int - width - - - int - height - - intx - inty - - - Extrait une portion de l'image. - - - - - - - &reftitle.parameters; - - - - - width - - - - La longueur de la portion. - - - - - - height - - - - La hauteur de la région. - - - - - x - - - La coordonnée en X de la portion à extraire, en commençant par le coin en haut, à gauche. - - - - - y - - - La coordonnée en Y de la portion à extraire, en commençant par le coin en haut, à gauche. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick représentant la portion extraite. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/cropthumbnailimage.xml b/reference/gmagick/gmagick/cropthumbnailimage.xml deleted file mode 100644 index 9c21ddccc0..0000000000 --- a/reference/gmagick/gmagick/cropthumbnailimage.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Gmagick::cropthumbnailimage - Crée une miniature recadrée - - - - &reftitle.description; - - public GmagickGmagick::cropthumbnailimage - intwidth - intheight - - - Crée une miniature de taille fixe en commençant par une mise à l'échelle - de l'image, puis, en recadrant la région spécifique depuis le centre. - - - - - &reftitle.parameters; - - - width - - - La longueur de la miniature. - - - - - height - - - La hauteur de la miniature. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick recadré. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/current.xml b/reference/gmagick/gmagick/current.xml deleted file mode 100644 index 191b828e8c..0000000000 --- a/reference/gmagick/gmagick/current.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::current - Le contexte courant - - - - &reftitle.description; - - public GmagickGmagick::current - - - - Retourne une référence vers l'objet Gmagick courant avec le - pointeur de l'image à la bonne séquence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le contexte en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/cyclecolormapimage.xml b/reference/gmagick/gmagick/cyclecolormapimage.xml deleted file mode 100644 index 197bc64e6f..0000000000 --- a/reference/gmagick/gmagick/cyclecolormapimage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Gmagick::cyclecolormapimage - Déplace la carte des couleurs d'une image - - - - &reftitle.description; - - public GmagickGmagick::cyclecolormapimage - intdisplace - - - Déplace la carte des couleurs d'une image d'un nombre de positions donné. - En déplaçant plusieurs fois la carte des couleurs, il est possible de produire - un effet psychédélique. - - - - - - &reftitle.parameters; - - - displace - - - Le nombre de positions dont on doit déplacer la carte des couleurs. - - - - - - - - &reftitle.returnvalues; - - Retourne le contexte en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/deconstructimages.xml b/reference/gmagick/gmagick/deconstructimages.xml deleted file mode 100644 index 639212e4df..0000000000 --- a/reference/gmagick/gmagick/deconstructimages.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gmagick::deconstructimages - Retourne les pixels différents entre des images - - - - &reftitle.description; - - public GmagickGmagick::deconstructimages - - - - Compare chaque image avec la suivante de la séquence et retourne - les pixels différents découverts. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/despeckleimage.xml b/reference/gmagick/gmagick/despeckleimage.xml deleted file mode 100644 index 0af52afb4e..0000000000 --- a/reference/gmagick/gmagick/despeckleimage.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - Gmagick::despeckleimage - Le but de despeckleimage - - - - &reftitle.description; - - public GmagickGmagick::despeckleimage - - - - Réduit le bruit speckle d'une image tout en préservant les bords de l'image originale. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Gmagick sans bruit en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - &reftitle.examples; - - Exemple avec <methodname>Gmagick::despeckleimage</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/gmagick/gmagick/destroy.xml b/reference/gmagick/gmagick/destroy.xml deleted file mode 100644 index fa05db5cf9..0000000000 --- a/reference/gmagick/gmagick/destroy.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::destroy - Le but de la méthode destroy - - - - &reftitle.description; - - public boolGmagick::destroy - - - - Détruit l'objet Gmagick et libère toutes les ressources associées. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/drawimage.xml b/reference/gmagick/gmagick/drawimage.xml deleted file mode 100644 index f6cbe98ce9..0000000000 --- a/reference/gmagick/gmagick/drawimage.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::drawimage - Fait un rendu de l'objet GmagickDraw sur l'image courante - - - - &reftitle.description; - - public GmagickGmagick::drawimage - GmagickDrawGmagickDraw - - - Fait un rendu de l'objet GmagickDraw sur l'image courante. - - - - - - &reftitle.parameters; - - - GmagickDraw - - - L'opération de dessin à exécuter sur l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick dessiné. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/edgeimage.xml b/reference/gmagick/gmagick/edgeimage.xml deleted file mode 100644 index d44826a0d6..0000000000 --- a/reference/gmagick/gmagick/edgeimage.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - Gmagick::edgeimage - Améliore les bords intérieurs de l'image - - - - &reftitle.description; - - public GmagickGmagick::edgeimage - floatradius - - - Améliore les bords intérieurs de l'image avec un filtre de convolution - utilisant le rayon fourni. En utilisant un rayon de 0, la méthode le choisira - automatiquement. - - - - - - - &reftitle.parameters; - - - radius - - - Le rayon utilisé pour l'opération. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick dont les bords intérieurs ont été améliorés. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/embossimage.xml b/reference/gmagick/gmagick/embossimage.xml deleted file mode 100644 index 716e8e8628..0000000000 --- a/reference/gmagick/gmagick/embossimage.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Gmagick::embossimage - Retourne une image en niveaux de gris avec un effet à 3 dimensions - - - - &reftitle.description; - - public GmagickGmagick::embossimage - floatradius - floatsigma - - - Retourne une image en niveaux de gris avec un effet à 3 dimensions. - L'image est transformée avec un opérateur Gaussien utilisant le rayon donné, - et une déviation standard (sigma). Pour obtenir un résultat convenable, le rayon - doit être supérieur au sigma. Si l'on spécifie un rayon de 0, la méthode - choisira le meilleur rayon à sa place. - - - - - &reftitle.parameters; - - - radius - - - Le rayon de l'effet. - - - - - sigma - - - Le sigma de l'effet. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick en relief. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/enhanceimage.xml b/reference/gmagick/gmagick/enhanceimage.xml deleted file mode 100644 index d534896cb5..0000000000 --- a/reference/gmagick/gmagick/enhanceimage.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - Gmagick::enhanceimage - Améliore la qualité d'une image contenant du bruit - - - - &reftitle.description; - - public GmagickGmagick::enhanceimage - - - - Applique un filtre numérique qui améliore la qualité d'une image - contenant du bruit. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Gmagick amélioré. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - - diff --git a/reference/gmagick/gmagick/equalizeimage.xml b/reference/gmagick/gmagick/equalizeimage.xml deleted file mode 100644 index c420fd4063..0000000000 --- a/reference/gmagick/gmagick/equalizeimage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gmagick::equalizeimage - Égalise l'histogramme de l'image - - - - &reftitle.description; - - public GmagickGmagick::equalizeimage - - - - Égalise l'histogramme de l'image. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Gmagick égalisé. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/flipimage.xml b/reference/gmagick/gmagick/flipimage.xml deleted file mode 100644 index 8b179a7679..0000000000 --- a/reference/gmagick/gmagick/flipimage.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - Gmagick::flipimage - Crée une image miroir verticale - - - - &reftitle.description; - - public GmagickGmagick::flipimage - - - - Crée une image miroir verticale en reflétant les pixels autour du centre de l'axe X. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Gmagick reflété. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - &reftitle.seealso; - - Gmagick::flopimage - - - - - diff --git a/reference/gmagick/gmagick/flopimage.xml b/reference/gmagick/gmagick/flopimage.xml deleted file mode 100644 index 852fa669f0..0000000000 --- a/reference/gmagick/gmagick/flopimage.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Gmagick::flopimage - Crée une image miroir horizontale - - - - &reftitle.description; - - public GmagickGmagick::flopimage - - - - Crée une image miroir horizontale en reflétant les pixels autour du centre de l'axe Y. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Gmagick reflété. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - &reftitle.seealso; - - Gmagick::flipimage - - - - - diff --git a/reference/gmagick/gmagick/frameimage.xml b/reference/gmagick/gmagick/frameimage.xml deleted file mode 100644 index 725067adff..0000000000 --- a/reference/gmagick/gmagick/frameimage.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - Gmagick::frameimage - Ajoute une bordure afin de simuler un effet 3D - - - - &reftitle.description; - - public GmagickGmagick::frameimage - GmagickPixelcolor - intwidth - intheight - intinner_bevel - intouter_bevel - - - Ajoute une bordure simulant un effet 3D à l'image. - La largeur et la hauteur spécifient la largeur de la bordure verticale - et horizontale de la frame. Les paramètres inner_bevel - et outer_bevel indiquent la largeur interne et - externe de l'ombre de la frame. - - - - - - &reftitle.parameters; - - - color - - - Un objet GmagickPixel ou un nombre à virgule flottante représentant - la couleur mate. - - - - - width - - - La largeur de la bordure. - - - - - height - - - La hauteur de la bordure. - - - - - inner_bevel - - - La largeur du bevel interne. - - - - - outer_bevel - - - La largeur du bevel externe. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick dont la bordure 3D a été ajoutée. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/gammaimage.xml b/reference/gmagick/gmagick/gammaimage.xml deleted file mode 100644 index 275f7ac572..0000000000 --- a/reference/gmagick/gmagick/gammaimage.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - Gmagick::gammaimage - Corrige le gamma d'une image - - - - &reftitle.description; - - public GmagickGmagick::gammaimage - floatgamma - - - Corrige le gamma d'une image. La même image vue sur différents - médias aura plusieurs différences suivant l'intensité représentée - sur l'écran. Il est possible d'ainsi jouer sur le niveau de gamma - pour les canaux rouges, verts et bleus, ou ajuster les 3 avec le - paramètre gamma. Les valeurs sont typiquement dans l'intervalle - 0.8 à 2.3. - - - - - - &reftitle.parameters; - - - gamma - - - La quantité de correction gamma. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick dont le gamma a été corrigé. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getcopyright.xml b/reference/gmagick/gmagick/getcopyright.xml deleted file mode 100644 index 3adb38dfd4..0000000000 --- a/reference/gmagick/gmagick/getcopyright.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - Gmagick::getcopyright - Retourne le copyright de l'API GraphicsMagick - - - - &reftitle.description; - - public stringGmagick::getcopyright - - - - Retourne le copyright de l'API GraphicsMagick. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; contenant le copyright de l'API GraphicsMagick - ainsi que celui de l'API Magickwand. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getfilename.xml b/reference/gmagick/gmagick/getfilename.xml deleted file mode 100644 index 0c92c47a2f..0000000000 --- a/reference/gmagick/gmagick/getfilename.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::getfilename - Retourne le nom du fichier associé avec une séquence d'image - - - - &reftitle.description; - - public stringGmagick::getfilename - - - - Retourne le nom du fichier associé avec une séquence d'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagebackgroundcolor.xml b/reference/gmagick/gmagick/getimagebackgroundcolor.xml deleted file mode 100644 index 1213fad137..0000000000 --- a/reference/gmagick/gmagick/getimagebackgroundcolor.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - Gmagick::getimagebackgroundcolor - Retourne la couleur d'arrière plan de l'image - - - - &reftitle.description; - - public GmagickPixelGmagick::getimagebackgroundcolor - - - - Retourne la couleur d'arrière plan de l'image. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un objet GmagickPixel défini à la couleur d'arrière plan - de l'image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageblueprimary.xml b/reference/gmagick/gmagick/getimageblueprimary.xml deleted file mode 100644 index c97b723b4c..0000000000 --- a/reference/gmagick/gmagick/getimageblueprimary.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - Gmagick::getimageblueprimary - Retourne le point bleu primaire chromatique - - - - &reftitle.description; - - public arrayGmagick::getimageblueprimary - - - - Retourne le point bleu primaire chromatique de l'image. - - - - - &reftitle.parameters; - - - x - - - Coordonnée en X du point bleu primaire chromatique. - - - - - y - - - Coordonnée en Y du point bleu primaire chromatique. - - - - - - - - &reftitle.returnvalues; - - Un tableau contenant les coordonnées en X et en Y du point. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagebordercolor.xml b/reference/gmagick/gmagick/getimagebordercolor.xml deleted file mode 100644 index 5f959afe67..0000000000 --- a/reference/gmagick/gmagick/getimagebordercolor.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gmagick::getimagebordercolor - Retourne la couleur du bord de l'image - - - - &reftitle.description; - - public GmagickPixelGmagick::getimagebordercolor - - - - Retourne la couleur du bord de l'image. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet GmagickPixel représentant la couleur du bord de l'image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagechanneldepth.xml b/reference/gmagick/gmagick/getimagechanneldepth.xml deleted file mode 100644 index 9557a15ffa..0000000000 --- a/reference/gmagick/gmagick/getimagechanneldepth.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gmagick::getimagechanneldepth - Récupère la profondeur d'un canal particulier de l'image - - - - &reftitle.description; - - public intGmagick::getimagechanneldepth - intchannel_type - - - Récupère la profondeur d'un canal particulier de l'image. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La profondeur du canal de l'image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagecolors.xml b/reference/gmagick/gmagick/getimagecolors.xml deleted file mode 100644 index 60efc4498e..0000000000 --- a/reference/gmagick/gmagick/getimagecolors.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gmagick::getimagecolors - Retourne la couleur de l'indice de la carte des couleurs spécifiée - - - - &reftitle.description; - - public intGmagick::getimagecolors - - - - Retourne la couleur de l'indice de la carte des couleurs spécifiée. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre de couleurs dans l'image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagecolorspace.xml b/reference/gmagick/gmagick/getimagecolorspace.xml deleted file mode 100644 index 9a91f533e2..0000000000 --- a/reference/gmagick/gmagick/getimagecolorspace.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gmagick::getimagecolorspace - Récupère l'espace colorimétrique de l'image - - - - &reftitle.description; - - public intGmagick::getimagecolorspace - - - - Récupère l'espace colorimétrique de l'image. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'espace colorimétrique. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagecompose.xml b/reference/gmagick/gmagick/getimagecompose.xml deleted file mode 100644 index 13df8cc20c..0000000000 --- a/reference/gmagick/gmagick/getimagecompose.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gmagick::getimagecompose - Retourne l'opérateur de composition associé avec l'image - - - - &reftitle.description; - - public intGmagick::getimagecompose - - - - Retourne l'opérateur de composition associé avec l'image. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'opérateur de composition associé avec l'image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagedelay.xml b/reference/gmagick/gmagick/getimagedelay.xml deleted file mode 100644 index bb681b5bab..0000000000 --- a/reference/gmagick/gmagick/getimagedelay.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::getimagedelay - Récupère le délai de l'image - - - - &reftitle.description; - - public intGmagick::getimagedelay - - - - Récupère le délai de l'image. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'opérateur de composition associé avec l'image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagedepth.xml b/reference/gmagick/gmagick/getimagedepth.xml deleted file mode 100644 index a4fbc5ab57..0000000000 --- a/reference/gmagick/gmagick/getimagedepth.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gmagick::getimagedepth - Récupère la profondeur de l'image - - - - &reftitle.description; - - public intGmagick::getimagedepth - - - - Récupère la profondeur de l'image. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La profondeur de l'image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagedispose.xml b/reference/gmagick/gmagick/getimagedispose.xml deleted file mode 100644 index 038ad5394e..0000000000 --- a/reference/gmagick/gmagick/getimagedispose.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::getimagedispose - Récupère la méthode de disposition de l'image - - - - &reftitle.description; - - public intGmagick::getimagedispose - - - - Récupère la méthode de disposition de l'image. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la méthode de disposition de l'image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageextrema.xml b/reference/gmagick/gmagick/getimageextrema.xml deleted file mode 100644 index 09a53d0e04..0000000000 --- a/reference/gmagick/gmagick/getimageextrema.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - Gmagick::getimageextrema - Récupère les extrémités de l'image - - - - &reftitle.description; - - public arrayGmagick::getimageextrema - - - - Retourne un tableau associatif contenant les clés - "min" et "max". - &gmagick.gmagickexception.throw; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau associatif contenant les clés - "min" et "max". - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagefilename.xml b/reference/gmagick/gmagick/getimagefilename.xml deleted file mode 100644 index abfaeda5e9..0000000000 --- a/reference/gmagick/gmagick/getimagefilename.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - Gmagick::getimagefilename - Récupère le nom du fichier d'une image - particulière dans une séquence - - - - &reftitle.description; - - public stringGmagick::getimagefilename - - - - Récupère le nom du fichier d'une image - particulière dans une séquence. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; représentant le nom du fichier - image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageformat.xml b/reference/gmagick/gmagick/getimageformat.xml deleted file mode 100644 index 599007afcc..0000000000 --- a/reference/gmagick/gmagick/getimageformat.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - Gmagick::getimageformat - Récupère le format d'une image - particulière dans une séquence - - - - &reftitle.description; - - public stringGmagick::getimageformat - - - - Récupère le format d'une image - particulière dans une séquence. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; contenant le format de - l'image en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagegamma.xml b/reference/gmagick/gmagick/getimagegamma.xml deleted file mode 100644 index 2d87b2b663..0000000000 --- a/reference/gmagick/gmagick/getimagegamma.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::getimagegamma - Récupère le gamma de l'image - - - - &reftitle.description; - - public floatGmagick::getimagegamma - - - - Récupère le gamma de l'image. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le gamma de l'image en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/getimagegreenprimary.xml b/reference/gmagick/gmagick/getimagegreenprimary.xml deleted file mode 100644 index e4c780b68d..0000000000 --- a/reference/gmagick/gmagick/getimagegreenprimary.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - Gmagick::getimagegreenprimary - Récupère le point chromatique primaire vert - - - - &reftitle.description; - - public arrayGmagick::getimagegreenprimary - - - - Récupère le point chromatique primaire vert. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les clés - "x" et "y" en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/getimageheight.xml b/reference/gmagick/gmagick/getimageheight.xml deleted file mode 100644 index d5831f8243..0000000000 --- a/reference/gmagick/gmagick/getimageheight.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::getimageheight - Récupère la hauteur de l'image - - - - &reftitle.description; - - public intGmagick::getimageheight - - - - Récupère la hauteur de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la hauteur de l'image, en pixels. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagehistogram.xml b/reference/gmagick/gmagick/getimagehistogram.xml deleted file mode 100644 index 25e07e973e..0000000000 --- a/reference/gmagick/gmagick/getimagehistogram.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gmagick::getimagehistogram - Récupère l'histogramme de l'image - - - - &reftitle.description; - - public arrayGmagick::getimagehistogram - - - - Récupère l'histogramme de l'image. - Lance une exception GmagickException en cas d'erreur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'histogramme de l'image sous la forme d'un - tableau d'objets GmagickPixel. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageindex.xml b/reference/gmagick/gmagick/getimageindex.xml deleted file mode 100644 index 8564719d48..0000000000 --- a/reference/gmagick/gmagick/getimageindex.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::getimageindex - Récupère l'indice de l'image active courante - - - - &reftitle.description; - - public intGmagick::getimageindex - - - - Récupère l'indice de l'image active courante dans l'objet Gmagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'indice de l'image courante active. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageinterlacescheme.xml b/reference/gmagick/gmagick/getimageinterlacescheme.xml deleted file mode 100644 index 876495c5c9..0000000000 --- a/reference/gmagick/gmagick/getimageinterlacescheme.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::getimageinterlacescheme - Récupère le schéma d'entrelacement de l'image - - - - &reftitle.description; - - public intGmagick::getimageinterlacescheme - - - - Récupère le schéma d'entrelacement de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le schéma d'entrelacement de l'image, sous - la forme d'un &integer; en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageiterations.xml b/reference/gmagick/gmagick/getimageiterations.xml deleted file mode 100644 index 02bbee885d..0000000000 --- a/reference/gmagick/gmagick/getimageiterations.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::getimageiterations - Récupère les itérations de l'image - - - - &reftitle.description; - - public intGmagick::getimageiterations - - - - Récupère les itérations de l'image. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les itérations de l'image, sous la forme d'un &integer;. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagematte.xml b/reference/gmagick/gmagick/getimagematte.xml deleted file mode 100644 index 3d4586c417..0000000000 --- a/reference/gmagick/gmagick/getimagematte.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::getimagematte - Vérifie si l'image a un canal mate - - - - &reftitle.description; - - public intGmagick::getimagematte - - - - Retourne &true; si l'image a un canal mate, &false; sinon. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si l'image a un canal mate, &false; sinon. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagemattecolor.xml b/reference/gmagick/gmagick/getimagemattecolor.xml deleted file mode 100644 index ed2368b99b..0000000000 --- a/reference/gmagick/gmagick/getimagemattecolor.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::getimagemattecolor - Récupère la couleur mate de l'image - - - - &reftitle.description; - - public GmagickPixelGmagick::getimagemattecolor - - - - Retourne un objet GmagickPixel en cas de succès. - Lance une exception GmagickException en cas d'erreur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un objet GmagickPixel. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageprofile.xml b/reference/gmagick/gmagick/getimageprofile.xml deleted file mode 100644 index 9c0b1c633e..0000000000 --- a/reference/gmagick/gmagick/getimageprofile.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::getimageprofile - Récupère le nom du profil de l'image - - - - &reftitle.description; - - public stringGmagick::getimageprofile - stringname - - - Récupère le nom du profil de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; représentant le profil de l'image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageredprimary.xml b/reference/gmagick/gmagick/getimageredprimary.xml deleted file mode 100644 index 22f184627d..0000000000 --- a/reference/gmagick/gmagick/getimageredprimary.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - Gmagick::getimageredprimary - Récupère le point chromatique primaire rouge - - - - &reftitle.description; - - public arrayGmagick::getimageredprimary - - - - Récupère le point chromatique primaire rouge, sous la forme d'un - &array; contenant les clés "x" et "y". - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le point chromatique primaire rouge, sous la forme d'un - &array; contenant les clés "x" et "y". - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagerenderingintent.xml b/reference/gmagick/gmagick/getimagerenderingintent.xml deleted file mode 100644 index 7cfdf5de5d..0000000000 --- a/reference/gmagick/gmagick/getimagerenderingintent.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - Gmagick::getimagerenderingintent - Récupère l'image de rendu - - - - &reftitle.description; - - public intGmagick::getimagerenderingintent - - - - Récupère l'image de rendu. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Extrait une région de l'image et la retourne en tant que nouvelle baguette - magique. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageresolution.xml b/reference/gmagick/gmagick/getimageresolution.xml deleted file mode 100644 index 3629129da9..0000000000 --- a/reference/gmagick/gmagick/getimageresolution.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::getimageresolution - Récupère la résolution de l'image - - - - &reftitle.description; - - public arrayGmagick::getimageresolution - - - - Récupère la résolution de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la résolution sous la forme d'un &array;. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagescene.xml b/reference/gmagick/gmagick/getimagescene.xml deleted file mode 100644 index 3f649bef06..0000000000 --- a/reference/gmagick/gmagick/getimagescene.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::getimagescene - Récupère la scène de l'image - - - - &reftitle.description; - - public intGmagick::getimagescene - - - - Récupère la scène de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la scène de l'image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagesignature.xml b/reference/gmagick/gmagick/getimagesignature.xml deleted file mode 100644 index c93f2b1e4f..0000000000 --- a/reference/gmagick/gmagick/getimagesignature.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::getimagesignature - Génère la signature SHA-256 de l'image - - - - &reftitle.description; - - public stringGmagick::getimagesignature - - - - Génère la signature SHA-256 de l'image depuis le flux de pixels. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; contenant la signature SHA-256 hash. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagetype.xml b/reference/gmagick/gmagick/getimagetype.xml deleted file mode 100644 index 924f79b0be..0000000000 --- a/reference/gmagick/gmagick/getimagetype.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - Gmagick::getimagetype - Récupère le type potentiel d'une image - - - - &reftitle.description; - - public intGmagick::getimagetype - - - - Récupère le type potentiel d'une image. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le type potentiel d'une image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageunits.xml b/reference/gmagick/gmagick/getimageunits.xml deleted file mode 100644 index 6ddab6208a..0000000000 --- a/reference/gmagick/gmagick/getimageunits.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - Gmagick::getimageunits - Récupère les unités utilisées pour la résolution de l'image - - - - &reftitle.description; - - public intGmagick::getimageunits - - - - Récupère les unités utilisées pour la résolution de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les unités utilisées pour la résolution de l'image. - - - - - - diff --git a/reference/gmagick/gmagick/getimagewhitepoint.xml b/reference/gmagick/gmagick/getimagewhitepoint.xml deleted file mode 100644 index 7d9c8468ab..0000000000 --- a/reference/gmagick/gmagick/getimagewhitepoint.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - Gmagick::getimagewhitepoint - Récupère le point chromatique blanc - - - - &reftitle.description; - - public arrayGmagick::getimagewhitepoint - - - - Récupère le point chromatique blanc. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le point chromatique blanc, sous la forme d'un tableau associatif - contenant les clés "x" et "y". - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/getimagewidth.xml b/reference/gmagick/gmagick/getimagewidth.xml deleted file mode 100644 index de6d76a271..0000000000 --- a/reference/gmagick/gmagick/getimagewidth.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - Gmagick::getimagewidth - Récupère la largeur de l'image - - - - &reftitle.description; - - public intGmagick::getimagewidth - - - - Récupère la largeur de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la largeur de l'image. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getpackagename.xml b/reference/gmagick/gmagick/getpackagename.xml deleted file mode 100644 index 6260aefb2f..0000000000 --- a/reference/gmagick/gmagick/getpackagename.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::getpackagename - Récupère le nom du paquet GraphicsMagick - - - - &reftitle.description; - - public stringGmagick::getpackagename - - - - Récupère le nom du paquet GraphicsMagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le nom du paquet GraphicsMagick, sous la forme d'une &string;. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getquantumdepth.xml b/reference/gmagick/gmagick/getquantumdepth.xml deleted file mode 100644 index d776d1b33f..0000000000 --- a/reference/gmagick/gmagick/getquantumdepth.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::getquantumdepth - Récupère la profondeur du quantum Gmagick - - - - &reftitle.description; - - public arrayGmagick::getquantumdepth - - - - Récupère la profondeur du quantum Gmagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la profondeur du quantum Gmagick, sous la forme d'un &string;. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getreleasedate.xml b/reference/gmagick/gmagick/getreleasedate.xml deleted file mode 100644 index 873abcb1fa..0000000000 --- a/reference/gmagick/gmagick/getreleasedate.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::getreleasedate - Récupère la date de sortie de la version courante de GraphicsMagick - - - - &reftitle.description; - - public stringGmagick::getreleasedate - - - - Récupère la date de sortie de la version courante de GraphicsMagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la date de sortie de la version courante de GraphicsMagick - sous la forme d'une &string;. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/getsamplingfactors.xml b/reference/gmagick/gmagick/getsamplingfactors.xml deleted file mode 100644 index f603a1fe47..0000000000 --- a/reference/gmagick/gmagick/getsamplingfactors.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - Gmagick::getsamplingfactors - Récupère le facteur d'échantillonnage horizontal et vertical - - - - &reftitle.description; - - public arrayGmagick::getsamplingfactors - - - - Récupère le facteur d'échantillonnage horizontal et vertical. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau associatif contenant le facteur d'échantillonnage vertical et horizontal. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getsize.xml b/reference/gmagick/gmagick/getsize.xml deleted file mode 100644 index ebff533f6c..0000000000 --- a/reference/gmagick/gmagick/getsize.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - Gmagick::getsize - Récupère la taille associée avec l'objet Gmagick - - - - &reftitle.description; - - public arrayGmagick::getsize - - - - Récupère la taille associée avec l'objet Gmagick. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la taille associée avec l'objet Gmagick - sous la forme d'un tableau contenant les clés - "columns" et "rows". - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getversion.xml b/reference/gmagick/gmagick/getversion.xml deleted file mode 100644 index b33a99ce11..0000000000 --- a/reference/gmagick/gmagick/getversion.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::getversion - Récupère la version de l'API GraphicsMagick - - - - &reftitle.description; - - public arrayGmagick::getversion - - - - Récupère la version de l'API GraphicsMagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la version de l'API GraphicsMagick, sous la forme - d'une &string; et d'un nombre. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/hasnextimage.xml b/reference/gmagick/gmagick/hasnextimage.xml deleted file mode 100644 index 0bc9478272..0000000000 --- a/reference/gmagick/gmagick/hasnextimage.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - Gmagick::hasnextimage - Vérifie si l'objet contient au moins une autre image - - - - &reftitle.description; - - public mixedGmagick::hasnextimage - - - - Vérifie si l'objet contient au moins une image suivante. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si l'objet a au moins une image suivante, &false; sinon. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/haspreviousimage.xml b/reference/gmagick/gmagick/haspreviousimage.xml deleted file mode 100644 index 4ad4887094..0000000000 --- a/reference/gmagick/gmagick/haspreviousimage.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - Gmagick::haspreviousimage - Vérifie si l'objet contient une image précédente - - - - &reftitle.description; - - public mixedGmagick::haspreviousimage - - - - Vérifie si l'objet contient une image précédente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si l'objet a au moins une image précédente, &false; sinon. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/implodeimage.xml b/reference/gmagick/gmagick/implodeimage.xml deleted file mode 100644 index 7113f3eb16..0000000000 --- a/reference/gmagick/gmagick/implodeimage.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::implodeimage - Crée une image à partir d'une copie - - - - &reftitle.description; - - public mixedGmagick::implodeimage - floatradius - - - Crée une nouvelle image à partir d'une copie d'une image existante - dont les pixels ont été modifiés suivant le pourcentage fourni. - - - - - &reftitle.parameters; - - - radius - - - Le rayon d'implosion des pixels. - - - - - - - - &reftitle.returnvalues; - - Retourne un objet Gmagick dont les pixels ont été modifiés. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/labelimage.xml b/reference/gmagick/gmagick/labelimage.xml deleted file mode 100644 index 6ef51ecbeb..0000000000 --- a/reference/gmagick/gmagick/labelimage.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Gmagick::labelimage - Ajoute un libellé à une image - - - - &reftitle.description; - - public mixedGmagick::labelimage - stringlabel - - - Ajoute un libellé à une image. - - - - - &reftitle.parameters; - - - label - - - Le libellé à ajouter - - - - - - - - &reftitle.returnvalues; - - Gmagick avec un libellé. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/levelimage.xml b/reference/gmagick/gmagick/levelimage.xml deleted file mode 100644 index d5eb81f819..0000000000 --- a/reference/gmagick/gmagick/levelimage.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - Gmagick::levelimage - Ajuste les niveaux d'une image - - - - &reftitle.description; - - public mixedGmagick::levelimage - floatblackPoint - floatgamma - floatwhitePoint - intchannelGmagick::CHANNEL_DEFAULT - - - Ajuste les niveaux d'une image en balançant les couleurs situées entre les points blancs et noirs - spécifiés, vers un intervalle quantum disponible. Les paramètres indiquent les points - blancs, milieux et noirs. Le point noir spécifie la couleur la plus sombre de l'image. - Les couleurs plus sombres que le point noir seront définies à zéro. Le point milieu spécifie - une correction gamma à appliquer à l'image. Le point blanc spécifie la couleur la plus - claire de l'image. Les couleurs plus claires que le point blanc seront définies à - la valeur maximale du quantum. - - - - - &reftitle.parameters; - - - blackPoint - - - Le point noir de l'image. - - - - - gamma - - - La valeur gamma. - - - - - whitePoint - - - Le point blanc de l'image. - - - - - channel - - - Une constante de canaux valide pour le mode de canal utilisé. - Pour l'appliquer à plus d'un canal, combinez les constantes - de type de canaux en utilisant un opérateur bit à bit. - Se reporter à la liste des constantes de canaux. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick dont les niveaux ont été modifiés. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/magnifyimage.xml b/reference/gmagick/gmagick/magnifyimage.xml deleted file mode 100644 index 6df5d45942..0000000000 --- a/reference/gmagick/gmagick/magnifyimage.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - Gmagick::magnifyimage - Retaille par 2 une image en conservant les proportions - - - - &reftitle.description; - - public mixedGmagick::magnifyimage - - - - Retaille par 2 une image en conservant les proportions. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Gmagick modifié. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/mapimage.xml b/reference/gmagick/gmagick/mapimage.xml deleted file mode 100644 index c8006f809a..0000000000 --- a/reference/gmagick/gmagick/mapimage.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - Gmagick::mapimage - Remplace les couleurs d'une image avec les couleurs les plus proches d'une image de référence - - - - &reftitle.description; - - public GmagickGmagick::mapimage - gmagickgmagick - booldither - - - Remplace les couleurs d'une image avec les couleurs les plus proches d'une image de référence. - - - - - &reftitle.parameters; - - - gmagick - - - L'image de référence. - - - - - dither - - - Entier plus grand que 0 pour appliquer le tramage à l'image mappée. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/medianfilterimage.xml b/reference/gmagick/gmagick/medianfilterimage.xml deleted file mode 100644 index b0d8521caf..0000000000 --- a/reference/gmagick/gmagick/medianfilterimage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - Gmagick::medianfilterimage - Applique un filtre numérique - - - - &reftitle.description; - - public voidGmagick::medianfilterimage - floatradius - - - Applique un filtre numérique qui améliore la qualité du bruit d'une image. - Chaque pixel est remplacé par la médiane dans un jeu de pixels voisins - tel que défini par le rayon. - - - - - &reftitle.parameters; - - - radius - - - Le rayon des pixels voisins. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick dont le filtre a été appliqué. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/minifyimage.xml b/reference/gmagick/gmagick/minifyimage.xml deleted file mode 100644 index d15e5c8d60..0000000000 --- a/reference/gmagick/gmagick/minifyimage.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::minifyimage - Réduit une image de moitié en gardant les proportions - - - - &reftitle.description; - - public GmagickGmagick::minifyimage - - - - Réduit une image de moitié en gardant les proportions. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/modulateimage.xml b/reference/gmagick/gmagick/modulateimage.xml deleted file mode 100644 index ef8c59bba9..0000000000 --- a/reference/gmagick/gmagick/modulateimage.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - Gmagick::modulateimage - Contrôle la luminosité, la saturation et la teinte - - - - &reftitle.description; - - public GmagickGmagick::modulateimage - floatbrightness - floatsaturation - floathue - - - Permet de contrôler la luminosité, la saturation et la teinte d'une image. - La teinte est un pourcentage d'une rotation absolue depuis la position - courante. Par exemple, 50 correspond à une rotation de 90 degrés dans le sens - inverse des aiguilles d'une montre, 150, une rotation de 90 degrés dans le sens - des aiguilles d'une montre, ou encore, 0 ou 200 correspond à une rotation de 180 - degrés. - - - - - &reftitle.parameters; - - - brightness - - - Le nombre de pourcentage à modifier pour la luminosité (-100 à +100). - - - - - saturation - - - Le nombre de pourcentage à modifier pour la saturation (-100 à +100). - - - - - hue - - - Le nombre de pourcentage à modifier pour la teinte (-100 à +100). - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/motionblurimage.xml b/reference/gmagick/gmagick/motionblurimage.xml deleted file mode 100644 index d817b61e27..0000000000 --- a/reference/gmagick/gmagick/motionblurimage.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - Gmagick::motionblurimage - Simule un flou cinétique - - - - &reftitle.description; - - public GmagickGmagick::motionblurimage - floatradius - floatsigma - floatangle - - - Simule un flou cinétique. L'image est traitée avec un opérateur Gaussien d'un rayon - donné et d'une déviation standard (sigma). Pour de bons résultats, le rayon - doit être plus élevé que le sigma. En utilisant un rayon de 0, la méthode - Gmagick::motionblurimage sélectionne automatiquement le meilleur rayon. Le paramètre - angle fournit l'angle du flou cinétique. - - - - - &reftitle.parameters; - - - radius - - - Le rayon du Gaussien, en pixels, sans compter le pixel central. - - - - - sigma - - - La déviation standard du Gaussien, en pixels. - - - - - angle - - - Applique l'effet tout le long de l'angle. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/newimage.xml b/reference/gmagick/gmagick/newimage.xml deleted file mode 100644 index 6ccaac0cc6..0000000000 --- a/reference/gmagick/gmagick/newimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - Gmagick::newimage - Crée une nouvelle image - - - - &reftitle.description; - - public GmagickGmagick::newimage - intwidth - intheight - stringbackground - stringformat - - - Crée une nouvelle image avec la couleur d'arrière-plan spécifiée. - - - - - &reftitle.parameters; - - - width - - - Largeur de la nouvelle image. - - - - - height - - - Hauteur de la nouvelle image. - - - - - background - - - La couleur d'arrière-plan à utiliser pour l'image (sous la forme - d'un nombre à virgule flottante) - - - - - format - - - Le format de l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/nextimage.xml b/reference/gmagick/gmagick/nextimage.xml deleted file mode 100644 index b28c830fa8..0000000000 --- a/reference/gmagick/gmagick/nextimage.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::nextimage - Se déplace sur l'image suivante - - - - &reftitle.description; - - public boolGmagick::nextimage - - - - Associe l'image suivante dans la liste des images avec un objet - Gmagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/normalizeimage.xml b/reference/gmagick/gmagick/normalizeimage.xml deleted file mode 100644 index 69d57afc4f..0000000000 --- a/reference/gmagick/gmagick/normalizeimage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - Gmagick::normalizeimage - Améliore le contraste de la couleur de l'image - - - - &reftitle.description; - - public GmagickGmagick::normalizeimage - intchannel - - - Améliore le contraste de la couleur de l'image en ajustant - la couleur des pixels pour correspondre à l'intervalle de couleurs - disponibles. - - - - - &reftitle.parameters; - - - channel - - - Canal à normaliser. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/oilpaintimage.xml b/reference/gmagick/gmagick/oilpaintimage.xml deleted file mode 100644 index b40d57b6b8..0000000000 --- a/reference/gmagick/gmagick/oilpaintimage.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - Gmagick::oilpaintimage - Simule une peinture à l'huile - - - - &reftitle.description; - - public GmagickGmagick::oilpaintimage - - float - radius - - - - Applique un effet spécial qui simule une peinture à l'huile. - Chaque pixel est remplacé par la couleur survenant le plus grand - nombre de fois dans une région circulaire définie par un rayon. - - - - - &reftitle.parameters; - - - - radius - - - - Le rayon de la région circulaire voisine. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick en cas de succès. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/previousimage.xml b/reference/gmagick/gmagick/previousimage.xml deleted file mode 100644 index 57c328e715..0000000000 --- a/reference/gmagick/gmagick/previousimage.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::previousimage - Se déplace vers l'image précédente de l'objet - - - - &reftitle.description; - - public boolGmagick::previousimage - - - - Associe l'image précédente de la liste d'images avec l'objet - Gmagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/profileimage.xml b/reference/gmagick/gmagick/profileimage.xml deleted file mode 100644 index d90e1c95bf..0000000000 --- a/reference/gmagick/gmagick/profileimage.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - Gmagick::profileimage - Ajoute ou supprime un profil d'une image - - - - &reftitle.description; - - public GmagickGmagick::profileimage - stringname - stringprofile - - - Ajoute ou supprime un profil ICC, IPTC ou générique d'une image. - Si le profil est &null;, il sera supprimé de l'image, sinon, il - sera ajouté. En utilisant * comme nom et un profil &null;, il est possible de - supprimer tous les profils de l'image. - - - - - &reftitle.parameters; - - - name - - - Nom du profil à ajouter ou à supprimer : profil ICC, IPTC, ou générique. - - - - - profile - - - Le profil. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/quantizeimage.xml b/reference/gmagick/gmagick/quantizeimage.xml deleted file mode 100644 index e52fcd6546..0000000000 --- a/reference/gmagick/gmagick/quantizeimage.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - Gmagick::quantizeimage - Analyse les couleurs d'une image de référence - - - - &reftitle.description; - - public GmagickGmagick::quantizeimage - intnumColors - intcolorspace - inttreeDepth - booldither - boolmeasureError - - - Analyse les couleurs d'une image de référence et choisit un nombre fixe - de couleurs représentant l'image. Le but de l'algorithme est de minimiser - les différences de couleurs entre l'image d'entrée et celle de sortie - lors d'un processus d'optimisation. - - - - - &reftitle.parameters; - - - numColors - - - Le nombre de couleurs. - - - - - colorspace - - - Effectue la réduction de couleurs dans cet espace - de couleurs, typiquement RGBColorspace. - - - - - treeDepth - - - Normalement, la valeur de cet entier est zéro ou un. Une telle valeur demande à - Quantize de choisir une profondeur optionnelle de Log4(number_colors). Un arbre - de cette profondeur autorise généralement la meilleure représentation de l'image - de référence tout en utilisant une quantité de mémoire raisonnable ainsi qu'une - rapidité d'exécution optimum. Dans certains cas, comme avec une image contenant - des dispersions de couleurs basses (un petit nombre de couleurs), une valeur autre - que Log4(number_colors) est nécessaire. Pour étendre totalement l'arbre de couleurs, - il convient d'utiliser la valeur 8. - - - - - dither - - - Une valeur autre que zéro distribue la différence entre l'image originale - et la couleur correspondante réduite par l'algorithme vers les pixels voisins - le long de la courbe Hilbert. - - - - - measureError - - - Une valeur autre que zéro mesure la différence entre l'image originale et l'image - optimisée. Cette différence représente l'erreur totale de quantification. L'erreur - est calculée en faisant la somme de tous les pixels dans une image carrée de la distance - dans l'espace RVB entre chaque valeur de pixel de référence et sa valeur quantifiée. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/quantizeimages.xml b/reference/gmagick/gmagick/quantizeimages.xml deleted file mode 100644 index 36c649a655..0000000000 --- a/reference/gmagick/gmagick/quantizeimages.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - Gmagick::quantizeimages - Le but de quantizeimages - - - - &reftitle.description; - - public GmagickGmagick::quantizeimages - intnumColors - intcolorspace - inttreeDepth - booldither - boolmeasureError - - - Analyse les couleurs d'une séquence d'images et choisit un nombre fixe - de couleurs pour représenter l'image. Le but de cet algorithme est de minimiser - les différences de couleurs entre l'image d'entrée et celle de sortie lors - d'un processus d'optimisation. - - - - - &reftitle.parameters; - - - numColors - - - Le nombre de couleurs. - - - - - colorspace - - - Effectue une réduction de couleur dans cet espace de couleur, - habituellement, RGBColorspace. - - - - - treeDepth - - - Normalement, cet entier vaut zéro ou un. Ces valeurs indiquent au Quantize - de choisir une profondeur d'arbre optimale de Log4(number_colors). Un arbre de - cette profondeur autorise généralement la meilleure représentation de l'image - de référence, avec un minimum de mémoire, et une rapidité d'exécution optimale. - Dans certains cas, comme une image avec peu de dispersion de couleurs (un nombre - peu élevé de couleurs), une valeur autre que Log4(number_colors) est nécessaire. - Pour étendre l'arbre des couleurs complètement, il convient d'utiliser la valeur 8. - - - - - dither - - - Une valeur autre que 0 distribue la différence entre l'image originale et la couleur - correspondante réduite par l'algorithme aux pixels voisins le long d'une courbe - Hilbert. - - - - - measureError - - - Une valeur autre que 0 mesure la différence entre l'image originale et celle quantifiée. - La différence représente les erreurs de quantification. L'erreur est calculée en faisant - la somme de tous les pixels dans une image carrée de la distance dans l'espace RVB entre - chaque valeur de pixel de référence et sa valeur quantifiée. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/queryfontmetrics.xml b/reference/gmagick/gmagick/queryfontmetrics.xml deleted file mode 100644 index 80dd9ab164..0000000000 --- a/reference/gmagick/gmagick/queryfontmetrics.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gmagick::queryfontmetrics - Retourne un tableau représentant la métrique pour la police de caractères - - - - &reftitle.description; - - public arrayGmagick::queryfontmetrics - GmagickDrawdraw - stringtext - - - MagickQueryFontMetrics() retourne un tableau représentant la métrique pour la police de caractères. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Gmagick en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/queryfonts.xml b/reference/gmagick/gmagick/queryfonts.xml deleted file mode 100644 index d83c7a6280..0000000000 --- a/reference/gmagick/gmagick/queryfonts.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::queryfonts - Retourne les polices de caractères configurées - - - - &reftitle.description; - - public arrayGmagick::queryfonts - stringpattern"*" - - - Retourne les polices de caractères supportées par Gmagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Gmagick en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/queryformats.xml b/reference/gmagick/gmagick/queryformats.xml deleted file mode 100644 index 55c2803a3f..0000000000 --- a/reference/gmagick/gmagick/queryformats.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Gmagick::queryformats - Retourne les formats supportés par Gmagick - - - - &reftitle.description; - - public arrayGmagick::queryformats - stringpattern"*" - - - Retourne les formats supportés par Gmagick. - - - - - &reftitle.parameters; - - - pattern - - - Spécifie un string contenant un masque. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/radialblurimage.xml b/reference/gmagick/gmagick/radialblurimage.xml deleted file mode 100644 index 9d621f6a16..0000000000 --- a/reference/gmagick/gmagick/radialblurimage.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - Gmagick::radialblurimage - Brouille une image suivant un rayon - - - - &reftitle.description; - - public GmagickGmagick::radialblurimage - floatangle - intchannelGmagick::CHANNEL_DEFAULT - - - Brouille une image suivant un rayon. - - - - - &reftitle.parameters; - - - angle - - - L'angle de brouillage, en degrés. - - - - - channel - - - Canal concerné. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/raiseimage.xml b/reference/gmagick/gmagick/raiseimage.xml deleted file mode 100644 index bc8d3478f2..0000000000 --- a/reference/gmagick/gmagick/raiseimage.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - Gmagick::raiseimage - Crée un bouton avec un effet 3D - - - - &reftitle.description; - - public GmagickGmagick::raiseimage - intwidth - intheight - intx - inty - boolraise - - - Crée un bouton avec un effet 3D en éclaircissant et en noircissant les angles - de l'image. La hauteur et la largeur des membres de raise_info - définissent la largeur du coin vertical et horizontal de l'effet. - - - - - &reftitle.parameters; - - - width - - - Largeur de la zone à traiter. - - - - - height - - - Hauteur de la zone à traiter. - - - - - x - - - Coordonnée en X. - - - - - y - - - Coordonnée en Y. - - - - - raise - - - Une valeur, autre que 0, pour créer l'effet 3D, sinon, l'effet sera amoindri. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/read.xml b/reference/gmagick/gmagick/read.xml deleted file mode 100644 index 7124bf48c6..0000000000 --- a/reference/gmagick/gmagick/read.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::read - Lit une image depuis un fichier - - - - &reftitle.description; - - public GmagickGmagick::read - stringfilename - - - Lit une image depuis un fichier. - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier image. - - - - - - - - &reftitle.returnvalues; - - Un objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/readimage.xml b/reference/gmagick/gmagick/readimage.xml deleted file mode 100644 index f8f89b5038..0000000000 --- a/reference/gmagick/gmagick/readimage.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::readimage - Lit une image depuis un fichier - - - - &reftitle.description; - - public GmagickGmagick::readimage - stringfilename - - - Lit une image depuis un fichier. - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier image. - - - - - - - - &reftitle.returnvalues; - - Un objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/readimageblob.xml b/reference/gmagick/gmagick/readimageblob.xml deleted file mode 100644 index 6df73fd1df..0000000000 --- a/reference/gmagick/gmagick/readimageblob.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::readimageblob - Lit une image depuis une chaîne binaire - - - - &reftitle.description; - - public GmagickGmagick::readimageblob - stringimageContents - stringfilename - - - Lit une image depuis une chaîne binaire. - - - - - &reftitle.parameters; - - - imageContents - - - Contenu de l'image. - - - - - filename - - - Le nom du fichier image. - - - - - - - - &reftitle.returnvalues; - - Un objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/readimagefile.xml b/reference/gmagick/gmagick/readimagefile.xml deleted file mode 100644 index 2551340ca7..0000000000 --- a/reference/gmagick/gmagick/readimagefile.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::readimagefile - Le but de readimagefile - - - - &reftitle.description; - - public GmagickGmagick::readimagefile - resourcefp - stringfilename - - - Lit une image ou une séquence d'images depuis un descripteur de fichier ouvert. - - - - - &reftitle.parameters; - - - fp - - - Le descripteur de fichier. - - - - - - - - &reftitle.returnvalues; - - Un objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/reducenoiseimage.xml b/reference/gmagick/gmagick/reducenoiseimage.xml deleted file mode 100644 index 7dbe413913..0000000000 --- a/reference/gmagick/gmagick/reducenoiseimage.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - Gmagick::reducenoiseimage - Lisse les contours de l'image - - - - &reftitle.description; - - public GmagickGmagick::reducenoiseimage - floatradius - - - Lisse les contours de l'image tout en conservant les - informations des coins. L'algorithme fonctionne en - remplaçant chaque pixel avec son voisin le plus proche - de sa valeur. Un voisin est défini par son rayon. - En utilisant un rayon de 0, la méthode Gmagick::reducenoiseimage - sélectionnera un rayon approprié automatiquement. - - - - - &reftitle.parameters; - - - radius - - - Le rayon du pixel voisin. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/removeimage.xml b/reference/gmagick/gmagick/removeimage.xml deleted file mode 100644 index ba33d330c8..0000000000 --- a/reference/gmagick/gmagick/removeimage.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::removeimage - Supprime une image depuis la liste des images - - - - &reftitle.description; - - public GmagickGmagick::removeimage - - - - Supprime une image depuis la liste des images. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/removeimageprofile.xml b/reference/gmagick/gmagick/removeimageprofile.xml deleted file mode 100644 index 3e378f71cc..0000000000 --- a/reference/gmagick/gmagick/removeimageprofile.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::removeimageprofile - Supprime un profil nommé de l'image - - - - &reftitle.description; - - public stringGmagick::removeimageprofile - stringname - - - Supprime un profil nommé de l'image. - - - - - &reftitle.parameters; - - - name - - - Nom du profil à retourner : ICC, IPTC, ou un profil générique. - - - - - - - - &reftitle.returnvalues; - - Le profil nommé - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/resampleimage.xml b/reference/gmagick/gmagick/resampleimage.xml deleted file mode 100644 index df7346e4a3..0000000000 --- a/reference/gmagick/gmagick/resampleimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - Gmagick::resampleimage - Échantillonne l'image à la résolution désirée - - - - &reftitle.description; - - public GmagickGmagick::resampleimage - floatxResolution - floatyResolution - intfilter - floatblur - - - Échantillonne l'image à la résolution désirée. - - - - - &reftitle.parameters; - - - xResolution - - - La nouvelle résolution en X de l'image. - - - - - yResolution - - - La nouvelle résolution en Y de l'image. - - - - - filter - - - Filtre de l'image à utiliser. - - - - - blur - - - Le facteur de flou où la valeur supérieure à 1 correspond à - entièrement flou, et la valeur inférieure à 1, l'inverse. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/resizeimage.xml b/reference/gmagick/gmagick/resizeimage.xml deleted file mode 100644 index 423ad54cd6..0000000000 --- a/reference/gmagick/gmagick/resizeimage.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - Gmagick::resizeimage - Redimensionne une image - - - - &reftitle.description; - - public GmagickGmagick::resizeimage - intwidth - intheight - intfilter - floatblur - boolfit&false; - - - Redimensionne une image aux dimensions voulues, avec un filtre. - - - - - - &reftitle.parameters; - - - width - - - Le nombre de colonnes dans l'image redimensionnée. - - - - - height - - - Le nombre de lignes dans l'image redimensionnée. - - - - - filter - - - Le filtre de l'image à utiliser. - - - - - blur - - - Le facteur de flou, où les valeurs supérieures à 1 correspondent - à entièrement flou, et les valeurs inférieures à 1, l'inverse. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/rollimage.xml b/reference/gmagick/gmagick/rollimage.xml deleted file mode 100644 index 4d86cdd622..0000000000 --- a/reference/gmagick/gmagick/rollimage.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Gmagick::rollimage - Repositionne une image - - - - &reftitle.description; - - public GmagickGmagick::rollimage - intx - inty - - - Repositionne une image en utilisant les paramètres - x et y. - - - - - &reftitle.parameters; - - - x - - - La position en X. - - - - - y - - - La position en Y. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/rotateimage.xml b/reference/gmagick/gmagick/rotateimage.xml deleted file mode 100644 index 2812ea5be1..0000000000 --- a/reference/gmagick/gmagick/rotateimage.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Gmagick::rotateimage - Effectue une rotation de l'image - - - - &reftitle.description; - - public GmagickGmagick::rotateimage - mixedcolor - floatdegrees - - - Effectue une rotation de l'image d'un degré spécifié. Les triangles vides - non traités par la rotation seront remplis par la couleur d'arrière-plan. - - - - - &reftitle.parameters; - - - color - - - Le pixel d'arrière-plan. - - - - - degrees - - - Le degré de rotation de l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/scaleimage.xml b/reference/gmagick/gmagick/scaleimage.xml deleted file mode 100644 index 27b0c9c478..0000000000 --- a/reference/gmagick/gmagick/scaleimage.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::scaleimage - Met à l'échelle une image - - - - &reftitle.description; - - public GmagickGmagick::scaleimage - intwidth - intheight - boolfit&false; - - - Met à l'échelle une image aux dimensions fournies. Les autres paramètres - seront calculés si 0 est passé en tant que paramètre. - - - - - &reftitle.parameters; - - - width - - - Le nombre de colonnes dans l'image mise à l'échelle. - - - - - height - - - Le nombre de lignes dans l'image mise à l'échelle. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/separateimagechannel.xml b/reference/gmagick/gmagick/separateimagechannel.xml deleted file mode 100644 index 7ee81a80e2..0000000000 --- a/reference/gmagick/gmagick/separateimagechannel.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::separateimagechannel - Sépare un canal depuis une image - - - - &reftitle.description; - - public GmagickGmagick::separateimagechannel - intchannel - - - Sépare un canal depuis une image et retourne une image en niveaux de gris. - Un canal est un composant d'une couleur particulière de chaque pixel d'une image. - - - - - &reftitle.parameters; - - - channel - - - Une des constantes de canaux - (Gmagick::CHANNEL_*). - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setcompressionquality.xml b/reference/gmagick/gmagick/setcompressionquality.xml deleted file mode 100644 index f4115d00a4..0000000000 --- a/reference/gmagick/gmagick/setcompressionquality.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Gmagick::setCompressionQuality - Définit la qualité de compression par défaut de l'objet - - - - &reftitle.description; - - GmagickGmagick::setCompressionQuality - - intquality - - - - Définit la qualité de compression par défaut de l'objet. - - - - - &reftitle.parameters; - - - quality - - - La valeur par défaut de GraphicsMagick est 75. - - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - &reftitle.examples; - - Exemple avec <function>Gmagick::setCompressionQuality</function> - - read("magick:rose"); -$gm->setCompressionQuality(2); -?> -]]> - - - - - - diff --git a/reference/gmagick/gmagick/setfilename.xml b/reference/gmagick/gmagick/setfilename.xml deleted file mode 100644 index f2e1cd20f6..0000000000 --- a/reference/gmagick/gmagick/setfilename.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - Gmagick::setfilename - Définit le nom de fichier avant la lecture ou l'écriture d'une image - - - - &reftitle.description; - - public GmagickGmagick::setfilename - stringfilename - - - Définit le nom de fichier avant la lecture ou l'écriture d'une image. - - - - - &reftitle.parameters; - - - filename - - - Le nom de fichier de l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimagebackgroundcolor.xml b/reference/gmagick/gmagick/setimagebackgroundcolor.xml deleted file mode 100644 index fc4e7d0237..0000000000 --- a/reference/gmagick/gmagick/setimagebackgroundcolor.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Gmagick::setimagebackgroundcolor - Définit la couleur d'arrière-plan de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimagebackgroundcolor - GmagickPixelcolor - - - Définit la couleur d'arrière-plan de l'image. - - - - - &reftitle.parameters; - - - color - - - La couleur d'arrière-plan. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageblueprimary.xml b/reference/gmagick/gmagick/setimageblueprimary.xml deleted file mode 100644 index a9b6f33ac5..0000000000 --- a/reference/gmagick/gmagick/setimageblueprimary.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::setimageblueprimary - Définit le point bleu primaire de l'image chromatique - - - - &reftitle.description; - - public GmagickGmagick::setimageblueprimary - floatx - floaty - - - Définit le point bleu primaire de l'image chromatique. - - - - - &reftitle.parameters; - - - x - - - Coordonnée en X du point du bleu primaire. - - - - - y - - - Coordonnée en Y du point du bleu primaire. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagebordercolor.xml b/reference/gmagick/gmagick/setimagebordercolor.xml deleted file mode 100644 index 12bb625676..0000000000 --- a/reference/gmagick/gmagick/setimagebordercolor.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimagebordercolor - Définit la couleur de la bordure de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimagebordercolor - GmagickPixelcolor - - - Définit la couleur de la bordure de l'image. - - - - - &reftitle.parameters; - - - color - - - La couleur de la bordure. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagechanneldepth.xml b/reference/gmagick/gmagick/setimagechanneldepth.xml deleted file mode 100644 index e1c998cc2c..0000000000 --- a/reference/gmagick/gmagick/setimagechanneldepth.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Gmagick::setimagechanneldepth - Définit la profondeur d'un canal particulier de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimagechanneldepth - intchannel - intdepth - - - Définit la profondeur d'un canal particulier de l'image. - - - - - &reftitle.parameters; - - - channel - - - Une des constantes de canaux - (Gmagick::CHANNEL_*). - - - - - depth - - - La profondeur de l'image, en bits. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagecolorspace.xml b/reference/gmagick/gmagick/setimagecolorspace.xml deleted file mode 100644 index e46694534b..0000000000 --- a/reference/gmagick/gmagick/setimagecolorspace.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::setimagecolorspace - Définit l'espace de couleurs de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimagecolorspace - intcolorspace - - - Définit l'espace de couleurs de l'image. - - - - - &reftitle.parameters; - - - colorspace - - - Une des constantes d'espace de couleurs de l'image - (Gmagick::COLORSPACE_*). - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagecompose.xml b/reference/gmagick/gmagick/setimagecompose.xml deleted file mode 100644 index bfa3751114..0000000000 --- a/reference/gmagick/gmagick/setimagecompose.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimagecompose - Définit l'opérateur de composition de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimagecompose - intcomposite - - - Définit l'opérateur de composition de l'image. - - - - - &reftitle.parameters; - - - composite - - - L'opérateur de composition de l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagedelay.xml b/reference/gmagick/gmagick/setimagedelay.xml deleted file mode 100644 index 0ddd8612b5..0000000000 --- a/reference/gmagick/gmagick/setimagedelay.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimagedelay - Définit le délai de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimagedelay - intdelay - - - Définit le délai de l'image. - - - - - &reftitle.parameters; - - - delay - - - Le délai de l'image, au 1/100ème de seconde. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagedepth.xml b/reference/gmagick/gmagick/setimagedepth.xml deleted file mode 100644 index 5739dbdbcf..0000000000 --- a/reference/gmagick/gmagick/setimagedepth.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::setimagedepth - Définit la profondeur de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimagedepth - intdepth - - - Définit la profondeur de l'image. - - - - - - &reftitle.parameters; - - - depth - - - La profondeur de l'image, en bits : 8, 16, ou 32. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagedispose.xml b/reference/gmagick/gmagick/setimagedispose.xml deleted file mode 100644 index 3906d80126..0000000000 --- a/reference/gmagick/gmagick/setimagedispose.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Gmagick::setimagedispose - Définit la méthode de disposition de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimagedispose - intdisposeType - - - Définit la méthode de disposition de l'image. - - - - - &reftitle.parameters; - - - disposeType - - - Le type de disposition de l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimagefilename.xml b/reference/gmagick/gmagick/setimagefilename.xml deleted file mode 100644 index 08dbed526d..0000000000 --- a/reference/gmagick/gmagick/setimagefilename.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Gmagick::setimagefilename - Définit le nom du fichier pour une image particulière d'une séquence - - - - &reftitle.description; - - public GmagickGmagick::setimagefilename - stringfilename - - - Définit le nom du fichier pour une image particulière d'une séquence. - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier de l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimageformat.xml b/reference/gmagick/gmagick/setimageformat.xml deleted file mode 100644 index a15e511f23..0000000000 --- a/reference/gmagick/gmagick/setimageformat.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Gmagick::setimageformat - Définit le format d'une image - - - - &reftitle.description; - - public GmagickGmagick::setimageformat - stringimageFormat - - - Définit le format d'une image particulière d'une séquence. - - - - - &reftitle.parameters; - - - imageFormat - - - Le format de l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimagegamma.xml b/reference/gmagick/gmagick/setimagegamma.xml deleted file mode 100644 index 37ca759e94..0000000000 --- a/reference/gmagick/gmagick/setimagegamma.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimagegamma - Définit le gamma de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimagegamma - floatgamma - - - Définit le gamma de l'image. - - - - - &reftitle.parameters; - - - gamma - - - Le gamma de l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagegreenprimary.xml b/reference/gmagick/gmagick/setimagegreenprimary.xml deleted file mode 100644 index f3bce1279b..0000000000 --- a/reference/gmagick/gmagick/setimagegreenprimary.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::setimagegreenprimary - Définit le point vert sur l'image chromatique primaire - - - - &reftitle.description; - - public GmagickGmagick::setimagegreenprimary - floatx - floaty - - - Définit le point vert sur l'image chromatique primaire. - - - - - &reftitle.parameters; - - - x - - - Coordonnée en X du point vert de l'image chromatique. - - - - - y - - - Coordonnée en Y du point vert de l'image chromatique. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageindex.xml b/reference/gmagick/gmagick/setimageindex.xml deleted file mode 100644 index 24fd29b23d..0000000000 --- a/reference/gmagick/gmagick/setimageindex.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimageindex - Définit l'itérateur à la position spécifiée dans l'image de la liste pointée par son index - - - - &reftitle.description; - - public GmagickGmagick::setimageindex - intindex - - - Définit l'itérateur à la position spécifiée dans l'image de la liste pointée par son index. - - - - - &reftitle.parameters; - - - index - - - Le numéro de la scène. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageinterlacescheme.xml b/reference/gmagick/gmagick/setimageinterlacescheme.xml deleted file mode 100644 index 089a7efc78..0000000000 --- a/reference/gmagick/gmagick/setimageinterlacescheme.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimageinterlacescheme - Définit le schéma d'entrelacement de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimageinterlacescheme - intinterlace - - - Définit le schéma d'entrelacement de l'image. - - - - - &reftitle.parameters; - - - interlace - - - Une des constantes des schémas d'entrelacement de l'image - (Gmagick::INTERLACE_*). - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimageiterations.xml b/reference/gmagick/gmagick/setimageiterations.xml deleted file mode 100644 index 7e30b4657f..0000000000 --- a/reference/gmagick/gmagick/setimageiterations.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimageiterations - Définit les itérations de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimageiterations - intiterations - - - Définit les itérations de l'image. - - - - - &reftitle.parameters; - - - iterations - - - Le délai de l'image au 1/100ème de seconde. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageprofile.xml b/reference/gmagick/gmagick/setimageprofile.xml deleted file mode 100644 index fee9ab4003..0000000000 --- a/reference/gmagick/gmagick/setimageprofile.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - Gmagick::setimageprofile - Ajoute un profil nommé à l'objet Gmagick - - - - &reftitle.description; - - public GmagickGmagick::setimageprofile - stringname - stringprofile - - - Ajoute un profil nommé à l'objet Gmagick. Si un profil avec le même - nom existe déjà, il sera remplacé. Cette méthode diffère de la méthode - Gmagick::profileImage() dans le fait qu'elle n'applique aucun profil de couleur CMS. - - - - - &reftitle.parameters; - - - name - - - Nom du profil à ajouter ou à effacer : ICC, IPTC, ou un profil générique. - - - - - profile - - - Le profil. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageredprimary.xml b/reference/gmagick/gmagick/setimageredprimary.xml deleted file mode 100644 index 5228f85ffb..0000000000 --- a/reference/gmagick/gmagick/setimageredprimary.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::setimageredprimary - Définit le point rouge sur l'image chromatique primaire - - - - &reftitle.description; - - public GmagickGmagick::setimageredprimary - floatx - floaty - - - Définit le point rouge sur l'image chromatique primaire. - - - - - &reftitle.parameters; - - - x - - - Coordonnée en X du point rouge de l'image chromatique. - - - - - y - - - Coordonnée en Y du point rouge de l'image chromatique. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagerenderingintent.xml b/reference/gmagick/gmagick/setimagerenderingintent.xml deleted file mode 100644 index 589b8bf240..0000000000 --- a/reference/gmagick/gmagick/setimagerenderingintent.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::setimagerenderingintent - Définit l'image de rendu - - - - &reftitle.description; - - public GmagickGmagick::setimagerenderingintent - intrendering_intent - - - Définit l'image de rendu. - - - - - &reftitle.parameters; - - - rendering_intent - - - Une des constantes de rendu d'image - (Gmagick::RENDERINGINTENT_*). - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageresolution.xml b/reference/gmagick/gmagick/setimageresolution.xml deleted file mode 100644 index 10c35c59a1..0000000000 --- a/reference/gmagick/gmagick/setimageresolution.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::setimageresolution - Définit la résolution de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimageresolution - floatxResolution - floatyResolution - - - Définit la résolution de l'image. - - - - - &reftitle.parameters; - - - xResolution - - - La résolution en X de l'image. - - - - - yResolution - - - La résolution en Y de l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick en cas de succès. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagescene.xml b/reference/gmagick/gmagick/setimagescene.xml deleted file mode 100644 index ded1d55f8f..0000000000 --- a/reference/gmagick/gmagick/setimagescene.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimagescene - Définit l'image de scène - - - - &reftitle.description; - - public GmagickGmagick::setimagescene - intscene - - - Définit l'image de scène. - - - - - &reftitle.parameters; - - - scene - - - Le numéro de la scène dans l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagetype.xml b/reference/gmagick/gmagick/setimagetype.xml deleted file mode 100644 index 6b7e8e72cc..0000000000 --- a/reference/gmagick/gmagick/setimagetype.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::setimagetype - Définit le type de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimagetype - intimgType - - - Définit le type de l'image. - - - - - &reftitle.parameters; - - - imgType - - - Une des constantes de type d'image - (Gmagick::IMGTYPE_*). - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageunits.xml b/reference/gmagick/gmagick/setimageunits.xml deleted file mode 100644 index d7dde46f39..0000000000 --- a/reference/gmagick/gmagick/setimageunits.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::setimageunits - Définit les unités à utiliser pour la résolution de l'image - - - - &reftitle.description; - - public GmagickGmagick::setimageunits - intresolution - - - Définit les unités à utiliser pour la résolution de l'image. - - - - - &reftitle.parameters; - - - resolution - - - Une des constantes de résolution - (Gmagick::RESOLUTION_*). - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagewhitepoint.xml b/reference/gmagick/gmagick/setimagewhitepoint.xml deleted file mode 100644 index feb24ab75d..0000000000 --- a/reference/gmagick/gmagick/setimagewhitepoint.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::setimagewhitepoint - Définit le point blanc sur l'image chromatique primaire - - - - &reftitle.description; - - public GmagickGmagick::setimagewhitepoint - floatx - floaty - - - Définit le point blanc sur l'image chromatique primaire. - - - - - &reftitle.parameters; - - - x - - - Coordonnée en X du point blanc de l'image chromatique. - - - - - y - - - Coordonnée en Y du point blanc de l'image chromatique. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setsamplingfactors.xml b/reference/gmagick/gmagick/setsamplingfactors.xml deleted file mode 100644 index e28d6780dc..0000000000 --- a/reference/gmagick/gmagick/setsamplingfactors.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Gmagick::setsamplingfactors - Définit les facteurs d'échantillonnage de l'image - - - - &reftitle.description; - - public GmagickGmagick::setsamplingfactors - arrayfactors - - - Définit les facteurs d'échantillonnage de l'image. - - - - - &reftitle.parameters; - - - factors - - - Un tableau de floats, représentant le facteur d'échantillonnage - pour chaque composant de couleur (dans l'ordre RVB). - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setsize.xml b/reference/gmagick/gmagick/setsize.xml deleted file mode 100644 index 8aa29d40ea..0000000000 --- a/reference/gmagick/gmagick/setsize.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Gmagick::setsize - Définit la taille de l'objet Gmagick - - - - &reftitle.description; - - public GmagickGmagick::setsize - intcolumns - introws - - - Définit la taille de l'objet Gmagick. Cette taille doit être définie - avant de lire une image brute au format Gmagick::COLORSPACE_RGB, Gmagick::COLORSPACE_GRAY, ou Gmagick::COLORSPACE_CMYK. - - - - - &reftitle.parameters; - - - columns - - - La largeur, en pixels. - - - - - rows - - - La hauteur, en pixels. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/shearimage.xml b/reference/gmagick/gmagick/shearimage.xml deleted file mode 100644 index bd67da58ed..0000000000 --- a/reference/gmagick/gmagick/shearimage.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - Gmagick::shearimage - Crée un parallélogramme - - - - &reftitle.description; - - public GmagickGmagick::shearimage - mixedcolor - floatxShear - floatyShear - - - Bouge un coin de l'image le long des axes X ou Y pour créer un parallélogramme. - Une direction en X bouge le long de l'axe X, tandis qu'une direction en Y bouge le long - de l'axe Y. La quantité de cisaillement est contrôlée par un angle de cisaillement. Pour - les cisaillements en direction X, x_shear est mesuré relativement à l'axe Y, et inversement, - pour les cisaillements en direction Y, y_shear est mesuré relativement à l'axe X. Les triangles vides - ainsi créés lors du cisaillement de l'image seront remplis par la couleur d'arrière-plan. - - - - - &reftitle.parameters; - - - color - - - Le pixel d'arrière-plan. - - - - - xShear - - - Le degré de cisaillement de l'image. - - - - - yShear - - - Le degré de cisaillement de l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/solarizeimage.xml b/reference/gmagick/gmagick/solarizeimage.xml deleted file mode 100644 index ea7fc309c3..0000000000 --- a/reference/gmagick/gmagick/solarizeimage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Gmagick::solarizeimage - Applique un effet de solarisation à l'image - - - - &reftitle.description; - - public GmagickGmagick::solarizeimage - intthreshold - - - Applique un effet de solarisation à l'image, similaire à l'effet créé dans - une photo en chambre noire, en exposant les zones d'une photo sur papier sensitif - à la lumière. Le seuil varie de 0 à QuantumRange et est une mesure de l'étendue de la - solarisation. - - - - - &reftitle.parameters; - - - threshold - - - Définit l'étendue de la solarisation. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/spreadimage.xml b/reference/gmagick/gmagick/spreadimage.xml deleted file mode 100644 index c5f9da8e1b..0000000000 --- a/reference/gmagick/gmagick/spreadimage.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::spreadimage - Déplace aléatoirement chaque pixel d'un bloc - - - - &reftitle.description; - - public GmagickGmagick::spreadimage - floatradius - - - Effet spécial qui déplace aléatoirement chaque pixel d'un bloc défini - par le paramètre radius. - - - - - &reftitle.parameters; - - - radius - - - Choisit des pixels aléatoirement dans le voisinage de cette étendue. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/stripimage.xml b/reference/gmagick/gmagick/stripimage.xml deleted file mode 100644 index 9f2cbfed49..0000000000 --- a/reference/gmagick/gmagick/stripimage.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::stripimage - Supprime d'une image tous les profils et tous les commentaires - - - - &reftitle.description; - - public GmagickGmagick::stripimage - - - - Supprime d'une image tous les profils et tous les commentaires. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/swirlimage.xml b/reference/gmagick/gmagick/swirlimage.xml deleted file mode 100644 index fb55ec69d6..0000000000 --- a/reference/gmagick/gmagick/swirlimage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - Gmagick::swirlimage - Remous les pixels du centre de l'image - - - - &reftitle.description; - - public GmagickGmagick::swirlimage - floatdegrees - - - Remous les pixels du centre de l'image, où les degrés indiquent l'arc de remous autour duquel - les pixels sont déplacés. Il est possible d'obtenir un effet de plus en plus soutenu - en modifiant les degrés de 1 à 360. - - - - - &reftitle.parameters; - - - degrees - - - Définit la finesse de l'effet de remous. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/thumbnailimage.xml b/reference/gmagick/gmagick/thumbnailimage.xml deleted file mode 100644 index d88f491a26..0000000000 --- a/reference/gmagick/gmagick/thumbnailimage.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - Gmagick::thumbnailimage - Modifie la taille d'une image - - - - &reftitle.description; - - public GmagickGmagick::thumbnailimage - intwidth - intheight - boolfit&false; - - - Modifie la taille d'une image aux dimensions données et supprime les profils associés. - Le but est de produire une image miniature, moins lourde, aux fins d'affichage sur le Web. - Si &true; est fourni comme valeur du 3ème paramètre, alors les paramètres width - et height sont utilisés comme valeurs maximales pour chaque côté. - Les 2 côtés seront mis à l'échelle lors de l'opération. - - - - - &reftitle.parameters; - - - width - - - largeur de l'image. - - - - - height - - - Hauteur de l'image. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/trimimage.xml b/reference/gmagick/gmagick/trimimage.xml deleted file mode 100644 index 729affe101..0000000000 --- a/reference/gmagick/gmagick/trimimage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Gmagick::trimimage - Supprime les coins de l'image - - - - &reftitle.description; - - public GmagickGmagick::trimimage - floatfuzz - - - Supprime les coins qui sont de la couleur de l'arrière-plan depuis l'image. - - - - - &reftitle.parameters; - - - fuzz - - - Par défaut, la cible doit correspondre exactement à la couleur du pixel précis. - Cependant, dans beaucoup de cas, 2 couleurs peuvent différer très légèrement. - Ce paramètre indique donc la tolérance acceptable à considérer 2 couleurs - comme identiques. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/write.xml b/reference/gmagick/gmagick/write.xml deleted file mode 100644 index 3f93f73f78..0000000000 --- a/reference/gmagick/gmagick/write.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - Gmagick::write - &Alias; Gmagick::writeimage - - - - &reftitle.description; - - &info.method.alias; Gmagick::writeimage. - - - - - - diff --git a/reference/gmagick/gmagick/writeimage.xml b/reference/gmagick/gmagick/writeimage.xml deleted file mode 100644 index 9d3c156544..0000000000 --- a/reference/gmagick/gmagick/writeimage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Gmagick::writeimage - Écrit une image dans un fichier - - - - &reftitle.description; - - public GmagickGmagick::writeimage - stringfilename - boolall_frames&false; - - - Écrit une image dans un fichier spécifique. Si le paramètre - filename vaut &null;, l'image - sera écrite dans le fichier défini par la méthode Gmagick::readimage - ou la méthode Gmagick::setimagefilename. - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier. - - - - - - - - &reftitle.returnvalues; - - L'objet Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagickdraw.xml b/reference/gmagick/gmagickdraw.xml deleted file mode 100644 index 10399a5e2d..0000000000 --- a/reference/gmagick/gmagickdraw.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - La classe GmagickDraw - GmagickDraw - - - - -
- &reftitle.intro; - - -
- - -
- &reftitle.classsynopsis; - - - - GmagickDraw - - - - - GmagickDraw - - - - - &Methods; - - - - -
- - - - &reference.gmagick.entities.gmagickdraw; - - - diff --git a/reference/gmagick/gmagickdraw/annotate.xml b/reference/gmagick/gmagickdraw/annotate.xml deleted file mode 100644 index fc71da0356..0000000000 --- a/reference/gmagick/gmagickdraw/annotate.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - GmagickDraw::annotate - Dessine un texte sur l'image - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::annotate - floatx - floaty - stringtext - - - Dessine un texte sur l'image. - - - - - &reftitle.parameters; - - - x - - - Coordonnée en X de la gauche du texte. - - - - - y - - - Coordonnée en Y de la base du texte. - - - - - text - - - Le texte à dessiner. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/arc.xml b/reference/gmagick/gmagickdraw/arc.xml deleted file mode 100644 index b2aa10ec2e..0000000000 --- a/reference/gmagick/gmagickdraw/arc.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - GmagickDraw::arc - Dessine un arc - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::arc - floatsx - floatsy - floatex - floatey - floatsd - floated - - - Dessine un arc dans un rectangle spécifié sur l'image. - - - - - &reftitle.parameters; - - - sx - - - Coordonnée en X du début du rectangle conteneur. - - - - - sy - - - Coordonnée en Y du début du rectangle conteneur. - - - - - ex - - - Coordonnée en X de la fin du rectangle conteneur. - - - - - ey - - - Coordonnée en Y de la fin du rectangle conteneur. - - - - - sd - - - Degré de départ de la rotation. - - - - - ed - - - Degré de fin de la rotation. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - diff --git a/reference/gmagick/gmagickdraw/bezier.xml b/reference/gmagick/gmagickdraw/bezier.xml deleted file mode 100644 index fbc29332f8..0000000000 --- a/reference/gmagick/gmagickdraw/bezier.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - GmagickDraw::bezier - Dessine une courbe de Bézier - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::bezier - arraycoordinate_array - - - Dessine une courbe de Bézier sur un jeu de points de l'image. - - - - - &reftitle.parameters; - - - coordinate_array - - - Tableau de coordonnées - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/ellipse.xml b/reference/gmagick/gmagickdraw/ellipse.xml deleted file mode 100644 index c1174391e9..0000000000 --- a/reference/gmagick/gmagickdraw/ellipse.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - GmagickDraw::ellipse - Dessine une ellipse sur l'image - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::ellipse - floatox - floatoy - floatrx - floatry - floatstart - floatend - - - Dessine une ellipse sur l'image. - - - - - &reftitle.parameters; - - - ox - - - Coordonnée en X d'origine. - - - - - oy - - - Coordonnée en Y d'origine. - - - - - rx - - - Rayon en X. - - - - - ry - - - Rayon en Y. - - - - - start - - - Rotation de départ, en degrés. - - - - - end - - - Rotation de fin, en degrés. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - - diff --git a/reference/gmagick/gmagickdraw/getfillcolor.xml b/reference/gmagick/gmagickdraw/getfillcolor.xml deleted file mode 100644 index 9416452b7e..0000000000 --- a/reference/gmagick/gmagickdraw/getfillcolor.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - GmagickDraw::getfillcolor - Retourne la couleur de remplissage - - - - &reftitle.description; - - public GmagickPixelGmagickDraw::getfillcolor - - - - Retourne la couleur de remplissage utilisée pour dessiner - les objets pleins. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La couleur de remplissage GmagickPixel utilisée pour dessiner les objets pleins. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfillopacity.xml b/reference/gmagick/gmagickdraw/getfillopacity.xml deleted file mode 100644 index e0f93c10fd..0000000000 --- a/reference/gmagick/gmagickdraw/getfillopacity.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - GmagickDraw::getfillopacity - Retourne l'opacité utilisée lors d'un dessin - - - - &reftitle.description; - - public floatGmagickDraw::getfillopacity - - - - Retourne l'opacité utilisée lors d'un dessin. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'opacité utilisée lors d'un dessin utilisant une couleur - de remplissage ou une texture de remplissage. - Pour une opacité totalement opaque, la valeur 1.0 doit être utilisée. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfont.xml b/reference/gmagick/gmagickdraw/getfont.xml deleted file mode 100644 index a8c8e4de1a..0000000000 --- a/reference/gmagick/gmagickdraw/getfont.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - GmagickDraw::getfont - Retourne la police de caractères - - - - &reftitle.description; - - public mixedGmagickDraw::getfont - - - - Retourne une chaîne spécifiant la police de caractères - utilisée lors d'une annotation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &false; si la police - de caractères n'est pas définie. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfontsize.xml b/reference/gmagick/gmagickdraw/getfontsize.xml deleted file mode 100644 index 4ab29d53f2..0000000000 --- a/reference/gmagick/gmagickdraw/getfontsize.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - GmagickDraw::getfontsize - Retourne la taille du point d'une police de caractères - - - - &reftitle.description; - - public floatGmagickDraw::getfontsize - - - - Retourne la taille du point d'une police de caractères utilisée - lors d'une annotation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la taille de la police de caractères associée avec l'objet - GmagickDraw courant. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfontstyle.xml b/reference/gmagick/gmagickdraw/getfontstyle.xml deleted file mode 100644 index b44e413662..0000000000 --- a/reference/gmagick/gmagickdraw/getfontstyle.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - GmagickDraw::getfontstyle - Retourne le style de la police de caractères - - - - &reftitle.description; - - public intGmagickDraw::getfontstyle - - - - Retourne le style de la police de caractères utilisée - lors d'une annotation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la constante (STYLE_) représentant le style de la police - de caractères associée avec l'objet GmagickDraw ou 0 si le style - n'est pas défini. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfontweight.xml b/reference/gmagick/gmagickdraw/getfontweight.xml deleted file mode 100644 index f4f1dce3cd..0000000000 --- a/reference/gmagick/gmagickdraw/getfontweight.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - GmagickDraw::getfontweight - Retourne le poids de la police de caractères - - - - &reftitle.description; - - public intGmagickDraw::getfontweight - - - - Retourne le poids de la police de caractères utilisée lors - d'une annotation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &integer; en cas de succès, et 0 si le poids n'est pas - défini. - - - - - diff --git a/reference/gmagick/gmagickdraw/getstrokecolor.xml b/reference/gmagick/gmagickdraw/getstrokecolor.xml deleted file mode 100644 index b92ad2381b..0000000000 --- a/reference/gmagick/gmagickdraw/getstrokecolor.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - GmagickDraw::getstrokecolor - Retourne la couleur utilisée pour tracer les contours de l'objet - - - - &reftitle.description; - - public GmagickPixelGmagickDraw::getstrokecolor - - - - Retourne la couleur utilisée pour tracer les contours de l'objet. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un objet GmagickPixel qui décrit la couleur. - - - - - diff --git a/reference/gmagick/gmagickdraw/getstrokeopacity.xml b/reference/gmagick/gmagickdraw/getstrokeopacity.xml deleted file mode 100644 index 2612a0f89d..0000000000 --- a/reference/gmagick/gmagickdraw/getstrokeopacity.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - GmagickDraw::getstrokeopacity - Retourne l'opacité du tracé des contours de l'objet - - - - &reftitle.description; - - public floatGmagickDraw::getstrokeopacity - - - - Retourne l'opacité du tracé des contours de l'objet. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un float, décrivant l'opacité. - - - - - diff --git a/reference/gmagick/gmagickdraw/getstrokewidth.xml b/reference/gmagick/gmagickdraw/getstrokewidth.xml deleted file mode 100644 index c291af8111..0000000000 --- a/reference/gmagick/gmagickdraw/getstrokewidth.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - GmagickDraw::getstrokewidth - Retourne la largeur utilisée pour les contours de l'objet - - - - &reftitle.description; - - public floatGmagickDraw::getstrokewidth - - - - Retourne la largeur utilisée pour les contours de l'objet. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un float décrivant la largeur des contours. - - - - - diff --git a/reference/gmagick/gmagickdraw/gettextdecoration.xml b/reference/gmagick/gmagickdraw/gettextdecoration.xml deleted file mode 100644 index d3a903229d..0000000000 --- a/reference/gmagick/gmagickdraw/gettextdecoration.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - GmagickDraw::gettextdecoration - Retourne la décoration du texte - - - - &reftitle.description; - - public intGmagickDraw::gettextdecoration - - - - Retourne la décoration à appliquer à du texte lors d'une annotation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une constante parmi les constantes DECORATION_ - et 0 si aucune décoration n'est définie. - - - - - diff --git a/reference/gmagick/gmagickdraw/gettextencoding.xml b/reference/gmagick/gmagickdraw/gettextencoding.xml deleted file mode 100644 index 1edc53cf52..0000000000 --- a/reference/gmagick/gmagickdraw/gettextencoding.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - GmagickDraw::gettextencoding - Retourne le code du jeu de caractères à utiliser pour les annotations - - - - &reftitle.description; - - public mixedGmagickDraw::gettextencoding - - - - Retourne le code du jeu de caractères à utiliser pour les annotations. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; spécifiant le code du jeu de caractères - ou &false; si l'encodage n'est pas défini. - - - - - diff --git a/reference/gmagick/gmagickdraw/line.xml b/reference/gmagick/gmagickdraw/line.xml deleted file mode 100644 index f40f551afa..0000000000 --- a/reference/gmagick/gmagickdraw/line.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - GmagickDraw::line - Trace une ligne - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::line - floatsx - floatsy - floatex - floatey - - - Trace une ligne sur l'image en utilisant la couleur de contour courante, - l'opacité des contours courante, ainsi que l'épaisseur du contour courant. - - - - - &reftitle.parameters; - - - sx - - - Coordonnée de départ en X. - - - - - sy - - - Coordonnée de départ en Y. - - - - - ex - - - Coordonnée de fin en X. - - - - - ey - - - Coordonnée de fin en Y. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw en cas de succès. - - - - - diff --git a/reference/gmagick/gmagickdraw/point.xml b/reference/gmagick/gmagickdraw/point.xml deleted file mode 100644 index ec79a63f08..0000000000 --- a/reference/gmagick/gmagickdraw/point.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - GmagickDraw::point - Dessine un point - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::point - floatx - floaty - - - Dessine un point en utilisant la couleur et l'épaisseur courants du contour - aux coordonnées spécifiées. - - - - - &reftitle.parameters; - - - x - - - Coordonnée cible en X. - - - - - y - - - Coordonnée cible en Y. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - - diff --git a/reference/gmagick/gmagickdraw/polygon.xml b/reference/gmagick/gmagickdraw/polygon.xml deleted file mode 100644 index 5c26fc092e..0000000000 --- a/reference/gmagick/gmagickdraw/polygon.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - GmagickDraw::polygon - Dessine un polygone - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::polygon - arraycoordinates - - - Dessine un polygone en utilisant les paramètres courants du contour, - la couleur ou la texture de remplissage, et en utilisant le tableau de - coordonnées spécifié. - - - - - &reftitle.parameters; - - - coordinates - - - Tableau de coordonnées. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/polyline.xml b/reference/gmagick/gmagickdraw/polyline.xml deleted file mode 100644 index fde98b9913..0000000000 --- a/reference/gmagick/gmagickdraw/polyline.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - GmagickDraw::polyline - Dessine une polyligne - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::polyline - arraycoordinate_array - - - Dessine une polyligne en utilisant les paramètres courants du contour, - et la couleur ou la texture de remplissage, et en utilisant le tableau de - coordonnées spécifié. - - - - - &reftitle.parameters; - - - coordinate_array - - - Le tableau de coordonnées. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/rectangle.xml b/reference/gmagick/gmagickdraw/rectangle.xml deleted file mode 100644 index 3188c9e57b..0000000000 --- a/reference/gmagick/gmagickdraw/rectangle.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - GmagickDraw::rectangle - Dessine un rectangle - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::rectangle - floatx1 - floaty1 - floatx2 - floaty2 - - - Dessine un rectangle en utilisant 2 coordonnées, et en utilisant - les paramètres de contour et de remplissage courants. - - - - - &reftitle.parameters; - - - x1 - - - Coordonnée en X du premier point. - - - - - y1 - - - Coordonnée en Y du premier point. - - - - - x2 - - - Coordonnée en X du second point. - - - - - y2 - - - Coordonnée en Y du second point. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/rotate.xml b/reference/gmagick/gmagickdraw/rotate.xml deleted file mode 100644 index bd80f1f345..0000000000 --- a/reference/gmagick/gmagickdraw/rotate.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - GmagickDraw::rotate - Applique une rotation - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::rotate - floatdegrees - - - Applique une rotation spécifiée à l'espace courant. - - - - - &reftitle.parameters; - - - degrees - - - Degrés pour la rotation. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/roundrectangle.xml b/reference/gmagick/gmagickdraw/roundrectangle.xml deleted file mode 100644 index 62f35384f3..0000000000 --- a/reference/gmagick/gmagickdraw/roundrectangle.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - GmagickDraw::roundrectangle - Dessine un rectangle arrondi - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::roundrectangle - floatx1 - floaty1 - floatx2 - floaty2 - floatrx - floatry - - - Dessine un rectangle arrondi en utilisant les paramètres fournis. - - - - - &reftitle.parameters; - - - x1 - - - Coordonnée en X du premier point. - - - - - y1 - - - Coordonnée en Y du premier point. - - - - - x2 - - - Coordonnée en X du second point. - - - - - y2 - - - Coordonnée en Y du second point. - - - - - rx - - - Le rayon du coin en direction horizontale. - - - - - ry - - - Le rayon du coin en direction verticale. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/scale.xml b/reference/gmagick/gmagickdraw/scale.xml deleted file mode 100644 index 15db2984bc..0000000000 --- a/reference/gmagick/gmagickdraw/scale.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - GmagickDraw::scale - Ajuste le facteur d'échelle - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::scale - floatx - floaty - - - Ajuste le facteur d'échelle à appliquer aux directions horizontale et verticale - de l'espace courant. - - - - - &reftitle.parameters; - - - x - - - Facteur d'échelle horizontal. - - - - - y - - - Facteur d'échelle vertical. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/setfillcolor.xml b/reference/gmagick/gmagickdraw/setfillcolor.xml deleted file mode 100644 index 0d519520a3..0000000000 --- a/reference/gmagick/gmagickdraw/setfillcolor.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - GmagickDraw::setfillcolor - Définit la couleur de remplissage à utiliser pour dessiner des objets pleins - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfillcolor - mixedcolor - - - Définit la couleur de remplissage à utiliser pour dessiner des objets pleins. - - - - - &reftitle.parameters; - - - color - - - Objet GmagickPixel ou string indiquant la couleur de remplissage. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw en cas de succès. - - - - - diff --git a/reference/gmagick/gmagickdraw/setfillopacity.xml b/reference/gmagick/gmagickdraw/setfillopacity.xml deleted file mode 100644 index c42bb82a03..0000000000 --- a/reference/gmagick/gmagickdraw/setfillopacity.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - GmagickDraw::setfillopacity - Le but de la méthode setfillopacity - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfillopacity - floatfill_opacity - - - Définit l'opacité à utiliser lors d'un dessin en utilisant une couleur - ou une texture de remplissage. Le fait de définir la valeur à 1.0 signifie - que le remplissage sera totalement opaque. - - - - - &reftitle.parameters; - - - fill_opacity - - - Opacité du remplissage. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/setfont.xml b/reference/gmagick/gmagickdraw/setfont.xml deleted file mode 100644 index 1cbe5714d9..0000000000 --- a/reference/gmagick/gmagickdraw/setfont.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - GmagickDraw::setfont - Définit la police de caractère à utiliser lors d'une annotation - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfont - stringfont - - - Définit la police de caractère à utiliser lors d'une annotation. - - - - - - &reftitle.parameters; - - - font - - - Le nom de la police de caractère. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/setfontsize.xml b/reference/gmagick/gmagickdraw/setfontsize.xml deleted file mode 100644 index 395e89803c..0000000000 --- a/reference/gmagick/gmagickdraw/setfontsize.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - GmagickDraw::setfontsize - Définit la taille, en points, de la police de caractère utilisée lors d'une annotation - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfontsize - floatpointsize - - - Définit la taille, en points, de la police de caractère utilisée lors d'une annotation. - - - - - - &reftitle.parameters; - - - pointsize - - - La taille, en points, du texte. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/setfontstyle.xml b/reference/gmagick/gmagickdraw/setfontstyle.xml deleted file mode 100644 index 7f94fef668..0000000000 --- a/reference/gmagick/gmagickdraw/setfontstyle.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - GmagickDraw::setfontstyle - Définit le style de police de caractères à utiliser lors d'une annotation - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfontstyle - intstyle - - - Définit le style de police de caractères à utiliser lors d'une annotation. - L'énumération AnyStyle agit comme une option jocker. - - - - - &reftitle.parameters; - - - style - - - Style de la police de caractères (NormalStyle, ItalicStyle, ObliqueStyle, AnyStyle) - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - - diff --git a/reference/gmagick/gmagickdraw/setfontweight.xml b/reference/gmagick/gmagickdraw/setfontweight.xml deleted file mode 100644 index 09c27a0964..0000000000 --- a/reference/gmagick/gmagickdraw/setfontweight.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - GmagickDraw::setfontweight - Définit le poids de la police de caractères - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfontweight - intweight - - - Définit le poids de la police de caractères à utiliser lors - d'une annotation. - - - - - - &reftitle.parameters; - - - weight - - - Poids de la police de caractères (intervalle valide entre 100-900). - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/setstrokecolor.xml b/reference/gmagick/gmagickdraw/setstrokecolor.xml deleted file mode 100644 index 9c94a36484..0000000000 --- a/reference/gmagick/gmagickdraw/setstrokecolor.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - GmagickDraw::setstrokecolor - Définit la couleur à utiliser pour tracer les contours de l'objet - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setstrokecolor - mixedcolor - - - Définit la couleur à utiliser pour tracer les contours de l'objet. - - - - - &reftitle.parameters; - - - color - - - Objet GmagickPixel ou string représentant la couleur pour les contours. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw en cas de succès. - - - - - diff --git a/reference/gmagick/gmagickdraw/setstrokeopacity.xml b/reference/gmagick/gmagickdraw/setstrokeopacity.xml deleted file mode 100644 index 80cdb7f951..0000000000 --- a/reference/gmagick/gmagickdraw/setstrokeopacity.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - GmagickDraw::setstrokeopacity - Spécifie l'opacité pour les contours de l'objet - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setstrokeopacity - floatstroke_opacity - - - Spécifie l'opacité pour les contours de l'objet. - - - - - &reftitle.parameters; - - - stroke_opacity - - - L'opacité. La valeur 1.0 représente une opacité opaque. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/setstrokewidth.xml b/reference/gmagick/gmagickdraw/setstrokewidth.xml deleted file mode 100644 index 8ffa652cde..0000000000 --- a/reference/gmagick/gmagickdraw/setstrokewidth.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - GmagickDraw::setstrokewidth - Définit la largeur des contours de l'objet - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setstrokewidth - floatwidth - - - Définit la largeur des contours de l'objet. - - - - - &reftitle.parameters; - - - width - - - La largeur des contours. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/settextdecoration.xml b/reference/gmagick/gmagickdraw/settextdecoration.xml deleted file mode 100644 index 8e2f55377b..0000000000 --- a/reference/gmagick/gmagickdraw/settextdecoration.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - GmagickDraw::settextdecoration - Spécifie une décoration - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::settextdecoration - intdecoration - - - Spécifie une décoration à appliquer au texte lors d'une annotation. - - - - - &reftitle.parameters; - - - int - - - La décoration du texte. Une constante parmi - NoDecoration, UnderlineDecoration, OverlineDecoration, ou LineThroughDecoration. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - - diff --git a/reference/gmagick/gmagickdraw/settextencoding.xml b/reference/gmagick/gmagickdraw/settextencoding.xml deleted file mode 100644 index ca1780d277..0000000000 --- a/reference/gmagick/gmagickdraw/settextencoding.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - GmagickDraw::settextencoding - Spécifie le code du jeu de caractères à utiliser - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::settextencoding - stringencoding - - - Spécifie le code du jeu de caractères à utiliser pour le texte des annotations. - Le seul jeu de caractères qui peut être actuellement spécifié est "UTF-8" - pour représenter l'Unicode comme séquence d'octets. En spécifiant une chaîne vide - pour définir l'encodage du texte conformément à celui du système. - Un texte utilisant l'Unicode sera représenté correctement lors de l'utilisation - d'une police de caractères qui supporte l'Unicode. - - - - - &reftitle.parameters; - - - encoding - - - Chaîne spécifiant l'encodage du texte. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickDraw. - - - - diff --git a/reference/gmagick/gmagickexception.xml b/reference/gmagick/gmagickexception.xml deleted file mode 100644 index 85898feeba..0000000000 --- a/reference/gmagick/gmagickexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - La classe GmagickException - GmagickException - - - - -
- &reftitle.intro; - - La classe GmagickException. - -
- - -
- &reftitle.classsynopsis; - - - - GmagickException - - - - - GmagickException - - - - extends - Exception - - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - -
- - - - - - - diff --git a/reference/gmagick/gmagickpixel.xml b/reference/gmagick/gmagickpixel.xml deleted file mode 100644 index 8667185520..0000000000 --- a/reference/gmagick/gmagickpixel.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - La classe GmagickPixel - GmagickPixel - - - - -
- &reftitle.intro; - - -
- - -
- &reftitle.classsynopsis; - - - - GmagickPixel - - - - - GmagickPixel - - - - - &Methods; - - - - - - - - - -
- - - - &reference.gmagick.entities.gmagickpixel; - - - diff --git a/reference/gmagick/gmagickpixel/construct.xml b/reference/gmagick/gmagickpixel/construct.xml deleted file mode 100644 index 8d9a001286..0000000000 --- a/reference/gmagick/gmagickpixel/construct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - GmagickPixel::__construct - Le constructeur GmagickPixel - - - - &reftitle.description; - - public GmagickPixel::__construct - stringcolor - - - Construit un nouvel objet GmagickPixel. - Si une couleur est spécifiée, l'objet est construit - puis initialisé en utilisant cette couleur avant d'être retourné. - - - - - &reftitle.parameters; - - - color - - - La couleur à utiliser comme valeur initiale de cet objet (optionnel). - - - - - - - - diff --git a/reference/gmagick/gmagickpixel/getcolor.xml b/reference/gmagick/gmagickpixel/getcolor.xml deleted file mode 100644 index 00891a0222..0000000000 --- a/reference/gmagick/gmagickpixel/getcolor.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - GmagickPixel::getcolor - Retourne la couleur - - - - &reftitle.description; - - public mixedGmagickPixel::getcolor - boolas_array&false; - boolnormalize_array&false; - - - Retourne la couleur décrite par l'objet GmagickPixel, sous la forme d'une &string; ou un &array;. - Si la couleur a un canal d'opacité défini, il sera spécifié comme 4ème valeur - de la liste. - - - - - - &reftitle.parameters; - - - as_array - - - &true; pour indiquer que la valeur retournée doit être - un &array; au lieu d'une &string;. - - - - - normalize_array - - - &true; pour normaliser les valeurs de couleur. - - - - - - - - &reftitle.returnvalues; - - Une &string; ou un &array; des valeurs de canaux, dont chacun est normalisé si &true; - est fourni pour normalize_array. - Émet une exception GmagickPixelException en cas d'erreur. - - - - - diff --git a/reference/gmagick/gmagickpixel/getcolorcount.xml b/reference/gmagick/gmagickpixel/getcolorcount.xml deleted file mode 100644 index 439262e5e6..0000000000 --- a/reference/gmagick/gmagickpixel/getcolorcount.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - GmagickPixel::getcolorcount - Retourne le nombre de couleurs associées avec cette couleur - - - - &reftitle.description; - - public intGmagickPixel::getcolorcount - - - - Retourne le nombre de couleurs associées avec cette couleur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le nombre de couleurs, sous la forme d'un entier en cas - de succès, et émet une exception GmagickPixelException si une erreur survient. - - - - - diff --git a/reference/gmagick/gmagickpixel/getcolorvalue.xml b/reference/gmagick/gmagickpixel/getcolorvalue.xml deleted file mode 100644 index 1dd4d0055a..0000000000 --- a/reference/gmagick/gmagickpixel/getcolorvalue.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - GmagickPixel::getcolorvalue - Récupère la valeur normalisée du canal de la couleur fournie - - - - &reftitle.description; - - public floatGmagickPixel::getcolorvalue - intcolor - - - Récupère la valeur normalisée du canal de la couleur fournie, - sous la forme d'un nombre à virgule flottante compris entre 0 et 1. - - - - - - &reftitle.parameters; - - - color - - - Le canal à vérifier, spécifié sous la forme d'une des constantes de canal - Gmagick. - - - - - - - - &reftitle.returnvalues; - - La valeur du canal, sous la forme d'un nombre à virgule flottante - normalisé, et émet une exception GmagickPixelException si une erreur survient. - - - - - diff --git a/reference/gmagick/gmagickpixel/setcolor.xml b/reference/gmagick/gmagickpixel/setcolor.xml deleted file mode 100644 index a80d5b5f79..0000000000 --- a/reference/gmagick/gmagickpixel/setcolor.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - GmagickPixel::setcolor - Définit la couleur - - - - &reftitle.description; - - public GmagickPixelGmagickPixel::setcolor - stringcolor - - - Définit la couleur décrite par l'objet GmagickPixel, avec une &string; - (c.-à-d. "blue", "#0000ff", "rgb(0,0,255)", "cmyk(100,100,100,10)", etc.). - - - - - - &reftitle.parameters; - - - color - - - La définition de la couleur à utiliser pour initialiser - l'objet GmagickPixel. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickPixel en cas de succès. - - - - - diff --git a/reference/gmagick/gmagickpixel/setcolorvalue.xml b/reference/gmagick/gmagickpixel/setcolorvalue.xml deleted file mode 100644 index 4bcbdd2754..0000000000 --- a/reference/gmagick/gmagickpixel/setcolorvalue.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - GmagickPixel::setcolorvalue - Définit la valeur normalisée d'un des canaux - - - - &reftitle.description; - - public GmagickPixelGmagickPixel::setcolorvalue - intcolor - floatvalue - - - Définit la valeur du canal spécifié de cet objet à une valeur fournie, - qui doit être entre 0 et 1. Cette fonction peut être utilisée pour - fournir un canal d'opacité à l'objet GmagickPixel. - - - - - - &reftitle.parameters; - - - color - - - Une des constantes de couleur de canal Gmagick. - - - - - value - - - La valeur à utiliser pour définir ce canal, comprise - entre 0 et 1. - - - - - - - - &reftitle.returnvalues; - - L'objet GmagickPixel en cas de succès. - - - - - diff --git a/reference/gmagick/gmagickpixelexception.xml b/reference/gmagick/gmagickpixelexception.xml deleted file mode 100644 index 919711cb7a..0000000000 --- a/reference/gmagick/gmagickpixelexception.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - La classe GmagickPixelException - GmagickPixelException - - - - -
- &reftitle.intro; - - -
- - -
- &reftitle.classsynopsis; - - - - GmagickPixelException - - - - - GmagickPixelException - - - - extends - Exception - - - - - - &InheritedMethods; - - - - - -
- - - - - - - diff --git a/reference/gmagick/setup.xml b/reference/gmagick/setup.xml deleted file mode 100644 index e6313ab013..0000000000 --- a/reference/gmagick/setup.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - &reftitle.setup; - -
- &reftitle.required; - - Cette extension fonctionne parfaitement avec GraphicsMagick version 1.4+. - Gmagick devrait fonctionner avec les anciennes versions et ce, - depuis la version 1.2.6 de GraphicsMagick mais quelques fonctionnalités - et formats n'y sont pas supportés. La version Windows de GraphicsMagick est disponible - depuis le site web de GraphicsMagick. Pour connaître les différences - entre ImageMagick et GraphicsMagick, lire la - FAQ. - -
- - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;gmagick. - - - - Le nom officiel de cette extension est gmagick. - - -
- - - - diff --git a/reference/gnupg/book.xml b/reference/gnupg/book.xml deleted file mode 100644 index 79f8140e22..0000000000 --- a/reference/gnupg/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - GNU Privacy Guard - GnuPG - - - - &reftitle.intro; - - Ce module permet d'interagir avec - gnupg. - - - - - &reference.gnupg.setup; - &reference.gnupg.constants; - &reference.gnupg.examples; - - &reference.gnupg.reference; - - - diff --git a/reference/gnupg/configure.xml b/reference/gnupg/configure.xml deleted file mode 100644 index 8891b4f7e4..0000000000 --- a/reference/gnupg/configure.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - -
- &reftitle.install; - - &pecl.info; - . - -
- diff --git a/reference/gnupg/constants.xml b/reference/gnupg/constants.xml deleted file mode 100644 index 2e2f3b2804..0000000000 --- a/reference/gnupg/constants.xml +++ /dev/null @@ -1,306 +0,0 @@ - - - - - - - &reftitle.constants; - - - - GNUPG_SIG_MODE_NORMAL - (int) - - - - - - - - - - GNUPG_SIG_MODE_DETACH - (int) - - - - - - - - - - GNUPG_SIG_MODE_CLEAR - (int) - - - - - - - - - - GNUPG_VALIDITY_UNKNOWN - (int) - - - - - - - - - - GNUPG_VALIDITY_UNDEFINED - (int) - - - - - - - - - - GNUPG_VALIDITY_NEVER - (int) - - - - - - - - - - GNUPG_VALIDITY_MARGINAL - (int) - - - - - - - - - - GNUPG_VALIDITY_FULL - (int) - - - - - - - - - - GNUPG_VALIDITY_ULTIMATE - (int) - - - - - - - - - - GNUPG_PROTOCOL_OpenPGP - (int) - - - - - - - - - - GNUPG_PROTOCOL_CMS - (int) - - - - - - - - - - GNUPG_SIGSUM_VALID - (int) - - - - - - - - - - GNUPG_SIGSUM_GREEN - (int) - - - - - - - - - - GNUPG_SIGSUM_RED - (int) - - - - - - - - - - GNUPG_SIGSUM_KEY_REVOKED - (int) - - - - - - - - - - GNUPG_SIGSUM_KEY_EXPIRED - (int) - - - - - - - - - - GNUPG_SIGSUM_KEY_MISSING - (int) - - - - - - - - - - GNUPG_SIGSUM_SIG_EXPIRED - (int) - - - - - - - - - - GNUPG_SIGSUM_CRL_MISSING - (int) - - - - - - - - - - GNUPG_SIGSUM_CRL_TOO_OLD - (int) - - - - - - - - - - GNUPG_SIGSUM_BAD_POLICY - (int) - - - - - - - - - - GNUPG_SIGSUM_SYS_ERROR - (int) - - - - - - - - - - GNUPG_ERROR_WARNING - (int) - - - - - - - - - - GNUPG_ERROR_EXCEPTION - (int) - - - - - - - - - - GNUPG_ERROR_SILENT - (int) - - - - - - - - - - - diff --git a/reference/gnupg/examples.xml b/reference/gnupg/examples.xml deleted file mode 100644 index b09344e5d9..0000000000 --- a/reference/gnupg/examples.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - &reftitle.examples; -
- Signe en clair un texte - - Cet exemple signe en clair un texte donné. - - - Exemple avec gnupg clearsign (Style procédural) - - -]]> - - - - Exemple avec gnupg clearsign (Style orienté objet) - -setsignmode(gnupg::SIG_MODE_CLEAR); - -// ajoute une clé avec une passphrase 'test' pour signer -$gnupg->addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); - -// Signe -$signed = $gnupg->sign("just a test"); -echo $signed; -?> -]]> - - - - keylistiterator - - Cette extension vient aussi avec un Itérateur pour le trousseau. - - - $userid){ - echo $fingerprint." -> ".$userid."\n"; -} -?> -]]> - - -
- - diff --git a/reference/gnupg/functions/gnupg-adddecryptkey.xml b/reference/gnupg/functions/gnupg-adddecryptkey.xml deleted file mode 100644 index 332539b69e..0000000000 --- a/reference/gnupg/functions/gnupg-adddecryptkey.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - gnupg_adddecryptkey - Ajoute une clé pour déchiffrement - - - - &reftitle.description; - - boolgnupg_adddecryptkey - resourceidentifier - stringfingerprint - stringpassphrase - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - fingerprint - - &gnupg.fingerprint; - - - - passphrase - - - La phrase de passe (comme le mot de passe, mais plus long). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_adddecryptkey</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_adddecryptkey</function> (Style orienté objet) - -adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-addencryptkey.xml b/reference/gnupg/functions/gnupg-addencryptkey.xml deleted file mode 100644 index b18d3da441..0000000000 --- a/reference/gnupg/functions/gnupg-addencryptkey.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - gnupg_addencryptkey - Ajoute une clé pour chiffrement - - - - &reftitle.description; - - boolgnupg_addencryptkey - resourceidentifier - stringfingerprint - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - fingerprint - - &gnupg.fingerprint; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_addencryptkey</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_addencryptkey</function> (Style orienté objet) - -addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-addsignkey.xml b/reference/gnupg/functions/gnupg-addsignkey.xml deleted file mode 100644 index e98eea0cd8..0000000000 --- a/reference/gnupg/functions/gnupg-addsignkey.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - gnupg_addsignkey - Ajoute une clé pour signer - - - - &reftitle.description; - - boolgnupg_addsignkey - resourceidentifier - stringfingerprint - stringpassphrase - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - fingerprint - - &gnupg.fingerprint; - - - - passphrase - - - La phrase de passe (comme le mot de passe, mais plus long). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_addsignkey</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_addsignkey</function> (Style orienté objet) - -addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-cleardecryptkeys.xml b/reference/gnupg/functions/gnupg-cleardecryptkeys.xml deleted file mode 100644 index 8692073158..0000000000 --- a/reference/gnupg/functions/gnupg-cleardecryptkeys.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - gnupg_cleardecryptkeys - Supprime toutes les clés qui étaient fixées pour déchiffrement auparavant - - - - &reftitle.description; - - boolgnupg_cleardecryptkeys - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_cleardecryptkeys</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_cleardecryptkeys</function> (Style orienté objet) - -cleardecryptkeys(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-clearencryptkeys.xml b/reference/gnupg/functions/gnupg-clearencryptkeys.xml deleted file mode 100644 index 3ce568e3f9..0000000000 --- a/reference/gnupg/functions/gnupg-clearencryptkeys.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - gnupg_clearencryptkeys - Supprime toutes les clés qui étaient fixées pour chiffrement auparavant - - - - &reftitle.description; - - boolgnupg_clearencryptkeys - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_clearencryptkeys</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_clearencryptkeys</function> (Style orienté objet) - -clearencryptkeys(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-clearsignkeys.xml b/reference/gnupg/functions/gnupg-clearsignkeys.xml deleted file mode 100644 index d33d0ff29a..0000000000 --- a/reference/gnupg/functions/gnupg-clearsignkeys.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - gnupg_clearsignkeys - Supprime toutes les clés qui étaient fixées pour signature auparavant - - - - &reftitle.description; - - boolgnupg_clearsignkeys - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_clearsignkeys</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_clearsignkeys</function> (Style orienté objet) - -clearsignkeys(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-decrypt.xml b/reference/gnupg/functions/gnupg-decrypt.xml deleted file mode 100644 index 44bd763aaf..0000000000 --- a/reference/gnupg/functions/gnupg-decrypt.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - gnupg_decrypt - Déchiffre un texte donné - - - - &reftitle.description; - - stringfalsegnupg_decrypt - resourceidentifier - stringtext - - - Déchiffre un texte donné avec les clés qui ont été fixées avec gnupg_adddecryptkey - auparavant. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - text - - - Le texte à déchiffrer. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette fonction retourne le texte déchiffré. - En cas d'échec, cette fonction retourne &false;. - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_decrypt</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_decrypt</function> (Style orienté objet) - -adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -$plain = $gpg->decrypt($encrypted_text); -echo $plain; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-decryptverify.xml b/reference/gnupg/functions/gnupg-decryptverify.xml deleted file mode 100644 index 277828e04b..0000000000 --- a/reference/gnupg/functions/gnupg-decryptverify.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - gnupg_decryptverify - Déchiffre et vérifie un texte donné - - - - &reftitle.description; - - arrayfalsegnupg_decryptverify - resourceidentifier - stringtext - stringplaintext - - - Déchiffre et vérifie un texte donné et retourne les informations à propos - de la signature. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - text - - - Le texte à déchiffrer. - - - - - plaintext - - - Le paramètre plaintext se remplit avec le texte - déchiffré. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette fonction retourne les informations à propos de la - signature et remplit le paramètre plaintext avec le - texte déchiffré. En cas d'échec, cette fonction retourne &false;. - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_decryptverify</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_decryptverify</function> (Style orienté objet) - -adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -$info = $gpg->decryptverify($text,$plaintext); -print_r($info); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-deletekey.xml b/reference/gnupg/functions/gnupg-deletekey.xml deleted file mode 100644 index 0af6aa0575..0000000000 --- a/reference/gnupg/functions/gnupg-deletekey.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - gnupg_deletekey - Supprime une clé du trousseau - - - - &reftitle.description; - - boolgnupg_deletekey - resourceidentifier - stringkey - boolallow_secret - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - key - - - La clé à supprimer. - - - - - allow_secret - - - Spécifie s'il faut supprimer les clés secrètes. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple procédural <function>gnupg_deletekey</function> - - -]]> - - - - Exemple orienté objet <function>gnupg_deletekey</function> - -deletekey("8660281B6051D071D94B5B230549F9DC851566DC"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-encrypt.xml b/reference/gnupg/functions/gnupg-encrypt.xml deleted file mode 100644 index d4cd93c192..0000000000 --- a/reference/gnupg/functions/gnupg-encrypt.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - gnupg_encrypt - Chiffre un texte donné - - - - &reftitle.description; - - stringfalsegnupg_encrypt - resourceidentifier - stringplaintext - - - Chiffre le paramètre plaintext avec les clés qui ont - été fixées avec gnupg_addencryptkey - auparavant et retourne le texte chiffré. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - plaintext - - - Le texte à chiffrer. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette fonction retourne le texte chiffré. - En cas d'échec, cette fonction retourne &false;. - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_encrypt</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_encrypt</function> (Style orienté objet) - -addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); -$enc = $gpg->encrypt("juste un test"); -echo $enc; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-encryptsign.xml b/reference/gnupg/functions/gnupg-encryptsign.xml deleted file mode 100644 index 1aa5a2eb49..0000000000 --- a/reference/gnupg/functions/gnupg-encryptsign.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - gnupg_encryptsign - Chiffre et signe un texte donné - - - - &reftitle.description; - - stringfalsegnupg_encryptsign - resourceidentifier - stringplaintext - - - Chiffre et signe le paramètre plaintext avec les - clés qui ont été fixées avec - gnupg_addsignkey et gnupg_addencryptkey - auparavant et retourne le texte chiffré et signé. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - plaintext - - - Le texte à chiffrer. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette fonction retourne le texte signé et chiffré. - En cas d'échec, cette fonction retourne &false;. - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_encryptsign</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_encryptsign</function> (Style orienté objet) - -addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); -$gpg->addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -$enc = $gpg->encryptsign("juste un test"); -echo $enc; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-export.xml b/reference/gnupg/functions/gnupg-export.xml deleted file mode 100644 index 659cf31a9b..0000000000 --- a/reference/gnupg/functions/gnupg-export.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - gnupg_export - Exporte une clé - - - - &reftitle.description; - - stringfalsegnupg_export - resourceidentifier - stringfingerprint - - - Exporte la clé fingerprint. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - fingerprint - - &gnupg.fingerprint; - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette fonction retourne les données de la clé. - En cas d'échec, cette fonction retourne &false;. - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_export</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_export</function> (Style orienté objet) - -export("8660281B6051D071D94B5B230549F9DC851566DC"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-getengineinfo.xml b/reference/gnupg/functions/gnupg-getengineinfo.xml deleted file mode 100644 index cad82619ef..0000000000 --- a/reference/gnupg/functions/gnupg-getengineinfo.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - gnupg_getengineinfo - Renvoie les informations du moteur - - - - &reftitle.description; - - arraygnupg_getengineinfo - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - Renvoie un tableau contenant les informations du moteur composé de protocol, - file_name et home_dir. - - - - - &reftitle.examples; - - - Exemple procédural <function>gnupg_getengineinfo</function> - - -]]> - - &example.outputs; - - - int(0) - ["file_name"]=> - string(12) "/usr/bin/gpg" - ["home_dir"]=> - string(0) "" -} -]]> - - - - Exemple orienté objet <function>gnupg_getengineinfo</function> - - "/usr/bin/gpg2", "home_dir" => "/var/www/.gnupg"]); -print_r($gpg->getengineinfo()); -?> -]]> - - &example.outputs; - - - int(0) - ["file_name"]=> - string(13) "/usr/bin/gpg2" - ["home_dir"]=> - string(15) "/var/www/.gnupg" -} -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-geterror.xml b/reference/gnupg/functions/gnupg-geterror.xml deleted file mode 100644 index a3f3bb5c93..0000000000 --- a/reference/gnupg/functions/gnupg-geterror.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - gnupg_geterror - Retourne le texte d'erreur, si une fonction échoue - - - - &reftitle.description; - - stringfalsegnupg_geterror - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - Retourne le texte d'erreur si une erreur s'est produite, sinon retourne - &false;. - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_geterror</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_geterror</function> (Style orienté objet) - -geterror(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-geterrorinfo.xml b/reference/gnupg/functions/gnupg-geterrorinfo.xml deleted file mode 100644 index 0308a0ecb2..0000000000 --- a/reference/gnupg/functions/gnupg-geterrorinfo.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - gnupg_geterrorinfo - Renvoie les informations d'erreur - - - - &reftitle.description; - - arraygnupg_geterrorinfo - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - Renvoie un tableau avec les informations d'erreur. - - - - - &reftitle.examples; - - - Exemple procédural <function>gnupg_geterrorinfo</function> - - -]]> - - &example.outputs; - - - bool(false) - ["gpgme_code"]=> - int(0) - ["gpgme_source"]=> - string(18) "Unspecified source" - ["gpgme_message"]=> - string(7) "Success" -} -]]> - - - - Exemple orienté objet <function>gnupg_geterrorinfo</function> - -decrypt('abc'); -// les informations d'erreur doivent être affichées -print_r($gpg->geterrorinfo()); -?> -]]> - - &example.outputs; - - - string(14) "decrypt failed" - ["gpgme_code"]=> - int(117440570) - ["gpgme_source"]=> - string(5) "GPGME" - ["gpgme_message"]=> - string(7) "No data" -} -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-getprotocol.xml b/reference/gnupg/functions/gnupg-getprotocol.xml deleted file mode 100644 index 6c34c04618..0000000000 --- a/reference/gnupg/functions/gnupg-getprotocol.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - gnupg_getprotocol - Retourne le protocole actif courant pour toutes les opérations - - - - &reftitle.description; - - intgnupg_getprotocol - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - Retourne le protocole actif courant, qui peut être un de ceux-ci : - GNUPG_PROTOCOL_OpenPGP ou - GNUPG_PROTOCOL_CMS. - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_getprotocol</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_getprotocol</function> (Style orienté objet) - -getprotocol(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-gettrustlist.xml b/reference/gnupg/functions/gnupg-gettrustlist.xml deleted file mode 100644 index 4931ed1b2c..0000000000 --- a/reference/gnupg/functions/gnupg-gettrustlist.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - gnupg_gettrustlist - Recherche les éléments de confiance - - - - &reftitle.description; - - arraynullgnupg_gettrustlist - resourceidentifier - stringpattern - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - pattern - - - Une expression pour limiter la liste des éléments de confiance aux seuls éléments correspondant au modèle. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette fonction renvoie un tableau d'éléments de confiance. - En cas d'échec, cette fonction renvoie &null;. - - - - - &reftitle.examples; - - - Exemple procédural <function>gnupg_gettrustlist</function> - - -]]> - - - - Exemple orienté objet <function>gnupg_gettrustlist</function> - -gettrustlist(); -print_r($items); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-import.xml b/reference/gnupg/functions/gnupg-import.xml deleted file mode 100644 index 24b02a9fa5..0000000000 --- a/reference/gnupg/functions/gnupg-import.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - gnupg_import - Importe une clé - - - - &reftitle.description; - - arrayfalsegnupg_import - resourceidentifier - stringkeydata - - - Importe la clé keydata et retourne un tableau avec - les informations à propos du processus d'importation. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - keydata - - - La clé à importer. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette fonction retourne un tableau d'information à - propos du processus d'importation. - En cas d'échec, cette fonction retourne &false;. - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_import</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_import</function> (Style orienté objet) - -import($keydata); -print_r($info); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-init.xml b/reference/gnupg/functions/gnupg-init.xml deleted file mode 100644 index 8805312744..0000000000 --- a/reference/gnupg/functions/gnupg-init.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - gnupg_init - Initialise une connexion - - - - &reftitle.description; - - resourcegnupg_init - arraynulloptions&null; - - - - - &reftitle.parameters; - - - options - - - Doit être un tableau associatif. Il est utilisé pour modifier la configuration - par défaut du moteur cryptographique. - - Remplacement de la configuration - - - - Clé - Type - Description - - - - - file_name - string - - C'est le nom de fichier du programme exécutable implémentant - ce protocole qui est généralement le chemin de l'exécutable gpg. - - - - home_dir - string - - Il s'agit du nom du répertoire de configuration. - Il remplace également la variable d'environnement GNUPGHOME - qui est utilisée dans le même but. - - - - -
- - - - - - - - &reftitle.returnvalues; - - Une ressource de connexion GnuPG, utilisée par les autres fonctions GnuPG. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL gnupg 1.5.0 - - Le paramètre options a été ajouté. - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_init</function> avec réglage par défaut (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_init</function> avec un nom de fichier et un répertoire d'origine surchargés (Style procédural) - - "/usr/bin/gpg2", "home_dir" => "/var/www/.gnupg"]); -?> -]]> - - - - Exemple avec <function>gnupg_init</function> avec réglage par défaut (Style orienté objet) - - -]]> - - - - Exemple avec <function>gnupg_init</function> avec un nom de fichier et un répertoire d'origine surchargés (Style orienté objet) - - "/usr/bin/gpg2", "home_dir" => "/var/www/.gnupg"]); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-keyinfo.xml b/reference/gnupg/functions/gnupg-keyinfo.xml deleted file mode 100644 index ffd7e02e0d..0000000000 --- a/reference/gnupg/functions/gnupg-keyinfo.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - gnupg_keyinfo - Retourne un tableau avec les informations à propos de toutes les - clés qui correspondent au motif donné - - - - &reftitle.description; - - arrayfalsegnupg_keyinfo - resourceidentifier - stringpattern - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - pattern - - - Le masque à utiliser sur les clés. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les informations à propos de toutes les clés qui - correspondent au motif donné ou retourne &false; si une erreur s'est - produite. - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_keyinfo</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_keyinfo</function> (Style orienté objet) - -keyinfo("test"); -print_r($info); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-listsignatures.xml b/reference/gnupg/functions/gnupg-listsignatures.xml deleted file mode 100644 index 18b64e1463..0000000000 --- a/reference/gnupg/functions/gnupg-listsignatures.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - gnupg_listsignatures - Liste les signatures de clé - - - - &reftitle.description; - - arraynullgnupg_listsignatures - resourceidentifier - stringkeyid - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - keyid - - - L'identifiant de clé pour lister les signatures. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette fonction renvoie un tableau de signatures de clé. - En cas d'échec, cette fonction renvoie &null;. - - - - - &reftitle.examples; - - - Exemple procédural <function>gnupg_listsignatures</function> - - -]]> - - - - Exemple orienté objet <function>gnupg_listsignatures</function> - -listsignatures("8660281B6051D071D94B5B230549F9DC851566DC"); -print_r($signatures); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-setarmor.xml b/reference/gnupg/functions/gnupg-setarmor.xml deleted file mode 100644 index e90bb6870d..0000000000 --- a/reference/gnupg/functions/gnupg-setarmor.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - gnupg_setarmor - Change la sortie blindée - - - - &reftitle.description; - - boolgnupg_setarmor - resourceidentifier - intarmor - - - Change la sortie blindée. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - armor - - - Passer une valeur entière différente de zéro à cette fonction permet d'activer - la sortie blindée (valeur par défaut). - Passer 0 désactive la sortie blindée. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_setarmor</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_setarmor</function> (Style orienté objet) - -setarmor(1); // Active la sortie blindée; -$gpg->setarmor(0); // Désactive la sortie blindée; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-seterrormode.xml b/reference/gnupg/functions/gnupg-seterrormode.xml deleted file mode 100644 index 3d02fd1029..0000000000 --- a/reference/gnupg/functions/gnupg-seterrormode.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - gnupg_seterrormode - Fixe le mode pour error_reporting - - - - &reftitle.description; - - voidgnupg_seterrormode - resourceidentifier - interrormode - - - Fixe le mode pour error_reporting. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - errormode - - - Le mode de l'erreur. - - - errormode prend une constante indiquant quel type de - error_reporting devrait être utilisé. Les valeurs possibles sont - GNUPG_ERROR_WARNING, - GNUPG_ERROR_EXCEPTION et - GNUPG_ERROR_SILENT. - Par défaut GNUPG_ERROR_SILENT. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_seterrormode</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_seterrormode</function> (Style orienté objet) - -seterrormode(gnupg::ERROR_EXCEPTION); // jette une exception dans le cas d'une erreur -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-setsignmode.xml b/reference/gnupg/functions/gnupg-setsignmode.xml deleted file mode 100644 index 9c2e04c01e..0000000000 --- a/reference/gnupg/functions/gnupg-setsignmode.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - gnupg_setsignmode - Fixe le mode pour signer - - - - &reftitle.description; - - boolgnupg_setsignmode - resourceidentifier - intsignmode - - - Fixe le mode pour signer. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - sigmode - - - Le mode de signature. - - - signmode prend une constante indiquant quel type de - signature doit être produit. Les valeurs possibles sont : - GNUPG_SIG_MODE_NORMAL, - GNUPG_SIG_MODE_DETACH et - GNUPG_SIG_MODE_CLEAR. - Par défaut, GNUPG_SIG_MODE_CLEAR est utilisé. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_setsignmode</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_setsignmode</function> (Style orienté objet) - -setsignmode(gnupg::SIG_MODE_DETACH); // produit une signature détachée -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-sign.xml b/reference/gnupg/functions/gnupg-sign.xml deleted file mode 100644 index 7a78e17387..0000000000 --- a/reference/gnupg/functions/gnupg-sign.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - gnupg_sign - Signe un texte donné - - - - &reftitle.description; - - stringfalsegnupg_sign - resourceidentifier - stringplaintext - - - Signe le paramètre plaintext avec les clés qui ont - été fixées avec gnupg_addsignkey auparavant - et retourne le texte signé ou la signature, dépendamment de ce qui a été - fixé avec - gnupg_setsignmode. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - plaintext - - - Le texte à signer. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette fonction retourne le texte signé ou la signature. - En cas d'échec, cette fonction retourne &false;. - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_sign</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_sign</function> (Style orienté objet) - -addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -$signed = $gpg->sign("just a test"); -echo $signed; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-verify.xml b/reference/gnupg/functions/gnupg-verify.xml deleted file mode 100644 index 4c8b9a6bab..0000000000 --- a/reference/gnupg/functions/gnupg-verify.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - gnupg_verify - Vérifie un texte signé - - - - &reftitle.description; - - arrayfalsegnupg_verify - resourceidentifier - stringsigned_text - stringsignature - stringplaintext - - - Vérifie le paramètre signed_text et retourne les - informations à propos de la signature. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - signed_text - - - Le texte signé. - - - - - signature - - - La signature. Pour vérifier un texte signé en clair, fixez la signature - à &false;. - - - - - plaintext - - - Le texte. Si ce paramètre optionnel est passé, il - est rempli avec le plaintext. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette fonction retourne des informations à propos de la - signature. - En cas d'échec, cette fonction retourne &false;. - - - - - &reftitle.examples; - - - Exemple avec <function>gnupg_verify</function> (Style procédural) - - -]]> - - - - Exemple avec <function>gnupg_verify</function> (Style orienté objet) - -verify($signed_text,false,$plaintext); -print_r($info); -// signature détachée -$info = $gpg->verify($signed_text,$signature); -print_r($info); -?> -]]> - - - - - - diff --git a/reference/gnupg/reference.xml b/reference/gnupg/reference.xml deleted file mode 100644 index d31e56a81f..0000000000 --- a/reference/gnupg/reference.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - &Functions; GnuPG - - - &reftitle.notes; - - Cette extension utilise le trousseau de l'usager courant. Ce trousseau est - normalement situé dans ~/.gnupg/. - Pour spécifier un emplacement différent, il faut enregistrer le chemin du - trousseau dans la variable d'environnement GNUPGHOME. Voir - putenv pour plus d'informations. - - - Certaines fonctions requièrent la spécification d'une clé. Cette - spécification peut être quelque chose qui réfère à une clé unique (userid, - key-id, fingerprint, ...). - Cette documentation utilise les fingerprint dans tous les exemples. - - - - En tant qu'alternative aux fonctions utilisant explicitement les - resource, il est également possible d'utiliser un style orienté - objet à l'aide d'objets gnupg. - - - - - &reference.gnupg.entities.functions; - - - diff --git a/reference/gnupg/setup.xml b/reference/gnupg/setup.xml deleted file mode 100644 index 4027c19c95..0000000000 --- a/reference/gnupg/setup.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - &reftitle.setup; - - -
- &reftitle.required; - - Cette extension requiert la bibliothèque gpgme. - -
- - - - &reference.gnupg.configure; - - - - diff --git a/reference/hrtime/book.xml b/reference/hrtime/book.xml deleted file mode 100644 index cbd426262f..0000000000 --- a/reference/hrtime/book.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - Gestion du temps à haute résolution - HRTime - - - &reftitle.intro; - - L'extension HRTime implémente une classe StopWatch de haute résolution. - Elle utilise la meilleure des APIs sur les différentes plateformes, qui - fournira une résolution à la nanoseconde. Il est également possible - d'implémenter un chronomètre personnalisé en utilisant les ticks de bas - niveau, délivrés par les APIs sous-jacentes. - - - - À partir de PHP 7.3.0 la fonction liée hrtime fait partie - du cœur. - - - - - &reference.hrtime.setup; - &reference.hrtime.examples; - &reference.hrtime.hrtime.performancecounter; - &reference.hrtime.hrtime.stopwatch; - &reference.hrtime.hrtime.unit; - - - diff --git a/reference/hrtime/configure.xml b/reference/hrtime/configure.xml deleted file mode 100644 index 17a22ea7e7..0000000000 --- a/reference/hrtime/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - -
- &reftitle.install; - - - Il faut utiliser lors de la compilation de PHP. - - - - Les utilisateurs de Windows doivent inclure la bibliothèque - php_hrtime.dll dans le &php.ini; - - -
- diff --git a/reference/hrtime/examples.xml b/reference/hrtime/examples.xml deleted file mode 100644 index ee95aa68f7..0000000000 --- a/reference/hrtime/examples.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - &reftitle.examples; -
- Utilisation simple - - Cet exemple montre l'utilisation basique de la classe StopWatch. - - - Mesure l'exécution de différents blocs et retourne le total - -start(); -/* mesure l'exécution de ce bloc de code */ -for ($i = 0; $i < 1024*1024; $i++); -$c->stop(); -$elapsed0 = $c->getLastElapsedTime(HRTime\Unit::NANOSECOND); - -/* la mesure n'est pas en cours ici */ -for ($i = 0; $i < 1024*1024; $i++); - -$c->start(); -/* mesure l'exécution de ce bloc de code */ -for ($i = 0; $i < 1024*1024; $i++); -$c->stop(); -$elapsed1 = $c->getLastElapsedTime(HRTime\Unit::NANOSECOND); - -$elapsed_total = $c->getElapsedTime(HRTime\Unit::NANOSECOND); - -?> -]]> - - -
- - diff --git a/reference/hrtime/hrtime-performancecounter/getfrequency.xml b/reference/hrtime/hrtime-performancecounter/getfrequency.xml deleted file mode 100644 index 43ce183e9b..0000000000 --- a/reference/hrtime/hrtime-performancecounter/getfrequency.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - HRTime\PerformanceCounter::getFrequency - Fréquence du timer en ticks par seconde - - - - &reftitle.description; - - public static intHRTime\PerformanceCounter::getFrequency - - - - Retourne la fréquence du timer en ticks par seconde. Cette - valeur est constante après le démarrage du système sur la plupart - des systèmes d'exploitations. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &integer; indiquant la fréquence du timer. - - - - - diff --git a/reference/hrtime/hrtime-performancecounter/getticks.xml b/reference/hrtime/hrtime-performancecounter/getticks.xml deleted file mode 100644 index 24caa529a9..0000000000 --- a/reference/hrtime/hrtime-performancecounter/getticks.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - HRTime\PerformanceCounter::getTicks - Ticks courants depuis le système - - - - &reftitle.description; - - public static intHRTime\PerformanceCounter::getTicks - - - - Retourne le compte de ticks. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &integer; indiquant le compte de ticks. - - - - - diff --git a/reference/hrtime/hrtime-performancecounter/gettickssince.xml b/reference/hrtime/hrtime-performancecounter/gettickssince.xml deleted file mode 100644 index cd9d17453e..0000000000 --- a/reference/hrtime/hrtime-performancecounter/gettickssince.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - HRTime\PerformanceCounter::getTicksSince - Ticks écoulés depuis la valeur fournie - - - - &reftitle.description; - - public static intHRTime\PerformanceCounter::getTicksSince - intstart - - - Retourne le compte de ticks écoulés depuis la valeur de départ fournie. - - - - - - &reftitle.parameters; - - - start - - - Valeur de ticks de départ. - - - - - - - - &reftitle.returnvalues; - - Retourne un &integer; indiquant le compte de ticks. - - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml b/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml deleted file mode 100644 index 0d23477475..0000000000 --- a/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - HRTime\StopWatch::getElapsedTicks - Récupère les ticks écoulés pour tous les intervalles - - - - &reftitle.description; - - public intHRTime\StopWatch::getElapsedTicks - - - - Récupère les ticks écoulés pour tous les intervalles fermés précédents. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &integer; indiquant les ticks écoulés. - - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml b/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml deleted file mode 100644 index 7356ed2561..0000000000 --- a/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - HRTime\StopWatch::getElapsedTime - Récupère le temps écoulé pour tous les intervalles - - - - &reftitle.description; - - public floatHRTime\StopWatch::getElapsedTime - intunit - - - Récupère le temps écoulé pour tous les intervalles précédents clos. - - - - - &reftitle.parameters; - - - unit - - - Unité de temps représentée par une constante - HRTime\Unit. Par défaut vaut HRTime\Unit::SECOND. - - - - - - - - &reftitle.returnvalues; - - Retourne un &float; indiquant le temps écoulé. - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml b/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml deleted file mode 100644 index ff28b3368c..0000000000 --- a/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - HRTime\StopWatch::getLastElapsedTicks - Récupère les ticks écoulés pour le dernier intervalle - - - - &reftitle.description; - - public intHRTime\StopWatch::getLastElapsedTicks - - - - Récupère les ticks écoulés pour le dernier intervalle fermé. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &integer; indiquant les ticks écoulés. - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml b/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml deleted file mode 100644 index 4fd828e1c9..0000000000 --- a/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - HRTime\StopWatch::getLastElapsedTime - Récupère le temps écoulé pour le dernier intervalle - - - - &reftitle.description; - - public floatHRTime\StopWatch::getLastElapsedTime - intunit - - - Récupère le temps écoulé pour le dernier intervalle. - - - - - - &reftitle.parameters; - - - unit - - - Unité de temps représentée par une constante - HRTime\Unit. Par défaut vaut HRTime\Unit::SECOND. - - - - - - - - &reftitle.returnvalues; - - Retourne un &float; indiquant le temps écoulé. - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/isrunning.xml b/reference/hrtime/hrtime-stopwatch/isrunning.xml deleted file mode 100644 index 2e617a9b2c..0000000000 --- a/reference/hrtime/hrtime-stopwatch/isrunning.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - HRTime\StopWatch::isRunning - Vérifie si la mesure du temps est en cours - - - - &reftitle.description; - - public boolHRTime\StopWatch::isRunning - - - - Vérifie si la mesure du temps a été démarrée. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &boolean; indiquant si la mesure du temps est en cours. - - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/start.xml b/reference/hrtime/hrtime-stopwatch/start.xml deleted file mode 100644 index 13c2f1dc30..0000000000 --- a/reference/hrtime/hrtime-stopwatch/start.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - HRTime\StopWatch::start - Démarre la mesure du temps - - - - &reftitle.description; - - public voidHRTime\StopWatch::start - - - - Démarre la mesure du temps. Cette méthode n'a aucun effet si la mesure du temps - a déjà été démarrée. La mesure va continuer si elle a été arrêtée précédemment. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne void. - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/stop.xml b/reference/hrtime/hrtime-stopwatch/stop.xml deleted file mode 100644 index 35edaeb890..0000000000 --- a/reference/hrtime/hrtime-stopwatch/stop.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - HRTime\StopWatch::stop - Arrête la mesure du temps - - - - &reftitle.description; - - public voidHRTime\StopWatch::stop - - - - Arrête la mesure du temps pour l'intervalle précédent. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne void. - - - - diff --git a/reference/hrtime/hrtime.performancecounter.xml b/reference/hrtime/hrtime.performancecounter.xml deleted file mode 100644 index 3321244f06..0000000000 --- a/reference/hrtime/hrtime.performancecounter.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - La classe HRTime\PerformanceCounter - HRTime\PerformanceCounter - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - HRTime\PerformanceCounter - - - - - HRTime\PerformanceCounter - - - - - &Methods; - - - - -
- - - - &reference.hrtime.entities.hrtime-performancecounter; - - - diff --git a/reference/hrtime/hrtime.stopwatch.xml b/reference/hrtime/hrtime.stopwatch.xml deleted file mode 100644 index d65b2ec922..0000000000 --- a/reference/hrtime/hrtime.stopwatch.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - La classe HRTime\StopWatch - HRTime\StopWatch - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - HRTime\StopWatch - - - - - HRTime\StopWatch - - - - extends - HRTime\PerformanceCounter - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.hrtime.entities.hrtime-stopwatch; - - - diff --git a/reference/hrtime/hrtime.unit.xml b/reference/hrtime/hrtime.unit.xml deleted file mode 100644 index f63739e638..0000000000 --- a/reference/hrtime/hrtime.unit.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - La classe HRTime\Unit - HRTime\Unit - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - HRTime\Unit - - - - - HRTime\Unit - - - - &Constants; - - const - int - HRTime\Unit::SECOND - 0 - - - const - int - HRTime\Unit::MILLISECOND - 1 - - - const - int - HRTime\Unit::MICROSECOND - 2 - - - const - int - HRTime\Unit::NANOSECOND - 3 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - HRTime\Unit::SECOND - - - - - - - HRTime\Unit::MILLISECOND - - - - - - - HRTime\Unit::MICROSECOND - - - - - - - HRTime\Unit::NANOSECOND - - - - - - -
- - - - - - - - - diff --git a/reference/hrtime/setup.xml b/reference/hrtime/setup.xml deleted file mode 100644 index b84e75ba55..0000000000 --- a/reference/hrtime/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - - - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;hrtime. - - -
- - - - - diff --git a/reference/ibase/book.xml b/reference/ibase/book.xml deleted file mode 100644 index afe7d45f75..0000000000 --- a/reference/ibase/book.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - Firebird/InterBase - - - - &reftitle.intro; - - - &pecl.info.dead.git; - &url.php.git.mirror;pecl-database-interbase. - - - - Firebird est une base de données relationnelle offrant la plupart des fonctionnalités - décrites dans la norme ISO SQL-2003, qui fonctionne sous environnements Linux, Windows, - et la plupart des systèmes Unix. Firebird offre une excellente simultanéité, de - hautes performances et un langage efficace pour l'écriture des procédures stockées et - des déclencheurs. Il est utilisé sur des systèmes de production depuis 1981. - - - Interbase est le nom de la variante commerciale de cette base de données - créée par Embarcadero/Inprise. Pour plus d'informations sur Interbase, allez à - &url.ibase;. - - - Firebird est un projet commercialement indépendant (fondation) de programmeurs C++, - conseillers techniques, supportant le développement et assurant la - compatibilité multi-plate-forme de la base de données relationnelle basée sur le - code source offert par Inprise Corp. (maintenant connu sous le nom de Embarcadero) - sous la licence "InterBase Public License v.1.0 le 25 Juillet 2000". - Pour plus d'informations sur Firebird, allez à &url.firebird;. - - - - &pecl.moved-ver;7.4.0 - - - Cette extension supporte Interbase version 6 et suivantes ainsi que - Firebird version 2 et suivantes. - - - - - - &reference.ibase.setup; - &reference.ibase.constants; - &reference.ibase.reference; - - - diff --git a/reference/ibase/configure.xml b/reference/ibase/configure.xml deleted file mode 100644 index 8ee95de23d..0000000000 --- a/reference/ibase/configure.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - -
- &reftitle.install; - - &pecl.moved-ver;7.4.0 - - - &pecl.info; - &url.git.hub;FirebirdSQL/php-firebird. - - - Pour activer le support de Firebird/InterBase, il faut compiler PHP - avec l'option - , où DIR - est le dossier d'installation de Firebird/InterBase (qui est par défaut, - /usr). - - - Note aux utilisateurs Win32/Win64 - - &ext.windows.path.dll; - fbclient.dll,gds32.dll - - - Lors de l'installation d'un serveur Firebird/InterBase sur la même machine que - celle faisant fonctionner PHP, il faudra déjà cette - bibliothèque et fbclient.dll,gds32.dll - (gds32.dll est généré depuis l'installeur) - devrait déjà être dans le PATH. - - -
- diff --git a/reference/ibase/constants.xml b/reference/ibase/constants.xml deleted file mode 100644 index e32060490c..0000000000 --- a/reference/ibase/constants.xml +++ /dev/null @@ -1,645 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Les constantes suivantes peuvent être passées à ibase_trans - pour spécifier le comportement des transactions. - - Constantes Firebird/InterBase - - - - Constante - Description - - - - - IBASE_DEFAULT - - Définit le comportement par défaut. Ce comportement est déterminé par la bibliothèque cliente, - qui est définie comme IBASE_WRITE|IBASE_CONCURRENCY|IBASE_WAIT dans - la plupart des cas. - - - - IBASE_READ - Démarre une transaction en lecture seule - - - IBASE_WRITE - Démarre une transaction en lecture / écriture - - - IBASE_CONSISTENCY - - Démarre une transaction avec le niveau d'isolation défini à - 'consistency', ce qui signifie que la transaction courante - ne peut lire depuis des tables qui ont été modifiées par d'autres transactions. - - - - IBASE_CONCURRENCY - - Démarre une transaction avec le niveau d'isolation défini à - 'concurrency' (ou 'snapshot'), ce qui signifie - que la transaction peut accéder à toutes les tables, mais ne peut pas voir les - modifications apportées par d'autres transactions une fois que la transaction - a débuté. - - - - IBASE_COMMITTED - - Démarre une transaction avec le niveau d'isolation défini à - 'read committed'. Ce flag doit être associé avec - soit la constante IBASE_REC_VERSION, soit - la constante IBASE_REC_NO_VERSION. - Ce niveau d'isolation permet d'accéder aux modifications effectuées - après le début de la transaction. Si la constante - IBASE_REC_NO_VERSION est spécifiée, - seulement la dernière version des lignes pourra être lue. - Si la constante IBASE_REC_VERSION est spécifiée, - une ligne peut toujours être lue lorsqu'une modification est en attente dans - une transaction concurrente. - - - - IBASE_WAIT - - Indique que la transaction peut attendre, puis réessayer lorsqu'un conflit apparaît. - - - - IBASE_NOWAIT - - Indique que la transaction échouera immédiatement lorsqu'un conflit apparaît. - - - - -
- - - - Les constantes suivantes peuvent être passées aux fonctions - ibase_fetch_row, - ibase_fetch_assoc ou ibase_fetch_object - pour spécifier leurs comportements. - - Constantes Firebird/InterBase - - - - Constante - Description - - - - - IBASE_FETCH_BLOBS - - Aussi disponible sous le nom IBASE_TEXT pour des raisons de - compatibilité ascendante. - Permet de lire le contenu d'un BLOB "inline" au lieu - de le parcourir en utilisant un identifiant de BLOB. - - - - IBASE_FETCH_ARRAYS - - Permet de lire un tableau "inline". - Sinon, les identifiants de tableaux sont retournés. - Les identifiants de tableaux ne peuvent être passés uniquement comme arguments - aux requêtes INSERT, car aucune fonction pour traiter les identifiants de tableaux - n'est actuellement disponible. - - - - IBASE_UNIXTIME - - Permet de retourner les champs date et heure non pas comme des chaînes de caractères - mais comme des timestamps UNIX (le nombre de secondes depuis l'époque UNIX, qui - est le 1-Jan-1970 0:00 UTC). Cela peut être problématique si l'on utilise des dates - antérieures à 1970 sur quelques systèmes. - - - - -
- - - Les constantes suivantes sont utilisées pour passer des requêtes et des options à - l'API (ibase_server_info, ibase_db_info, - ibase_backup, ibase_restore et - ibase_maintain_db). - Il est possible de consulter le manuel Firebird/InterBase pour plus d'informations - sur la signification de ces options. - - - - IBASE_BKP_IGNORE_CHECKSUMS - - - - Options pour ibase_backup - - - - - - IBASE_BKP_IGNORE_LIMBO - - - - Options pour ibase_backup - - - - - - IBASE_BKP_METADATA_ONLY - - - - Options pour ibase_backup - - - - - - IBASE_BKP_NO_GARBAGE_COLLECT - - - - Options pour ibase_backup - - - - - - IBASE_BKP_OLD_DESCRIPTIONS - - - - Options pour ibase_backup - - - - - - IBASE_BKP_NON_TRANSPORTABLE - - - - Options pour ibase_backup - - - - - - IBASE_BKP_CONVERT - - - - Options pour ibase_backup - - - - - - IBASE_RES_DEACTIVATE_IDX - - - - Options pour ibase_restore - - - - - - IBASE_RES_NO_SHADOW - - - - Options pour ibase_restore - - - - - - IBASE_RES_NO_VALIDITY - - - - Options pour ibase_restore - - - - - - IBASE_RES_ONE_AT_A_TIME - - - - Options pour ibase_restore - - - - - - IBASE_RES_REPLACE - - - - - - - - - IBASE_RES_CREATE - - - - Options pour ibase_restore - - - - - - IBASE_RES_USE_ALL_SPACE - - - - Options pour ibase_restore - - - - - - IBASE_PRP_PAGE_BUFFERS - - - - - - - - - IBASE_PRP_SWEEP_INTERVAL - - - - - - - - - IBASE_PRP_SHUTDOWN_DB - - - - - - - - - IBASE_PRP_DENY_NEW_TRANSACTIONS - - - - - - - - - IBASE_PRP_DENY_NEW_ATTACHMENTS - - - - - - - - - IBASE_PRP_RESERVE_SPACE - - - - - - - - - IBASE_PRP_RES_USE_FULL - - - - - - - - - IBASE_PRP_RES - - - - - - - - - IBASE_PRP_WRITE_MODE - - - - - - - - - IBASE_PRP_WM_ASYNC - - - - - - - - - IBASE_PRP_WM_SYNC - - - - - - - - - IBASE_PRP_ACCESS_MODE - - - - - - - - - IBASE_PRP_AM_READONLY - - - - - - - - - IBASE_PRP_AM_READWRITE - - - - - - - - - IBASE_PRP_SET_SQL_DIALECT - - - - - - - - - IBASE_PRP_ACTIVATE - - - - - - - - - IBASE_PRP_DB_ONLINE - - - - - - - - - IBASE_RPR_CHECK_DB - - - - - - - - - IBASE_RPR_IGNORE_CHECKSUM - - - - - - - - - IBASE_RPR_KILL_SHADOWS - - - - - - - - - IBASE_RPR_MEND_DB - - - - - - - - - IBASE_RPR_VALIDATE_DB - - - - - - - - - IBASE_RPR_FULL - - - - - - - - - IBASE_RPR_SWEEP_DB - - - - Options de ibase_maintain_db - - - - - - IBASE_STS_DATA_PAGES - - - - - - - - - IBASE_STS_DB_LOG - - - - - - - - - IBASE_STS_HDR_PAGES - - - - - - - - - IBASE_STS_IDX_PAGES - - - - - - - - - IBASE_STS_SYS_RELATIONS - - - - Options de ibase_db_info - - - - - - IBASE_SVC_SERVER_VERSION - - - - Options pour ibase_server_info - - - - - - IBASE_SVC_IMPLEMENTATION - - - - Options pour ibase_server_info - - - - - - IBASE_SVC_GET_ENV - - - - Options pour ibase_server_info - - - - - - IBASE_SVC_GET_ENV_LOCK - - - - - - - - - IBASE_SVC_GET_ENV_MSG - - - - - - - - - IBASE_SVC_USER_DBPATH - - - - - - - - - IBASE_SVC_SVR_DB_INFO - - - - - - - - - IBASE_SVC_GET_USERS - - - - Options pour ibase_server_info - - - - - - - - diff --git a/reference/ibase/functions/fbird-add-user.xml b/reference/ibase/functions/fbird-add-user.xml deleted file mode 100644 index 63d71bf825..0000000000 --- a/reference/ibase/functions/fbird-add-user.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_add_user - &Alias; ibase_add_user - - - - &reftitle.description; - - &info.function.alias; - ibase_add_user. - - - - - &reftitle.seealso; - - fbird_modify_user - fbird_delete_user - - - - - diff --git a/reference/ibase/functions/fbird-affected-rows.xml b/reference/ibase/functions/fbird-affected-rows.xml deleted file mode 100644 index 40ebe47bbc..0000000000 --- a/reference/ibase/functions/fbird-affected-rows.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_affected_rows - &Alias; ibase_affected_rows - - - - &reftitle.description; - - &info.function.alias; - ibase_affected_rows. - - - - - &reftitle.seealso; - - fbird_query - fbird_execute - - - - - diff --git a/reference/ibase/functions/fbird-backup.xml b/reference/ibase/functions/fbird-backup.xml deleted file mode 100644 index 3ac4d2ae4f..0000000000 --- a/reference/ibase/functions/fbird-backup.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - fbird_backup - &Alias; ibase_backup - - - - &reftitle.description; - - &info.function.alias; - ibase_backup. - - - - - diff --git a/reference/ibase/functions/fbird-blob-add.xml b/reference/ibase/functions/fbird-blob-add.xml deleted file mode 100644 index 6c4cecddb3..0000000000 --- a/reference/ibase/functions/fbird-blob-add.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - fbird_blob_add - &Alias; ibase_blob_add - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_add. - - - - - &reftitle.seealso; - - fbird_blob_cancel - fbird_blob_close - fbird_blob_create - fbird_blob_import - - - - - diff --git a/reference/ibase/functions/fbird-blob-cancel.xml b/reference/ibase/functions/fbird-blob-cancel.xml deleted file mode 100644 index c04f8b6b89..0000000000 --- a/reference/ibase/functions/fbird-blob-cancel.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - fbird_blob_cancel - Annule la création d'un blob - - - - &reftitle.description; - - boolfbird_blob_cancel - resourceblob_handle - - - Cette fonction jetera un BLOB s'il n'a pas encore été fermé par - fbird_blob_close. - - - - - &reftitle.parameters; - - - blob_handle - - - Un gestionnaire de BLOB ouvert avec fbird_blob_create. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fbird_blob_close - fbird_blob_create - fbird_blob_import - - - - - diff --git a/reference/ibase/functions/fbird-blob-close.xml b/reference/ibase/functions/fbird-blob-close.xml deleted file mode 100644 index f81e02b76a..0000000000 --- a/reference/ibase/functions/fbird-blob-close.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - fbird_blob_close - &Alias; ibase_blob_close - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_close. - - - - - &reftitle.seealso; - - fbird_blob_create - fbird_blob_cancel - fbird_blob_open - fbird_blob_import - - - - - diff --git a/reference/ibase/functions/fbird-blob-create.xml b/reference/ibase/functions/fbird-blob-create.xml deleted file mode 100644 index f1dd411f1e..0000000000 --- a/reference/ibase/functions/fbird-blob-create.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - fbird_blob_create - &Alias; ibase_blob_create - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_create. - - - - - &reftitle.seealso; - - fbird_blob_add - fbird_blob_cancel - fbird_blob_close - fbird_blob_import - - - - - diff --git a/reference/ibase/functions/fbird-blob-echo.xml b/reference/ibase/functions/fbird-blob-echo.xml deleted file mode 100644 index f1be1b7260..0000000000 --- a/reference/ibase/functions/fbird-blob-echo.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - fbird_blob_echo - &Alias; ibase_blob_echo - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_echo. - - - - - &reftitle.seealso; - - fbird_blob_open - fbird_blob_close - fbird_blob_get - - - - - diff --git a/reference/ibase/functions/fbird-blob-get.xml b/reference/ibase/functions/fbird-blob-get.xml deleted file mode 100644 index 957b367a23..0000000000 --- a/reference/ibase/functions/fbird-blob-get.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - fbird_blob_get - &Alias; ibase_blob_get - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_get. - - - - - &reftitle.seealso; - - fbird_blob_open - fbird_blob_close - fbird_blob_echo - - - - - diff --git a/reference/ibase/functions/fbird-blob-import.xml b/reference/ibase/functions/fbird-blob-import.xml deleted file mode 100644 index baf1828c76..0000000000 --- a/reference/ibase/functions/fbird-blob-import.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - fbird_blob_import - &Alias; ibase_blob_import - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_import. - - - - - &reftitle.seealso; - - fbird_blob_add - fbird_blob_cancel - fbird_blob_close - fbird_blob_create - - - - - diff --git a/reference/ibase/functions/fbird-blob-info.xml b/reference/ibase/functions/fbird-blob-info.xml deleted file mode 100644 index 57fe00ea6a..0000000000 --- a/reference/ibase/functions/fbird-blob-info.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_blob_info - &Alias; ibase_blob_info - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_info. - - - - - - diff --git a/reference/ibase/functions/fbird-blob-open.xml b/reference/ibase/functions/fbird-blob-open.xml deleted file mode 100644 index a4c9caef64..0000000000 --- a/reference/ibase/functions/fbird-blob-open.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - fbird_blob_open - &Alias; ibase_blob_open - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_open. - - - - - &reftitle.seealso; - - fbird_blob_close - fbird_blob_echo - fbird_blob_get - - - - - diff --git a/reference/ibase/functions/fbird-close.xml b/reference/ibase/functions/fbird-close.xml deleted file mode 100644 index 83194e7908..0000000000 --- a/reference/ibase/functions/fbird-close.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_close - &Alias; ibase_close - - - - &reftitle.description; - - &info.function.alias; - ibase_close. - - - - - &reftitle.seealso; - - fbird_connect - fbird_pconnect - - - - - diff --git a/reference/ibase/functions/fbird-commit-ret.xml b/reference/ibase/functions/fbird-commit-ret.xml deleted file mode 100644 index cc99ae72ad..0000000000 --- a/reference/ibase/functions/fbird-commit-ret.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_commit_ret - &Alias; ibase_commit_ret - - - - &reftitle.description; - - &info.function.alias; - ibase_commit_ret. - - - - - - diff --git a/reference/ibase/functions/fbird-commit.xml b/reference/ibase/functions/fbird-commit.xml deleted file mode 100644 index 0386fed975..0000000000 --- a/reference/ibase/functions/fbird-commit.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_commit - &Alias; ibase_commit - - - - &reftitle.description; - - &info.function.alias; - ibase_commit. - - - - - - diff --git a/reference/ibase/functions/fbird-connect.xml b/reference/ibase/functions/fbird-connect.xml deleted file mode 100644 index d56548c32a..0000000000 --- a/reference/ibase/functions/fbird-connect.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_connect - &Alias; ibase_connect - - - - &reftitle.description; - - &info.function.alias; - ibase_connect. - - - - - &reftitle.seealso; - - fbird_pconnect - fbird_close - - - - - diff --git a/reference/ibase/functions/fbird-db-info.xml b/reference/ibase/functions/fbird-db-info.xml deleted file mode 100644 index 2b53f2764f..0000000000 --- a/reference/ibase/functions/fbird-db-info.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_db_info - &Alias; ibase_db_info - - - - &reftitle.description; - - &info.function.alias; - ibase_db_info. - - - - - - diff --git a/reference/ibase/functions/fbird-delete-user.xml b/reference/ibase/functions/fbird-delete-user.xml deleted file mode 100644 index d505512798..0000000000 --- a/reference/ibase/functions/fbird-delete-user.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_delete_user - &Alias; ibase_delete_user - - - - &reftitle.description; - - &info.function.alias; - ibase_delete_user. - - - - - &reftitle.seealso; - - fbird_add_user - fbird_modify_user - - - - - diff --git a/reference/ibase/functions/fbird-drop-db.xml b/reference/ibase/functions/fbird-drop-db.xml deleted file mode 100644 index dd8c522b3f..0000000000 --- a/reference/ibase/functions/fbird-drop-db.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_drop_db - &Alias; ibase_drop_db - - - - &reftitle.description; - - &info.function.alias; - ibase_drop_db. - - - - - &reftitle.seealso; - - fbird_connect - fbird_pconnect - - - - - diff --git a/reference/ibase/functions/fbird-errcode.xml b/reference/ibase/functions/fbird-errcode.xml deleted file mode 100644 index 8eaad334cc..0000000000 --- a/reference/ibase/functions/fbird-errcode.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - fbird_errcode - &Alias; ibase_errcode - - - - &reftitle.description; - - &info.function.alias; - ibase_errcode. - - - - - &reftitle.seealso; - - fbird_errmsg - - - - - diff --git a/reference/ibase/functions/fbird-errmsg.xml b/reference/ibase/functions/fbird-errmsg.xml deleted file mode 100644 index e971a3314e..0000000000 --- a/reference/ibase/functions/fbird-errmsg.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - fbird_errmsg - &Alias; ibase_errmsg - - - - &reftitle.description; - - &info.function.alias; - ibase_errmsg. - - - - - &reftitle.seealso; - - fbird_errcode - - - - - diff --git a/reference/ibase/functions/fbird-execute.xml b/reference/ibase/functions/fbird-execute.xml deleted file mode 100644 index 2cff68ab26..0000000000 --- a/reference/ibase/functions/fbird-execute.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - fbird_execute - &Alias; ibase_execute - - - - &reftitle.description; - - &info.function.alias; - ibase_execute. - - - - - &reftitle.seealso; - - fbird_query - - - - - diff --git a/reference/ibase/functions/fbird-fetch-assoc.xml b/reference/ibase/functions/fbird-fetch-assoc.xml deleted file mode 100644 index 54bdba34ae..0000000000 --- a/reference/ibase/functions/fbird-fetch-assoc.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_fetch_assoc - &Alias; ibase_fetch_assoc - - - - &reftitle.description; - - &info.function.alias; - ibase_fetch_assoc. - - - - - &reftitle.seealso; - - fbird_fetch_row - fbird_fetch_object - - - - - diff --git a/reference/ibase/functions/fbird-fetch-object.xml b/reference/ibase/functions/fbird-fetch-object.xml deleted file mode 100644 index dd923abc3f..0000000000 --- a/reference/ibase/functions/fbird-fetch-object.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_fetch_object - &Alias; ibase_fetch_object - - - - &reftitle.description; - - &info.function.alias; - ibase_fetch_object. - - - - - &reftitle.seealso; - - fbird_fetch_row - fbird_fetch_assoc - - - - - diff --git a/reference/ibase/functions/fbird-fetch-row.xml b/reference/ibase/functions/fbird-fetch-row.xml deleted file mode 100644 index 8e91babea7..0000000000 --- a/reference/ibase/functions/fbird-fetch-row.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_fetch_row - &Alias; ibase_fetch_row - - - - &reftitle.description; - - &info.function.alias; - ibase_fetch_row. - - - - - &reftitle.seealso; - - fbird_fetch_assoc - fbird_fetch_object - - - - - diff --git a/reference/ibase/functions/fbird-field-info.xml b/reference/ibase/functions/fbird-field-info.xml deleted file mode 100644 index e5ddea49c9..0000000000 --- a/reference/ibase/functions/fbird-field-info.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - fbird_field_info - &Alias; ibase_field_info - - - - &reftitle.description; - - &info.function.alias; - ibase_field_info. - - - - - &reftitle.seealso; - - fbird_num_fields - - - - - diff --git a/reference/ibase/functions/fbird-free-event-handler.xml b/reference/ibase/functions/fbird-free-event-handler.xml deleted file mode 100644 index c72d9ebf53..0000000000 --- a/reference/ibase/functions/fbird-free-event-handler.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - fbird_free_event_handler - &Alias; ibase_free_event_handler - - - - &reftitle.description; - - &info.function.alias; - ibase_free_event_handler. - - - - - &reftitle.seealso; - - fbird_set_event_handler - - - - - diff --git a/reference/ibase/functions/fbird-free-query.xml b/reference/ibase/functions/fbird-free-query.xml deleted file mode 100644 index 3bbd9a4a14..0000000000 --- a/reference/ibase/functions/fbird-free-query.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_free_query - &Alias; ibase_free_query - - - - &reftitle.description; - - &info.function.alias; - ibase_free_query. - - - - - - diff --git a/reference/ibase/functions/fbird-free-result.xml b/reference/ibase/functions/fbird-free-result.xml deleted file mode 100644 index 7e5e3b95d0..0000000000 --- a/reference/ibase/functions/fbird-free-result.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_free_result - &Alias; ibase_free_result - - - - &reftitle.description; - - &info.function.alias; - ibase_free_result. - - - - - - diff --git a/reference/ibase/functions/fbird-gen-id.xml b/reference/ibase/functions/fbird-gen-id.xml deleted file mode 100644 index c8f2eff216..0000000000 --- a/reference/ibase/functions/fbird-gen-id.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - - fbird_gen_id - &Alias; ibase_gen_id - - - - &reftitle.description; - - &info.function.alias; - ibase_gen_id. - - - - - - diff --git a/reference/ibase/functions/fbird-maintain-db.xml b/reference/ibase/functions/fbird-maintain-db.xml deleted file mode 100644 index aa7599a68a..0000000000 --- a/reference/ibase/functions/fbird-maintain-db.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_maintain_db - &Alias; ibase_maintain_db - - - - &reftitle.description; - - &info.function.alias; - ibase_maintain_db. - - - - - - diff --git a/reference/ibase/functions/fbird-modify-user.xml b/reference/ibase/functions/fbird-modify-user.xml deleted file mode 100644 index b3aec8cc3d..0000000000 --- a/reference/ibase/functions/fbird-modify-user.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_modify_user - &Alias; ibase_modify_user - - - - &reftitle.description; - - &info.function.alias; - ibase_modify_user. - - - - - &reftitle.seealso; - - fbird_add_user - fbird_delete_user - - - - - diff --git a/reference/ibase/functions/fbird-name-result.xml b/reference/ibase/functions/fbird-name-result.xml deleted file mode 100644 index 562abaec04..0000000000 --- a/reference/ibase/functions/fbird-name-result.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_name_result - &Alias; ibase_name_result - - - - &reftitle.description; - - &info.function.alias; - ibase_name_result. - - - - - &reftitle.seealso; - - fbird_prepare - fbird_execute - - - - - diff --git a/reference/ibase/functions/fbird-num-fields.xml b/reference/ibase/functions/fbird-num-fields.xml deleted file mode 100644 index de369b10b6..0000000000 --- a/reference/ibase/functions/fbird-num-fields.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - fbird_num_fields - &Alias; ibase_num_fields - - - - &reftitle.description; - - &info.function.alias; - ibase_num_fields. - - - - - &reftitle.seealso; - - fbird_field_info - - - - - diff --git a/reference/ibase/functions/fbird-num-params.xml b/reference/ibase/functions/fbird-num-params.xml deleted file mode 100644 index fc2c58b89c..0000000000 --- a/reference/ibase/functions/fbird-num-params.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_num_params - &Alias; ibase_num_params - - - - &reftitle.description; - - &info.function.alias; - ibase_num_params. - - - - - &reftitle.seealso; - - fbird_prepare - fbird_param_info - - - - - diff --git a/reference/ibase/functions/fbird-param-info.xml b/reference/ibase/functions/fbird-param-info.xml deleted file mode 100644 index d426359263..0000000000 --- a/reference/ibase/functions/fbird-param-info.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_param_info - &Alias; ibase_param_info - - - - &reftitle.description; - - &info.function.alias; - ibase_param_info. - - - - - &reftitle.seealso; - - fbird_field_info - fbird_num_params - - - - - diff --git a/reference/ibase/functions/fbird-pconnect.xml b/reference/ibase/functions/fbird-pconnect.xml deleted file mode 100644 index 77285ec034..0000000000 --- a/reference/ibase/functions/fbird-pconnect.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_pconnect - &Alias; ibase_pconnect - - - - &reftitle.description; - - &info.function.alias; - ibase_pconnect. - - - - - &reftitle.seealso; - - fbird_close - fbird_connect - - - - - diff --git a/reference/ibase/functions/fbird-prepare.xml b/reference/ibase/functions/fbird-prepare.xml deleted file mode 100644 index 5ad62bf915..0000000000 --- a/reference/ibase/functions/fbird-prepare.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_prepare - &Alias; ibase_prepare - - - - &reftitle.description; - - &info.function.alias; - ibase_prepare. - - - - - - diff --git a/reference/ibase/functions/fbird-query.xml b/reference/ibase/functions/fbird-query.xml deleted file mode 100644 index bdb2897adb..0000000000 --- a/reference/ibase/functions/fbird-query.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - fbird_query - &Alias; ibase_query - - - - &reftitle.description; - - &info.function.alias; - ibase_query. - - - - - &reftitle.seealso; - - fbird_errmsg - fbird_fetch_row - fbird_fetch_object - fbird_free_result - - - - - diff --git a/reference/ibase/functions/fbird-restore.xml b/reference/ibase/functions/fbird-restore.xml deleted file mode 100644 index bd217c9677..0000000000 --- a/reference/ibase/functions/fbird-restore.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_restore - &Alias; ibase_restore - - - - &reftitle.description; - - &info.function.alias; - ibase_restore. - - - - - - diff --git a/reference/ibase/functions/fbird-rollback-ret.xml b/reference/ibase/functions/fbird-rollback-ret.xml deleted file mode 100644 index 855a631da8..0000000000 --- a/reference/ibase/functions/fbird-rollback-ret.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_rollback_ret - &Alias; ibase_rollback_ret - - - - &reftitle.description; - - &info.function.alias; - ibase_rollback_ret. - - - - - - diff --git a/reference/ibase/functions/fbird-rollback.xml b/reference/ibase/functions/fbird-rollback.xml deleted file mode 100644 index 19747823c2..0000000000 --- a/reference/ibase/functions/fbird-rollback.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_rollback - &Alias; ibase_rollback - - - - &reftitle.description; - - &info.function.alias; - ibase_rollback. - - - - - - diff --git a/reference/ibase/functions/fbird-server-info.xml b/reference/ibase/functions/fbird-server-info.xml deleted file mode 100644 index 5ded5a80c9..0000000000 --- a/reference/ibase/functions/fbird-server-info.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_server_info - &Alias; ibase_server_info - - - - &reftitle.description; - - &info.function.alias; - ibase_server_info. - - - - - - diff --git a/reference/ibase/functions/fbird-service-attach.xml b/reference/ibase/functions/fbird-service-attach.xml deleted file mode 100644 index be6fa913ca..0000000000 --- a/reference/ibase/functions/fbird-service-attach.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_service_attach - &Alias; ibase_service_attach - - - - &reftitle.description; - - &info.function.alias; - ibase_service_attach. - - - - - - diff --git a/reference/ibase/functions/fbird-service-detach.xml b/reference/ibase/functions/fbird-service-detach.xml deleted file mode 100644 index 0a40f13b52..0000000000 --- a/reference/ibase/functions/fbird-service-detach.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_service_detach - &Alias; ibase_service_detach - - - - &reftitle.description; - - &info.function.alias; - ibase_service_detach. - - - - - - diff --git a/reference/ibase/functions/fbird-set-event-handler.xml b/reference/ibase/functions/fbird-set-event-handler.xml deleted file mode 100644 index 84b4f15ca0..0000000000 --- a/reference/ibase/functions/fbird-set-event-handler.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_set_event_handler - &Alias; ibase_set_event_handler - - - - &reftitle.description; - - &info.function.alias; - ibase_set_event_handler. - - - - - &reftitle.seealso; - - fbird_free_event_handler - fbird_wait_event - - - - - diff --git a/reference/ibase/functions/fbird-trans.xml b/reference/ibase/functions/fbird-trans.xml deleted file mode 100644 index 7befae6db9..0000000000 --- a/reference/ibase/functions/fbird-trans.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_trans - &Alias; ibase_trans - - - - &reftitle.description; - - &info.function.alias; - ibase_trans. - - - - - - diff --git a/reference/ibase/functions/fbird-wait-event.xml b/reference/ibase/functions/fbird-wait-event.xml deleted file mode 100644 index 87c8770053..0000000000 --- a/reference/ibase/functions/fbird-wait-event.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_wait_event - &Alias; ibase_wait_event - - - - &reftitle.description; - - &info.function.alias; - ibase_wait_event. - - - - - &reftitle.seealso; - - fbird_set_event_handler - fbird_free_event_handler - - - - - diff --git a/reference/ibase/functions/ibase-add-user.xml b/reference/ibase/functions/ibase-add-user.xml deleted file mode 100644 index 4e64944ade..0000000000 --- a/reference/ibase/functions/ibase-add-user.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - ibase_add_user - Ajoute un utilisateur à une base de données de sécurité - - - - &reftitle.description; - - boolibase_add_user - resourceservice_handle - stringuser_name - stringpassword - stringfirst_name - stringmiddle_name - stringlast_name - - - - - &reftitle.parameters; - - - service_handle - - - Le gestionnaire sur le service du serveur de base de données. - - - - - user_name - - - L'identifiant pour le nouvel utilisateur de la base de données. - - - - - password - - - Le mot de passe pour le nouvel utilisateur. - - - - - first_name - - - Le prénom pour le nouvel utilisateur de la base de données. - - - - - middle_name - - - Le deuxième prénom pour le nouvel utilisateur de la base de données. - - - - - last_name - - - Le nom de famille pour le nouvel utilisateur de la base de données. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_modify_user - ibase_delete_user - - - - - diff --git a/reference/ibase/functions/ibase-affected-rows.xml b/reference/ibase/functions/ibase-affected-rows.xml deleted file mode 100644 index 6d2451b991..0000000000 --- a/reference/ibase/functions/ibase-affected-rows.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - ibase_affected_rows - Retourne le nombre de lignes affectées par la dernière requête iBase - - - - &reftitle.description; - - intibase_affected_rows - resourcelink_identifier - - - Retourne le nombre de lignes qui ont été affectées par la - dernière requête (INSERT, UPDATE ou DELETE) qui a été exécutée - dans le contexte de transaction spécifié par - link_identifier. - - - - - &reftitle.parameters; - - - link_identifier - - - Un contexte de transaction. Si link_identifier - est une ressource de connexion, la transaction par défaut est - utilisée. - - - - - - - - &reftitle.returnvalues; - - Retourne le nombre de lignes, sous la forme d'un &integer;. - - - - - &reftitle.seealso; - - ibase_query - ibase_execute - - - - - diff --git a/reference/ibase/functions/ibase-backup.xml b/reference/ibase/functions/ibase-backup.xml deleted file mode 100644 index 37b62bd9cc..0000000000 --- a/reference/ibase/functions/ibase-backup.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - ibase_backup - Lance une tâche de sauvegarde dans le gestionnaire de services et retourne immédiatement - - - - &reftitle.description; - - mixedibase_backup - resourceservice_handle - stringsource_db - stringdest_file - intoptions0 - boolverbose&false; - - - Cette fonction transmet les arguments au serveur de base de données (distant). - Là, il commence un nouveau processus de sauvegarde. - Par conséquent, le résultat ne sera aucune réponse. - - - - - &reftitle.parameters; - - - service_handle - - - Une connexion au serveur de base de données créée précédemment. - - - - - source_db - - - Le chemin absolu vers la base de données sur le serveur de base de données. - Il est également possible d'utiliser un alias de base de données. - - - - - dest_file - - - Le chemin absolu vers le fichier de sauvegarde sur le serveur de base de données. - - - - - options - - - Options supplémentaires à transmettre au serveur de base de données - pour la sauvegarde. - Le paramètre options peut être une combinaison - des constantes suivantes : - IBASE_BKP_IGNORE_CHECKSUMS, - IBASE_BKP_IGNORE_LIMBO, - IBASE_BKP_METADATA_ONLY, - IBASE_BKP_NO_GARBAGE_COLLECT, - IBASE_BKP_OLD_DESCRIPTIONS, - IBASE_BKP_NON_TRANSPORTABLE ou - IBASE_BKP_CONVERT. - Lire la section à propos des pour - plus d'information. - - - - - verbose - - - Étant donné que le processus de sauvegarde est effectué sur le serveur - de base de données, l’on n’a aucune chance d’obtenir sa sortie. - Cet argument est inutile. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - Le processus de sauvegarde étant effectué sur le serveur (distant), - cette fonction ne fait que lui transmettre les arguments. - Tant que les arguments sont légaux, le résultat ne sera pas &false;. - - - - - &reftitle.examples; - - Exemple avec <function>ibase_backup</function> - - -]]> - - - - - Exemple de <function>ibase_backup</function> avec des arguments - - -]]> - - - - - - &reftitle.seealso; - - ibase_restore - - - - - diff --git a/reference/ibase/functions/ibase-blob-add.xml b/reference/ibase/functions/ibase-blob-add.xml deleted file mode 100644 index 6f9c746e18..0000000000 --- a/reference/ibase/functions/ibase-blob-add.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - ibase_blob_add - Ajoute des données dans un BLOB iBase fraîchement créé - - - - &reftitle.description; - - voidibase_blob_add - resourceblob_handle - stringdata - - - ibase_blob_add ajoute les données - data dans le BLOB - blob_handle, créé - avec ibase_blob_create. - - - - - &reftitle.parameters; - - - blob_handle - - - Une ressource blob, ouverte avec la fonction - ibase_blob_create. - - - - - data - - - Les données à ajouter. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - ibase_blob_cancel - ibase_blob_close - ibase_blob_create - ibase_blob_import - - - - - diff --git a/reference/ibase/functions/ibase-blob-cancel.xml b/reference/ibase/functions/ibase-blob-cancel.xml deleted file mode 100644 index e1ecc29101..0000000000 --- a/reference/ibase/functions/ibase-blob-cancel.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - ibase_blob_cancel - Annule la création d'un BLOB iBase - - - - &reftitle.description; - - boolibase_blob_cancel - resourceblob_handle - - - ibase_blob_cancel annule la création du BLOB - blob_handle, créé par - ibase_blob_create s'il n'a pas encore été fermé - avec ibase_blob_close. - - - - - &reftitle.parameters; - - - blob_handle - - - Une ressource blob, ouverte avec la fonction - ibase_blob_create. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_blob_close - ibase_blob_create - ibase_blob_import - - - - - diff --git a/reference/ibase/functions/ibase-blob-close.xml b/reference/ibase/functions/ibase-blob-close.xml deleted file mode 100644 index 8121b51c7c..0000000000 --- a/reference/ibase/functions/ibase-blob-close.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - ibase_blob_close - Ferme un BLOB iBase - - - - &reftitle.description; - - mixedibase_blob_close - resourceblob_handle - - - ibase_blob_close ferme le BLOB - blob_handle, ouvert en lecture - avec ibase_open_blob ou en écriture avec - ibase_blob_create. - - - - - &reftitle.parameters; - - - blob_handle - - - Une ressource blob, ouverte avec la fonction - ibase_blob_create ou la fonction - ibase_blob_open. - - - - - - - - &reftitle.returnvalues; - - Si le BLOB était lu, ibase_blob_close retourne &true; - en cas de succès, s'il était en cours de modification, - ibase_blob_close retourne une chaîne de caractères - contenant l'identifiant du BLOB qui lui a été assigné par la base de données. - En cas d'échec, cette fonction retournera &false;. - - - - - &reftitle.seealso; - - ibase_blob_cancel - ibase_blob_open - - - - - diff --git a/reference/ibase/functions/ibase-blob-create.xml b/reference/ibase/functions/ibase-blob-create.xml deleted file mode 100644 index d18309e9cd..0000000000 --- a/reference/ibase/functions/ibase-blob-create.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - ibase_blob_create - Crée un BLOB iBase pour ajouter des données - - - - &reftitle.description; - - resourcefalseibase_blob_create - resourcelink_identifier&null; - - - ibase_blob_create crée un nouveau BLOB - à remplir avec des données, sur la connexion InterBase - link_identifier. - - - - - &reftitle.parameters; - - - link_identifier - - - Un identifiant de connexion à InterBase. S'il est omis, la dernière - connexion ouverte sera utilisée. - - - - - - - - &reftitle.returnvalues; - - Retourne un identifiant de BLOB à utiliser avec - ibase_blob_add&return.falseforfailure;. - - - - - &reftitle.seealso; - - ibase_blob_add - ibase_blob_cancel - ibase_blob_close - ibase_blob_import - - - - - diff --git a/reference/ibase/functions/ibase-blob-echo.xml b/reference/ibase/functions/ibase-blob-echo.xml deleted file mode 100644 index 13a0f1d948..0000000000 --- a/reference/ibase/functions/ibase-blob-echo.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - ibase_blob_echo - Affiche le contenu d'un BLOB iBase au navigateur - - - - &reftitle.description; - - boolibase_blob_echo - stringblob_id - - - boolibase_blob_echo - resourcelink_identifier - stringblob_id - - - ibase_blob_echo ouvre le BLOB - blob_id en lecture et envoie son contenu directement - vers la sortie standard (le navigateur dans la plupart des cas). - - - - - &reftitle.parameters; - - - link_identifier - - - Un identifiant de connexion à InterBase. S'il est omis, la dernière connexion - ouverte sera utilisée. - - - - - blob_id - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_blob_open - ibase_blob_close - ibase_blob_get - - - - - diff --git a/reference/ibase/functions/ibase-blob-get.xml b/reference/ibase/functions/ibase-blob-get.xml deleted file mode 100644 index b53c0ce684..0000000000 --- a/reference/ibase/functions/ibase-blob-get.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - ibase_blob_get - Lit len octets de données dans un BLOB iBase ouvert - - - - &reftitle.description; - - stringibase_blob_get - resourceblob_handle - intlen - - - ibase_blob_get retourne au plus len - octets du BLOB blob_handle - qui a été ouvert en lecture par ibase_blob_open. - - - - Il n'est pas possible de lire dans un BLOB ouvert en écriture par - ibase_blob_create. - - - - - - &reftitle.parameters; - - - blob_handle - - - Une ressource blob, ouverte avec la fonction - ibase_blob_open. - - - - - len - - - La taille des données retournées. - - - - - - - - &reftitle.returnvalues; - - Retourne au plus, len octets du BLOB, ou - &false; si une erreur survient. - - - - - &reftitle.examples; - - - Exemple avec <function>ibase_blob_get</function> - -BLOB_VALUE); -$blob_hndl = ibase_blob_open($data->BLOB_VALUE); -echo ibase_blob_get($blob_hndl, $blob_data[0]); -?> -]]> - - - Cet exemple ne fait pas plus qu'un - ibase_blob_echo( $data->BLOB_VALUE ), mais il - montre comment récupérer les informations dans une $variable pour les - manipuler comme on le souhaite. - - - - - &reftitle.seealso; - - ibase_blob_open - ibase_blob_close - ibase_blob_echo - - - - - diff --git a/reference/ibase/functions/ibase-blob-import.xml b/reference/ibase/functions/ibase-blob-import.xml deleted file mode 100644 index 0706ac8fd7..0000000000 --- a/reference/ibase/functions/ibase-blob-import.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - ibase_blob_import - Crée un BLOB iBase, y copie un fichier et le referme - - - - &reftitle.description; - - stringibase_blob_import - resourcelink_identifier - resourcefile_handle - - - stringibase_blob_import - resourcefile_handle - - - ibase_blob_import crée un nouveau BLOB - sur la connexion iBase link_identifier, - y copie le fichier file_handle en entier, le referme et en - retourne l'identifiant assigné - - - - - &reftitle.parameters; - - - link_identifier - - - Un identifiant de connexion à InterBase. S'il est omis, la dernière - connexion ouverte sera utilisée. - - - - - file_handle - - - La ressource de fichier, retournée par la fonction - fopen. - - - - - - - - &reftitle.returnvalues; - - Retourne l'identifiant du BLOB en cas de succès, ou &false; - si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>ibase_blob_import</function> - - -]]> - - - - - - &reftitle.seealso; - - ibase_blob_add - ibase_blob_cancel - ibase_blob_close - ibase_blob_create - - - - - diff --git a/reference/ibase/functions/ibase-blob-info.xml b/reference/ibase/functions/ibase-blob-info.xml deleted file mode 100644 index 281da35ac7..0000000000 --- a/reference/ibase/functions/ibase-blob-info.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - ibase_blob_info - Retourne la taille d'un BLOB iBase et d'autres informations utiles - - - - &reftitle.description; - - arrayibase_blob_info - resourcelink_identifier - stringblob_id - - - arrayibase_blob_info - stringblob_id - - - Retourne la taille d'un BLOB iBase et d'autres informations utiles. - - - - - &reftitle.parameters; - - - link_identifier - - - Un identifiant de connexion à InterBase. S'il est omis, la dernière - connexion ouverte sera utilisée. - - - - - blob_id - - - L'identifiant du BLOB. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant des informations à propos du BLOB - blob_id. Les informations sont la taille - du BLOB, le nombre de segments qu'il contient, la taille du - segment le plus large, et indiquent s'il s'agit d'un BLOB stream - ou segmenté. - - - - - diff --git a/reference/ibase/functions/ibase-blob-open.xml b/reference/ibase/functions/ibase-blob-open.xml deleted file mode 100644 index be3f9fa271..0000000000 --- a/reference/ibase/functions/ibase-blob-open.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - ibase_blob_open - Ouvre un BLOB iBase pour récupérer des parties de données - - - - &reftitle.description; - - resourcefalseibase_blob_open - resourcelink_identifier - stringblob_id - - - resourcefalseibase_blob_open - stringblob_id - - - Ouvre un BLOB iBase pour récupérer des parties de données. - - - - - &reftitle.parameters; - - - link_identifier - - - Un identifiant de connexion à InterBase. S'il est omis, la dernière - connexion ouverte sera utilisée. - - - - - blob_id - - - L'identifiant du BLOB. - - - - - - - - &reftitle.returnvalues; - - Retourne une ressource BLOB pour une utilisation avec la fonction - ibase_blob_get&return.falseforfailure;. - - - - - &reftitle.seealso; - - ibase_blob_close - ibase_blob_echo - ibase_blob_get - - - - - diff --git a/reference/ibase/functions/ibase-close.xml b/reference/ibase/functions/ibase-close.xml deleted file mode 100644 index 4aca9c2396..0000000000 --- a/reference/ibase/functions/ibase-close.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - ibase_close - Ferme une connexion à une base de données Interbase - - - - &reftitle.description; - - boolibase_close - resourceconnection_id&null; - - - Ferme une connexion à une base de données Interbase. Cette fonction prend - comme argument l'identifiant de connexion connection_id - retourné par ibase_connect. Les transactions par défaut - sont validées et les autres sont annulées. - - - - - &reftitle.parameters; - - - connection_id - - - Un identifiant de connexion à InterBase, retourné par la fonction - ibase_connect. S'il est omis, la dernière - connexion ouverte sera utilisée. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_connect - ibase_pconnect - - - - - diff --git a/reference/ibase/functions/ibase-commit-ret.xml b/reference/ibase/functions/ibase-commit-ret.xml deleted file mode 100644 index ce7237ccf3..0000000000 --- a/reference/ibase/functions/ibase-commit-ret.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - ibase_commit_ret - Valide une transaction iBase sans la refermer - - - - &reftitle.description; - - boolibase_commit_ret - resourcelink_or_trans_identifier&null; - - - Valide une transaction iBase sans la refermer. - - - - - &reftitle.parameters; - - - link_or_trans_identifier - - - Appelée sans argument, - elle valide la transaction par défaut de la connexion - par défaut. Si l'argument link_or_trans_identifier - est un identifiant de connexion, sa transaction par défaut - est validée. Si l'argument link_or_trans_identifier est un - identifiant de transaction, celle-ci sera validée. - Le contexte de transaction sera retenu et, donc, les requêtes exécutées - dans cette transaction ne seront pas invalidées. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-commit.xml b/reference/ibase/functions/ibase-commit.xml deleted file mode 100644 index 0b73b85531..0000000000 --- a/reference/ibase/functions/ibase-commit.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - ibase_commit - Valide une transaction iBase - - - - &reftitle.description; - - boolibase_commit - resourcelink_or_trans_identifier&null; - - - Valide une transaction iBase. - - - - - &reftitle.parameters; - - - link_or_trans_identifier - - - Appelée sans argument, - elle valide la transaction par défaut de la connexion - par défaut. Si l'argument link_or_trans_identifier - est un identifiant de connexion, sa transaction par défaut - est validée. Si l'argument link_or_trans_identifier est un - identifiant de transaction, celle-ci sera validée. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-connect.xml b/reference/ibase/functions/ibase-connect.xml deleted file mode 100644 index a9005a335a..0000000000 --- a/reference/ibase/functions/ibase-connect.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - ibase_connect - Ouvre une connexion à une base de données - - - - &reftitle.description; - - resourceibase_connect - stringdatabase - stringusername - stringpassword - stringcharset - intbuffers - intdialect - stringrole - intsync - - - Ouvre une connexion à une base de données Firebird/InterBase. - - - Si un deuxième appel est fait avec ibase_connect, en - passant les mêmes arguments, une nouvelle connexion ne sera pas ouverte, - mais la connexion déjà ouverte sera retournée. La connexion - sera fermée dès que le script se termine, à moins qu'elle - ne soit fermée explicitement avec ibase_close, - durant le script. - - - - - &reftitle.parameters; - - - database - - - database doit être un chemin - valide jusqu'à un fichier de base de données sur le serveur sur - lequel il réside. Si le serveur est distant, il faut le préfixer - avec un nom d'hôte 'hostname:' (TCP/IP), 'hostname/port:' - (TCP/IP avec un serveur interbase sur un port TCP personnalisé), '//hostname/' - (NetBEUI) en fonction du protocole de communication utilisé. - - - - - username - - - Le nom d'utilisateur. Peut être défini avec la directive - ibase.default_user du fichier &php.ini;. - - - - - password - - - Le mot de passe correspondant à l'utilisateur username. - Peut être défini avec la directive - ibase.default_password du fichier &php.ini;. - - - - - charset - - - charset est le jeu de caractères par défaut - pour la base de données. - - - - - buffers - - - buffers est le nombre de buffers de base de données à - allouer pour le cache serveur. S'il est passé à 0 ou - omis, le serveur le choisira de lui-même. - - - - - dialect - - - dialect - sélectionne le dialecte SQL pour les requêtes exécutées - avec cette connexion et, par défaut, il utilise le meilleur dialecte - disponible. - - - - - role - - - Ne fonctionne qu'avec InterBase 5 et supérieur. - - - - - sync - - - - - - - - - - &reftitle.returnvalues; - - Retourne un identifiant de connexion Firebird/InterBase en cas de succès, - ou &false; si une erreur survient. - - - - - &reftitle.errors; - - Si l'on a quelques erreurs comme "arithmetic exception, numeric overflow, - or string truncation. Cannot transliterate character between character - sets" (cela se produit lors de la tentative d'utiliser des caractères accentués) lorsque - l'on utilise ibase_connect - et après ibase_query, il faut spécifier un jeu de caractères - correct (c.-à-d. ISO8859_1 ou le jeu de caractères courant). - - - - - &reftitle.examples; - - Exemple avec <function>ibase_connect</function> - -email, "\n"; -} -ibase_free_result($sth); -ibase_close($dbh); -?> -]]> - - - - - - &reftitle.seealso; - - ibase_pconnect - ibase_close - - - - - diff --git a/reference/ibase/functions/ibase-db-info.xml b/reference/ibase/functions/ibase-db-info.xml deleted file mode 100644 index d3c5cf1049..0000000000 --- a/reference/ibase/functions/ibase-db-info.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - ibase_db_info - Demande des statistiques sur une base de données Interbase - - - - &reftitle.description; - - stringibase_db_info - resourceservice_handle - stringdb - intaction - intargument0 - - - &warn.undocumented.func; - - - - - - diff --git a/reference/ibase/functions/ibase-delete-user.xml b/reference/ibase/functions/ibase-delete-user.xml deleted file mode 100644 index 62c7db1c1a..0000000000 --- a/reference/ibase/functions/ibase-delete-user.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - ibase_delete_user - Efface un utilisateur d'une base de données de sécurité - - - - &reftitle.description; - - boolibase_delete_user - resourceservice_handle - stringuser_name - - - - - &reftitle.parameters; - - - service_handle - - - Le gestionnaire sur le service du serveur de base de données. - - - - - user_name - - - L'identifiant de l'utilisateur qui doit être supprimé de la base de données. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_add_user - ibase_modify_user - - - - - diff --git a/reference/ibase/functions/ibase-drop-db.xml b/reference/ibase/functions/ibase-drop-db.xml deleted file mode 100644 index ed91e023d0..0000000000 --- a/reference/ibase/functions/ibase-drop-db.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - ibase_drop_db - Supprime une base de données iBase - - - - &reftitle.description; - - boolibase_drop_db - resourceconnection&null; - - - ibase_drop_db supprime une base de données - qui a été ouverte par ibase_connect - ou ibase_pconnect. La base de données est - refermée et supprimée du serveur. - - - - - &reftitle.parameters; - - - connection - - - Un identifiant de connexion à InterBase. S'il est omis, la dernière - connexion ouverte sera utilisée. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_connect - ibase_pconnect - - - - - diff --git a/reference/ibase/functions/ibase-errcode.xml b/reference/ibase/functions/ibase-errcode.xml deleted file mode 100644 index 92ebfc8e98..0000000000 --- a/reference/ibase/functions/ibase-errcode.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - ibase_errcode - Retourne le code d'erreur iBase - - - - &reftitle.description; - - intibase_errcode - - - - Retourne le code erreur résultant de l'appel le plus récent à une - fonction InterBase. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le code erreur, sous la forme d'un &integer;, ou &false; - si aucune erreur n'est survenue. - - - - - &reftitle.seealso; - - ibase_errmsg - - - - - diff --git a/reference/ibase/functions/ibase-errmsg.xml b/reference/ibase/functions/ibase-errmsg.xml deleted file mode 100644 index c939515979..0000000000 --- a/reference/ibase/functions/ibase-errmsg.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - ibase_errmsg - Retourne un message d'erreur - - - - &reftitle.description; - - stringibase_errmsg - - - - Retourne une chaîne contenant les messages d'erreurs. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le message d'erreur, sous la forme d'une &string;, ou - &false; si aucune erreur n'est survenue. - - - - - &reftitle.seealso; - - ibase_errcode - - - - - diff --git a/reference/ibase/functions/ibase-execute.xml b/reference/ibase/functions/ibase-execute.xml deleted file mode 100644 index 6daa1cc32f..0000000000 --- a/reference/ibase/functions/ibase-execute.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - ibase_execute - Exécute une requête iBase préparée - - - - &reftitle.description; - - resourceibase_execute - resourcequery - mixedvalues - - - Exécute une requête iBase préparée. - - - ibase_execute est beaucoup plus efficace que - ibase_query, si l'on effectue plusieurs fois - la même requête en ne changeant que quelques paramètres. - - - - - &reftitle.parameters; - - - query - - - Une requête InterBase, préparée avec la fonction - ibase_prepare. - - - - - values - - - - - - - - - - &reftitle.returnvalues; - - Si la requête émet une erreur, la fonction retournera &false;. Si la requête - réussit, et qu'il y a un jeu de résultats (pouvant être vide), la fonction - retourne un identifiant de résultats. Si la requête réussit et qu'il n'y - a pas de résultat, la fonction retourne &true;. - - - - ibase_execute retourne le nombre - d'enregistrements affectés par la requête (si supérieur à 0). - Pour une requête qui réussit mais qui ne renvoie aucun enregistrement - (p. ex. un UPDATE sur un enregistrement inexistant), - ibase_execute retournera &true;. - - - - - - &reftitle.examples; - - Exemple avec <function>ibase_execute</function> - - 'Eric', - 5 => 'Filip', - 7 => 'Larry' -); - -$query = ibase_prepare($dbh, "UPDATE FOO SET BAR = ? WHERE BAZ = ?"); - -foreach ($updates as $baz => $bar) { - ibase_execute($query, $bar, $baz); -} - -?> -]]> - - - - - - &reftitle.seealso; - - ibase_query - - - - - diff --git a/reference/ibase/functions/ibase-fetch-assoc.xml b/reference/ibase/functions/ibase-fetch-assoc.xml deleted file mode 100644 index cf8162ef09..0000000000 --- a/reference/ibase/functions/ibase-fetch-assoc.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - ibase_fetch_assoc - Récupère une ligne du résultat d'une requête dans un tableau associatif - - - - &reftitle.description; - - arrayibase_fetch_assoc - resourceresult - intfetch_flag0 - - - Récupère une ligne du résultat d'une requête dans un tableau associatif. - - - ibase_fetch_assoc récupère une ligne - de données à partir de result. Si - deux ou plus colonnes ont le même nom de champ, la dernière - colonne prendra précédence. Pour accéder aux autres - colonnes du même nom, il faut soit le faire avec leurs - indices numériques en utilisant ibase_fetch_row - ou en utilisant des alias dans la requête. - - - - - &reftitle.parameters; - - - result - - - Le jeu de résultats. - - - - - fetch_flag - - - fetch_flag est une combinaison des constantes - IBASE_TEXT et IBASE_UNIXTIME. - Passer IBASE_TEXT fait retourner le contenu du BLOB - au lieu de l'ID du BLOB. Passer IBASE_UNIXTIME fait retourner les valeurs - date/time sous forme de timestamps UNIX au lieu de chaînes formatées. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif qui correspond à la ligne récupérée. Les - appels suivants renvoient la ligne qui suit dans le jeu de résultats, - ou &false; s'il n'y a plus de lignes. - - - - - &reftitle.seealso; - - ibase_fetch_row - ibase_fetch_object - - - - - diff --git a/reference/ibase/functions/ibase-fetch-object.xml b/reference/ibase/functions/ibase-fetch-object.xml deleted file mode 100644 index c6295300f5..0000000000 --- a/reference/ibase/functions/ibase-fetch-object.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - ibase_fetch_object - Lit une ligne dans une base Interbase dans un objet - - - - &reftitle.description; - - objectibase_fetch_object - resourceresult_id - intfetch_flag0 - - - Lit une ligne dans une base Interbase et la place dans un pseudo objet. - - - Les prochains appels à la fonction ibase_fetch_object - retournent la prochaine ligne du jeu de résultats. - - - - - &reftitle.parameters; - - - result_id - - - Un identifiant de résultat InterBase, obtenu soit par la fonction - ibase_query, soit par la fonction - ibase_execute. - - - - - fetch_flag - - - fetch_flag est une combinaison des constantes - IBASE_TEXT et IBASE_UNIXTIME. - Passer IBASE_TEXT fait retourner le contenu du BLOB - au lieu de l'ID du BLOB. Passer IBASE_UNIXTIME - fait retourner les valeurs date/time sous forme de timestamps UNIX au - lieu de chaînes formatées. - - - - - - - - &reftitle.returnvalues; - - Retourne un objet contenant les informations de la ligne, ou &false; - s'il n'y a plus de ligne. - - - - - &reftitle.examples; - - Exemple avec <function>ibase_fetch_object</function> - -email . "\n"; -} -ibase_close($dbh); -?> -]]> - - - - - - &reftitle.seealso; - - ibase_fetch_row - ibase_fetch_assoc - - - - - diff --git a/reference/ibase/functions/ibase-fetch-row.xml b/reference/ibase/functions/ibase-fetch-row.xml deleted file mode 100644 index 10bc991d8c..0000000000 --- a/reference/ibase/functions/ibase-fetch-row.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - ibase_fetch_row - Lit une ligne d'une base Interbase - - - - &reftitle.description; - - arrayibase_fetch_row - resourceresult_identifier - intfetch_flag0 - - - ibase_fetch_row récupère une ligne de données - depuis le jeu de résultats donné. - - - Les appels suivants à ibase_fetch_row vont retourner - la prochaine ligne dans le résultat, ou bien &false; s'il n'y a plus - de ligne. - - - - - &reftitle.parameters; - - - result_identifier - - - Un identifiant de résultat InterBase. - - - - - fetch_flag - - - fetch_flag est une combinaison des constantes - IBASE_TEXT et IBASE_UNIXTIME. - Passer IBASE_TEXT fait retourner le contenu du BLOB - au lieu de l'ID du BLOB. Passer IBASE_UNIXTIME fait - retourner les valeurs date/time sous forme de timestamps UNIX au lieu de - chaînes formatées. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau correspondant à la ligne récupérée, ou &false; - s'il n'y a plus de ligne. Chaque colonne du résultat est stockée - dans une position du tableau, en commençant à 0. - - - - - &reftitle.seealso; - - ibase_fetch_assoc - ibase_fetch_object - - - - - diff --git a/reference/ibase/functions/ibase-field-info.xml b/reference/ibase/functions/ibase-field-info.xml deleted file mode 100644 index d0c74c702f..0000000000 --- a/reference/ibase/functions/ibase-field-info.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - ibase_field_info - Lit les informations sur un champ iBase - - - - &reftitle.description; - - arrayibase_field_info - resourceresult - intfield_number - - - Retourne un tableau contenant les informations d'un champ, après - qu'une requête de type sélection ait été exécutée. - - - - - &reftitle.parameters; - - - result - - - Un identifiant de résultat InterBase. - - - - - field_number - - - Position du champ. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les clés suivantes : name, - alias, relation, - length et type. - - - - - &reftitle.examples; - - Exemple avec <function>ibase_field_info</function> - - -]]> - - - - - - &reftitle.seealso; - - ibase_num_fields - - - - - diff --git a/reference/ibase/functions/ibase-free-event-handler.xml b/reference/ibase/functions/ibase-free-event-handler.xml deleted file mode 100644 index c10b6817c0..0000000000 --- a/reference/ibase/functions/ibase-free-event-handler.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - ibase_free_event_handler - Libère un gestionnaire d'événements iBase - - - - &reftitle.description; - - boolibase_free_event_handler - resourceevent - - - ibase_free_event_handler annule le gestionnaire - d'événements enregistré, spécifié - par event. La fonction de rappel ne sera plus - exécutée pour les événements qu'elle devait - prendre en charge. - - - - - &reftitle.parameters; - - - event - - - Une ressource d'événement, créée par la fonction - ibase_set_event_handler. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_set_event_handler - - - - - diff --git a/reference/ibase/functions/ibase-free-query.xml b/reference/ibase/functions/ibase-free-query.xml deleted file mode 100644 index 83e7da18f9..0000000000 --- a/reference/ibase/functions/ibase-free-query.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - ibase_free_query - Libère la mémoire réservée par une requête préparée - - - - &reftitle.description; - - boolibase_free_query - resourcequery - - - Libère la mémoire réservée par une requête préparée. - - - - - &reftitle.parameters; - - - query - - - Une requête préparée avec la fonction - ibase_prepare. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-free-result.xml b/reference/ibase/functions/ibase-free-result.xml deleted file mode 100644 index 85ef9642c4..0000000000 --- a/reference/ibase/functions/ibase-free-result.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - ibase_free_result - Libère un résultat iBase - - - - &reftitle.description; - - boolibase_free_result - resourceresult_identifier - - - Libère un résultat iBase. - - - - - &reftitle.parameters; - - - result_identifier - - - Un jeu de résultats, créé par la fonction - ibase_query ou par la fonction - ibase_execute. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-gen-id.xml b/reference/ibase/functions/ibase-gen-id.xml deleted file mode 100644 index 212d750765..0000000000 --- a/reference/ibase/functions/ibase-gen-id.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - ibase_gen_id - Incrémente le générateur donné et retourne sa nouvelle valeur - - - - &reftitle.description; - - mixedibase_gen_id - stringgenerator - intincrement1 - resourcelink_identifier&null; - - - &warn.undocumented.func; - - - - - &reftitle.returnvalues; - - Retourne une nouvelle valeur générée sous la forme d'un &integer; ou d'une - &string; si la valeur est trop grosse. - - - - - diff --git a/reference/ibase/functions/ibase-maintain-db.xml b/reference/ibase/functions/ibase-maintain-db.xml deleted file mode 100644 index d7ccda8a60..0000000000 --- a/reference/ibase/functions/ibase-maintain-db.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - ibase_maintain_db - Exécute une commande de maintenance sur une base de données Interbase - - - - &reftitle.description; - - boolibase_maintain_db - resourceservice_handle - stringdb - intaction - intargument0 - - - &warn.undocumented.func; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-modify-user.xml b/reference/ibase/functions/ibase-modify-user.xml deleted file mode 100644 index 072d449693..0000000000 --- a/reference/ibase/functions/ibase-modify-user.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - ibase_modify_user - Modifie un utilisateur dans une base de données de sécurité - - - - &reftitle.description; - - boolibase_modify_user - resourceservice_handle - stringuser_name - stringpassword - stringfirst_name - stringmiddle_name - stringlast_name - - - - - &reftitle.parameters; - - - service_handle - - - Le gestionnaire sur le service du serveur de base de données. - - - - - user_name - - - L'identifiant de l'utilisateur de base de données à modifier. - - - - - password - - - Le nouveau mot de passe de l'utilisateur. - - - - - first_name - - - Le nouveau prénom de l'utilisateur. - - - - - middle_name - - - Le nouveau deuxième prénom de l'utilisateur. - - - - - last_name - - - Le nouveau nom de famille de l'utilisateur. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_add_user - ibase_delete_user - - - - - diff --git a/reference/ibase/functions/ibase-name-result.xml b/reference/ibase/functions/ibase-name-result.xml deleted file mode 100644 index fb46c24a55..0000000000 --- a/reference/ibase/functions/ibase-name-result.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - ibase_name_result - Assigne un nom à un jeu de résultats iBase - - - - &reftitle.description; - - boolibase_name_result - resourceresult - stringname - - - Assigne un nom à un jeu de résultats. Ce nom peut être - utilisé plus tard dans les requêtes de type - UPDATE|DELETE ... WHERE CURRENT OF name. - - - - - &reftitle.parameters; - - - result - - - Un jeu de résultats InterBase. - - - - - name - - - Le nom à assigner. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>ibase_name_result</function> - - -]]> - - - - - - &reftitle.seealso; - - ibase_prepare - ibase_execute - - - - - diff --git a/reference/ibase/functions/ibase-num-fields.xml b/reference/ibase/functions/ibase-num-fields.xml deleted file mode 100644 index e19441bd51..0000000000 --- a/reference/ibase/functions/ibase-num-fields.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - ibase_num_fields - Retourne le nombre de colonnes dans un résultat iBase - - - - &reftitle.description; - - intibase_num_fields - resourceresult_id - - - Retourne le nombre de colonnes dans un résultat iBase. - - - - - &reftitle.parameters; - - - result_id - - - Un identifiant de résultat InterBase. - - - - - - - - &reftitle.returnvalues; - - Retourne le nombre de champs, sous la forme d'un &integer;. - - - - - &reftitle.examples; - - Exemple avec <function>ibase_num_fields</function> - - -]]> - - - - - - &reftitle.seealso; - - ibase_field_info - - - - - diff --git a/reference/ibase/functions/ibase-num-params.xml b/reference/ibase/functions/ibase-num-params.xml deleted file mode 100644 index 4bf1852c62..0000000000 --- a/reference/ibase/functions/ibase-num-params.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - ibase_num_params - Retourne le nombre de paramètres dans une requête préparée iBase - - - - &reftitle.description; - - intibase_num_params - resourcequery - - - ibase_num_params retourne le nombre de paramètres - dans la requête spécifiée - par query. C'est le nombre d'arguments de - substitution qui doivent être présents lors de l'appel de - ibase_execute. - - - - - &reftitle.parameters; - - - query - - - La requête préparée. - - - - - - - - &reftitle.returnvalues; - - Retourne le nombre de paramètres, sous la forme d'un &integer;. - - - - - &reftitle.seealso; - - ibase_prepare - ibase_param_info - - - - - diff --git a/reference/ibase/functions/ibase-param-info.xml b/reference/ibase/functions/ibase-param-info.xml deleted file mode 100644 index f627347447..0000000000 --- a/reference/ibase/functions/ibase-param-info.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - ibase_param_info - Retourne des informations à propos d'un paramètre dans une requête préparée iBase - - - - &reftitle.description; - - arrayibase_param_info - resourcequery - intparam_number - - - Retourne un tableau avec des informations à propos d'un paramètre après - qu'une requête ait été préparée. - - - - - &reftitle.parameters; - - - query - - - Un gestionnaire de requête préparée InterBase. - - - - - param_number - - - La position du paramètre. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les clés suivantes : name, - alias, relation, - length et type. - - - - - &reftitle.seealso; - - ibase_field_info - ibase_num_params - - - - - diff --git a/reference/ibase/functions/ibase-pconnect.xml b/reference/ibase/functions/ibase-pconnect.xml deleted file mode 100644 index 513a47fefa..0000000000 --- a/reference/ibase/functions/ibase-pconnect.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - ibase_pconnect - Ouvre une connexion persistante à une base de données InterBase - - - - &reftitle.description; - - resourceibase_pconnect - stringdatabase - stringusername - stringpassword - stringcharset - intbuffers - intdialect - stringrole - intsync - - - Ouvre une connexion persistante à une base de données InterBase. - - - ibase_pconnect se comporte similairement à - ibase_connect, avec deux différences - majeures. - - - La première est que, lors de la connexion, la fonction - va essayer de trouver une connexion (persistante) déjà ouverte. - Si elle la trouve, cette dernière sera retournée, plutôt - qu'une nouvelle connexion. Sinon, une nouvelle connexion sera ouverte. - - - La deuxième est que la connexion ne sera pas fermée à la fin - du script, mais restera ouverte pour utilisation ultérieure. - (ibase_close ne fermera pas une connexion ouverte - avec ibase_pconnect). Ce type de lien est alors dit - 'persistant'. - - - - - &reftitle.parameters; - - - database - - - L'argument database doit être un chemin valide - vers le fichier de la base de données sur le serveur où il réside. Si - le serveur n'est pas local, il doit être préfixé avec soit 'hostname:' - (TCP/IP), '//hostname/' (NetBEUI) ou 'hostname@' (IPX/SPX), suivant le - protocole utilisé. - - - - - username - - - Le nom d'utilisateur. Peut être défini avec la directive - ibase.default_user du &php.ini;. - - - - - password - - - Le mot de passe pour l'utilisateur username. - Peut être défini avec la directive - ibase.default_password du &php.ini;. - - - - - charset - - - charset est le jeu de caractères par défaut pour - la base de données. - - - - - buffers - - - buffers est le nombre de buffers de la base de données - à allouer pour le cache côté serveur. Si ce paramètre vaut 0 ou s'il est - omis, le serveur choisira lui-même ce nombre. - - - - - dialect - - - dialect sélectionne le dialecte SQL par défaut pour - toutes les requêtes exécutées dans la connexion, et vaudra par défaut, - le plus haut supporté par la bibliothèque cliente. Ne fonctionne qu'avec - InterBase 6 et supérieur. - - - - - role - - - Ne fonctionne qu'avec InterBase 5 et supérieur. - - - - - sync - - - - - - - - - - &reftitle.returnvalues; - - Retourne un identifiant de connexion InterBase en cas de succès, - ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - ibase_close - ibase_connect - - - - - diff --git a/reference/ibase/functions/ibase-prepare.xml b/reference/ibase/functions/ibase-prepare.xml deleted file mode 100644 index dbb4fb55a3..0000000000 --- a/reference/ibase/functions/ibase-prepare.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - ibase_prepare - Prépare une requête iBase pour lier les paramètres et l'exécuter ultérieurement - - - - &reftitle.description; - - resourceibase_prepare - stringquery - - - resourceibase_prepare - resourcelink_identifier - stringquery - - - resourceibase_prepare - resourcelink_identifier - stringtrans - stringquery - - - Prépare une requête afin d'y lier ultérieurement des paramètres ainsi que - de l'exécuter (via la fonction ibase_execute). - - - - - &reftitle.parameters; - - - query - - - Une requête InterBase. - - - - - link_identifier - - - Un identifiant de connexion Interbase retourné par - ibase_connect. Si omis, le dernier lien ouvert - est adopté. - - - - - trans - - - Un gestionnaire de transaction InterBase auquel la requête doit être associée. - Si omis, la transaction par défaut de la connexion est adoptée. - - - - - - - - &reftitle.returnvalues; - - Retourne un gestionnaire de requête préparée, ou &false; si une - erreur survient. - - - - - diff --git a/reference/ibase/functions/ibase-query.xml b/reference/ibase/functions/ibase-query.xml deleted file mode 100644 index cfe3e9cd92..0000000000 --- a/reference/ibase/functions/ibase-query.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - ibase_query - Exécute une requête sur une base iBase - - - - &reftitle.description; - - resourceibase_query - resourcelink_identifier - stringquery - intbind_args - - - Exécute une requête sur une base iBase. - - - - - &reftitle.parameters; - - - link_identifier - - - Un identifiant de connexion à InterBase. S'il est omis, la dernière - connexion ouverte sera utilisée. - - - - - query - - - Une requête InterBase. - - - - - bind_args - - - - - - - - - - &reftitle.returnvalues; - - Si la requête émet une erreur, la fonction retournera &false;. Si la - requête est exécutée avec succès, et qu'il y a un jeu de résultats (même - vide), la fonction retournera un identifiant de résultat. Si la requête - est exécutée avec succès, et qu'il n'y a pas de résultat, la fonction - retournera &true;. - - - - Dans les versions 5.0.0 de PHP et suivantes, ibase_query - retourne le nombre d'enregistrements affectés par les requêtes INSERT, - UPDATE et DELETE. - Dans un souci de compatibilité ascendante, ibase_query - retournera &true; si la requête réussit mais ne renvoie aucun enregistrement. - - - - - - &reftitle.errors; - - En cas de réception d'une erreur du type "arithmetic exception, numeric overflow, - or string truncation. Cannot transliterate character between character - sets" (ceci survient lors de la tentative d'utiliser des - caractères accentués) avec la fonction ibase_query, - c'est qu'il faut choisir un jeu de caractères - (c.-à-d. ISO8859_1 ou le jeu courant). - - - - - &reftitle.examples; - - Exemple avec <function>ibase_query</function> - - -]]> - - - - - - &reftitle.seealso; - - ibase_errmsg - ibase_fetch_row - ibase_fetch_object - ibase_free_result - - - - - diff --git a/reference/ibase/functions/ibase-restore.xml b/reference/ibase/functions/ibase-restore.xml deleted file mode 100644 index 61dabc974f..0000000000 --- a/reference/ibase/functions/ibase-restore.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - ibase_restore - Lance une tâche de restauration dans le gestionnaire de services et retourne immédiatement - - - - &reftitle.description; - - mixedibase_restore - resourceservice_handle - stringsource_file - stringdest_db - intoptions0 - boolverbose&false; - - - - Cette fonction transmet les arguments au serveur de base de données (distant). - Là, il commence un nouveau processus de restauration. - Par conséquent, le résultat ne sera aucune réponse. - - - - - &reftitle.parameters; - - - service_handle - - - Une connexion au serveur de base de données créée précédemment. - - - - - source_file - - - Le chemin absolu sur le serveur où le fichier de sauvegarde est situé. - - - - - dest_db - - - Le chemin pour créer la nouvelle base de données sur le serveur. - Il est également possible d'utiliser un alias de base de données. - - - - - options - - - Options supplémentaires à transmettre au serveur de base de données - pour la restauration. - Le paramètre options peut être une combinaison - des constantes suivantes : - IBASE_RES_DEACTIVATE_IDX, - IBASE_RES_NO_SHADOW, - IBASE_RES_NO_VALIDITY, - IBASE_RES_ONE_AT_A_TIME, - IBASE_RES_REPLACE, - IBASE_RES_CREATE, - IBASE_RES_USE_ALL_SPACE, - IBASE_PRP_PAGE_BUFFERS, - IBASE_PRP_SWEEP_INTERVAL, - IBASE_RES_CREATE. - Lire la section à propos des pour - plus d'information. - - - - - verbose - - - Étant donné que le processus de restauration est effectué sur le serveur - de base de données, l’on n’a aucune chance d’obtenir sa sortie. - Cet argument est inutile. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - Le processus de restauration étant effectué sur le serveur (distant), - cette fonction ne fait que lui transmettre les arguments. - Tant que les arguments sont légaux, le résultat ne sera pas &false;. - - - - - &reftitle.examples; - - Exemple avec <function>ibase_restore</function> - - -]]> - - - - - Exemple de <function>ibase_restore</function> avec des arguments - - -]]> - - - - - - - &reftitle.seealso; - - ibase_backup - - - - - diff --git a/reference/ibase/functions/ibase-rollback-ret.xml b/reference/ibase/functions/ibase-rollback-ret.xml deleted file mode 100644 index 74813863a3..0000000000 --- a/reference/ibase/functions/ibase-rollback-ret.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - ibase_rollback_ret - Annule une transaction sans la fermer - - - - &reftitle.description; - - boolibase_rollback_ret - resourcelink_or_trans_identifier&null; - - - Annule une transaction sans la fermer. - - - - - &reftitle.parameters; - - - link_or_trans_identifier - - - Si ibase_rollback_ret est appelée sans argument, - elle annule la transaction par défaut du lien par défaut. Si l'argument - link_or_trans_identifier est un identifiant de connexion, - la transaction par défaut de cette connexion sera annulée. - Si l'argument link_or_trans_identifier - est un identifiant de transaction, celle-ci sera annulée. - Le contexte de transaction sera retenu et, donc, les requêtes exécutées - dans cette transaction ne seront pas invalidées. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-rollback.xml b/reference/ibase/functions/ibase-rollback.xml deleted file mode 100644 index 16852b1c76..0000000000 --- a/reference/ibase/functions/ibase-rollback.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - ibase_rollback - Annule une transaction interBase - - - - &reftitle.description; - - boolibase_rollback - resourcelink_or_trans_identifier&null; - - - Annule une transaction interBase. - - - - - &reftitle.parameters; - - - link_or_trans_identifier - - - Lorsque ibase_rollback est appelée sans argument, - elle annule la transaction par défaut du lien par défaut. Si l'argument - link_or_trans_identifier est un identifiant de connexion, - la transaction par défaut de cette connexion sera annulée. - Si l'argument link_or_trans_identifier - est un identifiant de transaction, celle-ci sera annulée. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-server-info.xml b/reference/ibase/functions/ibase-server-info.xml deleted file mode 100644 index 0c8a04db1d..0000000000 --- a/reference/ibase/functions/ibase-server-info.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - ibase_server_info - Sollicite des informations à propos d'un serveur de base de données - - - - &reftitle.description; - - stringibase_server_info - resourceservice_handle - intaction - - - - - &reftitle.parameters; - - - service_handle - - - Une connexion au serveur de base de données créée précédemment. - - - - - action - - - Une constante valide. - - - - - - - - &reftitle.returnvalues; - - Retourne des types différents en fonction du contexte. - - - - - &reftitle.examples; - - Exemple avec <function>ibase_service_attach</function> - - -]]> - - &example.outputs; - - Array - ( - [user_name] => SYSDBA - [first_name] => Sql - [middle_name] => Server - [last_name] => Administrator - [user_id] => 0 - [group_id] => 0 - ) - -) - -Server directory: /etc/firebird/ -Server lock path: /tmp/firebird/ -Server lib path: /usr/lib64/firebird/lib/ -Path of user db: /var/lib/firebird/secdb/security3.fdb -Established connections: Array -( - [attachments] => 3 - [databases] => 2 - [0] => /srv/firebird/poss.fdb - [1] => /srv/firebird/employees.fdb -) -]]> - - - - - - - diff --git a/reference/ibase/functions/ibase-service-attach.xml b/reference/ibase/functions/ibase-service-attach.xml deleted file mode 100644 index c09fa0a8f1..0000000000 --- a/reference/ibase/functions/ibase-service-attach.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - ibase_service_attach - Connexion au gestionnaire de service - - - - &reftitle.description; - - resourcefalseibase_service_attach - stringhost - stringdba_username - stringdba_password - - - - - &reftitle.parameters; - - - host - - - Le nom ou l'adresse IP de l'hôte de la base de données. - Il est possible de définir le port en ajoutant '/' et le numéro du port. - Si aucun port est spécifié, le port 3050 sera utilisé. - - - - - dba_username - - - Le nom de tout utilisateur valide. - - - - - dba_password - - - Le mot de passe de l'utilisateur. - - - - - - - - &reftitle.returnvalues; - - Retourne un identifiant de lien Interbase / Firebird en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>ibase_service_attach</function> - -"; - echo "Server implementation: " . $server_implementation; - } - else { - // Afficher un message en cas d'erreur - $conn_error = ibase_errmsg(); - die($conn_error); - } - -?> -]]> - - - - - Exemple de<function>ibase_service_attach</function> en utilisant la syntaxe <literal>hostname/port</literal> - -"; - echo "Server implementation: " . $server_implementation; - } - else { - // Afficher un message en cas d'erreur - $conn_error = ibase_errmsg(); - die($conn_error); - } - -?> -]]> - - - - - - &reftitle.seealso; - - ibase_service_detach - - - - - diff --git a/reference/ibase/functions/ibase-service-detach.xml b/reference/ibase/functions/ibase-service-detach.xml deleted file mode 100644 index 75a699970b..0000000000 --- a/reference/ibase/functions/ibase-service-detach.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - ibase_service_detach - Déconnexion du gestionnaire de service - - - - &reftitle.description; - - boolibase_service_detach - resourceservice_handle - - - - - &reftitle.parameters; - - - service_handle - - - Une connexion au serveur de base de données créée précédemment. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>ibase_service_detach</function> - - -]]> - - - - - diff --git a/reference/ibase/functions/ibase-set-event-handler.xml b/reference/ibase/functions/ibase-set-event-handler.xml deleted file mode 100644 index 438f695cc4..0000000000 --- a/reference/ibase/functions/ibase-set-event-handler.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - ibase_set_event_handler - Enregistre une fonction de rappel sur un événement interBase - - - - &reftitle.description; - - resourceibase_set_event_handler - callableevent_handler - stringevent_name - stringeven_names - - - resourceibase_set_event_handler - resourceconnection - callableevent_handler - stringevent_name - stringevent_names - - - ibase_set_event_handler enregistre la fonction - utilisateur PHP event_handler en tant que - gestionnaire d'événements pour les événements - spécifiés. - - - - - &reftitle.parameters; - - - event_handler - - - Fonction de rappel appelée avec le nom de l'événement et la ressource de - connexion en tant qu'arguments dès qu'un événement - spécifié est posté dans la base de données. - - - La fonction de rappel event_handler doit - retourner &false; si le gestionnaire doit être annulé. Toute autre - valeur de retour est ignorée. - Cette fonction accepte jusqu'à 15 arguments d'événement. - - - - - event_name - - - Le nom de l'événement. - - - - - event_names - - - 15 événements tout au plus sont autorisés. - - - - - - - - &reftitle.returnvalues; - - La valeur retournée est une ressource d'événement. Elle peut être - utilisée pour libérer le gestionnaire d'événements en utilisant - ibase_free_event_handler. - - - - - &reftitle.examples; - - Exemple avec <function>ibase_set_event_handler</function> - - -]]> - - - - - - &reftitle.seealso; - - ibase_free_event_handler - ibase_wait_event - - - - - diff --git a/reference/ibase/functions/ibase-trans.xml b/reference/ibase/functions/ibase-trans.xml deleted file mode 100644 index 4ad1da1c13..0000000000 --- a/reference/ibase/functions/ibase-trans.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - ibase_trans - Démarre une transaction interBase - - - - &reftitle.description; - - resourceibase_trans - inttrans_args - resourcelink_identifier - - - resourceibase_trans - resourcelink_identifier - - - Démarre une transaction interBase. - - - - Le premier appel à ibase_trans ne retournera pas - la transaction par défaut pour la connexion courante. Toutes les - transactions commencées par ibase_trans - seront annulées à la fin de l'exécution du script si elles n'ont pas été - validées ou annulées par respectivement les fonctions ibase_commit - ou ibase_rollback. - - - - - ibase_trans accepte plusieurs paramètres - trans_args et link_identifier. - Ceci permet d'effectuer des transactions sur plusieurs connexions à des - bases de données différentes, qui seront validées en utilisant l'algorithme - 2-phase. Cela signifie qu'il est possible de mettre à jour - plusieurs bases de données. Cela ne veut PAS dire qu'il est possible d'utiliser - plusieurs bases de données dans une même requête ! - - - Si l'on utilise les transactions sur plusieurs base de données, il faut spécifier - link_id et transaction_id - dans les fonctions ibase_query et ibase_prepare. - - - - - - &reftitle.parameters; - - - trans_args - - - trans_args peut être une combinaison des constantes - suivantes : - IBASE_READ, - IBASE_WRITE, - IBASE_COMMITTED, - IBASE_CONSISTENCY, - IBASE_CONCURRENCY, - IBASE_REC_VERSION, - IBASE_REC_NO_VERSION, - IBASE_WAIT et - IBASE_NOWAIT. - - - - - link_identifier - - - Un identifiant de connexion à InterBase. S'il est omis, la dernière - connexion ouverte sera utilisée. - - - - - - - - &reftitle.returnvalues; - - Retourne une ressource de transaction, ou &false; si une - erreur survient. - - - - - diff --git a/reference/ibase/functions/ibase-wait-event.xml b/reference/ibase/functions/ibase-wait-event.xml deleted file mode 100644 index e64d904601..0000000000 --- a/reference/ibase/functions/ibase-wait-event.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - ibase_wait_event - Attend un événement interBase - - - - &reftitle.description; - - stringibase_wait_event - stringevent_name - stringevent_names - - - stringibase_wait_event - resourceconnection - stringevent_name - stringevent_names - - - ibase_wait_event suspend l'exécution du script - jusqu'à ce que l'un des événements spécifiés soit posté par la base - de données. Le nom de l'événement qui a été posté est alors retourné. - Cette fonction accepte jusqu'à 15 arguments événements. - - - - - &reftitle.parameters; - - - event_name - - - Le nom de l'événement. - - - - - event_names - - - - - - - - - - &reftitle.returnvalues; - - Retourne le nom de l'événement qui a été posté. - - - - - &reftitle.seealso; - - ibase_set_event_handler - ibase_free_event_handler - - - - - diff --git a/reference/ibase/ini.xml b/reference/ibase/ini.xml deleted file mode 100644 index 450573d1af..0000000000 --- a/reference/ibase/ini.xml +++ /dev/null @@ -1,237 +0,0 @@ - - - - -
- &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; iBase - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - ibase.allow_persistent - "1" - INI_SYSTEM - - - - ibase.max_persistent - "-1" - INI_SYSTEM - - - - ibase.max_links - "-1" - INI_SYSTEM - - - - ibase.default_db - NULL - INI_SYSTEM - - - - ibase.default_user - NULL - INI_ALL - - - - ibase.default_password - NULL - INI_ALL - - - - ibase.default_charset - NULL - INI_ALL - - - - ibase.timestampformat - "%Y-%m-%d %H:%M:%S" - INI_ALL - - - - ibase.dateformat - "%Y-%m-%d" - INI_ALL - - - - ibase.timeformat - "%H:%M:%S" - INI_ALL - - - - -
- &ini.php.constants; - - - &ini.descriptions.title; - - - - - ibase.allow_persistent - bool - - - - Accepte ou non les - connexions persistantes - à Firebird/Interbase. - - - - - - - ibase.max_persistent - int - - - - Le nombre maximal de connexions persistantes Firebird/Interbase par processus. - Les nouvelles connexions avec ibase_pconnect - ne seront pas persistantes si ce nombre maximal est atteint. - - - - - - - ibase.max_links - int - - - - Le nombre maximal de connexions Firebird/Interbase par processus, incluant les - connexions persistantes. - - - - - - ibase.default_db - string - - - - Le nom de la base de données par défaut lorsque ibase_[p]connect() est appelé - sans base de données spécifique. Si cette valeur est définie et que le - mode sécurisé (safe mode) SQL est activé, aucune connexion - à d'autres bases de données que celle-ci ne sera autorisée. - - - - - - ibase.default_user - string - - - - Le nom d'utilisateur utilisé lors de la connexion à la base de données lorsqu'aucun n'est spécifié. - - - - - - - ibase.default_password - string - - - - Le mot de passe utilisé lors de la connexion à la base de données lorsqu'aucun n'est spécifié. - - - - - - ibase.default_charset - string - - - - Le jeu de caractères utilisé lors de la connexion à la base de données lorsqu'aucun - n'est spécifié. - - - - - - - - - ibase.timestampformat - string - - - - - - - - - ibase.dateformat - string - - - - - - - - - ibase.timeformat - string - - - - Ces directives sont utilisées pour définir les formats de dates et d'heures qui seront - utilisés lorsque des dates/heures seront retournées d'un jeu de résultats, ou lors - de traitement d'arguments en paramètres dates/heures. - - - - - -
- diff --git a/reference/ibase/reference.xml b/reference/ibase/reference.xml deleted file mode 100644 index e9ccbefe1f..0000000000 --- a/reference/ibase/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - &Functions; Firebird/InterBase - - &reference.ibase.entities.functions; - - - - diff --git a/reference/ibase/setup.xml b/reference/ibase/setup.xml deleted file mode 100644 index 6678148818..0000000000 --- a/reference/ibase/setup.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.ibase.configure; - - - - &reference.ibase.ini; - - - - - - diff --git a/reference/ibm_db2/book.xml b/reference/ibm_db2/book.xml deleted file mode 100644 index dabfe9f643..0000000000 --- a/reference/ibm_db2/book.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - Fonctions IBM DB2, Cloudscape et Apache Derby - IBM DB2 - - - - &reftitle.intro; - - Ces fonctions permettent d'accéder aux bases de données IBM DB2 Universal Database, - IBM Cloudscape et Apache Derby en utilisant l'interface - DB2 Call Level Interface (DB2 CLI). - - - - - &reference.ibm-db2.setup; - &reference.ibm-db2.constants; - &reference.ibm-db2.reference; - - - diff --git a/reference/ibm_db2/configure.xml b/reference/ibm_db2/configure.xml deleted file mode 100644 index f2ba7605db..0000000000 --- a/reference/ibm_db2/configure.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - -
- &reftitle.install; - - Pour compiler l'extension ibm_db2, les fichiers d'en-tête et de bibliothèques - de l'application de développement de DB2 doivent être présents sur le - système. DB2 ne les installe pas par défaut, il pourrait donc être nécessaire de retourner - à l'installation de DB2 et ajouter cette option. Le client de développement d'application DB2 - inclut les fichiers d'en-tête et est disponible librement - au téléchargement depuis le support du site - de la base de données universelle. - - - Si les fichiers d'en-têtes et de bibliothèques de l'application de - développement de DB2 sont ajoutés sur un système Linux ou Unix où DB2 est déjà installé, - la commande db2iupdt -e devra être lancée pour mettre à - jour les liens symboliques vers les fichiers d'en-têtes et de bibliothèques - des instances DB2. - - - ibm_db2 est une extension &link.pecl;, alors suivez - les instructions présentes dans pour - installer l'extension ibm_db2 pour PHP. Tapez la commande - configure pour pointer vers l'emplacement des fichiers - d'en-têtes et de bibliothèques de DB2 comme suit : - - - - La commande configure prend la valeur par défaut de - /opt/IBM/db2/V8.1. - - - Note pour les utilisateurs d'IIS - - Si le driver ibm_db2 est utilisé avec IIS (Microsoft Internet Information Server), - il pourrait être nécessaire de prendre les mesures suivantes : - - - - Installer DB2 avec le système de sécurité étendu. - - - Ajouter le chemin vers le binaire PHP à la variable d'environnement - PATH du système (Par défaut : C:\php\). - - - Créer une autre variable d'environnement contenant le chemin vers le fichier PHP.INI - (p. ex. : PHPRC = C:\php\). - - - Ajouter l'utilisateur IUSR_COMPUTERNAME au groupe DB2USERS. - - - -
- diff --git a/reference/ibm_db2/constants.xml b/reference/ibm_db2/constants.xml deleted file mode 100644 index 1d4b2afc8e..0000000000 --- a/reference/ibm_db2/constants.xml +++ /dev/null @@ -1,252 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - DB2_BINARY - (int) - - - - Spécifie que les données binaires seront retournées telles quelles. - Ceci est le mode par défaut. - - - - - - DB2_CONVERT - (int) - - - - Spécifie que les données binaires seront converties en hexadécimal et - retournées comme une chaîne ASCII. - - - - - - DB2_PASSTHRU - (int) - - - - Spécifie que les données binaires seront converties en valeur &null;. - - - - - - DB2_SCROLLABLE - (int) - - - - Spécifie un curseur de défilement pour une ressource de requête. Ce - mode permet un accès aléatoire aux lignes d'un jeu de résultats, mais - présentement, il est supporté seulement par IBM DB2 Universal Database. - - - - - - DB2_FORWARD_ONLY - (int) - - - - Spécifie un curseur unidirectionnel pour une ressource de requête. - Il s'agit du type de curseur par défaut, supporté sur tous les - serveurs de base de données. - - - - - - DB2_PARAM_IN - (int) - - - - Spécifie que la variable PHP devrait être liée comme paramètre - ENTRANT pour une procédure stockée. - - - - - - DB2_PARAM_OUT - (int) - - - - Spécifie que la variable PHP devrait être liée comme paramètre - SORTANT pour une procédure stockée. - - - - - - DB2_PARAM_INOUT - (int) - - - - Spécifie que la variable PHP devrait être liée comme paramètre - ENTRANT/SORTANT pour une procédure stockée. - - - - - - DB2_PARAM_FILE - (int) - - - - Spécifie que la colonne devrait être liée directement à un fichier en - entrée. - - - - - - DB2_AUTOCOMMIT_ON - (int) - - - - Spécifie que l'autocommit devrait être activé. - - - - - - DB2_AUTOCOMMIT_OFF - (int) - - - - Spécifie que l'autocommit devrait être désactivé. - - - - - - DB2_DOUBLE - (int) - - - - Spécifie que la variable devrait être liée à un type DOUBLE, FLOAT ou REAL. - - - - - - DB2_LONG - (int) - - - - Spécifie que la variable devrait être liée à un type SMALLINT, INTEGER ou - BIGINT. - - - - - - DB2_CHAR - (int) - - - - Spécifie que la variable devrait être liée à un type CHAR ou VARCHAR. - - - - - - DB2_CASE_NATURAL - (int) - - - - Spécifie que les noms de colonnes seront retournés dans leur casse naturelle. - - - - - - DB2_CASE_LOWER - (int) - - - - Spécifie que les noms de colonnes seront retournés en minuscules. - - - - - - DB2_CASE_UPPER - (int) - - - - Spécifie que les noms de colonnes seront retournés en majuscules. - - - - - - DB2_DEFERRED_PREPARE_ON - (int) - - - - Spécifie que la préparation différée devrait être activée pour la ressource de requête spécifiée. - - - - - - DB2_DEFERRED_PREPARE_OFF - (int) - - - - Spécifie que la préparation différée devrait être désactivée pour la ressource de requête spécifiée. - - - - - - - diff --git a/reference/ibm_db2/functions/db2-autocommit.xml b/reference/ibm_db2/functions/db2-autocommit.xml deleted file mode 100644 index 825db569b2..0000000000 --- a/reference/ibm_db2/functions/db2-autocommit.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - - db2_autocommit - - Retourne ou modifie l'état AUTOCOMMIT de la connexion à la base de - données - - - - &reftitle.description; - - intbooldb2_autocommit - resourceconnection - intvalue - - - - Modifie ou lit le comportement de AUTOCOMMIT de la connexion spécifiée. - - - - - &reftitle.parameters; - - - connection - - - Une variable de connexion à une base de données valide retournée par - db2_connect ou db2_pconnect. - - - - - value - - - Une des constantes suivantes : - - - DB2_AUTOCOMMIT_OFF - - - Désactive AUTOCOMMIT. - - - - - DB2_AUTOCOMMIT_ON - - - Active AUTOCOMMIT. - - - - - - - - - - - &reftitle.returnvalues; - - Lorsque db2_autocommit reçoit seulement - connection comme paramètre, la fonction retourne - un entier représentant l'état courant de AUTOCOMMIT de la connexion fournie. - Une valeur de DB2_AUTOCOMMIT_OFF signifie que AUTOCOMMIT - est désactivé, tandis qu'une valeur de DB2_AUTOCOMMIT_ON - signifie que AUTOCOMMIT est activé. - - - Lorsque db2_autocommit reçoit les deux paramètres - connection et autocommit, - la fonction essaie de modifier l'état AUTOCOMMIT à l'état - autocommit de la connexion fournie. - &return.success; - - - - - &reftitle.examples; - - - Récupération de la valeur de AUTOCOMMIT pour une connexion - - Dans l'exemple suivant, une connexion qui a été initialisée avec l'état AUTOCOMMIT - désactivé est testée avec la fonction db2_autocommit. - - - DB2_AUTOCOMMIT_OFF); -$conn = db2_connect($database, $user, $password, $options); -$ac = db2_autocommit($conn); -if ($ac == DB2_AUTOCOMMIT_OFF) { - print "$ac -- AUTOCOMMIT est désactivé."; -} else { - print "$ac -- AUTOCOMMIT est activé."; -} -?> -]]> - - &example.outputs; - - - - - - Modification de la valeur de AUTOCOMMIT pour une connexion - - Dans l'exemple suivant, une connexion qui a été préalablement initialisée avec - l'état AUTOCOMMIT désactivé a son comportement changé lors de l'activation de - l'état AUTOCOMMIT. - - - DB2_AUTOCOMMIT_OFF); -$conn = db2_connect($database, $user, $password, $options); - -// Active AUTOCOMMIT -$rc = db2_autocommit($conn, DB2_AUTOCOMMIT_ON); -if ($rc) { - print "Activation AUTOCOMMIT réussie.\n"; -} - -// Vérification de l'état AUTOCOMMIT -$ac = db2_autocommit($conn); -if ($ac == DB2_AUTOCOMMIT_OFF) { - print "$ac -- AUTOCOMMIT est désactivé."; -} else { - print "$ac -- AUTOCOMMIT est activé."; -} -?> -]]> - - &example.outputs; - - - - - - - - - - &reftitle.seealso; - - db2_connect - db2_pconnect - - - - - diff --git a/reference/ibm_db2/functions/db2-bind-param.xml b/reference/ibm_db2/functions/db2-bind-param.xml deleted file mode 100644 index bab77400d5..0000000000 --- a/reference/ibm_db2/functions/db2-bind-param.xml +++ /dev/null @@ -1,308 +0,0 @@ - - - - - - - db2_bind_param - - Associe une variable PHP à un paramètre d'une requête SQL - - - - &reftitle.description; - - booldb2_bind_param - resourcestmt - intparameter_number - stringvariable_name - intparameter_typeDB2_PARAM_IN - intdata_type0 - intprecision-1 - intscale0 - - - - Associe une variable PHP à un paramètre d'une requête SQL dans une - ressource de requête retournée par db2_prepare. Cette - fonction donne plus de contrôle sur le type de paramètre, le type de - données, la précision et l'échelle du paramètre que le simple fait de - passer la variable comme élément du tableau d'entrée optionnel de - db2_execute. - - - - - &reftitle.parameters; - - - stmt - - - Une requête préparée retournée par db2_prepare. - - - - - parameter_number - - - Spécifie la position du paramètre commençant à l'indice 1 dans la - requête préparée. - - - - - variable_name - - - Une chaîne spécifiant le nom de la variable PHP à associer au - paramètre spécifié par parameter_number. - - - - - parameter_type - - - Une constante spécifiant si la variable PHP devrait être associée au - paramètre SQL en tant que paramètre entrant - (DB2_PARAM_IN), que paramètre sortant - (DB2_PARAM_OUT) ou en tant que paramètre qui accepte - les entrées et les sorties (DB2_PARAM_INOUT). - Pour éviter une surconsommation de la mémoire, il est aussi possible de spécifier - DB2_PARAM_FILE pour attacher la variable PHP au - nom du fichier qui contient les données de l'objet large (BLOB, CLOB ou - DBCLOB). - - - - - data_type - - - Une constante spécifiant le type de données SQL auquel la variable PHP - devrait être associée : l'une des valeurs DB2_BINARY, - DB2_CHAR, DB2_DOUBLE ou - DB2_LONG. - - - - - precision - - - Spécifie la précision à laquelle la variable devrait être associée à - la base de données. Ce paramètre peut également être utilisé pour - récupérer des valeurs de sortie XML pour les procédures stockées. - Une valeur non négative spécifie la taille maximale des données XML - qui seront récupérées depuis la base de données. Si ce paramètre n'est - pas utilisé, une taille par défaut de 1 Mo sera définie pour récupérer - les valeurs de sortie XML depuis la procédure stockée. - - - - - scale - - - Spécifie l'échelle à laquelle la variable devrait être associée à la - base de données. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Association de variables PHP à une requête préparée - - La requête SQL dans l'exemple suivant utilise deux paramètres d'entrée - dans la clause WHERE. Nous appelons db2_bind_param - pour associer deux variables PHP aux paramètres SQL correspondants. Il - est à noter que les variables PHP n'ont pas besoin d'être déclarées ou - assignées avant l'appel à db2_bind_param ; dans cet - exemple, $lower_limit est assignée avant l'appel à - db2_bind_param, mais $upper_limit - est assignée après l'appel à db2_bind_param. Les - variables doivent être associées et, pour les paramètres qui acceptent - une entrée, une valeur doit leur être assignée, avant d'appeler - db2_execute. - - - ? AND weight < ?'; -$conn = db2_connect($database, $user, $password); -$stmt = db2_prepare($conn, $sql); - -// Nous pouvons déclarer la variable avant d'appeler db2_bind_param() -$lower_limit = 1; - -db2_bind_param($stmt, 1, "lower_limit", DB2_PARAM_IN); -db2_bind_param($stmt, 2, "upper_limit", DB2_PARAM_IN); - -// Nous pouvons aussi déclarer la variable après l'appel de db2_bind_param() -$upper_limit = 15.0; - -if (db2_execute($stmt)) { - while ($row = db2_fetch_array($stmt)) { - print "{$row[0]}, {$row[1]}, {$row[2]}\n"; - } -} -?> -]]> - - &example.outputs; - - - - - - Appel de procédures stockées avec des paramètres IN et OUT - - La procédure stockée match_animal dans l'exemple suivant accepte trois - paramètres différents : - - - - un paramètre d'entrée (IN) qui accepte le nom du premier animal en - entrée - - - - - un paramètre d'entrée-sortie (INOUT) qui accepte le nom du second - animal en entrée et retourne la chaîne TRUE si un - animal de la base de données correspond à ce nom - - - - - un paramètre de sortie (OUT) qui retourne la somme des poids des deux - animaux identifiés - - - - De plus, la procédure stockée retourne un jeu de résultats contenant les - animaux listés par ordre alphabétique, en commençant par l'animal - correspondant à la valeur d'entrée du premier paramètre et en terminant - par l'animal correspondant à la valeur d'entrée du second paramètre. - - - -]]> - - &example.outputs; - - - - - - Insertion d'un objet large binaire (BLOB) provenant directement d'un fichier - - Les données pour les objets larges sont normalement enregistrées dans des - fichiers, comme des documents XML ou des fichiers audio. Plutôt que de - lire le fichier en entier dans une variable de PHP et ensuite associer - la variable PHP dans la requête SQL, il est possible d'éviter certains - surcoûts de mémoire en associant le fichier directement au paramètre - d'entrée de la requête SQL. L'exemple suivant démontre comment - associer un fichier directement dans une colonne BLOB. - - - -]]> - - - - - - - &reftitle.seealso; - - db2_execute - db2_prepare - - - - - diff --git a/reference/ibm_db2/functions/db2-client-info.xml b/reference/ibm_db2/functions/db2-client-info.xml deleted file mode 100644 index 5739aadf2f..0000000000 --- a/reference/ibm_db2/functions/db2-client-info.xml +++ /dev/null @@ -1,219 +0,0 @@ - - - - - - - db2_client_info - Retourne un objet avec des propriétés qui décrivent le client de base de données DB2 - - - &reftitle.description; - - stdClassfalsedb2_client_info - resourceconnection - - - - Cette fonction retourne un objet avec des propriétés en lecture seule qui - retournent des informations à propos du client de base de données DB2. La - table suivante liste les propriétés du client DB2 : - - Propriétés du client DB2 - - - - Nom de la propriété - Type de retour - Description - - - - - APPL_CODEPAGE - &integer; - Le code page de l'application. - - - CONN_CODEPAGE - &integer; - Le code page pour la connexion courante. - - - DATA_SOURCE_NAME - &string; - Le nom de la source de données (DSN) utilisé pour créer la connexion - courante à la base de données. - - - DRIVER_NAME - &string; - Le nom de la bibliothèque qui implémente la spécification - DB2 Call Level Interface (CLI). - - - DRIVER_ODBC_VER - &string; - La version d'ODBC que le client DB2 supporte. Ceci retourne une - &string; "MM.mm" où MM est la version majeure et - mm est la version mineure. Le client DB2 retourne - toujours "03.51". - - - - DRIVER_VER - &string; - La version du client, dans la forme d'une &string; "MM.mm.uuuu" - où MM est la version majeure, mm - est la version mineure et uuuu est la mise à jour. - Par exemple, "08.02.0001" représente la version majeure 8, la version - mineure 2, et la mise à jour 1. - - - - ODBC_SQL_CONFORMANCE - &string; - - Le niveau de grammaire SQL ODBC supporté par le client : - - - MINIMUM - - - Supporte le minimum de grammaire SQL d'ODBC. - - - - - CORE - - - Supporte le noyau de grammaire SQL d'ODBC. - - - - - EXTENDED - - - Supporte la grammaire étendue SQL d'ODBC. - - - - - - - - - ODBC_VER - &string; - La version d'ODBC que le gestionnaire de pilote ODBC supporte. - Cela retourne une &string; "MM.mm.rrrr" où MM est la - version majeure, mm est la version mineure et - rrrr est la mise à jour. Le client DB2 retourne - toujours "03.01.0000". - - - - -
- - - - - &reftitle.parameters; - - - connection - - - Spécifie la connexion cliente DB2 active. - - - - - - - &reftitle.returnvalues; - - Retourne un objet si l'appel est réussi,&return.falseforfailure; - - - - - &reftitle.examples; - - Exemple avec <function>db2_client_info</function> - - Pour récupérer des informations à propos du client, il faut passer une - ressource de connexion de base de données valide à la fonction - db2_client_info. - - -DRIVER_NAME ); - echo "DRIVER_VER: "; var_dump( $client->DRIVER_VER ); - echo "DATA_SOURCE_NAME: "; var_dump( $client->DATA_SOURCE_NAME ); - echo "DRIVER_ODBC_VER: "; var_dump( $client->DRIVER_ODBC_VER ); - echo "ODBC_VER: "; var_dump( $client->ODBC_VER ); - echo "ODBC_SQL_CONFORMANCE: "; var_dump( $client->ODBC_SQL_CONFORMANCE ); - echo "APPL_CODEPAGE: "; var_dump( $client->APPL_CODEPAGE ); - echo "CONN_CODEPAGE: "; var_dump( $client->CONN_CODEPAGE ); -} -else { - echo "Erreur de récupération des informations du client. - Peut-être que la connexion à la base de données était invalide."; -} -db2_close($conn); - -?>]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_server_info - - - - - - diff --git a/reference/ibm_db2/functions/db2-close.xml b/reference/ibm_db2/functions/db2-close.xml deleted file mode 100644 index ff50b02770..0000000000 --- a/reference/ibm_db2/functions/db2-close.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - db2_close - - Ferme une connexion de base de données - - - - &reftitle.description; - - booldb2_close - resourceconnection - - - - Cette fonction ferme la connexion client DB2 initialisée avec - db2_connect et libère les ressources correspondantes - du serveur de base de données. - - - En tentant de fermer une connexion client DB2 persistante initialisée avec - db2_pconnect, la requête de fermeture est ignorée et la - connexion client DB2 persistante reste disponible pour de prochains appels. - - - - - &reftitle.parameters; - - - connection - - - Spécifie une connexion client DB2 active. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Fermeture d'une connexion - - L'exemple suivant montre une tentative réussie de fermeture de connexion - d'une base de données IBM DB2, Cloudscape ou Apache Derby. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_connect - db2_pclose - db2_pconnect - - - - - diff --git a/reference/ibm_db2/functions/db2-column-privileges.xml b/reference/ibm_db2/functions/db2-column-privileges.xml deleted file mode 100644 index 4cd35e6b79..0000000000 --- a/reference/ibm_db2/functions/db2-column-privileges.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - db2_column_privileges - - Retourne un jeu de résultats listant les colonnes et leurs privilèges d'une table - - - - &reftitle.description; - - resourcedb2_column_privileges - resourceconnection - stringnullqualifier&null; - stringnullschema&null; - stringnulltable_name&null; - stringnullcolumn_name&null; - - - - Retourne un jeu de résultats listant les colonnes et leurs privilèges d'une - table. - - - - - &reftitle.parameters; - - - connection - - - Une connexion valide à une base de données IBM DB2, Cloudscape ou - Apache Derby. - - - - - qualifier - - - Un qualificatif pour les bases de données DB2 qui fonctionnent sur - les serveurs OS/390 ou z/OS. Pour les autres bases de données, - passez &null; ou une chaîne vide. - - - - - schema - - - Le schéma qui contient les tables. Pour concorder avec tous les - schémas, passez &null; ou une chaîne vide. - - - - - table_name - - - Le nom de la table ou de la vue. Pour obtenir toutes les tables dans la - base de données, passez &null; ou une chaîne vide. - - - - - column_name - - - Le nom de la colonne. Pour obtenir toutes les colonnes de la table, - passez &null; ou une chaîne vide. - - - - - - - &reftitle.returnvalues; - - Retourne une ressource avec le jeu de résultats contenant les lignes qui - décrivent les privilèges des colonnes concordant avec les paramètres - spécifiés. Les lignes sont composées des colonnes suivantes : - - - - - Nom de la colonne - Description - - - - - TABLE_CAT - Nom du catalogue. La valeur est &null; si la table ne possède - pas de catalogue. - - - TABLE_SCHEM - Nom du schéma. - - - TABLE_NAME - Nom de la table ou de la vue. - - - COLUMN_NAME - Nom de la colonne. - - - GRANTOR - ID d'autorisation de l'utilisateur qui a donné le privilège. - - - GRANTEE - ID d'autorisation de l'utilisateur à qui le privilège a été - donné. - - - PRIVILEGE - Le privilège pour la colonne. - - - IS_GRANTABLE - Si GRANTEE a la permission d'accorder ce privilège à d'autres - utilisateurs. - - - - - - - - - &reftitle.seealso; - - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-columns.xml b/reference/ibm_db2/functions/db2-columns.xml deleted file mode 100644 index 26ba11c75e..0000000000 --- a/reference/ibm_db2/functions/db2-columns.xml +++ /dev/null @@ -1,220 +0,0 @@ - - - - - - - db2_columns - - Retourne un jeu de résultats listant les colonnes et leurs métadonnées d'une table - - - - &reftitle.description; - - resourcedb2_columns - resourceconnection - stringnullqualifier&null; - stringnullschema&null; - stringnulltable_name&null; - stringnullcolumn_name&null; - - - - Retourne un jeu de résultats listant les colonnes et leurs métadonnées d'une - table. - - - - - &reftitle.parameters; - - - connection - - - Une connexion valide à une base de données IBM DB2, Cloudscape ou - Apache Derby. - - - - - qualifier - - - Un qualificatif pour les bases de données DB2 qui fonctionnent sur - les serveurs OS/390 ou z/OS. Pour les autres bases de données, passez - &null; ou une chaîne vide. - - - - - schema - - - Le schéma qui contient les tables. Pour concorder avec tous les - schémas, passez '%'. - - - - - table_name - - - Le nom de la table ou de la vue. Pour obtenir toutes les tables dans - la base de données, passez &null; ou une chaîne vide. - - - - - column_name - - - Le nom de la colonne. Pour obtenir toutes les colonnes de la table, - passez &null; ou une chaîne vide. - - - - - - - &reftitle.returnvalues; - - Retourne une ressource avec le jeu de résultats contenant les lignes qui - décrivent les colonnes concordant avec les paramètres spécifiés. Les - lignes sont composées des colonnes suivantes : - - - - - Nom de la colonne - Description - - - - - TABLE_CAT - Nom du catalogue. La valeur est &null; si la table ne possède - pas de catalogue. - - - TABLE_SCHEM - Nom du schéma. - - - TABLE_NAME - Nom de la table ou de la vue. - - - COLUMN_NAME - Nom de la colonne. - - - DATA_TYPE - Le type de données SQL pour la colonne, représenté comme un - entier. - - - TYPE_NAME - Une chaîne représentant le type de données pour la colonne. - - - COLUMN_SIZE - Un entier représentant la grandeur de la colonne. - - - BUFFER_LENGTH - Nombre maximal d'octets nécessaires pour enregistrer des données - de cette colonne. - - - DECIMAL_DIGITS - L'échelle de la colonne ou &null; lorsque l'échelle n'est pas - applicable. - - - NUM_PREC_RADIX - Un entier pouvant être 10 (représentant un - type de données numérique exact), 2 (représentant un - type de données numérique approximatif) ou &null; (représentant un type - de données pour lequel la base n'est pas applicable). - - - NULLABLE - Un entier représentant si la colonne peut être nulle ou pas. - - - REMARKS - Description de la colonne. - - - COLUMN_DEF - Valeur par défaut de la colonne. - - - SQL_DATA_TYPE - Un entier représentant la grandeur de la colonne. - - - SQL_DATETIME_SUB - Retourne un entier représentant un code de sous-type - datetime ou - &null; pour les types de données SQL auxquels cela ne s'applique pas. - - - CHAR_OCTET_LENGTH - Longueur maximale en octets pour une colonne de type - caractère, qui concorde avec COLUMN_SIZE pour les données d'un jeu - de caractères sur un octet, ou &null; pour les types de données - non-caractères. - - - ORDINAL_POSITION - La position de la colonne commençant à 1 dans la table. - - - IS_NULLABLE - Une chaîne dont la valeur 'YES' signifie que la colonne peut - être nulle et 'NO' signifie que la colonne ne peut être nulle. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-commit.xml b/reference/ibm_db2/functions/db2-commit.xml deleted file mode 100644 index 1394ea37f8..0000000000 --- a/reference/ibm_db2/functions/db2-commit.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - db2_commit - - Valide la transaction - - - - &reftitle.description; - - booldb2_commit - resourceconnection - - - - Valide une transaction en cours sur la ressource de connexion spécifiée et - commence une nouvelle transaction. Les applications PHP ont normalement - le mode AUTOCOMMIT activé par défaut, donc - db2_commit n'est pas nécessaire tant que AUTOCOMMIT - n'est pas désactivé pour la ressource de connexion. - - - - - &reftitle.parameters; - - - connection - - - Une variable ressource de connexion à la base de données valide retournée par - db2_connect ou db2_pconnect. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - db2_autocommit - db2_rollback - - - - diff --git a/reference/ibm_db2/functions/db2-conn-error.xml b/reference/ibm_db2/functions/db2-conn-error.xml deleted file mode 100644 index 14f61ab99f..0000000000 --- a/reference/ibm_db2/functions/db2-conn-error.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - db2_conn_error - - Retourne une chaîne contenant la valeur de SQLSTATE retournée par la dernière tentative - de connexion - - - - &reftitle.description; - - stringdb2_conn_error - resourcenullconnection&null; - - - - db2_conn_error retourne la valeur de SQLSTATE - représentant la raison pour laquelle la dernière tentative de connexion à - la base de données a échoué. Comme db2_connect - retourne &false; en cas de tentative de connexion échouée, il ne faut - passer aucun paramètre à db2_conn_error pour obtenir - la valeur de SQLSTATE. - - - Si par contre la connexion était réussie mais est devenue invalide avec le - temps, il est possible de passer le paramètre de connexion - connection pour obtenir la valeur de SQLSTATE pour la - connexion spécifique. - - - Pour comprendre les valeurs de SQLSTATE, il est possible de taper la commande - suivante dans le processeur de ligne de commandes de DB2 : - db2 '? sqlstate-value'. Il - est aussi possible d'appeler la fonction db2_conn_errormsg - pour obtenir un message d'erreur explicite ainsi que la valeur de SQLCODE - associée. - - - - &reftitle.parameters; - - - connection - - - Une ressource de connexion associée à la connexion qui a - préalablement été réussie, mais qui est devenue invalide avec le temps. - - - - - - - &reftitle.returnvalues; - - Retourne la valeur de SQLSTATE résultant d'une mauvaise tentative de - connexion. Retourne une chaîne vide s'il n'y a pas d'erreur associée avec - la dernière tentative de connexion. - - - - - &reftitle.examples; - - Récupération de la valeur de SQLSTATE pour une tentative de connexion - échouée - - L'exemple suivant montre comment retourner une valeur de SQLSTATE après un - passage forcé d'un paramètre invalide à la fonction - db2_connect. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_conn_errormsg - db2_connect - db2_stmt_error - db2_stmt_errormsg - - - - - - diff --git a/reference/ibm_db2/functions/db2-conn-errormsg.xml b/reference/ibm_db2/functions/db2-conn-errormsg.xml deleted file mode 100644 index e33ae545c1..0000000000 --- a/reference/ibm_db2/functions/db2-conn-errormsg.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - db2_conn_errormsg - - Retourne le dernier message d'erreur de connexion ainsi que la valeur - de SQLCODE - - - - &reftitle.description; - - stringdb2_conn_errormsg - resourcenullconnection&null; - - - - db2_conn_errormsg retourne un message d'erreur et la - valeur de SQLCODE représentant la raison pour laquelle la dernière tentative - de connexion à la base de données a échoué. Comme - db2_connect retourne &false; en cas d'une tentative de - connexion échouée, il ne faut passer aucun paramètre à - db2_conn_errormsg pour obtenir le message d'erreur et - la valeur de SQLCODE associés. - - - Si par contre la connexion était réussie mais est devenue invalide avec le - temps, il est possible de passer le paramètre de connexion - connection pour obtenir le message d'erreur et la - valeur de SQLCODE pour la connexion spécifique. - - - - &reftitle.parameters; - - - connection - - - Une ressource de connexion associée à la connexion qui a - préalablement été réussie, mais qui est devenue invalide avec le temps. - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant le message d'erreur et la valeur de SQLCODE - résultant d'une mauvaise tentative de connexion. Retourne une chaîne vide - s'il n'y a pas d'erreur associée avec la dernière tentative de connexion. - - - - - &reftitle.examples; - - Récupération du message d'erreur retourné par une tentative de - connexion échouée - - L'exemple suivant montre comment retourner un message d'erreur ainsi que - la valeur de SQLCODE après un passage forcé d'un paramètre invalide à la - fonction db2_connect. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_conn_error - db2_connect - db2_stmt_error - db2_stmt_errormsg - - - - - diff --git a/reference/ibm_db2/functions/db2-connect.xml b/reference/ibm_db2/functions/db2-connect.xml deleted file mode 100644 index 5b11c126eb..0000000000 --- a/reference/ibm_db2/functions/db2-connect.xml +++ /dev/null @@ -1,743 +0,0 @@ - - - - - - db2_connect - - Retourne une connexion à une base de données - - - - &reftitle.description; - - resourcefalsedb2_connect - stringdatabase - stringnullusername - stringnullpassword - arrayoptions[] - - - - Crée une nouvelle connexion à une base de données IBM DB2 Universal - Database, IBM Cloudscape ou Apache Derby. - - - - - &reftitle.parameters; - - - database - - - Pour une connexion cataloguée de la base de données, database - représente l'alias de la base de données dans le catalogue client DB2 - - - Pour une connexion non cataloguée de la base de données, database - représente une chaîne complète de connexion qui est dans le format - suivant : - DATABASE=database;HOSTNAME=hostname;PORT=port;PROTOCOL=TCPIP;UID=username;PWD=password; - - - Lors de la connexion à Db2 sur IBM i, les appels système sous-jacents - SQLDriverConnect, - n'acceptent que DSN, UID et PWD pour la - chaîne de connexion. - Comme suit : - DSN=database;UID=username;PWD=password; - - - où les paramètres représentent les valeurs suivantes : - - - database - - - Le nom de la base de données. - - - - - hostname - - - L'adresse Internet ou IP du serveur de base de données. - - - - - port - - - Le port TCP/IP sur lequel la base de données écoute les - connexions. - - - - - username - - - Le nom d'utilisateur utilisé pour la connexion à la base de - données. - - - - - password - - - Le mot de passe utilisé pour la connexion à la base de - données. - - - - - - - - - username - - - Le nom d'utilisateur utilisé pour la connexion à la base de - données. - - - Pour les connexions non cataloguées, il faut passer une valeur - &null; ou une chaîne vide. - - - - - password - - - Le mot de passe utilisé pour la connexion à la base de - données. - - - Pour les connexions non cataloguées, il faut passer une valeur - &null; ou une chaîne vide. - - - - - options - - - Un tableau associatif des options de connexion qui affecteront le - comportement de la connexion, où les valeurs des clés incluent : - - - autocommit - - - La valeur DB2_AUTOCOMMIT_ON active l'autocommit - sur cette connexion. - - - La valeur DB2_AUTOCOMMIT_OFF désactive - l'autocommit pour cette connexion. - - - - - DB2_ATTR_CASE - - - Passer la valeur DB2_CASE_NATURAL spécifie que les - noms de colonnes seront retournés dans leurs casses naturelles. - - - Passer la valeur DB2_CASE_LOWER spécifie que les - noms de colonnes seront retournés en minuscule. - - - Passer la valeur DB2_CASE_UPPER spécifie que les - noms de colonnes seront retournés en majuscule. - - - - - CURSOR - - - Passer la valeur DB2_FORWARD_ONLY spécifie un curseur - uniquement suivant pour une ressource de requête. C'est le type de curseur - par défaut et est supporté sur tous les serveurs de base de données. - - - Passer la valeur DB2_SCROLLABLE spécifie un - curseur défilant pour une ressource de requête. Ce mode permet - un accès aléatoire aux lignes dans un jeu de résultats, mais actuellement, - n'est supporté que par la base de données IBM DB2 Universal. - - - - - - - La nouvelle option suivante est disponible pour les versions ibm_db2 1.7.0 et - suivantes. - - - trustedcontext - - - Le fait de passer la valeur DB2_TRUSTED_CONTEXT_ENABLE active le contexte - de confiance pour ce gestionnaire de connexion. Ce paramètre ne peut - être défini avec la fonction db2_set_option. - - - Cette clé fonctionne uniquement si la base de données est cataloguée - (même si la base de données est locale), ou si l'on spécifie le DSN complet - lors de la création de la connexion. - - - Pour cataloguer la base de données, utiliser les commandes suivantes : - - db2 catalog tcpip node loopback remote <SERVERNAME> server <SERVICENAME> -db2 catalog database <LOCALDBNAME> as <REMOTEDBNAME> at node loopback -db2 "update dbm cfg using svcename <SERVICENAME>" -db2set DB2COMM=TCPIP - - - - - - Les nouvelles options i5/OS suivantes sont disponibles dans les versions - ibm_db2 1.5.1 et suivantes. - - - i5_lib - - - Un caractère qui indique la bibliothèque par défaut qui sera - utilisée pour résoudre les références aux fichiers non qualifiées. - Ceci n'est pas valide si la connexion utilise un mode de système de - nom. - - - - - i5_naming - - - La valeur DB2_I5_NAMING_ON active le mode de - nommage système iSeries de DB2 UDB CLI. Les fichiers sont qualifiés en - utilisant le délimiteur slash (/). Les fichiers non qualifiés sont - résolus en utilisant la liste de bibliothèque pour le travail. - - - La valeur DB2_I5_NAMING_OFF désactive le - mode de nommage par défaut de DB2 UDB CLI, qui est le nommage SQL. Les fichiers - sont qualifiés en utilisant le délimiteur point (.). Les fichiers - non qualifiés sont résolus en utilisant soit la bibliothèque par - défaut, soit l'ID de l'utilisateur courant. - - - - - i5_commit - - - L'attribut i5_commit devrait être fixé avant - l'appel à db2_connect. Si la valeur est - changée après que la connexion a été établie et que la connexion - est à une source de données distante, le changement ne prendra - effet qu'au prochain appel réussi de db2_connect - pour le gestionnaire de connexion. - - - La configuration php.ini ibm_db2.i5_allow_commit==0 - ou DB2_I5_TXN_NO_COMMIT est par défaut, mais - peut être remplacée avec l'option i5_commit. - - - - - DB2_I5_TXN_NO_COMMIT : le contrôle de validation n'est pas utilisé. - - - DB2_I5_TXN_READ_UNCOMMITTED : Les lectures sales, - non répétables et fantômes sont possibles. - - - DB2_I5_TXN_READ_COMMITTED : Les lectures sales ne - sont pas possibles. Les lectures non répétables et fantômes sont possibles. - - - DB2_I5_TXN_REPEATABLE_READ : Les lectures sales et - non répétables ne sont pas possibles. Les lectures fantômes sont possibles. - - - DB2_I5_TXN_SERIALIZABLE : les transactions sont - sérialisées. Les lectures sales, non répétables et fantômes ne sont - pas possibles. - - - - - i5_query_optimize - - - DB2_FIRST_IO Toutes les requêtes sont - optimisées avec le but de retourner la première page aussi vite - que possible. Ce but fonctionne bien lorsque les données de sortie sont - contrôlées par un utilisateur qui est le plus susceptible d'annuler une requête après - avoir vu la première page des données. Les requêtes sont codées - avec une clause "OPTIMIZE FOR nnn ROWS" afin de - honorer le but spécifié par la clause. - - - DB2_ALL_IO Toutes les requêtes sont optimisées - avec le but d'exécuter la requête entière jusqu'à la fin dans le plus petit - intervalle de temps. C'est une bonne option lorsque les données de sortie - d'une requête sont en train d'être écrites vers un fichier ou un - rapport ou encore lorsque l'interface met en file d'attente les données. Les - requêtes sont codées avec une clause "OPTIMIZE FOR nnn ROWS" afin de - honorer le but spécifié par la clause. C'est la valeur par - défaut. - - - - - i5_dbcs_alloc - - - La valeur DB2_I5_DBCS_ALLOC_ON active le canevas - d'allocation DB2 6X pour l'accroissement des tailles des colonnes - en traduction DBCS. - - - La valeur DB2_I5_DBCS_ALLOC_OFF désactive le - canevas d'allocation DB2 6X pour l'accroissement des tailles des - colonnes en traduction DBCS. - - - Note : la configuration &php.ini; - ibm_db2.i5_dbcs_alloc==0 ou - DB2_I5_DBCS_ALLOC_OFF est par défaut mais peut - être remplacée avec l'option i5_dbcs_alloc. - - - - - i5_date_fmt - - - DB2_I5_FMT_ISO : le format de date de l'organisation internationale de - normalisation (ISO) "yyyy-mm-dd" est utilisé. Ceci est la valeur par - défaut. - - - DB2_I5_FMT_USA : le format de date des - États-Unis "mm/dd/yyyy" est utilisé. - - - DB2_I5_FMT_EUR : le format de date européen - "dd.mm.yyyy" est utilisé. - - - DB2_I5_FMT_JIS : le format de date de - la norme industrielle japonaise (JIS) "yyyy-mm-dd" est utilisé. - - - DB2_I5_FMT_MDY : le format de date "mm/dd/yyyy" - est utilisé. - - - DB2_I5_FMT_DMY : le format de date "dd/mm/yyyy" - est utilisé. - - - DB2_I5_FMT_YMD : le format de date "yy/mm/dd" est - utilisé. - - - DB2_I5_FMT_JUL : le format de date julien "yy/ddd" - est utilisé. - - - DB2_I5_FMT_JOB : la valeur par défaut est utilisée. - - - - - i5_date_sep - - - DB2_I5_SEP_SLASH : un slash ( / ) est utilisé - en tant que séparateur de date. - Ceci est la valeur par défaut. - - - DB2_I5_SEP_DASH : un tiret ( - ) est utilisé en - tant que séparateur de date. - - - DB2_I5_SEP_PERIOD : un point ( . ) est utilisé - en tant que séparateur de date. - - - DB2_I5_SEP_COMMA : une virgule ( , ) est - utilisée en tant que séparateur de date. - - - DB2_I5_SEP_BLANK : un espace blanc est utilisé - en tant que séparateur de date. - - - DB2_I5_SEP_JOB : la valeur par défaut est - utilisée. - - - - - i5_time_fmt - - - DB2_I5_FMT_ISO : le format de l'heure de - l'organisation internationale de normalisation (ISO) "hh.mm.ss" est - utilisé. Ceci est la valeur par défaut. - - - DB2_I5_FMT_USA : le format de l'heure des - États-Unis "hh:mmxx" est utilisé, où "xx" - vaut "AM" ou "PM". - - - DB2_I5_FMT_EUR : le format de l'heure européen - "hh.mm.ss" est utilisé. - - - DB2_I5_FMT_JIS : le format de l'heure de - la norme industrielle japonaise "hh:mm:ss" est utilisé. - - - DB2_I5_FMT_HMS : le format "hh:mm:ss" est utilisé. - - - - - i5_time_sep - - - DB2_I5_SEP_COLON : un deux-points ( : ) est - utilisé en tant que séparateur d'heure. Ceci est la valeur par - défaut. - - - DB2_I5_SEP_PERIOD : un point ( . ) est utilisé - en tant que séparateur d'heure. - - - DB2_I5_SEP_COMMA : une virgule ( , ) est - utilisée en tant que séparateur d'heure. - - - DB2_I5_SEP_BLANK : un espace blanc est utilisé - en tant que séparateur d'heure. - - - DB2_I5_SEP_JOB : la valeur par défaut est - utilisée. - - - - - i5_decimal_sep - - - DB2_I5_SEP_PERIOD : un point ( . ) est utilisé - en tant que séparateur de décimale. Ceci est la valeur par défaut. - - - DB2_I5_SEP_COMMA : une virgule ( , ) est - utilisée en tant que séparateur de décimale. - - - DB2_I5_SEP_JOB : la valeur par défaut est - utilisée. - - - - - - - La nouvelle option i5/OS suivante est disponible à partir de la version ibm_db2 - 1.8.0. - - - i5_libl - - - Une chaîne indiquant la liste de bibliothèques à utiliser pour résoudre les références - de fichiers non qualifiés. Spécifier la liste en séparant les - valeurs par un espace, comme ceci : 'i5_libl'=>"MYLIB YOURLIB ANYLIB". - - - - i5_libl appelle qsys2/qcmdexc('cmd',cmdlen), - qui n'est disponible qu'à partir de i5/OS V5R4. - - - - - - - - - - - - &reftitle.returnvalues; - - Retourne la ressource de connexion si la tentative de connexion réussit. Si - la tentative de connexion échoue, db2_connect retourne - &false;. - - - - - &reftitle.examples; - - - Création d'une connexion cataloguée - - Les connexions cataloguées nécessitent que l'on ait préalablement - catalogué la base de données spécifiée à l'aide du processeur de ligne de - commandes DB2 ("Command Line Processor" : CLP) ou avec l'assistant de - configuration de DB2. - - - -]]> - - &example.outputs; - - - - - - Création d'une connexion non cataloguée - - Une connexion non cataloguée permet de se connecter dynamiquement - à une base de données. - - - -]]> - - &example.outputs; - - - - - - Création d'une connexion avec autocommit désactivé par défaut - - Le fait de passer un tableau d'option à db2_connect - permet de modifier le comportement par défaut de la connexion. - - - DB2_AUTOCOMMIT_OFF); - -$conn = db2_connect($database, $user, $password, $options); - -if ($conn) { - echo "Connexion réussie.\n"; - if (db2_autocommit($conn)) { - echo "Autocommit est activé.\n"; - } - else { - echo "Autocommit est désactivé.\n"; - } - db2_close($conn); -} -else { - echo "Connexion échouée."; -} -?> -]]> - - &example.outputs; - - - - - - - Meilleure performance i5/OS - - Pour obtenir les meilleures performances de l'application PHP i5/OS - ibm_db2 1.5.1, utiliser l'hôte par défaut, l'identifiant utilisateur et - le mot de passe pour l'appel à db2_connect. - - -"qsys2")); - $result = db2_exec($i5, - "select * from systables where table_schema = '$library'"); - while ($row = db2_fetch_both($result)) { - echo $row['TABLE_NAME']."
"; - } - db2_close($i5); -?> -]]> - - &example.outputs; - - - - - - Utilisation du contexte de confiance - - L'exemple suivant montre comment activer le contexte de confiance, changer d'utilisateur - et récupérer l'ID de l'utilisateur courant. - - - DB2_TRUSTED_CONTEXT_ENABLE); - -$tc_conn = db2_connect($dsn, "", "", $options); -if($tc_conn) { - echo "Connexion explicite de confiance réussie.\n"; - - if(db2_get_option($tc_conn, "trustedcontext")) { - $userBefore = db2_get_option($tc_conn, "trusted_user"); - - //Code en tant qu'utilisateur 1. - - //Passage à l'utilisateur de confiance. - $parameters = array("trusted_user" => $tc_user, - "trusted_password" => $tcuser_pass); - $res = db2_set_option ($tc_conn, $parameters, 1); - - $userAfter = db2_get_option($tc_conn, "trusted_user"); - //Code en tant qu'utilisateur de confiance. - - if($userBefore != $userAfter) { - echo "L'utilisateur a changé." . "\n"; - } - } - - db2_close($tc_conn); -} -else { - echo "La connexion explicite de confiance a échoué.\n"; -} -?> - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_close - db2_pconnect - - - - - - diff --git a/reference/ibm_db2/functions/db2-cursor-type.xml b/reference/ibm_db2/functions/db2-cursor-type.xml deleted file mode 100644 index 1a07c86c36..0000000000 --- a/reference/ibm_db2/functions/db2-cursor-type.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - db2_cursor_type - - Retourne le type de curseur utilisé par une ressource d'instruction - - - - &reftitle.description; - - intdb2_cursor_type - resourcestmt - - - - Retourne le type de curseur utilisé par une ressource d'instruction. - Cette fonction permet de déterminer si l'on travaille avec un curseur - à avance seul ou un curseur flottant. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource d'instruction valide. - - - - - - - &reftitle.returnvalues; - - Retourne DB2_FORWARD_ONLY si la ressource d'instruction - utilise un curseur à avance seul ou DB2_SCROLLABLE - si la ressource d'instruction utilise un curseur flottant. - - - - - &reftitle.seealso; - - db2_prepare - - - - diff --git a/reference/ibm_db2/functions/db2-escape-string.xml b/reference/ibm_db2/functions/db2-escape-string.xml deleted file mode 100755 index 3b6485461e..0000000000 --- a/reference/ibm_db2/functions/db2-escape-string.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - db2_escape_string - - Utilisé pour échapper certains caractères - - - - - &reftitle.description; - - stringdb2_escape_string - stringstring_literal - - - Place des antislashs devant les caractères spéciaux à la chaîne de caractères passée en argument. - - - - - &reftitle.parameters; - - - string_literal - - - Une &string; qui contient des caractères spéciaux qui doivent être modifiés. - Les caractères qui sont transformés à l'aide d'un antislash sont \x00, - \n, \r, \, - ', " et \x1a. - - - - - - - - &reftitle.returnvalues; - - Retourne string_literal avec les caractères spéciaux mentionnés - ci-dessus précédés par des antislashs. - - - - - &reftitle.examples; - - Exemple avec <function>db2_escape_string</function> - - Résultat suite à l'utilisation de la fonction db2_escape_string - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_prepare - - - - - diff --git a/reference/ibm_db2/functions/db2-exec.xml b/reference/ibm_db2/functions/db2-exec.xml deleted file mode 100644 index 595a6354d8..0000000000 --- a/reference/ibm_db2/functions/db2-exec.xml +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - - db2_exec - - Exécute une requête SQL directement - - - - &reftitle.description; - - resourcefalsedb2_exec - resourceconnection - stringstatement - arrayoptions[] - - - - Exécute une requête SQL directement. - - - Pour intercaler des variables PHP dans la requête SQL, il faut - comprendre que c'est l'une des plus communes failles de sécurité. - Il est recommandé d'appeler la fonction db2_prepare - pour préparer une requête SQL qui contient des marqueurs pour des variables d'entrée. - Ensuite, il est possible d'appeler la fonction db2_execute - pour passer les valeurs d'entrée et ainsi éviter les attaques par - injections SQL. - - - Pour appeler à plusieurs reprises la même requête SQL avec des - paramètres différents, il est préférable d'appeler la - fonction db2_prepare et - db2_execute pour permettre au serveur de base de - données de réutiliser son plan d'accès et ainsi augmenter l'efficacité de - l'accès à la base de données. - - - - - &reftitle.parameters; - - - connection - - - Une variable ressource de connexion valide retournée par - db2_connect ou db2_pconnect. - - - - - statement - - - Une requête SQL. La requête ne peut contenir de marqueur. - - - - - options - - - Un tableau associatif contenant les options de la requête. Il est possible - d'utiliser ce paramètre pour demander un curseur flottant sur les - serveurs de base de données qui supportent cette fonctionnalité. - - - Pour une description des options valides, se reporter à la fonction - db2_set_option. - - - - - - - &reftitle.returnvalues; - - Retourne une variable ressource si la requête SQL était envoyée - correctement ou &false; si la base de données n'a pas réussi à exécuter la - requête SQL. - - - - - &reftitle.examples; - - - Création d'une table avec <function>db2_exec</function> - - L'exemple suivant utilise la fonction db2_exec pour - envoyer un ensemble de requêtes DDL afin de créer une table. - - - -]]> - - &example.outputs; - - - - - - - Exécution d'une requête SELECT avec un curseur flottant - - L'exemple suivant montre comment demander un curseur flottant pour une - requête SQL envoyée avec la fonction db2_exec. - - - DB2_SCROLLABLE)); - while ($row = db2_fetch_array($stmt)) { - print "$row[0]\n"; - } -} -?> -]]> - - &example.outputs; - - - - - - Retourne des données XML en tant que ResultSet SQL - - L'exemple suivant démontre comment utiliser des documents enregistrés - dans une colonne XML en utilisant la base de données SAMPLE. En - utilisant un simple SQL/XML, cet exemple retourne quelques nœuds dans un - document XML dans un format ResultSet SQL dont la plupart des - utilisateurs sont familiers. - - -CID $row->NAME $row->PHONE\n"); -} -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Exécuter un "JOIN" avec des données XML - - L'exemple suivant fonctionne avec des documents enregistrés dans deux - colonnes XML différentes de la base de données SAMPLE. Cela crée deux - tables temporaires provenant des documents XML de deux colonnes XML - différentes et retourne un ResultSet SQL avec les informations contenant - le statut de livraison pour un client. - - -CID $row->NAME $row->PHONE $row->PONUM $row->STATUS\n"); -} - -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Retourne des données SQL faisant partie d'un document XML large - - L'exemple suivant utilise une portion des documents de - PRODUCT.DESCRIPTION dans la base de données SAMPLE. Cela crée un document - XML contenant la description du produit (données XML) et les informations - concernant le prix (données SQL). - - - { - for $prod in $doc/product - where $prod/description/price < 10.00 - order by $prod/description/price ascending - return( - { - $prod, - {$start} , - {$end} , - {$promo} - } - ) - } -\' passing by ref DESCRIPTION AS "doc", -PROMOSTART as "start", -PROMOEND as "end", -PROMOPRICE as "promo" -RETURNING SEQUENCE) -AS CLOB (32000)) -AS NEW_PRODUCT_INFO -FROM PRODUCT -WHERE PID = \'100-100-01\' -'; - -$stmt = db2_exec($conn, $query); - -while($row = db2_fetch_array($stmt)){ - printf("$row[0]\n"); -} -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Snow Shovel, Basic 22 inch -
Basic Snow Shovel, 22 inches wide, straight handle with D-Grip
- 9.99 - 1 kg - - - 2004-11-19 - 2004-12-19 - 7.25 - - -]]> - - - - - - - &reftitle.seealso; - - db2_execute - db2_prepare - - - - - - diff --git a/reference/ibm_db2/functions/db2-execute.xml b/reference/ibm_db2/functions/db2-execute.xml deleted file mode 100644 index e826173bf6..0000000000 --- a/reference/ibm_db2/functions/db2-execute.xml +++ /dev/null @@ -1,372 +0,0 @@ - - - - - - - db2_execute - - Exécute une requête SQL préparée - - - - &reftitle.description; - - booldb2_execute - resourcestmt - arrayparameters[] - - - - db2_execute exécute une requête SQL qui a été - préparée par db2_prepare. - - - Si la requête SQL retourne un jeu de résultats, par exemple, une requête - SELECT ou un CALL à une procédure stockée retournant un ou - plusieurs jeux de résultats, il est possible de récupérer une ligne en tant que - tableau à partir de la ressource stmt en utilisant - db2_fetch_assoc, - db2_fetch_both ou - db2_fetch_array. Alternativement, il est possible d'utiliser - db2_fetch_row pour déplacer le pointeur du jeu de résultats - à la ligne suivante et récupérer une colonne à la fois de cette ligne avec la - fonction db2_result. - - - Se référer à db2_prepare pour une brève discussion - sur les avantages de l'utilisation de db2_prepare et - db2_execute plutôt que db2_exec. - - - - - &reftitle.parameters; - - - stmt - - - Une requête préparée retournée par db2_prepare. - - - - - parameters - - - Un tableau des paramètres d'entrée qui contient les marqueurs de - variables contenus dans la requête préparée. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Préparation et exécution d'une requête SQL avec des marqueurs - - L'exemple suivant prépare une requête INSERT qui accepte quatre - marqueurs, ensuite itère sur le tableau contenant les valeurs d'entrées - qui sera passé à la fonction db2_execute. - - - -]]> - - &example.outputs; - - - - - - Appel d'une procédure stockée avec un paramètre de SORTIE - - L'exemple suivant prépare une requête CALL qui accepte un marqueur qui - représente un paramètre de SORTIE, lie la variable PHP $my_pets - au paramètre en utilisant la fonction - db2_bind_param et appelle la fonction - db2_execute pour exécuter la requête - CALL. Une fois que la requête CALL a été exécutée, la valeur de - $num_pets change pour refléter la valeur retournée - par la procédure stockée pour ce paramètre de SORTIE. - - - -]]> - - &example.outputs; - - - - - - Retourne des données XML en tant que ResultSet SQL - - L'exemple suivant démontre comment utiliser des documents enregistrés - dans une colonne XML en utilisant la base de données SAMPLE. En - utilisant un simple SQL/XML, cet exemple retourne quelques nœuds dans un - document XML dans un format ResultSet SQL dont la plupart des - utilisateurs sont familiers. - - -CID $row->NAME $row->PHONE\n"); - } -} -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Exécuter un "JOIN" avec des données XML - - L'exemple suivant fonctionne avec des documents enregistrés dans deux - colonnes différentes dans la base de données SAMPLE. Cela crée deux - tables temporaires provenant des documents XML de deux différentes - colonnes XML et retourne un ResultSet SQL avec les informations contenant - le statut de livraison pour un client. - - -CID $row->NAME $row->PHONE $row->PONUM $row->STATUS\n"); - } -} - -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Retourne des données SQL faisant partie d'un document XML large - - L'exemple suivant utilise une portion des documents de - PRODUCT.DESCRIPTION dans la base de données SAMPLE. Cela crée un document - XML contenant la description du produit (données XML) et les informations - concernant le prix (données SQL). - - - { - for $prod in $doc/product - where $prod/description/price < 10.00 - order by $prod/description/price ascending - return( - { - $prod, - {$start} , - {$end} , - {$promo} - } - ) - } -\' passing by ref DESCRIPTION AS "doc", -PROMOSTART as "start", -PROMOEND as "end", -PROMOPRICE as "promo" -RETURNING SEQUENCE) -AS CLOB (32000)) -AS NEW_PRODUCT_INFO -FROM PRODUCT -WHERE PID = ? -'; - -$stmt = db2_prepare($conn, $query); - -$pid = "100-100-01"; - -if ($stmt) { - db2_bind_param($stmt, 1, "pid", DB2_PARAM_IN); - db2_execute($stmt); - - while($row = db2_fetch_array($stmt)){ - printf("$row[0]\n"); - } -} - -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Snow Shovel, Basic 22 inch -
Basic Snow Shovel, 22 inches wide, straight handle with D-Grip
- 9.99 - 1 kg - - - 2004-11-19 - 2004-12-19 - 7.25 - - -]]> - - - - - - - &reftitle.seealso; - - db2_exec - db2_fetch_array - db2_fetch_assoc - db2_fetch_both - db2_fetch_row - db2_prepare - db2_result - - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-array.xml b/reference/ibm_db2/functions/db2-fetch-array.xml deleted file mode 100644 index dcd4b44504..0000000000 --- a/reference/ibm_db2/functions/db2-fetch-array.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - db2_fetch_array - - Retourne un tableau, indexé par la position des colonnes, représentant une - ligne du jeu de résultats - - - - &reftitle.description; - - arrayfalsedb2_fetch_array - resourcestmt - introw_number-1 - - - - Retourne un tableau, indexé par la position des colonnes, représentant une - ligne du jeu de résultats. Les indices du tableau sont numériques et - commencent par zéro. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource stmt valide contenant le jeu de - résultats. - - - - - row_number - - - Demande une ligne spécifique indexée numériquement qui commence par la - valeur 1 au jeu de résultats. En fournissant ce paramètre, - une alerte PHP sera générée si le jeu de résultats - utilise un curseur d'avancement seul. - - - - - - - &reftitle.returnvalues; - - Retourne un tableau à indices numériques commençant à 0 indexé avec la position des - colonnes. Cet indice pointe vers des données de la ligne suivante - ou la ligne demandée dans le jeu de résultats. Retourne &false; - s'il n'y a pas de ligne disponible dans le jeu de résultats ou si - la ligne demandée par row_number n'existe - pas dans le jeu de résultats. - - - - - &reftitle.examples; - - - Itère avec un curseur d'avancement seul - - Si l'on appelle db2_fetch_array sans le numéro d'une - ligne spécifique, la ligne suivante sera automatiquement récupérée dans le - jeu de résultats. - - - -]]> - - &example.outputs; - - - - - - - Récupération de lignes spécifiques avec <function>db2_fetch_array</function> - provenant d'un curseur flottant - - Si le jeu de résultats utilise un curseur flottant, il est possible d'appeler la fonction db2_fetch_array avec un numéro - de ligne spécifique. L'exemple suivant récupère chaque ligne paire dans - le jeu de résultats, commençant avec la deuxième ligne. - - - DB2_SCROLLABLE)); - -$i=2; -while ($row = db2_fetch_array($result, $i)) { - printf ("%-5d %-16s %-32s %10s\n", - $row[0], $row[1], $row[2], $row[3]); - $i = $i + 2; -} -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_fetch_assoc - db2_fetch_both - db2_fetch_object - db2_fetch_row - db2_result - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-assoc.xml b/reference/ibm_db2/functions/db2-fetch-assoc.xml deleted file mode 100644 index 3a46ca4154..0000000000 --- a/reference/ibm_db2/functions/db2-fetch-assoc.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - db2_fetch_assoc - - Retourne un tableau, indexé par nom de colonne, représentant une ligne du jeu - de résultats - - - - &reftitle.description; - - arrayfalsedb2_fetch_assoc - resourcestmt - introw_number-1 - - - - Retourne un tableau, indexé par nom de colonne, représentant une ligne du jeu - de résultats. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource stmt valide contenant le jeu de - résultats. - - - - - row_number - - - Demande une ligne spécifique indexée numériquement qui commence par la - valeur 1 dans le jeu de résultats. En fournissant ce paramètre, - une alerte PHP sera générée si le jeu de résultats - utilise un curseur d'avancement seul. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif avec les valeurs des colonnes indexées par - le nom des colonnes représentant la ligne suivante ou la ligne demandée dans le - jeu de résultats. Retourne &false; s'il n'y a pas de ligne disponible dans - le jeu de résultats ou si la ligne demandée par - row_number n'existe pas dans le jeu de résultats. - - - - - &reftitle.examples; - - - Itère avec un curseur d'avancement seul - - Si l'on appelle db2_fetch_assoc sans le numéro d'une - ligne spécifique, la ligne suivante sera automatiquement récupérée dans le - jeu de résultats. - - - -]]> - - &example.outputs; - - - - - - - Récupération de lignes spécifiques avec <function>db2_fetch_assoc</function> - provenant d'un curseur flottant - - Si le jeu de résultats utilise un curseur flottant, il est possible d'appeler la fonction db2_fetch_assoc avec un numéro - de ligne spécifique. L'exemple suivant récupère chaque ligne paire dans - le jeu de résultats, commençant avec la deuxième ligne. - - - DB2_SCROLLABLE)); - -$i=2; -while ($row = db2_fetch_assoc($result, $i)) { - printf ("%-5d %-16s %-32s %10s\n", - $row['ID'], $row['NOM'], $row['RACE'], $row['POIDS']); - $i = $i + 2; -} -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_both - db2_fetch_object - db2_fetch_row - db2_result - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-both.xml b/reference/ibm_db2/functions/db2-fetch-both.xml deleted file mode 100644 index 3bdcdf7dd4..0000000000 --- a/reference/ibm_db2/functions/db2-fetch-both.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - db2_fetch_both - - Retourne un tableau, indexé par nom de colonne et position, représentant - une ligne du jeu de résultats - - - - &reftitle.description; - - arrayfalsedb2_fetch_both - resourcestmt - introw_number-1 - - - - Retourne un tableau, indexé par nom de colonne et position, représentant - une ligne du jeu de résultats. Il est à noter que la ligne retournée par - db2_fetch_both nécessite plus de mémoire que les - tableaux simplement indexés retournés par - db2_fetch_assoc ou - db2_fetch_array. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource stmt valide contenant le jeu de - résultats. - - - - - row_number - - - Demande une ligne spécifique indexée numériquement qui commence par la - valeur 1 dans le jeu de résultats. Fournir ce paramètre génère une - alerte PHP si le jeu de résultats utilise un curseur d'avancement seul. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif avec les valeurs des colonnes indexées par - le nom des colonnes et le numéro des colonnes commençant par 0. Le tableau - représente la ligne suivante ou la ligne demandée du jeu de résultats. - Retourne &false; s'il n'y a pas de ligne disponible dans le jeu de - résultats ou si la ligne demandée par row_number - n'existe pas dans le jeu de résultats. - - - - - &reftitle.examples; - - - Itération avec un curseur d'avancement seul - - Si l'on appelle db2_fetch_both sans le numéro d'une - ligne spécifique, la ligne suivante du jeu de résultats sera - automatiquement récupérée. L'exemple suivant accède aux colonnes - retournées dans le tableau à la fois par nom de colonne et par indice - numérique. - - - -]]> - - &example.outputs; - - - - - - - Récupération de lignes spécifiques avec <function>db2_fetch_both</function> - provenant d'un curseur flottant - - Si le jeu de résultats utilise un curseur flottant, il est possible d'appeler la fonction db2_fetch_both avec un numéro - de ligne spécifique. L'exemple suivant récupère chaque ligne paire dans - le jeu de résultats, commençant avec la deuxième ligne. - - - DB2_SCROLLABLE)); - -$i=2; -while ($row = db2_fetch_both($result, $i)) { - printf ("%-5d %-16s %-32s %10s\n", - $row[0], $row['NOM'], $row[2], $row['POIDS']); - $i = $i + 2; -} -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_assoc - db2_fetch_object - db2_fetch_row - db2_result - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-object.xml b/reference/ibm_db2/functions/db2-fetch-object.xml deleted file mode 100644 index 258565b990..0000000000 --- a/reference/ibm_db2/functions/db2-fetch-object.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - db2_fetch_object - - Retourne un objet avec les propriétés représentant des colonnes dans la - ligne extraite - - - - &reftitle.description; - - stdClassfalsedb2_fetch_object - resourcestmt - introw_number-1 - - - - Retourne un objet dans lequel chaque propriété représente une colonne - retournée dans la ligne extraite du jeu de résultats. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource stmt valide contenant le jeu de résultats. - - - - - row_number - - - Demande une ligne spécifique commençant à l'index 1 du jeu de - résultats. Le passage de ce paramètre entraîne une alerte PHP - si le jeu de résultats utilise un curseur unidirectionnel. - - - - - - - &reftitle.returnvalues; - - Retourne un objet représentant une seule ligne dans le jeu de résultats. - Les propriétés de l'objet correspondent au nom des colonnes dans le jeu de - résultats. - - - Les serveurs IBM DB2, Cloudscape et Apache Derby mettent normalement les - noms des colonnes en majuscules, par conséquent, les propriétés de - l'objet refléteront cette casse. - - - Si la requête SELECT appelle une fonction scalaire pour modifier la - valeur d'une colonne, les serveurs de base de données retournent le numéro - de colonne en tant que nom de colonne dans le jeu de résultats. Si l'on - préfère un nom de colonne et une propriété d'objet plus descriptifs, - il est possible d'utiliser la clause AS pour assigner un nom à la colonne - dans le jeu de résultats. - - - Retourne &false; si aucune ligne n'a été récupérée. - - - - - &reftitle.examples; - - Exemple avec <function>db2_fetch_object</function> - - L'exemple suivant envoie une requête SELECT avec une fonction scalaire, - RTRIM, qui supprime les espaces à partir de la fin de la colonne. Au lieu - de créer un objet avec les propriétés "RACE" et "2", la clause AS est - utilisée dans la requête SELECT pour assigner le nom "nom" à la colonne - modifiée. Le serveur de base de données met les noms des colonnes en - majuscules, l'objet aura donc les propriétés "RACE" et "NOM". - - -NOM}, mon petit {$pet->RACE} !"; - } - db2_close($conn); -} -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_assoc - db2_fetch_both - db2_fetch_row - db2_result - - - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-row.xml b/reference/ibm_db2/functions/db2-fetch-row.xml deleted file mode 100644 index baaa406d18..0000000000 --- a/reference/ibm_db2/functions/db2-fetch-row.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - - db2_fetch_row - - Modifie le pointeur du jeu de résultats à la prochaine ligne ou à la ligne - demandée - - - - &reftitle.description; - - booldb2_fetch_row - resourcestmt - introw_number-1 - - - - La fonction db2_fetch_row peut être utilisée pour itérer à travers un jeu de - résultats ou pour pointer à une ligne spécifique d'un jeu de résultats - si l'on a demandé un curseur défilant. - - - Pour obtenir des champs individuels du jeu de résultats, il faut appeler la fonction - db2_result. - - - Au lieu d'appeler les fonctions db2_fetch_row et - db2_result, la plupart des applications vont appeler - la fonction db2_fetch_assoc, - db2_fetch_both ou db2_fetch_array - pour avancer le pointeur dans le jeu de résultats et retourner une ligne - complète en tant que tableau. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource stmt valide. - - - - - row_number - - - Avec des curseurs défilants, il est possible de demander un numéro de ligne - spécifique du jeu de résultats. Les numéros des lignes commencent à - l'indice 1. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si la ligne demandée existe dans le jeu de résultats. - Retourne &false; si la ligne demandée n'existe pas dans le jeu de - résultats. - - - - - &reftitle.examples; - - - Itération à travers un jeu de résultats - - L'exemple suivant démontre comment itérer à travers un jeu de résultats - avec la fonction db2_fetch_row et récupérer les - colonnes du jeu de résultats avec db2_result. - - - -]]> - - &example.outputs; - - - - - - Alternatives recommandées sur i5/OS à db2_fetch_row/db2_result - - Sur i5/OS, il est recommandé d'utiliser - db2_fetch_both, db2_fetch_array - ou db2_fetch_object au lieu de - db2_fetch_row/db2_result. - En général, - db2_fetch_row/db2_result ont plus - de problèmes avec divers types de colonnes lors de la traduction - EBCDIC vers ASCII, y compris une - possible troncature dans les applications DBCS. - Il est également possible de trouver les performances de - db2_fetch_both, db2_fetch_array - et db2_fetch_object supérieures à celles de - db2_fetch_row/db2_result. - - - DB2_SCROLLABLE)); - while ($row = db2_fetch_both($stmt)){ - echo "
db2_fetch_both {$row['SPECIFIC_NAME']} {$row['ROUTINE_CREATED']} {$row[5]}"; - } - $stmt = db2_exec($conn, $sql, array('cursor' => DB2_SCROLLABLE)); - while ($row = db2_fetch_array($stmt)){ - echo "
db2_fetch_array {$row[1]} {$row[5]}"; - } - $stmt = db2_exec($conn, $sql, array('cursor' => DB2_SCROLLABLE)); - while ($row = db2_fetch_object($stmt)){ - echo "
db2_fetch_object {$row->SPECIFIC_NAME} {$row->ROUTINE_CREATED}"; - } - db2_close($conn); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_assoc - db2_fetch_both - db2_fetch_object - db2_result - - - - diff --git a/reference/ibm_db2/functions/db2-field-display-size.xml b/reference/ibm_db2/functions/db2-field-display-size.xml deleted file mode 100644 index c2e1fe1c39..0000000000 --- a/reference/ibm_db2/functions/db2-field-display-size.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - db2_field_display_size - - Retourne le maximum d'octets requis pour afficher une colonne - - - - &reftitle.description; - - intfalsedb2_field_display_size - resourcestmt - intstringcolumn - - - - Retourne le maximum d'octets requis pour afficher une colonne dans un jeu - de résultats. - - - - - &reftitle.parameters; - - - stmt - - - Spécifie la ressource contenant le jeu de résultats. - - - - - column - - - Spécifie la colonne dans le jeu de résultats. Cela peut être un entier - commençant à la position 0 représentant le numéro de la colonne - ou une chaîne contenant le nom de la colonne. - - - - - - - &reftitle.returnvalues; - - Retourne une valeur entière avec le maximum d'octets requis pour afficher - la colonne spécifiée. Si la colonne n'existe pas dans le jeu de résultats, - db2_field_display_size retourne &false;. - - - - - &reftitle.seealso; - - db2_field_name - db2_field_num - db2_field_precision - db2_field_scale - db2_field_type - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-field-name.xml b/reference/ibm_db2/functions/db2-field-name.xml deleted file mode 100644 index 16e64f3b74..0000000000 --- a/reference/ibm_db2/functions/db2-field-name.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - db2_field_name - - Retourne le nom de la colonne du jeu de résultats - - - - &reftitle.description; - - stringfalsedb2_field_name - resourcestmt - intstringcolumn - - - - Retourne le nom de la colonne du jeu de résultats - - - - - &reftitle.parameters; - - - stmt - - - Spécifie la ressource contenant le jeu de résultats. - - - - - column - - - Spécifie la colonne dans le jeu de résultats. Cela peut être un entier - commençant à la position 0 représentant le numéro de la colonne - ou une chaîne contenant le nom de la colonne. - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant le nom de la colonne spécifiée. Si la colonne - spécifiée n'existe pas dans le jeu de résultats, - db2_field_name retourne &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_num - db2_field_precision - db2_field_scale - db2_field_type - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-field-num.xml b/reference/ibm_db2/functions/db2-field-num.xml deleted file mode 100644 index e689409f61..0000000000 --- a/reference/ibm_db2/functions/db2-field-num.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - db2_field_num - - Retourne la position de la colonne nommée dans un jeu de résultats - - - - &reftitle.description; - - intfalsedb2_field_num - resourcestmt - intstringcolumn - - - - Retourne la position de la colonne nommée dans un jeu de résultats. - - - - - &reftitle.parameters; - - - stmt - - - Spécifie une ressource d'instruction contenant un jeu de résultats. - - - - - column - - - Spécifie la colonne dans le jeu de résultats. Cela peut être un entier - commençant à la position 0 représentant le numéro de la colonne - ou une chaîne contenant le nom de la colonne. - - - - - - - &reftitle.returnvalues; - - Retourne un entier contenant la position commençant à 0 de la colonne - nommée dans le jeu de résultats. Si la colonne spécifiée n'existe pas dans - le jeu de résultats, db2_field_num retourne &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_precision - db2_field_scale - db2_field_type - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-field-precision.xml b/reference/ibm_db2/functions/db2-field-precision.xml deleted file mode 100644 index e2445e086f..0000000000 --- a/reference/ibm_db2/functions/db2-field-precision.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - db2_field_precision - - Retourne la précision de la colonne indiquée du jeu de résultats - - - - &reftitle.description; - - intfalsedb2_field_precision - resourcestmt - intstringcolumn - - - - Retourne la précision de la colonne indiquée du jeu de résultats. - - - - - &reftitle.parameters; - - - stmt - - - Spécifie la ressource contenant le jeu de résultats. - - - - - column - - - Spécifie la colonne dans le jeu de résultats. Cela peut être un entier - commençant à la position 0 représentant le numéro de la colonne - ou une chaîne contenant le nom de la colonne. - - - - - - - &reftitle.returnvalues; - - Retourne un entier contenant la précision de la colonne spécifiée. Si la - colonne spécifiée n'existe pas dans le jeu de résultats, - db2_field_precision retourne &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_num - db2_field_scale - db2_field_type - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-field-scale.xml b/reference/ibm_db2/functions/db2-field-scale.xml deleted file mode 100644 index dd380adab5..0000000000 --- a/reference/ibm_db2/functions/db2-field-scale.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - db2_field_scale - - Retourne l'échelle de la colonne indiquée du jeu de résultats - - - - &reftitle.description; - - intfalsedb2_field_scale - resourcestmt - intstringcolumn - - - - Retourne l'échelle de la colonne indiquée du jeu de résultats. - - - - - &reftitle.parameters; - - - stmt - - - Spécifie la ressource contenant le jeu de résultats. - - - - - column - - - Spécifie la colonne dans le jeu de résultats. Cela peut être un entier - commençant à la position 0 représentant le numéro de la colonne - ou une chaîne contenant le nom de la colonne. - - - - - - - &reftitle.returnvalues; - - Retourne un entier contenant l'échelle de la colonne spécifiée. Si la - colonne spécifiée n'existe pas dans le jeu de résultats, - db2_field_scale retourne &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_num - db2_field_precision - db2_field_type - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-field-type.xml b/reference/ibm_db2/functions/db2-field-type.xml deleted file mode 100644 index e391024fb9..0000000000 --- a/reference/ibm_db2/functions/db2-field-type.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - db2_field_type - - Retourne le type de données de la colonne indiquée du jeu de résultats - - - - &reftitle.description; - - stringfalsedb2_field_type - resourcestmt - intstringcolumn - - - - Retourne le type de données de la colonne indiquée du jeu de résultats. - - - - - &reftitle.parameters; - - - stmt - - - Spécifie la ressource contenant le jeu de résultats. - - - - - column - - - Spécifie la colonne dans le jeu de résultats. Cela peut être un entier - commençant à la position 0 représentant le numéro de la colonne - ou une chaîne contenant le nom de la colonne. - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant le type de données défini de la colonne - spécifiée. Si la colonne spécifiée n'existe pas dans le jeu de résultats, - db2_field_type retourne &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_num - db2_field_precision - db2_field_scale - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-field-width.xml b/reference/ibm_db2/functions/db2-field-width.xml deleted file mode 100644 index 18a957e4e2..0000000000 --- a/reference/ibm_db2/functions/db2-field-width.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - db2_field_width - - Retourne la largeur de la valeur courante de la colonne indiquée du - jeu de résultats - - - - &reftitle.description; - - intfalsedb2_field_width - resourcestmt - intstringcolumn - - - - Retourne la largeur de la valeur courante de la colonne indiquée du jeu de - résultats. Il s'agit de la largeur maximale de la colonne pour un type de - données de longueur fixe, ou de la largeur réelle de la colonne pour un - type de données de longueur variable. - - - - - &reftitle.parameters; - - - stmt - - - Spécifie la ressource contenant le jeu de résultats. - - - - - column - - - Spécifie la colonne dans le jeu de résultats. Cela peut être un entier - commençant à la position 0 représentant le numéro de la colonne - ou une chaîne contenant le nom de la colonne. - - - - - - - &reftitle.returnvalues; - - Retourne un entier contenant la largeur du caractère spécifié ou de la - colonne de type binaire dans le jeu de résultats. Si la colonne spécifiée - n'existe pas dans le jeu de résultats, db2_field_width - retourne &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_num - db2_field_precision - db2_field_scale - db2_field_type - - - - diff --git a/reference/ibm_db2/functions/db2-foreign-keys.xml b/reference/ibm_db2/functions/db2-foreign-keys.xml deleted file mode 100644 index 63167a3123..0000000000 --- a/reference/ibm_db2/functions/db2-foreign-keys.xml +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - - db2_foreign_keys - - Retourne un jeu de résultats listant les clés étrangères d'une table - - - - &reftitle.description; - - resourcedb2_foreign_keys - resourceconnection - stringnullqualifier - stringnullschema - stringtable_name - - - - Retourne un jeu de résultats listant les clés étrangères d'une table. - - - - - &reftitle.parameters; - - - connection - - - Une connexion valide à une base de données IBM DB2, Cloudscape ou - Apache Derby. - - - - - qualifier - - - Un qualificatif pour les bases de données DB2 qui fonctionnent sur - les serveurs OS/390 ou z/OS. Pour les autres bases de données, passez - &null; ou une chaîne vide. - - - - - schema - - - Le schéma qui contient les tables. Si schema est - &null;, db2_foreign_keys fait concorder le schéma - pour la connexion courante. - - - - - table_name - - - Le nom de la table. - - - - - - - &reftitle.returnvalues; - - Retourne une ressource d'instruction avec un jeu de résultats contenant des - lignes décrivant les clés étrangères de la table spécifiée. Le jeu de - résultats est composé des colonnes suivantes : - - - - - Nom de la colonne - Description - - - - - PKTABLE_CAT - Nom du catalogue de la table contenant la clé primaire. La - valeur est &null; si la table n'a pas de catalogue. - - - PKTABLE_SCHEM - Nom du schéma de la table contenant la clé primaire. - - - PKTABLE_NAME - Nom de la table contenant la clé primaire. - - - PKCOLUMN_NAME - Nom de la colonne contenant la clé primaire. - - - FKTABLE_CAT - Nom du catalogue de la table contenant la clé étrangère. La - valeur est &null; si la table n'a pas de catalogue. - - - FKTABLE_SCHEM - Nom du schéma de la table contenant la clé étrangère. - - - FKTABLE_NAME - Nom de la table contenant la clé étrangère. - - - FKCOLUMN_NAME - Nom de la colonne contenant la clé étrangère. - - - KEY_SEQ - Position commençant à 1 de la colonne dans la clé. - - - UPDATE_RULE - Entier représentant l'action appliquée à la clé étrangère - lorsqu'une opération SQL est de type UPDATE. - - - DELETE_RULE - Entier représentant l'action appliquée à la clé étrangère - lorsqu'une opération SQL est de type DELETE. - - - FK_NAME - Nom de la clé étrangère. - - - PK_NAME - Nom de la clé primaire. - - - DEFERRABILITY - Un entier représentant si le mode différé de la clé étrangère - est SQL_INITIALLY_DEFERRED, SQL_INITIALLY_IMMEDIATE ou - SQL_NOT_DEFERRABLE. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-free-result.xml b/reference/ibm_db2/functions/db2-free-result.xml deleted file mode 100644 index 3f63f26e69..0000000000 --- a/reference/ibm_db2/functions/db2-free-result.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - db2_free_result - - Libère la mémoire associée à un jeu de résultats - - - - &reftitle.description; - - booldb2_free_result - resourcestmt - - - - Libère les ressources système et de base de données qui sont associées - à un jeu de résultats. Ces ressources sont libérées implicitement lorsqu'un - script se termine, mais il est possible d'appeler - db2_free_result pour libérer explicitement les - ressources du jeu de résultats avant la fin du script. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource d'instruction valide. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - db2_free_stmt - - - - diff --git a/reference/ibm_db2/functions/db2-free-stmt.xml b/reference/ibm_db2/functions/db2-free-stmt.xml deleted file mode 100644 index 83e22191fc..0000000000 --- a/reference/ibm_db2/functions/db2-free-stmt.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - db2_free_stmt - - Libère les ressources associées à la ressource d'instruction indiquée - - - - &reftitle.description; - - booldb2_free_stmt - resourcestmt - - - - Libère les ressources du système et de base de données associées - à une ressource d'instruction. Ces ressources sont libérées implicitement lorsqu'un - script se termine, mais il est possible d'appeler - db2_free_stmt pour libérer explicitement les - ressources d'instruction avant la fin du script. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource d'instruction valide. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - db2_free_result - - - - diff --git a/reference/ibm_db2/functions/db2-get-option.xml b/reference/ibm_db2/functions/db2-get-option.xml deleted file mode 100755 index 1d9ad9c761..0000000000 --- a/reference/ibm_db2/functions/db2-get-option.xml +++ /dev/null @@ -1,308 +0,0 @@ - - - - - - - db2_get_option - Récupère la valeur d'une option pour une ressource d'instruction ou une ressource de connexion - - - - &reftitle.description; - - stringfalsedb2_get_option - resourceresource - stringoption - - - Récupère la valeur d'une option spécifiée pour une ressource d'instruction ou une ressource - de connexion. - - - - - &reftitle.parameters; - - - resource - - - Une ressource d'instruction valide retournée par - db2_prepare ou une ressource de connexion valide retournée par - db2_connect ou db2_pconnect. - - - - - option - - - Des options d'instruction ou de connexion valides. Les nouvelles options suivantes sont - disponibles à partir de la version 1.6.0 d'ibm_db2. Elles fournissent d'utiles informations - de traçage qui peuvent être fixées pendant l'exécution avec - db2_get_option. - - - Les anciennes versions d'ibm_db2 ne supportent pas ces nouvelles options. - - - Lorsqu'une valeur dans chaque option est fixée, certains serveurs peuvent ne pas - prendre en charge la valeur totale fournie et peuvent tronquer cette valeur. - - - Pour s'assurer que les données spécifiées dans chaque option sont converties correctement - lors de la transmission vers une base de données, utiliser seulement les caractères de A à Z, 0 à 9 - et les caractères de soulignement (_) ou point (.). - - - - - userid - - - SQL_ATTR_INFO_USERID : un pointeur vers une &string; utilisée pour identifier - l'identifiant de l'usager (ID) envoyé vers le serveur de base de données lors de l'utilisation de DB2 Connect. - - - DB2 pour les serveurs z/OS et OS/390 supporte jusqu'à 16 caractères. - Le user-id ne doit pas être confondu avec le user-id d'authentification ; il sert - uniquement à des fins d'identification et n'est pas utilisé pour des autorisations. - - - - - - - acctstr - - - SQL_ATTR_INFO_ACCTSTR : un pointeur vers une &string; utilisée pour identifier - le compte du client envoyé vers le serveur de base de données lors de l'utilisation de DB2 Connect. - - - DB2 pour les serveurs z/OS et OS/390 supporte jusqu'à 200 caractères. - - - - - - - applname - - - SQL_ATTR_INFO_APPLNAME : un pointeur vers une &string; utilisée pour identifier - le nom de l'application du client envoyé vers le serveur de base de données lors de l'utilisation de DB2 Connect. - - - DB2 pour les serveurs z/OS et OS/390 supporte jusqu'à 32 caractères. - - - - - - - wrkstnname - - - SQL_ATTR_INFO_WRKSTNNAME : un pointeur vers une &string; utilisée pour identifier - le nom de la machine du client envoyé vers le serveur de base de données lors de l'utilisation de DB2 Connect. - - - DB2 pour les serveurs z/OS et OS/390 supporte jusqu'à 18 caractères. - - - - - - - - - - - - La table suivante spécifie quelles options sont compatibles avec les types - de ressources disponibles : - - Matrice ressource-paramètre - - - - - - - - - Clé - Valeur - Type de ressource - - - - - Connexion - Instruction - Jeu de résultats - - - userid - SQL_ATTR_INFO_USERID - X - X - - - - - acctstr - SQL_ATTR_INFO_ACCTSTR - X - X - - - - - applname - SQL_ATTR_INFO_APPLNAME - X - X - - - - - wrkstnname - SQL_ATTR_INFO_WRKSTNNAME - X - X - - - - - -
- - - - - &reftitle.returnvalues; - - Retourne la configuration courante de la connexion fournie en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Définit et récupère les paramètres au travers d'une ressource de connexion - - 'db2inst1'); -$conn1 = db2_connect($database, $user, $password, $options1); -$val = db2_get_option($conn1, 'userid'); -echo $val . "\n"; - -$options2 = array('acctstr' => 'account'); -$conn2 = db2_connect($database, $user, $password, $options2); -$val = db2_get_option($conn2, 'acctstr'); -echo $val . "\n"; - -$options3 = array('applname' => 'myapp'); -$conn3 = db2_connect($database, $user, $password, $options3); -$val = db2_get_option($conn3, 'applname'); -echo $val . "\n"; - -$options4 = array('wrkstnname' => 'workstation'); -$conn4 = db2_connect($database, $user, $password, $options4); -$val = db2_get_option($conn4, 'wrkstnname'); -echo $val . "\n"; - -echo "Attributs après la connexion :\n"; - -/* Crée un tableau associatif d'options avec les paires clé/valeur valides */ -/* Assigne les attributs après que la connexion soit faite */ -/* Accède aux options spécifiées */ -$options5 = array('userid' => 'db2inst1'); -$conn5 = db2_connect($database, $user, $password); -$rc = db2_set_option($conn5, $options5, 1); -$val = db2_get_option($conn5, 'userid'); -echo $val . "\n"; - -$options6 = array('acctstr' => 'account'); -$conn6 = db2_connect($database, $user, $password); -$rc = db2_set_option($conn6, $options6, 1); -$val = db2_get_option($conn6, 'acctstr'); -echo $val . "\n"; - -$options7 = array('applname' => 'myapp'); -$conn7 = db2_connect($database, $user, $password); -$rc = db2_set_option($conn7, $options7, 1); -$val = db2_get_option($conn7, 'applname'); -echo $val . "\n"; - -$options8 = array('wrkstnname' => 'workstation'); -$conn8 = db2_connect($database, $user, $password); -$rc = db2_set_option($conn8, $options8, 1); -$val = db2_get_option($conn8, 'wrkstnname'); -echo $val . "\n"; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_connect - db2_cursor_type - db2_exec - db2_set_option - db2_pconnect - db2_prepare - - - - - diff --git a/reference/ibm_db2/functions/db2-last-insert-id.xml b/reference/ibm_db2/functions/db2-last-insert-id.xml deleted file mode 100755 index a460df3d97..0000000000 --- a/reference/ibm_db2/functions/db2-last-insert-id.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - db2_last_insert_id - Retourne le dernier ID généré par la dernière requête d'insertion - - - - &reftitle.description; - - stringnulldb2_last_insert_id - resourceresource - - - Retourne le dernier identifiant autogénéré par la dernière requête d'insertion - pour la connexion en cours. - - - Le résultat de cette fonction n'est pas affecté par les événements suivants : - - - - Une commande unique INSERT avec une clause VALUES pour une table - qui ne dispose pas de colonne d'identité. - - - - - Une commande INSERT multiple avec clause VALUES. - - - - - Une commande INSERT avec un SELECT. - - - - - Une commande ROLLBACK TO SAVEPOINT. - - - - - - - - &reftitle.parameters; - - - resource - - - Une ressource de connexion valide, créée par db2_connect - ou db2_pconnect. La valeur de ce paramètre ne peut pas - être une ressource d'instruction ou un jeu de résultats. - - - - - - - - &reftitle.returnvalues; - - Retourne l'identifiant autogénéré qui a pu être exécuté correctement - sur cette connexion. - - - - - &reftitle.examples; - - Exemple avec <function>db2_last_insert_id</function> - - L'exemple suivant montre comment retourner un identifiant automatique - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/ibm_db2/functions/db2-lob-read.xml b/reference/ibm_db2/functions/db2-lob-read.xml deleted file mode 100755 index 96b2d4ae9c..0000000000 --- a/reference/ibm_db2/functions/db2-lob-read.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - - db2_lob_read - - Récupère une taille définie par l'utilisateur de fichiers LOB à chaque invocation - - - - - &reftitle.description; - - stringfalsedb2_lob_read - resourcestmt - intcolnum - intlength - - - La fonction db2_lob_read permet d'itérer à travers une colonne - spécifique d'un jeu de résultats et de récupérer une taille définie par l'utilisateur - de données LOB. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource stmt valide contenant des données LOB. - - - - - colnum - - - Un numéro de colonne valide dans le jeu de résultats de la ressource - stmt. - - - - - length - - - La taille des données LOB à récupérer depuis la ressource - stmt. - - - - - - - - &reftitle.returnvalues; - - Retourne la quantité de données spécifiée par l'utilisateur. Retourne &false; - si les données ne peuvent être récupérées. - - - - - &reftitle.examples; - - Itère à travers différents types de données - - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_bind_param - db2_exec - db2_execute - db2_fetch_row - db2_prepare - db2_result - - - - - diff --git a/reference/ibm_db2/functions/db2-next-result.xml b/reference/ibm_db2/functions/db2-next-result.xml deleted file mode 100644 index 1df29128f0..0000000000 --- a/reference/ibm_db2/functions/db2-next-result.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - - db2_next_result - - Demande le prochain jeu de résultats d'une procédure stockée - - - - &reftitle.description; - - resourcefalsedb2_next_result - resourcestmt - - - - Une procédure stockée peut retourner aucun ou plusieurs jeux de - résultats. Il faut gérer le premier jeu de résultats de la même manière - que l'on gère les résultats retournés par une simple requête SELECT ; - pour obtenir le deuxième jeu de résultats et les suivants à partir - d'une procédure stockée, il faut appeler la fonction - db2_next_result et retourner le résultat dans - une variable PHP au nom unique. - - - - - &reftitle.parameters; - - - stmt - - - Une requête préparée retournée par db2_exec ou - db2_execute. - - - - - - - &reftitle.returnvalues; - - Retourne une nouvelle ressource d'instruction contenant le jeu de résultats - suivant si la procédure stockée a retourné un autre jeu de résultats. - Retourne &false; si la procédure stockée n'a pas retourné d'autre jeu de - résultats. - - - - - &reftitle.examples; - - Appel d'une procédure stockée qui retourne plusieurs jeux de résultats - - Dans l'exemple suivant, une procédure stockée qui retourne trois - jeux de résultats est appelée. Le premier jeu de résultats est récupéré - directement à partir de la même ressource d'instruction sur laquelle la - requête CALL a été invoquée, alors que le deuxième et le troisième jeux - de résultats sont récupérés à partir des ressources d'instruction - retournées par les appels à la fonction - db2_next_result. - - - -]]> - - &example.outputs; - - - string(16) "Bubbles " - [1]=> - int(3) -} -array(2) { - [0]=> - string(16) "Gizmo " - [1]=> - int(4) -} - -Récupération du deuxième jeu de résultats -array(4) { - [0]=> - string(16) "Sweater " - [1]=> - int(6) - [2]=> - string(5) "lama" - [3]=> - string(6) "150.00" -} -array(4) { - [0]=> - string(16) "Smarty " - [1]=> - int(2) - [2]=> - string(5) "cheval" - [3]=> - string(6) "350.00" -} - -Récupération du troisième jeu de résultats -array(1) { - [0]=> - string(16) "Bubbles " -} -array(1) { - [0]=> - string(16) "Gizmo " -} -]]> - - - - - - - - - diff --git a/reference/ibm_db2/functions/db2-num-fields.xml b/reference/ibm_db2/functions/db2-num-fields.xml deleted file mode 100644 index 321c83d08d..0000000000 --- a/reference/ibm_db2/functions/db2-num-fields.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - db2_num_fields - - Retourne le nombre de champs contenus dans un jeu de résultats - - - - &reftitle.description; - - intfalsedb2_num_fields - resourcestmt - - - - Retourne le nombre de champs contenus dans le jeu de résultats. Cette - fonction est très utile lorsqu'on gère des jeux de résultats retournés - par des requêtes générées dynamiquement ou pour des jeux de résultats - retournés par des procédures d'enregistrement, là où l'application ne - peut faire autrement pour obtenir et utiliser ces résultats. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource d'instruction valide contenant un jeu de résultats. - - - - - - - &reftitle.returnvalues; - - Retourne un entier représentant le nombre de champs dans le jeu de - résultats associé avec la ressource d'instruction spécifiée. Retourne &false; - si la ressource d'instruction n'est pas une valeur d'entrée valide. - - - - - &reftitle.examples; - - Récupération du nombre de champs dans un jeu de résultats - - L'exemple suivant démontre comment obtenir le nombre de champs retournés - dans le jeu de résultats. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_execute - db2_field_display_size - db2_field_name - db2_field_num - db2_field_precision - db2_field_scale - db2_field_type - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-num-rows.xml b/reference/ibm_db2/functions/db2-num-rows.xml deleted file mode 100644 index ed6f092480..0000000000 --- a/reference/ibm_db2/functions/db2-num-rows.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - db2_num_rows - - Retourne le nombre de lignes affectées par une requête SQL - - - - &reftitle.description; - - intfalsedb2_num_rows - resourcestmt - - - - Retourne le nombre de lignes supprimées, ajoutées, mises à jour par une - requête SQL. - - - Afin de déterminer le nombre de lignes que retournera une requête SELECT, - il faut exécuter la requête SELECT COUNT(*) avec les mêmes prédicats que - la requête SELECT prévue et récupérer la valeur. - - - Si la logique de l'application vérifie le nombre de lignes retournées par - une requête SELECT et effectue un branchement si le nombre de lignes est 0, - il est recommandé de modifier l'application pour tenter de retourner la première ligne avec - db2_fetch_assoc, db2_fetch_both, - db2_fetch_array ou db2_fetch_row, - et d'effectuer le branchement si la fonction retourne &false;. - - - - - Lors de l'envoi d'une requête SELECT avec un curseur flottant, - db2_num_rows retourne le nombre de lignes retournées - par la requête SELECT. Cependant, le temps système associé aux - curseurs flottants dégrade considérablement les performances de - l'application, ainsi, si cela est la seule raison pour laquelle l'on envisage d'utiliser - des curseurs flottants, il est recommandé d'utiliser un curseur à avancement - seul et soit d'appeler SELECT COUNT(*), soit de s'appuyer sur la valeur - de retour de type bool des fonctions de récupération pour obtenir - une fonctionnalité équivalente avec des performances bien meilleures. - - - - - - &reftitle.parameters; - - - stmt - - - Une ressource stmt valide contenant le jeu de - résultats. - - - - - - - &reftitle.returnvalues; - - Retourne le nombre de lignes affectées par la dernière requête SQL envoyée - par une fonction qui exécute les requêtes SQL, &return.falseforfailure; - - - - - diff --git a/reference/ibm_db2/functions/db2-pclose.xml b/reference/ibm_db2/functions/db2-pclose.xml deleted file mode 100755 index 32743aa463..0000000000 --- a/reference/ibm_db2/functions/db2-pclose.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - db2_pclose - Ferme une connexion persistante à la base de données - - - - &reftitle.description; - - booldb2_pclose - resourceconnection - - - Cette fonction ferme une connexion client DB2, créée avec - db2_pconnect, et rend les ressources correspondantes - au serveur de base de données. - - - Cette fonction n'est disponible que sur i5/OS en réponse à des requêtes - d'administration i5/OS. - - - - - Si l'on a une connexion client DB2 persistante créée avec la fonction - db2_pconnect, il est possible d'utiliser cette fonction pour - fermer la connexion. Pour éviter des coûts de performance significatifs liés à la connexion, - cette fonction ne devrait être utilisée que dans de rares cas, lorsque la connexion persistante - ne répond plus ou qu'elle ne sera plus nécessaire pendant une longue période. - - - - - &reftitle.parameters; - - - connection - - - Spécifie une connexion client DB2 active. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Fermer une connexion DB2 persistante - - L'exemple ci-dessous montre comment fermer une connexion - sur un serveur IBM DB2 i5/OS. - - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_close - db2_pconnect - - - - - diff --git a/reference/ibm_db2/functions/db2-pconnect.xml b/reference/ibm_db2/functions/db2-pconnect.xml deleted file mode 100644 index 4ed097da69..0000000000 --- a/reference/ibm_db2/functions/db2-pconnect.xml +++ /dev/null @@ -1,705 +0,0 @@ - - - - - - db2_pconnect - - Retourne une connexion persistante à une base de données - - - - &reftitle.description; - - resourcefalsedb2_pconnect - stringdatabase - stringnullusername - stringnullpassword - arrayoptions[] - - - - Retourne une connexion persistante à une base de données IBM DB2 - Universal Database, IBM Cloudscape ou Apache Derby. - - - - Pour plus d'informations sur les connexions persistantes, voir - . - - - - Appeler db2_close sur une connexion persistante - retourne toujours &true;, mais la connexion sous-jacente du client DB2 - demeure ouverte et attend de servir la prochaine requête correspondante - de la fonction db2_pconnect. - - - - Les utilisateurs de versions 1.9.0 ou plus d'ibm_db2 doivent savoir que l'extension - exécutera un rollback sur une transaction dans une connexion persistante à la fin - de la requête, terminant ainsi la transaction. Ceci évite un blocage transactionnel - vers la requête suivante sur la même connexion si l'exécution du script se termine - avant la transaction. - - - - - &reftitle.parameters; - - - database - - - Pour une connexion cataloguée à une base de données, database - représente l'alias de la base de données dans le catalogue du client DB2. - - - Pour une connexion non cataloguée à une base de données, - database représente une chaîne de connexion complète - au format suivant : - DATABASE=database;HOSTNAME=hostname;PORT=port;PROTOCOL=TCPIP;UID=username;PWD=password; - - - Lors de la connexion à Db2 sur IBM i, les appels système sous-jacents - SQLDriverConnect, - n'acceptent que DSN, UID et PWD pour la - chaîne de connexion. - Comme suit : - DSN=database;UID=username;PWD=password; - - - où les paramètres représentent les valeurs suivantes : - - - database - - - Le nom de la base de données. - - - - - hostname - - - Le nom d'hôte ou l'adresse IP du serveur de la base de données. - - - - - port - - - Le port TCP/IP sur lequel la base de données écoute - les requêtes. - - - - - username - - - Le nom d'utilisateur utilisé pour la connexion à la - base de données. - - - - - password - - - Le mot de passe utilisé pour la connexion à la base de données. - - - - - - - - - username - - - Le nom d'utilisateur utilisé pour la connexion à la base de - données. - - - - - password - - - Le mot de passe utilisé pour la connexion à la base de données. - - - - - options - - - Un tableau associatif des options de connexion qui affecteront le - comportement de la connexion, où les valeurs des clés incluent : - - - autocommit - - - La valeur DB2_AUTOCOMMIT_ON active l'autocommit - sur cette connexion. - - - La valeur DB2_AUTOCOMMIT_OFF désactive - l'autocommit pour cette connexion. - - - - - DB2_ATTR_CASE - - - Passer la valeur DB2_CASE_NATURAL spécifie que les - noms de colonnes seront retournés dans leurs casses naturelles. - - - Passer la valeur DB2_CASE_LOWER spécifie que les - noms de colonnes seront retournés en minuscule. - - - Passer la valeur DB2_CASE_UPPER spécifie que les - noms de colonnes seront retournés en majuscule. - - - - - CURSOR - - - Passer la valeur DB2_FORWARD_ONLY spécifie un curseur - uniquement suivant pour une ressource de requête. C'est le type de curseur - par défaut et est supporté sur tous les serveurs de base de données. - - - Passer la valeur DB2_SCROLLABLE spécifie un - curseur scrollable pour une ressource de requête. Ce mode permet - un accès aléatoire aux lignes dans un jeu de résultats, mais actuellement, - n'est supporté que par la base de données IBM DB2 Universal. - - - - - - - Les options suivantes sont disponibles à partir d'ibm_db2 version 1.7.0. - - - trustedcontext - - - En passant la valeur DB2_TRUSTED_CONTEXT_ENABLE, le contexte de confiance - est activé pour cette connexion. Ce paramètre ne peut pas être activé - avec db2_set_option. - - - Cette option ne fonctionne que si la base est cataloguée, même si la base - est locale, ou si l'on spécifie un DSN complet lors de la création de la - connexion. - - - Pour cataloguer la base, utiliser la commande suivante : - - db2 catalog tcpip node loopback remote <SERVERNAME> server <SERVICENAME> -db2 catalog database <LOCALDBNAME> as <REMOTEDBNAME> at node loopback -db2 "update dbm cfg using svcename <SERVICENAME>" -db2set DB2COMM=TCPIP - - - - - - - Les options i5/OS suivantes sont disponibles à partir d'ibm_db2 version 1.5.1. - - - Des attributs de connexion contradictoires, en conjonction avec des - connexions persistantes, peuvent produire des résultats indéterminés sur i5/OS. - La politique du site doit être établie pour toutes les applications - utilisant chaque profil utilisateur de connexion persistante. La valeur - par défaut DB2_AUTOCOMMIT_ON est recommandée avec les connexions persistantes. - - - - - i5_lib - - - Une valeur de type caractère qui indique la bibliothèque par défaut qui sera - utilisée pour résoudre les références de fichiers non qualifiées. - Cette option n'est pas valide si la connexion utilise le mode - de nommage système. - - - - - i5_naming - - - DB2_I5_NAMING_ON active le mode de nommage système - de DB2 UDB CLI iSeries. Les fichiers sont alors qualifiés avec le délimiteur - slash (/). Les fichiers non qualifiés sont résolus en utilisant la liste - de bibliothèque de la tâche. - - - DB2_I5_NAMING_OFF active le mode de nommage par défaut, - qui est le nommage SQL. Les fichiers sont alors qualifiés avec le point (.) . - Les fichiers non qualifiés sont résolus avec la bibliothèque par défaut, - ou bien l'identifiant de l'utilisateur courant. - - - - - i5_commit - - - L'attribut i5_commit doit être configuré avant - l'appel à db2_pconnect. Si la valeur est changée - après la connexion, et que la connexion s'effectue sur des données distantes, - alors ce changement n'aura pas d'effets, jusqu'au prochain appel réussi - à db2_pconnect. - - - La directive du &php.ini; ibm_db2.i5_allow_commit==0 - ou DB2_I5_TXN_NO_COMMIT est la valeur par défaut, mais peut - être remplacée par l'option i5_commit. - - - - - DB2_I5_TXN_NO_COMMIT : le contrôle de validation n'est pas utilisé. - - - DB2_I5_TXN_READ_UNCOMMITTED : les lectures incohérentes, - ou non répétables et les fantômes sont possibles. - - - DB2_I5_TXN_READ_COMMITTED : les lectures incohérentes - ne sont pas possibles. Les lectures non répétables et les fantômes - sont possibles. - - - DB2_I5_TXN_REPEATABLE_READ : les lectures incohérentes - et les lectures non répétables ne sont pas possibles. Les fantômes - sont possibles. - - - DB2_I5_TXN_SERIALIZABLE : les transactions sont sérialisables. - Les lectures incohérentes, les lectures non répétables et les fantômes - ne sont pas possibles. - - - - - i5_query_optimize - - - DB2_FIRST_IO : toutes les requêtes sont optimisées - dans le but de retourner la première page le plus rapidement possible. - Cet objectif fonctionne bien lorsque le résultat est contrôlé par un - utilisateur qui a de bonnes chances d'annuler la requête après avoir vu - les premières réponses. Les requêtes codées avec une clause - OPTIMIZE FOR nnn ROWS respectent aussi cet objectif. - - - DB2_ALL_IO : toutes les requêtes sont optimisées - dans le but de traiter la requête complète le plus rapidement possible. - C'est une bonne option lorsque le résultat de la requête doit être - écrit dans un fichier ou un rapport, ou que l'interface accumule - toutes les données de sortie. Les requêtes codées avec la clause - OPTIMIZE FOR nnn ROWS respectent aussi cet objectif. - C'est le comportement par défaut. - - - - - i5_dbcs_alloc - - - DB2_I5_DBCS_ALLOC_ON active le schéma d'allocation - DB2 6X pour la croissance des tailles de colonnes de translation DBCS. - - - DB2_I5_DBCS_ALLOC_OFF désactive le schéma d'allocation - DB2 6X pour la croissance des tailles de colonnes de translation DBCS. - - - La directive du &php.ini; ibm_db2.i5_dbcs_alloc==0 - ou DB2_I5_DBCS_ALLOC_OFF est la valeur par défaut, mais peut - être remplacée par l'option i5_dbcs_alloc. - - - - - - - i5_date_fmt - - - DB2_I5_FMT_ISO : le format de date ISO - (International Organization for Standardization) est - utilisé : yyyy-mm-dd. C'est le format par défaut. - - - DB2_I5_FMT_USA : le format des États-Unis d'Amérique - est utilisé : mm/dd/yyyy. - - - DB2_I5_FMT_EUR : le format de date européen - dd.mm.yyyy est utilisé. - - - DB2_I5_FMT_JIS : le format standard industriel japonais - yyyy-mm-dd est utilisé. - - - DB2_I5_FMT_MDY : le format de date - mm/dd/yyyy est utilisé. - - - DB2_I5_FMT_DMY : le format de date - dd/mm/yyyy est utilisé. - - - DB2_I5_FMT_YMD : le format de date - yy/mm/dd est utilisé. - - - DB2_I5_FMT_JUL : le format de date julien - yy/ddd est utilisé. - - - DB2_I5_FMT_JOB : le format de date par défaut est utilisé. - - - - - i5_date_sep - - - DB2_I5_SEP_SLASH : un slash ( / ) est utilisé comme séparateur de date. - C'est le format par défaut. - - - DB2_I5_SEP_DASH : un tiret ( - ) est utilisé comme séparateur de date. - - - DB2_I5_SEP_PERIOD : un point ( . ) est utilisé comme séparateur de date. - - - DB2_I5_SEP_COMMA : une virgule ( , ) est utilisée comme séparateur de date. - - - DB2_I5_SEP_BLANK : un espace est utilisé comme séparateur de date. - - - DB2_I5_SEP_JOB : la configuration par défaut est utilisée. - - - - - i5_time_fmt - - - DB2_I5_FMT_ISO : le format d'heure ISO - (International Organization for Standardization) est - utilisé : hh.mm.ss. C'est le format par défaut. - - - DB2_I5_FMT_USA : le format des États-Unis d'Amérique - est utilisé : hh:mmxx est utilisé, où xx - vaut AM ou PM. - - - DB2_I5_FMT_EUR : le format d'heure européen - hh.mm.ss est utilisé. - - - DB2_I5_FMT_JIS : le format standard industriel japonais - est utilisé hh:mm:ss. - - - DB2_I5_FMT_HMS : le format hh:mm:ss - est utilisé. - - - - - i5_time_sep - - - DB2_I5_SEP_COLON : un deux-points ( : ) est utilisé comme - séparateur d'heure. C'est la valeur par défaut. - - - DB2_I5_SEP_PERIOD : un point ( . ) est utilisé comme - séparateur d'heure. - - - DB2_I5_SEP_COMMA : une virgule ( , ) est utilisée comme - séparateur d'heure. - - - DB2_I5_SEP_BLANK : un espace est utilisé comme - séparateur d'heure. - - - DB2_I5_SEP_JOB : le séparateur par défaut est utilisé. - - - - - i5_decimal_sep - - - DB2_I5_SEP_PERIOD : un point ( . ) est utilisé comme - séparateur décimal. C'est le séparateur par défaut. - - - DB2_I5_SEP_COMMA : une virgule ( , ) est utilisée comme - séparateur décimal. - - - DB2_I5_SEP_JOB : le séparateur par défaut est utilisé. - - - - - - - L'option i5/OS suivante est disponible à partir d'ibm_db2 version 1.8.0. - - - i5_libl - - - Une valeur de type caractère qui indique la liste de bibliothèques - qui sera utilisée pour résoudre les références de fichiers non - qualifiées. Spécifier la liste de bibliothèques sous la forme - d'éléments séparés par des espaces : - 'i5_libl'=>"MYLIB YOURLIB ANYLIB". - - - i5_libl appelle qsys2/qcmdexc('cmd',cmdlen), qui - n'est disponible qu'à partir d'i5/OS V5R4. - - - - - - - - - - - - - &reftitle.returnvalues; - - Retourne la ressource de connexion si la tentative de connexion réussit. - db2_pconnect essaie de réutiliser une ressource de - connexion existante qui correspond parfaitement aux paramètres tels que la base de données - database, l'utilisateur username - et le mot de passe password. Si la tentative de - connexion échoue, db2_pconnect retourne &false; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL ibm_db2 1.9.0 - - Les transactions actives sur des connexions persistantes seront annulées à - la fin de chaque requête. - - - - PECL ibm_db2 1.8.0 - - L'option i5_libl est disponible pour les utilisateurs - d'i5/OS. - - - - PECL ibm_db2 1.7.0 - - L'option trustedcontext est disponible. - - - - PECL ibm_db2 1.5.1 - - Les options i5_lib, i5_naming, - i5_commit, - i5_query_optimize, - i5_dbcs_alloc, - i5_date_fmt, - i5_date_sep, - i5_time_fmt, i5_time_sep - et i5_decimal_sep sont disponibles pour les utilisateurs - d'i5/OS. - - - - - - - - - &reftitle.examples; - - - Exemple d'utilisation de <function>db2_pconnect</function> - - Dans l'exemple suivant, le premier appel à - db2_pconnect retourne une nouvelle ressource de - connexion persistante. Le second appel à la fonction - db2_pconnect retourne une ressource de connexion - persistante qui réutilise la première ressource de connexion. - - - -]]> - - &example.outputs; - - - - - - Utilisation de contextes de confiance DB2 - - L'exemple suivant montre comment activer le contexte de confiance, - changer d'utilisateur et obtenir l'identifiant de l'utilisateur courant. - - - DB2_TRUSTED_CONTEXT_ENABLE); - -$tc_conn = db2_pconnect($dsn, "", "", $options); -if($tc_conn) { - echo "Connexion de confiance réussie.\n"; - - if(db2_get_option($tc_conn, "trustedcontext")) { - $userBefore = db2_get_option($tc_conn, "trusted_user"); - - //Travail par l'utilisateur 1. - - //Bascule sur l'utilisateur de confiance. - $parameters = array("trusted_user" => $tc_user, - "trusted_password" => $tcuser_pass); - $res = db2_set_option ($tc_conn, $parameters, 1); - - $userAfter = db2_get_option($tc_conn, "trusted_user"); - //Travail supplémentaire en tant qu'utilisateur de confiance. - - if($userBefore != $userAfter) { - echo "Utilisateur changé." . "\n"; - } - } - - db2_close($tc_conn); -} -else { - echo "Connexion de confiance échouée.\n"; -} -?> - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_connect - - - - - - diff --git a/reference/ibm_db2/functions/db2-prepare.xml b/reference/ibm_db2/functions/db2-prepare.xml deleted file mode 100644 index 6a88930516..0000000000 --- a/reference/ibm_db2/functions/db2-prepare.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - db2_prepare - - Prépare une requête SQL à être exécutée - - - - &reftitle.description; - - resourcefalsedb2_prepare - resourceconnection - stringstatement - arrayoptions[] - - - - db2_prepare crée une requête SQL préparée qui peut - inclure aucun ou plusieurs marqueurs (caractères ?) - représentant les paramètres d'entrée, sortie ou d'entrée/sortie. Il - est possible de passer des paramètres à la requête préparée en utilisant la - fonction db2_bind_param, s'il n'y a que des entrées, - il est possible d'utiliser db2_execute. - - - Il y a trois principaux avantages d'utiliser les requêtes préparées dans - l'application : - - - - Performance : lors de la préparation d'une requête, le - serveur de base de données crée un plan d'accès optimisé pour la - récupération des données avec la requête. Par la suite, l'envoi de la - requête préparée avec db2_execute permet à la - requête de réutiliser le plan d'accès et ainsi d'éviter les surcharges - du processeur à chaque envoi de requête qui créerait dynamiquement un - nouveau plan d'accès. - - - - - Sécurité : lors de la préparation d'une requête, l'on - peut inclure des marqueurs pour les valeurs d'entrées. Lors de - l'exécution d'une requête préparée avec ces valeurs d'entrées, le serveur de - base de données vérifie chaque valeur d'entrée pour s'assurer que les - types concordent avec la définition de la colonne ou du paramètre de - définition. - - - - - Fonctionnalité avancée : Les marqueurs permettent - non seulement de passer des valeurs d'entrées dans les requêtes SQL - préparées, mais permettent aussi de récupérer des paramètres de SORTIE et - d'ENTRÉE/SORTIE des procédures stockées en utilisant la fonction - db2_bind_param. - - - - - - - - &reftitle.parameters; - - - connection - - - Une variable ressource de connexion valide retournée par - db2_connect ou db2_pconnect. - - - - - statement - - - Une requête SQL qui peut contenir un ou plusieurs marqueurs. - - - - - options - - - Un tableau associatif contenant les options de la requête. Il est possible - d'utiliser ce paramètre pour demander un curseur flottant sur les - serveurs de base de données qui supportent cette fonctionnalité. - - - Pour une description des options valides, se reporter à la fonction - db2_set_option. - - - - - - - &reftitle.returnvalues; - - Retourne une ressource d'instruction si la requête SQL a été analysée et - préparée avec succès par le serveur de base de données. Retourne &false; - si le serveur de base de données a retourné une erreur. Il est possible de - déterminer quelle erreur a été retournée en appelant la fonction - db2_stmt_error ou db2_stmt_errormsg. - - - - - &reftitle.examples; - - Préparation et exécution d'une requête SQL avec des marqueurs - - L'exemple suivant prépare une requête INSERT qui accepte quatre - marqueurs, ensuite itère sur le tableau contenant les valeurs d'entrées - qui sera passé à la fonction db2_execute. - - - -]]> - - - - - - &reftitle.seealso; - - db2_bind_param - db2_execute - db2_stmt_error - db2_stmt_errormsg - - - - diff --git a/reference/ibm_db2/functions/db2-primary-keys.xml b/reference/ibm_db2/functions/db2-primary-keys.xml deleted file mode 100644 index c04f6b4fca..0000000000 --- a/reference/ibm_db2/functions/db2-primary-keys.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - db2_primary_keys - - Retourne un jeu de résultats listant les clés primaires d'une table - - - - &reftitle.description; - - resourcedb2_primary_keys - resourceconnection - stringnullqualifier - stringnullschema - stringtable_name - - - - Retourne un jeu de résultats listant les clés primaires d'une table. - - - - - &reftitle.parameters; - - - connection - - - Une connexion valide à une base de données IBM DB2, Cloudscape ou - Apache Derby. - - - - - qualifier - - - Un qualificatif pour les bases de données DB2 qui fonctionnent sur - les serveurs OS/390 ou z/OS. Pour les autres bases de données, passez - &null; ou une chaîne vide. - - - - - schema - - - Le schéma qui contient les tables. Si schema est - &null;, db2_primary_keys fait concorder le schéma - pour la connexion courante. - - - - - table_name - - - Le nom de la table. - - - - - - - &reftitle.returnvalues; - - Retourne une ressource d'instruction avec un jeu de résultats contenant des - lignes décrivant les clés primaires pour la table spécifiée. Le jeu de - résultats est composé des colonnes suivantes : - - - - - Nom de la colonne - Description - - - - - TABLE_CAT - Nom du catalogue de la table contenant la clé primaire. La - valeur est &null; si la table n'a pas de catalogue. - - - TABLE_SCHEM - Nom du schéma de la table contenant la clé primaire. - - - TABLE_NAME - Nom de la table contenant la clé primaire. - - - COLUMN_NAME - Nom de la colonne contenant la clé primaire. - - - KEY_SEQ - Position commençant à 1 de la colonne dans la clé. - - - PK_NAME - Nom de la clé primaire. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-procedure-columns.xml b/reference/ibm_db2/functions/db2-procedure-columns.xml deleted file mode 100644 index 0c7489f4b8..0000000000 --- a/reference/ibm_db2/functions/db2-procedure-columns.xml +++ /dev/null @@ -1,259 +0,0 @@ - - - - - - - db2_procedure_columns - - Retourne un jeu de résultats listant les paramètres de procédure stockée - - - - &reftitle.description; - - resourcedb2_procedure_columns - resourceconnection - stringnullqualifier - stringschema - stringprocedure - stringnullparameter - - - - Retourne un jeu de résultats listant les paramètres pour une ou plusieurs - procédures stockées. - - - - - &reftitle.parameters; - - - connection - - - Une connexion valide à une base de données IBM DB2, Cloudscape ou - Apache Derby. - - - - - qualifier - - - Un qualificatif pour les bases de données DB2 qui fonctionnent sur - les serveurs OS/390 ou z/OS. Pour les autres bases de données, - passez &null; ou une chaîne vide. - - - - - schema - - - Le schéma qui contient les procédures. Ce paramètre accepte un motif - de recherche contenant _ et % - en tant que caractères génériques. - - - - - procedure - - - Le nom de la procédure. Ce paramètre accepte un motif de recherche - contenant _ et % en tant que - caractères génériques. - - - - - parameter - - - Le nom du paramètre. Ce paramètre accepte un motif de recherche - contenant _ et % en tant que - caractères génériques. Si ce paramètre est &null;, tous les paramètres - pour les procédures stockées spécifiées sont retournés. - - - - - - - &reftitle.returnvalues; - - Retourne une ressource d'instruction avec un jeu de résultats contenant - les lignes qui décrivent les paramètres pour les procédures stockées qui - correspondent aux paramètres spécifiés. Les lignes sont composées des - colonnes suivantes : - - - - - Nom de la colonne - Description - - - - - PROCEDURE_CAT - Le catalogue qui contient la procédure. - La valeur est &null; si cette table n'a pas de catalogue. - - - PROCEDURE_SCHEM - Nom du schéma qui contient la procédure stockée. - - - PROCEDURE_NAME - Nom de la procédure. - - - COLUMN_NAME - Nom du paramètre. - - - COLUMN_TYPE - - - Un entier représentant le type du paramètre : - - - - - Valeur de retour - Type de paramètre - - - - - 1 (SQL_PARAM_INPUT) - Paramètre d'entrée (IN). - - - 2 (SQL_PARAM_INPUT_OUTPUT) - Paramètre d'entrée/sortie (INOUT). - - - 3 (SQL_PARAM_OUTPUT) - Paramètre de sortie (OUT). - - - - - - - - - DATA_TYPE - Le type de données SQL pour le paramètre représenté en tant - qu'entier. - - - TYPE_NAME - Une chaîne représentant le type de données pour le paramètre. - - - COLUMN_SIZE - Un entier représentant la taille du paramètre. - - - BUFFER_LENGTH - Nombre maximal d'octets nécessaires pour stocker les - données de ce paramètre. - - - DECIMAL_DIGITS - L'échelle du paramètre, ou &null; lorsque l'échelle n'est pas - applicable. - - - NUM_PREC_RADIX - Un entier pouvant être 10 (représentant un - type de données numérique exact), 2 (représentant un - type de données numérique approché) ou &null; (représentant un type - de données pour lequel la base n'est pas applicable). - - - NULLABLE - Un entier indiquant si le paramètre peut être nul ou non. - - - REMARKS - Description du paramètre. - - - COLUMN_DEF - Valeur par défaut du paramètre. - - - SQL_DATA_TYPE - Un entier représentant la taille du paramètre. - - - SQL_DATETIME_SUB - Retourne un entier représentant un code de sous-type - datetime, ou &null; pour les types de données SQL - auxquels cela ne s'applique pas. - - - CHAR_OCTET_LENGTH - Longueur maximale en octets pour un paramètre de type de - données caractère, qui correspond à COLUMN_SIZE pour les données - d'un jeu de caractères mono-octet, ou &null; pour les types de - données non caractères. - - - ORDINAL_POSITION - La position du paramètre, indexée à partir de 1, dans - l'instruction CALL. - - - IS_NULLABLE - Une valeur de chaîne où 'YES' signifie que le paramètre - accepte ou retourne des valeurs &null;, et 'NO' signifie que le - paramètre n'accepte ou ne retourne pas de valeurs &null;. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-procedures.xml b/reference/ibm_db2/functions/db2-procedures.xml deleted file mode 100644 index 375430d5b1..0000000000 --- a/reference/ibm_db2/functions/db2-procedures.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - db2_procedures - - Retourne un jeu de résultats listant les procédures stockées - enregistrées dans une base de données - - - - &reftitle.description; - - resourcedb2_procedures - resourceconnection - stringnullqualifier - stringschema - stringprocedure - - - - Retourne un jeu de résultats listant les procédures stockées - enregistrées dans une base de données. - - - - - &reftitle.parameters; - - - connection - - - Une connexion valide à une base de données IBM DB2, Cloudscape ou - Apache Derby. - - - - - qualifier - - - Un qualificatif pour les bases de données DB2 qui fonctionnent sur - les serveurs OS/390 ou z/OS. Pour les autres bases de données, - il faut passer &null; ou une chaîne vide. - - - - - schema - - - Le schéma qui contient les procédures. Ce paramètre accepte un motif - de recherche contenant _ et % - comme caractères génériques. - - - - - procedure - - - Le nom de la procédure. Ce paramètre accepte un motif de recherche - contenant _ et % comme - caractères génériques. - - - - - - - &reftitle.returnvalues; - - Retourne une ressource d'instruction avec un jeu de résultats contenant - les lignes qui décrivent les procédures stockées qui correspondent aux - paramètres spécifiés. Les lignes sont composées des colonnes suivantes : - - - - - Nom de la colonne - Description - - - - - PROCEDURE_CAT - Le catalogue qui contient la procédure. - La valeur est &null; si la table n'a pas de catalogue. - - - PROCEDURE_SCHEM - Nom du schéma qui contient la procédure stockée. - - - PROCEDURE_NAME - Nom de la procédure. - - - NUM_INPUT_PARAMS - Nombre de paramètres d'entrée (IN) pour la procédure stockée. - - - NUM_OUTPUT_PARAMS - Nombre de paramètres de sortie (OUT) pour la procédure stockée. - - - NUM_RESULT_SETS - Nombre de jeux de résultats retournés par la procédure stockée. - - - REMARKS - Commentaires concernant la procédure stockée. - - - PROCEDURE_TYPE - Retourne toujours 1, indiquant que la - procédure stockée ne retourne aucune valeur de retour. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-result.xml b/reference/ibm_db2/functions/db2-result.xml deleted file mode 100644 index 7afbd2c3bc..0000000000 --- a/reference/ibm_db2/functions/db2-result.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - db2_result - - Retourne une colonne d'une ligne d'un jeu de résultats - - - - &reftitle.description; - - mixednulldb2_result - resourcestmt - intstringcolumn - - - - Utiliser db2_result pour retourner une valeur d'une - colonne spécifique dans la ligne courante d'un jeu de résultats. Il faut - appeler db2_fetch_row avant d'appeler - db2_result pour enregistrer les valeurs pointées du - jeu de résultats. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource stmt valide. - - - - - column - - - Soit un entier correspondant au champ commençant à l'indice 0 dans le - jeu de résultats, soit une chaîne représentant le nom de la colonne. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur du champ demandé si le champ existe dans le jeu de - résultats. Retourne &null; si le champ n'existe pas, et émet une - alerte. - - - - - &reftitle.examples; - - Exemple d'utilisation de <function>db2_result</function> - - L'exemple suivant démontre comment itérer à travers un jeu de résultats - avec la fonction db2_fetch_row et récupérer les - colonnes du jeu de résultats avec db2_result. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_assoc - db2_fetch_both - db2_fetch_object - db2_fetch_row - - - - diff --git a/reference/ibm_db2/functions/db2-rollback.xml b/reference/ibm_db2/functions/db2-rollback.xml deleted file mode 100644 index fe395bf517..0000000000 --- a/reference/ibm_db2/functions/db2-rollback.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - db2_rollback - - Annule une transaction - - - - &reftitle.description; - - booldb2_rollback - resourceconnection - - - - Annule une transaction en cours sur la ressource de connexion spécifiée et - commence une nouvelle transaction. Les applications PHP utilisent normalement - le mode AUTOCOMMIT par défaut, donc db2_rollback - n'a normalement aucun effet tant que AUTOCOMMIT n'a pas été désactivé pour - la ressource de connexion. - - - - - &reftitle.parameters; - - - connection - - - Une variable ressource de connexion à la base de données valide retournée par - db2_connect ou db2_pconnect. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Annulation d'une instruction DELETE - - Dans l'exemple suivant, le nombre de lignes dans une table est compté, - le mode AUTOCOMMIT est désactivé sur une connexion de base de données, - toutes les lignes de la table sont supprimées et le compteur retourne - 0 pour prouver que les lignes ont bien été supprimées. - Ensuite, db2_rollback est invoquée, et le nombre - de lignes mis à jour dans la table est retourné pour montrer que le nombre - est le même qu'avant l'exécution de l'instruction DELETE. Le retour à - l'état original de la table démontre que l'annulation de la transaction - a réussi. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_autocommit - db2_commit - - - - diff --git a/reference/ibm_db2/functions/db2-server-info.xml b/reference/ibm_db2/functions/db2-server-info.xml deleted file mode 100644 index 53ed87f983..0000000000 --- a/reference/ibm_db2/functions/db2-server-info.xml +++ /dev/null @@ -1,394 +0,0 @@ - - - - - - - db2_server_info - Retourne un objet avec des propriétés qui décrivent le serveur de base de données DB2 - - - &reftitle.description; - - stdClassfalsedb2_server_info - resourceconnection - - - - Cette fonction retourne un objet avec des propriétés en lecture seule qui - retournent des informations à propos du serveur de base de données IBM DB2, - Cloudscape ou Apache Derby. La table suivante liste les propriétés du - serveur de base de données : - - Propriétés serveur de base de données - - - - Nom de la propriété - Type de retour - Description - - - - - DBMS_NAME - &string; - Le nom du serveur de base de données sur lequel l'on est - connecté. Pour des serveurs DB2, c'est une combinaison de - DB2 suivi par le système d'exploitation sur lequel - le serveur de base de données fonctionne. - - - DBMS_VER - &string; - La version du serveur de la base de données, dans la forme d'une - &string; "MM.mm.uuuu" où MM est la version majeure, - mm est la version mineure et uuuu - est la mise à jour. Par exemple, "08.02.0001" représente la version - majeure 8, la version mineure 2, la mise à jour 1. - - - - DB_CODEPAGE - &integer; - Le code page de la base de données sur laquelle l'on est - connecté. - - - DB_NAME - &string; - Le nom de la base de données sur laquelle l'on est connecté. - - - DFT_ISOLATION - &string; - - Le niveau par défaut d'isolation de transaction supporté par le - serveur : - - - UR - - - Lecture non validée (Uncommitted read) : les changements sont - immédiatement visibles par toutes les transactions concurrentes. - - - - - CS - - - Stabilité du curseur (Cursor stability) : une ligne lue par une - transaction peut être modifiée et validée par une seconde - transaction concurrente. - - - - - RS - - - Stabilité de lecture (Read stability) : une transaction peut - ajouter ou supprimer des lignes qui correspondent à une condition - de recherche ou à une transaction en attente. - - - - - RR - - - Lecture répétée (Repeatable read) : les données affectées par les - transactions en attente ne sont pas disponibles aux autres - transactions. - - - - - NC - - - Aucune validation (No commit) : tout changement est visible à la fin - d'une opération réussie. Les validations explicites et retours - arrières ne sont pas autorisés. - - - - - - - - - IDENTIFIER_QUOTE_CHAR - &string; - Le caractère utilisé pour délimiter un identifiant. - - - INST_NAME - &string; - L'instance sur le serveur de base de données qui contient la - base de données. - - - ISOLATION_OPTION - &array; - Un tableau des options d'isolation supportées par le serveur de - base de données. Les options d'isolation sont décrites dans la - propriété DFT_ISOLATION. - - - KEYWORDS - &array; - Un tableau des mots-clés réservés par le serveur de base de - données. - - - LIKE_ESCAPE_CLAUSE - &boolean; - &true; si le serveur de base de données supporte l'utilisation - des caractères de remplacement % et - _. &false; si le serveur de base de données ne - supporte pas ces caractères de remplacement. - - - MAX_COL_NAME_LEN - &integer; - Taille maximale d'un nom de colonne supportée par le serveur de - base de données, exprimée en octets. - - - MAX_IDENTIFIER_LEN - &integer; - Taille maximale d'un identifiant SQL supportée par les serveurs - de base de données, exprimée en caractères. - - - MAX_INDEX_SIZE - &integer; - Taille maximale des colonnes combinées dans un index supportée - par le serveur de base de données, exprimée en octets. - - - MAX_PROC_NAME_LEN - &integer; - Taille maximale d'un nom de procédure supportée par le serveur de - base de données, exprimée en octets. - - - MAX_ROW_SIZE - &integer; - Taille maximale d'une ligne dans la table de base supportée par - le serveur de base de données, exprimée en octets. - - - MAX_SCHEMA_NAME_LEN - &integer; - Taille maximale d'un nom de schéma supportée par le serveur de - base de données, exprimée en octets. - - - MAX_STATEMENT_LEN - &integer; - Taille maximale d'une requête SQL supportée par le serveur de - base de données, exprimée en octets. - - - MAX_TABLE_NAME_LEN - &integer; - Taille maximale d'un nom de table supportée par le serveur de - base de données, exprimée en octets. - - - NON_NULLABLE_COLUMNS - &boolean; - &true; si le serveur de base de données supporte les colonnes - qui peuvent être définies comme NOT NULL, &false; si le serveur de base - de données ne supporte pas les colonnes définies comme NOT - NULL. - - - PROCEDURES - &boolean; - &true; si le serveur de base de données supporte l'utilisation - de la requête CALL pour appeler les procédures stockées, &false; si - le serveur de base de données ne supporte pas la requête CALL. - - - SPECIAL_CHARS - &string; - Une &string; contenant tous les caractères autres que les lettres - (majuscules et minuscules), les chiffres et le caractère souligné - qui peuvent être utilisés en tant que nom d'identifiant. - - - SQL_CONFORMANCE - &string; - - Le niveau de conformité à la spécification ANSI/ISO SQL-92 - offert par le serveur de base de données : - - - ENTRY - - - Niveau d'entrée de conformité SQL-92. - - - - - FIPS127 - - - Conformité transitoire FIPS-127-2. - - - - - FULL - - - Niveau complet de conformité SQL-92. - - - - - INTERMEDIATE - - - Niveau intermédiaire de conformité SQL-92. - - - - - - - - - -
- - - - - &reftitle.parameters; - - - connection - - - Spécifie la connexion cliente DB2 active. - - - - - - - &reftitle.returnvalues; - - Retourne un objet si l'appel est réussi, &return.falseforfailure; - - - - - &reftitle.examples; - - Exemple avec <function>db2_server_info</function> - - Pour récupérer des informations à propos du serveur, il faut passer - une ressource de connexion de base de données valide à la fonction - db2_server_info. - - DBMS_NAME ); - echo "DBMS_VER: "; var_dump( $server->DBMS_VER ); - echo "DB_CODEPAGE: "; var_dump( $server->DB_CODEPAGE ); - echo "DB_NAME: "; var_dump( $server->DB_NAME ); - echo "INST_NAME: "; var_dump( $server->INST_NAME ); - echo "SPECIAL_CHARS: "; var_dump( $server->SPECIAL_CHARS ); - echo "KEYWORDS: "; var_dump( sizeof($server->KEYWORDS) ); - echo "DFT_ISOLATION: "; var_dump( $server->DFT_ISOLATION ); - echo "ISOLATION_OPTION: "; - $il = ''; - foreach( $server->ISOLATION_OPTION as $opt ) - { - $il .= $opt." "; - } - var_dump( $il ); - echo "SQL_CONFORMANCE: "; var_dump( $server->SQL_CONFORMANCE ); - echo "PROCEDURES: "; var_dump( $server->PROCEDURES ); - echo "IDENTIFIER_QUOTE_CHAR: "; var_dump( $server->IDENTIFIER_QUOTE_CHAR ); - echo "LIKE_ESCAPE_CLAUSE: "; var_dump( $server->LIKE_ESCAPE_CLAUSE ); - echo "MAX_COL_NAME_LEN: "; var_dump( $server->MAX_COL_NAME_LEN ); - echo "MAX_ROW_SIZE: "; var_dump( $server->MAX_ROW_SIZE ); - echo "MAX_IDENTIFIER_LEN: "; var_dump( $server->MAX_IDENTIFIER_LEN ); - echo "MAX_INDEX_SIZE: "; var_dump( $server->MAX_INDEX_SIZE ); - echo "MAX_PROC_NAME_LEN: "; var_dump( $server->MAX_PROC_NAME_LEN ); - echo "MAX_SCHEMA_NAME_LEN: "; var_dump( $server->MAX_SCHEMA_NAME_LEN ); - echo "MAX_STATEMENT_LEN: "; var_dump( $server->MAX_STATEMENT_LEN ); - echo "MAX_TABLE_NAME_LEN: "; var_dump( $server->MAX_TABLE_NAME_LEN ); - echo "NON_NULLABLE_COLUMNS: "; var_dump( $server->NON_NULLABLE_COLUMNS ); - - db2_close($conn); -} -?>]]> - &example.outputs; - - - - - - - &reftitle.seealso; - - db2_client_info - - - - diff --git a/reference/ibm_db2/functions/db2-set-option.xml b/reference/ibm_db2/functions/db2-set-option.xml deleted file mode 100644 index 8f346d3b5c..0000000000 --- a/reference/ibm_db2/functions/db2-set-option.xml +++ /dev/null @@ -1,962 +0,0 @@ - - - - - - - db2_set_option - Fixe des options pour une ressource de connexion ou une ressource d'instruction - - - &reftitle.description; - - booldb2_set_option - resourceresource - arrayoptions - inttype - - - Fixe des options pour une ressource d'instruction ou une ressource de connexion. - Il n'est pas possible de fixer des options pour des ressources de jeu de résultats. - - - - &reftitle.parameters; - - - resource - - - Une ressource d'instruction valide retournée par - db2_prepare ou une ressource de connexion valide - retournée par db2_connect ou - db2_pconnect. - - - - - options - - - Un tableau associatif contenant des options d'instruction ou de - connexion valides. Ce paramètre peut être utilisé pour changer - les valeurs d'autocommit, les types de curseur (flottant ou à avance - seule) et pour spécifier la casse des noms de colonne (minuscule, - majuscule ou naturelle) qui apparaîtra dans le jeu de résultats. - - - autocommit - - - Passer DB2_AUTOCOMMIT_ON active - l'autocommit pour la ressource de connexion spécifiée. - - - Passer DB2_AUTOCOMMIT_OFF désactive - l'autocommit pour la ressource de connexion spécifiée. - - - - - cursor - - - Passer DB2_FORWARD_ONLY spécifie un - curseur à avance seule pour une ressource d'instruction. Ceci est - le type de curseur par défaut, et il est supporté par tous - les serveurs de base de données. - - - Passer DB2_SCROLLABLE spécifie un - curseur flottant pour une ressource d'instruction. Les curseurs - flottants permettent aux lignes du jeu de résultats d'être - accessibles dans un ordre non séquentiel, mais ils ne sont supportés - que par les bases de données IBM DB2 Universal Database. - - - - - binmode - - - Passer DB2_BINARY spécifie que des - données binaires seront retournées comme telles. Ceci est - le mode par défaut. Ceci est équivalent à la - configuration ibm_db2.binmode=1 dans - &php.ini;. - - - Passer DB2_CONVERT spécifie que les - données binaires seront converties en encodage hexadécimal - et seront retournées ainsi. Ceci est équivalent à la - configuration ibm_db2.binmode=2 dans - &php.ini;. - - - Passer DB2_PASSTHRU spécifie que les - données binaires seront converties en &null;. - Ceci est équivalent à la - configuration ibm_db2.binmode=3 dans - &php.ini;. - - - - - db2_attr_case - - - Passer DB2_CASE_LOWER spécifie que les - noms des colonnes dans le jeu de résultats seront - retournés en minuscules. - - - Passer DB2_CASE_UPPER spécifie que les - noms des colonnes dans le jeu de résultats seront - retournés en majuscules. - - - Passer DB2_CASE_NATURAL spécifie que - les noms de colonnes dans le jeu de résultats seront - retournés en casse naturelle. - - - - - deferred_prepare - - - Passer DB2_DEFERRED_PREPARE_ON active - la préparation différée sur la ressource d'instruction spécifiée. - - - Passer DB2_DEFERRED_PREPARE_OFF désactive - la préparation différée sur la ressource d'instruction spécifiée. - - - - - - - Les nouvelles options suivantes i5/OS sont disponibles à partir de la - version 1.5.1 d'ibm_db2. Ces options s'appliquent uniquement lorsque - PHP et ibm_db2 fonctionnent nativement sur un système i5. - - - i5_fetch_only - - - DB2_I5_FETCH_ON : les curseurs sont en - lecture seule et ne peuvent être utilisés pour positionner - des mises à jour et des suppressions. Ceci est la valeur - par défaut à moins que la variable d'environnement - SQL_ATTR_FOR_FETCH_ONLY ait été mise à - SQL_FALSE. - - - DB2_I5_FETCH_OFF : les curseurs - peuvent être positionnés pour des mises à jour et des - suppressions. - - - - - - - La nouvelle option suivante est disponible à partir de - ibm_db2 version 1.8.0. - - - rowcount - - - DB2_ROWCOUNT_PREFETCH_ON - Le client peut demander - un comptage complet des lignes avant de les récupérer, ce qui - signifie que la fonction db2_num_rows retourne - le nombre de lignes sélectionnées même si un curseur - ROLLFORWARD_ONLY est utilisé. - - - DB2_ROWCOUNT_PREFETCH_OFF - Le client - ne peut pas demander un comptage complet des lignes avant de les récupérer. - - - - - - - Les options suivantes sont nouvelles, et disponibles à partir de - ibm_db2 version 1.7.0. - - - trusted_user - - - Pour basculer l'utilisateur vers un utilisateur de confiance, - il faut passer l'identifiant utilisateur (chaîne de caractères) de - l'utilisateur de confiance comme valeur de cette clé. Cette option ne - peut être configurée que sur une ressource de connexion. Pour utiliser - cette option, un contexte de confiance doit être activé sur la ressource - de connexion. - - - - - trusted_password - - - Le mot de passe (chaîne de caractères) qui correspond à l'utilisateur - spécifié par la clé trusted_user. - - - - - - - Les options suivantes sont nouvelles, et disponibles à partir de - ibm_db2 version 1.6.0. Ces options fournissent des informations de - suivi utiles, accessibles pendant l'exécution via db2_get_option. - - - Lorsque la valeur de chaque option est sur le point d'être définie, quelques - serveurs peuvent ne pas gérer la totalité de la longueur fournie et peuvent - tronquer la valeur. - - - Pour s'assurer que les données spécifiées dans chaque option seront converties - correctement lorsqu'elles seront transmises au système, utiliser seulement - les caractères d'A à Z, 0 à 9, les soulignés (_) et - les points (.). - - - - - userid - - - SQL_ATTR_INFO_USERID : un pointeur vers une &string; - terminée par &null; utilisée pour identifier l'ID utilisateur du client envoyé - au serveur de base de données hôte lors de l'utilisation de DB2 Connect. - - - DB2 pour les serveurs z/OS et OS/390 supporte une longueur jusqu'à - 16 caractères. L'ID utilisateur ne doit pas être confondu avec l'ID utilisateur - d'identification, il est utilisé pour les processus d'identification uniquement - et non pour ceux d'autorisation. - - - - - - - acctstr - - - SQL_ATTR_INFO_ACCTSTR : un pointeur vers une &string; - terminée par &null; utilisée pour identifier la chaîne de comptabilité du client - à envoyer au serveur de base de données hôte lors de l'utilisation de DB2 Connect. - - - DB2 pour les serveurs z/OS et OS/390 supporte une longueur jusqu'à - 200 caractères. - - - - - - - applname - - - SQL_ATTR_INFO_APPLNAME : un pointeur vers une &string; - terminée par &null; utilisée pour identifier le nom de l'application client - à envoyer au serveur de base de données hôte lors de l'utilisation de DB2 Connect. - - - DB2 pour les serveurs z/OS et OS/390 supporte une longueur jusqu'à - 32 caractères. - - - - - - - wrkstnname - - - SQL_ATTR_INFO_WRKSTNNAME : un pointeur vers une &string; - terminée par &null; utilisée pour identifier le nom de la station de travail du client - à envoyer au serveur de base de données hôte lors de l'utilisation de DB2 Connect. - - - DB2 pour les serveurs z/OS et OS/390 supporte une longueur jusqu'à - 18 caractères. - - - - - - - - - - - type - - - Un &integer; qui spécifie le type de ressource qui a été passé à - la fonction. Le type de ressource et cette valeur doivent correspondre. - - - Passer 1 en tant que valeur spécifie - qu'une ressource de connexion a été passée à la fonction. - - - Passer n'importe quel &integer; différent de - 1 en tant que valeur spécifie qu'une - ressource d'instruction a été passée à la fonction. - - - - - - - - Le tableau suivant spécifie quelles options sont compatibles avec quels - types de ressources : - - Matrice ressource-paramètre - - - - - - - - - - Clé - Valeur - Type de ressource - - - - - - Connexion - Instruction - Jeu de résultats - - - autocommit - DB2_AUTOCOMMIT_ON - X - - - - - - - autocommit - DB2_AUTOCOMMIT_OFF - X - - - - - - - cursor - DB2_SCROLLABLE - - - X - - - - - cursor - DB2_FORWARD_ONLY - - - X - - - - - binmode - DB2_BINARY - X - X - - - - - binmode - DB2_CONVERT - X - X - - - - - binmode - DB2_PASSTHRU - X - X - - - - - db2_attr_case - DB2_CASE_LOWER - X - X - - - - - db2_attr_case - DB2_CASE_UPPER - X - X - - - - - db2_attr_case - DB2_CASE_NATURAL - X - X - - - - - deferred_prepare - DB2_DEFERRED_PREPARE_ON - - - X - - - - - deferred_prepare - DB2_DEFERRED_PREPARE_OFF - - - X - - - - - i5_fetch_only - DB2_I5_FETCH_ON - - - X - - - - - rowcount - DB2_ROWCOUNT_PREFETCH_ON - - - X - - - - - rowcount - DB2_ROWCOUNT_PREFETCH_OFF - - - X - - - - - trusted_user - <USER NAME> (String) - X - - - - - - - trusted_password - <PASSWORD> (String) - X - - - - - - - i5_fetch_only - DB2_I5_FETCH_OFF - - - X - - - - - userid - SQL_ATTR_INFO_USERID - X - X - - - - - acctstr - SQL_ATTR_INFO_ACCTSTR - X - X - - - - - applname - SQL_ATTR_INFO_APPLNAME - X - X - - - - - wrkstnname - SQL_ATTR_INFO_WRKSTNNAME - X - X - - - - - -
- - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Fixer un paramètre à une ressource de connexion - - DB2_AUTOCOMMIT_ON); - -/* Appel de la fonction en utilisant le type correct de ressource, le tableau -* d'options et la valeur type */ -$result = db2_set_option($conn, $options, 1); - -/* Vérifie si toutes les options peuvent être fixées correctement */ -if($result) -{ - echo 'Options fixées correctement'; -} -else -{ - echo 'Impossible de fixer les options'; -} -?> -]]> - - &example.outputs; - - - - - - Fixe des paramètres multiples avec une ressource de connexion - - DB2_AUTOCOMMIT_OFF, -'binmode' => DB2_PASSTHRU, -'db2_attr_case' => DB2_CASE_UPPER, -'cursor' => DB2_SCROLLABLE); - -/* Appel de la fonction en utilisant le type correct de ressource, le tableau -* d'options et la valeur type */ -$result = db2_set_option($conn, $options, 1); - -/* Vérifie si toutes les options peuvent être fixées correctement */ -if($result) -{ - echo 'Options fixées correctement'; -} -else -{ - echo 'Impossible de fixer les options'; -} -?> -]]> - - &example.outputs; - - - - - - - Fixe des paramètres multiples avec une clé invalide - - DB2_AUTOCOMMIT_OFF, -'MY_INVALID_KEY' => DB2_PASSTHRU, -'db2_attr_case' => DB2_CASE_UPPER, -'cursor' => DB2_SCROLLABLE); - -/* Appel de la fonction en utilisant le type correct de ressource, le tableau -* d'options et la valeur type */ -$result = db2_set_option($conn, $options, 1); - -/* Vérifie si toutes les options peuvent être fixées correctement */ -if($result) -{ - echo 'Options fixées correctement'; -} -else -{ - echo 'Impossible de fixer les options'; -} -?> -]]> - - &example.outputs; - - - - - - - Fixe des paramètres multiples avec une valeur invalide - - DB2_AUTOCOMMIT_OFF, -'binmode' => 'INVALID_VALUE', -'db2_attr_case' => DB2_CASE_UPPER, -'cursor' => DB2_SCROLLABLE); - -/* Appel de la fonction en utilisant le type correct de ressource, le tableau -* d'options et la valeur type */ -$result = db2_set_option($conn, $options, 1); - -/* Vérifie si toutes les options peuvent être fixées correctement */ -if($result) -{ - echo 'Options fixées correctement'; -} -else -{ - echo 'Impossible de fixer les options'; -} -?> -]]> - - &example.outputs; - - - - - - - Fixe des paramètres multiples avec une ressource de connexion et un mauvais type - - DB2_AUTOCOMMIT_OFF, -'binmode' => DB2_PASSTHRU, -'db2_attr_case' => DB2_CASE_UPPER, -'cursor' => DB2_SCROLLABLE); - -/* Appel de la fonction en utilisant le type correct de ressource, le tableau -* d'options et la valeur type invalide */ -$result = db2_set_option($conn, $options, 2); - -/* Vérifie si toutes les options peuvent être fixées correctement */ -if($result) -{ - echo 'Options fixées correctement'; -} -else -{ - echo 'Impossible de fixer les options'; -} -?> -]]> - - &example.outputs; - - - - - - - Fixe des paramètres multiples avec une mauvaise ressource - - DB2_AUTOCOMMIT_OFF, -'binmode' => DB2_PASSTHRU, -'db2_attr_case' => DB2_CASE_UPPER, -'cursor' => DB2_SCROLLABLE); - -$stmt = db2_prepare($conn, 'SELECT * FROM EMPLOYEE'); - -/* Appel de la fonction en utilisant le type incorrect de ressource, mais le tableau -* d'options et la valeur type valide */ -$result = db2_set_option($stmt, $options, 1); - -/* Vérifie si toutes les options peuvent être fixées correctement */ -if($result) -{ - echo 'Options fixées correctement'; -} -else -{ - echo 'Impossible de fixer les options'; -} -?> -]]> - - &example.outputs; - - - - - - - Tout mettre ensemble - - DB2_CASE_LOWER, -'cursor' => DB2_SCROLLABLE); - -$stmt = db2_prepare($conn, 'SELECT * FROM EMPLOYEE WHERE EMPNO = ? OR EMPNO = ?'); - -/* Appel de la fonction en utilisant le type correct de ressource, le tableau -* d'options et la valeur type */ -$option_result = db2_set_option($stmt, $options, 2); -$result = db2_execute($stmt, array('000130', '000140')); - -/* Récupère la ligne 2 avant la ligne 1 puisque nous avons un curseur flottant */ -print_r(db2_fetch_assoc($stmt, 2)); -print '

'; -print_r(db2_fetch_assoc($stmt, 1)); - -?> -]]> - - &example.outputs; - - 000140 - [firstnme] => HEATHER - [midinit] => A - [lastname] => NICHOLLS - [workdept] => C01 - [phoneno] => 1793 - [hiredate] => 1976-12-15 - [job] => ANALYST - [edlevel] => 18 - [sex] => F - [birthdate] => 1946-01-19 - [salary] => 28420.00 - [bonus] => 600.00 - [comm] => 2274.00 -) - -Array -( - [empno] => 000130 - [firstnme] => DELORES - [midinit] => M - [lastname] => QUINTANA - [workdept] => C01 - [phoneno] => 4578 - [hiredate] => 1971-07-28 - [job] => ANALYST - [edlevel] => 16 - [sex] => F - [birthdate] => 1925-09-15 - [salary] => 23800.00 - [bonus] => 500.00 - [comm] => 1904.00 -) -]]> - - - - Les curseurs i5/OS sont en lecture seule - -"nobody")); -$stmt = db2_prepare($conn, 'select * from names where first = ?'); -$name = "first2"; -db2_bind_param($stmt, 1, "name", DB2_PARAM_IN); -$options = array("i5_fetch_only"=>DB2_I5_FETCH_ON); -db2_set_option($stmt,$options,0); -if (db2_execute($stmt)) { - while ($row = db2_fetch_array($stmt)) { - echo "{$row[0]} {$row[1]}"; - } -} -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_connect - db2_pconnect - db2_exec - db2_prepare - db2_cursor_type - - - - diff --git a/reference/ibm_db2/functions/db2-special-columns.xml b/reference/ibm_db2/functions/db2-special-columns.xml deleted file mode 100644 index 6cd80df10d..0000000000 --- a/reference/ibm_db2/functions/db2-special-columns.xml +++ /dev/null @@ -1,239 +0,0 @@ - - - - - - - db2_special_columns - - Retourne un jeu de résultats listant les identifiants uniques des lignes d'une table - - - - &reftitle.description; - - resourcedb2_special_columns - resourceconnection - stringnullqualifier - stringschema - stringtable_name - intscope - - - - Retourne un jeu de résultats listant les identifiants uniques des lignes - d'une table. - - - - - &reftitle.parameters; - - - connection - - - Une connexion valide à une base de données IBM DB2, Cloudscape ou - Apache Derby. - - - - - qualifier - - - Un qualificatif pour les bases de données DB2 qui fonctionnent sur - les serveurs OS/390 ou z/OS. Pour les autres bases de données, - passez &null; ou une chaîne vide. - - - - - schema - - - Le schéma qui contient les tables. - - - - - table_name - - - Le nom de la table. - - - - - scope - - - Un entier représentant le temps minimal pour lequel l'identifiant - unique de la ligne est valide. Cela peut être une des valeurs suivantes : - - - - - Valeur Entier - Constante SQL - Description - - - - - 0 - SQL_SCOPE_CURROW - L'identifiant de la ligne est valide seulement lorsque - le curseur est positionné sur la ligne. - - - 1 - SQL_SCOPE_TRANSACTION - L'identifiant de la ligne est valide pour la durée de la - transaction. - - - 2 - SQL_SCOPE_SESSION - L'identifiant de la ligne est valide pour la durée de la - connexion. - - - - - - - - - - - - &reftitle.returnvalues; - - Retourne une ressource d'instruction avec un jeu de résultats contenant - des lignes avec des informations uniques pour une table. Les lignes sont - composées des colonnes suivantes : - - - - - Nom de la colonne - Description - - - - - SCOPE - - - - - - Valeur Entier - Constante SQL - Description - - - - - 0 - SQL_SCOPE_CURROW - L'identifiant de la ligne est valide seulement lorsque - le curseur est positionné sur la ligne. - - - 1 - SQL_SCOPE_TRANSACTION - L'identifiant de la ligne est valide pour la durée de la - transaction. - - - 2 - SQL_SCOPE_SESSION - L'identifiant de la ligne est valide pour la durée de la - connexion. - - - - - - - - COLUMN_NAME - Nom de la colonne unique. - - - DATA_TYPE - Le type de données SQL pour la colonne. - - - TYPE_NAME - Une chaîne représentant le type de données SQL pour la - colonne. - - - COLUMN_SIZE - Un entier représentant la taille de la colonne. - - - BUFFER_LENGTH - Nombre maximal d'octets nécessaires pour stocker les - données de cette colonne. - - - DECIMAL_DIGITS - L'échelle de la colonne, ou &null; lorsque l'échelle n'est pas - applicable. - - - NUM_PREC_RADIX - Un entier pouvant être 10 (représentant un - type de données numérique exact), 2 (représentant un - type de données numérique approximatif) ou &null; (représentant un type - de données pour lequel la base n'est pas applicable). - - - PSEUDO_COLUMN - Retourne toujours 1. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-statistics.xml b/reference/ibm_db2/functions/db2-statistics.xml deleted file mode 100644 index 2f32e3cfb1..0000000000 --- a/reference/ibm_db2/functions/db2-statistics.xml +++ /dev/null @@ -1,285 +0,0 @@ - - - - - - - db2_statistics - - Retourne un jeu de résultats listant les index et statistiques d'une table - - - - &reftitle.description; - - resourcedb2_statistics - resourceconnection - stringnullqualifier - stringnullschema - stringtable_name - boolunique - - - - Retourne un jeu de résultats listant les index et statistiques d'une table. - - - - - &reftitle.parameters; - - - connection - - - Une connexion valide à une base de données IBM DB2, Cloudscape ou - Apache Derby. - - - - - qualifier - - - Un qualificatif pour les bases de données DB2 qui fonctionnent sur - les serveurs OS/390 ou z/OS. Pour les autres bases de données, - il faut passer &null; ou une chaîne vide. - - - - - schema - - - Le schéma qui contient les tables visées. Si le paramètre est &null;, - les statistiques et les index sont retournés pour le schéma de - l'utilisateur en cours. - - - - - table_name - - - Le nom de la table. - - - - - unique - - - Quand unique est &true;, les informations relatives - à tous les index de la table sont renvoyées. - Sinon, seules les informations relatives aux index uniques de la table - sont renvoyées. - - - - - - - &reftitle.returnvalues; - - Retourne une ressource d'instruction avec un jeu de résultats contenant des - lignes décrivant les statistiques et les index pour les tables de base - correspondant aux paramètres spécifiés. Les lignes sont composées des - colonnes suivantes : - - - - - Nom de la colonne - Description - - - - - TABLE_CAT - Le catalogue qui contient la table. - La valeur est &null; si cette table n'a pas de catalogue. - - - TABLE_SCHEM - Nom du schéma qui contient la table. - - - TABLE_NAME - Nom de la table. - - - NON_UNIQUE - - - Un entier indiquant si l'index interdit les valeurs uniques ou si - la ligne représente des statistiques sur la table elle-même : - - - - - Valeur de retour - Type de paramètre - - - - - 0 (SQL_FALSE) - L'index autorise les valeurs dupliquées. - - - 1 (SQL_TRUE) - Les valeurs de l'index doivent être uniques. - - - &null; - La ligne contient des informations statistiques à propos de la table. - - - - - - - - - INDEX_QUALIFIER - Une chaîne de caractères représentant le qualificatif qui devrait - être préfixé à INDEX_NAME pour qualifier complètement - l'index. - - - INDEX_NAME - Une chaîne représentant le nom de l'index. - - - TYPE - - - Un entier représentant le type d'informations contenues dans cette - ligne du jeu de résultats : - - - - - Valeur de retour - Type de paramètre - - - - - 0 (SQL_TABLE_STAT) - La ligne contient des informations statistiques à propos de la table. - - - 1 (SQL_INDEX_CLUSTERED) - La ligne contient des informations à propos d'un index groupé. - - - 2 (SQL_INDEX_HASH) - La ligne contient des informations à propos d'un index haché. - - - 3 (SQL_INDEX_OTHER) - La ligne contient des informations à propos d'un type - d'index qui n'est ni groupé ni haché. - - - - - - - - - ORDINAL_POSITION - La position (commençant à 1) de la colonne dans l'index. &null; - si la ligne contient des informations statistiques à propos de la - table. - - - COLUMN_NAME - Le nom de la colonne dans l'index. &null; si la ligne contient - des informations statistiques à propos de la table. - - - ASC_OR_DESC - - A si la colonne est triée en ordre croissant, - D si la colonne est triée en ordre décroissant, - &null; si la ligne contient des informations statistiques à - propos de la table. - - - - CARDINALITY - - - Si la ligne contient des informations à propos d'un index, cette - colonne contiendra un entier représentant le nombre de valeurs uniques - dans l'index. - - - Si la ligne contient des informations à propos de la table, cette - colonne contiendra un entier représentant le nombre de lignes dans la - table. - - - - - PAGES - - - Si la ligne contient des informations à propos d'un index, cette - colonne contiendra un entier représentant le nombre de pages - utilisées pour enregistrer l'index. - - - Si la ligne contient des informations à propos de la table, cette - colonne contiendra un entier représentant le nombre de pages utilisées - pour enregistrer la table. - - - - - FILTER_CONDITION - Retourne toujours &null;. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-stmt-error.xml b/reference/ibm_db2/functions/db2-stmt-error.xml deleted file mode 100644 index 2aecaa2c58..0000000000 --- a/reference/ibm_db2/functions/db2-stmt-error.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - db2_stmt_error - - Retourne une chaîne contenant la valeur de SQLSTATE retournée par une requête SQL - - - - &reftitle.description; - - stringdb2_stmt_error - resourcenullstmt&null; - - - - Retourne une chaîne contenant la valeur de SQLSTATE retournée par une requête - SQL. - - - Si aucune ressource d'instruction n'est passée en argument à la fonction - db2_stmt_error, le pilote retourne la valeur de - SQLSTATE associée avec la dernière tentative de retour d'une ressource - d'instruction, par exemple, provenant de db2_prepare - ou db2_exec. - - - Pour comprendre les valeurs de SQLSTATE, il est possible de taper la commande - suivante dans le processeur de ligne de commandes de DB2 : - db2 '? sqlstate-value'. Il - est aussi possible d'appeler la fonction db2_stmt_errormsg - pour obtenir un message d'erreur explicite ainsi que la valeur de SQLCODE - associée. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource d'instruction valide. - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant la valeur de SQLSTATE. - - - - - &reftitle.seealso; - - db2_conn_error - db2_conn_errormsg - db2_stmt_errormsg - - - - diff --git a/reference/ibm_db2/functions/db2-stmt-errormsg.xml b/reference/ibm_db2/functions/db2-stmt-errormsg.xml deleted file mode 100644 index 9e90a11fdf..0000000000 --- a/reference/ibm_db2/functions/db2-stmt-errormsg.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - db2_stmt_errormsg - - Retourne le dernier message d'erreur d'une requête SQL - - - - &reftitle.description; - - stringdb2_stmt_errormsg - resourcenullstmt&null; - - - - Retourne le dernier message d'erreur d'une requête SQL. - - - Si aucune ressource d'instruction n'est passée en argument à - db2_stmt_errormsg, le pilote retourne le message - d'erreur associé avec la dernière tentative de retour d'une ressource - d'instruction, par exemple, provenant de db2_prepare - ou db2_exec. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource d'instruction valide. - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant le message d'erreur et la valeur SQLCODE - pour la dernière erreur survenue lors de l'exécution d'une requête SQL. - - - - - &reftitle.seealso; - - db2_conn_error - db2_conn_errormsg - db2_stmt_error - - - - diff --git a/reference/ibm_db2/functions/db2-table-privileges.xml b/reference/ibm_db2/functions/db2-table-privileges.xml deleted file mode 100644 index 02707a1bf0..0000000000 --- a/reference/ibm_db2/functions/db2-table-privileges.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - - db2_table_privileges - - Retourne un jeu de résultats listant les tables et les privilèges - qui leur sont associés dans une base de données - - - - &reftitle.description; - - resourcedb2_table_privileges - resourceconnection - stringnullqualifier&null; - stringnullschema&null; - stringnulltable_name&null; - - - - Retourne un jeu de résultats listant les tables et les privilèges - qui leur sont associés dans une base de données. - - - - - &reftitle.parameters; - - - connection - - - Une connexion valide à une base de données IBM DB2, Cloudscape ou - Apache Derby. - - - - - qualifier - - - Un qualificatif pour les bases de données DB2 qui fonctionnent sur - les serveurs OS/390 ou z/OS. Pour les autres bases de données, - passer &null; ou une chaîne vide. - - - - - schema - - - Le schéma qui contient les tables. Ce paramètre accepte un motif - de recherche contenant _ et % - en tant que caractères génériques. - - - - - table_name - - - Le nom de la table. Ce paramètre accepte un motif de recherche - contenant _ et % en tant que - caractères génériques. - - - - - - - &reftitle.returnvalues; - - Retourne une ressource d'instruction avec un jeu de résultats contenant les - lignes décrivant les privilèges des tables qui correspondent aux paramètres - spécifiés. Les lignes sont composées des colonnes suivantes : - - - - - Nom de la colonne - Description - - - - - TABLE_CAT - Le catalogue qui contient la table. La valeur est &null; si - cette table n'a pas de catalogues. - - - TABLE_SCHEM - Nom du schéma qui contient la table. - - - TABLE_NAME - Nom de la table. - - - GRANTOR - ID d'autorisation de l'utilisateur qui a accordé le privilège. - - - GRANTEE - ID d'autorisation de l'utilisateur à qui le privilège a été - accordé. - - - PRIVILEGE - - Le privilège qui a été accordé. Cela peut être l'un des suivants : - ALTER, CONTROL, DELETE, INDEX, INSERT, REFERENCES, SELECT ou UPDATE. - - - - IS_GRANTABLE - - Une chaîne valant "YES" ou "NO" indiquant si le bénéficiaire peut - accorder le privilège à d'autres utilisateurs. - - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-tables.xml b/reference/ibm_db2/functions/db2-tables.xml deleted file mode 100644 index 451be3eb17..0000000000 --- a/reference/ibm_db2/functions/db2-tables.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - db2_tables - - Retourne la liste des tables et leurs métadonnées - - - - &reftitle.description; - - resourcedb2_tables - resourceconnection - stringnullqualifier&null; - stringnullschema&null; - stringnulltable_name&null; - stringnulltable_type&null; - - - - Retourne un jeu de résultats listant les tables et les métadonnées - associées dans une base de données. - - - - - &reftitle.parameters; - - - connection - - - Une connexion valide à une base de données IBM DB2, Cloudscape ou - Apache Derby. - - - - - qualifier - - - Un qualificatif pour les bases de données DB2 qui fonctionnent sur - les serveurs OS/390 ou z/OS. Pour les autres bases de données, - passez &null; ou une chaîne vide. - - - - - schema - - - Le schéma qui contient les tables. Ce paramètre accepte un motif de recherche - contenant _ et % en tant que - caractères génériques. - - - - - table_name - - - Le nom de la table. Ce paramètre accepte un motif de recherche - contenant _ et % en tant que - caractères génériques. - - - - - table_type - - - Une liste d'identifiants de type de table délimitée par des virgules. - Pour correspondre à tous les types de tables, passez &null; ou une chaîne - vide. Les identifiants de type de table valides incluent : - ALIAS, HIERARCHY TABLE, INOPERATIVE VIEW, NICKNAME, - MATERIALIZED QUERY TABLE, SYSTEM TABLE, TABLE, TYPED TABLE, TYPED VIEW - et VIEW. - - - - - - - &reftitle.returnvalues; - - Retourne une ressource d'instruction avec un jeu de résultats contenant les lignes - décrivant les tables qui correspondent aux paramètres spécifiés. Les - lignes sont composées des colonnes suivantes : - - - - - Nom de la colonne - Description - - - - - TABLE_CAT - Le catalogue qui contient la table. - La valeur est &null; si cette table n'a pas de catalogues. - - - TABLE_SCHEM - Nom du schéma qui contient la table. - - - TABLE_NAME - Nom de la table. - - - TABLE_TYPE - Identifiant de type de table pour la table. - - - REMARKS - Description de la table. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - - - - diff --git a/reference/ibm_db2/ini.xml b/reference/ibm_db2/ini.xml deleted file mode 100644 index 16496a78bd..0000000000 --- a/reference/ibm_db2/ini.xml +++ /dev/null @@ -1,542 +0,0 @@ - - - -
- &reftitle.runtime; - &extension.runtime; - - &ConfigureOptions; DB2 - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - ibm_db2.binmode - "1" - INI_ALL - - - - ibm_db2.i5_all_pconnect - "0" - INI_SYSTEM - Disponible à partir d'ibm_db2 1.6.5. - - - ibm_db2.i5_allow_commit - "0" - INI_SYSTEM - Disponible à partir d'ibm_db2 1.4.9. - - - ibm_db2.i5_blank_userid - "0" - INI_SYSTEM - Disponible à partir d'ibm_db2 1.9.7. - - - ibm_db2.i5_char_trim - "0" - INI_SYSTEM - Disponible à partir d'ibm_db2 2.1.0. - - - ibm_db2.i5_dbcs_alloc - "0" - INI_SYSTEM - Disponible à partir d'ibm_db2 1.5.0. - - - ibm_db2.i5_guard_profile - "0" - INI_SYSTEM - Disponible à partir d'ibm_db2 1.9.7. - - - ibm_db2.i5_ignore_userid - "0" - INI_SYSTEM - Disponible à partir d'ibm_db2 1.8.0. - - - ibm_db2.i5_job_sort - "0" - INI_SYSTEM - Disponible à partir d'ibm_db2 1.8.4. - - - ibm_db2.i5_log_verbose - "0" - INI_SYSTEM - Disponible à partir d'ibm_db2 1.9.7. - - - ibm_db2.i5_max_pconnect - "0" - INI_SYSTEM - Disponible à partir d'ibm_db2 1.9.7. - - - ibm_db2.i5_override_ccsid - "0" - INI_SYSTEM - Disponible à partir d'ibm_db2 1.9.7. - - - ibm_db2.i5_servermode_subsystem - NULL - INI_SYSTEM - Disponible à partir d'ibm_db2 1.9.7. - - - ibm_db2.i5_sys_naming - "0" - INI_SYSTEM - Disponible à partir d'ibm_db2 1.9.7. - - - ibm_db2.instance_name - NULL - INI_SYSTEM - Disponible à partir d'ibm_db2 1.0.2. - - - -
- - &ini.descriptions.title; - - - - - ibm_db2.binmode - (int) - - - - Cette option contrôle le mode utilisé pour convertir à partir ou vers - les données binaires dans l'application PHP. - - - - 1 (DB2_BINARY) - - - - - 2 (DB2_CONVERT) - - - - - 3 (DB2_PASSTHRU) - - - - - - - - - ibm_db2.i5_all_pconnect - (int) - - - - Cette option force toutes les connexions à être persistantes sur IBM i. - Fondamentalement, tous les appels à db2_connect deviennent - automatiquement des appels à db2_pconnect. - Par défaut, cette option est 0. - Cette option est fournie pour des raisons de commodité dans les cas où les connexions persistantes sont plus rapides. - Elle ne devrait pas être utilisée dans de nouvelles applications. - - - - 0 - Les connexions persistantes et non persistantes peuvent être établies. - - - - - 1 - Toutes les connexions sont persistantes. - - - - - - - - - ibm_db2.i5_allow_commit - int - - - - Cette option contrôle le mode d'isolation de la transaction utilisé. - Par défaut, cette option est 0, donc le contrôle d'engagement n'est pas utilisé. - Cette option peut être remplacée lors de la connexion si la clé de tableau - i5_commit est définie dans le tableau d'options de connexion - passé à db2_connect ou - db2_pconnect. - - - - 0 - contrôle d'engagement n'est pas utilisé. - - - - - 1 - lecture non validée, lecture sale possible. - - - - - 2 - lecture validée, lecture sale impossible. - - - - - 3 - lecture répétable, lecture sale et lecture non répétable sont impossibles. - - - - - 4 - sérialisable, lecture sale, lecture non répétable, et fantôme sont impossibles. - - - - - - - - - ibm_db2.i5_blank_userid - int - - - - Cela contrôle si un identifiant utilisateur vide doit être autorisé sur IBM i. - Par défaut, cette option est 0. - Contrairement à ibm_db2.i5_ignore_userid, cette option - ne force pas tous les identifiants d'utilisateur à être vides ou à modifier le comportement du travail, mais - permet simplement de passer un identifiant d'utilisateur vide, pour se connecter à Db2 en tant - qu'utilisateur actuel. - - - - 0 - Ne permet pas de passer un identifiant utilisateur vide. - - - - - 1 - Permet de passer un identifiant utilisateur vide. - - - - - - - - - ibm_db2.i5_char_trim - int - - - - Cette option contrôle si la fin des chaînes est tronquée sur IBM i. - Étant donné que de nombreuses tables utilisent des tailles de colonnes fixes remplies d'espaces, cela est - fourni par commodité. - Par défaut, cette option est 0. - - - - 0 - Les colonnes ne sont pas tronquées. - - - - - 1 - Les espaces à la fin des colonnes de caractères retournées sont supprimés. - - - - - - - - - ibm_db2.i5_dbcs_alloc - (int) - - - - Cette option affecte la stratégie d'allocation de mémoire tampon interne sur IBM i. - Par défaut, cette option est 0. - Lorsque cette option est définie, les tampons sont alloués avec une taille beaucoup plus grande, - au cas où la base de données sous-estimerait la taille d'une chaîne lors de la conversion - entre les encodages. - Cette option utilise six fois plus de mémoire pour les tampons (pour prendre en compte - les séquences UTF-8 les plus grandes possibles), mais peut être nécessaire si des données tronquées sont renvoyées. - - - - 0 - Des tampons de taille minimale sont alloués. - - - - - 1 - Des tampons de taille plus grande sont alloués. - - - - - - - - - ibm_db2.i5_guard_profile - int - - - - Cette option vérifie si le profil utilisateur de la base de données a été changé lors de - la connexion à une connexion de base de données persistante sur IBM i, et si c'est le cas, - elle se déconnecte de la base de données. - Par défaut, cette option est définie sur 0. - - - - 0 - Ne pas vérifier les changements de profil. - - - - - 1 - Vérifier les changements de profil et se déconnecter le cas échéant. - - - - - - - - - ibm_db2.i5_log_verbose - int - - - - Cette option définit si les messages diagnostiques SQL tels que les avertissements et les erreurs sont - toujours envoyés dans le journal d'erreurs PHP sur IBM i. - Normalement, seul un bref message en cas d'échec est envoyé (tel que "l'exécution - de la déclaration a échoué") dans le journal d'erreurs PHP, car cette option est définie sur - 0 par défaut. - Il est à noter qu'il est toujours possible, et recommandé, d'appeler - manuellement db2_stmt_errormsg pour vérifier si - les fonctions échouent. - - - - 0 - Ne journalise que des messages brefs. - - - - - 1 - Journalise le message diagnostique SQL en plus du message bref. - - - - - - - - - ibm_db2.i5_ignore_userid - (int) - - - - Cette option ignore l'ID utilisateur lors de la connexion à la base de données lors de - l'exécution sur IBM i, et exécute la fonctionnalité SQL/CLI à l'intérieur du travail PHP, - au lieu d'un travail séparé. - Par défaut, cette option est 0. - Lorsqu'elle est activée, elle n'utilise plus un travail de serveur de base de données séparé, et - utilise toujours le profil utilisateur actuel pour la base de données, ignorant le - nom d'utilisateur et le mot de passe transmis à db2_connect et - db2_pconnect. - - - - 0 : db2_(p)connect avec un identifiant utilisateur et un mot de passe spécifique - 0 - Utilise les informations d'identification spécifiées et utilise un travail de serveur SQL/CLI. - - - - - 1 : db2_(p)connect avec un identifiant utilisateur et un mot de passe vide - 1 - Utilise toujours des informations d'identification vides et exécute SQL/CLI dans le travail PHP. - - - - - - - - - ibm_db2.i5_job_sort - int - - - - Contrôle l'option de tri des travaux sur IBM i. - Par défaut, cette option est 0. - Cela correspond à l'attribut SQL_ATTR_CONN_SORT_SEQUENCE - d'IBM i SQL/CLI. - - - - 0 - Utilise l'option de tri *HEX, triant par octets. - - - - - 1 - Utilise la séquence de tri de travail définie pour le travail PHP. - - - - - 2 - Utilise la séquence de tri de travail définie pour le travail de base de données. - - - - - - - - - ibm_db2.i5_max_pconnect - int - - - - Cela affectera combien de fois une connexion persistante peut être réutilisée - lors de l'exécution sur IBM i. - Par défaut, cela est réglé sur 0, ce qui signifie qu'une connexion persistante peut toujours être réutilisée. - Cette option peut aider à contourner les problèmes dans un travail de base de données - de longue durée (c'est-à-dire si une procédure perd de la mémoire), - mais n'est évidemment pas une solution à long terme. - - - - - - ibm_db2.i5_override_ccsid - int - - - - Le CCSID PASE à utiliser pour les conversions de caractères d'EBCDIC sur IBM i. - Par défaut, c'est 0, ce qui sélectionnera le CCSID de travail PASE par défaut, - provenant des paramètres de localisation PASE. - Par exemple, en le réglant sur 1208, on utilisera l'UTF-8. - Cela ne doit être modifié que si le CCSID du travail PASE n'est pas le CCSID attendu, - et que la localisation ne peut pas être modifiée. - - - Pour en savoir plus sur les CCSID sur IBM i, consulter la - documentation IBM. - Pour savoir comment les localisations sur IBM i PASE sont mappées sur les CCSID, consulter la - documentation IBM. - - - - - - ibm_db2.i5_sys_naming - int - - - - Cette option contrôle le mode de nommage lors de la connexion à un système IBM i. - Par défaut, cette option est 0. - Le mode de nommage affecte la résolution des noms et la syntaxe autorisée pour - les noms. - Lorsqu'il est réglé sur 0, cela utilise des points pour qualifier les noms et - utilise la bibliothèque ou l'ID utilisateur par défaut pour résoudre les noms. - Lorsqu'il est réglé sur 1, cela utilise des barres obliques pour qualifier les noms et - utilise la liste de bibliothèques de travail pour résoudre les noms. - - - - 0 - Utilise le mode de nommage SQL ("SCHEMA.TABLE"). - - - - - 1 - Utilise le mode de nommage système ("LIBRARY/FILE"). - - - - - - Pour en savoir plus sur les modes de nommage sur IBM i, consulter la - documentation IBM. - - - - - - ibm_db2.i5_servermode-subsystem - string - - - - Cette option modifie le sous-système sous lequel les travaux du serveur de base de données s'exécutent sur - IBM i. - Par défaut, cette option est &null;, donc les travaux s'exécuteront sous le sous-système par défaut pour les travaux QSQSRVR. - - - - - - ibm_db2.instance_name - string - - - - Sur les systèmes d'exploitation Linux et UNIX, cette option définit le nom de l'instance à utiliser - pour les connexions de base de données cataloguées. - Par défaut, cette option est &null;. - Si cette option est définie, sa valeur remplace le réglage de la variable d'environnement - DB2INSTANCE. - - - Cette option est ignorée sur les systèmes d'exploitation Windows. - - - - -
- diff --git a/reference/ibm_db2/reference.xml b/reference/ibm_db2/reference.xml deleted file mode 100644 index 00881659be..0000000000 --- a/reference/ibm_db2/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - &Functions; IBM DB2 - - &reference.ibm-db2.entities.functions; - - - diff --git a/reference/ibm_db2/setup.xml b/reference/ibm_db2/setup.xml deleted file mode 100644 index fcf1120a11..0000000000 --- a/reference/ibm_db2/setup.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - &reftitle.setup; - - -
- &reftitle.required; - - Pour se connecter à des bases de données IBM DB2 Universal Database pour - linux, UNIX et Windows ou IBM Cloudscape ou Apache Derby, il faut - installer un client IBM DB2 Universal Database sur le même ordinateur qui - utilise PHP. Cette extension a été développée et testée avec DB2 Version - 8.2. - - - Pour se connecter à des bases de données IBM DB2 Universal Database pour - z/OS ou iSeries, on aura aussi besoin d'IBM DB2 Connect ou - l'équivalent d'un programme DRDA. - -
- Prérequis pour Linux et Unix - - L'utilisateur appelant l'exécutable PHP ou module SAPI doit spécifier - l'instance DB2 avant d'accéder à ces fonctions. Il est possible de spécifier le - nom de l'instance DB2 dans &php.ini; en utilisant l'option de - configuration ibm_db2.instance_name ou il est possible d'approvisionner le profil de l'instance DB2 avant d'appeler l'exécutable PHP. - - - Si l'on a créé une instance DB2 nommée db2inst1 - dans /home/db2inst1, par exemple, il est possible d'ajouter la ligne suivante au &php.ini; : - - - - Si l'on ne spécifie pas cette option dans &php.ini;, il faut exécuter - la commande suivante pour modifier les variables d'environnement pour - autoriser l'accès à DB2 : - - - - Pour permettre à PHP sur le serveur web d'accéder à ces fonctions, - il faut ajouter la même commande au script de démarrage du - serveur Web (typiquement /etc/init.d/httpd ou - /etc/init.d/apache). - -
-
- - - - &reference.ibm-db2.configure; - - - - &reference.ibm-db2.ini; - - - -
- &reftitle.resources; - - L'extension ibm_db2 retourne des ressources de connexion, des ressources - de déclaration et des ressources de jeu de résultats. - -
- - - - diff --git a/reference/igbinary/book.xml b/reference/igbinary/book.xml deleted file mode 100644 index 226d5bfe4d..0000000000 --- a/reference/igbinary/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - Igbinary - Igbinary - - - &reftitle.intro; - - Igbinary est un remplaçant interchangeable du sérialiseur standard de PHP. - Au lieu de la représentation textuelle, consommatrice de temps et d'espace, utilisée par la fonction - serialize de PHP, igbinary stocke les structures de données PHP sous une forme binaire - compacte. - Les économies de mémoire sont significatives lorsque memcached, APCu ou d'autres outils de stockage similaires - basés sur la mémoire sont utilisés pour les données sérialisées. - Les réductions caractéristiques des besoins de stockage sont d'environ 50%. - Le pourcentage exact dépend des données. - - - - &reference.igbinary.setup; - &reference.igbinary.reference; - - - diff --git a/reference/igbinary/functions/igbinary-serialize.xml b/reference/igbinary/functions/igbinary-serialize.xml deleted file mode 100644 index 5b3cc94c90..0000000000 --- a/reference/igbinary/functions/igbinary-serialize.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - igbinary_serialize - Génère une représentation binaire stockable et compacte d'une valeur - - - - &reftitle.description; - - stringfalseigbinary_serialize - mixedvalue - - - Génère une représentation stockable d'une valeur. - - - C'est une technique pratique pour stocker ou passer des valeurs PHP entre scripts, sans perdre leur structure ni leur type. - - - Pour reconvertir la chaîne de caractères sérialisée en une valeur PHP, - la fonction igbinary_unserialize peut être utilisée. - - - - - &reftitle.parameters; - - - value - - - La valeur à sérialiser. igbinary_serialize - gère tous les types sauf les resources et certains objects (voir la note ci-dessous). - Même des &array;s qui contiennent des références à eux-mêmes peuvent être sérialisés avec igbinary_serialize. - Les références circulaires à l'intérieur d'un &array; ou d'un &object; à sérialiser seront également stockées. - Toute autre référence sera perdue. - - - Lorsqu'il sérialise des objets, igbinary tentera d'appeler les méthodes magiques - __serialize() ou - __sleep() avant la sérialisation. - Cela permettra à l'objet de faire un nettoyage de dernière minute, etc., avant d'être sérialisé. - De même, lorsque l'objet est restauré en utilisant la fonction - igbinary_unserialize, une des méthodes magiques __unserialize() - ou __wakeup() est appelée. - - - - Les attributs privés d'un objet auront le nom de la classe préfixé au nom de l'attribut; - les attributs protégés seront préfixés avec un astérisque '*'. - Ces valeurs préfixées ont des caractères nuls des deux côtés. - - - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne de caractères contenant une représentation du paramètre value - sous forme de flux d'octets qui peut être stocké à n'importe quel endroit. - - - Il est à noter que c'est une chaîne binaire qui peut inclure n'importe quelle valeur d'octet, et doit donc être stockée et gérée comme telle. - Par exemple, dans une base de données, la sortie de la fonction igbinary_serialize - doit, en général, être stockée dans un champ de type BLOB - plutôt que dans un champ de type CHAR ou TEXT. - - - - - &reftitle.examples; - - Exemple avec <function>igbinary_serialize</function> - - -]]> - - &example.outputs; - - 'test', - 1 => 'test', -) -]]> - - - - - - &reftitle.notes; - - - Il est à noter que de nombreux objets internes de PHP ne peuvent pas être sérialisés. Cependant, ceux qui le peuvent - implémentent soit l'interface Serializable soit les méthodes magiques - __serialize()/__unserialize() - ou __sleep()/__wakeup(). - Si une classe interne ne remplit aucune de ces conditions, elle ne peut pas être sérialisée de manière fiable. - - - Il existe des exceptions historiques à cette règle, où des objets internes peuvent être sérialisés - sans implémenter ni l'interface ni les méthodes magiques. - - - - - - &reftitle.seealso; - - serialize - igbinary_unserialize - var_export - json_encode - Sérialisation d'objets - __sleep() - __wakeup() - __serialize() - __unserialize() - - - - - diff --git a/reference/igbinary/functions/igbinary-unserialize.xml b/reference/igbinary/functions/igbinary-unserialize.xml deleted file mode 100644 index 5b330ef058..0000000000 --- a/reference/igbinary/functions/igbinary-unserialize.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - igbinary_unserialize - - Crée une variable PHP à partir d'une valeur sérialisée par igbinary_serialize - - - - - &reftitle.description; - - mixedigbinary_unserialize - stringstr - - - igbinary_unserialize prend une variable sérialisée par - igbinary_serialize et la convertit en une variable PHP. - - - - Les entrées utilisateur non fiables ne doivent pas être passées à la fonction - igbinary_unserialize. - La désérialisation peut entraîner l'exécution de code chargé et exécuté lors de l'instanciation - et l'autochargement d'objet, et ainsi, un utilisateur mal intentionné peut être capable d'exploiter - ce comportement. - À la place, un standard d'échange sûr tel que JSON (via json_decode et - json_encode) doit être utilisé pour passer des données sérialisées au client. - - - S'il est indispensable de désérialiser des données sérialisées provenant de l'extérieur, la fonction - hash_hmac peut être utilisée pour valider les données. - Il est important de vérifier que personne n'a altéré les données. - - - - - Le protocole de sérialisation par igbinary ne permet pas de distinguer entre les différents groupes de - références. Toutes les références PHP à une valeur donnée sont vues comme membres d'un même - groupe lors de la désérialisation, même si elles appartenaient à des groupes différents avant la - sérialisation. - - - - - - &reftitle.parameters; - - - str - - - La chaîne de caractères sérialisée, générée par igbinary_serialize. - - - Si la valeur désérialisée est un &object;, après avoir réussi à le reconstruire, - igbinary tentera automatiquement d'appeler les méthodes - __unserialize() ou - __wakeup() (si l'une d'elles existe). - - - - La directive <link linkend="ini.unserialize-callback-func">unserialize_callback_func</link> - - - La fonction de rappel spécifiée dans la directive - unserialize_callback_func - est appelée lorsqu'une classe non définie est désérialisée. - Si aucune fonction de rappel n'est spécifiée, l'objet sera instancié - en tant que __PHP_Incomplete_Class. - - - - - - - - - &reftitle.returnvalues; - - La valeur convertie est retournée par la fonction, et peut être de type &boolean;, - &integer;, &float;, &string;, - &array;, &object;, ou de type null. - - - Si la chaîne de caractères passée ne peut pas être désérialisée, cette fonction retourne &false; - et un diagnostic E_NOTICE ou E_WARNING est émis. - - - - - &reftitle.errors; - - Les objets peuvent lancer un Throwable dans leur gestionnaire de désérialisation. - - - - - &reftitle.notes; - - - &null; ou &false; est retourné soit dans le cas d'une erreur soit après avoir désérialisé - le résultat de la sérialisation de &null; ou &false;. Il est possible de discriminer entre ces deux cas - spéciaux en comparant la valeur du paramètre str avec le résultat de l'exécution - de igbinary_serialize(null) ou de igbinary_serialize(false) - ou bien en attrapant un diagnostic E_NOTICE. - - - - - - &reftitle.seealso; - - unserialize - json_encode - json_decode - hash_hmac - igbinary_serialize - Auto-chargement de classes - unserialize_callback_func - __wakeup() - __serialize() - __unserialize() - - - - diff --git a/reference/igbinary/ini.xml b/reference/igbinary/ini.xml deleted file mode 100644 index dccf371d5b..0000000000 --- a/reference/igbinary/ini.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - -
- &reftitle.runtime; - &extension.runtime; - - - Igbinary &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - igbinary.compact_strings - 1 - INI_ALL - - - - -
- - Options de configuration de session affectant le comportement d'igbinary - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - session.save_handler - "files" - INI_ALL - - - - -
- &ini.php.constants; - - - &ini.descriptions.title; - - - - - igbinary.compact_strings - bool - - - - Active ou non le compactage des chaînes de caractères dupliquées. - La valeur par défaut est On. - - - - - - - session.save_handler - string - - - - Igbinary est utilisé en tant que gestionnaire de session en mettant la valeur de cette option à igbinary. - - - - - -
- diff --git a/reference/igbinary/reference.xml b/reference/igbinary/reference.xml deleted file mode 100644 index 43242136b2..0000000000 --- a/reference/igbinary/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &Functions; de Igbinary - - &reference.igbinary.entities.functions; - - - diff --git a/reference/igbinary/setup.xml b/reference/igbinary/setup.xml deleted file mode 100644 index ba81f279af..0000000000 --- a/reference/igbinary/setup.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;igbinary. - - - &pecl.windows.download.avail; - -
- - &reference.igbinary.ini; - - diff --git a/reference/imagick/book.xml b/reference/imagick/book.xml deleted file mode 100644 index 532b9b799c..0000000000 --- a/reference/imagick/book.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - Traitement des images (ImageMagick) - ImageMagick - - - - &reftitle.intro; - - &warn.experimental; - Imagick est une extension PHP native permettant de créer et de modifier des images - en utilisant l'API ImageMagick. - - -
- À propos d'ImageMagick - - ImageMagick est une suite de logiciels permettant la création, - l'édition et la composition d'images bitmap. Elle peut lire, convertir - et écrire des images dans divers formats (plus d'une centaine) dont - DPX, EXR, GIF, JPEG, JPEG-2000, PDF, PhotoCD, PNG, Postscript, SVG et TIFF. - - - ImageMagick Studio LLC est une organisation à but non lucratif dont la - vocation est de rendre librement disponibles des solutions logicielles - de traitement d'images. - -
- - - - - - &reference.imagick.setup; - &reference.imagick.constants; - &reference.imagick.examples; - - &reference.imagick.imagick; - &reference.imagick.imagickdraw; - &reference.imagick.imagickdrawexception; - &reference.imagick.imagickexception; - &reference.imagick.imagickkernel; - &reference.imagick.imagickkernelexception; - &reference.imagick.imagickpixel; - &reference.imagick.imagickpixelexception; - &reference.imagick.imagickpixeliterator; - &reference.imagick.imagickpixeliteratorexception; - - - - diff --git a/reference/imagick/constants.xml b/reference/imagick/constants.xml deleted file mode 100644 index a87f4f8c99..0000000000 --- a/reference/imagick/constants.xml +++ /dev/null @@ -1,4394 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - Constantes <constant>COLOR_<replaceable>*</replaceable></constant> - Constantes sur les types de couleur. Ces constantes - sont surtout utilisées avec la classe ImagickPixel. - - - - imagick::COLOR_BLACK - (int) - - - - Couleur noire - - - - - - imagick::COLOR_BLUE - (int) - - - - Couleur bleue - - - - - - imagick::COLOR_CYAN - (int) - - - - Couleur cyan - - - - - - imagick::COLOR_GREEN - (int) - - - - Couleur verte - - - - - - imagick::COLOR_RED - (int) - - - - Couleur rouge - - - - - - imagick::COLOR_YELLOW - (int) - - - - Couleur jaune - - - - - - imagick::COLOR_MAGENTA - (int) - - - - Couleur magenta - - - - - - imagick::COLOR_OPACITY - (int) - - - - Couleur de l'opacité - - - - - - imagick::COLOR_ALPHA - (int) - - - - Couleur de l'alpha - - - - - - imagick::COLOR_FUZZ - (int) - - - - Couleur du fuzz - - - - - - - Constantes <constant>DISPOSE_<replaceable>*</replaceable></constant> - Constantes relatives aux types de disposition - - - imagick::DISPOSE_UNRECOGNIZED - (int) - - - - Type de disposition non reconnu - - - - - - imagick::DISPOSE_UNDEFINED - (int) - - - - Type de disposition non défini - - - - - - imagick::DISPOSE_NONE - (int) - - - - Aucun type de disposition - - - - - - imagick::DISPOSE_BACKGROUND - (int) - - - - Disposition du fond - - - - - - imagick::DISPOSE_PREVIOUS - (int) - - - - Disposition précédente - - - - - - - Constantes <constant>COMPOSITE_<replaceable>*</replaceable></constant> - - - imagick::COMPOSITE_DEFAULT - (int) - - - - L'opérateur de composition par défaut. - - - - - - imagick::COMPOSITE_UNDEFINED - (int) - - - - Opérateur de composition indéfini - - - - - - imagick::COMPOSITE_NO - (int) - - - - Pas d'opérateur de composition défini - - - - - - imagick::COMPOSITE_ADD - (int) - - - - Le résultat d'image + image - - - - - - imagick::COMPOSITE_ATOP - (int) - - - - Le résultat a la même forme que l'image, avec l'image composée qui remplit - l'image là où la forme d'image chevauche l'image - - - - - - imagick::COMPOSITE_BLEND - (int) - - - - Combine les images image (blending) - - - - - - imagick::COMPOSITE_BUMPMAP - (int) - - - - La même chose que COMPOSITE_MULTIPLY, hormis le fait que la source est - d'abord convertie en niveaux de gris - - - - - - imagick::COMPOSITE_CLEAR - (int) - - - - Rend l'image cible transparente - - - - - - imagick::COMPOSITE_COLORBURN - (int) - - - - Assombrit l'image de destination pour refléter l'image source - - - - - - imagick::COMPOSITE_COLORDODGE - (int) - - - - Éclaire l'image de destination pour refléter l'image source - - - - - - imagick::COMPOSITE_COLORIZE - (int) - - - - Colorie l'image cible avec l'image composée - - - - - - imagick::COMPOSITE_COPYBLACK - (int) - - - - Copie le noir de la source vers la cible - - - - - - imagick::COMPOSITE_COPYBLUE - (int) - - - - Copie le bleu de la source vers la cible - - - - - - imagick::COMPOSITE_COPY - (int) - - - - Copie la source vers la cible - - - - - - imagick::COMPOSITE_COPYCYAN - (int) - - - - Copie le Cyan de la source vers la cible - - - - - - imagick::COMPOSITE_COPYGREEN - (int) - - - - Copie le vert de la source vers la cible - - - - - - imagick::COMPOSITE_COPYMAGENTA - (int) - - - - Copie le magenta de la source vers la cible - - - - - - imagick::COMPOSITE_COPYOPACITY - (int) - - - - Copie l'opacité de la source vers la cible - - - - - - imagick::COMPOSITE_COPYRED - (int) - - - - Copie le rouge de la source vers la cible - - - - - - imagick::COMPOSITE_COPYYELLOW - (int) - - - - Copie le jaune de la source vers la cible - - - - - - imagick::COMPOSITE_DARKEN - (int) - - - - Assombrit l'image cible - - - - - - imagick::COMPOSITE_DSTATOP - (int) - - - - La partie de l'image de destination qui est à l'intérieur de la - source est composée avec la source, et placée dans la destination. - - - - - - imagick::COMPOSITE_DST - (int) - - - - La cible est laissée intacte - - - - - - imagick::COMPOSITE_DSTIN - (int) - - - - La partie à l'intérieur de la source remplace la cible - - - - - - imagick::COMPOSITE_DSTOUT - (int) - - - - La partie à l'extérieur de la source remplace la cible - - - - - - imagick::COMPOSITE_DSTOVER - (int) - - - - La cible remplace la source - - - - - - imagick::COMPOSITE_DIFFERENCE - (int) - - - - Soustrait la couleur sombre de la couleur claire - - - - - - imagick::COMPOSITE_DISPLACE - (int) - - - - Décale les pixels de la cible tel que défini par la source - - - - - - imagick::COMPOSITE_DISSOLVE - (int) - - - - Dissout la source dans la cible - - - - - - imagick::COMPOSITE_EXCLUSION - (int) - - - - Produit un effet similaire à imagick::COMPOSITE_DIFFERENCE, mais - avec un contraste plus faible - - - - - - imagick::COMPOSITE_HARDLIGHT - (int) - - - - Multiplie ou superpose les couleurs, selon la valeur de la couleur source - - - - - - imagick::COMPOSITE_HUE - (int) - - - - Modifie la teinte de la cible, tel que défini par la source - - - - - - imagick::COMPOSITE_IN - (int) - - - - Compose la source dans la cible - - - - - - imagick::COMPOSITE_LIGHTEN - (int) - - - - Éclaircit la cible, tel que défini par la source - - - - - - imagick::COMPOSITE_LUMINIZE - (int) - - - - Illumine la cible tel que défini par la source - - - - - - imagick::COMPOSITE_MINUS - (int) - - - - Soustrait la source de la cible - - - - - - imagick::COMPOSITE_MODULATE - (int) - - - - Module la clarté de la cible, sa saturation et sa teinte - tel que défini par la source - - - - - - imagick::COMPOSITE_MULTIPLY - (int) - - - - Multiplie la cible avec la source - - - - - - imagick::COMPOSITE_OUT - (int) - - - - Compose l'extérieur de la source dans la cible - - - - - - imagick::COMPOSITE_OVER - (int) - - - - Compose la source sur la cible - - - - - - imagick::COMPOSITE_OVERLAY - (int) - - - - Surimprime la source sur la cible - - - - - - imagick::COMPOSITE_PLUS - (int) - - - - Ajoute la source sur la cible - - - - - - imagick::COMPOSITE_REPLACE - (int) - - - - Remplace la cible avec la source - - - - - - imagick::COMPOSITE_SATURATE - (int) - - - - Sature la cible tel que défini par la source - - - - - - imagick::COMPOSITE_SCREEN - (int) - - - - La source et la cible sont complétées puis multipliées et finalement - elles remplacent la cible - - - - - - imagick::COMPOSITE_SOFTLIGHT - (int) - - - - Assombrit ou éclaire les couleurs, en fonction de la source - - - - - - imagick::COMPOSITE_SRCATOP - (int) - - - - La partie de la source qui est dans la cible est composée sur la cible - - - - - - imagick::COMPOSITE_SRC - (int) - - - - La source est copiée sur la destination - - - - - - imagick::COMPOSITE_SRCIN - (int) - - - - La partie de la source qui est dans la destination, - remplace la destination. - - - - - - imagick::COMPOSITE_SRCOUT - (int) - - - - La partie de la source qui est hors de la destination remplace la destination - - - - - - imagick::COMPOSITE_SRCOVER - (int) - - - - La source remplace la cible - - - - - - imagick::COMPOSITE_SUBTRACT - (int) - - - - Soustrait les couleurs de la source de celles de la cible - - - - - - imagick::COMPOSITE_THRESHOLD - (int) - - - - La source est composée sur la cible, tel que défini par les seuils de la source - - - - - - imagick::COMPOSITE_XOR - (int) - - - - La partie de la source qui est hors de la destination et combinée avec - la partie de la destination qui est hors de la source - - - - - - - Constantes <constant>MONTAGEMODE_<replaceable>*</replaceable></constant> - - - - imagick::MONTAGEMODE_FRAME - (int) - - - - - - - - - imagick::MONTAGEMODE_UNFRAME - (int) - - - - - - - - - imagick::MONTAGEMODE_CONCATENATE - (int) - - - - - - - - - - Constantes <constant>STYLE_<replaceable>*</replaceable></constant> - - - - imagick::STYLE_NORMAL - (int) - - - - - - - - - imagick::STYLE_ITALIC - (int) - - - - - - - - - imagick::STYLE_OBLIQUE - (int) - - - - - - - - - imagick::STYLE_ANY - (int) - - - - - - - - - - Constantes <constant>FILTER_<replaceable>*</replaceable></constant> - - - - imagick::FILTER_UNDEFINED - (int) - - - - - - - - - imagick::FILTER_POINT - (int) - - - - - - - - - imagick::FILTER_BOX - (int) - - - - - - - - - imagick::FILTER_TRIANGLE - (int) - - - - - - - - - imagick::FILTER_HERMITE - (int) - - - - - - - - - imagick::FILTER_HANNING - (int) - - - - - - - - - imagick::FILTER_HAMMING - (int) - - - - - - - - - imagick::FILTER_BLACKMAN - (int) - - - - - - - - - imagick::FILTER_GAUSSIAN - (int) - - - - - - - - - imagick::FILTER_QUADRATIC - (int) - - - - - - - - - imagick::FILTER_CUBIC - (int) - - - - - - - - - imagick::FILTER_CATROM - (int) - - - - - - - - - imagick::FILTER_MITCHELL - (int) - - - - - - - - - imagick::FILTER_LANCZOS - (int) - - - - - - - - - imagick::FILTER_BESSEL - (int) - - - - - - - - - imagick::FILTER_SINC - (int) - - - - - - - - - - Constantes <constant>IMGTYPE_<replaceable>*</replaceable></constant> - - Un type d'image combine un modèle colorimétrique et la présence ou l'absence - d'un canal alpha. - Passer une de ces constantes à - Imagick::setImageType convertit l'image vers ce - type. - Imagick::getImageType indique le type d'une image, - mais ne retourne jamais qu'un type décrivant des données de pixels réelles, - jamais imagick::IMGTYPE_UNDEFINED ni - imagick::IMGTYPE_OPTIMIZE. - - - Les constantes dont le nom se termine par MATTE sont les - variantes qui portent un canal alpha ; les autres n'en ont pas. - Dans ImageMagick 6, le canal alpha était appelé canal matte, et lorsque - Imagick est compilé avec ImageMagick 7, chacune de ces constantes existe - aussi sous un nom - IMGTYPE_*ALPHA ayant la même - valeur. - - - - imagick::IMGTYPE_UNDEFINED - (int) - - - - Le type de l'image est inconnu. - Imagick::setImageType ne convertit rien pour - cette valeur, mais l'enregistre tout de même sur l'image. - - - - - - imagick::IMGTYPE_BILEVEL - (int) - - - - Deux couleurs seulement. - L'image est convertie en niveaux de gris, son contraste est étiré, et - chaque pixel devient noir ou blanc selon qu'il est plus clair ou plus - sombre qu'un gris moyen ; tout canal alpha est abandonné. - - - - - - imagick::IMGTYPE_GRAYSCALE - (int) - - - - Des nuances de gris. - L'image est convertie vers l'espace colorimétrique en niveaux de gris, et - tout canal alpha est abandonné. - - - - - - imagick::IMGTYPE_GRAYSCALEMATTE - (int) - - - - Des nuances de gris avec un canal alpha. - Identique à imagick::IMGTYPE_GRAYSCALE, sauf que le - canal alpha est conservé, et que si l'image n'en a pas, un canal opaque - est ajouté. - - - - - - imagick::IMGTYPE_PALETTE - (int) - - - - Couleurs indexées. - L'image est convertie en sRGB et, si elle n'est pas déjà indexée ou - qu'elle comporte plus de 256 couleurs, elle est quantifiée à 256 - couleurs ; tout canal alpha est abandonné. - - - - - - imagick::IMGTYPE_PALETTEMATTE - (int) - - - - Couleurs indexées avec un canal alpha. - L'image est convertie en sRGB, le canal alpha est conservé, et si l'image - n'en a pas, un canal opaque est ajouté. - Contrairement à imagick::IMGTYPE_PALETTE, les - couleurs sont quantifiées même lorsque l'image est déjà indexée, et le - canal alpha est inclus dans la quantification. - - - - - - imagick::IMGTYPE_TRUECOLOR - (int) - - - - Couleurs directes : une valeur de rouge, de vert et de bleu par pixel, - sans palette. - L'image est convertie en sRGB, et tout canal alpha est abandonné. - - - - - - imagick::IMGTYPE_TRUECOLORMATTE - (int) - - - - Couleurs directes avec un canal alpha. - Identique à imagick::IMGTYPE_TRUECOLOR, sauf que le - canal alpha est conservé, et que si l'image n'en a pas, un canal opaque - est ajouté. - - - - - - imagick::IMGTYPE_COLORSEPARATION - (int) - - - - Un canal par encre d'impression, sans palette. - L'image est convertie vers l'espace colorimétrique CMJN, et tout canal - alpha est abandonné. - - - - - - imagick::IMGTYPE_COLORSEPARATIONMATTE - (int) - - - - Un canal par encre d'impression, sans palette, plus un canal alpha. - Identique à imagick::IMGTYPE_COLORSEPARATION, sauf - que le canal alpha est conservé, et que si l'image n'en a pas, un canal - opaque est ajouté. - - - - - - imagick::IMGTYPE_PALETTEBILEVELMATTE - (int) - - - - Couleurs indexées avec un canal alpha entièrement transparent ou - entièrement opaque. - L'image est convertie en sRGB, un canal alpha opaque est ajouté si elle - n'en a pas, ce canal seul est réduit à deux valeurs, puis les couleurs - sont quantifiées. - C'est le type d'un PNG utilisant une transparence binaire. - - - - - - imagick::IMGTYPE_OPTIMIZE - (int) - - - - Imagick::setImageType ne convertit rien pour - cette valeur, mais l'enregistre tout de même sur l'image. - - - - - - - Constantes <constant>RESOLUTION_<replaceable>*</replaceable></constant> - - - - imagick::RESOLUTION_UNDEFINED - (int) - - - - - - - - - imagick::RESOLUTION_PIXELSPERINCH - (int) - - - - - - - - - imagick::RESOLUTION_PIXELSPERCENTIMETER - (int) - - - - - - - - - - Constantes <constant>COMPRESSION_<replaceable>*</replaceable></constant> - - - - imagick::COMPRESSION_UNDEFINED - (int) - - - - - - - - - imagick::COMPRESSION_NO - (int) - - - - - - - - - imagick::COMPRESSION_BZIP - (int) - - - - - - - - - imagick::COMPRESSION_FAX - (int) - - - - - - - - - imagick::COMPRESSION_GROUP4 - (int) - - - - - - - - - imagick::COMPRESSION_JPEG - (int) - - - - - - - - - imagick::COMPRESSION_JPEG2000 - (int) - - - - - - - - - imagick::COMPRESSION_LOSSLESSJPEG - (int) - - - - - - - - - imagick::COMPRESSION_LZW - (int) - - - - - - - - - imagick::COMPRESSION_RLE - (int) - - - - - - - - - imagick::COMPRESSION_ZIP - (int) - - - - - - - - - imagick::COMPRESSION_DXT1 - (int) - - - - &imagick.constant.available; 6.4.0 ou supérieur. - - - - - - imagick::COMPRESSION_DXT3 - (int) - - - - &imagick.constant.available; 6.4.0 ou supérieur. - - - - - - imagick::COMPRESSION_DXT5 - (int) - - - - &imagick.constant.available; 6.4.0 ou supérieur. - - - - - - - Constantes <constant>PAINT_<replaceable>*</replaceable></constant> - - - - imagick::PAINT_POINT - (int) - - - - - - - - - imagick::PAINT_REPLACE - (int) - - - - - - - - - imagick::PAINT_FLOODFILL - (int) - - - - - - - - - imagick::PAINT_FILLTOBORDER - (int) - - - - - - - - - imagick::PAINT_RESET - (int) - - - - - - - - - - Constantes <constant>GRAVITY_<replaceable>*</replaceable></constant> - - - - imagick::GRAVITY_NORTHWEST - (int) - - - - - - - - - imagick::GRAVITY_NORTH - (int) - - - - - - - - - imagick::GRAVITY_NORTHEAST - (int) - - - - - - - - - imagick::GRAVITY_WEST - (int) - - - - - - - - - imagick::GRAVITY_CENTER - (int) - - - - - - - - - imagick::GRAVITY_EAST - (int) - - - - - - - - - imagick::GRAVITY_SOUTHWEST - (int) - - - - - - - - - imagick::GRAVITY_SOUTH - (int) - - - - - - - - - imagick::GRAVITY_SOUTHEAST - (int) - - - - - - - - - - Constantes <constant>STRETCH_<replaceable>*</replaceable></constant> - - - - imagick::STRETCH_NORMAL - (int) - - - - - - - - - imagick::STRETCH_ULTRACONDENSED - (int) - - - - - - - - - imagick::STRETCH_CONDENSED - (int) - - - - - - - - - imagick::STRETCH_SEMICONDENSED - (int) - - - - - - - - - imagick::STRETCH_SEMIEXPANDED - (int) - - - - - - - - - imagick::STRETCH_EXPANDED - (int) - - - - - - - - - imagick::STRETCH_EXTRAEXPANDED - (int) - - - - - - - - - imagick::STRETCH_ULTRAEXPANDED - (int) - - - - - - - - - imagick::STRETCH_ANY - (int) - - - - - - - - - - Constantes <constant>ALIGN_<replaceable>*</replaceable></constant> - - - - imagick::ALIGN_UNDEFINED - (int) - - - - - - - - - imagick::ALIGN_LEFT - (int) - - - - - - - - - imagick::ALIGN_CENTER - (int) - - - - - - - - - imagick::ALIGN_RIGHT - (int) - - - - - - - - - - Constantes <constant>DECORATION_<replaceable>*</replaceable></constant> - - - - imagick::DECORATION_NO - (int) - - - - - - - - - imagick::DECORATION_UNDERLINE - (int) - - - - - - - - - imagick::DECORATION_OVERLINE - (int) - - - - - - - - - imagick::DECORATION_LINETROUGH - (int) - - - - - - - - - - Constantes <constant>NOISE_<replaceable>*</replaceable></constant> - - - - imagick::NOISE_UNIFORM - (int) - - - - - - - - - imagick::NOISE_GAUSSIAN - (int) - - - - - - - - - imagick::NOISE_MULTIPLICATIVEGAUSSIAN - (int) - - - - - - - - - imagick::NOISE_IMPULSE - (int) - - - - - - - - - imagick::NOISE_LAPLACIAN - (int) - - - - - - - - - imagick::NOISE_POISSON - (int) - - - - - - - - - imagick::NOISE_RANDOM - (int) - - - - &imagick.constant.available; 6.3.6 ou supérieur. - - - - - - - Constantes <constant>CHANNEL_<replaceable>*</replaceable></constant> - - - - imagick::CHANNEL_UNDEFINED - (int) - - - - - - - - - imagick::CHANNEL_RED - (int) - - - - - - - - - imagick::CHANNEL_GRAY - (int) - - - - - - - - - imagick::CHANNEL_CYAN - (int) - - - - - - - - - imagick::CHANNEL_GREEN - (int) - - - - - - - - - imagick::CHANNEL_MAGENTA - (int) - - - - - - - - - imagick::CHANNEL_BLUE - (int) - - - - - - - - - imagick::CHANNEL_YELLOW - (int) - - - - - - - - - imagick::CHANNEL_ALPHA - (int) - - - - - - - - - imagick::CHANNEL_OPACITY - (int) - - - - - - - - - imagick::CHANNEL_MATTE - (int) - - - - - - - - - imagick::CHANNEL_BLACK - (int) - - - - - - - - - imagick::CHANNEL_INDEX - (int) - - - - - - - - - imagick::CHANNEL_ALL - (int) - - - - - - - - - imagick::CHANNEL_DEFAULT - (int) - - - - - - - - - - Constantes <constant>METRIC_<replaceable>*</replaceable></constant> - - - - imagick::METRIC_UNDEFINED - (int) - - - - - - - - - imagick::METRIC_MEANABSOLUTEERROR - (int) - - - - - - - - - imagick::METRIC_MEANSQUAREERROR - (int) - - - - - - - - - imagick::METRIC_PEAKABSOLUTEERROR - (int) - - - - - - - - - imagick::METRIC_PEAKSIGNALTONOISERATIO - (int) - - - - - - - - - imagick::METRIC_ROOTMEANSQUAREDERROR - (int) - - - - - - - - - - Constantes <constant>PIXEL_<replaceable>*</replaceable></constant> - - - - imagick::PIXEL_CHAR - (int) - - - - - - - - - imagick::PIXEL_DOUBLE - (int) - - - - - - - - - imagick::PIXEL_FLOAT - (int) - - - - - - - - - imagick::PIXEL_INTEGER - (int) - - - - Seulement disponible avec ImageMagick < 7. - - - - - - imagick::PIXEL_LONG - (int) - - - - - - - - - imagick::PIXEL_QUANTUM - (int) - - - - - - - - - imagick::PIXEL_SHORT - (int) - - - - - - - - - - - Constantes <constant>EVALUATE_<replaceable>*</replaceable></constant> - - - - imagick::EVALUATE_UNDEFINED - (int) - - - - - - - - - imagick::EVALUATE_ADD - (int) - - - - - - - - - imagick::EVALUATE_AND - (int) - - - - - - - - - imagick::EVALUATE_DIVIDE - (int) - - - - - - - - - imagick::EVALUATE_LEFTSHIFT - (int) - - - - - - - - - imagick::EVALUATE_MAX - (int) - - - - - - - - - imagick::EVALUATE_MIN - (int) - - - - - - - - - imagick::EVALUATE_MULTIPLY - (int) - - - - - - - - - imagick::EVALUATE_OR - (int) - - - - - - - - - imagick::EVALUATE_RIGHTSHIFT - (int) - - - - - - - - - imagick::EVALUATE_SET - (int) - - - - - - - - - imagick::EVALUATE_SUBTRACT - (int) - - - - - - - - - imagick::EVALUATE_XOR - (int) - - - - - - - - - - imagick::EVALUATE_POW - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_LOG - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_THRESHOLD - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_THRESHOLDBLACK - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_THRESHOLDWHITE - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_GAUSSIANNOISE - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_IMPULSENOISE - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_LAPLACIANNOISE - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_MULTIPLICATIVENOISE - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_POISSONNOISE - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_UNIFORMNOISE - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_COSINE - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_SINE - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - imagick::EVALUATE_ADDMODULUS - (int) - - - - &imagick.constant.available; 6.4.4 ou supérieur. - - - - - - - Constantes <constant>COLORSPACE_<replaceable>*</replaceable></constant> - - - - imagick::COLORSPACE_UNDEFINED - (int) - - - - - - - - - imagick::COLORSPACE_RGB - (int) - - - - - - - - - imagick::COLORSPACE_GRAY - (int) - - - - - - - - - imagick::COLORSPACE_TRANSPARENT - (int) - - - - - - - - - imagick::COLORSPACE_OHTA - (int) - - - - - - - - - imagick::COLORSPACE_LAB - (int) - - - - - - - - - imagick::COLORSPACE_XYZ - (int) - - - - - - - - - imagick::COLORSPACE_YCBCR - (int) - - - - - - - - - imagick::COLORSPACE_YCC - (int) - - - - - - - - - imagick::COLORSPACE_YIQ - (int) - - - - - - - - - imagick::COLORSPACE_YPBPR - (int) - - - - - - - - - imagick::COLORSPACE_YUV - (int) - - - - - - - - - imagick::COLORSPACE_CMYK - (int) - - - - - - - - - imagick::COLORSPACE_SRGB - (int) - - - - - - - - - imagick::COLORSPACE_HSB - (int) - - - - - - - - - imagick::COLORSPACE_HSL - (int) - - - - - - - - - imagick::COLORSPACE_HWB - (int) - - - - - - - - - imagick::COLORSPACE_REC601LUMA - (int) - - - - - - - - - imagick::COLORSPACE_REC709LUMA - (int) - - - - - - - - - imagick::COLORSPACE_LOG - (int) - - - - - - - - - imagick::COLORSPACE_CMY - (int) - - - - &imagick.constant.available; 6.4.2 ou supérieur. - - - - - - - Constantes <constant>VIRTUALPIXELMETHOD_<replaceable>*</replaceable></constant> - - - - imagick::VIRTUALPIXELMETHOD_UNDEFINED - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_BACKGROUND - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_CONSTANT - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_EDGE - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_MIRROR - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_TILE - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_TRANSPARENT - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_MASK - (int) - - - - &imagick.constant.available; 6.4.2 ou supérieur. - - - - - - imagick::VIRTUALPIXELMETHOD_BLACK - (int) - - - - &imagick.constant.available; 6.4.2 ou supérieur. - - - - - - imagick::VIRTUALPIXELMETHOD_GRAY - (int) - - - - &imagick.constant.available; 6.4.2 ou supérieur. - - - - - - imagick::VIRTUALPIXELMETHOD_WHITE - (int) - - - - &imagick.constant.available; 6.4.2 ou supérieur. - - - - - - imagick::VIRTUALPIXELMETHOD_HORIZONTALTILE - (int) - - - - &imagick.constant.available; 6.4.3 ou supérieur. - - - - - - imagick::VIRTUALPIXELMETHOD_VERTICALTILE - (int) - - - - &imagick.constant.available; 6.4.3 ou supérieur. - - - - - - - Constantes <constant>PREVIEW_<replaceable>*</replaceable></constant> - - - - imagick::PREVIEW_UNDEFINED - (int) - - - - - - - - - imagick::PREVIEW_ROTATE - (int) - - - - - - - - - imagick::PREVIEW_SHEAR - (int) - - - - - - - - - imagick::PREVIEW_ROLL - (int) - - - - - - - - - imagick::PREVIEW_HUE - (int) - - - - - - - - - imagick::PREVIEW_SATURATION - (int) - - - - - - - - - imagick::PREVIEW_BRIGHTNESS - (int) - - - - - - - - - imagick::PREVIEW_GAMMA - (int) - - - - - - - - - imagick::PREVIEW_SPIFF - (int) - - - - - - - - - imagick::PREVIEW_DULL - (int) - - - - - - - - - imagick::PREVIEW_GRAYSCALE - (int) - - - - - - - - - imagick::PREVIEW_QUANTIZE - (int) - - - - - - - - - imagick::PREVIEW_DESPECKLE - (int) - - - - - - - - - imagick::PREVIEW_REDUCENOISE - (int) - - - - - - - - - imagick::PREVIEW_ADDNOISE - (int) - - - - - - - - - imagick::PREVIEW_SHARPEN - (int) - - - - - - - - - imagick::PREVIEW_BLUR - (int) - - - - - - - - - imagick::PREVIEW_THRESHOLD - (int) - - - - - - - - - imagick::PREVIEW_EDGEDETECT - (int) - - - - - - - - - imagick::PREVIEW_SPREAD - (int) - - - - - - - - - imagick::PREVIEW_SOLARIZE - (int) - - - - - - - - - imagick::PREVIEW_SHADE - (int) - - - - - - - - - imagick::PREVIEW_RAISE - (int) - - - - - - - - - imagick::PREVIEW_SEGMENT - (int) - - - - - - - - - imagick::PREVIEW_SWIRL - (int) - - - - - - - - - imagick::PREVIEW_IMPLODE - (int) - - - - - - - - - imagick::PREVIEW_WAVE - (int) - - - - - - - - - imagick::PREVIEW_OILPAINT - (int) - - - - - - - - - imagick::PREVIEW_CHARCOALDRAWING - (int) - - - - - - - - - imagick::PREVIEW_JPEG - (int) - - - - - - - - - - Constantes <constant>RENDERINGINTENT_<replaceable>*</replaceable></constant> - - - - imagick::RENDERINGINTENT_UNDEFINED - (int) - - - - - - - - - imagick::RENDERINGINTENT_SATURATION - (int) - - - - - - - - - imagick::RENDERINGINTENT_PERCEPTUAL - (int) - - - - - - - - - imagick::RENDERINGINTENT_ABSOLUTE - (int) - - - - - - - - - imagick::RENDERINGINTENT_RELATIVE - (int) - - - - - - - - - - Constantes <constant>INTERLACE_<replaceable>*</replaceable></constant> - - - - imagick::INTERLACE_UNDEFINED - (int) - - - - - - - - - imagick::INTERLACE_NO - (int) - - - - - - - - - imagick::INTERLACE_LINE - (int) - - - - - - - - - imagick::INTERLACE_PLANE - (int) - - - - - - - - - imagick::INTERLACE_PARTITION - (int) - - - - - - - - - imagick::INTERLACE_GIF - (int) - - - - &imagick.constant.available; 6.3.4 ou supérieur. - - - - - - imagick::INTERLACE_JPEG - (int) - - - - - - - - - imagick::INTERLACE_PNG - (int) - - - - - - - - - - Constantes <constant>FILLRULE_<replaceable>*</replaceable></constant> - - - - imagick::FILLRULE_UNDEFINED - (int) - - - - - - - - - imagick::FILLRULE_EVENODD - (int) - - - - - - - - - imagick::FILLRULE_NONZERO - (int) - - - - - - - - - - Constantes <constant>PATHUNITS_<replaceable>*</replaceable></constant> - - - - imagick::PATHUNITS_UNDEFINED - (int) - - - - - - - - - imagick::PATHUNITS_USERSPACE - (int) - - - - - - - - - imagick::PATHUNITS_USERSPACEONUSE - (int) - - - - - - - - - imagick::PATHUNITS_OBJECTBOUNDINGBOX - (int) - - - - - - - - - - Constantes <constant>LINECAP_<replaceable>*</replaceable></constant> - - - - imagick::LINECAP_UNDEFINED - (int) - - - - - - - - - imagick::LINECAP_BUTT - (int) - - - - - - - - - imagick::LINECAP_ROUND - (int) - - - - - - - - - imagick::LINECAP_SQUARE - (int) - - - - - - - - - - Constantes <constant>LINEJOIN_<replaceable>*</replaceable></constant> - - - - imagick::LINEJOIN_UNDEFINED - (int) - - - - - - - - - imagick::LINEJOIN_MITER - (int) - - - - - - - - - imagick::LINEJOIN_ROUND - (int) - - - - - - - - - imagick::LINEJOIN_BEVEL - (int) - - - - - - - - - - Constantes <constant>RESOURCETYPE_<replaceable>*</replaceable></constant> - - - - imagick::RESOURCETYPE_UNDEFINED - (int) - - - - - - - - - imagick::RESOURCETYPE_AREA - (int) - - - - Définit la largeur et la hauteur maximales d'une image - qui peut être mise dans la mémoire cache des pixels. - - - - - - imagick::RESOURCETYPE_DISK - (int) - - - - Définit la taille maximale de l'espace disque autorisée à stocker le cache - des pixels. - - - - - - imagick::RESOURCETYPE_FILE - (int) - - - - Définit le nombre maximal de fichiers de cache de pixels ouverts. - - - - - - imagick::RESOURCETYPE_MAP - (int) - - - - Définit la taille maximale de mémoire en octets, à allouer au cache - de pixels. - - - - - - imagick::RESOURCETYPE_MEMORY - (int) - - - - Définit la taille maximale de la mémoire, en octets, à allouer au cache - de pixels. - - - - - - imagick::RESOURCETYPE_THREAD - (int) - - - - Définit le nombre maximal de threads parallèles. - &imagick.constant.available; 6.7.8 ou supérieur. - - - - - - - Constantes <constant>LAYERMETHOD_<replaceable>*</replaceable></constant> - - - - imagick::LAYERMETHOD_UNDEFINED - (int) - - - - &imagick.constant.available; 6.2.9 ou supérieur. - - - - - - imagick::LAYERMETHOD_COALESCE - (int) - - - - &imagick.constant.available; 6.2.9 ou supérieur. - - - - - - imagick::LAYERMETHOD_COMPAREANY - (int) - - - - &imagick.constant.available; 6.2.9 ou supérieur. - - - - - - imagick::LAYERMETHOD_COMPARECLEAR - (int) - - - - &imagick.constant.available; 6.2.9 ou supérieur. - - - - - - imagick::LAYERMETHOD_COMPAREOVERLAY - (int) - - - - &imagick.constant.available; 6.2.9 ou supérieur. - - - - - - imagick::LAYERMETHOD_DISPOSE - (int) - - - - &imagick.constant.available; 6.2.9 ou supérieur. - - - - - - imagick::LAYERMETHOD_OPTIMIZE - (int) - - - - &imagick.constant.available; 6.2.9 ou supérieur. - - - - - - imagick::LAYERMETHOD_OPTIMIZEPLUS - (int) - - - - &imagick.constant.available; 6.2.9 ou supérieur. - - - - - - imagick::LAYERMETHOD_OPTIMIZEIMAGE - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::LAYERMETHOD_OPTIMIZETRANS - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::LAYERMETHOD_REMOVEDUPS - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::LAYERMETHOD_REMOVEZERO - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::LAYERMETHOD_COMPOSITE - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::LAYERMETHOD_MERGE - (int) - - - - &imagick.constant.available; 6.3.7 ou supérieur. - - - - - - imagick::LAYERMETHOD_FLATTEN - (int) - - - - &imagick.constant.available; 6.3.7 ou supérieur. - - - - - - imagick::LAYERMETHOD_MOSAIC - (int) - - - - &imagick.constant.available; 6.3.7 ou supérieur. - - - - - - - Constantes <constant>ORIENTATION_<replaceable>*</replaceable></constant> - - - - imagick::ORIENTATION_UNDEFINED - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::ORIENTATION_TOPLEFT - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::ORIENTATION_TOPRIGHT - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::ORIENTATION_BOTTOMRIGHT - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::ORIENTATION_BOTTOMLEFT - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::ORIENTATION_LEFTTOP - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::ORIENTATION_RIGHTTOP - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::ORIENTATION_RIGHTBOTTOM - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - imagick::ORIENTATION_LEFTBOTTOM - (int) - - - - &imagick.constant.available; 6.3.0 ou supérieur. - - - - - - - Constantes <constant>DISTORTION_<replaceable>*</replaceable></constant> - - - - imagick::DISTORTION_UNDEFINED - (int) - - - - &imagick.constant.available; 6.3.6 ou supérieur. - - - - - - imagick::DISTORTION_AFFINE - (int) - - - - &imagick.constant.available; 6.3.6 ou supérieur. - - - - - - imagick::DISTORTION_AFFINEPROJECTION - (int) - - - - &imagick.constant.available; 6.3.6 ou supérieur. - - - - - - imagick::DISTORTION_ARC - (int) - - - - &imagick.constant.available; 6.3.6 ou supérieur. - - - - - - imagick::DISTORTION_BILINEAR - (int) - - - - &imagick.constant.available; 6.3.6 ou supérieur. - - - - - - imagick::DISTORTION_PERSPECTIVE - (int) - - - - &imagick.constant.available; 6.3.6 ou supérieur. - - - - - - imagick::DISTORTION_PERSPECTIVEPROJECTION - (int) - - - - &imagick.constant.available; 6.3.6 ou supérieur. - - - - - - imagick::DISTORTION_SCALEROTATETRANSLATE - (int) - - - - &imagick.constant.available; 6.3.6 ou supérieur. - - - - - - imagick::DISTORTION_POLYNOMIAL - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::DISTORTION_POLAR - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::DISTORTION_DEPOLAR - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::DISTORTION_BARREL - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::DISTORTION_BARRELINVERSE - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::DISTORTION_SHEPARDS - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::DISTORTION_SENTINEL - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - - Constantes <constant>ALPHACHANNEL_<replaceable>*</replaceable></constant> - - - - imagick::ALPHACHANNEL_ACTIVATE - (int) - - - - &imagick.constant.available; 6.3.8 ou supérieur. - - - - - - imagick::ALPHACHANNEL_DEACTIVATE - (int) - - - - &imagick.constant.available; 6.3.8 ou supérieur. - - - - - - imagick::ALPHACHANNEL_RESET - (int) - - - - &imagick.constant.available; 6.3.8 ou supérieur. - - - - - - imagick::ALPHACHANNEL_SET - (int) - - - - &imagick.constant.available; 6.3.8 ou supérieur. - - - - - - imagick::ALPHACHANNEL_UNDEFINED - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::ALPHACHANNEL_COPY - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::ALPHACHANNEL_EXTRACT - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::ALPHACHANNEL_OPAQUE - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::ALPHACHANNEL_SHAPE - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::ALPHACHANNEL_TRANSPARENT - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::ALPHACHANNEL_BACKGROUND - (int) - - - - &imagick.constant.available; 6.5.3 ou supérieur. - - - - - - imagick::ALPHACHANNEL_REMOVE - (int) - - - - &imagick.constant.available; 6.7.8 ou supérieur. - - - - - - imagick::ALPHACHANNEL_ASSOCIATE - (int) - - - - &imagick.constant.available; 6.9.0 ou supérieur. - - - - - - imagick::ALPHACHANNEL_DISSOCIATE - (int) - - - - &imagick.constant.available; 6.9.0 ou supérieur. - - - - - - imagick::ALPHACHANNEL_ON - (int) - - - - &imagick.constant.available; 7.0.0 ou supérieur. - - - - - - imagick::ALPHACHANNEL_OFF - (int) - - - - &imagick.constant.available; 7.0.0 ou supérieur. - - - - - - imagick::ALPHACHANNEL_DISCRETE - (int) - - - - &imagick.constant.available; 7.0.0 ou supérieur. - - - - - - - Constantes <constant>SPARSECOLORMETHOD_<replaceable>*</replaceable></constant> - - - - imagick::SPARSECOLORMETHOD_UNDEFINED - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::SPARSECOLORMETHOD_BARYCENTRIC - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::SPARSECOLORMETHOD_BILINEAR - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::SPARSECOLORMETHOD_POLYNOMIAL - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::SPARSECOLORMETHOD_SPEPARDS - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::SPARSECOLORMETHOD_VORONOI - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - - Constantes <constant>FUNCTION_<replaceable>*</replaceable></constant> - - - - imagick::FUNCTION_UNDEFINED - (int) - - - - &imagick.constant.available; 6.4.9 ou supérieur. - - - - - - imagick::FUNCTION_POLYNOMIAL - (int) - - - - &imagick.constant.available; 6.4.9 ou supérieur. - - - - - - imagick::FUNCTION_SINUSOID - (int) - - - - &imagick.constant.available; 6.4.9 ou supérieur. - - - - - - - Constantes <constant>INTERPOLATE_<replaceable>*</replaceable></constant> - - - - imagick::INTERPOLATE_UNDEFINED - (int) - - - - &imagick.constant.available; 6.3.2 ou supérieur. - - - - - - imagick::INTERPOLATE_AVERAGE - (int) - - - - &imagick.constant.available; 6.3.2 ou supérieur. - - - - - - imagick::INTERPOLATE_BICUBIC - (int) - - - - &imagick.constant.available; 6.3.2 ou supérieur. - - - - - - imagick::INTERPOLATE_BILINEAR - (int) - - - - &imagick.constant.available; 6.3.2 ou supérieur. - - - - - - imagick::INTERPOLATE_FILTER - (int) - - - - &imagick.constant.available; 6.3.2 ou supérieur. - - - - - - imagick::INTERPOLATE_INTEGER - (int) - - - - &imagick.constant.available; 6.3.2 ou supérieur. - - - - - - imagick::INTERPOLATE_MESH - (int) - - - - &imagick.constant.available; 6.3.2 ou supérieur. - - - - - - imagick::INTERPOLATE_NEARESTNEIGHBOR - (int) - - - - &imagick.constant.available; 6.3.2 ou supérieur. - - - - - - imagick::INTERPOLATE_SPLINE - (int) - - - - &imagick.constant.available; 6.3.4 ou supérieur. - - - - - - - Constantes <constant>DITHERMETHOD_<replaceable>*</replaceable></constant> - - - - imagick::DITHERMETHOD_UNDEFINED - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::DITHERMETHOD_NO - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::DITHERMETHOD_RIEMERSMA - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - imagick::DITHERMETHOD_FLOYDSTEINBERG - (int) - - - - &imagick.constant.available; 6.4.6 ou supérieur. - - - - - - - diff --git a/reference/imagick/examples.xml b/reference/imagick/examples.xml deleted file mode 100644 index 8677a948f5..0000000000 --- a/reference/imagick/examples.xml +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - - &reftitle.examples; -
- Utilisation simple - - Imagick rend la manipulation des images via PHP extrêmement facile - grâce à une interface orientée objet. Voici un exemple rapide - illustrant la création d'une miniature : - - Création d'une miniature avec Imagick - -thumbnailImage(100, 0); - -echo $image; - -?> -]]> - - - - - - En utilisant SPL ou toute autre fonctionnalité orientée objet supportée - par Imagick, il devient simple de redimensionner tous les fichiers - d'un dossier (utile pour des scripts batch redimensionnant des images - issues d'un appareil photo numérique afin de les rendre lisibles sur le - web). Voici un exemple de redimensionnement de toutes les images - JPG d'un dossier, tout en conservant les métadonnées : - - Création de miniature de toutes les images JPG d'un dossier - -thumbnailImage(1024,0); - -} - -$images->writeImages(); - -?> -]]> - - - - - Voici un exemple permettant de créer le reflet d'une image. Ce reflet est créé en - retournant l'image et en y ajoutant un dégradé. - Ensuite, l'image originale et son reflet sont ajoutés dans une nouvelle image. - - Création d'un reflet sur une image - -thumbnailImage(200, null); - -/* Création d'une bordure */ -$im->borderImage(new ImagickPixel("white"), 5, 5); - -/* Clône l'image et on la retourne */ -$reflection = $im->clone(); -$reflection->flipImage(); - -/* Création du dégradé. Il sera ajouté à l'image retournée */ -$gradient = new Imagick(); - -/* Le dégradé doit être assez large pour l'image et ses bordures */ -$gradient->newPseudoImage($reflection->getImageWidth() + 10, $reflection->getImageHeight() + 10, "gradient:transparent-black"); - -/* Ajout du dégradé sur l'image retournée */ -$reflection->compositeImage($gradient, imagick::COMPOSITE_OVER, 0, 0); - -/* Ajout d'un peu d'opacité. Nécessite ImageMagick 6.2.9 ou supérieur */ -$reflection->setImageOpacity( 0.3 ); - -/* Création d'une image vide */ -$canvas = new Imagick(); - -/* L'image vide doit être assez large pour contenir les 2 images */ -$width = $im->getImageWidth() + 40; -$height = ($im->getImageHeight() * 2) + 30; -$canvas->newImage($width, $height, new ImagickPixel("black")); -$canvas->setImageFormat("png"); - -/* Ajout de l'image originale et de l'image retournée dans notre nouvelle image */ -$canvas->compositeImage($im, imagick::COMPOSITE_OVER, 20, 10); -$canvas->compositeImage($reflection, imagick::COMPOSITE_OVER, 20, $im->getImageHeight() + 10); - -/* Affichage de l'image */ -header("Content-Type: image/png"); -echo $canvas; -?> -]]> - - &example.outputs.similar; - - Affichage de l'exemple : Création d'un reflet sur une image - - - - - - - - Voici un exemple montrant comment remplir un masque lors du dessin de l'image. - - Remplissage d'un texte avec un dégradé - -newPseudoImage(50, 50, "gradient:red-black"); - -/* Création d'un nouvel objet imagickdraw */ -$draw = new ImagickDraw(); - -/* On commence un nouveau masque nommé "gradient" */ -$draw->pushPattern('gradient', 0, 0, 50, 50); - -/* Ajout du dégradé sur le masque */ -$draw->composite(Imagick::COMPOSITE_OVER, 0, 0, 50, 50, $im); - -/* Fermeture du masque */ -$draw->popPattern(); - -/* Utilisation du masque nommé "gradient" comme remplissage */ -$draw->setFillPatternURL('#gradient'); - -/* Définition de la taille du texte à 52 */ -$draw->setFontSize(52); - -/* Ajout d'un texte */ -$draw->annotation(20, 50, "Bonjour le monde !"); - -/* Création d'un nouvel objet et d'une image blanche */ -$canvas = new Imagick(); -$canvas->newImage(350, 70, "white"); - -/* Dessine le ImagickDraw sur la nouvelle image */ -$canvas->drawImage($draw); - -/* Une bordure noire d'un pixel autour de l'image */ -$canvas->borderImage('black', 1, 1); - -/* Définition du format à PNG */ -$canvas->setImageFormat('png'); - -/* Affiche l'image */ -header("Content-Type: image/png"); -echo $canvas; -?> -]]> - - &example.outputs.similar; - - Affichage de l'exemple : Remplissage d'un texte avec un dégradé - - - - - - - - Exemple avec des images GIF animées - - Lit une image GIF et redimensionne toutes les frames - -thumbnailImage(50, 50); - - /* Définit le canevas virtuel à la bonne taille */ - $frame->setImagePage(50, 50, 0, 0); -} - -/* Notez l'utilisation de writeImages au lieu de writeImage */ -$im->writeImages("example_small.gif", true); -?> -]]> - - - - - Exemple avec des ellipses primitives et des polices personnalisées - - Création d'un logo PHP - -newImage($width, $height, new ImagickPixel('transparent')); - -/* Nouvelle instance ImagickDraw pour dessiner l'ellipse */ -$draw = new ImagickDraw(); -/* Définit la couleur violette pour remplir l'ellipse */ -$draw->setFillColor('#777bb4'); -/* Définit les dimensions de l'ellipse */ -$draw->ellipse($width / 2, $height / 2, $width / 2, $height / 2, 0, 360); -/* Dessine l'ellipse dans la toile */ -$img->drawImage($draw); - -/* Réinitialise la couleur de remplissage, passant du violet au noir pour le texte (note : nous ré-utilisons l'objet ImagickDraw) */ -$draw->setFillColor('black'); -/* Définit à blanc la couleur du trait de la bordure */ -$draw->setStrokeColor('white'); -/* Rend plus fin le trait de la bordure */ -$draw->setStrokeWidth(2); -/* Définit le crénage de la police (une valeur négative signifie que les lettres sont proches les unes des autres) */ -$draw->setTextKerning(-8); -/* Définit la police et sa taille à utiliser dans le logo PHP */ -$draw->setFont('Handel Gothic.ttf'); -$draw->setFontSize(150); -/* On centre le texte horizontalement et verticalement */ -$draw->setGravity(Imagick::GRAVITY_CENTER); - -/* Ajout de "php" au centre, avec une position en Y de -10 dans la toile (à l'intérieur de l'ellipse) */ -$img->annotateImage($draw, 0, -10, 0, 'php'); -$img->setImageFormat('png'); - -/* On définit l'en-tête approprié pour le PNG et on affiche l'image */ -header('Content-Type: image/png'); -echo $img; -?> - -]]> - - &example.outputs.similar; - - Affichage de l'exemple : Création d'un logo PHP avec Imagick - - - - - - -
- - - diff --git a/reference/imagick/imagick.xml b/reference/imagick/imagick.xml deleted file mode 100644 index 1afc776a97..0000000000 --- a/reference/imagick/imagick.xml +++ /dev/null @@ -1,775 +0,0 @@ - - - - - - La classe <classname>Imagick</classname> - Imagick - -
- &reftitle.classsynopsis; - - Imagick - - Imagick - - Iterator - - - - - - - - - -
- -
- Méthodes Image et méthodes globales - - La classe Imagick permet d'agir sur plusieurs images simultanément et ce, - grâce à une pile interne. Il y a toujours un pointeur interne, pointant - sur l'image courante. Quelques fonctions agissent sur toutes les images - d'une classe Imagick, mais la plupart uniquement sur l'image courante - au regard de cette pile. Tout comme les conversions, les noms des méthodes - peuvent contenir le nom de l'image, relatant uniquement l'effet - sur l'image de la pile. - -
- -
- Méthodes de la classe - - Vu le nombre de méthodes, voici une liste les présentant de façon générale : - - - - Méthodes de la classe - - - - Effets sur l'image - Méthodes de récupération - Méthodes de définition - Lecture/écriture de l'image - Autres - - - - - - Imagick::adaptiveBlurImage - Imagick::getCompression - Imagick::setBackgroundColor - Imagick::__construct - Imagick::clear - - - Imagick::adaptiveResizeImage - Imagick::getFilename - Imagick::setCompressionQuality - Imagick::addImage - Imagick::clone - - - Imagick::adaptiveSharpenImage - Imagick::getFormat - Imagick::setCompression - Imagick::appendImages - Imagick::current - - - Imagick::adaptiveThresholdImage - Imagick::getImageBackgroundColor - Imagick::setFilename - Imagick::getFilename - Imagick::destroy - - - Imagick::addNoiseImage - Imagick::getImageBlob - Imagick::getImagesBlob - Imagick::setFormat - Imagick::getFormat - - - Imagick::affinetransformimage - Imagick::getImageBluePrimary - Imagick::setImageBackgroundColor - Imagick::getImageFilename - Imagick::getHomeURL - - - Imagick::annotateImage - Imagick::getImageBorderColor - Imagick::setFirstIterator - Imagick::getImageFormat - Imagick::commentImage - - - Imagick::averageImages - Imagick::getImageChannelDepth - Imagick::setImageBias - Imagick::getImage - Imagick::getNumberImages - - - Imagick::blackThresholdImage - Imagick::getImageChannelDistortion - Imagick::setImageBluePrimary - Imagick::setImageFilename - Imagick::getReleaseDate - - - Imagick::blurImage - Imagick::getImageChannelExtrema - Imagick::setImageBorderColor - Imagick::setImageFormat - Imagick::getVersion - - - Imagick::borderImage - Imagick::getImageChannelMean - Imagick::setImageChannelDepth - Imagick::readImageFile - Imagick::hasNextImage - - - Imagick::charcoalImage - Imagick::getImageChannelStatistics - Imagick::setImageColormapColor - Imagick::readImage - Imagick::hasPreviousImage - - - Imagick::chopImage - Imagick::getImageColormapColor - Imagick::setImageColorSpace - Imagick::writeImages - Imagick::labelImage - - - Imagick::clipImage - Imagick::getImageColorspace - Imagick::setImageCompose - Imagick::writeImage - Imagick::newImage - - - Imagick::clipPathImage - Imagick::getImageColors - Imagick::setImageCompression - - Imagick::newPseudoImage - - - Imagick::coalesceImages - Imagick::getImageCompose - Imagick::setImageDelay - - Imagick::nextImage - - - Imagick::colorFloodFillImage - Imagick::getImageDelay - Imagick::setImageDepth - - Imagick::pingImageBlob - - - Imagick::colorizeImage - Imagick::getImageDepth - Imagick::setImageDispose - - Imagick::pingImageFile - - - Imagick::combineImages - Imagick::getImageDispose - Imagick::setImageDispose - - Imagick::pingImage - - - Imagick::compareImageChannels - Imagick::getImageDistortion - Imagick::setImageExtent - - Imagick::previousImage - - - Imagick::compareImageLayers - Imagick::getImageExtrema - Imagick::setImageFilename - - Imagick::profileImage - - - Imagick::compositeImage - Imagick::getImageFilename - Imagick::setImageFormat - - Imagick::queryFormats - - - Imagick::contrastImage - Imagick::getImageFormat - Imagick::setImageGamma - - Imagick::removeImageProfile - - - Imagick::contrastStretchImage - Imagick::getImageGamma - Imagick::setImageGreenPrimary - - Imagick::removeImage - - - Imagick::convolveImage - Imagick::getImageGeometry - Imagick::setImageIndex - - Imagick::setFirstIterator - - - Imagick::cropImage - Imagick::getImageGreenPrimary - Imagick::setImageInterpolateMethod - - Imagick::setImageIndex - - - Imagick::cycleColormapImage - Imagick::getImageHeight - Imagick::setImageIterations - - Imagick::valid - - - Imagick::deconstructImages - Imagick::getImageHistogram - Imagick::setImageMatteColor - - Imagick::getCopyright - - - Imagick::drawImage - Imagick::getImageIndex - Imagick::setImageMatte - - - - - Imagick::edgeImage - Imagick::getImageInterlaceScheme - Imagick::setImagePage - - - - - Imagick::embossImage - Imagick::getImageInterpolateMethod - Imagick::setImageProfile - - - - - Imagick::enhanceImage - Imagick::getImageIterations - Imagick::setImageProperty - - - - - Imagick::equalizeImage - Imagick::getImageMatteColor - Imagick::setImageRedPrimary - - - - - Imagick::evaluateImage - Imagick::getImageMatte - Imagick::setImageRenderingIntent - - - - - Imagick::flattenImages - Imagick::getImagePage - Imagick::setImageResolution - - - - - Imagick::flipImage - Imagick::getImagePixelColor - Imagick::setImageScene - - - - - Imagick::flopImage - Imagick::getImageProfile - Imagick::setImageTicksPerSecond - - - - - - Imagick::getImageProperty - Imagick::setImageType - - - - - Imagick::fxImage - Imagick::getImageRedPrimary - Imagick::setImageUnits - - - - - Imagick::gammaImage - Imagick::getImageRegion - Imagick::setImageVirtualPixelMethod - - - - - Imagick::gaussianBlurImage - Imagick::getImageRenderingIntent - Imagick::setImageWhitepoint - - - - - Imagick::implodeImage - Imagick::getImageResolution - Imagick::setInterlaceScheme - - - - - Imagick::levelImage - Imagick::getImageScene - Imagick::setOption - - - - - Imagick::linearStretchImage - Imagick::getImageSignature - Imagick::setPage - - - - - Imagick::magnifyImage - Imagick::getImageTicksPerSecond - Imagick::setResolution - - - - - Imagick::matteFloodFillImage - Imagick::getImageTotalInkDensity - Imagick::setResourceLimit - - - - - Imagick::medianFilterImage - Imagick::getImageType - Imagick::setSamplingFactors - - - - - Imagick::minifyImage - Imagick::getImageUnits - Imagick::setSizeOffset - - - - - Imagick::modulateImage - Imagick::getImageVirtualPixelMethod - Imagick::setSize - - - - - Imagick::montageImage - Imagick::getImageWhitepoint - Imagick::setType - - - - - Imagick::morphImages - Imagick::getImageWidth - - - - - - Imagick::mosaicImages - Imagick::getImage - - - - - - Imagick::motionBlurImage - Imagick::getInterlaceScheme - - - - - - Imagick::negateImage - Imagick::getNumberImages - - - - - - Imagick::normalizeImage - Imagick::getOption - - - - - - Imagick::oilPaintImage - Imagick::getPackageName - - - - - - Imagick::optimizeImageLayers - Imagick::getPage - - - - - - Imagick::paintOpaqueImage - Imagick::getPixelIterator - - - - - - Imagick::paintTransparentImage - Imagick::getPixelRegionIterator - - - - - - Imagick::posterizeImage - - Imagick::getQuantumDepth - - - - - - Imagick::radialBlurImage - Imagick::getQuantumRange - - - - - - Imagick::raiseImage - Imagick::getResourceLimit - - - - - - Imagick::randomThresholdImage - Imagick::getResource - - - - - - Imagick::reduceNoiseImage - Imagick::getSamplingFactors - - - - - - Imagick::render - Imagick::getSizeOffset - - - - - - Imagick::resampleImage - Imagick::getSize - - - - - - Imagick::resizeImage - Imagick::identifyImage - - - - - - Imagick::rollImage - Imagick::getImageSize - - - - - - Imagick::rotateImage - - - - - - - Imagick::sampleImage - - - - - - - Imagick::scaleImage - - - - - - - Imagick::separateImageChannel - - - - - - - Imagick::sepiaToneImage - - - - - - - Imagick::shadeImage - - - - - - - Imagick::shadowImage - - - - - - - Imagick::sharpenImage - - - - - - - Imagick::shaveImage - - - - - - - Imagick::shearImage - - - - - - - Imagick::sigmoidalContrastImage - - - - - - - Imagick::sketchImage - - - - - - - Imagick::solarizeImage - - - - - - - Imagick::spliceImage - - - - - - - Imagick::spreadImage - - - - - - - Imagick::steganoImage - - - - - - - Imagick::stereoImage - - - - - - - Imagick::stripImage - - - - - - - Imagick::swirlImage - - - - - - - Imagick::textureImage - - - - - - - Imagick::thresholdImage - - - - - - - Imagick::thumbnailImage - - - - - - - Imagick::tintImage - - - - - - - Imagick::transverseImage - - - - - - - Imagick::trimImage - - - - - - - Imagick::uniqueImageColors - - - - - - - Imagick::unsharpMaskImage - - - - - - - Imagick::vignetteImage - - - - - - - Imagick::waveImage - - - - - - - Imagick::whiteThresholdImage - - - - - - - -
-
- - &reference.imagick.entities.imagick; - - - diff --git a/reference/imagick/imagick/adaptiveblurimage.xml b/reference/imagick/imagick/adaptiveblurimage.xml deleted file mode 100644 index 63e2914b7d..0000000000 --- a/reference/imagick/imagick/adaptiveblurimage.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - Imagick::adaptiveBlurImage - Ajoute un flou adaptatif à l'image - - - - &reftitle.description; - - public boolImagick::adaptiveBlurImage - floatradius - floatsigma - intchannelImagick::CHANNEL_DEFAULT - - - Ajoute un flou adaptatif à l'image. L'intensité du flou est diminuée aux - bords de l'image, mais uniforme au centre. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - radius - - - Le rayon de la gaussienne, en pixels, sans compter le centre. - Avec une valeur de 0, le rayon sera choisi automatiquement. - - - - - sigma - - - La déviation standard de la gaussienne, en pixels. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::adaptiveBlurImage</function> - - Flou adaptatif d'une image, puis affichage au navigateur. - - -adaptiveBlurImage(5,3); -echo $image; - -?> -]]> - - &example.outputs.similar; - - Affichage de l'exemple : Utilisation de Imagick::adaptiveBlurImage() - - - - - - - - - - &reftitle.seealso; - - - Imagick::blurImage - Imagick::motionBlurImage - Imagick::radialBlurImage - - - - - - - diff --git a/reference/imagick/imagick/adaptiveresizeimage.xml b/reference/imagick/imagick/adaptiveresizeimage.xml deleted file mode 100644 index 79bb2effe0..0000000000 --- a/reference/imagick/imagick/adaptiveresizeimage.xml +++ /dev/null @@ -1,186 +0,0 @@ - - - - - Imagick::adaptiveResizeImage - Redimensionne adaptativement une image par triangulation - - - - &reftitle.description; - - public boolImagick::adaptiveResizeImage - intcolumns - introws - boolbestfit&false; - boollegacy&false; - - - Redimensionne une image adaptativement par triangulation. Cette fonction - évite les effets de flou dans les images à contraste fort. Elle fonctionne - au mieux avec des images qu'il faut réduire légèrement à une taille - Web standard; ne fonctionne pas toujours quand il faut réduire une - grosse image à une miniature. - &imagick.method.available.0x629; - - &imagick.bestfit.note; - - - - &reftitle.parameters; - - - - columns - - - Le nombre de colonnes dans l'image cible. - - - - - rows - - - Le nombre de lignes dans l'image cible. - - - - - bestfit - - - Indique si l'image doit tenir dans les dimensions données - tout en conservant les proportions. - - - - - legacy - - - Paramètre optionnel de type bool. - Si défini à &true;, les calculs sont effectués avec le léger bogue - d'arrondi qui existait dans Imagick avant la version 3.4.0. Si défini - à &false;, les calculs produisent les mêmes résultats que les outils - en ligne de commande d'ImageMagick. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - Ajout d'un paramètre optionnel de fit. - - - PECL imagick 2.1.0 - - Cette méthode supporte maintenant - la mise à l'échelle proportionnelle. Utiliser la valeur zéro comme - paramètre pour une mise à l'échelle proportionnelle. - - - - PECL imagick 3.4.0 - - Ajout du paramètre legacy. - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::adaptiveResizeImage</function> - - Redimensionne une image à une taille standard pour le Web. Cette méthode - fonctionne au mieux lorsqu'il faut redimensionner à une taille légèrement - inférieure à l'image précédente. - - -adaptiveResizeImage(1024,768); - -echo $image; -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::chopImage - Imagick::cropImage - Imagick::magnifyImage - Imagick::minifyImage - Imagick::resizeImage - Imagick::scaleImage - Imagick::shaveImage - Imagick::thumbnailImage - Imagick::trimImage - - - - - - - diff --git a/reference/imagick/imagick/adaptivesharpenimage.xml b/reference/imagick/imagick/adaptivesharpenimage.xml deleted file mode 100644 index 5c32d01ca3..0000000000 --- a/reference/imagick/imagick/adaptivesharpenimage.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - Imagick::adaptiveSharpenImage - Augmente le contraste de l'image - - - - &reftitle.description; - - public boolImagick::adaptiveSharpenImage - floatradius - floatsigma - intchannelImagick::CHANNEL_DEFAULT - - - Augmente le contraste adaptativement, en l'augmentant au niveau des bords, - et en le diminuant dans le cœur. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - radius - - - Le rayon de la gaussienne, en pixels, sans compter - le pixel du centre. Utiliser 0 pour l'auto-sélection. - - - - - sigma - - - La déviation standard de la gaussienne, en pixels. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::adaptiveSharpenImage</function> - - Augmente le contraste de l'image avec un rayon de 2 et un sigma de 1. - - -adaptiveSharpenImage(2,1); -} catch(ImagickException $e) { - echo 'Erreur : ' , $e->getMessage(); - die(); -} -header('Content-type: image/png'); -echo $image; -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::sharpenImage - - - - - - - diff --git a/reference/imagick/imagick/adaptivethresholdimage.xml b/reference/imagick/imagick/adaptivethresholdimage.xml deleted file mode 100644 index 094bfcb8d0..0000000000 --- a/reference/imagick/imagick/adaptivethresholdimage.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - Imagick::adaptiveThresholdImage - Sélectionne le niveau de chaque pixel, à partir d'un intervalle d'intensité - - - - &reftitle.description; - - public boolImagick::adaptiveThresholdImage - intwidth - intheight - intoffset - - - Sélectionne un seuil individuel pour chaque pixel, en se basant sur l'intervalle - des valeurs d'intensité dans son voisinage local. Cela permet d'appliquer un seuillage - à une image dont l'histogramme global d'intensité ne contient pas de pic distinct. - - - - - &reftitle.parameters; - - - - width - - - La largeur du voisinage local. - - - - - height - - - La hauteur du voisinage local. - - - - - offset - - - Le décalage de la moyenne. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::adaptiveThresholdImage</function> - -adaptiveThresholdImage($width, $height, $adaptiveOffsetQuantum); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/addimage.xml b/reference/imagick/imagick/addimage.xml deleted file mode 100644 index dbd94c9cde..0000000000 --- a/reference/imagick/imagick/addimage.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - Imagick::addImage - Ajoute une nouvelle image à la liste d'images Imagick - - - - &reftitle.description; - - public boolImagick::addImage - Imagicksource - - - Ajoute une nouvelle image à la liste d'images Imagick, à partir de la position - courante de l'objet source. Après cette opération, l'itérateur est placé à la - fin de la liste. - - - - - &reftitle.parameters; - - - - source - - - L'objet source Imagick. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/addnoiseimage.xml b/reference/imagick/imagick/addnoiseimage.xml deleted file mode 100644 index 0d562276b9..0000000000 --- a/reference/imagick/imagick/addnoiseimage.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - Imagick::addNoiseImage - Ajoute un bruit aléatoire à une image - - - - &reftitle.description; - - public boolImagick::addNoiseImage - intnoise_type - intchannelImagick::CHANNEL_DEFAULT - - - Ajoute un bruit aléatoire à une image. - - - - - &reftitle.parameters; - - - - noise_type - - - Le type de bruit, dans la liste des - constantes de bruit. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::addNoiseImage</function> - -addNoiseImage($noiseType, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/affinetransformimage.xml b/reference/imagick/imagick/affinetransformimage.xml deleted file mode 100644 index 649616b53d..0000000000 --- a/reference/imagick/imagick/affinetransformimage.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - Imagick::affineTransformImage - Transforme une image - - - - &reftitle.description; - - public boolImagick::affineTransformImage - ImagickDrawmatrix - - - Transforme une image, à l'aide d'une matrice affine. - - - - - &reftitle.parameters; - - - - matrix - - - La matrice affine. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::affineTransformImage</function> - - cos($angle), "sy" => cos($angle), - "rx" => sin($angle), "ry" => -sin($angle), - "tx" => 0, "ty" => 0, - ); - - $draw->affine($affineRotate); - - $imagick->affineTransformImage($draw); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/animateimages.xml b/reference/imagick/imagick/animateimages.xml deleted file mode 100644 index af86862c68..0000000000 --- a/reference/imagick/imagick/animateimages.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - Imagick::animateImages - Anime une ou plusieurs images - - - - &reftitle.description; - - public boolImagick::animateImages - stringx_server - - - Cette méthode anime l'image sur un serveur X local ou distant. Cette méthode - n'est pas disponible sur Windows. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - x_server - - - Adresse du serveur X. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::displayImage - - - - - - - diff --git a/reference/imagick/imagick/annotateimage.xml b/reference/imagick/imagick/annotateimage.xml deleted file mode 100644 index 2f8de2d854..0000000000 --- a/reference/imagick/imagick/annotateimage.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - - Imagick::annotateImage - Annote une image avec un texte - - - - &reftitle.description; - - public boolImagick::annotateImage - ImagickDrawdraw_settings - floatx - floaty - floatangle - stringtext - - - Annote une image avec un texte. - - - - - &reftitle.parameters; - - - - draw_settings - - - L'objet ImagickDraw qui contient les - directives pour dessiner le texte - - - - - x - - - La position horizontale du texte, en pixels depuis la gauche du texte - - - - - y - - - La position verticale du texte, en pixels depuis la ligne de base du texte - - - - - angle - - - L'angle auquel écrire le texte - - - - - text - - - La chaîne à dessiner - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::annotateImage</function> - - Annote un texte dans une image vide - - -newImage(800, 75, $pixel); - -/* Texte noir */ -$draw->setFillColor('black'); - -/* Propriétés du texte */ -$draw->setFont('Bookman-DemiItalic'); -$draw->setFontSize( 30 ); - -/* Création du texte */ -$image->annotateImage($draw, 10, 45, 0, 'The quick brown fox jumps over the lazy dog'); - -/* Format de l'image */ -$image->setImageFormat('png'); - -/* Affichage de l'image avec les entêtes */ -header('Content-type: image/png'); -echo $image; - -?> -]]> - - - - - - - &reftitle.seealso; - - - ImagickDraw::annotation - ImagickDraw::setFont - - - - - - - diff --git a/reference/imagick/imagick/appendimages.xml b/reference/imagick/imagick/appendimages.xml deleted file mode 100644 index 4010a84b43..0000000000 --- a/reference/imagick/imagick/appendimages.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - Imagick::appendImages - Ajoute un jeu d'images - - - - &reftitle.description; - - public ImagickImagick::appendImages - boolstack - - - Ajoute un jeu d'images dans une image plus large. - - - - - &reftitle.parameters; - - - - stack - - - Si l'on doit placer les images dans la pile de façon - verticale. Par défaut (ou si &false; est spécifié), les - images sont placées dans la pile de gauche à droite. Si - le paramètre stack vaut &true;, - les images sont placées dans la pile de haut en bas. - - - - - - - - - &reftitle.returnvalues; - - Retourne un nouvel objet Imagick en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <methodname>Imagick::appendImages</methodname> - -newImage(100, 50, "red"); -$im->newImage(100, 50, "green"); -$im->newImage(100, 50, "blue"); - -/* Ajoute les images dans une autre */ -$im->resetIterator(); -$combined = $im->appendImages(true); - -/* Affiche l'image */ -$combined->setImageFormat("png"); -header("Content-Type: image/png"); -echo $combined; -?> -]]> - - &example.outputs.similar; - - Affichage de l'exemple : Imagick::appendImages() - - - - - - - - - - - diff --git a/reference/imagick/imagick/autolevelimage.xml b/reference/imagick/imagick/autolevelimage.xml deleted file mode 100644 index 899ade10e3..0000000000 --- a/reference/imagick/imagick/autolevelimage.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Imagick::autoLevelImage - Ajuste le niveau d'un canal d'une image particulière - - - - &reftitle.description; - - public boolImagick::autoLevelImage - intchannelImagick::CHANNEL_DEFAULT - - - Ajuste le niveau d'un canal d'une image particulière en mettant à l'échelle les valeurs minimales et maximales à la plage quantique complète. - - - - - - &reftitle.parameters; - - - channel - - - Quel canal doit être utilisé pour l'auto-nivellement. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::autoLevelImage</function> - - autoLevelImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/averageimages.xml b/reference/imagick/imagick/averageimages.xml deleted file mode 100644 index c690dd06aa..0000000000 --- a/reference/imagick/imagick/averageimages.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::averageImages - Moyenne d'un jeu d'images - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::averageImages - - - - Fait la moyenne d'un jeu d'images. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un nouvel objet Imagick en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/blackthresholdimage.xml b/reference/imagick/imagick/blackthresholdimage.xml deleted file mode 100644 index 249301fa7a..0000000000 --- a/reference/imagick/imagick/blackthresholdimage.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - Imagick::blackThresholdImage - Force tous les pixels en dessous d'un seuil à noir - - - - &reftitle.description; - - public boolImagick::blackThresholdImage - mixedthreshold - - - Équivalent de la fonction Imagick::thresholdImage, mais - force tous les pixels en dessous du seuil threshold - en noir, et laisse les autres pixels inchangés. - - - - - &reftitle.parameters; - - - - threshold - - - Le seuil en dessous duquel tout doit devenir noir - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet désormais l'utilisation d'une chaîne pour représenter la couleur. - Les versions précédentes ne permettaient que les objets - ImagickPixel. - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::blackThresholdImage</function> - -blackthresholdimage($thresholdColor); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/blueshiftimage.xml b/reference/imagick/imagick/blueshiftimage.xml deleted file mode 100644 index bacfaabd8d..0000000000 --- a/reference/imagick/imagick/blueshiftimage.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Imagick::blueShiftImage - Atténue les couleurs de l'image - - - - &reftitle.description; - - public boolImagick::blueShiftImage - floatfactor1.5 - - - - Atténue les couleurs de l'image pour simuler une scène nocturne à la lumière de la lune. - - - - - - - - &reftitle.parameters; - - - factor - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::blueShiftImage</function> - - blueShiftImage($blueShift); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/blurimage.xml b/reference/imagick/imagick/blurimage.xml deleted file mode 100644 index 7e65ccf830..0000000000 --- a/reference/imagick/imagick/blurimage.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - Imagick::blurImage - Ajoute un filtre de flou à une image - - - - &reftitle.description; - - public boolImagick::blurImage - floatradius - floatsigma - intchannel - - - Ajoute un filtre de flou à une image. Le troisième paramètre - channel, optionnel, - ajoute le flou à un canal particulier. - - - - - &reftitle.parameters; - - - - radius - - - Le rayon du flou - - - - - sigma - - - La déviation standard - - - - - channel - - - La constante de type de canal. - Si elle n'est pas fournie, tous les canaux sont utilisés. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::blurImage</function> - - Ajoute du flou à une image, puis affiche dans le navigateur. - - -blurImage(5,3); -echo $image; - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::adaptiveBlurImage - Imagick::motionBlurImage - Imagick::radialBlurImage - - - - - - - diff --git a/reference/imagick/imagick/borderimage.xml b/reference/imagick/imagick/borderimage.xml deleted file mode 100644 index 0715d8ffce..0000000000 --- a/reference/imagick/imagick/borderimage.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - - Imagick::borderImage - Encadre une image avec un bord - - - - &reftitle.description; - - public boolImagick::borderImage - mixedbordercolor - intwidth - intheight - - - Encadre une image avec un bord de couleur, défini par l'attribut - bordercolor d'un objet ImagickPixel. - - - - - &reftitle.parameters; - - - - bordercolor - - - Objet ImagickPixel ou une chaîne contenant - la couleur du bord - - - - - width - - - La largeur du bord - - - - - height - - - La hauteur du bord - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet désormais l'utilisation d'une chaîne pour représenter la couleur. - Les versions précédentes ne permettaient que les objets - ImagickPixel. - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::borderImage</function> - -borderImage($color, $width, $height); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/brightnesscontrastimage.xml b/reference/imagick/imagick/brightnesscontrastimage.xml deleted file mode 100644 index 06511e4150..0000000000 --- a/reference/imagick/imagick/brightnesscontrastimage.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Imagick::brightnessContrastImage - Change la luminosité et/ou le contraste d'une image - - - - &reftitle.description; - - public boolImagick::brightnessContrastImage - floatbrightness - floatcontrast - intchannelImagick::CHANNEL_DEFAULT - - - Change la luminosité et/ou le contraste d'une image. Il convertit les paramètres de luminosité et de contraste en pente et en ordonnée à l'origine et appelle une fonction polynomiale à appliquer à l'image. - - - - - - &reftitle.parameters; - - - brightness - - - - - - - - contrast - - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::brightnessContrastImage</function> - - brightnessContrastImage($brightness, $contrast, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/charcoalimage.xml b/reference/imagick/imagick/charcoalimage.xml deleted file mode 100644 index 97144db9ba..0000000000 --- a/reference/imagick/imagick/charcoalimage.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - Imagick::charcoalImage - Simule un dessin au fusain - - - - &reftitle.description; - - public boolImagick::charcoalImage - floatradius - floatsigma - - - Simule un dessin au fusain - - - - - &reftitle.parameters; - - - - radius - - - Le rayon de la gaussienne, en pixels, sans - compter le pixel du centre - - - - - sigma - - - La déviation standard de la gaussienne, en pixels - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::charcoalImage</function> - -charcoalImage($radius, $sigma); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/chopimage.xml b/reference/imagick/imagick/chopimage.xml deleted file mode 100644 index cfdc8ca328..0000000000 --- a/reference/imagick/imagick/chopimage.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - - Imagick::chopImage - Supprime une région d'une image et retaille - - - - &reftitle.description; - - public boolImagick::chopImage - intwidth - intheight - intx - inty - - - Supprime une région d'une image, retaille et - déplace le reste de l'image pour occuper la portion coupée. - - - - - &reftitle.parameters; - - - - width - - - La largeur de la région à retirer - - - - - height - - - La hauteur de la région à retirer - - - - - x - - - L'abscisse de la région retirée - - - - - y - - - L'ordonnée de la région retirée - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::chopImage</function> - - Exemple avec Imagick::chopImage - - -newImage(400, 200, $pixel); - -/* Découpe l'image */ -$image->chopImage(200, 200, 0, 0); - -/* Donne un format à l'image */ -$image->setImageFormat('png'); - -/* Envoie l'image */ -header('Content-type: image/png'); -echo $image; - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::cropImage - - - - - - - diff --git a/reference/imagick/imagick/clampimage.xml b/reference/imagick/imagick/clampimage.xml deleted file mode 100644 index e22f9be550..0000000000 --- a/reference/imagick/imagick/clampimage.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Imagick::clampImage - Restreint la plage de couleurs de 0 à la profondeur quantique - - - - &reftitle.description; - - public boolImagick::clampImage - intchannelImagick::CHANNEL_DEFAULT - - - Restreint la plage de couleurs de 0 à la profondeur quantique. - - - - - - - &reftitle.parameters; - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/imagick/imagick/clear.xml b/reference/imagick/imagick/clear.xml deleted file mode 100644 index 5c3fbddc03..0000000000 --- a/reference/imagick/imagick/clear.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::clear - Libère toutes les ressources associées à un objet Imagick - - - - &reftitle.description; - - public boolImagick::clear - - - - Libère toutes les ressources associées à un objet Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/clipimage.xml b/reference/imagick/imagick/clipimage.xml deleted file mode 100644 index ef0c2d0b95..0000000000 --- a/reference/imagick/imagick/clipimage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::clipImage - Découpe le long du premier chemin du profil 8BIM - - - - &reftitle.description; - - public boolImagick::clipImage - - - - Découpe le long du premier chemin du profil 8BIM, si présent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/clipimagepath.xml b/reference/imagick/imagick/clipimagepath.xml deleted file mode 100644 index a69ee78e69..0000000000 --- a/reference/imagick/imagick/clipimagepath.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Imagick::clipImagePath - Découpe le long des chemins nommés du profil 8BIM, si présent - - - - &reftitle.description; - - public voidImagick::clipImagePath - stringpathname - stringinside - - - Découpe le long des chemins nommés du profil 8BIM, si présent. Les opérations ultérieures prennent effet à l'intérieur du chemin. Id peut être un nombre s'il est précédé de #, pour travailler sur un chemin numéroté, par exemple, "#1" pour utiliser le premier chemin. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - pathname - - - - - - - - inside - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagick/clippathimage.xml b/reference/imagick/imagick/clippathimage.xml deleted file mode 100644 index 8f7e518d98..0000000000 --- a/reference/imagick/imagick/clippathimage.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - Imagick::clipPathImage - Découpe le long du chemin d'un profil 8BIM - - - - &reftitle.description; - - public boolImagick::clipPathImage - stringpathname - boolinside - - - Découpe le long du chemin d'un profil 8BIM, s'il est présent. - Les opérations suivantes auront lieu dans ce chemin. - Cela peut être un nombre, s'il est précédé par #, pour - utiliser un chemin numéroté, p. ex. "#1" pour utiliser le - premier chemin. - - - - - &reftitle.parameters; - - - - pathname - - - Le nom du chemin - - - - - inside - - - Si &true; les prochaines opérations auront lieu dans le chemin. - Sinon, les prochaines opérations auront lieu hors du chemin. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/clone.xml b/reference/imagick/imagick/clone.xml deleted file mode 100644 index c1a2a185fb..0000000000 --- a/reference/imagick/imagick/clone.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - Imagick::clone - Fait une copie exacte d'un objet Imagick - - - - &reftitle.description; - - public ImagickImagick::clone - - - - Fait une copie exacte d'un objet Imagick. - - - - Cette fonction est devenue OBSOLETE à partir d'imagick 3.1.0. - Il faut désormais utiliser le mot clé - clone. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une copie de l'objet Imagick. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 3.1.0 - - Cette méthode est devenue obsolète en faveur du mot clé - clone. - - - - - - - - - - &reftitle.examples; - - - Clonage d'objet Imagick avec différentes versions d'Imagick - - clone(); - -// Clonage d'un objet Imagick à partir de la version 3.1.0 : -$newImage = clone $image; -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/clutimage.xml b/reference/imagick/imagick/clutimage.xml deleted file mode 100644 index b11f6fe053..0000000000 --- a/reference/imagick/imagick/clutimage.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - - Imagick::clutImage - Remplace les couleurs d'une image - - - - &reftitle.description; - - public boolImagick::clutImage - Imagicklookup_table - intchannelImagick::CHANNEL_DEFAULT - - - Remplace les couleurs dans l'image à l'aide d'une table de correspondance. - Un second paramètre optionnel remplace les couleurs dans un canal particulier. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - lookup_table - - - Un objet Imagick contenant la table de correspondance - - - - - channel - - - La constante de - type de canal. - S'il n'est pas fourni, les canaux par défaut sont utilisés. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::clutImage</function> - - Remplace les couleurs dans une image à partir d'une table de correspondance - - -newImage(1, 1, new ImagickPixel('black')); -$image->clutImage($clut); -$image->writeImage('test_out.jpg'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::adaptiveBlurImage - Imagick::motionBlurImage - Imagick::radialBlurImage - - - - - - - diff --git a/reference/imagick/imagick/coalesceimages.xml b/reference/imagick/imagick/coalesceimages.xml deleted file mode 100644 index ab628fd24c..0000000000 --- a/reference/imagick/imagick/coalesceimages.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Imagick::coalesceImages - Compose un jeu d'images - - - - &reftitle.description; - - public ImagickImagick::coalesceImages - - - - Compose un jeu d'images en respectant toutes les positions et - les méthodes de dispositions. Les séquences d'animations - GIF, MIFF, et MNG, commencent typiquement par une image de - fond, puis toutes les images suivantes varient en taille et - position. Retourne un nouvel objet Imagick où chaque image - de la séquence est de la même taille que la première, et composée - avec la suivante dans la séquence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un nouvel objet Imagick en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/colorfloodfillimage.xml b/reference/imagick/imagick/colorfloodfillimage.xml deleted file mode 100644 index 4baf3fc77d..0000000000 --- a/reference/imagick/imagick/colorfloodfillimage.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - - Imagick::colorFloodfillImage - Change la couleur d'un pixel - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::colorFloodfillImage - mixedfill - floatfuzz - mixedbordercolor - intx - inty - - - Change la couleur d'un pixel qui correspond à une cible, et - ses voisins immédiats. - - - - - &reftitle.parameters; - - - - fill - - - L'objet ImagickPixel contenant la couleur de remplissage - - - - - fuzz - - - La quantité de bruit. Par exemple, un bruit de 10 et la couleur - rouge à l'intensité de 100 et 102, respectivement, sont maintenant - interprétés comme la même couleur, dans le cadre de ce remplissage. - - - - - bordercolor - - - L'objet ImagickPixel contenant la couleur de frontière - - - - - x - - - L'abscisse de début de remplissage - - - - - y - - - L'ordonnée de début de remplissage - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet maintenant à une chaîne représentant la couleur comme - premier argument et troisième paramètre. Les versions précédentes - n'autorisaient que les objets ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/colorizeimage.xml b/reference/imagick/imagick/colorizeimage.xml deleted file mode 100644 index eb2555038a..0000000000 --- a/reference/imagick/imagick/colorizeimage.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - - Imagick::colorizeImage - Mélange la couleur de remplissage avec l'image - - - - &reftitle.description; - - public boolImagick::colorizeImage - mixedcolorize - mixedopacity - boollegacy&false; - - - Mélange la couleur de remplissage avec l'image. - - - - - &reftitle.parameters; - - - - colorize - - - L'objet ImagickPixel ou une chaîne contenant la couleur de colorisation - - - - - opacity - - - L'objet ImagickPixel ou un nombre décimal contenant la valeur - de l'opacité. 1.0 est totalement opaque, et 0.0 est totalement - transparent. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Maintenant, permet à une chaîne représentant la couleur comme premier - argument et un décimal représentant l'opacité comme second paramètre. - Les versions précédentes ne permettaient que l'utilisation d'objets - ImagickPixel. - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::colorizeImage</function> - -colorizeImage($color, $opacityColor); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/colormatriximage.xml b/reference/imagick/imagick/colormatriximage.xml deleted file mode 100644 index 826b203a6b..0000000000 --- a/reference/imagick/imagick/colormatriximage.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Imagick::colorMatrixImage - Applique une transformation de couleur à une image - - - - &reftitle.description; - - public boolImagick::colorMatrixImage - arraycolor_matrix - - - Applique une transformation de couleur à une image. La méthode permet des changements de saturation, une rotation de teinte, une luminance en alpha, et divers autres effets. Bien que des matrices de transformation de taille variable puissent être utilisées, on utilise généralement une matrice 5x5 pour une image RGBA et une 6x6 pour CMYKA (ou RGBA avec des décalages). La matrice est similaire à celles utilisées par Adobe Flash, sauf que les décalages sont dans la colonne 6 plutôt que 5 (en support des images CMYKA) et les décalages sont normalisés (diviser le décalage Flash par 255). - - - - - - - &reftitle.parameters; - - - color_matrix - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::colorMatrixImage</function> - - setImageOpacity(1); - - //Une matrice de couleur devrait ressembler à: - // $colorMatrix = [ - // 1.5, 0.0, 0.0, 0.0, 0.0, -0.157, - // 0.0, 1.0, 0.5, 0.0, 0.0, -0.157, - // 0.0, 0.0, 1.5, 0.0, 0.0, -0.157, - // 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, - // 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, - // 0.0, 0.0, 0.0, 0.0, 0.0, 1.0 - // ]; - - $background = new \Imagick(); - $background->newPseudoImage($imagick->getImageWidth(), $imagick->getImageHeight(), "pattern:checkerboard"); - - $background->setImageFormat('png'); - - $imagick->setImageFormat('png'); - $imagick->colorMatrixImage($colorMatrix); - - $background->compositeImage($imagick, \Imagick::COMPOSITE_ATOP, 0, 0); - - header("Content-Type: image/png"); - echo $background->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/combineimages.xml b/reference/imagick/imagick/combineimages.xml deleted file mode 100644 index 31f9667357..0000000000 --- a/reference/imagick/imagick/combineimages.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - Imagick::combineImages - Combine plusieurs images en une seule - - - - &reftitle.description; - - public ImagickImagick::combineImages - intchannelType - - - Combine une ou plusieurs images en une seule. Les niveaux de gris - des pixels de chaque image en séquence sont assignés en ordre à - des canaux spécifiés de l'image combinée. L'ordre typique - serait image 1 => Rouge, 2 => Vert, - 3 => Bleu, etc. - - - - - &reftitle.parameters; - - - - channelType - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/commentimage.xml b/reference/imagick/imagick/commentimage.xml deleted file mode 100644 index 385ac2cc09..0000000000 --- a/reference/imagick/imagick/commentimage.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - Imagick::commentImage - Ajoute un commentaire à une image - - - - &reftitle.description; - - public boolImagick::commentImage - stringcomment - - - Ajoute un commentaire à une image. - - - - - &reftitle.parameters; - - - - comment - - - Le commentaire à ajouter. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::commentImage</function> - - Ajout d'un commentaire d'image et lecture du commentaire - - -newImage(100, 100, new ImagickPixel("red")); - -/* Ajoute un commentaire à une image */ -$im->commentImage("Bonjour le monde!"); - -/* Affichage du commentaire */ -echo $im->getImageProperty("comment"); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/compareimagechannels.xml b/reference/imagick/imagick/compareimagechannels.xml deleted file mode 100644 index a755aa31d0..0000000000 --- a/reference/imagick/imagick/compareimagechannels.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - Imagick::compareImageChannels - Retourne la différence entre plusieurs images - - - - &reftitle.description; - - public arrayImagick::compareImageChannels - Imagickimage - intchannelType - intmetricType - - - Compare une ou plusieurs images et retourne la différence. - - - - - &reftitle.parameters; - - - - image - - - un objet Imagick contenant l'image à comparer - - - - - channelType - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - metricType - - - Une des constantes de type de métrique. - - - - - - - - - &reftitle.returnvalues; - - Un tableau contenant new_wand et - distortion. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/compareimagelayers.xml b/reference/imagick/imagick/compareimagelayers.xml deleted file mode 100644 index b20f019dfb..0000000000 --- a/reference/imagick/imagick/compareimagelayers.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - - Imagick::compareImageLayers - Retourne la région d'encadrement maximale entre deux images - - - - &reftitle.description; - - public ImagickImagick::compareImageLayers - intmethod - - - - Compare chaque image avec la suivante, dans la séquence, et retourne - la région d'encadrement maximale de chaque pixel différent entre les - images. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - method - - - Une des - constantes de méthode de couche. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::compareImageLayers</function> - - Comparaison de deux calques d'image - - -compareImageLayers(imagick::LAYERMETHOD_COALESCE); - -/* Travail sur le résultat */ -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::optimizeImageLayers - Imagick::writeImages - Imagick::writeImage - - - - - - diff --git a/reference/imagick/imagick/compareimages.xml b/reference/imagick/imagick/compareimages.xml deleted file mode 100644 index 80cd37cb83..0000000000 --- a/reference/imagick/imagick/compareimages.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - Imagick::compareImages - Compare une image avec une image reconstituée - - - - &reftitle.description; - - public arrayImagick::compareImages - Imagickcompare - intmetric - - - Retourne un tableau contenant l'image reconstituée et les différences - entre les images. - - - - - &reftitle.parameters; - - - - compare - - - Une image à comparer. - - - - - metric - - - Une constante de type de métrique. Voir la liste des - constantes de métriques. - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant une image reconstruite et la différence entre les images. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::compareImages</function> - - Compare des images et affiche l'image reconstituée - - -compareImages($image2, Imagick::METRIC_MEANSQUAREERROR); -$result[0]->setImageFormat("png"); - -header("Content-Type: image/png"); -echo $result[0]; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/compositeimage.xml b/reference/imagick/imagick/compositeimage.xml deleted file mode 100644 index 0753bef2a3..0000000000 --- a/reference/imagick/imagick/compositeimage.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - Imagick::compositeImage - Compose une image avec une autre - - - - &reftitle.description; - - public boolImagick::compositeImage - Imagickcomposite_object - intcomposite - intx - inty - intchannelImagick::CHANNEL_DEFAULT - - - Compose une image dans une autre, à la position donnée. Tout paramètre - supplémentaire nécessaire à l'algorithme de composition doit être passé à - setImageArtifact avec comme premier paramètre 'compose:args' et les données - en second paramètre. - - - - - &reftitle.parameters; - - - - composite_object - - - Objet Imagick qui contient l'image composite - - - - - compose - - - L'opérateur de composition. Voir la liste des constantes d'opérateurs de composition - - - - - x - - - La colonne de position dans l'image composée - - - - - y - - - La ligne de position dans l'image composée - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Utilisation de <function>Imagick::compositeImage</function> - - Compose deux images avec la méthode de composition 'mathematics'. - - -setImageVirtualPixelMethod(Imagick::VIRTUALPIXELMETHOD_TRANSPARENT); -$src1->setImageArtifact('compose:args', "1,0,-0.5,0.5"); -$src1->compositeImage($src2, Imagick::COMPOSITE_MATHEMATICS, 0, 0); -$src1->writeImage("./output.png"); - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::setImageArtifact - - - - - - - diff --git a/reference/imagick/imagick/construct.xml b/reference/imagick/imagick/construct.xml deleted file mode 100644 index 9ccb9c568e..0000000000 --- a/reference/imagick/imagick/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - Imagick::__construct - Le constructeur Imagick - - - - &reftitle.description; - - public Imagick::__construct - mixedfiles - - - Crée une instance Imagick pour une image spécifique ou pour un - jeu d'images. - - - - - &reftitle.parameters; - - - files - - - Le chemin jusqu'à l'image à charger, ou un tableau de chemins. - Ils peuvent inclure des jokers dans les noms des fichiers, ou - peuvent être des URLs. - - - - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/contrastimage.xml b/reference/imagick/imagick/contrastimage.xml deleted file mode 100644 index 9678e1e6d2..0000000000 --- a/reference/imagick/imagick/contrastimage.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - Imagick::contrastImage - Change le contraste de l'image - - - - &reftitle.description; - - public boolImagick::contrastImage - boolsharpen - - - Améliore l'intensité des différences entre les éléments - clairs et sombres de l'image. Donner une valeur différente - de zéro pour améliorer le contraste, et sinon, - il sera réduit. - - - - - &reftitle.parameters; - - - - sharpen - - - La valeur de contraste. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::contrastImage</function> - -contrastImage($contrastType); - } - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/contraststretchimage.xml b/reference/imagick/imagick/contraststretchimage.xml deleted file mode 100644 index 9e44b61834..0000000000 --- a/reference/imagick/imagick/contraststretchimage.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - Imagick::contrastStretchImage - Améliore le contraste d'une image - - - - &reftitle.description; - - public boolImagick::contrastStretchImage - floatblack_point - floatwhite_point - intchannelImagick::CHANNEL_DEFAULT - - - Améliore le contraste d'une image en ajustant les couleurs - des pixels sur l'ensemble de la gamme des couleurs. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - black_point - - - Le point noir. - - - - - white_point - - - Le point blanc. - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Par défaut, c'est - Imagick::CHANNEL_ALL. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/convolveimage.xml b/reference/imagick/imagick/convolveimage.xml deleted file mode 100644 index 6b7d56dc7c..0000000000 --- a/reference/imagick/imagick/convolveimage.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - Imagick::convolveImage - Applique un noyau de convolution à une image - - - - &reftitle.description; - - public boolImagick::convolveImage - arraykernel - intchannelImagick::CHANNEL_DEFAULT - - - Applique un noyau de convolution à une image. - - - - - &reftitle.parameters; - - - - kernel - - - Le noyau de convolution - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::convolveImage</function> - -setImageBias($bias * \Imagick::getQuantum()); - $imagick->convolveImage($kernelMatrix); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/count.xml b/reference/imagick/imagick/count.xml deleted file mode 100644 index 1926230844..0000000000 --- a/reference/imagick/imagick/count.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Imagick::count - Renvoie le nombre d'images - - - - &reftitle.description; - - public intImagick::count - intmode0 - - - Renvoie le nombre d'images. - - - - - - &reftitle.parameters; - - - mode - - - Un argument non utilisé. Actuellement, il existe une fonctionnalité non particulièrement bien définie en PHP où l'appel de count() sur un objet comptable pourrait (ou non) nécessiter que cette méthode accepte un paramètre. Ce paramètre est ici pour être conforme à l'interface de countable, même si le paramètre n'est pas utilisé. - - - - - - - - &reftitle.returnvalues; - - Renvoie le nombre d'images. - - - - - - - diff --git a/reference/imagick/imagick/cropimage.xml b/reference/imagick/imagick/cropimage.xml deleted file mode 100644 index 8cc293b90a..0000000000 --- a/reference/imagick/imagick/cropimage.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - Imagick::cropImage - Extrait une région d'une image - - - - &reftitle.description; - - public boolImagick::cropImage - intwidth - intheight - intx - inty - - - Extrait une région d'une image. - - - - - &reftitle.parameters; - - - - width - - - La largeur du retaillage - - - - - height - - - La hauteur du retaillage - - - - - x - - - L'abscisse, coordonnée X, de la région retaillée, coin haut gauche - - - - - y - - - L'ordonnée, coordonnée Y, de la région retaillée, coin haut gauche - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::cropImage</function> - -cropImage($width, $height, $startX, $startY); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/cropthumbnailimage.xml b/reference/imagick/imagick/cropthumbnailimage.xml deleted file mode 100644 index f264732d84..0000000000 --- a/reference/imagick/imagick/cropthumbnailimage.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - Imagick::cropThumbnailImage - Crée une miniature par retaillage - - - - &reftitle.description; - - public boolImagick::cropThumbnailImage - intwidth - intheight - boollegacy&false; - - - Crée une miniature de taille fixe, en agrandissant ou en réduisant sa taille, en - recadrant l'image autour du centre. - - - - - &reftitle.parameters; - - - - width - - - La largeur de la miniature - - - - - height - - - La hauteur de la miniature - - - - - legacy - - - Paramètre optionnel de type bool. - Si défini à &true;, les calculs sont effectués avec le léger bogue - d'arrondi qui existait dans Imagick avant la version 3.4.0. Si défini - à &false;, les calculs produisent les mêmes résultats que les outils - en ligne de commande d'ImageMagick. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 3.4.0 - - Ajout du paramètre legacy. - - - - - - - - - - diff --git a/reference/imagick/imagick/current.xml b/reference/imagick/imagick/current.xml deleted file mode 100644 index ae4d2b1225..0000000000 --- a/reference/imagick/imagick/current.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::current - Retourne une référence sur l'objet imagick courant - - - - &reftitle.description; - - public ImagickImagick::current - - - - Retourne une référence sur l'objet courant, à partir d'une - référence de séquence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne self en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/cyclecolormapimage.xml b/reference/imagick/imagick/cyclecolormapimage.xml deleted file mode 100644 index f2d2325317..0000000000 --- a/reference/imagick/imagick/cyclecolormapimage.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - Imagick::cycleColormapImage - Déplace la carte des couleurs d'une image - - - - &reftitle.description; - - public boolImagick::cycleColormapImage - intdisplace - - - Déplace la carte de couleurs, d'un nombre donné de positions. Si l'on - fait tourner la carte des couleurs plusieurs fois, il est possible de - produire des effets psychédéliques. - - - - - &reftitle.parameters; - - - - displace - - - Le déplacement de la carte des couleurs. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/decipherimage.xml b/reference/imagick/imagick/decipherimage.xml deleted file mode 100644 index 3094a22bfb..0000000000 --- a/reference/imagick/imagick/decipherimage.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - Imagick::decipherImage - Déchiffre une image - - - - &reftitle.description; - - public boolImagick::decipherImage - stringpassphrase - - - Déchiffre une image. L'image doit être chiffrée - à l'aide de la fonction Imagick::encipherImage. - &imagick.method.available.0x639; - - - - - &reftitle.parameters; - - - - passphrase - - - Le mot de passe. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::encipherImage - - - - - - - diff --git a/reference/imagick/imagick/deconstructimages.xml b/reference/imagick/imagick/deconstructimages.xml deleted file mode 100644 index 2f10dcfa5a..0000000000 --- a/reference/imagick/imagick/deconstructimages.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::deconstructImages - Retourne les différences de certains pixels entre deux images - - - - &reftitle.description; - - public ImagickImagick::deconstructImages - - - - Compare chaque image avec la suivante dans la séquence, et retourne - la région maximale d'encadrement des pixels différents qu'il découvre. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un nouvel objet Imagick en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/deleteimageartifact.xml b/reference/imagick/imagick/deleteimageartifact.xml deleted file mode 100644 index 0b6708d80e..0000000000 --- a/reference/imagick/imagick/deleteimageartifact.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - Imagick::deleteImageArtifact - Supprime l'artefact d'une image - - - - &reftitle.description; - - public boolImagick::deleteImageArtifact - stringartifact - - - Supprime un artefact associé à l'image. La différence entre les propriétés de l'image - et les artefacts de l'image est que les propriétés sont publiques, alors que les artefacts - sont privés. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - - - - artifact - - - Le nom de l'artefact à supprimer. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.seealso; - - - Imagick::setImageArtifact - Imagick::getImageArtifact - - - - - - - diff --git a/reference/imagick/imagick/deleteimageproperty.xml b/reference/imagick/imagick/deleteimageproperty.xml deleted file mode 100644 index 1e629481da..0000000000 --- a/reference/imagick/imagick/deleteimageproperty.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Imagick::deleteImageProperty - Supprime une propriété d'image - - - - &reftitle.description; - - public boolImagick::deleteImageProperty - stringname - - - Supprime une propriété d'image. - - - - - - &reftitle.parameters; - - - name - - - Le nom de la propriété à supprimer. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagick/deskewimage.xml b/reference/imagick/imagick/deskewimage.xml deleted file mode 100644 index 2c81168762..0000000000 --- a/reference/imagick/imagick/deskewimage.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - Imagick::deskewImage - Supprime le biais de l'image - - - - &reftitle.description; - - public boolImagick::deskewImage - floatthreshold - - - Cette méthode peut être utilisée pour supprimer le biais depuis, par exemple, - les images scannées où le papier n'a pas été placé correctement sur la surface. - &imagick.method.available.0x645; - - - - - &reftitle.parameters; - - - - threshold - - - Seuil de redressement. - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::deskewImage</function> - -deskewImage($threshold); - - // Le reste de l'exemple ne fait que rendre le résultat évident - - // sans cela, la modification ne serait pas tellement visible. - $trim = 9; - - $deskewImagick->cropImage($deskewImagick->getImageWidth() - $trim, $deskewImagick->getImageHeight(), $trim, 0); - $imagick->cropImage($imagick->getImageWidth() - $trim, $imagick->getImageHeight(), $trim, 0); - $deskewImagick->resizeimage($deskewImagick->getImageWidth() / 2, $deskewImagick->getImageHeight() / 2, \Imagick::FILTER_LANCZOS, 1); - $imagick->resizeimage($imagick->getImageWidth() / 2, $imagick->getImageHeight() / 2, \Imagick::FILTER_LANCZOS, 1); - $newCanvas = new \Imagick(); - $newCanvas->newimage($imagick->getImageWidth() + $deskewImagick->getImageWidth() + 20, $imagick->getImageHeight(), 'red', 'jpg'); - $newCanvas->compositeimage($imagick, \Imagick::COMPOSITE_COPY, 5, 0); - $newCanvas->compositeimage($deskewImagick, \Imagick::COMPOSITE_COPY, $imagick->getImageWidth() + 10, 0); - - header("Content-Type: image/jpg"); - echo $newCanvas->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/despeckleimage.xml b/reference/imagick/imagick/despeckleimage.xml deleted file mode 100644 index 84bfb640db..0000000000 --- a/reference/imagick/imagick/despeckleimage.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - Imagick::despeckleImage - Réduit le bruit speckle d'une image - - - - &reftitle.description; - - public boolImagick::despeckleImage - - - - Réduit le bruit speckle d'une image, en préservant les bords - de l'image originale. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::despeckleImage</function> - -despeckleImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/destroy.xml b/reference/imagick/imagick/destroy.xml deleted file mode 100644 index 7070483919..0000000000 --- a/reference/imagick/imagick/destroy.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - Imagick::destroy - Détruit un objet Imagick - - - - &reftitle.description; - - public boolImagick::destroy - - - - Détruit l'objet Imagick et libère toutes les ressources associées. - Cette méthode est obsolète, en faveur de la méthode - Imagick::clear. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/displayimage.xml b/reference/imagick/imagick/displayimage.xml deleted file mode 100644 index e33d2bac0a..0000000000 --- a/reference/imagick/imagick/displayimage.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - Imagick::displayImage - Affiche une image - - - - &reftitle.description; - - public boolImagick::displayImage - stringservername - - - Cette méthode affiche une image sur un serveur X. - - - - - &reftitle.parameters; - - - - servername - - - Le nom du serveur X - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/displayimages.xml b/reference/imagick/imagick/displayimages.xml deleted file mode 100644 index 3efa8ed974..0000000000 --- a/reference/imagick/imagick/displayimages.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - Imagick::displayImages - Affiche une image ou une séquence - - - - &reftitle.description; - - public boolImagick::displayImages - stringservername - - - Affiche une image ou une séquence sur un serveur X. - - - - - &reftitle.parameters; - - - - servername - - - Le nom du serveur X - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/distortimage.xml b/reference/imagick/imagick/distortimage.xml deleted file mode 100644 index 50084f9b05..0000000000 --- a/reference/imagick/imagick/distortimage.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - - Imagick::distortImage - Déforme une image avec différentes méthodes - - - - &reftitle.description; - - public boolImagick::distortImage - intmethod - arrayarguments - boolbestfit - - - Déforme une image en utilisant différentes méthodes, en associant - des couleurs de l'image source à celle d'une image de destination, - généralement de la même taille, à moins que l'argument - bestfit soit configuré à &true;. - - - Si bestfit est activé, et que la déformation le permet, - l'image de destination est ajustée pour s'assurer que toute l'image source va - tenir dans l'image de destination, qui sera redimensionnée et repositionnée - en fonction. De plus, dans de nombreux cas, la position virtuelle de - l'image sera prise en compte dans l'association. - - - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - method - - - La méthode de déformation de l'image. Voir les constantes de déformation - - - - - arguments - - - Les arguments de cette méthode de déformation - - - - - bestfit - - - Tentative de redimensionnement de l'image de destination pour - s'assurer de la taille - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::distortImage</function> - - Déformation d'une image, et affichage sur le navigateur. - - -newPseudoImage(100, 100, "pattern:checkerboard"); - -/* Configure l'image en PNG */ -$im->setImageFormat('png'); - -/* Remplit la nouvelle zone visible à transparent */ -$im->setImageVirtualPixelMethod(Imagick::VIRTUALPIXELMETHOD_TRANSPARENT); - -/* Active le mate */ -$im->setImageMatte(true); - -/* Contrôle les points de déformation */ -$controlPoints = array( 10, 10, - 10, 5, - - 10, $im->getImageHeight() - 20, - 10, $im->getImageHeight() - 5, - - $im->getImageWidth() - 10, 10, - $im->getImageWidth() - 10, 20, - - $im->getImageWidth() - 10, $im->getImageHeight() - 10, - $im->getImageWidth() - 10, $im->getImageHeight() - 30); - -/* Effectue la déformation */ -$im->distortImage(Imagick::DISTORTION_PERSPECTIVE, $controlPoints, true); - -/* Envoie l'image */ -header("Content-Type: image/png"); -echo $im; -?> -]]> - - &example.outputs.similar; - - Affichage de l'exemple : Utilisation de Imagick::distortImage() - - - - - - - - - - &reftitle.seealso; - - - Imagick::blurImage - Imagick::motionBlurImage - Imagick::radialBlurImage - - - - - - - diff --git a/reference/imagick/imagick/drawimage.xml b/reference/imagick/imagick/drawimage.xml deleted file mode 100644 index 83753620e4..0000000000 --- a/reference/imagick/imagick/drawimage.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::drawImage - Affiche un objet ImagickDraw dans l'image courante - - - - &reftitle.description; - - public boolImagick::drawImage - ImagickDrawdraw - - - Affiche un objet ImagickDraw dans l'image courante. - - - - - &reftitle.parameters; - - - - draw - - - Les opérations de dessins pour dessiner l'image. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/edgeimage.xml b/reference/imagick/imagick/edgeimage.xml deleted file mode 100644 index ade43b5aeb..0000000000 --- a/reference/imagick/imagick/edgeimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - Imagick::edgeImage - Renforce les bords dans l'image - - - - &reftitle.description; - - public boolImagick::edgeImage - floatradius - - - Renforce les bords dans l'image, avec un filtre de convolution, - pour un rayon donné. Avec un rayon de zéro, Imagick va choisir - lui-même la valeur du rayon. - - - - - &reftitle.parameters; - - - - radius - - - Le rayon de l'opération. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::edgeImage</function> - -edgeImage($radius); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/embossimage.xml b/reference/imagick/imagick/embossimage.xml deleted file mode 100644 index e2c8ea36f3..0000000000 --- a/reference/imagick/imagick/embossimage.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - Imagick::embossImage - Retourne une image en niveau de gris, avec un effet 3D - - - - &reftitle.description; - - public boolImagick::embossImage - floatradius - floatsigma - - - Retourne une image en niveau de gris, avec un effet 3D. Une convolution - d'image avec opérateur gaussien est appliquée, avec un rayon et une déviation - standard donnée. Pour des résultats raisonnables, le rayon doit être plus - grand que sigma (la déviation standard). Un rayon de zéro conduit - à laisser Imagick choisir sa valeur. - - - - - &reftitle.parameters; - - - - radius - - - Le rayon de l'effet - - - - - sigma - - - Le sigma de l'effet - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::embossImage</function> - -embossImage($radius, $sigma); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/encipherimage.xml b/reference/imagick/imagick/encipherimage.xml deleted file mode 100644 index 951cf46954..0000000000 --- a/reference/imagick/imagick/encipherimage.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - Imagick::encipherImage - Chiffre une image - - - &reftitle.description; - - public boolImagick::encipherImage - stringpassphrase - - - Convertit les pixels en pixels chiffrés. L'image n'est plus lisible - jusqu'à ce qu'elle ait été déchiffrée à l'aide de Imagick::decipherImage - &imagick.method.available.0x639; - - - - - &reftitle.parameters; - - - - passphrase - - - Le mot de passe. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::decipherImage - - - - - - - diff --git a/reference/imagick/imagick/enhanceimage.xml b/reference/imagick/imagick/enhanceimage.xml deleted file mode 100644 index 2dbf57884c..0000000000 --- a/reference/imagick/imagick/enhanceimage.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - Imagick::enhanceImage - Améliore la qualité d'une image bruitée - - - - &reftitle.description; - - public boolImagick::enhanceImage - - - - Améliore la qualité d'une image bruitée avec un filtre - numérique. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::enhanceImage</function> - -enhanceImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/equalizeimage.xml b/reference/imagick/imagick/equalizeimage.xml deleted file mode 100644 index 1261b67c21..0000000000 --- a/reference/imagick/imagick/equalizeimage.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - Imagick::equalizeImage - Égalise l'histogramme d'une image - - - - &reftitle.description; - - public boolImagick::equalizeImage - - - - Égalise l'histogramme d'une image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::equalizeImage</function> - -equalizeImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/evaluateimage.xml b/reference/imagick/imagick/evaluateimage.xml deleted file mode 100644 index 0cf9b2bd6c..0000000000 --- a/reference/imagick/imagick/evaluateimage.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - Imagick::evaluateImage - Applique une expression à une image - - - - &reftitle.description; - - public boolImagick::evaluateImage - intop - floatconstant - intchannelImagick::CHANNEL_DEFAULT - - - Applique une expression arithmétique, relationnelle ou logique à une image. - Utiliser ces opérateurs pour éclaircir ou assombrir une image, pour - augmenter ou réduire le contraste, ou encore, produire une image inversée. - - - - - &reftitle.parameters; - - - - op - - - L'opérateur d'évaluation - - - - - constant - - - La valeur de l'opérateur - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::evaluateImage</function> - - Utilisation d'evaluateImage pour réduire l'opacité - d'une image. - - -evaluateImage(Imagick::EVALUATE_DIVIDE, 2, Imagick::CHANNEL_ALPHA); - -// Affichage de l'image -header("Content-Type: image/png"); -echo $im; -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/exportimagepixels.xml b/reference/imagick/imagick/exportimagepixels.xml deleted file mode 100644 index 0d5aeb53a1..0000000000 --- a/reference/imagick/imagick/exportimagepixels.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - - - Imagick::exportImagePixels - Exporte les pixels bruts de l'image - - - - &reftitle.description; - - public arrayImagick::exportImagePixels - intx - inty - intwidth - intheight - stringmap - intSTORAGE - - - Exporte les pixels de l'image dans un tableau. La carte définit l'ordre d'exportation - des pixels. La taille du tableau retourné correspond à - width * height * strlen(map). - &imagick.method.available.0x647; - - - - - &reftitle.parameters; - - - - x - - - Coordonnée en X de l'espace exporté. - - - - - y - - - Coordonnée en Y de l'espace exporté. - - - - - width - - - Largeur de l'espace exporté. - - - - - height - - - Hauteur de l'espace exporté. - - - - - map - - - Ordre des pixels exportés. Par exemple, "RGB". - Les caractères valides pour la carte sont R, G, B, A, O, C, Y, M, K, I et P. - - - - - STORAGE - - - Se référer à la liste des - constantes de type pixel - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les valeurs des pixels. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::exportImagePixels</function> - - Exportation des pixels de l'image dans un tableau. - - -newPseudoImage(0, 0, "magick:rose"); - -/* Exporte les pixels de l'image */ -$pixels = $im->exportImagePixels(10, 10, 2, 2, "RGB", Imagick::PIXEL_CHAR); - -/* Affichage */ -var_dump($pixels); -?> -]]> - - &example.outputs; - - - int(72) - [1]=> - int(64) - [2]=> - int(57) - [3]=> - int(69) - [4]=> - int(59) - [5]=> - int(43) - [6]=> - int(124) - [7]=> - int(120) - [8]=> - int(-96) - [9]=> - int(91) - [10]=> - int(84) - [11]=> - int(111) -} -]]> - - - - - - - - diff --git a/reference/imagick/imagick/extentimage.xml b/reference/imagick/imagick/extentimage.xml deleted file mode 100644 index a462b0c458..0000000000 --- a/reference/imagick/imagick/extentimage.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - Imagick::extentImage - Définit la taille de l'image - - - - &reftitle.description; - - public boolImagick::extentImage - intwidth - intheight - intx - inty - - - - Cette méthode est utile pour définir la taille de l'image. La méthode définit - la taille de l'image et autorise la configuration des coordonnées x, y - définissant le début du nouvel espace. - &imagick.method.available.0x631; - - - - - Avant ImageMagick 6.5.7-8 (1623), $x était positif lors d'un déplacement - vers la gauche, et négatif lors d'un déplacement vers la droite, et $y - était positif lors d'un déplacement de l'image vers le haut, et négatif lors - d'un déplacement de l'image vers le bas. Quelque part entre les versions - ImageMagick 6.3.7 (1591) et ImageMagick 6.5.7-8 (1623), les axes de $x et $y - ont été inversés, aussi, $x était négatif lors d'un déplacement vers la gauche - et positif lors d'un déplacement vers la droite, et $y était négatif lors - d'un déplacement de l'image vers le haut, et positif, lors d'un déplacement - vers le bas. Quelque part entre les versions ImageMagick 6.5.7-8 (1623) et - ImageMagick 6.6.9-7 (1641), le comportement est revenu tel qu'il était - avant ImageMagick 6.5.7-8 (1623). - - - - - - - &reftitle.parameters; - - - - width - - - La nouvelle largeur. - - - - - height - - - La nouvelle hauteur. - - - - - x - - - La position en X pour la nouvelle taille. - - - - - y - - - La position en Y pour la nouvelle taille. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::resizeImage - Imagick::thumbnailImage - Imagick::cropImage - - - - - - - diff --git a/reference/imagick/imagick/filter.xml b/reference/imagick/imagick/filter.xml deleted file mode 100644 index c6b5c2c997..0000000000 --- a/reference/imagick/imagick/filter.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Imagick::filter - Applique un noyau de convolution personnalisé à l'image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::filter - ImagickKernelImagickKernel - intchannelImagick::CHANNEL_UNDEFINED - - - Applique un noyau de convolution personnalisé à l'image. - - - - - - - &reftitle.parameters; - - - ImagickKernel - - - Une instance de ImagickKernel qui représente soit un seul noyau, soit une série de noyaux liés. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::filter</function> - - scale($strength, \Imagick::NORMALIZE_KERNEL_VALUE); - $kernel->addUnityKernel(1 - $strength); - - $imagick->filter($kernel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/flattenimages.xml b/reference/imagick/imagick/flattenimages.xml deleted file mode 100644 index c5856615ff..0000000000 --- a/reference/imagick/imagick/flattenimages.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - Imagick::flattenImages - Fusionne une séquence d'images - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::flattenImages - - - - Fusionne une séquence d'images. Ceci est pratique pour combiner - une série de couches Photoshop en une seule image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/flipimage.xml b/reference/imagick/imagick/flipimage.xml deleted file mode 100644 index 282f2bdb0a..0000000000 --- a/reference/imagick/imagick/flipimage.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Imagick::flipImage - Crée une image par miroir vertical - - - - &reftitle.description; - - public boolImagick::flipImage - - - - Crée une image par miroir vertical, à l'aide d'une symétrie autour de l'axe des abscisses. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::flipImage</function> - -flipImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - Imagick::flopimage - - - - - - diff --git a/reference/imagick/imagick/floodfillpaintimage.xml b/reference/imagick/imagick/floodfillpaintimage.xml deleted file mode 100644 index 8f5619c70e..0000000000 --- a/reference/imagick/imagick/floodfillpaintimage.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - - - Imagick::floodFillPaintImage - Modifie la valeur de la couleur de chaque pixel correspondant à la cible - - - - &reftitle.description; - - public boolImagick::floodFillPaintImage - mixedfill - floatfuzz - mixedtarget - intx - inty - boolinvert - intchannelImagick::CHANNEL_DEFAULT - - - - Modifie la valeur de la couleur de chaque pixel correspondant - à la cible et qui se trouve dans le voisinage immédiat. Cette méthode est un - remplacement de la méthode obsolète - Imagick::paintFloodFillImage. - &imagick.method.available.0x638; - - - - - &reftitle.parameters; - - - - fill - - - Objet ImagickPixel ou une chaîne contenant la couleur de remplissage. - - - - - fuzz - - - &imagick.parameter.fuzz; - - - - - target - - - Objet ImagickPixel ou une chaîne contenant la couleur cible à peindre. - - - - - x - - - Position de départ en X du pot de peinture. - - - - - y - - - Position de départ en Y du pot de peinture. - - - - - invert - - - Si vaut &true;, peint chaque pixel qui ne correspond pas à la couleur cible. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <methodname>Imagick::floodfillPaintImage</methodname> - -newImage(100, 50, "red"); -$im->newImage(100, 50, "green"); -$im->newImage(100, 50, "blue"); - -/* Ajoute l'image dans une autre */ -$im->resetIterator(); -$combined = $im->appendImages(true); - -/* Sauvegarde de l'image intermédiaire pour comparaison */ -$combined->writeImage("floodfillpaint_intermediate.png"); - -/* Le pixel cible à peindre */ -$x = 1; -$y = 1; - -/* Récupère la couleur à utiliser pour peindre */ -$target = $combined->getImagePixelColor($x, $y); - -/* Peint le pixel à la position 1,1 en noir, ainsi que tous les pixels voisins - qui correspondent à la couleur cible */ -$combined->floodfillPaintImage("black", 1, $target, $x, $y, false); - -/* Sauvegarde le résultat */ -$combined->writeImage("floodfillpaint_result.png"); -?> -]]> - - &example.outputs.similar; - - Affichage de l'exemple : Imagick::floodfillPaintImage() - - - - - - - - - - - - - - diff --git a/reference/imagick/imagick/flopimage.xml b/reference/imagick/imagick/flopimage.xml deleted file mode 100644 index 2d3e176fd5..0000000000 --- a/reference/imagick/imagick/flopimage.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Imagick::flopImage - Crée une image par miroir horizontal - - - - &reftitle.description; - - public boolImagick::flopImage - - - - Crée une image par miroir horizontal, à l'aide d'une symétrie autour de l'axe des ordonnées. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::flopImage</function> - -flopImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - Imagick::flipimage - - - - - - diff --git a/reference/imagick/imagick/forwardfouriertransformimage.xml b/reference/imagick/imagick/forwardfouriertransformimage.xml deleted file mode 100644 index 91aee2599a..0000000000 --- a/reference/imagick/imagick/forwardfouriertransformimage.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - Imagick::forwardFourierTransformImage - Implémente la transformée de Fourier discrète (Discrete Fourier Transform - DFT) - - - - &reftitle.description; - - public boolImagick::forwardFourierTransformimage - boolmagnitude - - - Implémente la transformée de Fourier discrète (DFT) de l'image soit en tant que paire d'images magnitude / phase, soit en tant que paire d'images réelles / imaginaires. - - - - - - &reftitle.parameters; - - - magnitude - - - Si vrai, retourne en tant que paire magnitude / phase, sinon une paire d'images réelles / imaginaires. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::forwardFourierTransformImage</function> - - setStrokeOpacity(0); - $draw->setStrokeColor('rgb(255, 255, 255)'); - $draw->setFillColor('rgb(255, 255, 255)'); - - // Dessine un cercle sur l'axe des y, avec son centre - // à x, y qui touche l'origine - $draw->circle(250, 250, 220, 250); - - $imagick = new \Imagick(); - $imagick->newImage(512, 512, "black"); - $imagick->drawImage($draw); - $imagick->gaussianBlurImage(20, 20); - $imagick->autoLevelImage(); - - return $imagick; -} - - -function forwardFourierTransformImage($imagePath) { - $imagick = new \Imagick(realpath($imagePath)); - $imagick->resizeimage(512, 512, \Imagick::FILTER_LANCZOS, 1); - - $mask = createMask(); - $imagick->forwardFourierTransformImage(true); - - @$imagick->setimageindex(0); - $magnitude = $imagick->getimage(); - - @$imagick->setimageindex(1); - $imagickPhase = $imagick->getimage(); - - if (true) { - $imagickPhase->compositeImage($mask, \Imagick::COMPOSITE_MULTIPLY, 0, 0); - } - - if (false) { - $output = clone $imagickPhase; - $output->setimageformat('png'); - header("Content-Type: image/png"); - echo $output->getImageBlob(); - } - - $magnitude->inverseFourierTransformImage($imagickPhase, true); - - $magnitude->setimageformat('png'); - header("Content-Type: image/png"); - echo $magnitude->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/frameimage.xml b/reference/imagick/imagick/frameimage.xml deleted file mode 100644 index 5d92891e6f..0000000000 --- a/reference/imagick/imagick/frameimage.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - - Imagick::frameImage - Ajoute un bord 3D - - - - &reftitle.description; - - public boolImagick::frameImage - mixedmatte_color - intwidth - intheight - intinner_bevel - intouter_bevel - - - Ajoute un bord 3D. La largeur et la hauteur configurent la - largeur et la hauteur de la bordure du cadre. Le chanfrein - intérieur et extérieur indique la largeur de l'ombre - interne et externe. - - - - - &reftitle.parameters; - - - - matte_color - - - Un objet ImagickPixel ou une chaîne - représentant la couleur - - - - - width - - - La largeur de la bordure - - - - - height - - - La hauteur de la bordure - - - - - inner_bevel - - - La largeur du chanfrein intérieur - - - - - outer_bevel - - - La largeur du chanfrein extérieur - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet désormais l'utilisation d'une chaîne pour représenter la couleur. - Les versions précédentes ne permettaient que les objets - ImagickPixel. - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::frameImage</function> - -frameimage( - $color, - $width, - $height, - $innerBevel, - $outerBevel - ); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/functionimage.xml b/reference/imagick/imagick/functionimage.xml deleted file mode 100644 index faf85facf2..0000000000 --- a/reference/imagick/imagick/functionimage.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - - - Imagick::functionImage - Applique une fonction sur l'image - - - - &reftitle.description; - - public boolImagick::functionImage - intfunction - arrayarguments - intchannelImagick::CHANNEL_DEFAULT - - - Applique une expression arithmétique, relationnelle ou logique à une pseudo-image. - - - Voir aussi les exemples - d'ImageMagick v6 - Transformations d'images — Fonction, évaluation de plusieurs arguments. - - - &imagick.method.available.0x649; - - - - - &reftitle.parameters; - - - - function - - - Se référer à la liste des constantes de fonction. - - - - - arguments - - - Tableau d'arguments à passer à la fonction. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Crée un gradient sinusoïdal - -newPseudoImage(200, 200, 'gradient:black-white'); -$arguments = array(3, -90); -$imagick->functionImage(Imagick::FUNCTION_SINUSOID, $arguments); - -header("Content-Type: image/png"); -$imagick->setImageFormat("png"); -echo $imagick->getImageBlob(); -?> -]]> - - &example.outputs.similar; - - Résultat de la création d'un gradient sinusoïdal - - - - - - - - Crée un gradient depuis le polynôme (4x^2 - 4x + 1) - -newPseudoImage(200, 200, 'gradient:black-white'); -$arguments = array(4, -4, 1); -$imagick->functionImage(Imagick::FUNCTION_POLYNOMIAL, $arguments); - -header("Content-Type: image/png"); -$imagick->setimageformat("png"); -echo $imagick->getImageBlob(); -?> -]]> - - &example.outputs.similar; - - Résultat de la création d'un gradient à partir d'un polynôme - - - - - - - - - Crée un gradient complexe depuis le - polynôme (4x^2 - 4x^2 + 1) modulé par un gradient sinusoïdal - - -newPseudoImage(200, 200, 'gradient:black-white'); -$arguments = array(9, -90); -$imagick1->functionImage(Imagick::FUNCTION_SINUSOID, $arguments); - -$imagick2 = new Imagick(); -$imagick2->newPseudoImage(200, 200, 'gradient:black-white'); -$arguments = array(0.5, 0); -$imagick2->functionImage(Imagick::FUNCTION_SINUSOID, $arguments); -$imagick1->compositeimage($imagick2, Imagick::COMPOSITE_MULTIPLY, 0, 0); - -header("Content-Type: image/png"); -$imagick1->setImageFormat("png"); -echo $imagick1->getImageBlob(); -?> -]]> - - &example.outputs.similar; - - Résultat de la création d'un gradient complexe - - - - - - - - - - - - diff --git a/reference/imagick/imagick/fximage.xml b/reference/imagick/imagick/fximage.xml deleted file mode 100644 index dfdc6f48e0..0000000000 --- a/reference/imagick/imagick/fximage.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - - Imagick::fxImage - Évalue une expression pour chaque pixel d'une image - - - - &reftitle.description; - - public ImagickImagick::fxImage - stringexpression - intchannelImagick::CHANNEL_DEFAULT - - - Évalue une expression pour chaque pixel d'une image. Consulter - The Fx Special Effects Image Operator - pour plus de détails (en anglais). - - - - - &reftitle.parameters; - - - - expression - - - L'expression. - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::fxImage</function> - -newPseudoImage(200, 200, "xc:white"); - - $fx = 'xx=i-w/2; yy=j-h/2; rr=hypot(xx,yy); (.5-rr/140)*1.2+.5'; - $fxImage = $imagick->fxImage($fx); - - header("Content-Type: image/png"); - $fxImage->setimageformat('png'); - echo $fxImage->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/gammaimage.xml b/reference/imagick/imagick/gammaimage.xml deleted file mode 100644 index 4356f94e99..0000000000 --- a/reference/imagick/imagick/gammaimage.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - Imagick::gammaImage - Applique une correction gamma à l'image - - - - &reftitle.description; - - public boolImagick::gammaImage - floatgamma - intchannelImagick::CHANNEL_DEFAULT - - - Applique une correction gamma à l'image. La même image vue sur différents - écrans aura des différences de perception dans la représentation - des intensités. Spécifier des corrections gamma individuelles pour - les différentes couleurs, ou bien ajuster les trois corrections gamma - d'un seul coup. Les valeurs typiques vont de 0.8 à 2.3. - - - - - &reftitle.parameters; - - - - gamma - - - La correction gamma. - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::gammaImage</function> - -gammaImage($gamma, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/gaussianblurimage.xml b/reference/imagick/imagick/gaussianblurimage.xml deleted file mode 100644 index 880ca5c6f4..0000000000 --- a/reference/imagick/imagick/gaussianblurimage.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - Imagick::gaussianBlurImage - Ajoute du flou à une image - - - - &reftitle.description; - - public boolImagick::gaussianBlurImage - floatradius - floatsigma - intchannelImagick::CHANNEL_DEFAULT - - - Ajoute du flou à une image. Une convolution est appliquée avec un - rayon et une déviation standard données. Pour des résultats raisonnables, - il est recommandé d'utiliser une taille de rayon supérieure à sigma. - Un rayon de zéro force la fonction à choisir les valeurs. - - - - - &reftitle.parameters; - - - - radius - - - Le rayon de la gaussienne, en pixels, sans compter le - pixel du centre. - - - - - sigma - - - La déviation standard de la gaussienne, en pixels. - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::gaussianBlurImage</function> - - gaussianBlurImage($radius, $sigma, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getcolorspace.xml b/reference/imagick/imagick/getcolorspace.xml deleted file mode 100644 index 2844814248..0000000000 --- a/reference/imagick/imagick/getcolorspace.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - Imagick::getColorspace - Récupère l'espace de couleurs - - - - &reftitle.description; - - public intImagick::getColorspace - - - - Récupère la valeur globale de l'espace de couleurs. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier qui peut être comparé avec les - constantes COLORSPACE. - - - - - - diff --git a/reference/imagick/imagick/getcompression.xml b/reference/imagick/imagick/getcompression.xml deleted file mode 100644 index d70a210d70..0000000000 --- a/reference/imagick/imagick/getcompression.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getCompression - Lit le type de compression - - - - &reftitle.description; - - public intImagick::getCompression - - - - Lit le type de compression. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la constante de compression. - - - - - - diff --git a/reference/imagick/imagick/getcompressionquality.xml b/reference/imagick/imagick/getcompressionquality.xml deleted file mode 100644 index d33900ac18..0000000000 --- a/reference/imagick/imagick/getcompressionquality.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getCompressionQuality - Lit la qualité de la compression - - - - &reftitle.description; - - public intImagick::getCompressionQuality - - - - Lit la qualité de la compression. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier décrivant la qualité de la compression. - - - - - - diff --git a/reference/imagick/imagick/getcopyright.xml b/reference/imagick/imagick/getcopyright.xml deleted file mode 100644 index 6788a36ec7..0000000000 --- a/reference/imagick/imagick/getcopyright.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getCopyright - Retourne le copyright de l'API ImageMagick - - - - &reftitle.description; - - public static stringImagick::getCopyright - - - - Retourne le copyright de l'API ImageMagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne, en cas de succès. - - - - - - diff --git a/reference/imagick/imagick/getfilename.xml b/reference/imagick/imagick/getfilename.xml deleted file mode 100644 index 32761af423..0000000000 --- a/reference/imagick/imagick/getfilename.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getFilename - Lit le nom du fichier associé à une séquence - - - - &reftitle.description; - - public stringImagick::getFilename - - - - Lit le nom du fichier associé à une séquence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getfont.xml b/reference/imagick/imagick/getfont.xml deleted file mode 100644 index bce902e7bd..0000000000 --- a/reference/imagick/imagick/getfont.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Imagick::getFont - Récupère la police de caractères - - - - &reftitle.description; - - public stringImagick::getFont - - - - Retourne la propriété de la police de caractères de l'objet. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; contenant le nom de la police de caractères - ou &false; si la police n'est pas définie. - - - - - &reftitle.seealso; - - - Imagick::setFont - ImagickDraw::setFont - ImagickDraw::getFont - - - - - - - diff --git a/reference/imagick/imagick/getformat.xml b/reference/imagick/imagick/getformat.xml deleted file mode 100644 index e08b9b7267..0000000000 --- a/reference/imagick/imagick/getformat.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getFormat - Retourne le format de l'image Imagick - - - - &reftitle.description; - - public stringImagick::getFormat - - - - Retourne le format de l'image Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le format de l'image Imagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getgravity.xml b/reference/imagick/imagick/getgravity.xml deleted file mode 100644 index 9bbc3afb8c..0000000000 --- a/reference/imagick/imagick/getgravity.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - Imagick::getGravity - Récupère la gravité - - - - &reftitle.description; - - public intImagick::getGravity - - - - - Récupère la propriété globale de la gravité pour l'objet - Imagick. - &imagick.method.available.0x640; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la propriété de gravité. Se référer à la liste des - constantes de gravité. - - - - - - diff --git a/reference/imagick/imagick/gethomeurl.xml b/reference/imagick/imagick/gethomeurl.xml deleted file mode 100644 index c9a9e9e101..0000000000 --- a/reference/imagick/imagick/gethomeurl.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getHomeURL - Retourne l'URL de ImageMagick - - - - &reftitle.description; - - public static stringImagick::getHomeURL - - - - Retourne l'URL de ImageMagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'URL de ImageMagick. - - - - - - diff --git a/reference/imagick/imagick/getimage.xml b/reference/imagick/imagick/getimage.xml deleted file mode 100644 index 09074adaed..0000000000 --- a/reference/imagick/imagick/getimage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImage - Retourne un nouvel objet Imagick - - - - &reftitle.description; - - public ImagickImagick::getImage - - - - Retourne un nouvel objet Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un nouvel objet Imagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagealphachannel.xml b/reference/imagick/imagick/getimagealphachannel.xml deleted file mode 100644 index 204360cd7e..0000000000 --- a/reference/imagick/imagick/getimagealphachannel.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - Imagick::getImageAlphaChannel - Vérifie si l'image a un canal alpha - - - - &reftitle.description; - - public boolImagick::getImageAlphaChannel - - - - - Retourne si l'image a un canal alpha. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si l'image a une valeur de canal alpha et &false; sinon, - c'est-à-dire que l'image est RGB plutôt que RGBA ou CMYK plutôt que CMYKA. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 3.6.0 - - Retourne un &boolean; maintenant ; auparavant, un &integer; était retourné. - - - - - - - - - diff --git a/reference/imagick/imagick/getimageartifact.xml b/reference/imagick/imagick/getimageartifact.xml deleted file mode 100644 index af4207282c..0000000000 --- a/reference/imagick/imagick/getimageartifact.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - Imagick::getImageArtifact - Récupère l'artefact de l'image - - - - &reftitle.description; - - public stringImagick::getImageArtifact - stringartifact - - - Récupère l'artefact associé à l'image. La différence entre les propriétés - de l'image et les artefacts de l'image est que les propriétés sont publiques, alors - que les artefacts sont privés. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - - - - artifact - - - Le nom de l'artefact. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur de l'artefact en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.seealso; - - - Imagick::setImageArtifact - Imagick::deleteImageArtifact - - - - - - - diff --git a/reference/imagick/imagick/getimageattribute.xml b/reference/imagick/imagick/getimageattribute.xml deleted file mode 100644 index 58df22ef3c..0000000000 --- a/reference/imagick/imagick/getimageattribute.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Imagick::getImageAttribute - Obtient un attribut nommé - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public stringImagick::getImageAttribute - stringkey - - - Obtient un attribut nommé. - - - - - - - &reftitle.parameters; - - - key - - - La clé de l'attribut à obtenir. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagick/getimagebackgroundcolor.xml b/reference/imagick/imagick/getimagebackgroundcolor.xml deleted file mode 100644 index a8b3495b18..0000000000 --- a/reference/imagick/imagick/getimagebackgroundcolor.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageBackgroundColor - Retourne la couleur de fond - - - - &reftitle.description; - - public ImagickPixelImagick::getImageBackgroundColor - - - - Retourne la couleur de fond. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la couleur de fond sous forme d'objet ImagickPixel. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageblob.xml b/reference/imagick/imagick/getimageblob.xml deleted file mode 100644 index aa20ff4b9f..0000000000 --- a/reference/imagick/imagick/getimageblob.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::getImageBlob - Retourne la séquence d'images comme un blob - - - - &reftitle.description; - - public stringImagick::getImageBlob - - - - Implémente un formatage direct en mémoire. Il retourne la - séquence d'images sous forme de chaîne. Le format de l'image - détermine le format du BLOB retourné (GIF, JPEG, PNG, etc.). - Pour retourner un format différent, utiliser - Imagick::setImageFormat(). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant les images. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageblueprimary.xml b/reference/imagick/imagick/getimageblueprimary.xml deleted file mode 100644 index a8902bcfdc..0000000000 --- a/reference/imagick/imagick/getimageblueprimary.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - Imagick::getImageBluePrimary - Retourne la chromaticité de la couleur bleue - - - - &reftitle.description; - - public arrayImagick::getImageBluePrimary - - - - Retourne la chromaticité de la couleur bleue. - Retourne un tableau avec les clés "x" et "y". - - - - - &reftitle.parameters; - - - - x - - - L'abscisse du point. - - - - - y - - - L'ordonnée du point. - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les clés "x" et "y", en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagebordercolor.xml b/reference/imagick/imagick/getimagebordercolor.xml deleted file mode 100644 index 3657b1a489..0000000000 --- a/reference/imagick/imagick/getimagebordercolor.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageBorderColor - Retourne la couleur de bordure de l'image - - - - &reftitle.description; - - public ImagickPixelImagick::getImageBorderColor - - - - Retourne la couleur de bordure de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechanneldepth.xml b/reference/imagick/imagick/getimagechanneldepth.xml deleted file mode 100644 index 0252601a03..0000000000 --- a/reference/imagick/imagick/getimagechanneldepth.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::getImageChannelDepth - Lit la profondeur d'un des canaux de l'image - - - - &reftitle.description; - - public intImagick::getImageChannelDepth - intchannel - - - Lit la profondeur d'un des canaux de l'image. - - - - - &reftitle.parameters; - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/getimagechanneldistortion.xml b/reference/imagick/imagick/getimagechanneldistortion.xml deleted file mode 100644 index 401a1571a2..0000000000 --- a/reference/imagick/imagick/getimagechanneldistortion.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - Imagick::getImageChannelDistortion - Compare les canaux d'une image reconstituée - - - - &reftitle.description; - - public floatImagick::getImageChannelDistortion - Imagickreference - intchannel - intmetric - - - Compare un ou plusieurs canaux d'une image reconstituée et - retourne la métrique de déformation demandée. - - - - - &reftitle.parameters; - - - - reference - - - L'objet Imagick avec lequel se comparer. - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - metric - - - Une des constantes de type de métrique. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechanneldistortions.xml b/reference/imagick/imagick/getimagechanneldistortions.xml deleted file mode 100644 index 49997c39c4..0000000000 --- a/reference/imagick/imagick/getimagechanneldistortions.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - Imagick::getImageChannelDistortions - Récupère les distorsions d'un canal - - - - &reftitle.description; - - public floatImagick::getImageChannelDistortions - Imagickreference - intmetric - intchannelImagick::CHANNEL_DEFAULT - - - - Compare un ou plusieurs canaux d'une image avec une image reconstruite, et retourne - les mesures de la distorsion spécifiée. - &imagick.method.available.0x644; - - - - - &reftitle.parameters; - - - - reference - - - Objet Imagick contenant la référence de l'image. - - - - - metric - - - Se référer à la liste des - constantes de type de mesures. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - Retourne un float, décrivant la distorsion du canal. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechannelextrema.xml b/reference/imagick/imagick/getimagechannelextrema.xml deleted file mode 100644 index 6435a50ee3..0000000000 --- a/reference/imagick/imagick/getimagechannelextrema.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - Imagick::getImageChannelExtrema - Lit les extrêmes pour les canaux de l'image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public arrayImagick::getImageChannelExtrema - intchannel - - - Lit les extrêmes pour l'un ou plusieurs canaux de l'image. La valeur - retournée est un tableau associatif avec les clés "minima" et "maxima". - - - - - &reftitle.parameters; - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechannelkurtosis.xml b/reference/imagick/imagick/getimagechannelkurtosis.xml deleted file mode 100644 index 0425588009..0000000000 --- a/reference/imagick/imagick/getimagechannelkurtosis.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - Imagick::getImageChannelKurtosis - Le but de getImageChannelKurtosis - - - - &reftitle.description; - - public arrayImagick::getImageChannelKurtosis - intchannelImagick::CHANNEL_DEFAULT - - - Récupère le kurtosis et l'asymétrie d'un canal spécifique. - &imagick.method.available.0x649; - - - - - &reftitle.parameters; - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les membres kurtosis - et skewness. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/getimagechannelmean.xml b/reference/imagick/imagick/getimagechannelmean.xml deleted file mode 100644 index e39f999304..0000000000 --- a/reference/imagick/imagick/getimagechannelmean.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - Imagick::getImageChannelMean - Lit la moyenne et la déviation standard - - - - &reftitle.description; - - public arrayImagick::getImageChannelMean - intchannel - - - Récupère la moyenne et la déviation standard d'un ou plusieurs des canaux de l'image. - - - - - &reftitle.parameters; - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les membres "mean" et - "standardDeviation". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechannelrange.xml b/reference/imagick/imagick/getimagechannelrange.xml deleted file mode 100644 index 9c64bd657f..0000000000 --- a/reference/imagick/imagick/getimagechannelrange.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - Imagick::getImageChannelRange - Récupère l'intervalle du canal - - - - &reftitle.description; - - public arrayImagick::getImageChannelRange - intchannel - - - - Récupère l'intervalle pour un ou plusieurs canaux de l'image. - &imagick.method.available.0x640; - - - - - &reftitle.parameters; - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les valeurs minimales et - maximales du ou des canaux. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechannelstatistics.xml b/reference/imagick/imagick/getimagechannelstatistics.xml deleted file mode 100644 index b9692872fa..0000000000 --- a/reference/imagick/imagick/getimagechannelstatistics.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - Imagick::getImageChannelStatistics - Retourne des statistiques sur chaque canal de l'image - - - - &reftitle.description; - - public arrayImagick::getImageChannelStatistics - - - - Retourne des statistiques sur chaque canal de l'image. Les statistiques - incluent la profondeur du canal, ses minima et maxima, la moyenne, - et la déviation standard. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/getimageclipmask.xml b/reference/imagick/imagick/getimageclipmask.xml deleted file mode 100644 index e58a8a1bec..0000000000 --- a/reference/imagick/imagick/getimageclipmask.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - Imagick::getImageClipMask - Récupère le masque du clip de l'image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::getImageClipMask - - - - - Retourne le masque du clip de l'image. Le masque du clip est un objet - Imagick contenant le masque du clip. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un objet Imagick contenant le masque du clip. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagecolormapcolor.xml b/reference/imagick/imagick/getimagecolormapcolor.xml deleted file mode 100644 index def3964665..0000000000 --- a/reference/imagick/imagick/getimagecolormapcolor.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - Imagick::getImageColormapColor - Retourne la couleur à l'index de la carte de couleurs - - - - &reftitle.description; - - public ImagickPixelImagick::getImageColormapColor - intindex - - - Retourne la couleur à l'index de la carte de couleurs. - - - - - &reftitle.parameters; - - - - index - - - La position dans la carte des couleurs. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagecolors.xml b/reference/imagick/imagick/getimagecolors.xml deleted file mode 100644 index b8eef08d63..0000000000 --- a/reference/imagick/imagick/getimagecolors.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getImageColors - Lit le nombre de couleurs uniques de l'image - - - - &reftitle.description; - - public intImagick::getImageColors - - - - Lit le nombre de couleurs uniques de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un int, le nombre de couleurs uniques dans l'image. - - - - - - diff --git a/reference/imagick/imagick/getimagecolorspace.xml b/reference/imagick/imagick/getimagecolorspace.xml deleted file mode 100644 index 735c55d0d2..0000000000 --- a/reference/imagick/imagick/getimagecolorspace.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::getImageColorspace - Lit l'espace de couleurs de l'image - - - - &reftitle.description; - - public intImagick::getImageColorspace - - - - Lit l'espace de couleurs de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier qui peut être comparé aux - constantes COLORSPACE. - - - - - - diff --git a/reference/imagick/imagick/getimagecompose.xml b/reference/imagick/imagick/getimagecompose.xml deleted file mode 100644 index 0555804b87..0000000000 --- a/reference/imagick/imagick/getimagecompose.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getImageCompose - Retourne l'opérateur de composition associé à une image - - - - &reftitle.description; - - public intImagick::getImageCompose - - - - Retourne l'opérateur de composition associé à une image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/getimagecompression.xml b/reference/imagick/imagick/getimagecompression.xml deleted file mode 100644 index f8bf1211ee..0000000000 --- a/reference/imagick/imagick/getimagecompression.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::getImageCompression - Lit le type de compression de l'image - - - - &reftitle.description; - - public intImagick::getImageCompression - - - - - Lit le type de compression de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une constante de compression. - - - - - - diff --git a/reference/imagick/imagick/getimagecompressionquality.xml b/reference/imagick/imagick/getimagecompressionquality.xml deleted file mode 100644 index 17ce8113bf..0000000000 --- a/reference/imagick/imagick/getimagecompressionquality.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::getImageCompressionQuality - Lit la qualité de compression de l'image - - - - &reftitle.description; - - public intImagick::getImageCompressionQuality - - - - - Lit la qualité de compression de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier qui décrit la qualité de la compression de l'image. - - - - - - diff --git a/reference/imagick/imagick/getimagedelay.xml b/reference/imagick/imagick/getimagedelay.xml deleted file mode 100644 index 0de3222574..0000000000 --- a/reference/imagick/imagick/getimagedelay.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getImageDelay - Lit le délai de l'image - - - - &reftitle.description; - - public intImagick::getImageDelay - - - - Lit le délai de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le délai de l'image. - &imagick.imagickexception.throw; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagedepth.xml b/reference/imagick/imagick/getimagedepth.xml deleted file mode 100644 index 3b7caeb905..0000000000 --- a/reference/imagick/imagick/getimagedepth.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getImageDepth - Lit la profondeur de l'image - - - - &reftitle.description; - - public intImagick::getImageDepth - - - - Lit la profondeur de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La profondeur de l'image. - - - - - - diff --git a/reference/imagick/imagick/getimagedispose.xml b/reference/imagick/imagick/getimagedispose.xml deleted file mode 100644 index 969522cde2..0000000000 --- a/reference/imagick/imagick/getimagedispose.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageDispose - Lit la méthode de récupération - - - - &reftitle.description; - - public intImagick::getImageDispose - - - - Lit la méthode de récupération. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la méthode de récupération en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagedistortion.xml b/reference/imagick/imagick/getimagedistortion.xml deleted file mode 100644 index e21d796dee..0000000000 --- a/reference/imagick/imagick/getimagedistortion.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - Imagick::getImageDistortion - Compare une image à une image reconstituée - - - - &reftitle.description; - - public floatImagick::getImageDistortion - MagickWandreference - intmetric - - - Compare une image à une image reconstituée et retourne - une métrique. - - - - - &reftitle.parameters; - - - - reference - - - L'objet Imagick avec lequel se comparer. - - - - - metric - - - Une des constantes de type de métrique. - - - - - - - - - &reftitle.returnvalues; - - Retourne la métrique de déformation (ou la meilleure évaluation possible). - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageextrema.xml b/reference/imagick/imagick/getimageextrema.xml deleted file mode 100644 index 6cdff0a340..0000000000 --- a/reference/imagick/imagick/getimageextrema.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Imagick::getImageExtrema - Lit les extrêmes d'une image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public arrayImagick::getImageExtrema - - - - Lit les extrêmes d'une image. Retourne - un tableau associatif, avec les clés - "min" et "max". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau associatif, avec les clés "min" et "max". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagefilename.xml b/reference/imagick/imagick/getimagefilename.xml deleted file mode 100644 index 55b69a7cb0..0000000000 --- a/reference/imagick/imagick/getimagefilename.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageFilename - Retourne le nom d'un fichier pour une image dans une séquence - - - - &reftitle.description; - - public stringImagick::getImageFilename - - - - Retourne le nom d'un fichier pour une image dans une séquence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne avec le nom du fichier de l'image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageformat.xml b/reference/imagick/imagick/getimageformat.xml deleted file mode 100644 index c0cecceebd..0000000000 --- a/reference/imagick/imagick/getimageformat.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageFormat - Retourne le format d'une image dans une séquence - - - - &reftitle.description; - - public stringImagick::getImageFormat - - - - Retourne le format d'une image dans une séquence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le format d'une image dans une séquence. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagegamma.xml b/reference/imagick/imagick/getimagegamma.xml deleted file mode 100644 index 60b60ee519..0000000000 --- a/reference/imagick/imagick/getimagegamma.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageGamma - Lit le gamma de l'image - - - - &reftitle.description; - - public floatImagick::getImageGamma - - - - Lit le gamma de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le gamma de l'image en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagegeometry.xml b/reference/imagick/imagick/getimagegeometry.xml deleted file mode 100644 index 70c374a7e7..0000000000 --- a/reference/imagick/imagick/getimagegeometry.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - Imagick::getImageGeometry - Lit les dimensions de l'image dans un tableau - - - - &reftitle.description; - - public arrayImagick::getImageGeometry - - - - Retourne la largeur et la hauteur de l'image sous forme de tableau associatif. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &array; avec les dimensions de l'image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Utilisation de <function>Imagick::getImageGeometry</function> - -newImage(100, 200, "black"); -print_r($imagick->getImageGeometry()); -?> -]]> - - &example.outputs; - - 100 - [height] => 200 -) -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getimagegravity.xml b/reference/imagick/imagick/getimagegravity.xml deleted file mode 100644 index a1c742aa22..0000000000 --- a/reference/imagick/imagick/getimagegravity.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - Imagick::getImageGravity - Récupère la gravité de l'image - - - - &reftitle.description; - - public intImagick::getImageGravity - - - - - Récupère la valeur de la gravité courante de l'image. - Contrairement à la méthode Imagick::getGravity, - cette méthode retourne la gravité définie pour la séquence courante - de l'image. - &imagick.method.available.0x644; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la propriété de la gravité de l'image. Se référer à la liste des - constantes de gravité. - - - - - - diff --git a/reference/imagick/imagick/getimagegreenprimary.xml b/reference/imagick/imagick/getimagegreenprimary.xml deleted file mode 100644 index 444aae2aa4..0000000000 --- a/reference/imagick/imagick/getimagegreenprimary.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getImageGreenPrimary - Retourne la chromaticité de la couleur verte - - - - &reftitle.description; - - public arrayImagick::getImageGreenPrimary - - - - Retourne la chromaticité de la couleur verte. - Retourne un tableau avec les clés "x" et "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau avec les clés "x" et "y", en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageheight.xml b/reference/imagick/imagick/getimageheight.xml deleted file mode 100644 index 54eb2f2366..0000000000 --- a/reference/imagick/imagick/getimageheight.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageHeight - Retourne la hauteur de l'image - - - - &reftitle.description; - - public intImagick::getImageHeight - - - - Retourne la hauteur de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la hauteur de l'image en pixels. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagehistogram.xml b/reference/imagick/imagick/getimagehistogram.xml deleted file mode 100644 index 8cd50687b7..0000000000 --- a/reference/imagick/imagick/getimagehistogram.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - - Imagick::getImageHistogram - Retourne l'histogramme de l'image - - - - &reftitle.description; - - public arrayImagick::getImageHistogram - - - - Retourne l'histogramme de l'image, sous forme d'un - tableau d'objets ImagickPixel. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau d'objets ImagickPixel. - &imagick.imagickexception.throw; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::getImageHistogram</function> - -getColorValue($colorChannel); - $color = intval($color * 255); - $count = $histogramElement->getColorCount(); - - if (array_key_exists($color, $colorStatistics)) { - $colorStatistics[$color] += $count; - } - else { - $colorStatistics[$color] = $count; - } - } - - ksort($colorStatistics); - - return $colorStatistics; -} - - - -function getImageHistogram($imagePath) { - - $backgroundColor = 'black'; - - $draw = new \ImagickDraw(); - $draw->setStrokeWidth(0); // rend les lignes les plus fines possible - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - $histogramWidth = 256; - $histogramHeight = 100; // la hauteur de chaque segment RGB - - $imagick = new \Imagick(realpath($imagePath)); - //Resize the image to be small, otherwise PHP tends to run out of memory - //This might lead to bad results for images that are pathologically 'pixelly' - $imagick->adaptiveResizeImage(200, 200, true); - $histogramElements = $imagick->getImageHistogram(); - - $histogram = new \Imagick(); - $histogram->newpseudoimage($histogramWidth, $histogramHeight * 3, 'xc:black'); - $histogram->setImageFormat('png'); - - $getMax = function ($carry, $item) { - if ($item > $carry) { - return $item; - } - return $carry; - }; - - $colorValues = [ - 'red' => getColorStatistics($histogramElements, \Imagick::COLOR_RED), - 'lime' => getColorStatistics($histogramElements, \Imagick::COLOR_GREEN), - 'blue' => getColorStatistics($histogramElements, \Imagick::COLOR_BLUE), - ]; - - $max = array_reduce($colorValues['red'] , $getMax, 0); - $max = array_reduce($colorValues['lime'] , $getMax, $max); - $max = array_reduce($colorValues['blue'] , $getMax, $max); - - $scale = $histogramHeight / $max; - - $count = 0; - foreach ($colorValues as $color => $values) { - $draw->setstrokecolor($color); - - $offset = ($count + 1) * $histogramHeight; - - foreach ($values as $index => $value) { - $draw->line($index, $offset, $index, $offset - ($value * $scale)); - } - $count++; - } - - $histogram->drawImage($draw); - - header( "Content-Type: image/png" ); - echo $histogram; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getimageindex.xml b/reference/imagick/imagick/getimageindex.xml deleted file mode 100644 index a86171193a..0000000000 --- a/reference/imagick/imagick/getimageindex.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - Imagick::getImageIndex - Lit l'index de l'image courante - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public intImagick::getImageIndex - - - - Retourne l'index de l'image courante dans la séquence Imagick. - Cette méthode est obsolète. - Se reporter à la fonction Imagick::getIteratorIndex. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - diff --git a/reference/imagick/imagick/getimageinterlacescheme.xml b/reference/imagick/imagick/getimageinterlacescheme.xml deleted file mode 100644 index 20615a473b..0000000000 --- a/reference/imagick/imagick/getimageinterlacescheme.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::getImageInterlaceScheme - Lit le schéma d'entrelacement de l'image - - - - &reftitle.description; - - public intImagick::getImageInterlaceScheme - - - - Lit le schéma d'entrelacement de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le schéma d'entrelacement de l'image en cas de succès. - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/getimageinterpolatemethod.xml b/reference/imagick/imagick/getimageinterpolatemethod.xml deleted file mode 100644 index 4535b12178..0000000000 --- a/reference/imagick/imagick/getimageinterpolatemethod.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getImageInterpolateMethod - Retourne la méthode d'interpolation - - - - &reftitle.description; - - public intImagick::getImageInterpolateMethod - - - - Retourne la méthode d'interpolation de l'image spécifiée. - La méthode est une des constantes Imagick::INTERPOLATE_*. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la méthode d'interpolation en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageiterations.xml b/reference/imagick/imagick/getimageiterations.xml deleted file mode 100644 index 271231ab8d..0000000000 --- a/reference/imagick/imagick/getimageiterations.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageIterations - Lit les itérations de l'image - - - - &reftitle.description; - - public intImagick::getImageIterations - - - - Lit les itérations de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les itérations de l'image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagelength.xml b/reference/imagick/imagick/getimagelength.xml deleted file mode 100644 index d5be46be74..0000000000 --- a/reference/imagick/imagick/getimagelength.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - Imagick::getImageLength - Retourne la taille de l'image en octets - - - - &reftitle.description; - - public intImagick::getImageLength - - - - Retourne la taille de l'image en octets. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier. - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::getImageLength</function>: - - Récupère la taille de l'image, en octets - - -getImageLength() . ' octets'; -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getimagematte.xml b/reference/imagick/imagick/getimagematte.xml deleted file mode 100644 index 8d0637b05b..0000000000 --- a/reference/imagick/imagick/getimagematte.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - Imagick::getImageMatte - Indique si l'image a un canal mat - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::getImageMatte - - - - - Retourne &true; si l'image a un canal mat, et sinon, &false; - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/getimagemattecolor.xml b/reference/imagick/imagick/getimagemattecolor.xml deleted file mode 100644 index 05ca8ebd76..0000000000 --- a/reference/imagick/imagick/getimagemattecolor.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::getImageMatteColor - Retourne la couleur mate de l'image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickPixelImagick::getImageMatteColor - - - - Retourne la couleur mate de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un objet ImagickPixel en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagemimetype.xml b/reference/imagick/imagick/getimagemimetype.xml deleted file mode 100644 index 80b859f149..0000000000 --- a/reference/imagick/imagick/getimagemimetype.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Imagick::getImageMimeType - Renvoie le type MIME de l'image - - - - &reftitle.description; - - public stringImagick::getImageMimeType - - - - Renvoie le type MIME de l'image. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagick/getimageorientation.xml b/reference/imagick/imagick/getimageorientation.xml deleted file mode 100644 index cba6040893..0000000000 --- a/reference/imagick/imagick/getimageorientation.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getImageOrientation - Lit l'orientation de l'image - - - - &reftitle.description; - - public intImagick::getImageOrientation - - - - Lit l'orientation de l'image. La valeur retournée est une des - constantes d'orientation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagepage.xml b/reference/imagick/imagick/getimagepage.xml deleted file mode 100644 index 2a245bf425..0000000000 --- a/reference/imagick/imagick/getimagepage.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::getImagePage - Retourne la géométrie de la page - - - - &reftitle.description; - - public arrayImagick::getImagePage - - - - Retourne la géométrie de la page d'une image, sous la forme d'un tableau - avec les clés "width", "height", - "x" et "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la géométrie de la page d'une image, sous la forme d'un tableau - avec les clés "width", "height", - "x" et "y". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagepixelcolor.xml b/reference/imagick/imagick/getimagepixelcolor.xml deleted file mode 100644 index 1cacf9c926..0000000000 --- a/reference/imagick/imagick/getimagepixelcolor.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - Imagick::getImagePixelColor - Retourne la couleur d'un pixel - - - - &reftitle.description; - - public ImagickPixelImagick::getImagePixelColor - intx - inty - - - Retourne la couleur d'un pixel. - - - - - &reftitle.parameters; - - - - x - - - L'abscisse du pixel - - - - - y - - - L'ordonnée du pixel - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet ImagickPixel qui représente la couleur, - pour ces coordonnées. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageprofile.xml b/reference/imagick/imagick/getimageprofile.xml deleted file mode 100644 index 36c610b4fe..0000000000 --- a/reference/imagick/imagick/getimageprofile.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - Imagick::getImageProfile - Retourne un profil d'une image - - - - &reftitle.description; - - public stringImagick::getImageProfile - stringname - - - Retourne un profil d'une image, à partir de son nom. - - - - - &reftitle.parameters; - - - - name - - - Le nom du profil à lire. - - - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant le profil de l'image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageprofiles.xml b/reference/imagick/imagick/getimageprofiles.xml deleted file mode 100644 index abe0d5154f..0000000000 --- a/reference/imagick/imagick/getimageprofiles.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - Imagick::getImageProfiles - Retourne les profils de l'image - - - - &reftitle.description; - - public arrayImagick::getImageProfiles - stringpattern"*" - boolinclude_values&true; - - - Retourne les profils de l'image qui correspondent à un modèle. - Si &false; est passé comme second paramètre, seuls les noms des profils - sont retournés. &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - pattern - - - Le modèle de profil à lire. - - - - - include_values - - - S'il faut retourner seulement les noms des profils. - Si &false; est fourni, seuls les noms des profils seront retournés. - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les profils de l'image, ou bien - seulement les noms des profils. - - - - - - diff --git a/reference/imagick/imagick/getimageproperties.xml b/reference/imagick/imagick/getimageproperties.xml deleted file mode 100644 index b4aa1fc64f..0000000000 --- a/reference/imagick/imagick/getimageproperties.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - Imagick::getImageProperties - Retourne les propriétés EXIF de l'image - - - - &reftitle.description; - - public arrayImagick::getImageProperties - stringpattern"*" - boolinclude_values&true; - - - Retourne toutes les propriétés de l'image, qui satisfont un modèle. - Si &false; est passé comme second paramètre, seuls les noms des propriétés - sont retournés. &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - pattern - - - Le modèle pour les noms de propriétés. - - - - - include_values - - - S'il faut retourner uniquement les noms des - propriétés. Si &false; est fourni, alors seuls - les noms des propriétés seront retournés. - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les propriétés de l'image, - ou leurs noms. - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::getImageProperties</function> - - Exemple d'extraction d'informations EXIF. - - -getImageProperties("exif:*"); - -/* Passe en revue les propriétés EXIF */ -foreach ($exifArray as $name => $property) -{ - echo "{$name} => {$property}
\n"; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getimageproperty.xml b/reference/imagick/imagick/getimageproperty.xml deleted file mode 100644 index 8104679694..0000000000 --- a/reference/imagick/imagick/getimageproperty.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - Imagick::getImageProperty - Retourne une propriété d'une image - - - - &reftitle.description; - - public stringImagick::getImageProperty - stringname - - - Retourne une propriété d'une image. - &imagick.method.available.0x632; - - - - - &reftitle.parameters; - - - - name - - - Le nom de la propriété (par exemple, Exif:DateTime) - - - - - - - - - &reftitle.returnvalues; - - Retourne une propriété d'une image, ou &false; si le nom - demandé n'existe pas. - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::getImageProperty</function> - - Définition et récupération des propriétés de l'image. - - -newImage(300, 200, "black"); - -$image->setImageProperty('Exif:Make', 'Imagick'); -echo $image->getImageProperty('Exif:Make'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::setImageProperty - - - - - - - diff --git a/reference/imagick/imagick/getimageredprimary.xml b/reference/imagick/imagick/getimageredprimary.xml deleted file mode 100644 index f0260981b7..0000000000 --- a/reference/imagick/imagick/getimageredprimary.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Imagick::getImageRedPrimary - Retourne la chromaticité du point rouge - - - - &reftitle.description; - - public arrayImagick::getImageRedPrimary - - - - Retourne la chromaticité du point rouge sous la forme d'un tableau - avec les clés "x" et "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la chromaticité du point rouge sous la forme d'un tableau - avec les clés "x" et "y". - &imagick.imagickexception.throw; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageregion.xml b/reference/imagick/imagick/getimageregion.xml deleted file mode 100644 index 33e6f14041..0000000000 --- a/reference/imagick/imagick/getimageregion.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - Imagick::getImageRegion - Extrait une région d'une image - - - - &reftitle.description; - - public ImagickImagick::getImageRegion - intwidth - intheight - intx - inty - - - Extrait une région d'une image et la retourne sous la forme - d'un nouvel objet Imagick. - - - - - &reftitle.parameters; - - - - width - - - La largeur de la région extraite. - - - - - height - - - La hauteur de la région extraite. - - - - - x - - - L'abscisse du coin supérieur gauche de la région extraite. - - - - - y - - - L'ordonnée du coin supérieur gauche de la région extraite. - - - - - - - - - &reftitle.returnvalues; - - Extrait une région d'une image et la retourne sous la forme - d'un nouvel objet Imagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagerenderingintent.xml b/reference/imagick/imagick/getimagerenderingintent.xml deleted file mode 100644 index 0eee707c43..0000000000 --- a/reference/imagick/imagick/getimagerenderingintent.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getImageRenderingIntent - Lit la méthode de rendu de l'image - - - - &reftitle.description; - - public intImagick::getImageRenderingIntent - - - - Lit la méthode de rendu de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la constante de rendu. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageresolution.xml b/reference/imagick/imagick/getimageresolution.xml deleted file mode 100644 index 5d6c2d6d91..0000000000 --- a/reference/imagick/imagick/getimageresolution.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageResolution - Lit les résolutions en X et Y d'une image - - - - &reftitle.description; - - public arrayImagick::getImageResolution - - - - Lit les résolutions en X et Y d'une image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Lit les résolutions en X et Y d'une image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagesblob.xml b/reference/imagick/imagick/getimagesblob.xml deleted file mode 100644 index b1806dd5a4..0000000000 --- a/reference/imagick/imagick/getimagesblob.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - Imagick::getImagesBlob - Retourne toutes les images de la séquence en un BLOB - - - - &reftitle.description; - - public stringImagick::getImagesBlob - - - - Implémente le formatage direct en mémoire. Il retourne toutes les - images de la séquence sous forme de chaîne. Le format de l'image - détermine le format du BLOB retourné (GIF, JPEG, PNG, etc.). Pour - retourner un format d'image différent, utiliser - Imagick::setImageFormat. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant toutes les images. - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/getimagescene.xml b/reference/imagick/imagick/getimagescene.xml deleted file mode 100644 index 6f65e0b1e1..0000000000 --- a/reference/imagick/imagick/getimagescene.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageScene - Retourne la scène de l'image - - - - &reftitle.description; - - public intImagick::getImageScene - - - - Retourne la scène de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la scène de l'image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagesignature.xml b/reference/imagick/imagick/getimagesignature.xml deleted file mode 100644 index e1884a5fdd..0000000000 --- a/reference/imagick/imagick/getimagesignature.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageSignature - Génère une signature SHA-256 - - - - &reftitle.description; - - public stringImagick::getImageSignature - - - - Génère une signature SHA-256 de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant la signature SHA-256 de l'image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagesize.xml b/reference/imagick/imagick/getimagesize.xml deleted file mode 100644 index b73bc241e5..0000000000 --- a/reference/imagick/imagick/getimagesize.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - Imagick::getImageSize - Retourne la taille de l'image en octets - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public intImagick::getImageSize - - - - Retourne la taille de l'image en octets. - Cette méthode est obsolète en faveur de la méthode - Imagick::getImageLength() - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier représentant la taille de l'image en octets. - - - - - - diff --git a/reference/imagick/imagick/getimagetickspersecond.xml b/reference/imagick/imagick/getimagetickspersecond.xml deleted file mode 100644 index 0b0a822146..0000000000 --- a/reference/imagick/imagick/getimagetickspersecond.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageTicksPerSecond - Lit les ticks-par-seconde de l'image - - - - &reftitle.description; - - public intImagick::getImageTicksPerSecond - - - - Lit les ticks-par-seconde de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Lit les ticks-par-seconde de l'image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagetotalinkdensity.xml b/reference/imagick/imagick/getimagetotalinkdensity.xml deleted file mode 100644 index 07a188e20f..0000000000 --- a/reference/imagick/imagick/getimagetotalinkdensity.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::getImageTotalInkDensity - Lit la densité totale d'encre de l'image - - - - &reftitle.description; - - public floatImagick::getImageTotalInkDensity - - - - Lit la densité totale d'encre de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Lit la densité totale d'encre de l'image. - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/getimagetype.xml b/reference/imagick/imagick/getimagetype.xml deleted file mode 100644 index 2a02915235..0000000000 --- a/reference/imagick/imagick/getimagetype.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Imagick::getImageType - Lit le type de l'image - - - - &reftitle.description; - - public intImagick::getImageType - - - - Retourne le type de l'image, déduit de son espace colorimétrique, de sa - classe de stockage et de la présence d'un canal alpha. Les pixels - eux-mêmes ne sont pas examinés : la valeur reflète donc la façon dont - l'image est actuellement stockée, et non le plus petit type auquel elle - pourrait être réduite. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'une des constantes - imagick::IMGTYPE_* - suivantes. imagick::IMGTYPE_UNDEFINED et - imagick::IMGTYPE_OPTIMIZE ne sont jamais retournées. - - - - - imagick::IMGTYPE_BILEVEL - - - - - imagick::IMGTYPE_GRAYSCALE - - - - - imagick::IMGTYPE_GRAYSCALEMATTE - - - - - imagick::IMGTYPE_PALETTE - - - - - imagick::IMGTYPE_PALETTEMATTE - - - - - imagick::IMGTYPE_TRUECOLOR - - - - - imagick::IMGTYPE_TRUECOLORMATTE - - - - - imagick::IMGTYPE_COLORSEPARATION - - - - - imagick::IMGTYPE_COLORSEPARATIONMATTE - - - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageunits.xml b/reference/imagick/imagick/getimageunits.xml deleted file mode 100644 index 86aa6adceb..0000000000 --- a/reference/imagick/imagick/getimageunits.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageUnits - Retourne les unités de résolution de l'image - - - - &reftitle.description; - - public intImagick::getImageUnits - - - - Retourne les unités de résolution de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les unités de résolution de l'image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagevirtualpixelmethod.xml b/reference/imagick/imagick/getimagevirtualpixelmethod.xml deleted file mode 100644 index 0a6640e1c0..0000000000 --- a/reference/imagick/imagick/getimagevirtualpixelmethod.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageVirtualPixelMethod - Retourne la méthode du pixel virtuel - - - - &reftitle.description; - - public intImagick::getImageVirtualPixelMethod - - - - Retourne la méthode du pixel virtuel pour l'image spécifiée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la méthode du pixel virtuel pour l'image spécifiée. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagewhitepoint.xml b/reference/imagick/imagick/getimagewhitepoint.xml deleted file mode 100644 index 58de7ce287..0000000000 --- a/reference/imagick/imagick/getimagewhitepoint.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - Imagick::getImageWhitePoint - Retourne la chromaticité du point blanc - - - - &reftitle.description; - - public arrayImagick::getImageWhitePoint - - - - Retourne la chromaticité du point blanc, sous la forme d'un tableau - associatif avec les clés "x" et "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la chromaticité du point blanc, sous la forme d'un tableau - associatif avec les clés "x" et "y". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagewidth.xml b/reference/imagick/imagick/getimagewidth.xml deleted file mode 100644 index 223fef1519..0000000000 --- a/reference/imagick/imagick/getimagewidth.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageWidth - Retourne la largeur de l'image - - - - &reftitle.description; - - public intImagick::getImageWidth - - - - Retourne la largeur de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la largeur de l'image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getinterlacescheme.xml b/reference/imagick/imagick/getinterlacescheme.xml deleted file mode 100644 index 86b2e7310e..0000000000 --- a/reference/imagick/imagick/getinterlacescheme.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getInterlaceScheme - Lit le schéma d'entrelacement de l'objet - - - - &reftitle.description; - - public intImagick::getInterlaceScheme - - - - Lit le schéma d'entrelacement de l'objet. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Lit la constante d'entrelacement. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getiteratorindex.xml b/reference/imagick/imagick/getiteratorindex.xml deleted file mode 100644 index 6f0d8323e3..0000000000 --- a/reference/imagick/imagick/getiteratorindex.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - Imagick::getIteratorIndex - Lit l'index de l'image active courante - - - - &reftitle.description; - - public intImagick::getIteratorIndex - - - - Lit l'index de l'image active courante dans l'objet Imagick. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier représentant l'index de l'image dans la file d'attente. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::getIteratorIndex</function> - - Crée des images, définit et récupère l'index de l'itérateur. - - -newImage(100, 100, new ImagickPixel("red")); -$im->newImage(100, 100, new ImagickPixel("green")); -$im->newImage(100, 100, new ImagickPixel("blue")); - -$im->setIteratorIndex(1); -echo $im->getIteratorIndex(); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::setIteratorIndex - Imagick::getImageIndex - Imagick::setImageIndex - - - - - - - - diff --git a/reference/imagick/imagick/getnumberimages.xml b/reference/imagick/imagick/getnumberimages.xml deleted file mode 100644 index 359e21e2a3..0000000000 --- a/reference/imagick/imagick/getnumberimages.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getNumberImages - Retourne le nombre d'images d'un objet - - - - &reftitle.description; - - public intImagick::getNumberImages - - - - Retourne le nombre d'images d'un objet Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le nombre d'images d'un objet Imagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getoption.xml b/reference/imagick/imagick/getoption.xml deleted file mode 100644 index 0ef06ee850..0000000000 --- a/reference/imagick/imagick/getoption.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - Imagick::getOption - Retourne la valeur d'une option - - - - &reftitle.description; - - public stringImagick::getOption - stringkey - - - Retourne la valeur d'une option pour l'objet Imagick. - - - - - &reftitle.parameters; - - - - key - - - Le nom de l'option - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur associée à l'option. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getpackagename.xml b/reference/imagick/imagick/getpackagename.xml deleted file mode 100644 index 1d32f8aba2..0000000000 --- a/reference/imagick/imagick/getpackagename.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getPackageName - Retourne le nom du paquet ImageMagick - - - - &reftitle.description; - - public static stringImagick::getPackageName - - - - Retourne le nom du paquet ImageMagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le nom du paquet ImageMagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getpage.xml b/reference/imagick/imagick/getpage.xml deleted file mode 100644 index 86b7fc315d..0000000000 --- a/reference/imagick/imagick/getpage.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - Imagick::getPage - Retourne la géométrie de la page - - - - &reftitle.description; - - public arrayImagick::getPage - - - - Retourne la géométrie de l'objet Imagick, sous forme - d'un tableau associatif, avec les clés "width", - "height", "x" et "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la géométrie de l'objet Imagick, sous forme - d'un tableau associatif, avec les clés "width", - "height", "x" et "y". - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/getpixeliterator.xml b/reference/imagick/imagick/getpixeliterator.xml deleted file mode 100644 index c36ebdcb18..0000000000 --- a/reference/imagick/imagick/getpixeliterator.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - Imagick::getPixelIterator - Retourne un MagickPixelIterator - - - - &reftitle.description; - - public ImagickPixelIteratorImagick::getPixelIterator - - - - Retourne un MagickPixelIterator. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un objet MagickPixelIterator. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::getPixelIterator</function> - -getPixelIterator(); - - foreach ($imageIterator as $row => $pixels) { /* On parcourt les lignes de pixels */ - foreach ($pixels as $column => $pixel) { /* On parcourt les pixels dans la ligne (colonne) */ - /** @var $pixel \ImagickPixel */ - if ($column % 2) { - $pixel->setColor("rgba(0, 0, 0, 0)"); /* On peint tous les seconds pixels en noir */ - } - } - $imageIterator->syncIterator(); /* On synchronise l'itérateur, c'est important de le faire à chaque itération */ - } - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getpixelregioniterator.xml b/reference/imagick/imagick/getpixelregioniterator.xml deleted file mode 100644 index e0b42a4c9d..0000000000 --- a/reference/imagick/imagick/getpixelregioniterator.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - Imagick::getPixelRegionIterator - Lit un objet ImagickPixelIterator pour une section d'image - - - - &reftitle.description; - - public ImagickPixelIteratorImagick::getPixelRegionIterator - intx - inty - intcolumns - introws - - - Lit un objet ImagickPixelIterator pour une section d'image. - - - - - &reftitle.parameters; - - - - x - - - L'abscisse de la région. - - - - - y - - - L'ordonnée de la région. - - - - - columns - - - La largeur de la région. - - - - - rows - - - La hauteur de la région. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet ImagickPixelIterator pour une section d'image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - <methodname>Imagick::getPixelRegionIterator</methodname> example - - Itère sur les pixels du coin en haut à gauche de l'image, pour les peindre - en noir. - - - getPixelRegionIterator(0, 0, 10, 10); - -foreach ($areaIterator as $rowIterator) { - foreach ($rowIterator as $pixel) { - // Peint les pixels en noir - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - $areaIterator->syncIterator(); -} -$im->writeImage("./output.png"); -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getpointsize.xml b/reference/imagick/imagick/getpointsize.xml deleted file mode 100644 index 2052cf9ae9..0000000000 --- a/reference/imagick/imagick/getpointsize.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Imagick::getPointSize - Récupère la taille du point - - - - &reftitle.description; - - public floatImagick::getPointSize - - - - Retourne la propriété de la taille du point de l'objet. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &float; contenant la taille du point. - - - - - &reftitle.seealso; - - - Imagick::setPointSize - - - - - - - diff --git a/reference/imagick/imagick/getquantum.xml b/reference/imagick/imagick/getquantum.xml deleted file mode 100644 index e04b38ea5b..0000000000 --- a/reference/imagick/imagick/getquantum.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Imagick::getQuantum - Renvoie la plage quantique d'ImageMagick - - - - &reftitle.description; - - public static intImagick::getQuantum - - - - Renvoie la plage quantique d'ImageMagick. Si HDRI est activé, le type est un flottant, sinon c'est un entier. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagick/getquantumdepth.xml b/reference/imagick/imagick/getquantumdepth.xml deleted file mode 100644 index 2888e13e8f..0000000000 --- a/reference/imagick/imagick/getquantumdepth.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Imagick::getQuantumDepth - Lit la profondeur quantique - - - - &reftitle.description; - - public static arrayImagick::getQuantumDepth - - - - Retourne la profondeur quantique. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau avec les membres "quantumDepthLong" et - "quantumDepthString". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getquantumrange.xml b/reference/imagick/imagick/getquantumrange.xml deleted file mode 100644 index 6b49e22019..0000000000 --- a/reference/imagick/imagick/getquantumrange.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Imagick::getQuantumRange - Retourne l'intervalle quantique de Imagick - - - - &reftitle.description; - - public static arrayImagick::getQuantumRange - - - - Retourne l'intervalle quantique de l'instance Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau associatif contenant l'intervalle quantique - sous la forme d'un &integer; ("quantumRangeLong") - et sous la forme d'une &string; - ("quantumRangeString"). - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getregistry.xml b/reference/imagick/imagick/getregistry.xml deleted file mode 100644 index 8dcf424b30..0000000000 --- a/reference/imagick/imagick/getregistry.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Imagick::getRegistry - Obtient un élément de StringRegistry - - - - &reftitle.description; - - public static stringImagick::getRegistry - stringkey - - - Obtient l'entrée StringRegistry pour la clé nommée ou false si elle n'est pas définie. - - - - - - &reftitle.parameters; - - - key - - - L'entrée à obtenir. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagick/getreleasedate.xml b/reference/imagick/imagick/getreleasedate.xml deleted file mode 100644 index a52456df53..0000000000 --- a/reference/imagick/imagick/getreleasedate.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getReleaseDate - Retourne la date de publication de ImageMagick - - - - &reftitle.description; - - public static stringImagick::getReleaseDate - - - - Retourne la date de publication de ImageMagick, sous forme de chaîne. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la date de publication de ImageMagick, sous forme de chaîne. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getresource.xml b/reference/imagick/imagick/getresource.xml deleted file mode 100644 index 4af324f5c5..0000000000 --- a/reference/imagick/imagick/getresource.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - Imagick::getResource - Retourne la consommation de mémoire de la ressource - - - - &reftitle.description; - - public static intImagick::getResource - inttype - - - Retourne la consommation de mémoire de la ressource, en mégaoctets. - - - - - &reftitle.parameters; - - - - type - - - Voir la liste des - constantes de type de ressources. - - - - - - - - - &reftitle.returnvalues; - - Retourne la consommation de mémoire de la ressource, en mégaoctets. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getresourcelimit.xml b/reference/imagick/imagick/getresourcelimit.xml deleted file mode 100644 index 63bd9d172f..0000000000 --- a/reference/imagick/imagick/getresourcelimit.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - Imagick::getResourceLimit - Retourne la limite de la ressource - - - - &reftitle.description; - - public static intImagick::getResourceLimit - inttype - - - Retourne la limite de la ressource. - - - - - &reftitle.parameters; - - - - type - - - L'une des - constantes de type de ressources. - - - - - - - - - &reftitle.returnvalues; - - Retourne la limite de ressource spécifiée. - L'unité dépend du type de ressource qui est limitée. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.seealso; - - Imagick::setResourceLimit - - - - - - diff --git a/reference/imagick/imagick/getsamplingfactors.xml b/reference/imagick/imagick/getsamplingfactors.xml deleted file mode 100644 index 6afbb9e230..0000000000 --- a/reference/imagick/imagick/getsamplingfactors.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getSamplingFactors - Lit le facteur d'échantillonnage horizontal et vertical - - - - &reftitle.description; - - public arrayImagick::getSamplingFactors - - - - Lit le facteur d'échantillonnage horizontal et vertical. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau associatif avec les facteurs d'échantillonnage - horizontal et vertical de l'image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getsize.xml b/reference/imagick/imagick/getsize.xml deleted file mode 100644 index fafc6c5849..0000000000 --- a/reference/imagick/imagick/getsize.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - Imagick::getSize - Retourne la taille associée avec un objet Imagick - - - - &reftitle.description; - - public arrayImagick::getSize - - - - Obtenir la taille associée avec un objet Imagick, précédemment défini par Imagick::setSize. - - - - Cette méthode retourne simplement la taille qui a été définie à l'aide de - Imagick::setSize. Pour obtenir la - largeur/hauteur réelle de l'image, utiliser Imagick::getImageWidth et - Imagick::getImageHeight. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la taille associée avec un objet Imagick, - sous forme de tableau, avec les clés "columns" (colonnes) et - "rows" (lignes). - - - - - &reftitle.examples; - - - Obtention de la taille d'une image RVB brute définie à 200x400, après mise à l'échelle à 400x800 (par rapport à la largeur/hauteur) - -setSize(200, 400); -$img->readImage("image.rgb"); - -$img->scaleImage(400, 800); - -$size = $img->getSize(); -print_r($size); - -echo $img->getImageWidth()."x".$img->getImageHeight(); -?> -]]> - - &example.outputs; - - 200 - [rows] => 400 -) -400x800 -]]> - - - - - - diff --git a/reference/imagick/imagick/getsizeoffset.xml b/reference/imagick/imagick/getsizeoffset.xml deleted file mode 100644 index 9c7c10d4be..0000000000 --- a/reference/imagick/imagick/getsizeoffset.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getSizeOffset - Retourne la taille de la position - - - - &reftitle.description; - - public intImagick::getSizeOffset - - - - Retourne la taille de la position associée avec l'objet Imagick. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la taille de la position associée avec l'objet Imagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getversion.xml b/reference/imagick/imagick/getversion.xml deleted file mode 100644 index 9ae41fca82..0000000000 --- a/reference/imagick/imagick/getversion.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - Imagick::getVersion - Retourne la version de l'API ImageMagick - - - - &reftitle.description; - - public static arrayImagick::getVersion - - - - Retourne la version de l'API ImageMagick, sous forme de chaîne - et de nombre. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la version de l'API ImageMagick, sous forme de chaîne - et de nombre. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/haldclutimage.xml b/reference/imagick/imagick/haldclutimage.xml deleted file mode 100644 index 5a9f732165..0000000000 --- a/reference/imagick/imagick/haldclutimage.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - Imagick::haldClutImage - Remplace les couleurs de l'image - - - - &reftitle.description; - - public boolImagick::haldClutImage - Imagickclut - intchannelImagick::CHANNEL_DEFAULT - - - Remplace les couleurs de l'image en utilisant la table de correspondance - Hald. Les images Hald peuvent être créées en utilisant le codeur de couleur HALD. - - - - - &reftitle.parameters; - - - - clut - - - Objet Imagick contenant l'image de correspondance Hald. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::haldClutImage</function> - -sepiatoneImage(55); - $imagick->haldClutImage($imagickPalette); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/hasnextimage.xml b/reference/imagick/imagick/hasnextimage.xml deleted file mode 100644 index cc7fbe725e..0000000000 --- a/reference/imagick/imagick/hasnextimage.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::hasNextImage - Vérifie si un objet a une image suivante - - - - &reftitle.description; - - public boolImagick::hasNextImage - - - - Retourne &true; si l'objet a encore des images, pour passer en revue - la liste. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si l'objet a une image suivante, et &false; sinon. - - - - - - diff --git a/reference/imagick/imagick/haspreviousimage.xml b/reference/imagick/imagick/haspreviousimage.xml deleted file mode 100644 index 83e3c933c5..0000000000 --- a/reference/imagick/imagick/haspreviousimage.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::hasPreviousImage - Vérifie si un objet a une image précédente - - - - &reftitle.description; - - public boolImagick::hasPreviousImage - - - - Retourne &true; si l'objet a une image précédente, pour pouvoir - passer en revue la liste en ordre inverse. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si l'objet a une image précédente, et &false; sinon. - - - - - - diff --git a/reference/imagick/imagick/identifyformat.xml b/reference/imagick/imagick/identifyformat.xml deleted file mode 100644 index 162c0bf418..0000000000 --- a/reference/imagick/imagick/identifyformat.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Imagick::identifyFormat - Formate une chaîne avec les détails de l'image - - - - &reftitle.description; - - public stringfalseImagick::identifyFormat - stringembedText - - - Remplace tous les caractères de formatage intégrés par la propriété d'image appropriée et renvoie le texte interprété. Voir http://www.imagemagick.org/script/escape.php pour les séquences d'échappement. - - - - - - - &reftitle.parameters; - - - embedText - - - Une chaîne contenant des séquences de formatage, par exemple "Boîte de rognage: %@ nombre de couleurs uniques: %k". - - - - - - - - &reftitle.returnvalues; - - Renvoie le format&return.falseforfailure;. - - - - - - - - &reftitle.examples; - - - <function>Imagick::identifyFormat</function> - - "; - $imagick = new \Imagick(realpath("./images/artifact/mask.png")); - $output .= $imagick->identifyFormat("Trim box: %@ number of unique colors: %k"); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/identifyimage.xml b/reference/imagick/imagick/identifyimage.xml deleted file mode 100644 index ec325e2800..0000000000 --- a/reference/imagick/imagick/identifyimage.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - Imagick::identifyImage - Identifie une image et lit ses attributs - - - - &reftitle.description; - - public arrayImagick::identifyImage - boolappendRawOutput&false; - - - Identifie une image et retourne ses attributs. Les attributs - sont sa largeur, hauteur, taille et d'autres. - - - - - &reftitle.parameters; - - - - appendRawOutput - - - Si &true;, la sortie brute est ajoutée au tableau - - - - - - - - - &reftitle.returnvalues; - - Identifie une image et retourne ses attributs. Les attributs - sont sa largeur, hauteur, taille et d'autres. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple de format du résultat - - /some/path/image.jpg - [format] => JPEG (Joint Photographic Experts Group JFIF format) - [geometry] => Array - ( - [width] => 90 - [height] => 90 - ) - - [type] => TrueColor - [colorSpace] => RGB - [resolution] => Array - ( - [x] => 300 - [y] => 300 - ) - - [units] => PixelsPerInch - [fileSize] => 1.88672kb - [compression] => JPEG - [signature] => 9a6dc8f604f97d0d691c0286176ddf992e188f0bebba98494b2146ee2d7118da -) -]]> - - - - - - - - diff --git a/reference/imagick/imagick/implodeimage.xml b/reference/imagick/imagick/implodeimage.xml deleted file mode 100644 index 5da65eae81..0000000000 --- a/reference/imagick/imagick/implodeimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - Imagick::implodeImage - Crée une nouvelle copie d'image - - - - &reftitle.description; - - public boolImagick::implodeImage - floatradius - - - Crée une nouvelle copie d'image, avec chaque pixel - "implosé" par un pourcentage spécifique. - - - - - &reftitle.parameters; - - - - radius - - - Le rayon de l'implosion - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::implodeImage</function> - -implodeImage(0.0001); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); - -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/importimagepixels.xml b/reference/imagick/imagick/importimagepixels.xml deleted file mode 100644 index e73c4e2c85..0000000000 --- a/reference/imagick/imagick/importimagepixels.xml +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - - - Imagick::importImagePixels - Importe des pixels dans une image - - - - &reftitle.description; - - public boolImagick::importImagePixels - intx - inty - intwidth - intheight - stringmap - intstorage - arraypixels - - - Importe des pixels depuis un tableau dans une image. - Le paramètre map vaut généralement 'RGB'. - Cette méthode impose les contraintes suivantes pour les paramètres : le nombre de pixels - du tableau doit correspondre à la longueur width x height x - de la carte. - &imagick.method.available.0x645; - - - - - - &reftitle.parameters; - - - - x - - - La position en X de l'image. - - - - - y - - - La position en Y de l'image. - - - - - width - - - La largeur de l'image. - - - - - height - - - La hauteur de l'image. - - - - - map - - - La carte de l'ordre des pixels, sous la forme d'une &string;. - Par exemple RGB. La valeur peut être une combinaison - ou un ordre de R = rouge, G = vert, B = bleu, A = alpha (0 correspond à transparent), - O = opacité (0 correspond à opaque), C = cyan, Y = jaune, M = magenta, K = noir, I = intensité (pour les niveaux de gris), P = pad. - - - - - storage - - - La méthode de stockage des pixels. - Se référer à la liste des constantes de pixels. - - - - - pixels - - - Le tableau de pixels. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <methodname>Imagick::importImagePixels</methodname> - -newImage($width, $height, 'gray'); - -/* Importe les pixels dans l'image. - width * height * strlen("RGB") doit correspondre à count($pixels) */ -$im->importImagePixels(0, 0, $width, $height, "RGB", Imagick::PIXEL_CHAR, $pixels); - -/* Affiche l'image sous la forme d'une image jpeg */ -$im->setImageFormat('jpg'); -header("Content-Type: image/jpg"); -echo $im; - -?> -]]> - - &example.outputs.similar; - - Sortie de l'exemple : Imagick::importImagePixels() - - - - - - - - - - - - - diff --git a/reference/imagick/imagick/inversefouriertransformimage.xml b/reference/imagick/imagick/inversefouriertransformimage.xml deleted file mode 100644 index a6ca9d193d..0000000000 --- a/reference/imagick/imagick/inversefouriertransformimage.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Imagick::inverseFourierTransformImage - Implémente la transformée de Fourier discrète inverse (Discrete Fourier Transform - DFT) - - - - &reftitle.description; - - public boolImagick::inverseFourierTransformImage - Imagickcomplement - boolmagnitude - - - Implémente la transformée de Fourier discrète inverse (DFT) de l'image soit en tant que paire d'images magnitude / phase, soit en tant que paire d'images réelles / imaginaires. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - complement - - - La seconde image à combiner avec celle-ci pour former soit la paire d'images magnitude / phase, soit la paire d'images réelles / imaginaires. - - - - - magnitude - - - Si vrai, combine en tant que paire magnitude / phase, sinon une paire d'images réelles / imaginaires. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagick/labelimage.xml b/reference/imagick/imagick/labelimage.xml deleted file mode 100644 index f0a5801feb..0000000000 --- a/reference/imagick/imagick/labelimage.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::labelImage - Ajoute un libellé à une image - - - - &reftitle.description; - - public boolImagick::labelImage - stringlabel - - - Ajoute un libellé à une image. - - - - - &reftitle.parameters; - - - - label - - - Le libellé à ajouter - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/levelimage.xml b/reference/imagick/imagick/levelimage.xml deleted file mode 100644 index 4724e610c2..0000000000 --- a/reference/imagick/imagick/levelimage.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - Imagick::levelImage - Ajuste les niveaux de l'image - - - - &reftitle.description; - - public boolImagick::levelImage - floatblackPoint - floatgamma - floatwhitePoint - intchannelImagick::CHANNEL_DEFAULT - - - Ajuste les niveaux d'une image en modifiant les couleurs qui - sont entre deux couleurs données. Les paramètres représentent - le noir, le gris et le blanc. Le noir est la couleur la plus - sombre dans l'image. Les couleurs qui sont plus sombres que - la couleur noire sont alors mises à zéro. La couleur grise - spécifie une correction gamma à appliquer à l'image. - La couleur blanche spécifie la couleur la plus claire. - Les couleurs plus claires sont alors mises à l'intensité - maximale. - - - - - &reftitle.parameters; - - - - blackPoint - - - Le point noir de l'image - - - - - gamma - - - La correction gamma - - - - - whitePoint - - - Le point blanc de l'image - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::levelImage</function> - -newPseudoimage(500, 500, 'gradient:black-white'); - - $imagick->setFormat('png'); - $quantum = $imagick->getQuantum(); - $imagick->levelImage($blackPoint / 100 , $gamma, $quantum * $whitePoint / 100); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/linearstretchimage.xml b/reference/imagick/imagick/linearstretchimage.xml deleted file mode 100644 index 27adbba6b4..0000000000 --- a/reference/imagick/imagick/linearstretchimage.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - Imagick::linearStretchImage - Étire la saturation de l'intensité de l'image - - - - &reftitle.description; - - public boolImagick::linearStretchImage - floatblackPoint - floatwhitePoint - - - Étire la saturation de l'intensité de l'image. - - - - - &reftitle.parameters; - - - - blackPoint - - - Le point noir de l'image. - - - - - whitePoint - - - Le point blanc de l'image. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::linearStretchImage</function> - -getImageWidth() * $imagick->getImageHeight(); - $imagick->linearStretchImage($blackThreshold * $pixels, $whiteThreshold * $pixels); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/liquidrescaleimage.xml b/reference/imagick/imagick/liquidrescaleimage.xml deleted file mode 100644 index 974a79cac5..0000000000 --- a/reference/imagick/imagick/liquidrescaleimage.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - Imagick::liquidRescaleImage - Redimensionne une image par mise à l'échelle liquide - - - - &reftitle.description; - - public boolImagick::liquidRescaleImage - intwidth - intheight - floatdelta_x - floatrigidity - - - - Cette méthode met à l'échelle les images en utilisant la méthode - de mise à l'échelle liquide. Cette méthode est une implémentation - d'une technique appelée "seam carving". Pour que cette méthode fonctionne - telle que convenue, ImageMagick doit avoir été compilé avec le support liblqr. - &imagick.method.available.0x639; - - - - - &reftitle.parameters; - - - - width - - - La largeur de la taille cible. - - - - - height - - - La hauteur de la taille cible. - - - - - delta_x - - - Le nombre de coutures pouvant traverser - l'axe X. Le fait de passer 0 signifie - que la couture se fera sur la droite. - - - - - rigidity - - - Introduit une rigidité pour les coutures non droites. - Ce paramètre est habituellement à 0. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::resizeImage - - - - - - - diff --git a/reference/imagick/imagick/listregistry.xml b/reference/imagick/imagick/listregistry.xml deleted file mode 100644 index 47399d802b..0000000000 --- a/reference/imagick/imagick/listregistry.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Imagick::listRegistry - Liste tous les paramètres du registre - - - - &reftitle.description; - - public static arrayImagick::listRegistry - - - - Liste tous les paramètres du registre. Renvoie un tableau de toutes les paires clé/valeur du registre. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau contenant les clés/valeurs du registre. - - - - - - - diff --git a/reference/imagick/imagick/magnifyimage.xml b/reference/imagick/imagick/magnifyimage.xml deleted file mode 100644 index 1663095671..0000000000 --- a/reference/imagick/imagick/magnifyimage.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - Imagick::magnifyImage - Double la taille d'une image, proportionnellement - - - - &reftitle.description; - - public boolImagick::magnifyImage - - - - Cette méthode est un raccourci pour doubler la taille d'une image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::magnifyImage</function> - -magnifyImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/mapimage.xml b/reference/imagick/imagick/mapimage.xml deleted file mode 100644 index 0483cdb910..0000000000 --- a/reference/imagick/imagick/mapimage.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - Imagick::mapImage - Remplace la couleur d'une image par celle d'une image de référence - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::mapImage - Imagickmap - booldither - - - - - &reftitle.parameters; - - - - map - - - - - - - dither - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/mattefloodfillimage.xml b/reference/imagick/imagick/mattefloodfillimage.xml deleted file mode 100644 index 55530023ff..0000000000 --- a/reference/imagick/imagick/mattefloodfillimage.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - - Imagick::matteFloodfillImage - Change la transparence d'une couleur - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::matteFloodfillImage - floatalpha - floatfuzz - mixedbordercolor - intx - inty - - - Change la transparence d'un pixel cible, et ses voisins immédiats. - Si la méthode FillToBorderMethod est spécifiée, - la valeur de la transparence est modifiée pour tous les pixels voisins - qui ne correspondent pas à une couleur de bordercolor. - - - - - &reftitle.parameters; - - - - alpha - - - Le niveau de transparence : 1.0 représente une couleur opaque, - alors que 0.0 est totalement transparent. - - - - - fuzz - - - Cet argument représente la tolérance acceptable pour - que deux couleurs soient considérées comme identiques. - - - - - bordercolor - - - Un objet ImagickPixel ou une chaîne - représentant la couleur de bordure. - - - - - x - - - L'abscisse d'origine de l'opération. - - - - - y - - - L'ordonnée d'origine de l'opération. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet désormais l'utilisation d'une chaîne pour représenter la couleur. - Les versions précédentes ne permettaient que les objets - ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/medianfilterimage.xml b/reference/imagick/imagick/medianfilterimage.xml deleted file mode 100644 index 0cd6d31b51..0000000000 --- a/reference/imagick/imagick/medianfilterimage.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - Imagick::medianFilterImage - Applique un filtre numérique - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::medianFilterImage - floatradius - - - Applique un filtre numérique qui améliore la qualité d'une image - avec du bruit. Chaque pixel est remplacé par la médiane de son voisinage. - Le voisinage est défini par un rayon. - - - - - &reftitle.parameters; - - - - radius - - - Le rayon du voisinage. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::medianFilterImage</function> - -medianFilterImage($radius); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/mergeimagelayers.xml b/reference/imagick/imagick/mergeimagelayers.xml deleted file mode 100644 index 111bb075b1..0000000000 --- a/reference/imagick/imagick/mergeimagelayers.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - Imagick::mergeImageLayers - Fusionne les calques de l'image - - - - &reftitle.description; - - public ImagickImagick::mergeImageLayers - intlayer_method - - - Fusionne les calques de l'image en un seul. Cette méthode est utile - lors de l'utilisation de formats d'image qui utilisent plusieurs calques, - comme les PSD. La fusion est contrôlée en utilisant le paramètre - layer_method qui définit la façon dont les calques - doivent fusionner. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - - - - layer_method - - - Une constante parmi les constantes Imagick::LAYERMETHOD_*. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet Imagick contenant l'image fusionnée. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::mergeImageLayers</function> - -addImage($imagick2); - $imagick->setImageFormat('png'); - - $result = $imagick->mergeImageLayers($layerMethodType); - header("Content-Type: image/png"); - echo $result->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::flattenImages - - - - - - - diff --git a/reference/imagick/imagick/minifyimage.xml b/reference/imagick/imagick/minifyimage.xml deleted file mode 100644 index cce6722520..0000000000 --- a/reference/imagick/imagick/minifyimage.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - Imagick::minifyImage - Met à l'échelle une image proportionnellement pour la réduire de moitié de taille - - - - &reftitle.description; - - public boolImagick::minifyImage - - - - Cette fonction est un raccourci pratique pour mettre - à l'échelle une image proportionnellement pour la réduire - de moitié de taille. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/modulateimage.xml b/reference/imagick/imagick/modulateimage.xml deleted file mode 100644 index f83ab62416..0000000000 --- a/reference/imagick/imagick/modulateimage.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - Imagick::modulateImage - Contrôle la saturation, l'intensité et la teinte - - - - &reftitle.description; - - public boolImagick::modulateImage - floatbrightness - floatsaturation - floathue - - - Contrôle l'intensité, la saturation et la teinte d'une image. - La teinte est le pourcentage de rotation absolue depuis la - position courante. Par exemple, la valeur 50 engendre une - rotation anti-horaire de 90 degrés, 150 produit une rotation - horaire de 90 degrés, tandis que 0 et 200 produisent des - rotations de 180 degrés. - - - - - &reftitle.parameters; - - - - brightness - - - - - - - saturation - - - - - - - hue - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::modulateImage</function> - -modulateImage($brightness, $saturation, $hue); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/montageimage.xml b/reference/imagick/imagick/montageimage.xml deleted file mode 100644 index 715d45661d..0000000000 --- a/reference/imagick/imagick/montageimage.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Imagick::montageImage - Crée une image composite - - - - &reftitle.description; - - public ImagickImagick::montageImage - ImagickDrawdraw - stringtile_geometry - stringthumbnail_geometry - intmode - stringframe - - - Crée une image composite en combinant plusieurs images. - Les images sont utilisées comme carreaux dans l'image composite, - avec leur nom optionnellement en dessous. - - - - - &reftitle.parameters; - - - - draw - - - Le nom de la police, la taille et la couleur sont demandés à cet objet. - - - - - tile_geometry - - - Le nombre de carreaux par ligne et par page (p. ex. 6x4+0+0). - - - - - thumbnail_geometry - - - La taille demandée pour l'image et sa bordure pour chaque miniature - (p. ex. 120x120+4+3). - - - - - mode - - - Le mode de cadrage des miniatures. Voir la liste des constantes de mode de montage. - - - - - frame - - - Encadre l'image avec un bord d'ornement (p. ex. 15x15+3+3). La - couleur du bord est la couleur mate de la miniature. - - - - - - - - - &reftitle.returnvalues; - - Crée une image composée et la retourne en tant que nouvel objet - Imagick. - - - - - diff --git a/reference/imagick/imagick/morphimages.xml b/reference/imagick/imagick/morphimages.xml deleted file mode 100644 index 26fb5ae35a..0000000000 --- a/reference/imagick/imagick/morphimages.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - Imagick::morphImages - Réalise un morphing entre deux images - - - - &reftitle.description; - - public ImagickImagick::morphImages - intnumber_frames - - - Réalise un morphing d'images. La taille et la couleur des - pixels sont linéairement interpolés pour donner l'apparence - d'une métamorphose d'une image à l'autre. - - - - - &reftitle.parameters; - - - - number_frames - - - Le nombre d'images à générer entre les deux images. - - - - - - - - - &reftitle.returnvalues; - - Cette méthode retourne un nouvel objet Imagick. - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/morphology.xml b/reference/imagick/imagick/morphology.xml deleted file mode 100644 index b6365b1f76..0000000000 --- a/reference/imagick/imagick/morphology.xml +++ /dev/null @@ -1,575 +0,0 @@ - - - - - - Imagick::morphology - Applique un noyau personnalisé à l'image selon la méthode de morphologie donnée - - - - &reftitle.description; - - public boolImagick::morphology - intmorphologyMethod - intiterations - ImagickKernelImagickKernel - intchannelImagick::CHANNEL_DEFAULT - - - Applique un noyau personnalisé à l'image selon la méthode de morphologie donnée. - - - - - - - - &reftitle.parameters; - - - morphologyMethod - - - Quelle méthode de morphologie utiliser parmi les constantes \Imagick::MORPHOLOGY_*. - - - - - iterations - - - Le nombre d'itérations à appliquer à la fonction de morphologie. Une valeur de -1 signifie boucler jusqu'à ce qu'aucun changement ne soit trouvé. Comment cela est appliqué peut dépendre de la méthode de morphologie. Typiquement, il s'agit d'une valeur de 1. - - - - - ImagickKernel - - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - Convolution <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_GAUSSIAN, "5,1"); - $imagick->morphology(\Imagick::MORPHOLOGY_CONVOLVE, 2, $kernel); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); - -?> -]]> - - - - - Corréler <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromMatrix(self::$correlateMatrix, [2, 2]); - $imagick->morphology(\Imagick::MORPHOLOGY_CORRELATE, 1, $kernel); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); - -?> -]]> - - - - - Eroder <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_ERODE, 2, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Eroder l'intensité <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "1"); - $canvas->morphology(\Imagick::MORPHOLOGY_ERODE_INTENSITY, 2, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Dilater <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_DILATE, 4, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Dilater l'intensité <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "1"); - $canvas->morphology(\Imagick::MORPHOLOGY_DILATE_INTENSITY, 4, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Distancer avec le noyau de Chebyshev <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_CHEBYSHEV, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_DISTANCE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Distancer avec le noyau de Manhattan <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_MANHATTAN, "5"); - $canvas->morphology(\Imagick::MORPHOLOGY_DISTANCE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Distancer avec le noyau octagonal <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGONAL, "5"); - $canvas->morphology(\Imagick::MORPHOLOGY_DISTANCE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Distancer avec le noyau euclidien <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_EUCLIDEAN, "4"); - $canvas->morphology(\Imagick::MORPHOLOGY_DISTANCE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Border <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_EDGE, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Ouvrir <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "6"); - $canvas->morphology(\Imagick::MORPHOLOGY_OPEN, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Open intensity <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "6"); - $canvas->morphology(\Imagick::MORPHOLOGY_OPEN_INTENSITY, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Fermer <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "6"); - $canvas->morphology(\Imagick::MORPHOLOGY_CLOSE, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Fermer l'intensité <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "6"); - $canvas->morphology(\Imagick::MORPHOLOGY_CLOSE_INTENSITY, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Lisser <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_SMOOTH, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Border l'intérieur<function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_EDGE_IN, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Border l'extérieur <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_EDGE_OUT, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - La méthode 'TopHat', ou plus spécifiquement 'White Top Hat', renvoie les pixels qui ont été supprimés par une Ouverture de la forme, c'est-à-dire les pixels qui ont été supprimés pour arrondir les points, et les ponts de connexion entre les formes. <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "5"); - $canvas->morphology(\Imagick::MORPHOLOGY_TOP_HAT, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - La méthode 'BottomHat', également connue sous le nom de 'Black TopHat', est les pixels qu'une Fermeture de la forme ajoute à l'image. C'est-à-dire les pixels qui ont été utilisés pour remplir les 'trous', les 'lacunes' et les 'ponts'. <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "5"); - $canvas->morphology(\Imagick::MORPHOLOGY_BOTTOM_HAT, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Toucher et manquer <function>Imagick::morphology</function> - - getCharacterOutline(); - //Cela trouve tous les pixels avec 3 pixels de l'arête droite - $matrix = [[1, false, false, 0]]; - $kernel = \ImagickKernel::fromMatrix( - $matrix, - [0, 0] - ); - $canvas->morphology(\Imagick::MORPHOLOGY_HIT_AND_MISS, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Amincir <function>Imagick::morphology</function> - - getCharacterOutline(); - $leftEdgeKernel = \ImagickKernel::fromMatrix([[0, 1]], [1, 0]); - $rightEdgeKernel = \ImagickKernel::fromMatrix([[1, 0]], [0, 0]); - $leftEdgeKernel->addKernel($rightEdgeKernel); - - $canvas->morphology(\Imagick::MORPHOLOGY_THINNING, 3, $leftEdgeKernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Épaissir <function>Imagick::morphology</function> - - getCharacterOutline(); - $leftEdgeKernel = \ImagickKernel::fromMatrix([[0, 1]], [1, 0]); - $rightEdgeKernel = \ImagickKernel::fromMatrix([[1, 0]], [0, 0]); - $leftEdgeKernel->addKernel($rightEdgeKernel); - - $canvas->morphology(\Imagick::MORPHOLOGY_THICKEN, 3, $leftEdgeKernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Amincir pour générer une coque convexe <function>Imagick::morphology</function> - - getCharacterOutline(); - $diamondKernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DIAMOND, "1"); - $convexKernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_CONVEX_HULL, ""); - - // La morphologie d'amincissement ne gère pas les petits espaces. Nous les fermons - // avec la morphologie de fermeture. - $canvas->morphology(\Imagick::MORPHOLOGY_CLOSE, 1, $diamondKernel); - $canvas->morphology(\Imagick::MORPHOLOGY_THICKEN, -1, $convexKernel); - $canvas->morphology(\Imagick::MORPHOLOGY_CLOSE, 1, $diamondKernel); - - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - La morphologie itérative <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "2"); - $canvas->morphology(\Imagick::MORPHOLOGY_ITERATIVE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - La fonction d'aide pour obtenir un contour d'image <function>Imagick::morphology</function> - -newPseudoImage( - $imagick->getImageWidth(), - $imagick->getImageHeight(), - "canvas:white" - ); - $canvas = new \Imagick(); - $canvas->newPseudoImage( - $imagick->getImageWidth(), - $imagick->getImageHeight(), - "canvas:black" - ); - - $character->compositeimage( - $imagick, - \Imagick::COMPOSITE_COPYOPACITY, - 0, 0 - ); - $canvas->compositeimage( - $character, - \Imagick::COMPOSITE_ATOP, - 0, 0 - ); - $canvas->setFormat('png'); - - return $canvas; -} -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/mosaicimages.xml b/reference/imagick/imagick/mosaicimages.xml deleted file mode 100644 index d92c1249bf..0000000000 --- a/reference/imagick/imagick/mosaicimages.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - Imagick::mosaicImages - Forme une mosaïque d'images - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::mosaicImages - - - - Aligne les images d'une séquence pour former une seule image - cohérente. La fonction retourne une baguette avec chaque - image de la séquence, à l'endroit du décalage de l'image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/motionblurimage.xml b/reference/imagick/imagick/motionblurimage.xml deleted file mode 100644 index 60b7a581cf..0000000000 --- a/reference/imagick/imagick/motionblurimage.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - Imagick::motionBlurImage - Ajoute un flou de déplacement - - - - &reftitle.description; - - public boolImagick::motionBlurImage - floatradius - floatsigma - floatangle - intchannelImagick::CHANNEL_DEFAULT - - - Ajoute un flou de déplacement. Une convolution de l'image - avec un opérateur gaussien, pour un rayon et une déviation donnés - est utilisée. Pour des résultats raisonnables, le rayon doit être - plus grand que la déviation. Utiliser un rayon de zéro, et - Imagick va choisir sa valeur pour. L'angle donne la - direction du flou de déplacement. - - - - - &reftitle.parameters; - - - - radius - - - Le rayon de la gaussienne, en pixels, sans compter le pixel du centre. - - - - - sigma - - - La déviation standard de la gaussienne, en pixels. - - - - - angle - - - L'angle du flou. - - - - - channel - - - Une constante de canal, valide pour le mode de canal. Pour spécifier un - ou plusieurs canaux, il faut combiner les constantes de canaux avec les opérateurs bit à bit. - Voir la liste de constantes de canaux. - L'argument de canal est disponible uniquement si Imagick est compilé avec - ImageMagick, version 6.4.4 ou plus récente. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::motionBlurImage</function> - -motionBlurImage($radius, $sigma, $angle, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/negateimage.xml b/reference/imagick/imagick/negateimage.xml deleted file mode 100644 index 677f2c5080..0000000000 --- a/reference/imagick/imagick/negateimage.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - Imagick::negateImage - Effectue la négation des couleurs d'une image de référence - - - - &reftitle.description; - - public boolImagick::negateImage - boolgray - intchannelImagick::CHANNEL_DEFAULT - - - Effectue la négation des couleurs d'une image de référence. - L'option de niveau de gris signifie que seules les valeurs en - niveau de gris de l'image sont soumises à la transformation. - - - - - &reftitle.parameters; - - - - gray - - - S'il faut effectuer la négation sur les niveaux de gris. - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::negateImage</function> - -negateImage($grayOnly, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/newimage.xml b/reference/imagick/imagick/newimage.xml deleted file mode 100644 index 5700322a70..0000000000 --- a/reference/imagick/imagick/newimage.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - - - Imagick::newImage - Crée une nouvelle image - - - - &reftitle.description; - - public boolImagick::newImage - intcols - introws - mixedbackground - stringformat - - - Crée une nouvelle image et lui associe un objet ImagickPixel pour la couleur de fond - - - - - &reftitle.parameters; - - - - cols - - - Le nombre de colonnes de la nouvelle image - - - - - rows - - - Le nombre de lignes de la nouvelle image - - - - - background - - - La couleur de fond utilisée pour cette image - - - - - format - - - Le format de l'image. Ce paramètre a été ajouté en Imagick version 2.0.1. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet désormais l'utilisation d'une chaîne pour représenter la couleur. - Les versions précédentes ne permettaient que les objets - ImagickPixel. - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::newImage</function> - - Crée une nouvelle image et l'affiche. - - -newImage(100, 100, new ImagickPixel('red')); -$image->setImageFormat('png'); - -header('Content-type: image/png'); -echo $image; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/newpseudoimage.xml b/reference/imagick/imagick/newpseudoimage.xml deleted file mode 100644 index 099778d30f..0000000000 --- a/reference/imagick/imagick/newpseudoimage.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - - Imagick::newPseudoImage - Crée une nouvelle image - - - - &reftitle.description; - - public boolImagick::newPseudoImage - intcolumns - introws - stringpseudoString - - - Crée une nouvelle image en utilisant les pseudoformats ImageMagick. - - - - - &reftitle.parameters; - - - - columns - - - Le nombre de colonnes dans la nouvelle image - - - - - rows - - - Le nombre de lignes dans la nouvelle image - - - - - pseudoString - - - Une chaîne contenant une pseudodéfinition d'image. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::newPseudoImage</function> - -newPseudoImage(300, 300, $canvasType); - $imagick->setImageFormat("png"); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -//newPseudoImage('gradient:red-rgba(64, 255, 255, 0.5)'); -//newPseudoImage("radial-gradient:red-blue"); -newPseudoImage("plasma:fractal"); - -?> -]]> - - - - - - - - - diff --git a/reference/imagick/imagick/nextimage.xml b/reference/imagick/imagick/nextimage.xml deleted file mode 100644 index c8f650597d..0000000000 --- a/reference/imagick/imagick/nextimage.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::nextImage - Passe à la prochaine image - - - - &reftitle.description; - - public boolImagick::nextImage - - - - Passe à la prochaine image dans la liste de l'objet Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/normalizeimage.xml b/reference/imagick/imagick/normalizeimage.xml deleted file mode 100644 index 0ac983901f..0000000000 --- a/reference/imagick/imagick/normalizeimage.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - Imagick::normalizeImage - Améliore le contraste de l'image - - - - &reftitle.description; - - public boolImagick::normalizeImage - intchannelImagick::CHANNEL_DEFAULT - - - Améliore le contraste de l'image en ajustant la couleur - des pixels à travers toute la gamme des couleurs de l'image. - - - - - &reftitle.parameters; - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::normalizeImage</function> - -cropimage($original->getImageWidth() / 2, $original->getImageHeight(), 0, 0); - $imagick->normalizeImage($channel); - $imagick->compositeimage($original, \Imagick::COMPOSITE_ATOP, 0, 0); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/oilpaintimage.xml b/reference/imagick/imagick/oilpaintimage.xml deleted file mode 100644 index 1ba7466874..0000000000 --- a/reference/imagick/imagick/oilpaintimage.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - Imagick::oilPaintImage - Simule une peinture à l'huile - - - - &reftitle.description; - - public boolImagick::oilPaintImage - floatradius - - - Applique un filtre spécial qui simule une peinture à l'huile. - Chaque pixel est remplacé par la couleur la plus fréquente dans - son voisinage. - - - - - &reftitle.parameters; - - - - radius - - - Le rayon du voisinage circulaire. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::oilPaintImage</function> - -oilPaintImage($radius); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/opaquepaintimage.xml b/reference/imagick/imagick/opaquepaintimage.xml deleted file mode 100644 index b39b0df8db..0000000000 --- a/reference/imagick/imagick/opaquepaintimage.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - - Imagick::opaquePaintImage - Modifie la valeur de la couleur de tous les pixels correspondant à la cible - - - - &reftitle.description; - - public boolImagick::opaquePaintImage - mixedtarget - mixedfill - floatfuzz - boolinvert - intchannelImagick::CHANNEL_DEFAULT - - - - Modifie tous les pixels correspondant à la couleur avec la couleur - définie par le paramètre fill. - &imagick.method.available.0x638; - - - - - &reftitle.parameters; - - - - target - - - Un objet ImagickPixel ou une &string; contenant la couleur à modifier. - - - - - fill - - - La couleur de remplacement. - - - - - fuzz - - - &imagick.parameter.fuzz; - - - - - invert - - - Si vaut &true;, colorise tous les pixels qui ne correspondent pas à la couleur cible. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/optimizeimagelayers.xml b/reference/imagick/imagick/optimizeimagelayers.xml deleted file mode 100644 index 04658bae28..0000000000 --- a/reference/imagick/imagick/optimizeimagelayers.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - Imagick::optimizeImageLayers - Supprime les portions récurrentes d'images à optimiser - - - - &reftitle.description; - - public boolImagick::optimizeImageLayers - - - - - Compare chaque image GIF à la précédente dans la séquence. A partir - de là, la méthode tente de sélectionner la plus petite partie d'image - à remplacer à chaque image, tout en préservant les résultats de l'animation. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::optimizeImageLayers</function> - - Lecture, optimisation et écriture d'une image GIF - - -optimizeImageLayers(); - -/* écriture de l'image */ -$im->writeImages("test_optimized.gif", true); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::compareImageLayers - Imagick::writeImages - Imagick::writeImage - - - - - - - diff --git a/reference/imagick/imagick/orderedposterizeimage.xml b/reference/imagick/imagick/orderedposterizeimage.xml deleted file mode 100644 index a4109fc466..0000000000 --- a/reference/imagick/imagick/orderedposterizeimage.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - - Imagick::orderedPosterizeImage - Effectue un dither ordonné - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::orderedPosterizeImage - stringthreshold_map - intchannelImagick::CHANNEL_DEFAULT - - - Effectue un dither ordonné, basé sur un nombre prédéfini de cartes - de seuil de dither, mais avec plusieurs niveaux d'intensité, qui peuvent être - différents sur différents canaux, suivant les arguments. - &imagick.method.available.0x631; - - - - - &reftitle.parameters; - - - - threshold_map - - - Une chaîne contenant le nom de la carte de seuils de dither - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::orderedPosterizeImage</function> - -orderedPosterizeImage($orderedPosterizeType); - $imagick->setImageFormat('png'); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -//orderedPosterizeImage($imagePath, 'o4x4,3,3'); -//orderedPosterizeImage($imagePath, 'o8x8,6,6'); -orderedPosterizeImage($imagePath, 'h8x8a'); - - - - - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/paintfloodfillimage.xml b/reference/imagick/imagick/paintfloodfillimage.xml deleted file mode 100644 index c0e78e2c5a..0000000000 --- a/reference/imagick/imagick/paintfloodfillimage.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - - Imagick::paintFloodfillImage - Change les pixels qui sont d'une couleur - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::paintFloodfillImage - mixedfill - floatfuzz - mixedbordercolor - intx - inty - intchannelImagick::CHANNEL_DEFAULT - - - Change les pixels qui correspondent à une couleur en une couleur de remplissage, - et qui sont un voisin immédiat. Depuis ImageMagick 6.3.8, cette méthode est obsolète - et la méthode Imagick::floodfillPaintImage doit être utilisée à la place. - - - - - &reftitle.parameters; - - - - fill - - - L'objet ImagickPixel ou une &string; - contenant la couleur de remplissage. - - - - - fuzz - - - La quantité de bruit. Par exemple, un bruit de 10 et la couleur - rouge à l'intensité de 100 et 102, respectivement, sont maintenant - interprétés comme la même couleur, dans le cadre de ce remplissage. - - - - - bordercolor - - - Un objet ImagickPixel ou une &string; - contenant la couleur de la bordure - - - - - x - - - L'abscisse position d'origine du remplissage - - - - - y - - - L'ordonnée position d'origine du remplissage - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/paintopaqueimage.xml b/reference/imagick/imagick/paintopaqueimage.xml deleted file mode 100644 index 7cc8c3d559..0000000000 --- a/reference/imagick/imagick/paintopaqueimage.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - - Imagick::paintOpaqueImage - Change les pixels qui sont d'une couleur - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::paintOpaqueImage - mixedtarget - mixedfill - floatfuzz - intchannelImagick::CHANNEL_DEFAULT - - - Change les pixels qui correspondent à une couleur en une couleur de remplissage. - - - - - &reftitle.parameters; - - - - target - - - La couleur cible, avec son opacité. Un objet ImagickPixel ou bien - une chaîne représentant la couleur cible. - - - - - fill - - - Un objet ImagickPixel ou une chaîne représentant une couleur de remplissage. - - - - - fuzz - - - Ce paramètre indique la tolérance qui permet de considérer que - deux couleurs sont identiques. - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet désormais l'utilisation d'une chaîne pour représenter la couleur. - Les versions précédentes ne permettaient que les objets - ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/painttransparentimage.xml b/reference/imagick/imagick/painttransparentimage.xml deleted file mode 100644 index 05aab9a733..0000000000 --- a/reference/imagick/imagick/painttransparentimage.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - Imagick::paintTransparentImage - Remplit les pixels avec une couleur - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::paintTransparentImage - mixedtarget - floatalpha - floatfuzz - - - Change les pixels qui correspondent à une couleur en une couleur de remplissage. - - - - - &reftitle.parameters; - - - - target - - - La couleur cible, avec son opacité. - - - - - alpha - - - Le niveau de transparence : 1.0 est totalement opaque, et - 0 est totalement transparent. - - - - - fuzz - - - Ce paramètre indique la tolérance qui permet de considérer que - deux couleurs sont identiques. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet désormais l'utilisation d'une chaîne pour représenter la couleur. - Les versions précédentes ne permettaient que les objets - ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/pingimage.xml b/reference/imagick/imagick/pingimage.xml deleted file mode 100644 index 600360f3b5..0000000000 --- a/reference/imagick/imagick/pingimage.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - Imagick::pingImage - Lit des attributs simples sans ouvrir une image - - - - &reftitle.description; - - public boolImagick::pingImage - stringfilename - - - Cette méthode peut être utilisée pour obtenir les dimensions de l'image - sans lire toute l'image en mémoire. - - - - - &reftitle.parameters; - - - - filename - - - Le nom du fichier qui contient l'image. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/pingimageblob.xml b/reference/imagick/imagick/pingimageblob.xml deleted file mode 100644 index eb909dcff6..0000000000 --- a/reference/imagick/imagick/pingimageblob.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - Imagick::pingImageBlob - Lit rapidement les attributs - - - - &reftitle.description; - - public boolImagick::pingImageBlob - stringimage - - - Cette méthode peut être utilisée pour obtenir les dimensions de l'image - sans lire toute l'image en mémoire. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - image - - - Une chaîne contenant l'image. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::pingImageBlob</function> - - Récupère une image depuis une chaîne - - -pingImageBlob($image); - -/* Affiche les dimensions de l'image */ -echo $im->getImageWidth() . 'x' . $im->getImageHeight(); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::pingImage - Imagick::pingImageFile - Imagick::readImage - Imagick::readImageBlob - Imagick::readImageFile - - - - - - - diff --git a/reference/imagick/imagick/pingimagefile.xml b/reference/imagick/imagick/pingimagefile.xml deleted file mode 100644 index 6cd5c2bf03..0000000000 --- a/reference/imagick/imagick/pingimagefile.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - Imagick::pingImageFile - Lit les attributs simples d'une image - - - - &reftitle.description; - - public boolImagick::pingImageFile - resourcefilehandle - stringfileName - - - Cette méthode peut être utilisée pour connaître les dimensions - d'une image, sans lire toute l'image. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - filehandle - - - Un flux ouvert sur une image. - - - - - fileName - - - Le nom du fichier d'image, optionnellement. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::pingImageFile</function> - - Ouverture d'une image distante. - - -pingImageFile($fp); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::pingImage - Imagick::pingImageBlob - Imagick::readImage - Imagick::readImageBlob - Imagick::readImageFile - - - - - - - diff --git a/reference/imagick/imagick/polaroidimage.xml b/reference/imagick/imagick/polaroidimage.xml deleted file mode 100644 index fb21c9a729..0000000000 --- a/reference/imagick/imagick/polaroidimage.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - Imagick::polaroidImage - Simule une photo Polaroid - - - - &reftitle.description; - - public boolImagick::polaroidImage - ImagickDrawproperties - floatangle - - - Simule une photo Polaroid. - &imagick.method.available.0x632; - - - - - &reftitle.parameters; - - - - properties - - - Les propriétés Polaroid - - - - - angle - - - L'angle Polaroid - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::polaroidImage</function> - - Un exemple d'utilisation de Imagick::polaroidImage() - - -polaroidImage(new ImagickDraw(), 25); - -/* Affiche l'image */ -header('Content-type: image/png'); -echo $image; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/posterizeimage.xml b/reference/imagick/imagick/posterizeimage.xml deleted file mode 100644 index 17bea560f8..0000000000 --- a/reference/imagick/imagick/posterizeimage.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - Imagick::posterizeImage - Réduit une image à un nombre limité de couleurs - - - - &reftitle.description; - - public boolImagick::posterizeImage - intlevels - booldither - - - Réduit une image à un nombre limité de couleurs. - - - - - &reftitle.parameters; - - - - levels - - - - - - - dither - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::posterizeImage</function> - -posterizeImage($numberLevels, $posterizeType); - $imagick->setImageFormat('png'); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -posterizeImage($imagePath, \Imagick::DITHERMETHOD_RIEMERSMA, 8); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/previewimages.xml b/reference/imagick/imagick/previewimages.xml deleted file mode 100644 index d7f75681bb..0000000000 --- a/reference/imagick/imagick/previewimages.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - Imagick::previewImages - Teste rapidement différents paramètres pour un traitement d'images - - - - &reftitle.description; - - public boolImagick::previewImages - intpreview - - - Crée un panorama de 9 miniatures de l'image spécifiée avec un traitement - appliqué à différents niveaux. Cela est pratique pour tester rapidement - différents paramètres d'un filtre. - - - - - &reftitle.parameters; - - - - preview - - - Type de prévisualisation. Voir la liste des constantes de prévisualisation - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/previousimage.xml b/reference/imagick/imagick/previousimage.xml deleted file mode 100644 index e36b779ba7..0000000000 --- a/reference/imagick/imagick/previousimage.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::previousImage - Passe à l'image précédente dans une séquence d'images - - - - &reftitle.description; - - public boolImagick::previousImage - - - - Passe à l'image précédente dans une séquence d'images Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/profileimage.xml b/reference/imagick/imagick/profileimage.xml deleted file mode 100644 index dcd214d555..0000000000 --- a/reference/imagick/imagick/profileimage.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Imagick::profileImage - Ajoute ou retire un profil d'une image - - - - &reftitle.description; - - public boolImagick::profileImage - stringname - stringprofile - - - Ajoute ou retire un profil ICC, IPTC, - ou générique d'une image. - Si le profile est &null;, - il est retiré de l'image plutôt qu'ajouté. - - - Pour retirer tous les profils de l'image, utiliser '*' - comme name et &null; pour le - profile. - - - - - &reftitle.parameters; - - - - name - - - Le nom du profil. - - - - - profile - - - Les données du profil. - Si &null;, le profil spécifié sera supprimé. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/quantizeimage.xml b/reference/imagick/imagick/quantizeimage.xml deleted file mode 100644 index 30011faef0..0000000000 --- a/reference/imagick/imagick/quantizeimage.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - Imagick::quantizeImage - Analyse les couleurs dans une référence d'image - - - - &reftitle.description; - - public boolImagick::quantizeImage - intnumberColors - intcolorspace - inttreedepth - booldither - boolmeasureError - - - - - &reftitle.parameters; - - - - numberColors - - - - - - - colorspace - - - - - - - treedepth - - - - - - - dither - - - - - - - measureError - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::quantizeImage</function> - -quantizeImage($numberColors, $colorSpace, $treeDepth, $dither, false); - $imagick->setImageFormat('png'); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/quantizeimages.xml b/reference/imagick/imagick/quantizeimages.xml deleted file mode 100644 index 8f5c86c477..0000000000 --- a/reference/imagick/imagick/quantizeimages.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - Imagick::quantizeImages - Analyse les couleurs d'une séquence d'images - - - - &reftitle.description; - - public boolImagick::quantizeImages - intnumberColors - intcolorspace - inttreedepth - booldither - boolmeasureError - - - - - &reftitle.parameters; - - - - numberColors - - - - - - - colorspace - - - - - - - treedepth - - - - - - - dither - - - - - - - measureError - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/queryfontmetrics.xml b/reference/imagick/imagick/queryfontmetrics.xml deleted file mode 100644 index 7c2523d248..0000000000 --- a/reference/imagick/imagick/queryfontmetrics.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - Imagick::queryFontMetrics - Retourne un tableau représentant les dimensions de la police - - - - &reftitle.description; - - public arrayImagick::queryFontMetrics - ImagickDrawproperties - stringtext - boolmultiline - - - Retourne un tableau multidimensionnel représentant les dimensions de la police. - - - - - &reftitle.parameters; - - - - properties - - - Un objet ImagickDraw contenant des attributs de police - - - - - text - - - Le texte - - - - - multiline - - - Un paramètre multiligne. S'il est laissé vide, il est auto-détecté. - - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau de plusieurs dimensions contenant les dimensions - de la police. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::queryFontMetrics</function> - - Demande les dimensions du texte, et affiche les valeurs à l'écran - - -setFont('/path/to/font.ttf'); - -/* Affiche les dimensions de la police, auto-détecte le multiligne */ -var_dump($im->queryFontMetrics($draw, "Hello World!")); -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/queryfonts.xml b/reference/imagick/imagick/queryfonts.xml deleted file mode 100644 index ebefc28b2e..0000000000 --- a/reference/imagick/imagick/queryfonts.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - Imagick::queryFonts - Retourne la liste de polices configurées - - - - &reftitle.description; - - public static arrayImagick::queryFonts - stringpattern"*" - - - Retourne la liste de polices configurées pour Imagick. - - - - - &reftitle.parameters; - - - - pattern - - - Le modèle de recherche - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les polices configurées. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::queryFonts</function> - - "; - - $fontList = \Imagick::queryFonts("Helvetica*"); - - foreach ($fontList as $fontName) { - $output .= '
  • '. $fontName."
    • "; - } - - return $output; - -?> -]]> -     -     -     -     - -     - - diff --git a/reference/imagick/imagick/queryformats.xml b/reference/imagick/imagick/queryformats.xml deleted file mode 100644 index 8ac68e93b4..0000000000 --- a/reference/imagick/imagick/queryformats.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - Imagick::queryFormats - Retourne les formats supportés par Imagick - - - - &reftitle.description; - - public static arrayImagick::queryFormats - stringpattern"*" - - - Retourne les formats supportés par Imagick. - - - - - &reftitle.parameters; - - - - pattern - - - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les formats supportés par Imagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::queryFormats</function> - -"; - - for ($i=0; $i < count($input); $i += $columns) { - $output .= ""; - for ($c=0; $c<$columns; $c++) { - $output .= ""; - if (($i + $c) < count($input)) { - $output .= $input[$i + $c]; - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; - } - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/radialblurimage.xml b/reference/imagick/imagick/radialblurimage.xml deleted file mode 100644 index bb8a478df9..0000000000 --- a/reference/imagick/imagick/radialblurimage.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - Imagick::radialBlurImage - Flou radial d'une image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::radialBlurImage - floatangle - intchannelImagick::CHANNEL_DEFAULT - - - Flou radial d'une image. - - - - - &reftitle.parameters; - - - - angle - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::radialBlurImage</function> - -radialBlurImage(3); - $imagick->radialBlurImage(5); - $imagick->radialBlurImage(7); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/raiseimage.xml b/reference/imagick/imagick/raiseimage.xml deleted file mode 100644 index 02c72a22ae..0000000000 --- a/reference/imagick/imagick/raiseimage.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - Imagick::raiseImage - Crée un effet 3D de bouton - - - - &reftitle.description; - - public boolImagick::raiseImage - intwidth - intheight - intx - inty - boolraise - - - Crée un effet 3D de bouton, en éclairant et assombrissant - les bords de l'image. Les membres width et height de - raise_info définissent la largeur et la hauteur de - l'effet vertical. - - - - - &reftitle.parameters; - - - - width - - - - - - - height - - - - - - - x - - - - - - - y - - - - - - - raise - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::raiseImage</function> - -raiseImage($width, $height, $x, $y, $raise); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/randomthresholdimage.xml b/reference/imagick/imagick/randomthresholdimage.xml deleted file mode 100644 index 3c887a3c62..0000000000 --- a/reference/imagick/imagick/randomthresholdimage.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - Imagick::randomThresholdImage - Crée une image en deux couleurs, à haut contraste - - - - &reftitle.description; - - public boolImagick::randomThresholdImage - floatlow - floathigh - intchannelImagick::CHANNEL_DEFAULT - - - Change la valeur de chaque pixel en fonction de l'intensité - de la couleur, et la compare à un seuil. Le résultat est une - image en deux couleurs, à haut contraste. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - low - - - Le point inférieur. - - - - - high - - - Le point supérieur. - - - - - channel - - - Fournit une constante de canal valide pour le mode de canal. - Pour utiliser plus d'un canal, il faut combiner les constantes de type - de canal en utilisant les opérateurs bit à bit. Se reporter à la liste des - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::randomThresholdImage</function> - -randomThresholdimage( - $lowThreshold * \Imagick::getQuantum(), - $highThreshold * \Imagick::getQuantum(), - $channel - ); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/readimage.xml b/reference/imagick/imagick/readimage.xml deleted file mode 100644 index 18b6c7fade..0000000000 --- a/reference/imagick/imagick/readimage.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Imagick::readImage - Lit une image depuis un fichier - - - - &reftitle.description; - - public boolImagick::readImage - stringfilename - - - Lit une image depuis un fichier. - - - - - &reftitle.parameters; - - - - filename - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/readimageblob.xml b/reference/imagick/imagick/readimageblob.xml deleted file mode 100755 index 1c28498c57..0000000000 --- a/reference/imagick/imagick/readimageblob.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - Imagick::readImageBlob - Lit une image depuis une chaîne binaire - - - - &reftitle.description; - - public boolImagick::readImageBlob - stringimage - stringfilename - - - Lit une image depuis une chaîne binaire. - - - - - &reftitle.parameters; - - - - image - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::readImageBlob</function> - -readImageBlob($imageBlob); - - header("Content-Type: image/png"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/readimagefile.xml b/reference/imagick/imagick/readimagefile.xml deleted file mode 100644 index b22d266f8c..0000000000 --- a/reference/imagick/imagick/readimagefile.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - Imagick::readImageFile - Lit une image à partir d'une ressource fichier - - - - &reftitle.description; - - public boolImagick::readImageFile - resourcefilehandle - stringfileName&null; - - - Lit une image à partir d'une ressource fichier. - - - - - &reftitle.parameters; - - - - filehandle - - - - - - - fileName - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/readimages.xml b/reference/imagick/imagick/readimages.xml deleted file mode 100644 index cab005b923..0000000000 --- a/reference/imagick/imagick/readimages.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Imagick::readimages - Lit une image à partir d'un tableau de noms de fichiers - - - - &reftitle.description; - - public boolImagick::readImages - arrayfilenames - - - Lit une image à partir d'un tableau de noms de fichiers. Toutes les images sont stockées dans un seul objet Imagick. - - - - - - - &reftitle.parameters; - - - filenames - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagick/recolorimage.xml b/reference/imagick/imagick/recolorimage.xml deleted file mode 100644 index b69f32b36e..0000000000 --- a/reference/imagick/imagick/recolorimage.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - Imagick::recolorImage - Recolore l'image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::recolorImage - arraymatrix - - - - Traduit, met à l'échelle, cisaille et fait pivoter les couleurs de l'image. - Cette méthode supporte les matrices variables de mise à l'échelle, mais normalement, - la matrice 5x5 est utilisée pour RGBA et une matrice 6x6 est utilisée pour CMYK. - La dernière ligne doit contenir les valeurs normalisées. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - matrix - - - La matrice contenant les valeurs des couleurs. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::recolorImage</function> - -recolorImage($remapColor); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::displayImage - - - - - - - diff --git a/reference/imagick/imagick/reducenoiseimage.xml b/reference/imagick/imagick/reducenoiseimage.xml deleted file mode 100644 index e756a9b961..0000000000 --- a/reference/imagick/imagick/reducenoiseimage.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - Imagick::reduceNoiseImage - Adoucit les contours d'une image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::reduceNoiseImage - floatradius - - - Adoucit les contours d'une image, tout en préservant les - informations de bords. L'algorithme fonctionne en remplaçant - chaque pixel avec la valeur la plus proche de ses voisins. - Un voisin est défini par un rayon. En utilisant un rayon de - 0, Imagick::reduceNoiseImage sélectionne - un rayon automatiquement. - - - - - &reftitle.parameters; - - - - radius - - - Le rayon de définition d'un voisin. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::reduceNoiseImage</function> - -reduceNoiseImage($reduceNoise); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/remapimage.xml b/reference/imagick/imagick/remapimage.xml deleted file mode 100644 index 53556b1c9c..0000000000 --- a/reference/imagick/imagick/remapimage.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - Imagick::remapImage - Reconfigure les couleurs de l'image - - - - &reftitle.description; - - public boolImagick::remapImage - Imagickreplacement - intDITHER - - - Remplace les couleurs de l'image avec celles définies par le paramètre - replacement. Les couleurs sont remplacées avec les couleurs - les plus proches possibles. - &imagick.method.available.0x645; - - - - - &reftitle.parameters; - - - - replacement - - - Un objet Imagick contenant les couleurs de remplacement. - - - - - DITHER - - - Se référer à la liste des constantes de la méthode dither. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/removeimage.xml b/reference/imagick/imagick/removeimage.xml deleted file mode 100644 index b1456f40b0..0000000000 --- a/reference/imagick/imagick/removeimage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::removeImage - Retire une image de la liste - - - - &reftitle.description; - - public boolImagick::removeImage - - - - Retire une image de la liste. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/removeimageprofile.xml b/reference/imagick/imagick/removeimageprofile.xml deleted file mode 100644 index 9050a54105..0000000000 --- a/reference/imagick/imagick/removeimageprofile.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Imagick::removeImageProfile - Supprime le profil de l'image et le retourne - - - - &reftitle.description; - - public stringImagick::removeImageProfile - stringname - - - Supprime le profil de l'image et le retourne. - - - - - &reftitle.parameters; - - - - name - - - - - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant le profil de l'image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/render.xml b/reference/imagick/imagick/render.xml deleted file mode 100644 index 5997d1bad9..0000000000 --- a/reference/imagick/imagick/render.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::render - Affiche toutes les commandes de dessins précédentes - - - - &reftitle.description; - - public boolImagick::render - - - - Affiche toutes les commandes de dessins précédentes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/resampleimage.xml b/reference/imagick/imagick/resampleimage.xml deleted file mode 100644 index 210dd08021..0000000000 --- a/reference/imagick/imagick/resampleimage.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - Imagick::resampleImage - Rééchantillonne l'image - - - - &reftitle.description; - - public boolImagick::resampleImage - floatx_resolution - floaty_resolution - intfilter - floatblur - - - Rééchantillonne l'image à la résolution désirée. - - - - - &reftitle.parameters; - - - - x_resolution - - - - - - - y_resolution - - - - - - - filter - - - - - - - blur - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::resampleImage</function> - -resampleImage(200, 200, \Imagick::FILTER_LANCZOS, 1); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/resetimagepage.xml b/reference/imagick/imagick/resetimagepage.xml deleted file mode 100644 index ce70d2529b..0000000000 --- a/reference/imagick/imagick/resetimagepage.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - Imagick::resetImagePage - Réinitialise la page de l'image - - - - &reftitle.description; - - public boolImagick::resetImagePage - stringpage - - - - La définition de la page sous la forme d'une &string;. - La chaîne est au format WxH+x+y. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - page - - - La définition de la page. Par exemple, 7168x5147+0+0. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/resizeimage.xml b/reference/imagick/imagick/resizeimage.xml deleted file mode 100644 index c45552b7a3..0000000000 --- a/reference/imagick/imagick/resizeimage.xml +++ /dev/null @@ -1,194 +0,0 @@ - - - - - Imagick::resizeImage - Redimensionne une image - - - - &reftitle.description; - - public boolImagick::resizeImage - intcolumns - introws - intfilter - floatblur - boolbestfit&false; - boollegacy&false; - - - Redimensionne une image aux dimensions désirées, - avec un filtre. - - &imagick.bestfit.note; - - - - &reftitle.parameters; - - - - columns - - - La largeur de l'image cible. - - - - - rows - - - La hauteur de l'image cible. - - - - - filter - - - Une constante de filtre. - - - - - blur - - - Le facteur de flou, où > 1 est flou, et < 1 est net. - - - - - bestfit - - - Paramètre optionnel de type bool. - Si défini à &true;, l'image est redimensionnée pour tenir dans les - dimensions données tout en conservant les proportions. - - - - - - legacy - - - Paramètre optionnel de type bool. - Si défini à &true;, les calculs sont effectués avec le léger bogue - d'arrondi qui existait dans Imagick avant la version 3.4.0. Si défini - à &false;, les calculs produisent les mêmes résultats que les outils - en ligne de commande d'ImageMagick. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ajout d'un paramètre optionnel de fit. Cette méthode supporte maintenant - la mise à l'échelle proportionnelle. Passez zéro comme valeur de paramètre - pour une mise à l'échelle proportionnelle. - - - - PECL imagick 3.4.0 - - Ajout du paramètre legacy. - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::resizeImage</function> - - 1 correspond à totalement flou, et < 1 correspond à fort. - $imagick = new \Imagick(realpath($imagePath)); - - $imagick->resizeImage($width, $height, $filterType, $blur, $bestFit); - - $cropWidth = $imagick->getImageWidth(); - $cropHeight = $imagick->getImageHeight(); - - if ($cropZoom) { - $newWidth = $cropWidth / 2; - $newHeight = $cropHeight / 2; - - $imagick->cropimage( - $newWidth, - $newHeight, - ($cropWidth - $newWidth) / 2, - ($cropHeight - $newHeight) / 2 - ); - - $imagick->scaleimage( - $imagick->getImageWidth() * 4, - $imagick->getImageHeight() * 4 - ); - } - - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/rollimage.xml b/reference/imagick/imagick/rollimage.xml deleted file mode 100644 index f2913c658e..0000000000 --- a/reference/imagick/imagick/rollimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - Imagick::rollImage - Décale une image - - - - &reftitle.description; - - public boolImagick::rollImage - intx - inty - - - Décale une image, d'un vecteur x, y. - - - - - &reftitle.parameters; - - - - x - - - Le décalage en abscisse. - - - - - y - - - Le décalage en ordonnée. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::rollImage</function> - -rollimage($rollX, $rollY); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/rotateimage.xml b/reference/imagick/imagick/rotateimage.xml deleted file mode 100644 index bf622fbaa7..0000000000 --- a/reference/imagick/imagick/rotateimage.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - - Imagick::rotateImage - Tourne une image - - - - &reftitle.description; - - public boolImagick::rotateImage - mixedbackground - floatdegrees - - - Tourne une image d'un nombre de degrés spécifié par - degrees. Les triangles vides ainsi - créés sont remplis avec la couleur de fond. - - - - - &reftitle.parameters; - - - - background - - - La couleur de fond - - - - - degrees - - - Angle de rotation, en degrés. L'angle de rotation est interprété - comme le nombre de degrés pour la rotation dans le sens des aiguilles - d'une montre. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet désormais l'utilisation d'une chaîne pour représenter la couleur. - Les versions précédentes ne permettaient que les objets - ImagickPixel. - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::rotateImage</function> - -rotateimage($color, $angle); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/rotationalblurimage.xml b/reference/imagick/imagick/rotationalblurimage.xml deleted file mode 100644 index d30c0a8cef..0000000000 --- a/reference/imagick/imagick/rotationalblurimage.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Imagick::rotationalBlurImage - Flou de rotation d'une image - - - - &reftitle.description; - - public boolImagick::rotationalBlurImage - floatangle - intchannelImagick::CHANNEL_DEFAULT - - - Flou de rotation d'une image. - - - - - - - &reftitle.parameters; - - - angle - - - L'angle sur lequel appliquer le flou. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::rotationalBlurImage</function> - - rotationalBlurImage(3); - $imagick->rotationalBlurImage(5); - $imagick->rotationalBlurImage(7); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/roundcorners.xml b/reference/imagick/imagick/roundcorners.xml deleted file mode 100644 index 7480468c9a..0000000000 --- a/reference/imagick/imagick/roundcorners.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - - Imagick::roundCorners - Arrondit les coins d'une image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::roundCorners - floatx_rounding - floaty_rounding - floatstroke_width10 - floatdisplace5 - floatsize_correction-6 - - - Arrondit les coins d'une image. Les deux premiers paramètres contrôlent le - niveau d'arrondi, et le troisième peut être utilisé pour affiner ce processus. - &imagick.method.available.0x629; - &imagick.method.not.available.0x700; - - - - - &reftitle.parameters; - - - - x_rounding - - - Arrondi en x - - - - - y_rounding - - - Arrondi en y - - - - - stroke_width - - - Largeur du trait - - - - - displace - - - Déplacement de l'image - - - - - size_correction - - - Correction de taille - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::roundCorners</function>: - - Arrondit les coins d'une image. - - -newPseudoImage(100, 100, "magick:rose"); -$image->setImageFormat("png"); - -$image->roundCorners(5,3); -$image->writeImage("rounded.png"); -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sampleimage.xml b/reference/imagick/imagick/sampleimage.xml deleted file mode 100644 index 1d4dbd51f1..0000000000 --- a/reference/imagick/imagick/sampleimage.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - Imagick::sampleImage - Met à l'échelle une image avec échantillonnage de pixels - - - - &reftitle.description; - - public boolImagick::sampleImage - intcolumns - introws - - - Met à l'échelle une image aux dimensions désirées, à l'aide - de la méthode d'échantillonnage de pixels. Contrairement aux - autres méthodes, cette méthode n'introduit pas de nouvelle - couleur dans l'image. - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/scaleimage.xml b/reference/imagick/imagick/scaleimage.xml deleted file mode 100644 index 6084efa837..0000000000 --- a/reference/imagick/imagick/scaleimage.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - Imagick::scaleImage - Met à l'échelle la taille de l'image - - - - &reftitle.description; - - public boolImagick::scaleImage - intcolumns - introws - boolbestfit&false; - boollegacy&false; - - - Met à l'échelle la taille de l'image, aux dimensions voulues. Dans le cas où l'un des paramètres est égal à 0, il sera automatiquement calculé. - - &imagick.bestfit.note; - - - - &reftitle.parameters; - - - - columns - - - Le nombre de colonnes dans l'image mise à l'échelle. - - - - - rows - - - Le nombre de lignes dans l'image mise à l'échelle. - - - - - bestfit - - - Indique si l'image doit tenir dans les dimensions données - tout en conservant les proportions. - - - - - legacy - - - Paramètre optionnel de type bool. - Si défini à &true;, les calculs sont effectués avec le léger bogue - d'arrondi qui existait dans Imagick avant la version 3.4.0. Si défini - à &false;, les calculs produisent les mêmes résultats que les outils - en ligne de commande d'ImageMagick. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ajout d'un paramètre optionnel de fit. Cette méthode supporte désormais - la mise à l'échelle proportionnelle. Passez zéro dans l'un des paramètres - pour activer cette option. - - - - PECL imagick 3.4.0 - - Ajout du paramètre legacy. - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::scaleImage</function> - -scaleImage(150, 150, true); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/segmentimage.xml b/reference/imagick/imagick/segmentimage.xml deleted file mode 100644 index 8bbf8d5848..0000000000 --- a/reference/imagick/imagick/segmentimage.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - - Imagick::segmentImage - Segmente une image - - - - &reftitle.description; - - public boolImagick::segmentImage - intCOLORSPACE - floatcluster_threshold - floatsmooth_threshold - boolverbose&false; - - - Analyse l'image et identifie les unités similaires. - &imagick.method.available.0x645; - - - - - &reftitle.parameters; - - - - COLORSPACE - - - Une constante parmi les constantes COLORSPACE. - - - - - cluster_threshold - - - Un pourcentage décrivant le nombre minimal de pixels - contenus dans l'hexedra avant qu'il ne soit considéré - comme valide. - - - - - smooth_threshold - - - Élimine le bruit depuis l'histogramme. - - - - - verbose - - - Si l'on doit ou non afficher les informations détaillées - sur la reconnaissance des classes. - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::segmentImage</function> - -segmentImage($colorSpace, $clusterThreshold, $smoothThreshold); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -segmentImage($imagePath, \Imagick::COLORSPACE_RGB, 5, 5); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/selectiveblurimage.xml b/reference/imagick/imagick/selectiveblurimage.xml deleted file mode 100644 index 589db9ae25..0000000000 --- a/reference/imagick/imagick/selectiveblurimage.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Imagick::selectiveBlurImage - Floute sélectivement une image dans un seuil de contraste - - - - &reftitle.description; - - public boolImagick::selectiveBlurImage - floatradius - floatsigma - floatthreshold - intchannelImagick::CHANNEL_DEFAULT - - - Floute sélectivement une image dans un seuil de contraste. Il est similaire au masque de flou qui accentue tout avec un contraste supérieur à un certain seuil. - - - - - - - &reftitle.parameters; - - - radius - - - - - - - - sigma - - - - - - - - threshold - - - - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::selectiveBlurImage</function> - - selectiveBlurImage($radius, $sigma, $threshold, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/separateimagechannel.xml b/reference/imagick/imagick/separateimagechannel.xml deleted file mode 100644 index 72a2d4c0a8..0000000000 --- a/reference/imagick/imagick/separateimagechannel.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - Imagick::separateImageChannel - Sépare un canal d'une image - - - - &reftitle.description; - - public boolImagick::separateImageChannel - intchannel - - - Sépare un canal d'une image, et retourne une image en niveaux - de gris. Un canal est un composant de couleur particulier, de - chaque pixel de l'image. - - - - - &reftitle.parameters; - - - - channel - - - Le canal à retourner. Pour les espaces de couleurs différentes de - RGB, il est possible de continuer d'utiliser les constantes CHANNEL_RED, - CHANNEL_GREEN, CHANNEL_BLUE pour indiquer le premier, second ou troisième - canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::separateImageChannel</function> - -separateimagechannel($channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -separateImageChannel($imagePath, \Imagick::CHANNEL_GREEN); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sepiatoneimage.xml b/reference/imagick/imagick/sepiatoneimage.xml deleted file mode 100644 index f8406e7c35..0000000000 --- a/reference/imagick/imagick/sepiatoneimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - Imagick::sepiaToneImage - Passe une image en tons sépia - - - - &reftitle.description; - - public boolImagick::sepiaToneImage - floatthreshold - - - Applique un effet spécial à une image, similaire à l'effet de - tons sépia, obtenus dans les chambres noires de photographie. - Le seuil va de 0 jusqu'à QuantumRange et est une mesure de - l'intervalle de tons sépia. Une valeur raisonnable est 80. - - - - - &reftitle.parameters; - - - - threshold - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::sepiaToneImage</function> - -sepiaToneImage($sepia); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setbackgroundcolor.xml b/reference/imagick/imagick/setbackgroundcolor.xml deleted file mode 100644 index 4805e3b40d..0000000000 --- a/reference/imagick/imagick/setbackgroundcolor.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Imagick::setBackgroundColor - Configure la couleur de fond par défaut - - - - &reftitle.description; - - public boolImagick::setBackgroundColor - mixedbackground - - - Configure la couleur de fond par défaut. - - - - - &reftitle.parameters; - - - - background - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet désormais l'utilisation d'une chaîne pour représenter la couleur. - Les versions précédentes ne permettaient que les objets - ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/setcolorspace.xml b/reference/imagick/imagick/setcolorspace.xml deleted file mode 100644 index 1c1e4d1d0c..0000000000 --- a/reference/imagick/imagick/setcolorspace.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - Imagick::setColorspace - Définit l'espace de couleurs - - - - &reftitle.description; - - public boolImagick::setColorspace - intCOLORSPACE - - - Définit la valeur globale de l'espace de couleurs - pour l'objet. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - - - - COLORSPACE - - - Une constante parmi les constantes COLORSPACE. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setcompression.xml b/reference/imagick/imagick/setcompression.xml deleted file mode 100644 index 2cca3c14fd..0000000000 --- a/reference/imagick/imagick/setcompression.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::setCompression - Configure le type de compression de l'objet - - - - &reftitle.description; - - public boolImagick::setCompression - intcompression - - - Configure le type de compression de l'objet. - - - - - &reftitle.parameters; - - - - compression - - - Le type de compression. Voir les constantes Imagick::COMPRESSION_*. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setcompressionquality.xml b/reference/imagick/imagick/setcompressionquality.xml deleted file mode 100644 index 5c9662f225..0000000000 --- a/reference/imagick/imagick/setcompressionquality.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - Imagick::setCompressionQuality - Configure la compression par défaut de l'objet - - - - &reftitle.description; - - public boolImagick::setCompressionQuality - intquality - - - Configure la compression par défaut de l'objet. - - - - Cette méthode ne fonctionne qu'avec les nouvelles images, c.-à-d. - celles créées avec la méthode Imagick::newPseudoImage. Pour les images - existantes, il est recommandé d'utiliser la méthode - Imagick::setImageCompressionQuality. - - - - - - &reftitle.parameters; - - - - quality - - - Un &integer; entre 1 et 100, 1 = compression élevée, 100 compression faible. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setCompressionQuality</function> - -setCompressionQuality($quality); - $imagick->newPseudoImage( - $backgroundImagick->getImageWidth(), - $backgroundImagick->getImageHeight(), - 'canvas:white' - ); - - $imagick->compositeImage( - $backgroundImagick, - \Imagick::COMPOSITE_ATOP, - 0, - 0 - ); - - $imagick->setFormat("jpg"); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setfilename.xml b/reference/imagick/imagick/setfilename.xml deleted file mode 100644 index 53f034de45..0000000000 --- a/reference/imagick/imagick/setfilename.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Imagick::setFilename - Configure le nom du fichier d'image avant d'y accéder - - - - &reftitle.description; - - public boolImagick::setFilename - stringfilename - - - Configure le nom du fichier d'image avant d'y accéder. - - - - - &reftitle.parameters; - - - - filename - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setfirstiterator.xml b/reference/imagick/imagick/setfirstiterator.xml deleted file mode 100644 index 063ce6c28b..0000000000 --- a/reference/imagick/imagick/setfirstiterator.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::setFirstIterator - Place l'itérateur de Imagick sur la première image - - - - &reftitle.description; - - public boolImagick::setFirstIterator - - - - Place l'itérateur de Imagick sur la première image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setfont.xml b/reference/imagick/imagick/setfont.xml deleted file mode 100644 index 3bbae31545..0000000000 --- a/reference/imagick/imagick/setfont.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - Imagick::setFont - Configure la police - - - - &reftitle.description; - - public boolImagick::setFont - stringfont - - - Configure la police de l'image. Cette méthode est utilisée pour configurer - la police utilisée par le pseudoformat : caption. La police - doit être configurée dans la configuration d'ImageMagick ou bien, un fichier - portant le nom de la police font doit exister. Cette - méthode ne doit pas être confondue avec la méthode - ImagickDraw::setFont qui définit la police pour un objet - ImagickDraw spécifique. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - - - - font - - - Le nom de la police ou le nom du fichier - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setFont</function> - - Exemple d'utilisation de Imagick::setFont. - - -setFont("example.ttf"); - -/* Crée un nouveau message */ -$im->newPseudoImage(100, 100, "caption:Hello"); - -/* Suite du traitement de l'image */ -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getFont - ImagickDraw::setFont - ImagickDraw::getFont - - - - - - - diff --git a/reference/imagick/imagick/setformat.xml b/reference/imagick/imagick/setformat.xml deleted file mode 100644 index 6c77901f49..0000000000 --- a/reference/imagick/imagick/setformat.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Imagick::setFormat - Configure le format de l'objet Imagick - - - - &reftitle.description; - - public boolImagick::setFormat - stringformat - - - Configure le format de l'objet Imagick. - - - - - &reftitle.parameters; - - - - format - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setgravity.xml b/reference/imagick/imagick/setgravity.xml deleted file mode 100644 index 6cf175f784..0000000000 --- a/reference/imagick/imagick/setgravity.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - Imagick::setGravity - Définit la gravité - - - - &reftitle.description; - - public boolImagick::setGravity - intgravity - - - - Définit la propriété globale de gravité pour l'objet - Imagick. - &imagick.method.available.0x640; - - - - - &reftitle.parameters; - - - - gravity - - - La propriété de gravité. Se référer à la liste des - constantes de gravité. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagick/setimage.xml b/reference/imagick/imagick/setimage.xml deleted file mode 100644 index 987657579d..0000000000 --- a/reference/imagick/imagick/setimage.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - Imagick::setImage - Remplace l'image dans l'objet - - - - &reftitle.description; - - public boolImagick::setImage - Imagickreplace - - - Remplace l'image dans la séquence d'images de l'objet. - - - - - &reftitle.parameters; - - - - replace - - - L'objet Imagick de remplacement - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setImage</function> - - Un exemple avec Imagick::setImage - - -setImage($replace); - -/* Affichage de l'image */ -header('Content-type: image/jpeg'); -echo $image; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagealphachannel.xml b/reference/imagick/imagick/setimagealphachannel.xml deleted file mode 100644 index 33a7b9c57a..0000000000 --- a/reference/imagick/imagick/setimagealphachannel.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - Imagick::setImageAlphaChannel - Définit le canal alpha de l'image - - - - &reftitle.description; - - public boolImagick::setImageAlphaChannel - intmode - - - Active ou désactive le canal alpha de l'image. Le mode - est l'une des constantes Imagick::ALPHACHANNEL_*. - &imagick.method.available.0x638; - - - - - &reftitle.parameters; - - - - mode - - - Une constante parmi les constantes Imagick::ALPHACHANNEL_*. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.seealso; - - - Imagick::setImageMatte - Les constantes du canal Alpha Imagick - - - - - - - diff --git a/reference/imagick/imagick/setimageartifact.xml b/reference/imagick/imagick/setimageartifact.xml deleted file mode 100644 index 2ac533b9f3..0000000000 --- a/reference/imagick/imagick/setimageartifact.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - Imagick::setImageArtifact - Définit l'artefact de l'image - - - - &reftitle.description; - - public boolImagick::setImageArtifact - stringartifact - stringvalue - - - Associe un artefact avec l'image. La différence entre les propriétés de l'image - et l'artefact de l'image est que les propriétés sont publiques alors que les - artefacts sont privés. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - - - - artifact - - - Le nom de l'artefact. - - - - - value - - - La valeur de l'artefact. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setImageArtifact</function> - -setImageVirtualPixelMethod(\Imagick::VIRTUALPIXELMETHOD_TRANSPARENT); - $src2->setImageArtifact('compose:args', "1,0,-0.5,0.5"); - $src1->compositeImage($src2, Imagick::COMPOSITE_MATHEMATICS, 0, 0); - - $src1->setImageFormat('png'); - header("Content-Type: image/png"); - echo $src1->getImagesBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getImageArtifact - Imagick::deleteImageArtifact - - - - - - - diff --git a/reference/imagick/imagick/setimageattribute.xml b/reference/imagick/imagick/setimageattribute.xml deleted file mode 100644 index b0481ca46c..0000000000 --- a/reference/imagick/imagick/setimageattribute.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Imagick::setImageAttribute - Définit un attribut d'image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageAttribute - stringkey - stringvalue - - - Définit un attribut d'image. - - - - - - &reftitle.parameters; - - - key - - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagick/setimagebackgroundcolor.xml b/reference/imagick/imagick/setimagebackgroundcolor.xml deleted file mode 100644 index db445fd598..0000000000 --- a/reference/imagick/imagick/setimagebackgroundcolor.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - Imagick::setImageBackgroundColor - Configure la couleur de fond d'image - - - - &reftitle.description; - - public boolImagick::setImageBackgroundColor - mixedbackground - - - Configure la couleur de fond d'image. - - - - - &reftitle.parameters; - - - - background - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet désormais l'utilisation d'une chaîne pour représenter la couleur. - Les versions précédentes ne permettaient que les objets - ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/setimagebias.xml b/reference/imagick/imagick/setimagebias.xml deleted file mode 100644 index 78afa86fef..0000000000 --- a/reference/imagick/imagick/setimagebias.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - Imagick::setImageBias - Configure le biais pour les convolutions - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageBias - floatbias - - - Configure le biais pour les convolutions, utilisées avec la fonction - Imagick::ConvolveImage. - - - - - &reftitle.parameters; - - - - bias - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setImageBias</function> - -setImageBias($bias * \Imagick::getQuantum()); - $imagick->convolveImage($xKernel, \Imagick::CHANNEL_ALL); - - $imagick->setImageFormat('png'); - - header('Content-type: image/png'); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagebiasquantum.xml b/reference/imagick/imagick/setimagebiasquantum.xml deleted file mode 100644 index f880ad0e65..0000000000 --- a/reference/imagick/imagick/setimagebiasquantum.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - Imagick::setImageBiasQuantum - Définit le biais de l'image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public voidImagick::setImageBiasQuantum - floatbias - - - Définit le biais de l'image. Le biais doit être mis à l'échelle avec 0 (pas d'ajustement) à 1 (valeur quantique). - - - - - - &reftitle.parameters; - - - bias - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagick/setimageblueprimary.xml b/reference/imagick/imagick/setimageblueprimary.xml deleted file mode 100644 index 4025e66c2f..0000000000 --- a/reference/imagick/imagick/setimageblueprimary.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - Imagick::setImageBluePrimary - Configure la chromaticité du point bleu - - - - &reftitle.description; - - public boolImagick::setImageBluePrimary - floatx - floaty - - - Configure la chromaticité du point bleu. - - - - - &reftitle.parameters; - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagebordercolor.xml b/reference/imagick/imagick/setimagebordercolor.xml deleted file mode 100644 index fda07114a5..0000000000 --- a/reference/imagick/imagick/setimagebordercolor.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - Imagick::setImageBorderColor - Configure la couleur de bordure - - - - &reftitle.description; - - public boolImagick::setImageBorderColor - mixedborder - - - Configure la couleur de bordure. - - - - - &reftitle.parameters; - - - - border - - - La couleur de bordure - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet désormais l'utilisation d'une chaîne pour représenter la couleur. - Les versions précédentes ne permettaient que les objets - ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/setimagechanneldepth.xml b/reference/imagick/imagick/setimagechanneldepth.xml deleted file mode 100644 index 024bb4937b..0000000000 --- a/reference/imagick/imagick/setimagechanneldepth.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - Imagick::setImageChannelDepth - Configure la profondeur d'un canal - - - - &reftitle.description; - - public boolImagick::setImageChannelDepth - intchannel - intdepth - - - Configure la profondeur d'un canal. - - - - - &reftitle.parameters; - - - - channel - - - - - - - depth - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageclipmask.xml b/reference/imagick/imagick/setimageclipmask.xml deleted file mode 100644 index 68f413cf44..0000000000 --- a/reference/imagick/imagick/setimageclipmask.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - - Imagick::setImageClipMask - Définit le masque du clip de l'image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageClipMask - Imagickclip_mask - - - - Définit le masque du clip de l'image depuis un autre objet - Imagick. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - clip_mask - - - L'objet Imagick contenant le masque du clip. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setImageClipMask</function> - - readImage(realpath($imagePath)); - - $width = $imagick->getImageWidth(); - $height = $imagick->getImageHeight(); - - $clipMask = new \Imagick(); - $clipMask->newPseudoImage( - $width, - $height, - "canvas:transparent" - ); - - $draw = new \ImagickDraw(); - $draw->setFillColor('white'); - $draw->circle( - $width / 2, - $height / 2, - ($width / 2) + ($width / 4), - $height / 2 - ); - $clipMask->drawImage($draw); - $imagick->setImageClipMask($clipMask); - - $imagick->negateImage(false); - $imagick->setFormat("png"); - - header("Content-Type: image/png"); - echo $imagick->getImagesBlob(); - -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagecolormapcolor.xml b/reference/imagick/imagick/setimagecolormapcolor.xml deleted file mode 100644 index cf68a0b5e6..0000000000 --- a/reference/imagick/imagick/setimagecolormapcolor.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - Imagick::setImageColormapColor - Configure une couleur de la carte - - - - &reftitle.description; - - public boolImagick::setImageColormapColor - intindex - ImagickPixelcolor - - - Configure une couleur de la carte de couleurs de l'image. - - - - - &reftitle.parameters; - - - - index - - - - - - - color - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagecolorspace.xml b/reference/imagick/imagick/setimagecolorspace.xml deleted file mode 100644 index bf3a362756..0000000000 --- a/reference/imagick/imagick/setimagecolorspace.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - Imagick::setImageColorspace - Configure l'espace de couleurs de l'image - - - - &reftitle.description; - - public boolImagick::setImageColorspace - intcolorspace - - - Configure l'espace de couleurs de l'image. Cette méthode - doit être utilisée lors de la création de nouvelles images. - Pour changer l'espace de couleurs d'une image existante, - il faut utiliser la méthode - Imagick::transformImageColorspace. - - - - - &reftitle.parameters; - - - - colorspace - - - Une des constantes COLORSPACE - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagecompose.xml b/reference/imagick/imagick/setimagecompose.xml deleted file mode 100644 index 13ae7e40fc..0000000000 --- a/reference/imagick/imagick/setimagecompose.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - Imagick::setImageCompose - Configure l'opérateur de composition de l'image - - - - &reftitle.description; - - public boolImagick::setImageCompose - intcompose - - - Configure l'opérateur de composition de l'image. Cette fonction - est pratique pour spécifier la méthode de composition des miniatures, - lors de l'utilisation de la méthode Imagick::montageImage. - - - - - &reftitle.parameters; - - - - compose - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagecompression.xml b/reference/imagick/imagick/setimagecompression.xml deleted file mode 100644 index 18ee48b087..0000000000 --- a/reference/imagick/imagick/setimagecompression.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - Imagick::setImageCompression - Configure la compression de l'image - - - - &reftitle.description; - - public boolImagick::setImageCompression - intcompression - - - Configure la compression de l'image. - - - - - &reftitle.parameters; - - - - compression - - - Une des constantes COMPRESSION. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagecompressionquality.xml b/reference/imagick/imagick/setimagecompressionquality.xml deleted file mode 100644 index b0c61850c6..0000000000 --- a/reference/imagick/imagick/setimagecompressionquality.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - Imagick::setImageCompressionQuality - Spécifie la qualité de compression de l'image - - - - &reftitle.description; - - public boolImagick::setImageCompressionQuality - intquality - - - Spécifie la qualité de compression de l'image. - - - - - &reftitle.parameters; - - - - quality - - - La qualité de compression de l'image sous forme d'entier. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setImageCompressionQuality</function> - - setImageCompressionQuality($quality); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagedelay.xml b/reference/imagick/imagick/setimagedelay.xml deleted file mode 100644 index 44030c543c..0000000000 --- a/reference/imagick/imagick/setimagedelay.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - Imagick::setImageDelay - Configure le délai de l'image - - - - &reftitle.description; - - public boolImagick::setImageDelay - intdelay - - - Configure le délai de l'image. Pour une image animée, ce sera le temps - pendant lequel la frame sera affichée, avant d'afficher la frame suivante. - - - Le délai peut être défini individuellement pour chaque frame de l'image. - - - - - &reftitle.parameters; - - - - delay - - - Le temps, exprimé en 'ticks', pendant lequel l'image sera affichée. - Pour les GIFs animés, il y a 100 ticks par seconde, aussi, une valeur - de 20 vaudra 20/100 d'une seconde, soit 1/5ème de seconde. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Modification d'un GIF animé avec <function>Imagick::setImageDelay</function> - -coalesceImages(); - -$frameCount = 0; - -foreach ($imagick as $frame) { - $imagick->setImageDelay((($frameCount % 11) * 5)); - $frameCount++; -} - -$imagick = $imagick->deconstructImages(); - -$imagick->writeImages("/chemin/de/sauvegarde/output.gif", true); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagedepth.xml b/reference/imagick/imagick/setimagedepth.xml deleted file mode 100644 index 0c603ad885..0000000000 --- a/reference/imagick/imagick/setimagedepth.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Imagick::setImageDepth - Configure la profondeur de l'image - - - - &reftitle.description; - - public boolImagick::setImageDepth - intdepth - - - Configure la profondeur de l'image. - - - - - &reftitle.parameters; - - - - depth - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagedispose.xml b/reference/imagick/imagick/setimagedispose.xml deleted file mode 100644 index a7b1911aeb..0000000000 --- a/reference/imagick/imagick/setimagedispose.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Imagick::setImageDispose - Configure la méthode de récupération - - - - &reftitle.description; - - public boolImagick::setImageDispose - intdispose - - - Configure la méthode de récupération. - - - - - &reftitle.parameters; - - - - dispose - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageextent.xml b/reference/imagick/imagick/setimageextent.xml deleted file mode 100644 index 89e57d5575..0000000000 --- a/reference/imagick/imagick/setimageextent.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - Imagick::setImageExtent - Configure la taille d'une image - - - - &reftitle.description; - - public boolImagick::setImageExtent - intcolumns - introws - - - Configure la taille d'une image (le nombre de colonnes et de lignes). - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagefilename.xml b/reference/imagick/imagick/setimagefilename.xml deleted file mode 100644 index 3834e48c72..0000000000 --- a/reference/imagick/imagick/setimagefilename.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Imagick::setImageFilename - Configure le nom de fichier d'une image dans une séquence - - - - &reftitle.description; - - public boolImagick::setImageFilename - stringfilename - - - Configure le nom de fichier d'une image dans une séquence. - - - - - &reftitle.parameters; - - - - filename - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageformat.xml b/reference/imagick/imagick/setimageformat.xml deleted file mode 100644 index f02bccc472..0000000000 --- a/reference/imagick/imagick/setimageformat.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - Imagick::setImageFormat - Configure le format d'une image dans une séquence - - - - &reftitle.description; - - public boolImagick::setImageFormat - stringformat - - - Configure le format d'une image dans une séquence. - - - - - &reftitle.parameters; - - - - format - - - La représentation en chaîne du format d'image. - Les formats supportés dépendent de l'installation ImageMagick. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagegamma.xml b/reference/imagick/imagick/setimagegamma.xml deleted file mode 100644 index ac2686fbe5..0000000000 --- a/reference/imagick/imagick/setimagegamma.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Imagick::setImageGamma - Configure la correction gamma - - - - &reftitle.description; - - public boolImagick::setImageGamma - floatgamma - - - Configure la correction gamma. - - - - - &reftitle.parameters; - - - - gamma - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagegravity.xml b/reference/imagick/imagick/setimagegravity.xml deleted file mode 100644 index ede99dd301..0000000000 --- a/reference/imagick/imagick/setimagegravity.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - Imagick::setImageGravity - Définit la gravité de l'image - - - - &reftitle.description; - - public boolImagick::setImageGravity - intgravity - - - - Définit la propriété de gravité pour l'image courante. - Cette méthode peut être utilisée pour définir la propriété - de gravité pour une seule image d'une séquence. - &imagick.method.available.0x644; - - - - - &reftitle.parameters; - - - - gravity - - - La propriété de gravité. Se référer à la liste des - constantes de gravité. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagick/setimagegreenprimary.xml b/reference/imagick/imagick/setimagegreenprimary.xml deleted file mode 100644 index f70c33820d..0000000000 --- a/reference/imagick/imagick/setimagegreenprimary.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - Imagick::setImageGreenPrimary - Configure la chromaticité du point vert - - - - &reftitle.description; - - public boolImagick::setImageGreenPrimary - floatx - floaty - - - Configure la chromaticité du point vert. - - - - - &reftitle.parameters; - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageindex.xml b/reference/imagick/imagick/setimageindex.xml deleted file mode 100644 index 24a397dad8..0000000000 --- a/reference/imagick/imagick/setimageindex.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - Imagick::setImageIndex - Modifie la position de l'itérateur - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageIndex - intindex - - - Modifie la position de l'itérateur à l'index index. - - - Cette méthode est obsolète. Voir Imagick::setIteratorIndex - - - - - &reftitle.parameters; - - - - index - - - La position à laquelle mettre l'itérateur - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageinterlacescheme.xml b/reference/imagick/imagick/setimageinterlacescheme.xml deleted file mode 100644 index 631f1fac1b..0000000000 --- a/reference/imagick/imagick/setimageinterlacescheme.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Imagick::setImageInterlaceScheme - Configure la méthode d'entrelacement de l'image - - - - &reftitle.description; - - public boolImagick::setImageInterlaceScheme - intinterlace_scheme - - - Configure la méthode d'entrelacement de l'image. - - - - - &reftitle.parameters; - - - - interlace_scheme - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageinterpolatemethod.xml b/reference/imagick/imagick/setimageinterpolatemethod.xml deleted file mode 100644 index cf67dda490..0000000000 --- a/reference/imagick/imagick/setimageinterpolatemethod.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::setImageInterpolateMethod - Configure la méthode d'interpolation de l'image - - - - &reftitle.description; - - public boolImagick::setImageInterpolateMethod - intmethod - - - Configure la méthode d'interpolation de l'image. - - - - - &reftitle.parameters; - - - - method - - - Une constante Imagick::INTERPOLATE_*. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimageiterations.xml b/reference/imagick/imagick/setimageiterations.xml deleted file mode 100644 index b2e144eef7..0000000000 --- a/reference/imagick/imagick/setimageiterations.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - Imagick::setImageIterations - Configure les itérations de l'image - - - - &reftitle.description; - - public boolImagick::setImageIterations - intiterations - - - Configure le nombre d'itérations d'affichage d'une image. - - - - - &reftitle.parameters; - - - - iterations - - - Le nombre d'itérations de l'image. Défini à 0, la boucle sera infinie. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Utilisation basique de la méthode <function>Imagick::setImageIterations</function> - -coalesceImages(); -$imagick->setImageIterations(1); -$imagick = $imagick->deconstructImages(); - -$imagick->writeImages('/chemin/de/sauvegarde/OnceOnly.gif', true); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagematte.xml b/reference/imagick/imagick/setimagematte.xml deleted file mode 100644 index 9a8ef4a54a..0000000000 --- a/reference/imagick/imagick/setimagematte.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - Imagick::setImageMatte - Configure le canal mate de l'image - - - - &reftitle.description; - - public boolImagick::setImageMatte - boolmatte - - - Configure le canal mate de l'image. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - matte - - - &true; active le canal mate, et &false; le désactive. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagemattecolor.xml b/reference/imagick/imagick/setimagemattecolor.xml deleted file mode 100644 index fdfe6af65a..0000000000 --- a/reference/imagick/imagick/setimagemattecolor.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - Imagick::setImageMatteColor - Configure la couleur mate - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageMatteColor - mixedmatte - - - Configure la couleur mate. - - - - - &reftitle.parameters; - - - - matte - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Permet désormais l'utilisation d'une chaîne pour représenter la couleur. - Les versions précédentes ne permettaient que les objets - ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/setimageopacity.xml b/reference/imagick/imagick/setimageopacity.xml deleted file mode 100644 index 6226c21659..0000000000 --- a/reference/imagick/imagick/setimageopacity.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - Imagick::setImageOpacity - Configure le niveau d'opacité de l'image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageOpacity - floatopacity - - - Configure le niveau d'opacité de l'image. - &imagick.method.available.0x631; - Cette méthode opère sur tous les canaux, ce qui signifie que, par exemple, - une valeur d'opacité de 0.5 va définir toutes les zones transparentes - en partiellement opaques. Pour ajouter de la transparence aux zones qui ne - sont actuellement pas transparentes, utiliser la méthode - Imagick::evaluateImage(). - - - - - - &reftitle.parameters; - - - - opacity - - - Le niveau de transparence : 1.0 est totalement opaque, et - 0.0 est totalement transparent. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setImageOpacity</function> - - Un exemple avec Imagick::setImageOpacity() - - -setImageOpacity(0.7); - -/* Affiche l'image */ -header('Content-type: image/png'); -echo $image; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimageorientation.xml b/reference/imagick/imagick/setimageorientation.xml deleted file mode 100644 index bd2e42b585..0000000000 --- a/reference/imagick/imagick/setimageorientation.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - Imagick::setImageOrientation - Configure l'orientation de l'image - - - - &reftitle.description; - - public boolImagick::setImageOrientation - intorientation - - - Configure l'orientation de l'image. - - - - - &reftitle.parameters; - - - - orientation - - - Une des constantes d'orientation - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setImageOrientation</function> - - setImageOrientation($orientationType); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagepage.xml b/reference/imagick/imagick/setimagepage.xml deleted file mode 100644 index 0a5a830f22..0000000000 --- a/reference/imagick/imagick/setimagepage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - Imagick::setImagePage - Configure la géométrie de la page de l'image - - - - &reftitle.description; - - public boolImagick::setImagePage - intwidth - intheight - intx - inty - - - Configure la géométrie de la page de l'image. - - - - - &reftitle.parameters; - - - - width - - - - - - - height - - - - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageprofile.xml b/reference/imagick/imagick/setimageprofile.xml deleted file mode 100644 index ee068f337a..0000000000 --- a/reference/imagick/imagick/setimageprofile.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - Imagick::setImageProfile - Ajoute un profil à un objet Imagick - - - - &reftitle.description; - - public boolImagick::setImageProfile - stringname - stringprofile - - - Ajoute un nouveau profil à un objet Imagick. - Si un profil ajouté a le même nom qu'un profil déjà ajouté, il sera remplacé. - Cette méthode diffère de Imagick::ProfileImage, - car elle n'applique aucun profil CMS. - - - - - &reftitle.parameters; - - - - name - - - - - - - profile - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageproperty.xml b/reference/imagick/imagick/setimageproperty.xml deleted file mode 100644 index 482f5fff59..0000000000 --- a/reference/imagick/imagick/setimageproperty.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - Imagick::setImageProperty - Configure une propriété d'image - - - - &reftitle.description; - - public boolImagick::setImageProperty - stringname - stringvalue - - - Configure la propriété d'image name à la valeur - value. - &imagick.method.available.0x632; - - - - - &reftitle.parameters; - - - - name - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setImageProperty</function> - - Définit et récupère les propriétés d'une image. - - -newImage(300, 200, "black"); - -$image->setImageProperty('Exif:Make', 'Imagick'); -echo $image->getImageProperty('Exif:Make'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getImageProperty - - - - - - - diff --git a/reference/imagick/imagick/setimageredprimary.xml b/reference/imagick/imagick/setimageredprimary.xml deleted file mode 100644 index fde17fa2ab..0000000000 --- a/reference/imagick/imagick/setimageredprimary.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - Imagick::setImageRedPrimary - Configure la chromaticité du point rouge - - - - &reftitle.description; - - public boolImagick::setImageRedPrimary - floatx - floaty - - - Configure la chromaticité du point rouge. - - - - - &reftitle.parameters; - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagerenderingintent.xml b/reference/imagick/imagick/setimagerenderingintent.xml deleted file mode 100644 index d3e6d9a112..0000000000 --- a/reference/imagick/imagick/setimagerenderingintent.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Imagick::setImageRenderingIntent - Configure le type de rendu de l'image - - - - &reftitle.description; - - public boolImagick::setImageRenderingIntent - intrendering_intent - - - Configure le type de rendu de l'image. - - - - - &reftitle.parameters; - - - - rendering_intent - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageresolution.xml b/reference/imagick/imagick/setimageresolution.xml deleted file mode 100644 index 1e59d87405..0000000000 --- a/reference/imagick/imagick/setimageresolution.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - Imagick::setImageResolution - Configure la résolution de l'image - - - - &reftitle.description; - - public boolImagick::setImageResolution - floatx_resolution - floaty_resolution - - - Configure la résolution de l'image. - - - - - &reftitle.parameters; - - - - x_resolution - - - - - - - y_resolution - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setImageResolution</function> - - setImageResolution(50, 50); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagescene.xml b/reference/imagick/imagick/setimagescene.xml deleted file mode 100644 index 81af89037f..0000000000 --- a/reference/imagick/imagick/setimagescene.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Imagick::setImageScene - Configure la scène de l'image - - - - &reftitle.description; - - public boolImagick::setImageScene - intscene - - - Configure la scène de l'image. - - - - - &reftitle.parameters; - - - - scene - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagetickspersecond.xml b/reference/imagick/imagick/setimagetickspersecond.xml deleted file mode 100644 index 611d1c7d5e..0000000000 --- a/reference/imagick/imagick/setimagetickspersecond.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - - Imagick::setImageTicksPerSecond - Configure le nombre de ticks par seconde de l'image - - - - &reftitle.description; - - public boolImagick::setImageTicksPerSecond - intticks_per_second - - - Ajuste la durée qu'une frame d'une image animée sera affichée. - - - - Pour les GIFs animés, cette méthode ne modifie pas le nombre de 'ticks' - par seconde, qui sera toujours défini à 100. Au lieu de cela, la méthode - va ajuster la durée d'affichage de la frame pour simuler une modification - du ticks par seconde. - - - Par exemple, pour un GIF animé où chaque frame est affichée pendant 20 ticks - (1/5ème d'une seconde), lorsque cette méthode est appelée sur chaque frame - de l'image avec un argument de 50, les frames seront ajustées - pour s'afficher pendant 40 ticks (2/5ème d'une seconde) et l'animation sera jouée - à une vitesse de moitié moins par rapport à la vitesse originale. - - - - - - &reftitle.parameters; - - - - ticks_per_second - - - La durée pendant laquelle une image sera affichée, exprimée en ticks par - seconde. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Modification d'un GIF animé avec la méthode <function>Imagick::setImageTicksPerSecond</function> - -coalesceImages(); - -$totalFrames = $imagick->getNumberImages(); - -$frameCount = 0; - -foreach ($imagick as $frame) { - $imagick->setImageTicksPerSecond(50); - - if ($frameCount < ($totalFrames / 2)) { - // Modification de la frame pour qu'elle s'affiche pendant deux fois plus de temps qu'actuellement - $imagick->setImageTicksPerSecond(50); - } else { - - // Modification de la frame pour qu'elle s'affiche pendant deux fois moins de temps qu'actuellement - $imagick->setImageTicksPerSecond(200); - } - - $frameCount++; -} - -$imagick = $imagick->deconstructImages(); - -$imagick->writeImages("/chemin/de/sauvegarde/output.gif", true); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagetype.xml b/reference/imagick/imagick/setimagetype.xml deleted file mode 100644 index 074f93fe26..0000000000 --- a/reference/imagick/imagick/setimagetype.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Imagick::setImageType - Configure le type d'image - - - - &reftitle.description; - - public boolImagick::setImageType - intimage_type - - - Convertit l'image vers le type donné, qui combine un modèle colorimétrique - et la présence ou l'absence d'un canal alpha. - Selon le type, cela peut changer l'espace colorimétrique, quantifier les - couleurs, ou modifier la présence d'un canal alpha sur l'image. - - - Imagick::setImageType modifie l'image elle-même. - Pour définir à la place le type avec lequel les images suivantes seront - écrites, utiliser Imagick::setType. - - - - - &reftitle.parameters; - - - image_type - - - Une des constantes - imagick::IMGTYPE_*. - imagick::IMGTYPE_UNDEFINED et - imagick::IMGTYPE_OPTIMIZE ne convertissent rien, - mais sont tout de même enregistrées sur l'image. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimageunits.xml b/reference/imagick/imagick/setimageunits.xml deleted file mode 100644 index caa71193f9..0000000000 --- a/reference/imagick/imagick/setimageunits.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Imagick::setImageUnits - Configure les unités de résolution de l'image - - - - &reftitle.description; - - public boolImagick::setImageUnits - intunits - - - Configure les unités de résolution de l'image. - - - - - &reftitle.parameters; - - - - units - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagevirtualpixelmethod.xml b/reference/imagick/imagick/setimagevirtualpixelmethod.xml deleted file mode 100644 index 99b9d9bdc9..0000000000 --- a/reference/imagick/imagick/setimagevirtualpixelmethod.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Imagick::setImageVirtualPixelMethod - Configure la méthode du point virtuel de l'image - - - - &reftitle.description; - - public boolImagick::setImageVirtualPixelMethod - intmethod - - - Configure la méthode du point virtuel de l'image. - - - - - &reftitle.parameters; - - - - method - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagewhitepoint.xml b/reference/imagick/imagick/setimagewhitepoint.xml deleted file mode 100644 index f4eac28a4f..0000000000 --- a/reference/imagick/imagick/setimagewhitepoint.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - Imagick::setImageWhitePoint - Configure la chromaticité du point blanc - - - - &reftitle.description; - - public boolImagick::setImageWhitePoint - floatx - floaty - - - Configure la chromaticité du point blanc. - - - - - &reftitle.parameters; - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setinterlacescheme.xml b/reference/imagick/imagick/setinterlacescheme.xml deleted file mode 100644 index 288e96ad51..0000000000 --- a/reference/imagick/imagick/setinterlacescheme.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Imagick::setInterlaceScheme - Configure la compression de l'image - - - - &reftitle.description; - - public boolImagick::setInterlaceScheme - intinterlace_scheme - - - Configure la compression de l'image. - - - - - &reftitle.parameters; - - - - interlace_scheme - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setiteratorindex.xml b/reference/imagick/imagick/setiteratorindex.xml deleted file mode 100644 index 62ef50925e..0000000000 --- a/reference/imagick/imagick/setiteratorindex.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - Imagick::setIteratorIndex - Déplace l'itérateur - - - - &reftitle.description; - - public boolImagick::setIteratorIndex - intindex - - - Déplace l'itérateur à la position index - dans la séquence d'images. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - index - - - La position finale de l'itérateur - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setIteratorIndex</function> - - Crée des images, définit et récupère l'index de l'itérateur. - - -newImage(100, 100, new ImagickPixel("red")); -$im->newImage(100, 100, new ImagickPixel("green")); -$im->newImage(100, 100, new ImagickPixel("blue")); - -$im->setIteratorIndex(1); -echo $im->getIteratorIndex(); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getIteratorIndex - Imagick::getImageIndex - Imagick::setImageIndex - - - - - - - diff --git a/reference/imagick/imagick/setlastiterator.xml b/reference/imagick/imagick/setlastiterator.xml deleted file mode 100644 index 1d5dd2f17e..0000000000 --- a/reference/imagick/imagick/setlastiterator.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::setLastIterator - Positionne l'itérateur Imagick à la dernière image - - - - &reftitle.description; - - public boolImagick::setLastIterator - - - - Positionne l'itérateur Imagick à la dernière image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setoption.xml b/reference/imagick/imagick/setoption.xml deleted file mode 100644 index 6dc9f9b6b8..0000000000 --- a/reference/imagick/imagick/setoption.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - Imagick::setOption - Configure une option d'un objet Imagick - - - - &reftitle.description; - - public boolImagick::setOption - stringkey - stringvalue - - - Configure une ou plusieurs options de l'objet Imagick. - - - - - &reftitle.parameters; - - - - key - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Tentative d'atteindre la taille '$extent' avec <function>Imagick::setOption</function> - -control->getImagePath(); - $imagick = new \Imagick(realpath($imagePath)); - $imagick->setImageFormat('jpg'); - $imagick->setOption('jpeg:extent', $extent); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); - } - -?> -]]> - - - - - Exemple avec <function>Imagick::setOption</function> - -setImageFormat('png'); - $imagick->setOption('png:format', $format); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); - } - - //Save as 64bit PNG. - renderPNG($imagePath, 'png64'); - -?> -]]> - - - - - Exemple avec <function>Imagick::setOption</function> - -control->getImagePath(); - $imagick = new \Imagick(realpath($imagePath)); - $imagick->setImageFormat('png'); - - $imagick->setOption('png:bit-depth', '16'); - $imagick->setOption('png:color-type', 6); - header("Content-Type: image/png"); - $crash = true; - if ($crash) { - echo $imagick->getImageBlob(); - } - else { - $tempFilename = tempnam('./', 'imagick'); - $imagick->writeimage(realpath($tempFilename)); - echo file_get_contents($tempFilename); - } - } - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setpage.xml b/reference/imagick/imagick/setpage.xml deleted file mode 100644 index 9d6fa29c85..0000000000 --- a/reference/imagick/imagick/setpage.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - Imagick::setPage - Configure la géométrie de la page de l'objet Imagick - - - - &reftitle.description; - - public boolImagick::setPage - intwidth - intheight - intx - inty - - - Configure la géométrie de la page de l'objet Imagick. - - - - - &reftitle.parameters; - - - - width - - - - - - - height - - - - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setpointsize.xml b/reference/imagick/imagick/setpointsize.xml deleted file mode 100644 index 6368b858e8..0000000000 --- a/reference/imagick/imagick/setpointsize.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - Imagick::setPointSize - Définit la taille du point - - - - &reftitle.description; - - public boolImagick::setPointSize - floatpoint_size - - - Définit la propriété de la taille du point de l'objet. Cette méthode - peut être utilisée pour, par exemple, définir la taille de la police - de caractères pour la légende : pseudo-format. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - - - - point_size - - - La taille du point. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setPointSize</function> - - Exemple d'utilisation de la méthode Imagick::setPointSize - - -setFont("example.ttf"); - -/* Définit la taille du point */ -$im->setPointSize(12); - -/* Crée une nouvelle légende */ -$im->newPseudoImage(100, 100, "caption:Hello"); - -/* Faites quelques choses avec votre nouvelle image */ -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getPointSize - - - - - - - diff --git a/reference/imagick/imagick/setprogressmonitor.xml b/reference/imagick/imagick/setprogressmonitor.xml deleted file mode 100644 index c662511eaa..0000000000 --- a/reference/imagick/imagick/setprogressmonitor.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - Imagick::setProgressMonitor - Définit une fonction de rappel à appeler pendant le traitement - - - - &reftitle.description; - - public boolImagick::setProgressMonitor - callablecallback - - - Définit une fonction de rappel qui sera appelée pendant le traitement de l'image Imagick. - - - - - - - - &reftitle.parameters; - - - callback - - - La fonction de progression à appeler. Elle doit retourner true si le traitement de l'image doit continuer, ou false si elle doit être annulée. Le paramètre offset indique la progression et le paramètre span indique la quantité totale de travail à effectuer. - - - - bool - - callback - - - mixedoffset - - - mixed - span - - - - - - Les valeurs passées à la fonction de rappel ne sont pas cohérentes. En particulier, le paramètre span peut augmenter pendant le traitement de l'image. En raison de cela, le calcul du pourcentage complet d'une opération d'image n'est pas trivial. - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::setProgressMonitor</function> - - control->getImagePath())); - $startTime = time(); - - $callback = function ($offset, $span) use ($startTime, &$abortReason) { - if (((100 * $offset) / $span) > 20) { - $abortReason = "Processing reached 20%"; - return false; - } - - $nowTime = time(); - - if ($nowTime - $startTime > 5) { - $abortReason = "Image processing took more than 5 seconds"; - return false; - } - if (($offset % 5) == 0) { - echo "Progress: $offset / $span
    "; - } - return true; - }; - - $imagick->setProgressMonitor($callback); - - $imagick->waveImage(2, 15); - - echo "Data len is: ".strlen($imagick->getImageBlob()); - } - catch(\ImagickException $e) { - if ($abortReason != null) { - echo "Image processing was aborted: ".$abortReason."
    "; - } - else { - echo "ImagickException caught: ".$e->getMessage()." Exception type is ".get_class($e); - } - } - -?> -]]> -     -     -     -     - -     - - diff --git a/reference/imagick/imagick/setregistry.xml b/reference/imagick/imagick/setregistry.xml deleted file mode 100644 index cc303980af..0000000000 --- a/reference/imagick/imagick/setregistry.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Imagick::setRegistry - Définit l'entrée du registre ImageMagick nommée clé pour valeur - - - - &reftitle.description; - - public static boolImagick::setRegistry - stringkey - stringvalue - - - Définit l'entrée du registre ImageMagick nommée clé pour value. C'est le plus - utile pour définir "temporary-path" qui contrôle où ImageMagick - crée des images temporaires par exemple lors du traitement de PDF. - - - - - - &reftitle.parameters; - - - key - - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagick/setresolution.xml b/reference/imagick/imagick/setresolution.xml deleted file mode 100644 index 7f163164b6..0000000000 --- a/reference/imagick/imagick/setresolution.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Imagick::setResolution - Configure la résolution de l'image - - - - &reftitle.description; - - public boolImagick::setResolution - floatx_resolution - floaty_resolution - - - Configure la résolution de l'image. - - - - - &reftitle.parameters; - - - - x_resolution - - - La résolution horizontale. - - - - - y_resolution - - - La résolution verticale. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.notes; - - Imagick::setResolution doit être appelée - avant le chargement ou la création d'une image. - - - - - &reftitle.seealso; - - Imagick::setImageResolution - Imagick::getImageResolution - - - - - - diff --git a/reference/imagick/imagick/setresourcelimit.xml b/reference/imagick/imagick/setresourcelimit.xml deleted file mode 100644 index 626e258556..0000000000 --- a/reference/imagick/imagick/setresourcelimit.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - Imagick::setResourceLimit - Définit la limite pour une ressource particulière - - - - &reftitle.description; - - public static boolImagick::setResourceLimit - inttype - intlimit - - - Cette méthode est utilisée pour modifier les limites de la ressource - de la bibliothèque sous-jacente ImageMagick. - - - - - &reftitle.parameters; - - - - type - - - Se référer à la liste des - constantes de type de ressources. - - - - - limit - - - L'une des - constantes de type de ressources. - L'unité dépend du type de la ressource à limiter. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - Imagick::getResourceLimit - - - - - - diff --git a/reference/imagick/imagick/setsamplingfactors.xml b/reference/imagick/imagick/setsamplingfactors.xml deleted file mode 100644 index 5213938378..0000000000 --- a/reference/imagick/imagick/setsamplingfactors.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - Imagick::setSamplingFactors - Configure les facteurs d'échantillonnage de l'image - - - - &reftitle.description; - - public boolImagick::setSamplingFactors - arrayfactors - - - Configure les facteurs d'échantillonnage de l'image. - - - - - &reftitle.parameters; - - - - factors - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setSamplingFactors</function> - -setImageFormat('jpg'); - $imagick->setSamplingFactors(array('2x2', '1x1', '1x1')); - - $compressed = $imagick->getImageBlob(); - - - $reopen = new \Imagick(); - $reopen->readImageBlob($compressed); - - $reopen->resizeImage( - $reopen->getImageWidth() * 4, - $reopen->getImageHeight() * 4, - \Imagick::FILTER_POINT, - 1 - ); - - header("Content-Type: image/jpg"); - echo $reopen->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setsize.xml b/reference/imagick/imagick/setsize.xml deleted file mode 100644 index 16ab6d94a2..0000000000 --- a/reference/imagick/imagick/setsize.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - Imagick::setSize - Configure la taille de l'objet Imagick - - - - &reftitle.description; - - public boolImagick::setSize - intcolumns - introws - - - Configure la taille de l'objet Imagick. - Configurer cet attribut avant d'ouvrir une image brute, aux - formats RGB, GRAY ou CMYK. - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setsizeoffset.xml b/reference/imagick/imagick/setsizeoffset.xml deleted file mode 100644 index 117f216f85..0000000000 --- a/reference/imagick/imagick/setsizeoffset.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - Imagick::setSizeOffset - Configure la taille et la position de l'objet Imagick - - - - &reftitle.description; - - public boolImagick::setSizeOffset - intcolumns - introws - intoffset - - - Configure la taille et la position de l'objet Imagick. - Configurer ces attributs avant de lire une image brute, aux - formats RGB, GRAY ou CMYK. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/settype.xml b/reference/imagick/imagick/settype.xml deleted file mode 100644 index d86cd1a118..0000000000 --- a/reference/imagick/imagick/settype.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Imagick::setType - Configure l'attribut de l'image - - - - &reftitle.description; - - public boolImagick::setType - intimage_type - - - Définit le type d'image appliqué aux images écrites par la suite. - Pour convertir l'image courante à la place, utiliser - Imagick::setImageType. - - - - - &reftitle.parameters; - - - image_type - - - Une des constantes - imagick::IMGTYPE_*. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/shadeimage.xml b/reference/imagick/imagick/shadeimage.xml deleted file mode 100644 index 9d90cb47b2..0000000000 --- a/reference/imagick/imagick/shadeimage.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - - Imagick::shadeImage - Crée un effet 3D - - - - &reftitle.description; - - public boolImagick::shadeImage - boolgray - floatazimuth - floatelevation - - - Projette une lumière distante sur l'image pour créer un effet 3D. - Il est possible de contrôler le positionnement de la lumière avec l'azimut - et l'élévation ; l'azimut est mesuré en degré de l'axe X et l'élévation - est mesurée sur l'axe Z. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - gray - - - - - - - azimuth - - - - - - - elevation - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - Lance une exception ImagickException en cas d'échec. - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::shadeImage</function> - - shadeImage(true, 45, 20); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/shadowimage.xml b/reference/imagick/imagick/shadowimage.xml deleted file mode 100644 index 50bd303bd4..0000000000 --- a/reference/imagick/imagick/shadowimage.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - Imagick::shadowImage - Simule une ombre sur l'image - - - - &reftitle.description; - - public boolImagick::shadowImage - floatopacity - floatsigma - intx - inty - - - Simule une ombre sur l'image. - - - - - &reftitle.parameters; - - - - opacity - - - - - - - sigma - - - - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::shadowImage</function> - - shadowImage(0.4, 10, 50, 5); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sharpenimage.xml b/reference/imagick/imagick/sharpenimage.xml deleted file mode 100644 index f5aed0da28..0000000000 --- a/reference/imagick/imagick/sharpenimage.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - Imagick::sharpenImage - Aiguise une image - - - - &reftitle.description; - - public boolImagick::sharpenImage - floatradius - floatsigma - intchannelImagick::CHANNEL_DEFAULT - - - Aiguise une image. Nous modifions l'image avec un opérateur Gaussien - utilisant le paramètre radius et la déviation - standard sigma. Pour de bons résultats, - le paramètre radius doit être plus élevé - que le paramètre sigma. Utiliser un radius - de 0 et Imagick::sharpenImage choisira un bon - radius à sa place. - - - - - &reftitle.parameters; - - - - radius - - - - - - - sigma - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::sharpenImage</function> - - sharpenimage($radius, $sigma, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/shaveimage.xml b/reference/imagick/imagick/shaveimage.xml deleted file mode 100644 index eb56b3ab47..0000000000 --- a/reference/imagick/imagick/shaveimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - Imagick::shaveImage - Supprime les pixels du bord de l'image - - - - &reftitle.description; - - public boolImagick::shaveImage - intcolumns - introws - - - Supprime les pixels du bord de l'image. Alloue la mémoire nécessaire - pour la structure de la nouvelle image et retourne un pointeur vers - la nouvelle image. - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::shaveImage</function> - - shaveImage(100, 50); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/shearimage.xml b/reference/imagick/imagick/shearimage.xml deleted file mode 100644 index 73f257b1b0..0000000000 --- a/reference/imagick/imagick/shearimage.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - Imagick::shearImage - Crée un parallélogramme - - - - &reftitle.description; - - public boolImagick::shearImage - mixedbackground - floatx_shear - floaty_shear - - - Bouge le côté d'une image le long des axes X ou Y, créant un parallélogramme. - Une direction X coupe le côté le long de l'axe X, tandis qu'une direction Y - coupe le côté le long de l'axe Y. La coupe est contrôlée par l'angle de coupe. - Pour une coupe de direction X, x_shear sera mesuré relativement - à l'axe Y, et similairement, pour une coupe de direction Y, y_shear est mesuré - relativement à l'axe X. Les triangles vides laissés après la coupe seront - remplis avec la couleur d'arrière plan. - - - - - &reftitle.parameters; - - - - background - - - La couleur d'arrière plan - - - - - x_shear - - - Le nombre de degrés à couper suivant l'axe X - - - - - y_shear - - - Le nombre de degrés à couper suivant l'axe Y - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Autorise maintenant une chaîne représentant la couleur comme - premier paramètre. Les anciennes versions n'autorisent que - des objets ImagickPixel. - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::shearImage</function> - - shearimage($color, $shearX, $shearY); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sigmoidalcontrastimage.xml b/reference/imagick/imagick/sigmoidalcontrastimage.xml deleted file mode 100644 index 23a87301d9..0000000000 --- a/reference/imagick/imagick/sigmoidalcontrastimage.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - Imagick::sigmoidalContrastImage - Ajuste le contraste de l'image - - - - &reftitle.description; - - public boolImagick::sigmoidalContrastImage - boolsharpen - floatalpha - floatbeta - intchannelImagick::CHANNEL_DEFAULT - - - Ajuste le contraste de l'image avec un algorithme de contraste sigmoïde - non linéaire. Augmente le contraste de l'image en utilisant une fonction - de transfert sigmoïde sans saturer les hautes lumières ni les ombres. - alpha indique de combien augmenter le contraste : - 0.00 pour ne rien faire ; 3.00 est une - valeur typique ; 20.00 est une valeur poussée. - beta indique où se situent les tons moyens dans - l'image résultante, sous la forme d'une fraction de la plage de quantum : - 0.0 correspond au blanc, 0.5 au gris - moyen, 1.0 au noir (multiplier par - getQuantumRange()['quantumRangeLong'] pour obtenir la valeur à - passer). - - - Voir aussi les exemples - d'ImageMagick -- Modifications de couleurs — Le contraste non linéaire sigmoïde. - - - - - &reftitle.parameters; - - - - sharpen - - - Si vaut &true;, le contraste augmentera, sinon, le contraste diminuera. - - - - - alpha - - - La quantité de contraste à appliquer. 1.00 représente - une toute petite quantité, 5.00 représente une - quantité significative, 20.00 est extrême. - - - - - beta - - - Où doit se situer le milieu du gradient. Cette valeur doit être dans - l'intervalle 0.00 à 1.00, - multipliée par la valeur du quantum pour ImageMagick. - - - - - channel - - - Canaux de couleurs sur lesquels le contraste doit s'appliquer. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Crée un gradient d'image en utilisant la méthode - <function>Imagick::sigmoidalContrastImage</function> - pour mélanger deux images en douceur, où le mélange est - défini par <parameter>alpha</parameter> et <parameter>beta</parameter> - - -newPseudoImage($width, $height, 'gradient:black-white'); - $quanta = $imagick->getQuantumRange(); - $imagick->sigmoidalContrastImage(true, $alpha, $beta * $quanta["quantumRangeLong"]); - - return $imagick; -} -]]> - - - - - - - diff --git a/reference/imagick/imagick/sketchimage.xml b/reference/imagick/imagick/sketchimage.xml deleted file mode 100644 index 87e5d9ef83..0000000000 --- a/reference/imagick/imagick/sketchimage.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - Imagick::sketchImage - Simule un crayon à main levée - - - - &reftitle.description; - - public boolImagick::sketchImage - floatradius - floatsigma - floatangle - - - Simule un crayon à main levée. Nous modifions l'image en utilisant - un opérateur Gaussien avec le paramètre radius - et la déviation standard sigma. Pour de bons - résultats, le paramètre radius doit être plus - élevé que le paramètre sigma. Utiliser un - radius de 0 et Imagick::sketchImage() sélectionnera - automatiquement un bon radius à sa place. Le paramètre - angle fournit l'angle du flou du mouvement. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - radius - - - - - - - sigma - - - - - - - angle - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::sketchImage</function> - - sketchimage($radius, $sigma, $angle); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/smushimages.xml b/reference/imagick/imagick/smushimages.xml deleted file mode 100644 index c8d0fa56bc..0000000000 --- a/reference/imagick/imagick/smushimages.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Imagick::smushImages - Prend toutes les images du pointeur d'image actuel jusqu'à la fin de la liste d'images et les écrase - - - - &reftitle.description; - - public ImagickImagick::smushImages - boolstack - intoffset - - - Prend toutes les images du pointeur d'image actuel jusqu'à la fin de la liste d'images et les écrase - les unes sur les autres de haut en bas si le paramètre stack est vrai, sinon de gauche à droite. - - - - - - &reftitle.parameters; - - - stack - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - La nouvelle image écrasée. - - - - - - - - &reftitle.examples; - - - <function>Imagick::smushImages</function> - - addimage($imagick2); - $smushed = $imagick->smushImages(false, 50); - $smushed->setImageFormat('jpg'); - header("Content-Type: image/jpg"); - echo $smushed->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/solarizeimage.xml b/reference/imagick/imagick/solarizeimage.xml deleted file mode 100644 index c661ec0750..0000000000 --- a/reference/imagick/imagick/solarizeimage.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - Imagick::solarizeImage - Applique un effet de solarisation à l'image - - - - &reftitle.description; - - public boolImagick::solarizeImage - intthreshold - - - Applique un effet de solarisation à l'image, similaire à l'effet effectué - dans une chambre noire en exposant des zones du papier photo sensible - à la lumière. Le seuil threshold peut aller - de 0 à QuantumRange et mesure la densité de la solarisation. - - - - - &reftitle.parameters; - - - - threshold - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::solarizeImage</function> - - solarizeImage($solarizeThreshold * \Imagick::getQuantum()); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sparsecolorimage.xml b/reference/imagick/imagick/sparsecolorimage.xml deleted file mode 100644 index cb063f1846..0000000000 --- a/reference/imagick/imagick/sparsecolorimage.xml +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - - Imagick::sparseColorImage - Interpole les couleurs - - - - &reftitle.description; - - public boolImagick::sparseColorImage - intSPARSE_METHOD - arrayarguments - intchannelImagick::CHANNEL_DEFAULT - - - Le tableau fourni par le paramètre arguments contient - les valeurs numériques utilisées par cette méthode pour interpoler les couleurs - trouvées aux coordonnées de l'image entière en utilisant le paramètre - sparse_method. - &imagick.method.available.0x645; - - - - - &reftitle.parameters; - - - - SPARSE_METHOD - - - Se référer à la liste des - constantes pour la méthode sparse. - - - - - arguments - - - Un tableau contenant les coordonnées. - Le tableau est au format array(1,1, 2,45). - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::sparseColorImage</function> et SPARSECOLORMETHOD_BARYCENTRIC - -getImageBlob(); - } - -?> -]]> - - - - - Exemple avec <function>Imagick::sparseColorImage</function> et SPARSECOLORMETHOD_BILINEAR - -getImageBlob(); - } - -?> -]]> - - - - - Exemple avec <function>Imagick::sparseColorImage</function> et SPARSECOLORMETHOD_SPEPARDS - -getImageBlob(); - } - -?> -]]> - - - - - Exemple avec <function>Imagick::sparseColorImage</function> et SPARSECOLORMETHOD_VORONOI - -getImageBlob(); - } - -?> -]]> - - - - - Exemple avec <function>Imagick::sparseColorImage</function> et SPARSECOLORMETHOD_BARYCENTRIC - -getImageBlob(); - } - -?> -]]> - - - - - createGradientImage est utilisé par les autres exemples. <function>Imagick::sparseColorImage</function> - -newImage($width, $height, "white"); - $imagick->setImageFormat("png"); - - $barycentricPoints = array(); - - foreach ($colorPoints as $colorPoint) { - - if ($absolute == true) { - $barycentricPoints[] = $colorPoint[0]; - $barycentricPoints[] = $colorPoint[1]; - } - else { - $barycentricPoints[] = $colorPoint[0] * $width; - $barycentricPoints[] = $colorPoint[1] * $height; - } - - if (is_string($colorPoint[2])) { - $imagickPixel = new \ImagickPixel($colorPoint[2]); - } - else if ($colorPoint[2] instanceof \ImagickPixel) { - $imagickPixel = $colorPoint[2]; - } - else{ - $errorMessage = sprintf( - "Value %s is neither a string nor an ImagickPixel class. Cannot use as a color.", - $colorPoint[2] - ); - - throw new \InvalidArgumentException( - $errorMessage - ); - } - - $red = $imagickPixel->getColorValue(\Imagick::COLOR_RED); - $green = $imagickPixel->getColorValue(\Imagick::COLOR_GREEN); - $blue = $imagickPixel->getColorValue(\Imagick::COLOR_BLUE); - $alpha = $imagickPixel->getColorValue(\Imagick::COLOR_ALPHA); - - $barycentricPoints[] = $red; - $barycentricPoints[] = $green; - $barycentricPoints[] = $blue; - $barycentricPoints[] = $alpha; - } - - $imagick->sparseColorImage($sparseMethod, $barycentricPoints); - - return $imagick; -} - -?> -]]> - - - - - - - - - diff --git a/reference/imagick/imagick/spliceimage.xml b/reference/imagick/imagick/spliceimage.xml deleted file mode 100644 index db0d7d4c79..0000000000 --- a/reference/imagick/imagick/spliceimage.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - Imagick::spliceImage - Joint une couleur solide dans l'image - - - - &reftitle.description; - - public boolImagick::spliceImage - intwidth - intheight - intx - inty - - - Joint une couleur solide dans l'image. - - - - - &reftitle.parameters; - - - - width - - - - - - - height - - - - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::spliceImage</function> - - spliceImage($width, $height, $startX, $startY); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/spreadimage.xml b/reference/imagick/imagick/spreadimage.xml deleted file mode 100644 index f479d9fb4b..0000000000 --- a/reference/imagick/imagick/spreadimage.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - Imagick::spreadImage - Bouge aléatoirement chaque pixel d'un bloc - - - - &reftitle.description; - - public boolImagick::spreadImage - floatradius - - - Effet spécial qui bouge aléatoirement chaque pixel d'un bloc, - défini par le paramètre radius. - - - - - &reftitle.parameters; - - - - radius - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::spreadImage</function> - - spreadImage($radius); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/statisticimage.xml b/reference/imagick/imagick/statisticimage.xml deleted file mode 100644 index c016ae58c6..0000000000 --- a/reference/imagick/imagick/statisticimage.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Imagick::statisticImage - Modifie une image en utilisant une fonction statistique - - - - &reftitle.description; - - public boolImagick::statisticImage - inttype - intwidth - intheight - intchannelImagick::CHANNEL_DEFAULT - - - Remplace chaque pixel par la statistique correspondante du voisinage de la largeur et de la hauteur spécifiées. - - - - - - &reftitle.parameters; - - - type - - - - - - - - width - - - - - - - - height - - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::statisticImage</function> - - statisticImage( - $statisticType, - $width, - $height, - $channel - ); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -statisticImage($imagePath, \Imagick::STATISTIC_MEDIAN, 5, 5, \Imagick::CHANNEL_DEFAULT); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/steganoimage.xml b/reference/imagick/imagick/steganoimage.xml deleted file mode 100644 index 76c1aa6081..0000000000 --- a/reference/imagick/imagick/steganoimage.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - Imagick::steganoImage - Cache un filigrane numérique dans l'image - - - - &reftitle.description; - - public ImagickImagick::steganoImage - Imagickwatermark_wand - intoffset - - - Cache un filigrane numérique dans l'image. Récupérer le filigrane - plus tard pour prouver l'authenticité de l'image. Le paramètre - offset définit la position de départ à - partir de laquelle on cache le filigrane. - - - - - &reftitle.parameters; - - - - watermark_wand - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/stereoimage.xml b/reference/imagick/imagick/stereoimage.xml deleted file mode 100644 index 29d348a8a8..0000000000 --- a/reference/imagick/imagick/stereoimage.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - Imagick::stereoImage - Fusionne 2 images - - - - &reftitle.description; - - public boolImagick::stereoImage - Imagickoffset_wand - - - Fusionne 2 images et produit une seule image représentant la fusion - de l'image de gauche et de droite d'une paire stéréo. - - - - - &reftitle.parameters; - - - - offset_wand - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/stripimage.xml b/reference/imagick/imagick/stripimage.xml deleted file mode 100644 index 3b0d394784..0000000000 --- a/reference/imagick/imagick/stripimage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::stripImage - Supprime d'une image tous les profils et les commentaires - - - - &reftitle.description; - - public boolImagick::stripImage - - - - Supprime d'une image tous les profils et les commentaires. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/subimagematch.xml b/reference/imagick/imagick/subimagematch.xml deleted file mode 100644 index 7082ba5842..0000000000 --- a/reference/imagick/imagick/subimagematch.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Imagick::subImageMatch - Recherche une sous-image dans l'image courante et renvoie une image de similarité - - - - &reftitle.description; - - public ImagickImagick::subImageMatch - ImagickImagick - arrayoffset - floatsimilarity - - - Recherche une sous-image dans l'image courante et renvoie une image de similarité telle qu'un emplacement de correspondance exacte est complètement blanc et si aucun des pixels ne correspond, noir, sinon un certain niveau de gris entre les deux. Il est également possible de passer les paramètres facultatifs bestMatch et similarity. Après avoir appelé la fonction, similarity sera défini sur le 'score' de la similarité entre la sous-image et la position correspondante dans l'image plus grande, bestMatch contiendra un tableau associatif avec les éléments x, y, width, height qui décrivent la région correspondante. - - - - - - - &reftitle.parameters; - - - Imagick - - - - - - - - offset - - - - - - - - similarity - - - Une nouvelle image qui affiche la quantité de similarité à chaque pixel. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::subImageMatch</function> - - cropimage(40, 40, 250, 110); - $imagick2->vignetteimage(0, 1, 3, 3); - - $similarity = null; - $bestMatch = null; - $comparison = $imagick->subImageMatch($imagick2, $bestMatch, $similarity); - - $comparison->setImageFormat('png'); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/swirlimage.xml b/reference/imagick/imagick/swirlimage.xml deleted file mode 100644 index 4c04bf21db..0000000000 --- a/reference/imagick/imagick/swirlimage.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - Imagick::swirlImage - Tourbillonne les pixels du centre de l'image - - - - &reftitle.description; - - - boolImagick::swirlImage - floatdegrees - - - Tourbillonne les pixels du centre de l'image, où le paramètre - degrees indique le degré du tourbillon de l'arc - autour duquel les pixels sont bougés. Le résultat sera des effets différents - suivant le degré choisi, entre 1 et 360. - - - - - &reftitle.parameters; - - - - degrees - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::swirlImage</function> - - swirlImage($swirl); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/textureimage.xml b/reference/imagick/imagick/textureimage.xml deleted file mode 100644 index ba8898f75d..0000000000 --- a/reference/imagick/imagick/textureimage.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - Imagick::textureImage - Répète les carreaux de la texture d'une image - - - - &reftitle.description; - - - ImagickImagick::textureImage - Imagicktexture_wand - - - Répète les carreaux de la texture d'une image via le canevas de l'image. - - - - - &reftitle.parameters; - - - - texture_wand - - - Objet Imagick à utiliser comme image de texture - - - - - - - - - &reftitle.returnvalues; - - Retourne un nouvel objet Imagick, qui a la texture répétée appliquée. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::textureImage</function> - - newImage(640, 480, new \ImagickPixel('pink')); - $image->setImageFormat("jpg"); - $texture = new \Imagick(realpath($imagePath)); - $texture->scaleimage($image->getimagewidth() / 4, $image->getimageheight() / 4); - $image = $image->textureImage($texture); - header("Content-Type: image/jpg"); - echo $image; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/thresholdimage.xml b/reference/imagick/imagick/thresholdimage.xml deleted file mode 100644 index b3a97bc988..0000000000 --- a/reference/imagick/imagick/thresholdimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - Imagick::thresholdImage - Modifie la valeur des pixels individuels, basée sur un seuil - - - - &reftitle.description; - - public boolImagick::thresholdImage - floatthreshold - intchannelImagick::CHANNEL_DEFAULT - - - Modifie la valeur des pixels individuels, basée sur l'intensité de chaque - pixel, comparée au seuil. Le résultat sera une image d'un contraste élevé - comprenant 2 couleurs. - - - - - &reftitle.parameters; - - - - threshold - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::thresholdImage</function> - - thresholdimage($threshold * \Imagick::getQuantum(), $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/thumbnailimage.xml b/reference/imagick/imagick/thumbnailimage.xml deleted file mode 100644 index 69a621b94f..0000000000 --- a/reference/imagick/imagick/thumbnailimage.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - - Imagick::thumbnailImage - Modifie la taille d'une image - - - - &reftitle.description; - - public boolImagick::thumbnailImage - intcolumns - introws - boolbestfit&false; - boolfill&false; - boollegacy&false; - - - Modifie la taille d'une image dans les dimensions données et supprime - tous les profils associés. Le but est de produire une miniature à - faible coût pour l'afficher sur le web. - Si &true; est fourni comme troisième paramètre, alors les paramètres - columns et rows seront - utilisés comme maximum de chacun des côtés. Chaque côté sera abaissé - tant que la taille désirée ne sera pas atteinte. - - &imagick.bestfit.note; - - - - &reftitle.parameters; - - - - columns - - - Largeur de l'image - - - - - rows - - - Hauteur de l'image - - - - - bestfit - - - Si l'on doit forcer les valeurs maximales - - - - - fill - - - Si l’image ne remplit pas entièrement la boîte, alors celle-ci est remplie avec - la couleur d’arrière-plan de l’image. - - - - - legacy - - - Arrondit la plus petite dimension à l’entier inférieur le plus proche. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::thumbnailImage</function> - - setbackgroundcolor('rgb(64, 64, 64)'); - $imagick->thumbnailImage(100, 100, true, true); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/tintimage.xml b/reference/imagick/imagick/tintimage.xml deleted file mode 100644 index 98baa48dc6..0000000000 --- a/reference/imagick/imagick/tintimage.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - - Imagick::tintImage - Applique un vecteur de couleur à chaque pixel de l'image - - - - &reftitle.description; - - public boolImagick::tintImage - mixedtint - mixedopacity - boollegacy&false; - - - Applique un vecteur de couleur à chaque pixel de l'image. La longueur - du vecteur est 0 pour noir et blanc et à son maximum pour des tons moyens. - La fonction de vecteur est f(x)=(1-(4.0*((x-0.5)*(x-0.5)))). - - - - - &reftitle.parameters; - - - - tint - - - - - - - opacity - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Autorise maintenant une chaîne représentant la couleur en tant - que premier paramètre et un nombre décimal représentant la valeur - d'opacité comme deuxième paramètre. Les anciennes versions autorisent - uniquement des objets ImagickPixel. - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::tintImage</function> - - newPseudoImage(400, 400, 'gradient:black-white'); - - $tint = new \ImagickPixel("rgb($r, $g, $b)"); - $opacity = new \ImagickPixel("rgb(128, 128, 128, $a)"); - $imagick->tintImage($tint, $opacity); - $imagick->setImageFormat('png'); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/toString.xml b/reference/imagick/imagick/toString.xml deleted file mode 100644 index ea1941d4a8..0000000000 --- a/reference/imagick/imagick/toString.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Imagick::__toString - Renvoie l'image sous forme de chaîne - - - - &reftitle.description; - - public stringImagick::__toString - - - - Renvoie l'image actuelle sous forme de chaîne. Cela ne renverra qu'une seule image ; cela ne doit pas être utilisé pour les objets Imagick qui contiennent plusieurs images, par exemple un GIF animé ou un PDF avec plusieurs pages. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le contenu de la chaîne en cas de succès ou une chaîne vide en cas d'échec. - - - - - - &reftitle.seealso; - - Imagick::getImageBlob - Imagick::getImagesBlob - - - - - - diff --git a/reference/imagick/imagick/transformimage.xml b/reference/imagick/imagick/transformimage.xml deleted file mode 100644 index 3bcc1574f4..0000000000 --- a/reference/imagick/imagick/transformimage.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - Imagick::transformImage - Méthode de convenance pour définir la taille de rognage et la géométrie de l'image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::transformImage - stringcrop - stringgeometry - - - Méthode de convenance pour définir la taille de rognage et la géométrie de l'image - depuis des chaînes de caractères. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - crop - - - Une géométrie de rognage. Cette géométrie définit une sous-région de l'image à - rogner. - - - - - geometry - - - Une géométrie. Cette géométrie définit la taille finale de l'image. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet Imagick contenant l'image transformée. - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::transformImage</function>: - - L'exemple crée une image noire 100x100. - - -newImage(300, 200, "black"); -$new_image = $image->transformImage("100x100", "100x100"); -$new_image->writeImage('test_out.jpg'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::cropImage - Imagick::resizeImage - Imagick::thumbnailImage - - - - - - - diff --git a/reference/imagick/imagick/transformimagecolorspace.xml b/reference/imagick/imagick/transformimagecolorspace.xml deleted file mode 100644 index 028206d5af..0000000000 --- a/reference/imagick/imagick/transformimagecolorspace.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Imagick::transformImageColorspace - Transforme une image dans un nouvel espace de couleur - - - - &reftitle.description; - - - public boolImagick::transformImageColorspace - intcolorspace - - - Transforme une image dans un nouvel espace de couleur. - - - - - &reftitle.parameters; - - - colorspace - - - L'espace de couleur dans lequel l'image doit être transformée, l'une des constantes COLORSPACE par exemple Imagick::COLORSPACE_CMYK. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - <methodname>Imagick::transformImageColorspace</methodname> example - - Transforme une image dans un nouvel espace de couleur, puis extrait un seul canal pour que les valeurs de canal individuelles puissent être visualisées. - - - -transformimagecolorspace($colorSpace); - //channel doit être une des constantes de canal par exemple \Imagick::CHANNEL_BLUE - $imagick->separateImageChannel($channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} -?> -]]> - - - - - - - - &reftitle.seealso; - - Imagick::setColorSpace - - - - - - diff --git a/reference/imagick/imagick/transparentpaintimage.xml b/reference/imagick/imagick/transparentpaintimage.xml deleted file mode 100644 index 6d17e2cf83..0000000000 --- a/reference/imagick/imagick/transparentpaintimage.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - - Imagick::transparentPaintImage - Rend des pixels transparents - - - - &reftitle.description; - - public boolImagick::transparentPaintImage - mixedtarget - floatalpha - floatfuzz - boolinvert - - - - Rend transparents les pixels correspondant à la couleur cible. - &imagick.method.available.0x638; - - - - - &reftitle.parameters; - - - - target - - - La couleur cible à rendre transparente. - - - - - alpha - - - &imagick.parameter.alpha; - - - - - fuzz - - - &imagick.parameter.fuzz; - - - - - invert - - - Si &true;, rend transparents tous les pixels qui ne correspondent - pas à la couleur cible. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::transparentPaintImage</function> - - setimageformat('png'); - - $imagick->transparentPaintImage( - $color, $alpha, $fuzz * \Imagick::getQuantum(), false - ); - - //Not required, but helps tidy up left over pixels - $imagick->despeckleimage(); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/transposeimage.xml b/reference/imagick/imagick/transposeimage.xml deleted file mode 100644 index 53128acb07..0000000000 --- a/reference/imagick/imagick/transposeimage.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - Imagick::transposeImage - Applique une symétrie verticale - - - - &reftitle.description; - - public boolImagick::transposeImage - - - - - Applique une symétrie verticale, en créant la réflexion de chaque - pixel autour d'un axe horizontal, avec une rotation de 90 degrés. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::transposeImage</function> - - transposeImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::transverseImage - - - - - - - diff --git a/reference/imagick/imagick/transverseimage.xml b/reference/imagick/imagick/transverseimage.xml deleted file mode 100644 index 3239f1e261..0000000000 --- a/reference/imagick/imagick/transverseimage.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - Imagick::transverseImage - Crée un miroir horizontal de l'image - - - - &reftitle.description; - - public boolImagick::transverseImage - - - - Crée un miroir horizontal de l'image en reflétant les pixels autour - d'un axe Y central, et en effectuant une rotation de 270 degrés. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::transverseImage</function> - - transverseImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::transposeImage - - - - - - - diff --git a/reference/imagick/imagick/trimimage.xml b/reference/imagick/imagick/trimimage.xml deleted file mode 100644 index d7c5543e35..0000000000 --- a/reference/imagick/imagick/trimimage.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - Imagick::trimImage - Supprime les bords de l'image - - - - &reftitle.description; - - public boolImagick::trimImage - floatfuzz - - - Supprime les bords qui correspondent à la couleur d'arrière-plan - de l'image. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - fuzz - - - Par défaut, la cible doit correspondre à une couleur particulière - de pixel. Cependant, dans la plupart des cas, 2 couleurs peuvent - différer légèrement. Le paramètre fuzz - de l'image définit la tolérance acceptée afin de considérer deux - couleurs comme couleurs identiques. Ce paramètre représente les - variations d'intervalle quantique. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::trimImage</function>: - - Tronque l'image, puis l'affiche au navigateur. - - -trimImage(0); - -/* Affiche l'image */ -header("Content-Type: image/" . $im->getImageFormat()); -echo $im; -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getQuantumDepth - Imagick::getQuantumRange - imagecropauto - - - - - - diff --git a/reference/imagick/imagick/uniqueimagecolors.xml b/reference/imagick/imagick/uniqueimagecolors.xml deleted file mode 100644 index ff559f1163..0000000000 --- a/reference/imagick/imagick/uniqueimagecolors.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - Imagick::uniqueImageColors - Ne conserve qu'une couleur de pixel - - - - &reftitle.description; - - public boolImagick::uniqueImageColors - - - - - Ne conserve qu'une couleur de pixel et supprime les autres. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::uniqueImageColors</function> - -quantizeImage(256, \Imagick::COLORSPACE_YIQ, 0, false, false); - $imagick->uniqueImageColors(); - $imagick->scaleimage($imagick->getImageWidth(), $imagick->getImageHeight() * 20); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/unsharpmaskimage.xml b/reference/imagick/imagick/unsharpmaskimage.xml deleted file mode 100644 index bf4bc172d3..0000000000 --- a/reference/imagick/imagick/unsharpmaskimage.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - Imagick::unsharpMaskImage - Rend une image plus nette - - - - &reftitle.description; - - public boolImagick::unsharpMaskImage - floatradius - floatsigma - floatamount - floatthreshold - intchannelImagick::CHANNEL_DEFAULT - - - Rend une image plus nette. L'image est traitée avec un opérateur Gaussien - d'un rayon donné et d'une déviation standard (sigma). Pour de bons résultats, - le rayon doit être supérieur au sigma. Avec un rayon de 0, - Imagick::UnsharpMaskImage() sélectionne un bon rayon automatiquement. - - - - - &reftitle.parameters; - - - - radius - - - - - - - sigma - - - - - - - amount - - - - - - - threshold - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::unsharpMaskImage</function> - - unsharpMaskImage($radius, $sigma, $amount, $unsharpThreshold); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/valid.xml b/reference/imagick/imagick/valid.xml deleted file mode 100644 index 75289ae134..0000000000 --- a/reference/imagick/imagick/valid.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::valid - Vérifie si l'élément courant est valide - - - - &reftitle.description; - - public boolImagick::valid - - - - Vérifie si l'élément courant est valide. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/vignetteimage.xml b/reference/imagick/imagick/vignetteimage.xml deleted file mode 100644 index d36425b399..0000000000 --- a/reference/imagick/imagick/vignetteimage.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - - Imagick::vignetteImage - Ajoute un filtre vignette à l'image - - - - &reftitle.description; - - public boolImagick::vignetteImage - floatblackPoint - floatwhitePoint - intx - inty - - - Adoucit les contours de l'image, à la mode des vignettes. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - blackPoint - - - Le point noir. - - - - - whitePoint - - - Le point blanc. - - - - - x - - - L'abscisse de l'ellipse. - - - - - y - - - L'ordonnée de l'ellipse. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::vignetteImage</function> - - vignetteImage($blackPoint, $whitePoint, $x, $y); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::waveImage - Imagick::swirlImage - - - - - - - diff --git a/reference/imagick/imagick/waveimage.xml b/reference/imagick/imagick/waveimage.xml deleted file mode 100644 index 2cfb636985..0000000000 --- a/reference/imagick/imagick/waveimage.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - - Imagick::waveImage - Ajoute un filtre de vagues à l'image - - - - &reftitle.description; - - public boolImagick::waveImage - floatamplitude - floatlength - - - - Ajoute un filtre de vagues à l'image. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - amplitude - - - Amplitude de la vague. - - - - - length - - - Longueur de la vague. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - WaveImage peut être très lent ; <function>Imagick::waveImage</function> - -waveImage($amplitude, $length); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::solarizeImage - Imagick::oilpaintImage - Imagick::embossImage - Imagick::addNoiseImage - Imagick::swirlImage - - - - - - - diff --git a/reference/imagick/imagick/whitethresholdimage.xml b/reference/imagick/imagick/whitethresholdimage.xml deleted file mode 100644 index 7321753fef..0000000000 --- a/reference/imagick/imagick/whitethresholdimage.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - Imagick::whiteThresholdImage - Force tous les pixels au-dessus du seuil en blanc - - - - &reftitle.description; - - public boolImagick::whiteThresholdImage - mixedthreshold - - - Identique à Imagick::ThresholdImage() mais force tous les pixels - au-dessus du seuil en blanc, laissant inchangés tous les pixels - en dessous du seuil. - - - - - &reftitle.parameters; - - - - threshold - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Autorise désormais une chaîne représentant la couleur - comme paramètre. Les anciennes versions ne permettaient - qu'un objet ImagickPixel. - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::whiteThresholdImage</function> - -whiteThresholdImage($color); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/writeimage.xml b/reference/imagick/imagick/writeimage.xml deleted file mode 100644 index 8d9433c380..0000000000 --- a/reference/imagick/imagick/writeimage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - Imagick::writeImage - Écrit une image dans le fichier spécifié - - - - &reftitle.description; - - public boolImagick::writeImage - stringfilenameNULL - - - Écrit une image dans un fichier spécifié. Si le paramètre - filename vaut &null;, l'image sera écrite dans le fichier - défini par Imagick::readImage() ou Imagick::setImageFilename(). - - - - - &reftitle.parameters; - - - - filename - - - Nom du fichier dans lequel l'image sera écrite. L'extension du - fichier définit le type de fichier. Le format peut être forcé - malgré l'extension de fichier en utilisant format: préfixe, par exemple - "jpg:test.png". - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/writeimagefile.xml b/reference/imagick/imagick/writeimagefile.xml deleted file mode 100644 index 91fa23c340..0000000000 --- a/reference/imagick/imagick/writeimagefile.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - Imagick::writeImageFile - Écrit une image dans un descripteur de fichier - - - - &reftitle.description; - - public boolImagick::writeImageFile - resourcefilehandle - stringformat - - - - Écrit la séquence de l'image dans un descripteur de fichier ouvert. - Le descripteur doit avoir été ouvert avec, par exemple, la fonction fopen. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - filehandle - - - Descripteur de fichier dans lequel l'image sera écrite. - - - - - format - - - Le format de l'image. - La liste des spécificateurs de format valides dépend du jeu de fonctionnalités compilé d'ImageMagick, - et peut être interrogée au moment de l'exécution via Imagick::queryFormats. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - Imagick::queryFormats - - - - diff --git a/reference/imagick/imagick/writeimages.xml b/reference/imagick/imagick/writeimages.xml deleted file mode 100644 index a67f0d8e63..0000000000 --- a/reference/imagick/imagick/writeimages.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - Imagick::writeImages - Écrit une image ou une séquence d'images - - - - &reftitle.description; - - public boolImagick::writeImages - stringfilename - booladjoin - - - Écrit une image ou une séquence d'images. - - - - - &reftitle.parameters; - - - - filename - - - - - - - adjoin - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/writeimagesfile.xml b/reference/imagick/imagick/writeimagesfile.xml deleted file mode 100644 index 237ac15a71..0000000000 --- a/reference/imagick/imagick/writeimagesfile.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - Imagick::writeImagesFile - Écrit des frames dans un descripteur de fichiers - - - - &reftitle.description; - - public boolImagick::writeImagesFile - resourcefilehandle - stringformat - - - - Écrit toutes les frames d'une image dans un descripteur de fichier. - Cette méthode peut être utilisée pour écrire des gifs animés ou d'autres - images composées de plusieurs frames dans un descripteur de fichier ouvert. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - filehandle - - - Descripteur de fichier dans lequel les frames seront écrites. - - - - - format - - - Le format de l'image. - La liste des spécificateurs de format valides dépend du jeu de fonctionnalités compilé d'ImageMagick, - et peut être interrogée au moment de l'exécution via Imagick::queryFormats. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - Imagick::queryFormats - - - - diff --git a/reference/imagick/imagickdraw.xml b/reference/imagick/imagickdraw.xml deleted file mode 100644 index c2797401d3..0000000000 --- a/reference/imagick/imagickdraw.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - La classe <classname>ImagickDraw</classname> - ImagickDraw - -
    - &reftitle.classsynopsis; - - ImagickDraw - - ImagickDraw - - - -
    -     - - &reference.imagick.entities.imagickdraw; -     - - diff --git a/reference/imagick/imagickdraw/affine.xml b/reference/imagick/imagickdraw/affine.xml deleted file mode 100644 index 0b7216f08d..0000000000 --- a/reference/imagick/imagickdraw/affine.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - - ImagickDraw::affine - Ajuste la matrice de transformation affine courante - - - - &reftitle.description; - - public boolImagickDraw::affine - arrayaffine - - &warn.undocumented.func; - - Ajuste la matrice de transformation affine courante, avec la nouvelle - matrice de transformation. - - - - - &reftitle.parameters; - - - - affine - - - Paramètres de matrice de transformation affine. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::affine</function> - -setStrokeWidth(1); - $draw->setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - - $PI = 3.141592653589794; - $angle = 60 * $PI / 360; - - //Scale the drawing co-ordinates. - $affineScale = array("sx" => 1.75, "sy" => 1.75, "rx" => 0, "ry" => 0, "tx" => 0, "ty" => 0); - - //Shear the drawing co-ordinates. - $affineShear = array("sx" => 1, "sy" => 1, "rx" => sin($angle), "ry" => -sin($angle), "tx" => 0, "ty" => 0); - - //Rotate the drawing co-ordinates. The shear affine matrix - //produces incorrectly scaled drawings. - $affineRotate = array("sx" => cos($angle), "sy" => cos($angle), "rx" => sin($angle), "ry" => -sin($angle), "tx" => 0, "ty" => 0,); - - //Translate (offset) the drawing - $affineTranslate = array("sx" => 1, "sy" => 1, "rx" => 0, "ry" => 0, "tx" => 30, "ty" => 30); - - //The identity affine matrix - $affineIdentity = array("sx" => 1, "sy" => 1, "rx" => 0, "ry" => 0, "tx" => 0, "ty" => 0); - - $examples = [$affineScale, $affineShear, $affineRotate, $affineTranslate, $affineIdentity,]; - - $count = 0; - - foreach ($examples as $example) { - $draw->push(); - $draw->translate(($count % 2) * 250, intval($count / 2) * 250); - $draw->translate(100, 100); - $draw->affine($example); - $draw->rectangle(-50, -50, 50, 50); - $draw->pop(); - $count++; - } - - //Create an image object which the draw commands can be rendered into - $image = new \Imagick(); - $image->newImage(500, 750, $backgroundColor); - $image->setImageFormat("png"); - - //Render the draw commands in the ImagickDraw object - //into the image. - $image->drawImage($draw); - - //Send the image to the browser - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/annotation.xml b/reference/imagick/imagickdraw/annotation.xml deleted file mode 100644 index 42b399e7f1..0000000000 --- a/reference/imagick/imagickdraw/annotation.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - ImagickDraw::annotation - Dessine un texte sur une image - - - - &reftitle.description; - - public boolImagickDraw::annotation - floatx - floaty - stringtext - - &warn.undocumented.func; - - Dessine un texte sur une image. - - - - - &reftitle.parameters; - - - - x - - - L'abscisse du texte à dessiner. - - - - - y - - - L'ordonnée du texte à dessiner. - - - - - text - - - Le texte à dessiner. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/arc.xml b/reference/imagick/imagickdraw/arc.xml deleted file mode 100644 index 626735b17d..0000000000 --- a/reference/imagick/imagickdraw/arc.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - ImagickDraw::arc - Dessine un arc - - - - &reftitle.description; - - public boolImagickDraw::arc - floatstart_x - floatstart_y - floatend_x - floatend_y - floatstart_angle - floatend_angle - - &warn.undocumented.func; - - Dessine un arc, placé à l'intérieur d'un rectangle. - - - - - &reftitle.parameters; - - - - start_x - - - Abscisse du point de début d'arc dans le rectangle d'encadrement - - - - - start_y - - - Ordonnée du point de début d'arc dans le rectangle d'encadrement - - - - - end_x - - - Abscisse du point de fin d'arc dans le rectangle d'encadrement - - - - - end_y - - - Ordonnée du point de fin d'arc dans le rectangle d'encadrement - - - - - start_angle - - - Degré de rotation initial - - - - - end_angle - - - Degré de rotation final - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::arc</function> - -setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - - $draw->arc($startX, $startY, $endX, $endY, $startAngle, $endAngle); - - //Create an image object which the draw commands can be rendered into - $image = new \Imagick(); - $image->newImage(IMAGE_WIDTH, IMAGE_HEIGHT, $backgroundColor); - $image->setImageFormat("png"); - - //Render the draw commands in the ImagickDraw object - //into the image. - $image->drawImage($draw); - - //Send the image to the browser - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/bezier.xml b/reference/imagick/imagickdraw/bezier.xml deleted file mode 100644 index 6bd906085d..0000000000 --- a/reference/imagick/imagickdraw/bezier.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - - ImagickDraw::bezier - Dessine une courbe de Bézier - - - - &reftitle.description; - - public boolImagickDraw::bezier - arraycoordinates - - &warn.undocumented.func; - - Dessine une courbe de Bézier, à l'aide d'une série de points de contrôle. - - - - - &reftitle.parameters; - - - - coordinates - - - Tableau multidimensionnel tel que - array( array( 'x' => 1, 'y' => 2 ), array( 'x' => 3, 'y' => 4 ) ) - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::bezier</function> - -setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - - $smoothPointsSet = [ - [ - ['x' => 10.0 * 5, 'y' => 10.0 * 5], - ['x' => 30.0 * 5, 'y' => 90.0 * 5], - ['x' => 25.0 * 5, 'y' => 10.0 * 5], - ['x' => 50.0 * 5, 'y' => 50.0 * 5], - ], - [ - ['x' => 50.0 * 5, 'y' => 50.0 * 5], - ['x' => 75.0 * 5, 'y' => 90.0 * 5], - ['x' => 70.0 * 5, 'y' => 10.0 * 5], - ['x' => 90.0 * 5, 'y' => 40.0 * 5], - ], - ]; - - foreach ($smoothPointsSet as $points) { - $draw->bezier($points); - } - - $disjointPoints = [ - [ - ['x' => 10 * 5, 'y' => 10 * 5], - ['x' => 30 * 5, 'y' => 90 * 5], - ['x' => 25 * 5, 'y' => 10 * 5], - ['x' => 50 * 5, 'y' => 50 * 5], - ], - [ - ['x' => 50 * 5, 'y' => 50 * 5], - ['x' => 80 * 5, 'y' => 50 * 5], - ['x' => 70 * 5, 'y' => 10 * 5], - ['x' => 90 * 5, 'y' => 40 * 5], - ] - ]; - $draw->translate(0, 200); - - foreach ($disjointPoints as $points) { - $draw->bezier($points); - } - - //Création d'un objet image dans lequel on appliquera les commandes de dessin - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - //On applique les commandes de dessin à l'objet ImagickDraw - //et dans l'image. - $imagick->drawImage($draw); - - //On envoie l'image au navigateur - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/circle.xml b/reference/imagick/imagickdraw/circle.xml deleted file mode 100644 index bf708863c1..0000000000 --- a/reference/imagick/imagickdraw/circle.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - ImagickDraw::circle - Dessine un cercle - - - - &reftitle.description; - - public boolImagickDraw::circle - floatorigin_x - floatorigin_y - floatperimeter_x - floatperimeter_y - - &warn.undocumented.func; - - Dessine un cercle. - - - - - &reftitle.parameters; - - - - origin_x - - - abscisse de l'origine - - - - - origin_y - - - ordonnée de l'origine - - - - - perimeter_x - - - abscisse du périmètre - - - - - perimeter_y - - - ordonnée du périmètre - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::circle</function> - -setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->circle($originX, $originY, $endX, $endY); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/clear.xml b/reference/imagick/imagickdraw/clear.xml deleted file mode 100644 index 416480e20c..0000000000 --- a/reference/imagick/imagickdraw/clear.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::clear - Efface tout l'objet ImagickDraw - - - - &reftitle.description; - - public boolImagickDraw::clear - - - &warn.undocumented.func; - - Efface tout l'objet ImagickDraw et toutes les commandes accumulées, - puis remet les directives à leur valeur par défaut. - - - - - &reftitle.returnvalues; - - Retourne un objet ImagickDraw. - - - - - - diff --git a/reference/imagick/imagickdraw/clone.xml b/reference/imagick/imagickdraw/clone.xml deleted file mode 100644 index ed46e11a00..0000000000 --- a/reference/imagick/imagickdraw/clone.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::clone - Fait une copie exacte de l'objet ImagickDraw - - - - &reftitle.description; - - public ImagickDrawImagickDraw::clone - - - &warn.undocumented.func; - - Fait une copie exacte de l'objet ImagickDraw. - - - - - &reftitle.returnvalues; - - Retourne une copie exacte de l'objet ImagickDraw. - - - - - - diff --git a/reference/imagick/imagickdraw/color.xml b/reference/imagick/imagickdraw/color.xml deleted file mode 100644 index b90e7e81d7..0000000000 --- a/reference/imagick/imagickdraw/color.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - ImagickDraw::color - Dessine une couleur sur une image - - - - &reftitle.description; - - public boolImagickDraw::color - floatx - floaty - intpaint - - &warn.undocumented.func; - - Dessine une couleur sur une image, avec la couleur de remplissage courante, - en commençant à une position donnée, et en utilisant la méthode de coloration - indiquée. - - - - - &reftitle.parameters; - - - - x - - - abscisse du point de peinture - - - - - y - - - ordonnée du point de peinture - - - - - paint - - - Une des constantes PAINT - (imagick::PAINT_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/comment.xml b/reference/imagick/imagickdraw/comment.xml deleted file mode 100644 index 9a53104036..0000000000 --- a/reference/imagick/imagickdraw/comment.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - ImagickDraw::comment - Ajoute un commentaire - - - - &reftitle.description; - - public boolImagickDraw::comment - stringcomment - - &warn.undocumented.func; - - Ajoute un commentaire au flux de sortie. - - - - - &reftitle.parameters; - - - - comment - - - La chaîne de commentaire - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/composite.xml b/reference/imagick/imagickdraw/composite.xml deleted file mode 100644 index b992bab6ee..0000000000 --- a/reference/imagick/imagickdraw/composite.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - ImagickDraw::composite - Compose une image avec une autre - - - - &reftitle.description; - - public boolImagickDraw::composite - intcomposite - floatx - floaty - floatwidth - floatheight - Imagickimage - - &warn.undocumented.func; - - Compose une image avec une autre image, en utilisant l'opérateur de - composition, à la position et à la taille indiquées. - - - - - &reftitle.parameters; - - - - composite - - - l'opérateur de composition. - Une des constantes d'opérateur de composition - (imagick::COMPOSITE_*). - - - - - x - - - abscisse du coin supérieur gauche. - - - - - y - - - ordonnée du coin supérieur gauche. - - - - - width - - - largeur de l'image de composition. - - - - - height - - - hauteur de l'image de composition. - - - - - image - - - L'objet Imagick où la composition est prise. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::composite</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setFillOpacity(1); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setStrokeWidth(2); - $draw->setFont("../fonts/CANDY.TTF"); - $draw->setFontSize(140); - $draw->rectangle(0, 0, 1000, 300); - $draw->setFillColor('white'); - $draw->setfillopacity(1); - $draw->annotation(50, 180, "Lorem Ipsum!"); - - //Crée un objet image servant de base - $imagick = new \Imagick(); - $imagick->newImage(1000, 302, $backgroundColor); - $imagick->setImageFormat("png"); - - //On applique les commandes de dessin dans l'objet ImagickDraw - //et dans l'image. - $imagick->drawImage($draw); - - //On envoie l'image au navigateur - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/construct.xml b/reference/imagick/imagickdraw/construct.xml deleted file mode 100644 index d9504bd329..0000000000 --- a/reference/imagick/imagickdraw/construct.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - ImagickDraw::__construct - Le constructeur ImagickDraw - - - - &reftitle.description; - - public ImagickDraw::__construct - - - &warn.undocumented.func; - - Le constructeur de la classe ImagickDraw. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/destroy.xml b/reference/imagick/imagickdraw/destroy.xml deleted file mode 100644 index 9a838edded..0000000000 --- a/reference/imagick/imagickdraw/destroy.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::destroy - Libère toutes les ressources associées à un objet ImagickDraw - - - - &reftitle.description; - - public boolImagickDraw::destroy - - - &warn.undocumented.func; - - Libère toutes les ressources associées à un objet - ImagickDraw. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/ellipse.xml b/reference/imagick/imagickdraw/ellipse.xml deleted file mode 100644 index c63a8cdaf5..0000000000 --- a/reference/imagick/imagickdraw/ellipse.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - ImagickDraw::ellipse - Dessine une ellipse sur une image - - - - &reftitle.description; - - public boolImagickDraw::ellipse - floatorigin_x - floatorigin_y - floatradius_x - floatradius_y - floatangle_start - floatangle_end - - &warn.undocumented.func; - - Dessine une ellipse sur une image. - - - - - &reftitle.parameters; - - - - origin_x - - - - - - - origin_y - - - - - - - radius_x - - - - - - - radius_y - - - - - - - angle_start - - - - - - - angle_end - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::ellipse</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->ellipse(125, 70, 100, 50, 0, 360); - $draw->ellipse(350, 70, 100, 50, 0, 315); - - $draw->push(); - $draw->translate(125, 250); - $draw->rotate(30); - $draw->ellipse(0, 0, 100, 50, 0, 360); - $draw->pop(); - - $draw->push(); - $draw->translate(350, 250); - $draw->rotate(30); - $draw->ellipse(0, 0, 100, 50, 0, 315); - $draw->pop(); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/getclippath.xml b/reference/imagick/imagickdraw/getclippath.xml deleted file mode 100644 index f0e464b406..0000000000 --- a/reference/imagick/imagickdraw/getclippath.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - ImagickDraw::getClipPath - Retourne l'identifiant du chemin courant - - - - &reftitle.description; - - public falsestringImagickDraw::getClipPath - - - &warn.undocumented.func; - - Retourne l'identifiant du chemin courant. - - - - - &reftitle.returnvalues; - - Retourne une chaîne, ou &false; si aucun chemin n'existe. - - - - - - diff --git a/reference/imagick/imagickdraw/getcliprule.xml b/reference/imagick/imagickdraw/getcliprule.xml deleted file mode 100644 index 5ddde1f3af..0000000000 --- a/reference/imagick/imagickdraw/getcliprule.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::getClipRule - Retourne la règle de remplissage courante pour les polygones - - - - &reftitle.description; - - public intImagickDraw::getClipRule - - - &warn.undocumented.func; - - Retourne la règle de remplissage courante pour les polygones. - - - - - &reftitle.returnvalues; - - Retourne une constante FILLRULE - (imagick::FILLRULE_*). - - - - - - diff --git a/reference/imagick/imagickdraw/getclipunits.xml b/reference/imagick/imagickdraw/getclipunits.xml deleted file mode 100644 index cce369080e..0000000000 --- a/reference/imagick/imagickdraw/getclipunits.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::getClipUnits - Retourne l'unité d'interprétation des chemins - - - - &reftitle.description; - - public intImagickDraw::getClipUnits - - - &warn.undocumented.func; - - Retourne l'unité d'interprétation des chemins. - - - - - &reftitle.returnvalues; - - Retourne un &integer; en cas de succès. - - - - - - diff --git a/reference/imagick/imagickdraw/getfillcolor.xml b/reference/imagick/imagickdraw/getfillcolor.xml deleted file mode 100644 index 48479501e5..0000000000 --- a/reference/imagick/imagickdraw/getfillcolor.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::getFillColor - Retourne la couleur de remplissage - - - - &reftitle.description; - - public ImagickPixelImagickDraw::getFillColor - - - &warn.undocumented.func; - - Retourne la couleur de remplissage utilisée pour les objets pleins. - - - - - &reftitle.returnvalues; - - Retourne un objet ImagickPixel. - - - - - - diff --git a/reference/imagick/imagickdraw/getfillopacity.xml b/reference/imagick/imagickdraw/getfillopacity.xml deleted file mode 100644 index 1dee412f00..0000000000 --- a/reference/imagick/imagickdraw/getfillopacity.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::getFillOpacity - Retourne l'opacité de dessin - - - - &reftitle.description; - - public floatImagickDraw::getFillOpacity - - - &warn.undocumented.func; - - Retourne l'opacité de dessin. 1.0 représente l'opacité totale. - - - - - &reftitle.returnvalues; - - L'opacité. - - - - - - diff --git a/reference/imagick/imagickdraw/getfillrule.xml b/reference/imagick/imagickdraw/getfillrule.xml deleted file mode 100644 index 8c5c13b58c..0000000000 --- a/reference/imagick/imagickdraw/getfillrule.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::getFillRule - Retourne la règle de remplissage - - - - &reftitle.description; - - public intImagickDraw::getFillRule - - - &warn.undocumented.func; - - Retourne la règle de remplissage utilisée lors du dessin des polygones. - - - - - &reftitle.returnvalues; - - Retourne une constante FILLRULE - (imagick::FILLRULE_*). - - - - - - diff --git a/reference/imagick/imagickdraw/getfont.xml b/reference/imagick/imagickdraw/getfont.xml deleted file mode 100644 index e2b65479b6..0000000000 --- a/reference/imagick/imagickdraw/getfont.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::getFont - Retourne la police - - - - &reftitle.description; - - public stringImagickDraw::getFont - - - &warn.undocumented.func; - - Retourne une chaîne spécifiant la police utilisée pour les annotations. - - - - - &reftitle.returnvalues; - - Retourne une chaîne en cas de succès, et &false; sinon. - - - - - - diff --git a/reference/imagick/imagickdraw/getfontfamily.xml b/reference/imagick/imagickdraw/getfontfamily.xml deleted file mode 100644 index a3970b311a..0000000000 --- a/reference/imagick/imagickdraw/getfontfamily.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::getFontFamily - Retourne la famille de police - - - - &reftitle.description; - - public stringImagickDraw::getFontFamily - - - &warn.undocumented.func; - - Retourne la famille de police des annotations. - - - - - &reftitle.returnvalues; - - Retourne la famille de police des annotations, ou &false; si la famille de - police n'est pas configurée. - - - - - - diff --git a/reference/imagick/imagickdraw/getfontsize.xml b/reference/imagick/imagickdraw/getfontsize.xml deleted file mode 100644 index b6bf08001f..0000000000 --- a/reference/imagick/imagickdraw/getfontsize.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::getFontSize - Retourne la taille de la police - - - - &reftitle.description; - - public floatImagickDraw::getFontSize - - - &warn.undocumented.func; - - Retourne la taille de la police. - - - - - &reftitle.returnvalues; - - Retourne la taille de la police utilisée par l'objet ImagickDraw. - - - - - - diff --git a/reference/imagick/imagickdraw/getfontstretch.xml b/reference/imagick/imagickdraw/getfontstretch.xml deleted file mode 100644 index 051e74c09e..0000000000 --- a/reference/imagick/imagickdraw/getfontstretch.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - ImagickDraw::getFontStretch - Renvoie l'étirement de la police à utiliser lors de l'annotation avec du texte - - - - &reftitle.description; - - public intImagickDraw::getFontStretch - - - - Renvoie l'étirement de la police à utiliser lors de l'annotation avec du texte. Renvoie un StretchType. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagickdraw/getfontstyle.xml b/reference/imagick/imagickdraw/getfontstyle.xml deleted file mode 100644 index 29ebe73b07..0000000000 --- a/reference/imagick/imagickdraw/getfontstyle.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickDraw::getFontStyle - Retourne le style de la police - - - - &reftitle.description; - - public intImagickDraw::getFontStyle - - - &warn.undocumented.func; - - Retourne le style de la police. - - - - - &reftitle.returnvalues; - - Retourne une constante STYLE - (imagick::STYLE_*), associée à l'objet ImagickDraw, - ou 0 si le style n'est pas fait. - - - - - - diff --git a/reference/imagick/imagickdraw/getfontweight.xml b/reference/imagick/imagickdraw/getfontweight.xml deleted file mode 100644 index 17c3eaf095..0000000000 --- a/reference/imagick/imagickdraw/getfontweight.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::getFontWeight - Retourne le poids de la police - - - - &reftitle.description; - - public intImagickDraw::getFontWeight - - - &warn.undocumented.func; - - Retourne le poids de la police. - - - - - &reftitle.returnvalues; - - Retourne un &integer; en cas de succès, et 0 si le poids n'est pas configuré. - - - - - - diff --git a/reference/imagick/imagickdraw/getgravity.xml b/reference/imagick/imagickdraw/getgravity.xml deleted file mode 100644 index 6b4533c68c..0000000000 --- a/reference/imagick/imagickdraw/getgravity.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickDraw::getGravity - Retourne la gravité de placement de texte - - - - &reftitle.description; - - public intImagickDraw::getGravity - - - &warn.undocumented.func; - - Retourne la gravité de placement de texte, utilisée lors de l'annotation. - - - - - &reftitle.returnvalues; - - Retourne une constante GRAVITY - (imagick::GRAVITY_*) en cas de succès, ou 0 si la - gravité n'est pas configurée. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokeantialias.xml b/reference/imagick/imagickdraw/getstrokeantialias.xml deleted file mode 100644 index 989f805cd2..0000000000 --- a/reference/imagick/imagickdraw/getstrokeantialias.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - ImagickDraw::getStrokeAntialias - Retourne la configuration d'anti-aliasing de trait - - - - &reftitle.description; - - public boolImagickDraw::getStrokeAntialias - - - &warn.undocumented.func; - - Retourne la configuration d'anti-aliasing de trait. Les traits de - dessins sont anti-aliasés par défaut. Lorsque l'anti-aliasing est - désactivé, les pixels sont évalués à partir d'un seuil, pour déterminer - si la couleur de trait ou de fond doit être utilisée. - - - - - &reftitle.returnvalues; - - Retourne &true; si l'anti-aliasing est activé, ou &false; sinon. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokecolor.xml b/reference/imagick/imagickdraw/getstrokecolor.xml deleted file mode 100644 index 3624f01239..0000000000 --- a/reference/imagick/imagickdraw/getstrokecolor.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - ImagickDraw::getStrokeColor - Retourne la couleur des contours d'objets - - - - &reftitle.description; - - public ImagickPixelImagickDraw::getStrokeColor - - - &warn.undocumented.func; - - Retourne la couleur des contours d'objets. - - - - - &reftitle.parameters; - - - - stroke_color - - - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet ImagickPixel qui décrit la couleur. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokedasharray.xml b/reference/imagick/imagickdraw/getstrokedasharray.xml deleted file mode 100644 index b71afcd528..0000000000 --- a/reference/imagick/imagickdraw/getstrokedasharray.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::getStrokeDashArray - Retourne un tableau représentant le motif de pointillés - - - - &reftitle.description; - - public arrayImagickDraw::getStrokeDashArray - - - &warn.undocumented.func; - - Retourne un tableau représentant le motif de pointillés, - les vides et les pleins. - - - - - &reftitle.returnvalues; - - Retourne un tableau en cas de succès, et un tableau vide sinon. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokedashoffset.xml b/reference/imagick/imagickdraw/getstrokedashoffset.xml deleted file mode 100644 index 811a3e9215..0000000000 --- a/reference/imagick/imagickdraw/getstrokedashoffset.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::getStrokeDashOffset - Retourne l'offset du pointillé dans le motif - - - - &reftitle.description; - - public floatImagickDraw::getStrokeDashOffset - - - &warn.undocumented.func; - - Retourne l'offset du pointillé dans le motif. - - - - - &reftitle.returnvalues; - - Retourne un nombre décimal représentant le début du pointillé dans le motif. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokelinecap.xml b/reference/imagick/imagickdraw/getstrokelinecap.xml deleted file mode 100644 index 7513726e1a..0000000000 --- a/reference/imagick/imagickdraw/getstrokelinecap.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::getStrokeLineCap - Retourne la forme à utiliser pour dessiner les bouts de sous-chemins - - - - &reftitle.description; - - public intImagickDraw::getStrokeLineCap - - - &warn.undocumented.func; - - Retourne la forme à utiliser pour dessiner les bouts de sous-chemins. - - - - - &reftitle.returnvalues; - - Retourne une constante LINECAP - (imagick::LINECAP_*), ou 0 si les bouts de lignes ne sont pas configurés. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokelinejoin.xml b/reference/imagick/imagickdraw/getstrokelinejoin.xml deleted file mode 100644 index b97aba73b2..0000000000 --- a/reference/imagick/imagickdraw/getstrokelinejoin.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - ImagickDraw::getStrokeLineJoin - Retourne la forme à utiliser pour dessiner les coins d'un chemin - - - - &reftitle.description; - - public intImagickDraw::getStrokeLineJoin - - - &warn.undocumented.func; - - Retourne la forme à utiliser pour dessiner les coins d'un chemin (ou d'autres - formes vectorielles), quand ils sont dessinés. - - - - - &reftitle.returnvalues; - - Retourne une constante LINEJOIN - (imagick::LINEJOIN_*), - ou 0 si les coins ne sont pas configurés. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokemiterlimit.xml b/reference/imagick/imagickdraw/getstrokemiterlimit.xml deleted file mode 100644 index ff2de17ee5..0000000000 --- a/reference/imagick/imagickdraw/getstrokemiterlimit.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - ImagickDraw::getStrokeMiterLimit - Retourne la 'miterLimit' - - - - &reftitle.description; - - public intImagickDraw::getStrokeMiterLimit - - - &warn.undocumented.func; - - Retourne la 'miterLimit'. Lorsque deux segments se rencontrent à angle - aigu, que des jointures miter ont été spécifiées pour - 'lineJoin', - il est possible pour le miter de dépasser l'épaisseur du trait du chemin. - La 'miterLimit' impose une limite au ratio entre la longueur du miter - et 'lineWidth'. - - - - - &reftitle.returnvalues; - - Retourne un entier décrivant la 'miterLimit', et - 0 si la 'miterLimit' n'est pas configurée. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokeopacity.xml b/reference/imagick/imagickdraw/getstrokeopacity.xml deleted file mode 100644 index 94f60c2912..0000000000 --- a/reference/imagick/imagickdraw/getstrokeopacity.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - ImagickDraw::getStrokeOpacity - Retourne l'opacité des contours d'un objet - - - - &reftitle.description; - - public floatImagickDraw::getStrokeOpacity - - - &warn.undocumented.func; - - Retourne l'opacité des contours d'un objet. - - - - - &reftitle.returnvalues; - - Retourne un float décrivant l'opacité des contours d'un objet. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokewidth.xml b/reference/imagick/imagickdraw/getstrokewidth.xml deleted file mode 100644 index 25f3ea14cb..0000000000 --- a/reference/imagick/imagickdraw/getstrokewidth.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - ImagickDraw::getStrokeWidth - Retourne la largeur du trait utilisé - - - - &reftitle.description; - - public floatImagickDraw::getStrokeWidth - - - &warn.undocumented.func; - - Retourne la largeur du trait utilisé. - - - - - &reftitle.returnvalues; - - Retourne un float qui décrit la largeur du trait. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextalignment.xml b/reference/imagick/imagickdraw/gettextalignment.xml deleted file mode 100644 index 1dd2ec78f7..0000000000 --- a/reference/imagick/imagickdraw/gettextalignment.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::getTextAlignment - Retourne l'alignement du texte - - - - &reftitle.description; - - public intImagickDraw::getTextAlignment - - - &warn.undocumented.func; - - Retourne l'alignement du texte. - - - - - &reftitle.returnvalues; - - Retourne une constante ALIGN - (imagick::ALIGN_*), ou 0 si l'alignement n'est pas configuré. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextantialias.xml b/reference/imagick/imagickdraw/gettextantialias.xml deleted file mode 100644 index ac60d7e7bc..0000000000 --- a/reference/imagick/imagickdraw/gettextantialias.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::getTextAntialias - Retourne la configuration de l'anti-aliasing de texte - - - - &reftitle.description; - - public boolImagickDraw::getTextAntialias - - - &warn.undocumented.func; - - Retourne la configuration de l'anti-aliasing de texte, qui détermine si le - texte est anti-aliasé ou pas. Les textes sont anti-aliasés par défaut. - - - - - &reftitle.returnvalues; - - Retourne &true; si le texte est anti-aliasé, et &false; sinon. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextdecoration.xml b/reference/imagick/imagickdraw/gettextdecoration.xml deleted file mode 100644 index c1c2e6a8da..0000000000 --- a/reference/imagick/imagickdraw/gettextdecoration.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickDraw::getTextDecoration - Retourne la décoration du texte - - - - &reftitle.description; - - public intImagickDraw::getTextDecoration - - - &warn.undocumented.func; - - Retourne la décoration du texte d'annotation. - - - - - &reftitle.returnvalues; - - Retourne une constante DECORATION - (imagick::DECORATION_*), - ou bien 0 si aucune décoration n'est configurée. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextencoding.xml b/reference/imagick/imagickdraw/gettextencoding.xml deleted file mode 100644 index ce746e8c06..0000000000 --- a/reference/imagick/imagickdraw/gettextencoding.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - ImagickDraw::getTextEncoding - Retourne le jeu de caractères utilisé pour les annotations de texte - - - - &reftitle.description; - - public falsestringImagickDraw::getTextEncoding - - - &warn.undocumented.func; - - Retourne le jeu de caractères utilisé pour les annotations de texte. - - - - - &reftitle.returnvalues; - - Retourne une chaîne spécifiant le jeu de caractères, ou bien - &false; si le jeu de caractères n'est pas configuré. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextinterlinespacing.xml b/reference/imagick/imagickdraw/gettextinterlinespacing.xml deleted file mode 100644 index 82f18c7788..0000000000 --- a/reference/imagick/imagickdraw/gettextinterlinespacing.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - ImagickDraw::getTextInterlineSpacing - Récupère l'espacement interlignes d'un texte. - - - - &reftitle.description; - - public floatImagickDraw::getTextInterlineSpacing - - - - Récupère l'espacement interlignes d'un texte. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagickdraw/gettextinterwordspacing.xml b/reference/imagick/imagickdraw/gettextinterwordspacing.xml deleted file mode 100644 index c87cc59b91..0000000000 --- a/reference/imagick/imagickdraw/gettextinterwordspacing.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - ImagickDraw::getTextInterwordSpacing - Récupère l'espace entre les mots d'un texte. - - - - &reftitle.description; - - public floatImagickDraw::getTextInterwordSpacing - - - - Récupère l'espace entre les mots d'un texte. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagickdraw/gettextkerning.xml b/reference/imagick/imagickdraw/gettextkerning.xml deleted file mode 100644 index ebeae662fd..0000000000 --- a/reference/imagick/imagickdraw/gettextkerning.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - ImagickDraw::getTextKerning - Récupère le crénage d'un texte. - - - - &reftitle.description; - - public floatImagickDraw::getTextKerning - - - - Récupère le crénage d'un texte. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagickdraw/gettextundercolor.xml b/reference/imagick/imagickdraw/gettextundercolor.xml deleted file mode 100644 index 49b9942c3c..0000000000 --- a/reference/imagick/imagickdraw/gettextundercolor.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::getTextUnderColor - Retourne la couleur sous le texte - - - - &reftitle.description; - - public ImagickPixelImagickDraw::getTextUnderColor - - - &warn.undocumented.func; - - Retourne la couleur du rectangle placé sous le texte des annotations. - - - - - &reftitle.returnvalues; - - Retourne un objet ImagickPixel, qui décrit la couleur. - - - - - - diff --git a/reference/imagick/imagickdraw/getvectorgraphics.xml b/reference/imagick/imagickdraw/getvectorgraphics.xml deleted file mode 100644 index dea9742a21..0000000000 --- a/reference/imagick/imagickdraw/getvectorgraphics.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::getVectorGraphics - Retourne une chaîne contenant le vecteur graphique - - - - &reftitle.description; - - public stringImagickDraw::getVectorGraphics - - - &warn.undocumented.func; - - Retourne une chaîne contenant le vecteur graphique, généré par - les appels graphiques depuis que l'objet ImagickDraw a été créé. - - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant les vecteurs graphiques. - - - - - - diff --git a/reference/imagick/imagickdraw/line.xml b/reference/imagick/imagickdraw/line.xml deleted file mode 100644 index 3bf90b5c4b..0000000000 --- a/reference/imagick/imagickdraw/line.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - ImagickDraw::line - Dessine une ligne - - - - &reftitle.description; - - public boolImagickDraw::line - floatstart_x - floatstart_y - floatend_x - floatend_y - - &warn.undocumented.func; - - Dessine une ligne en utilisant la couleur de trait courante, son opacité, et sa - largeur. - - - - - &reftitle.parameters; - - - - start_x - - - L'abscisse de début - - - - - start_y - - - L'ordonnée de début - - - - - end_x - - - L'abscisse de fin - - - - - end_y - - - L'ordonnée de fin - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::line</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->line(125, 70, 100, 50); - $draw->line(350, 170, 100, 150); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/matte.xml b/reference/imagick/imagickdraw/matte.xml deleted file mode 100644 index 65265ed3b3..0000000000 --- a/reference/imagick/imagickdraw/matte.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - ImagickDraw::matte - Dessine sur le canal d'opacité de l'image - - - - &reftitle.description; - - public boolImagickDraw::matte - floatx - floaty - intpaint - - &warn.undocumented.func; - - Dessine sur le canal d'opacité de l'image, afin de rendre transparent - les pixels indiqués. - - - - - &reftitle.parameters; - - - - x - - - abscisse du mate - - - - - y - - - ordonnée du mate - - - - - paint - - - Une des constantes PAINT - (imagick::PAINT_*). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::matte</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->matte(120, 120, $paintType); - $draw->rectangle(100, 100, 300, 200); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pathclose.xml b/reference/imagick/imagickdraw/pathclose.xml deleted file mode 100644 index c1a583ed47..0000000000 --- a/reference/imagick/imagickdraw/pathclose.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickDraw::pathClose - Ajoute un élément de chemin au chemin courant - - - - &reftitle.description; - - public boolImagickDraw::pathClose - - - &warn.undocumented.func; - - Ajoute un élément de chemin au chemin courant, qui va clore le sous-chemin - en dessinant une ligne droite depuis le point courant jusqu'au point de démarrage - le plus récent (généralement, le dernier point de déplacement). - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoabsolute.xml b/reference/imagick/imagickdraw/pathcurvetoabsolute.xml deleted file mode 100644 index 701f34e5c3..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetoabsolute.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - - ImagickDraw::pathCurveToAbsolute - Dessine une courbe de Bézier cubique, en coordonnées absolues - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToAbsolute - floatx1 - floaty1 - floatx2 - floaty2 - floatx - floaty - - &warn.undocumented.func; - - Dessine une courbe de Bézier cubique, à partir du point courant - (x,y) en utilisant le point - (x1,y1) comme point de - contrôle au début de la courbe et - (x2,y2) comme point de contrôle - à la fin de la courbe, en utilisant des coordonnées absolues. À la fin de - la commande, le nouveau point courant est le point final - (x,y), utilisé par le polybezier. - - - - - &reftitle.parameters; - - - - x1 - - - abscisse du premier point de contrôle - - - - - y1 - - - ordonnée du premier point de contrôle - - - - - x2 - - - abscisse du second point de contrôle - - - - - y2 - - - ordonnée du second point de contrôle - - - - - x - - - abscisse de la fin de la courbe - - - - - y - - - ordonnée de la fin de la courbe - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml deleted file mode 100644 index aaacd78278..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - ImagickDraw::pathCurveToQuadraticBezierAbsolute - Dessine une courbe de Bézier quadratique, en coordonnées absolues - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToQuadraticBezierAbsolute - floatx1 - floaty1 - floatx_end - floaty - - &warn.undocumented.func; - - Dessine une courbe de Bézier quadratique, depuis le point courant - jusqu'à (x,y), - en utilisant le point (x1,y1) comme - point de contrôle, en coordonnées absolues. À la fin du dessin, le nouveau point courant - devient le point final (x,y) - utilisé par le polybezier. - - - - - &reftitle.parameters; - - - - x1 - - - abscisse du point de contrôle - - - - - y1 - - - ordonnée du point de contrôle - - - - - x_end - - - abscisse du point final - - - - - y - - - ordonnée du point final - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::pathCurveToQuadraticBezierAbsolute</function> - -setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->pathStart(); - $draw->pathMoveToAbsolute(50,250); - - // This specifies a quadratic bezier curve with the current position as the start - // point, the control point is the first two params, and the end point is the last two params. - $draw->pathCurveToQuadraticBezierAbsolute( - 150,50, - 250,250 - ); - - // This specifies a quadratic bezier curve with the current position as the start - // point, the control point is mirrored from the previous curves control point - // and the end point is defined by the x, y values. - $draw->pathCurveToQuadraticBezierSmoothAbsolute( - 450,250 - ); - - // This specifies a quadratic bezier curve with the current position as the start - // point, the control point is mirrored from the previous curves control point - // and the end point is defined relative from the current position by the x, y values. - $draw->pathCurveToQuadraticBezierSmoothRelative( - 200,-100 - ); - - $draw->pathFinish(); - - $imagick = new \Imagick(); - $imagick->newImage(700, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); - -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml deleted file mode 100644 index 57a6c15775..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - ImagickDraw::pathCurveToQuadraticBezierRelative - Dessine une courbe de Bézier quadratique, en coordonnées relatives - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToQuadraticBezierRelative - floatx1 - floaty1 - floatx_end - floaty - - &warn.undocumented.func; - - Dessine une courbe de Bézier quadratique, en coordonnées relatives, par - rapport au point courant (x,y), - en utilisant le point (x1,y1) comme - point de contrôle. À la fin du dessin, le nouveau point courant - devient le point final (x,y) - utilisé par le polybezier. - - - - - &reftitle.parameters; - - - - x1 - - - abscisse de départ - - - - - y1 - - - ordonnée de départ - - - - - x_end - - - abscisse de fin - - - - - y - - - ordonnée de fin - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml deleted file mode 100644 index 23f9403e74..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - - ImagickDraw::pathCurveToQuadraticBezierSmoothAbsolute - Dessine une courbe de Bézier quadratique, en coordonnées absolues - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToQuadraticBezierSmoothAbsolute - floatx - floaty - - - - Dessine une courbe de Bézier quadratique, en coordonnées absolues, à - partir du point courant (x, y). Le point de contrôle est la réflexion du - point de contrôle sur la commande de dessin en coordonnées absolues. - S'il n'y a pas eu de commande précédente ou si la commande précédente - n'était pas ImagickDraw::DrawPathCurveToQuadraticBezierAbsolute, - ImagickDraw::DrawPathCurveToQuadraticBezierRelative ou - ImagickDraw::DrawPathCurveToQuadraticBezierSmoothRelative, - on suppose que le point de contrôle coïncide avec le point courant. - À la fin de la commande, le nouveau point courant devient - le point final (x, y), utilisé par - le polybezier. - - - Cette fonction ne peut pas être utilisée pour lisser une courbe de Bézier - cubique. Elle peut uniquement lisser une courbe quadratique. - - - - - &reftitle.parameters; - - - - x - - - L'abscisse du point de fin - - - - - y - - - L'ordonnée du point de fin - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <methodname>ImagickDraw::pathCurveToQuadraticBezierSmoothAbsolute</methodname> - - setStrokeOpacity(1); -$draw->setStrokeColor("black"); -$draw->setFillColor("blue"); - -$draw->setStrokeWidth(2); -$draw->setFontSize(72); - -$draw->pathStart(); -$draw->pathMoveToAbsolute(50,250); - -// Ceci définit une courbe de Bezier quadratique avec la position courante comme -// point de départ, le point de contrôle correspond aux deux premiers paramètres -// et le point final aux deux derniers paramètres. -$draw->pathCurveToQuadraticBezierAbsolute( - 150,50, - 250,250 -); - -// Ceci définit une courbe de Bezier quadratique avec la position courante comme -// point de départ, le point de contrôle est obtenu par effet miroir des points -// de contrôle des précédentes courbes et le point final est défini par les -// valeurs x, y. -$draw->pathCurveToQuadraticBezierSmoothAbsolute( - 450,250 -); - -// Ceci définit une courbe de Bezier quadratique avec la position courante comme -// point de départ, le point de contrôle est obtenu par effet miroir des points -// de contrôle des précédentes courbes et le point final est défini relativement -// à la position courante par les valeurs x, y -$draw->pathCurveToQuadraticBezierSmoothRelative( - 200,-100 -); - -$draw->pathFinish(); - -$imagick = new \Imagick(); -$imagick->newImage(700, 500, $backgroundColor); -$imagick->setImageFormat("png"); - -$imagick->drawImage($draw); - -header("Content-Type: image/png"); -echo $imagick->getImageBlob(); -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml deleted file mode 100644 index d80a973b9e..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - - ImagickDraw::pathCurveToQuadraticBezierSmoothRelative - Dessine une courbe de Bézier quadratique, en coordonnées relatives - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToQuadraticBezierSmoothRelative - floatx - floaty - - &warn.undocumented.func; - - Dessine une courbe de Bézier quadratique, en coordonnées relatives, à - partir du point courant (x, y). Le point de contrôle est la réflexion du - point de contrôle sur la commande de dessin en coordonnées relatives. - S'il n'y a pas eu de commande précédente ou si la commande précédente - n'était pas ImagickDraw::DrawPathCurveToQuadraticBezierAbsolute, - ImagickDraw::DrawPathCurveToQuadraticBezierRelative, - ImagickDraw::DrawPathCurveToQuadraticBezierSmoothAbsolut ou - ImagickDraw::DrawPathCurveToQuadraticBezierSmoothRelative - on suppose que le point - de contrôle coïncide avec le point courant. À la fin de la commande, le - nouveau point courant devient le point final (x, y), utilisé par - le polybezier. - - - Cette fonction ne peut pas être utilisée pour lisser une courbe de Bézier - cubique. Elle peut uniquement lisser une courbe quadratique. - - - - - &reftitle.parameters; - - - - x - - - L'abscisse du point de fin - - - - - y - - - L'ordonnée du point de fin - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <methodname>ImagickDraw::pathCurveToQuadraticBezierSmoothRelative</methodname> - - setStrokeOpacity(1); -$draw->setStrokeColor("black"); -$draw->setFillColor("blue"); - -$draw->setStrokeWidth(2); -$draw->setFontSize(72); - -$draw->pathStart(); -$draw->pathMoveToAbsolute(50,250); - -// Ceci définit une courbe de Bezier quadratique avec la position courante comme -// point de départ, le point de contrôle correspond aux deux premiers paramètres -// et le point final aux deux derniers paramètres. -$draw->pathCurveToQuadraticBezierAbsolute( - 150,50, - 250,250 -); - -// Ceci définit une courbe de Bezier quadratique avec la position courante comme -// point de départ, le point de contrôle est obtenu par effet miroir des points -// de contrôle des précédentes courbes et le point final est défini par les -// valeurs x, y. -$draw->pathCurveToQuadraticBezierSmoothAbsolute( - 450,250 -); - -// Ceci définit une courbe de Bezier quadratique avec la position courante comme -// point de départ, le point de contrôle est obtenu par effet miroir des points -// de contrôle des précédentes courbes et le point final est défini relativement -// à la position courante par les valeurs x, y -$draw->pathCurveToQuadraticBezierSmoothRelative( - 200,-100 -); - -$draw->pathFinish(); - -$imagick = new \Imagick(); -$imagick->newImage(700, 500, $backgroundColor); -$imagick->setImageFormat("png"); - -$imagick->drawImage($draw); - -header("Content-Type: image/png"); -echo $imagick->getImageBlob(); -?> -]]> - - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetorelative.xml b/reference/imagick/imagickdraw/pathcurvetorelative.xml deleted file mode 100644 index d40761febb..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetorelative.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - - ImagickDraw::pathCurveToRelative - Dessine une courbe de Bézier cubique, en coordonnées relatives - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToRelative - floatx1 - floaty1 - floatx2 - floaty2 - floatx - floaty - - &warn.undocumented.func; - - Dessine une courbe de Bézier cubique, à partir du point courant - (x,y) en utilisant le point - (x1,y1) comme point de - contrôle au début de la courbe et - (x2,y2) comme point de - contrôle à la fin de la courbe, en utilisant des coordonnées relatives. - À la fin de la commande, le nouveau point courant est le point final - (x,y), utilisé par le polybezier. - - - - - &reftitle.parameters; - - - - x1 - - - abscisse du point de départ - - - - - y1 - - - ordonnée du point de départ - - - - - x2 - - - abscisse du point de contrôle final - - - - - y2 - - - ordonnée du point de contrôle final - - - - - x - - - abscisse du point final - - - - - y - - - ordonnée du point final - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml b/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml deleted file mode 100644 index fb9edd4e58..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - ImagickDraw::pathCurveToSmoothAbsolute - Dessine une courbe de Bézier, en coordonnées absolues - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToSmoothAbsolute - floatx2 - floaty2 - floatx - floaty - - &warn.undocumented.func; - - Dessine une courbe de Bézier, en coordonnées absolues, à partir du point - courant (x,y). - Le premier point de contrôle est la réflexion du second - point de contrôle de la commande précédente, relative au point courant. - S'il n'y a pas eu de commande précédente, ou que la commande précédente - n'était pas DrawPathCurveToAbsolute, DrawPathCurveToRelative, - DrawPathCurveToSmoothAbsolute ou DrawPathCurveToSmoothRelative, on suppose - alors que le premier point de contrôle coïncide avec le point courant. - (x2,y2) - est le second point de contrôle (c.-à-d., le point de contrôle à la fin - de la ligne). À la fin de la commande, le nouveau point courant est le point - final, de coordonnées (x,y), - dans le polybezier. - - - - - &reftitle.parameters; - - - - x2 - - - abscisse du deuxième point de contrôle - - - - - y2 - - - ordonnée du deuxième point de contrôle - - - - - x - - - abscisse du point de contrôle final - - - - - y - - - ordonnée du point de contrôle final - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml b/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml deleted file mode 100644 index d03bff2c2a..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - ImagickDraw::pathCurveToSmoothRelative - Dessine une courbe de Bézier, en coordonnées relatives - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToSmoothRelative - floatx2 - floaty2 - floatx - floaty - - &warn.undocumented.func; - - Dessine une courbe de Bézier, en coordonnées relatives, à partir du point - courant (x,y). - Le premier point de contrôle est la réflexion du second - point de contrôle de la commande précédente, relative au point courant. - S'il n'y a pas eu de commande précédente, ou que la commande précédente - n'était pas DrawPathCurveToAbsolute, DrawPathCurveToRelative, - DrawPathCurveToSmoothAbsolute ou DrawPathCurveToSmoothRelative, on suppose - alors que le premier point de contrôle coïncide avec le point courant. - (x2,y2) - est le second point de contrôle (c.-à-d., le point de contrôle à la fin - de la ligne). À la fin de la commande, le nouveau point courant est le point - final, de coordonnées (x,y), - dans le polybezier. - - - - - &reftitle.parameters; - - - - x2 - - - abscisse du deuxième point de contrôle - - - - - y2 - - - ordonnée du deuxième point de contrôle - - - - - x - - - abscisse du point de contrôle final - - - - - y - - - ordonnée du point de contrôle final - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathellipticarcabsolute.xml b/reference/imagick/imagickdraw/pathellipticarcabsolute.xml deleted file mode 100644 index 7995809d89..0000000000 --- a/reference/imagick/imagickdraw/pathellipticarcabsolute.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - ImagickDraw::pathEllipticArcAbsolute - Dessine un arc d'ellipse, en coordonnées absolues - - - - &reftitle.description; - - public boolImagickDraw::pathEllipticArcAbsolute - floatrx - floatry - floatx_axis_rotation - boollarge_arc - boolsweep - floatx - floaty - - &warn.undocumented.func; - - Dessine un arc d'ellipse à partir du point courant (x, y), en utilisant - des coordonnées absolues. La taille et l'orientation de l'ellipse - sont définies par deux rayons, (rx, ry) et une rotation xAxisRotation, - qui indique comment l'ellipse, dans son ensemble, est située dans - le système de coordonnées. Le centre (cx, cy) de l'ellipse est calculé - automatiquement pour satisfaire aux contraintes des autres paramètres. - Si large_arc vaut &true;, alors c'est l'arc - le plus grand qui est dessiné. - Si sweep vaut &true;, alors le dessin de l'arc se fait - dans le sens horaire. - - - - - &reftitle.parameters; - - - - rx - - - Rayon X - - - - - ry - - - Rayon Y - - - - - x_axis_rotation - - - Rotation sur l'axe des X - - - - - large_arc - - - option large_arc_flag - - - - - sweep - - - Option sweep_flag - - - - - x - - - L'abscisse - - - - - y - - - L'ordonnée - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathellipticarcrelative.xml b/reference/imagick/imagickdraw/pathellipticarcrelative.xml deleted file mode 100644 index b6a1075e27..0000000000 --- a/reference/imagick/imagickdraw/pathellipticarcrelative.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - ImagickDraw::pathEllipticArcRelative - Dessine un arc d'ellipse, en coordonnées relatives - - - - &reftitle.description; - - public boolImagickDraw::pathEllipticArcRelative - floatrx - floatry - floatx_axis_rotation - boollarge_arc - boolsweep - floatx - floaty - - &warn.undocumented.func; - - Dessine un arc d'ellipse à partir du point courant (x, y), en utilisant - des coordonnées relatives. La taille et l'orientation de l'ellipse - sont définies par deux rayons, (rx, ry) et une rotation xAxisRotation, - qui indique comment l'ellipse, dans son ensemble, est située dans - le système de coordonnées. Le centre (cx, cy) de l'ellipse est calculé - automatiquement pour satisfaire aux contraintes des autres paramètres. - Si large_arc vaut &true;, alors c'est l'arc le plus grand qui est - dessiné. Si sweep vaut &true;, alors le dessin de l'arc se fait - dans le sens horaire. - - - - - &reftitle.parameters; - - - - rx - - - Rayon X - - - - - ry - - - Rayon Y - - - - - x_axis_rotation - - - Rotation sur l'axe des X - - - - - large_arc - - - L'option large_arc_flag - - - - - sweep - - - L'option sweep_flag - - - - - x - - - L'abscisse - - - - - y - - - L'ordonnée - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathfinish.xml b/reference/imagick/imagickdraw/pathfinish.xml deleted file mode 100644 index 16bf2ccbad..0000000000 --- a/reference/imagick/imagickdraw/pathfinish.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::pathFinish - Termine le chemin courant - - - - &reftitle.description; - - public boolImagickDraw::pathFinish - - - &warn.undocumented.func; - - Termine le chemin courant. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetoabsolute.xml b/reference/imagick/imagickdraw/pathlinetoabsolute.xml deleted file mode 100644 index 3c4eaa34cc..0000000000 --- a/reference/imagick/imagickdraw/pathlinetoabsolute.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ImagickDraw::pathLineToAbsolute - Dessine une ligne de chemin, en coordonnées absolues - - - - &reftitle.description; - - public boolImagickDraw::pathLineToAbsolute - floatx - floaty - - &warn.undocumented.func; - - Dessine une ligne à partir du point courant, jusqu'au point cible, - en utilisant des coordonnées absolues. Le point cible devient alors le point - courant. - - - - - &reftitle.parameters; - - - - x - - - L'abscisse de départ - - - - - y - - - L'abscisse de fin - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml b/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml deleted file mode 100644 index b33ba4315f..0000000000 --- a/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ImagickDraw::pathLineToHorizontalAbsolute - Dessine une ligne de chemin horizontale, en coordonnées absolues - - - - &reftitle.description; - - public boolImagickDraw::pathLineToHorizontalAbsolute - floatx - - &warn.undocumented.func; - - Dessine une ligne horizontale à partir du point courant, jusqu'au point cible, - en utilisant des coordonnées absolues. Le point cible devient alors le point - courant. - - - - - &reftitle.parameters; - - - - x - - - L'abscisse - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml b/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml deleted file mode 100644 index 62b6b2d205..0000000000 --- a/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ImagickDraw::pathLineToHorizontalRelative - Dessine une ligne de chemin horizontale, en coordonnées relatives - - - - &reftitle.description; - - public boolImagickDraw::pathLineToHorizontalRelative - floatx - - &warn.undocumented.func; - - Dessine une ligne horizontale à partir du point courant, jusqu'au point cible, - en utilisant des coordonnées relatives. Le point cible devient alors le point - courant. - - - - - &reftitle.parameters; - - - - x - - - L'abscisse - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetorelative.xml b/reference/imagick/imagickdraw/pathlinetorelative.xml deleted file mode 100644 index cc1e446a8d..0000000000 --- a/reference/imagick/imagickdraw/pathlinetorelative.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ImagickDraw::pathLineToRelative - Dessine une ligne de chemin, en coordonnées relatives - - - - &reftitle.description; - - public boolImagickDraw::pathLineToRelative - floatx - floaty - - &warn.undocumented.func; - - Dessine une ligne à partir du point courant, jusqu'au point cible, - en utilisant des coordonnées relatives. Le point cible devient alors le point - courant. - - - - - &reftitle.parameters; - - - - x - - - abscisse de départ - - - - - y - - - ordonnée de départ - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml b/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml deleted file mode 100644 index cb3211cdb9..0000000000 --- a/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ImagickDraw::pathLineToVerticalAbsolute - Dessine une ligne de chemin verticale, en coordonnées absolues - - - - &reftitle.description; - - public boolImagickDraw::pathLineToVerticalAbsolute - floaty - - &warn.undocumented.func; - - Dessine une ligne verticale à partir du point courant, jusqu'au point cible, - en utilisant des coordonnées absolues. Le point cible devient alors le point - courant. - - - - - &reftitle.parameters; - - - - y - - - Ordonnée - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml b/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml deleted file mode 100644 index 20a46fde92..0000000000 --- a/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ImagickDraw::pathLineToVerticalRelative - Dessine une ligne de chemin verticale, en coordonnées relatives - - - - &reftitle.description; - - public boolImagickDraw::pathLineToVerticalRelative - floaty - - &warn.undocumented.func; - - Dessine une ligne verticale à partir du point courant, jusqu'au point cible, - en utilisant des coordonnées relatives. Le point cible devient alors le point - courant. - - - - - &reftitle.parameters; - - - - y - - - ordonnée cible - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathmovetoabsolute.xml b/reference/imagick/imagickdraw/pathmovetoabsolute.xml deleted file mode 100644 index ed1b266d79..0000000000 --- a/reference/imagick/imagickdraw/pathmovetoabsolute.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ImagickDraw::pathMoveToAbsolute - Commence un nouveau sous-chemin, en coordonnées absolues - - - - &reftitle.description; - - public boolImagickDraw::pathMoveToAbsolute - floatx - floaty - - &warn.undocumented.func; - - Commence un nouveau sous-chemin à partir des coordonnées indiquées, - en utilisant des coordonnées absolues. Le point courant devient alors - les coordonnées spécifiées. - - - - - &reftitle.parameters; - - - - x - - - L'abscisse cible - - - - - y - - - L'ordonnée cible - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathmovetorelative.xml b/reference/imagick/imagickdraw/pathmovetorelative.xml deleted file mode 100644 index e8a0926f9b..0000000000 --- a/reference/imagick/imagickdraw/pathmovetorelative.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ImagickDraw::pathMoveToRelative - Commence un nouveau sous-chemin, en coordonnées relatives - - - - &reftitle.description; - - public boolImagickDraw::pathMoveToRelative - floatx - floaty - - &warn.undocumented.func; - - Commence un nouveau sous-chemin à partir des coordonnées indiquées, - en utilisant des coordonnées relatives. Le point courant devient alors - les coordonnées spécifiées. - - - - - &reftitle.parameters; - - - - x - - - L'abscisse cible - - - - - y - - - L'ordonnée cible - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathstart.xml b/reference/imagick/imagickdraw/pathstart.xml deleted file mode 100644 index 7d74bd356e..0000000000 --- a/reference/imagick/imagickdraw/pathstart.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - - ImagickDraw::pathStart - Déclare le début d'un chemin de dessin - - - - &reftitle.description; - - public boolImagickDraw::pathStart - - - &warn.undocumented.func; - - Déclare le début d'un chemin de dessin, qui sera terminé par la commande - sœur ImagickDraw::DrawPathFinish. - Toutes les commandes autres que ImagickDraw::DrawPath - doivent être encadrées par ImagickDraw::pathStart et - ImagickDraw::DrawPathFinish. Ceci est lié au fait que - les commandes suivantes sont des commandes subordonnées. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::pathStart</function> - -setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->pathStart(); - $draw->pathMoveToAbsolute(50, 50); - $draw->pathLineToAbsolute(100, 50); - $draw->pathLineToRelative(0, 50); - $draw->pathLineToHorizontalRelative(-50); - $draw->pathFinish(); - - $draw->pathStart(); - $draw->pathMoveToAbsolute(50, 50); - $draw->pathMoveToRelative(300, 0); - $draw->pathLineToRelative(50, 0); - $draw->pathLineToVerticalRelative(50); - $draw->pathLineToHorizontalAbsolute(350); - $draw->pathclose(); - $draw->pathFinish(); - - $draw->pathStart(); - $draw->pathMoveToAbsolute(50, 300); - $draw->pathCurveToAbsolute(50, 300, 100, 200, 300, 300); - $draw->pathLineToVerticalAbsolute(350); - $draw->pathFinish(); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - diff --git a/reference/imagick/imagickdraw/point.xml b/reference/imagick/imagickdraw/point.xml deleted file mode 100644 index 81130b314c..0000000000 --- a/reference/imagick/imagickdraw/point.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - ImagickDraw::point - Dessine un point - - - - &reftitle.description; - - public boolImagickDraw::point - floatx - floaty - - &warn.undocumented.func; - - Dessine un point en utilisant la couleur de trait courante, ainsi que l'épaisseur, - dans les coordonnées spécifiées. - - - - - &reftitle.parameters; - - - - x - - - L'abscisse du point - - - - - y - - - L'ordonnée du point - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::point</function> - -setFillColor($fillColor); - - for ($x = 0; $x < 10000; $x++) { - $draw->point(rand(0, 500), rand(0, 500)); - } - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/polygon.xml b/reference/imagick/imagickdraw/polygon.xml deleted file mode 100644 index b12aecba81..0000000000 --- a/reference/imagick/imagickdraw/polygon.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - ImagickDraw::polygon - Dessine un polygone - - - - &reftitle.description; - - public boolImagickDraw::polygon - arraycoordinates - - &warn.undocumented.func; - - Dessine un polygone, en utilisant le trait courant, sa largeur, sa couleur de - remplissage, ainsi que le tableau de coordonnées indiqué. - - - - - &reftitle.parameters; - - - - coordinates - - - Tableau multidimensionnel de coordonnées, tel que - array( array( 'x' => 3, 'y' => 4 ), array( 'x' => 2, 'y' => 6 ) ); - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::polygon</function> - -setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setStrokeWidth(4); - - $draw->setFillColor($fillColor); - - $points = [ - ['x' => 40 * 5, 'y' => 10 * 5], - ['x' => 20 * 5, 'y' => 20 * 5], - ['x' => 70 * 5, 'y' => 50 * 5], - ['x' => 60 * 5, 'y' => 15 * 5], - ]; - - $draw->polygon($points); - - $image = new \Imagick(); - $image->newImage(500, 300, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/polyline.xml b/reference/imagick/imagickdraw/polyline.xml deleted file mode 100644 index c5c740c385..0000000000 --- a/reference/imagick/imagickdraw/polyline.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - ImagickDraw::polyline - Dessine une ligne brisée - - - - &reftitle.description; - - public boolImagickDraw::polyline - arraycoordinates - - &warn.undocumented.func; - - Dessine une ligne brisée, en utilisant le trait courant, sa largeur et - son motif, ainsi que sa couleur de remplissage ou sa texture, en - utilisant les coordonnées spécifiées. - - - - - &reftitle.parameters; - - - - coordinates - - - Tableau avec les coordonnées "x" et "y" - array( array( 'x' => 4, 'y' => 6 ), array( 'x' => 8, 'y' => 10 ) ) - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::polyline</function> - -setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(5); - - $points = [ - ['x' => 40 * 5, 'y' => 10 * 5], - ['x' => 20 * 5, 'y' => 20 * 5], - ['x' => 70 * 5, 'y' => 50 * 5], - ['x' => 60 * 5, 'y' => 15 * 5] - ]; - - $draw->polyline($points); - - $image = new \Imagick(); - $image->newImage(500, 300, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pop.xml b/reference/imagick/imagickdraw/pop.xml deleted file mode 100644 index 2351927c06..0000000000 --- a/reference/imagick/imagickdraw/pop.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - ImagickDraw::pop - Détruit l'objet ImagickDraw courant dans la pile, et retourne son précédent - - - - &reftitle.description; - - public boolImagickDraw::pop - - - &warn.undocumented.func; - - Détruit l'objet ImagickDraw courant dans la pile, et retourne son précédent. - Plusieurs objets ImagickDraw peuvent exister. C'est une erreur que de - tenter d'extraire plus d'objets ImagickDraw qu'il n'y en a, et il est recommandé - d'en extraire juste le bon nombre. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/popclippath.xml b/reference/imagick/imagickdraw/popclippath.xml deleted file mode 100644 index b136501c42..0000000000 --- a/reference/imagick/imagickdraw/popclippath.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::popClipPath - Termine la définition d'un chemin - - - - &reftitle.description; - - public boolImagickDraw::popClipPath - - - &warn.undocumented.func; - - Termine la définition d'un chemin. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/popdefs.xml b/reference/imagick/imagickdraw/popdefs.xml deleted file mode 100644 index 77f19a2708..0000000000 --- a/reference/imagick/imagickdraw/popdefs.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - ImagickDraw::popDefs - Termine une définition de liste - - - - &reftitle.description; - - public boolImagickDraw::popDefs - - - &warn.undocumented.func; - - Termine une définition de liste. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::popDefs</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setstrokeOpacity(1); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->pushDefs(); - $draw->setStrokeColor('white'); - $draw->rectangle(50, 50, 200, 200); - $draw->popDefs(); - - $draw->rectangle(300, 50, 450, 200); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/poppattern.xml b/reference/imagick/imagickdraw/poppattern.xml deleted file mode 100644 index 3388801a77..0000000000 --- a/reference/imagick/imagickdraw/poppattern.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::popPattern - Termine une définition de motif - - - - &reftitle.description; - - public boolImagickDraw::popPattern - - - &warn.undocumented.func; - - Termine une définition de motif. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/push.xml b/reference/imagick/imagickdraw/push.xml deleted file mode 100644 index 575495c020..0000000000 --- a/reference/imagick/imagickdraw/push.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - ImagickDraw::push - Clone l'objet ImagickDraw courant et le pousse dans la pile - - - - &reftitle.description; - - public boolImagickDraw::push - - - &warn.undocumented.func; - - Clone l'objet ImagickDraw courant et le pousse dans la pile, en l'ajoutant - à la fin. L'objet ImagickDraw original peut être retrouvé en appliquant la - méthode ImagickDraw::pop à la pile. Les objets ImagickDraws sont stockés dans une pile - ImagickDraw. Pour chaque pop, il faut qu'il y ait eu un push équivalent. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::push</function> - - setStrokeColor($strokeColor); - $draw->setFillColor($fillModifiedColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->push(); - $draw->translate(50, 50); - $draw->rectangle(200, 200, 300, 300); - $draw->pop(); - $draw->setFillColor($fillColor); - $draw->rectangle(200, 200, 300, 300); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pushclippath.xml b/reference/imagick/imagickdraw/pushclippath.xml deleted file mode 100644 index 58064a4887..0000000000 --- a/reference/imagick/imagickdraw/pushclippath.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - ImagickDraw::pushClipPath - Commence la définition d'un chemin - - - - &reftitle.description; - - public boolImagickDraw::pushClipPath - stringclip_mask_id - - &warn.undocumented.func; - - Commence la définition d'un chemin, qui est constitué de n'importe quel nombre - de commandes de dessins, et terminé par une commande ImagickDraw::popClipPath. - - - - - &reftitle.parameters; - - - - clip_mask_id - - - L'identifiant du masque de clip - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pushdefs.xml b/reference/imagick/imagickdraw/pushdefs.xml deleted file mode 100644 index 407f907063..0000000000 --- a/reference/imagick/imagickdraw/pushdefs.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - ImagickDraw::pushDefs - Indique que la commande suivante crée des éléments nommés pour pré-traitement - - - - &reftitle.description; - - public boolImagickDraw::pushDefs - - - &warn.undocumented.func; - - Indique que les commandes jusqu'à la commande terminante de - ImagickDraw::popDefs - créent des éléments nommés (p. ex., des chemins, des textures, etc.), - qui peuvent être traités au plus tôt par simple souci d'efficacité. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pushpattern.xml b/reference/imagick/imagickdraw/pushpattern.xml deleted file mode 100644 index 19996c420c..0000000000 --- a/reference/imagick/imagickdraw/pushpattern.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - - ImagickDraw::pushPattern - Configure un espace de dessin - - - - &reftitle.description; - - public boolImagickDraw::pushPattern - stringpattern_id - floatx - floaty - floatwidth - floatheight - - &warn.undocumented.func; - - Configure ImagickDraw pour que les commandes jusqu'à la fonction - DrawPopPattern() incluent la définition d'un nom de motif. L'espace de - motif reçoit les coordonnées du coin supérieur gauche, de la hauteur et - largeur, et devient un espace de dessin en lui-même. Tout ce qui peut être - dessiné peut être dessiné dans un motif. Des motifs peuvent aussi - définir des traits ou des brosses. - - - - - &reftitle.parameters; - - - - pattern_id - - - L'identifiant du motif - - - - - x - - - L'abscisse du coin supérieur gauche - - - - - y - - - L'ordonnée du coin supérieur gauche - - - - - width - - - La largeur du motif - - - - - height - - - La hauteur du motif - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::pushPattern</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(1); - - $draw->pushPattern("MyFirstPattern", 0, 0, 50, 50); - for ($x = 0; $x < 50; $x += 10) { - for ($y = 0; $y < 50; $y += 5) { - $positionX = $x + (($y / 5) % 5); - $draw->rectangle($positionX, $y, $positionX + 5, $y + 5); - } - } - $draw->popPattern(); - - $draw->setFillOpacity(0); - $draw->rectangle(100, 100, 400, 400); - $draw->setFillOpacity(1); - - $draw->setFillOpacity(1); - - $draw->push(); - $draw->setFillPatternURL('#MyFirstPattern'); - $draw->setFillColor('yellow'); - $draw->rectangle(100, 100, 400, 400); - $draw->pop(); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/rectangle.xml b/reference/imagick/imagickdraw/rectangle.xml deleted file mode 100644 index 8fd1c950a3..0000000000 --- a/reference/imagick/imagickdraw/rectangle.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - ImagickDraw::rectangle - Dessine un rectangle - - - - &reftitle.description; - - public boolImagickDraw::rectangle - floattop_left_x - floattop_left_y - floatbottom_right_x - floatbottom_right_y - - &warn.undocumented.func; - - Dessine un rectangle à partir de ses coordonnées et en utilisant - le trait courant, sa largeur et son motif. - - - - - &reftitle.parameters; - - - - top_left_x - - - abscisse du coin supérieur gauche - - - - - top_left_y - - - ordonnée du coin supérieur gauche - - - - - bottom_right_x - - - abscisse du coin inférieur droit - - - - - bottom_right_y - - - ordonnée du coin inférieur droit - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::rectangle</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - - $draw->rectangle(200, 200, 300, 300); - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/render.xml b/reference/imagick/imagickdraw/render.xml deleted file mode 100644 index baaec1beb1..0000000000 --- a/reference/imagick/imagickdraw/render.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::render - Effectue le rendu de tous les dessins à l'image - - - - &reftitle.description; - - public boolImagickDraw::render - - - &warn.undocumented.func; - - Effectue le rendu de tous les dessins à l'image. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/resetvectorgraphics.xml b/reference/imagick/imagickdraw/resetvectorgraphics.xml deleted file mode 100644 index 4ea54a8f19..0000000000 --- a/reference/imagick/imagickdraw/resetvectorgraphics.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - ImagickDraw::resetVectorGraphics - Réinitialise les graphiques vectoriels - - - - &reftitle.description; - - public boolImagickDraw::resetVectorGraphics - - - - Réinitialise les graphiques vectoriels. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickdraw/rotate.xml b/reference/imagick/imagickdraw/rotate.xml deleted file mode 100644 index ad90d29912..0000000000 --- a/reference/imagick/imagickdraw/rotate.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - ImagickDraw::rotate - Applique une rotation - - - - &reftitle.description; - - public boolImagickDraw::rotate - floatdegrees - - &warn.undocumented.func; - - Applique une rotation d'un angle donné aux coordonnées de l'espace courant. - - - - - &reftitle.parameters; - - - - degrees - - - Angle de rotation, en degrés. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::rotate</function> - -setStrokeColor($strokeColor); - $draw->setStrokeOpacity(1); - $draw->setFillColor($fillColor); - $draw->rectangle(200, 200, 300, 300); - $draw->setFillColor($fillModifiedColor); - $draw->rotate(15); - $draw->rectangle(200, 200, 300, 300); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/roundrectangle.xml b/reference/imagick/imagickdraw/roundrectangle.xml deleted file mode 100644 index 400dadd3d0..0000000000 --- a/reference/imagick/imagickdraw/roundrectangle.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - ImagickDraw::roundRectangle - Dessine un rectangle aux coins arrondis - - - - &reftitle.description; - - public boolImagickDraw::roundRectangle - floattop_left_x - floattop_left_y - floatbottom_right_x - floatbottom_right_y - floatrounding_x - floatrounding_y - - &warn.undocumented.func; - - Dessine un rectangle aux coins arrondis, à partir de deux coordonnées, - x & y, du rayon de coin et en utilisant le trait courant, son épaisseur - et sa couleur de remplissage. - - - - - &reftitle.parameters; - - - - top_left_x - - - L'abscisse du coin supérieur gauche - - - - - top_left_y - - - L'ordonnée du coin supérieur gauche - - - - - bottom_right_x - - - L'abscisse du coin inférieur droit - - - - - bottom_right_y - - - L'ordonnée du coin inférieur droit - - - - - rounding_x - - - Le rayon en x - - - - - rounding_y - - - Le rayon en y - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::roundRectangle</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - - $draw->roundRectangle($startX, $startY, $endX, $endY, $roundX, $roundY); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/scale.xml b/reference/imagick/imagickdraw/scale.xml deleted file mode 100644 index d3b7487534..0000000000 --- a/reference/imagick/imagickdraw/scale.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - ImagickDraw::scale - Ajuste le facteur de mise à l'échelle - - - - &reftitle.description; - - public boolImagickDraw::scale - floatx - floaty - - &warn.undocumented.func; - - Ajuste le facteur de mise à l'échelle à appliquer aux directions - verticales et horizontales de l'espace de coordonnées courant. - - - - - &reftitle.parameters; - - - - x - - - facteur horizontal - - - - - y - - - facteur vertical - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::scale</function> - -setStrokeColor($strokeColor); - $draw->setStrokeWidth(4); - $draw->setFillColor($fillColor); - $draw->rectangle(200, 200, 300, 300); - $draw->setFillColor($fillModifiedColor); - $draw->scale(1.4, 1.4); - $draw->rectangle(200, 200, 300, 300); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setclippath.xml b/reference/imagick/imagickdraw/setclippath.xml deleted file mode 100644 index 8b5984d91a..0000000000 --- a/reference/imagick/imagickdraw/setclippath.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - ImagickDraw::setClipPath - Associe un chemin avec une image - - - - &reftitle.description; - - public boolImagickDraw::setClipPath - stringclip_mask - - &warn.undocumented.func; - - Associe un chemin avec une image. Seules les surfaces dessinées sur le - chemin seront modifiées tant qu'il reste actif. - - - - - &reftitle.parameters; - - - - clip_mask - - - Le nom du chemin - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setClipPath</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - - $clipPathName = 'testClipPath'; - - $draw->pushClipPath($clipPathName); - $draw->rectangle(0, 0, 250, 250); - $draw->popClipPath(); - $draw->setClipPath($clipPathName); - $draw->rectangle(100, 100, 400, 400); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setcliprule.xml b/reference/imagick/imagickdraw/setcliprule.xml deleted file mode 100644 index cc2302d863..0000000000 --- a/reference/imagick/imagickdraw/setcliprule.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - ImagickDraw::setClipRule - Configure la règle de remplissage du polygone à utiliser avec les chemins - - - - &reftitle.description; - - public boolImagickDraw::setClipRule - intfillrule - - &warn.undocumented.func; - - Configure la règle de remplissage du polygone à utiliser avec les chemins. - - - - - &reftitle.parameters; - - - - fillrule - - - Une des constantes FILLRULE - (imagick::FILLRULE_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setClipRule</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - //\Imagick::FILLRULE_EVENODD - //\Imagick::FILLRULE_NONZERO - - $clipPathName = 'testClipPath'; - $draw->pushClipPath($clipPathName); - $draw->setClipRule(\Imagick::FILLRULE_EVENODD); - $draw->rectangle(0, 0, 300, 500); - $draw->rectangle(200, 0, 500, 500); - $draw->popClipPath(); - $draw->setClipPath($clipPathName); - $draw->rectangle(200, 200, 300, 300); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setclipunits.xml b/reference/imagick/imagickdraw/setclipunits.xml deleted file mode 100644 index 2873d504ae..0000000000 --- a/reference/imagick/imagickdraw/setclipunits.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - ImagickDraw::setClipUnits - Configure le mode d'interprétation des unités de chemin - - - - &reftitle.description; - - public boolImagickDraw::setClipUnits - intpathunits - - &warn.undocumented.func; - - Configure le mode d'interprétation des unités de chemin. - - - - - &reftitle.parameters; - - - - pathunits - - - Le nombre d'unités de clip - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setClipUnits</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - $clipPathName = 'testClipPath'; - $draw->setClipUnits(\Imagick::RESOLUTION_PIXELSPERINCH); - $draw->pushClipPath($clipPathName); - $draw->rectangle(0, 0, 250, 250); - $draw->popClipPath(); - $draw->setClipPath($clipPathName); - - //RESOLUTION_PIXELSPERINCH - //RESOLUTION_PIXELSPERCENTIMETER - - $draw->rectangle(200, 200, 300, 300); - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfillalpha.xml b/reference/imagick/imagickdraw/setfillalpha.xml deleted file mode 100644 index 741b8c01c0..0000000000 --- a/reference/imagick/imagickdraw/setfillalpha.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - ImagickDraw::setFillAlpha - Configure l'opacité de la couleur de remplissage - - - - &reftitle.description; - - public boolImagickDraw::setFillAlpha - floatalpha - - &warn.undocumented.func; - - Configure l'opacité à utiliser quand la couleur de remplissage est utilisée. - 1.0 est totalement opaque. - - - - - &reftitle.parameters; - - - - alpha - - - Canal alpha de la couleur de remplissage - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setFillAlpha</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - $draw->rectangle(100, 200, 200, 300); - @$draw->setFillAlpha(0.4); - $draw->rectangle(300, 200, 400, 300); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfillcolor.xml b/reference/imagick/imagickdraw/setfillcolor.xml deleted file mode 100644 index 8f27a027a2..0000000000 --- a/reference/imagick/imagickdraw/setfillcolor.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - ImagickDraw::setFillColor - Configure la couleur de dessin des objets remplis - - - - &reftitle.description; - - public boolImagickDraw::setFillColor - ImagickPixelstringfill_color - - &warn.undocumented.func; - - Configure la couleur de dessin des objets remplis. - - - - - &reftitle.parameters; - - - - fill_color - - - L'objet ImagickPixel à utiliser pour la couleur. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setFillColor</function> - -setStrokeOpacity(1); - $draw->setStrokeWidth(1.5); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->rectangle(50, 50, 150, 150); - - $draw->setFillColor("rgb(200, 32, 32)"); - $draw->rectangle(200, 50, 300, 150); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfillopacity.xml b/reference/imagick/imagickdraw/setfillopacity.xml deleted file mode 100644 index 08012b9fa4..0000000000 --- a/reference/imagick/imagickdraw/setfillopacity.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - ImagickDraw::setFillOpacity - Configure l'opacité à utiliser pour le remplissage - - - - &reftitle.description; - - public boolImagickDraw::setFillOpacity - floatopacity - - &warn.undocumented.func; - - Configure l'opacité à utiliser pour le remplissage. - Totalement opaque est 1.0. - - - - - &reftitle.parameters; - - - - opacity - - - L'opacité de remplissage. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setFillOpacity</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - - $draw->rectangle(100, 200, 200, 300); - - $draw->setFillOpacity(0.4); - $draw->rectangle(300, 200, 400, 300); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfillpatternurl.xml b/reference/imagick/imagickdraw/setfillpatternurl.xml deleted file mode 100644 index c02462c4c4..0000000000 --- a/reference/imagick/imagickdraw/setfillpatternurl.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - ImagickDraw::setFillPatternURL - Configure l'URL du motif de remplissage des surfaces - - - - &reftitle.description; - - public boolImagickDraw::setFillPatternURL - stringfill_url - - &warn.undocumented.func; - - Configure l'URL du motif de remplissage des surfaces. Seules les URL - locales ("#identifier") sont supportées actuellement. - Ces URL sont normalement créées en définissant un nom de motif de remplissage - avec DrawPushPattern/DrawPopPattern. - - - - - &reftitle.parameters; - - - - fill_url - - - L'URL à utiliser pour accéder au motif. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/setfillrule.xml b/reference/imagick/imagickdraw/setfillrule.xml deleted file mode 100644 index f99a47634b..0000000000 --- a/reference/imagick/imagickdraw/setfillrule.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - ImagickDraw::setFillRule - Configure la règle de remplissage des polygones - - - - &reftitle.description; - - public boolImagickDraw::setFillRule - intfillrule - - &warn.undocumented.func; - - Configure la règle de remplissage des polygones. - - - - - &reftitle.parameters; - - - - fillrule - - - Une des constantes FILLRULE - (imagick::FILLRULE_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setFillRule</function> - -setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $fillRules = [\Imagick::FILLRULE_NONZERO, \Imagick::FILLRULE_EVENODD]; - - $points = 11; - $size = 150; - - $draw->translate(175, 160); - - for ($x = 0; $x < 2; $x++) { - $draw->setFillRule($fillRules[$x]); - $draw->pathStart(); - for ($n = 0; $n < $points * 2; $n++) { - - if ($n >= $points) { - $angle = fmod($n * 360 * 4 / $points, 360) * pi() / 180; - } - else { - $angle = fmod($n * 360 * 3 / $points, 360) * pi() / 180; - } - - $positionX = $size * sin($angle); - $positionY = $size * cos($angle); - - if ($n == 0) { - $draw->pathMoveToAbsolute($positionX, $positionY); - } - else { - $draw->pathLineToAbsolute($positionX, $positionY); - } - } - - $draw->pathClose(); - $draw->pathFinish(); - - $draw->translate(325, 0); - } - - $image = new \Imagick(); - $image->newImage(700, 320, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfont.xml b/reference/imagick/imagickdraw/setfont.xml deleted file mode 100644 index 12e22635b9..0000000000 --- a/reference/imagick/imagickdraw/setfont.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - ImagickDraw::setFont - Configure la police complète pour les textes - - - - &reftitle.description; - - public boolImagickDraw::setFont - stringfont_name - - &warn.undocumented.func; - - Configure la police complète pour les textes. - - - - - &reftitle.parameters; - - - - font_name - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setFont</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(36); - - $draw->setFont("../fonts/Arial.ttf"); - $draw->annotation(50, 50, "Lorem Ipsum!"); - - $draw->setFont("../fonts/Consolas.ttf"); - $draw->annotation(50, 100, "Lorem Ipsum!"); - - $draw->setFont("../fonts/CANDY.TTF"); - $draw->annotation(50, 150, "Lorem Ipsum!"); - - $draw->setFont("../fonts/Inconsolata-dz.otf"); - $draw->annotation(50, 200, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(500, 300, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontfamily.xml b/reference/imagick/imagickdraw/setfontfamily.xml deleted file mode 100644 index 239fa4159c..0000000000 --- a/reference/imagick/imagickdraw/setfontfamily.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - ImagickDraw::setFontFamily - Configure la famille de police pour les textes - - - - &reftitle.description; - - public boolImagickDraw::setFontFamily - stringfont_family - - &warn.undocumented.func; - - Configure la famille de police pour les textes. - - - - - &reftitle.parameters; - - - - font_family - - - La famille de police - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setFontFamily</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - - $draw->setFontSize(48); - - $draw->setFontFamily("Times"); - $draw->annotation(50, 50, "Lorem Ipsum!"); - - $draw->setFontFamily("AvantGarde"); - $draw->annotation(50, 100, "Lorem Ipsum!"); - - $draw->setFontFamily("NewCenturySchlbk"); - $draw->annotation(50, 150, "Lorem Ipsum!"); - - $draw->setFontFamily("Palatino"); - $draw->annotation(50, 200, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(450, 250, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontsize.xml b/reference/imagick/imagickdraw/setfontsize.xml deleted file mode 100644 index dcd929eeb8..0000000000 --- a/reference/imagick/imagickdraw/setfontsize.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - ImagickDraw::setFontSize - Configure la taille de point pour les textes - - - - &reftitle.description; - - public boolImagickDraw::setFontSize - floatpoint_size - - &warn.undocumented.func; - - Configure la taille de point pour les textes. - - - - - &reftitle.parameters; - - - - point_size - - - La taille de point. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setFontSize</function> - -setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFont("../fonts/Arial.ttf"); - - $sizes = [24, 36, 48, 60, 72]; - - foreach ($sizes as $size) { - $draw->setFontSize($size); - $draw->annotation(50, ($size * $size / 16), "Lorem Ipsum!"); - } - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontstretch.xml b/reference/imagick/imagickdraw/setfontstretch.xml deleted file mode 100644 index f9597af55b..0000000000 --- a/reference/imagick/imagickdraw/setfontstretch.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - ImagickDraw::setFontStretch - Configure l'étirement du texte - - - - &reftitle.description; - - public boolImagickDraw::setFontStretch - intstretch - - &warn.undocumented.func; - - Configure l'étirement du texte pour le dessin des annotations. - L'énumération AnyStretch sert de joker et - signifie "peu importe". - - - - - &reftitle.parameters; - - - - stretch - - - Une des constantes STRETCH - (imagick::STRETCH_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setFontStretch</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(36); - - $fontStretchTypes = [ - \Imagick::STRETCH_ULTRACONDENSED, - \Imagick::STRETCH_CONDENSED, - \Imagick::STRETCH_SEMICONDENSED, - \Imagick::STRETCH_SEMIEXPANDED, - \Imagick::STRETCH_EXPANDED, - \Imagick::STRETCH_EXTRAEXPANDED, - \Imagick::STRETCH_ULTRAEXPANDED, - \Imagick::STRETCH_ANY - ]; - - $offset = 0; - foreach ($fontStretchTypes as $fontStretch) { - $draw->setFontStretch($fontStretch); - $draw->annotation(50, 75 + $offset, "Lorem Ipsum!"); - $offset += 50; - } - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontstyle.xml b/reference/imagick/imagickdraw/setfontstyle.xml deleted file mode 100644 index 823fb05929..0000000000 --- a/reference/imagick/imagickdraw/setfontstyle.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - ImagickDraw::setFontStyle - Configure le style de police - - - - &reftitle.description; - - public boolImagickDraw::setFontStyle - intstyle - - &warn.undocumented.func; - - Configure le style de police utilisée pour dessiner les annotations. - L'énumération AnyStyle joue le rôle de joker, - et signifie "peu importe". - - - - - &reftitle.parameters; - - - - style - - - Une des constantes STYLE - (imagick::STYLE_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setFontStyle</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setFontSize(36); - $draw->setFontStyle(\Imagick::STYLE_NORMAL); - $draw->annotation(50, 50, "Lorem Ipsum!"); - - $draw->setFontStyle(\Imagick::STYLE_ITALIC); - $draw->annotation(50, 100, "Lorem Ipsum!"); - - $draw->setFontStyle(\Imagick::STYLE_OBLIQUE); - $draw->annotation(50, 150, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(350, 300, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontweight.xml b/reference/imagick/imagickdraw/setfontweight.xml deleted file mode 100644 index 38a8d1eb97..0000000000 --- a/reference/imagick/imagickdraw/setfontweight.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - ImagickDraw::setFontWeight - Configure le poids de la police - - - - &reftitle.description; - - public boolImagickDraw::setFontWeight - intweight - - &warn.undocumented.func; - - Configure le poids de la police pour dessiner les annotations. - - - - - &reftitle.parameters; - - - - weight - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setFontWeight</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(1); - - $draw->setFontSize(36); - - $draw->setFontWeight(100); - $draw->annotation(50, 50, "Lorem Ipsum!"); - - $draw->setFontWeight(200); - $draw->annotation(50, 100, "Lorem Ipsum!"); - - $draw->setFontWeight(400); - $draw->annotation(50, 150, "Lorem Ipsum!"); - - $draw->setFontWeight(800); - $draw->annotation(50, 200, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setgravity.xml b/reference/imagick/imagickdraw/setgravity.xml deleted file mode 100644 index 3238038aed..0000000000 --- a/reference/imagick/imagickdraw/setgravity.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - ImagickDraw::setGravity - Configure la gravité de placement de texte - - - - &reftitle.description; - - public boolImagickDraw::setGravity - intgravity - - &warn.undocumented.func; - - Configure la gravité de placement de texte, à utiliser pour dessiner - les annotations. - - - - - &reftitle.parameters; - - - - gravity - - - Une des constantes GRAVITY - (imagick::GRAVITY_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setGravity</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setFontSize(24); - - $gravitySettings = array( - \Imagick::GRAVITY_NORTHWEST => 'NorthWest', - \Imagick::GRAVITY_NORTH => 'North', - \Imagick::GRAVITY_NORTHEAST => 'NorthEast', - \Imagick::GRAVITY_WEST => 'West', - \Imagick::GRAVITY_CENTER => 'Centre', - \Imagick::GRAVITY_SOUTHWEST => 'SouthWest', - \Imagick::GRAVITY_SOUTH => 'South', - \Imagick::GRAVITY_SOUTHEAST => 'SouthEast', - \Imagick::GRAVITY_EAST => 'East' - ); - - $draw->setFont("../fonts/Arial.ttf"); - - foreach ($gravitySettings as $type => $description) { - $draw->setGravity($type); - $draw->annotation(50, 50, '"' . $description . '"'); - } - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setresolution.xml b/reference/imagick/imagickdraw/setresolution.xml deleted file mode 100644 index 4e5e0afb0c..0000000000 --- a/reference/imagick/imagickdraw/setresolution.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - ImagickDraw::setResolution - Définit la résolution - - - - &reftitle.description; - - public boolImagickDraw::setResolution - floatresolution_x - floatresolution_y - - - Définit la résolution. - - - - - - &reftitle.parameters; - - - resolution_x - - - - - - - - resolution_y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokealpha.xml b/reference/imagick/imagickdraw/setstrokealpha.xml deleted file mode 100644 index 69bc5f99ad..0000000000 --- a/reference/imagick/imagickdraw/setstrokealpha.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - ImagickDraw::setStrokeAlpha - Spécifie l'opacité des contours d'objets - - - - &reftitle.description; - - public boolImagickDraw::setStrokeAlpha - floatalpha - - &warn.undocumented.func; - - Spécifie l'opacité des contours d'objets. - - - - - &reftitle.parameters; - - - - alpha - - - L'opacité - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setStrokeAlpha</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(4); - $draw->line(100, 100, 400, 145); - $draw->rectangle(100, 200, 225, 350); - $draw->setStrokeOpacity(0.1); - $draw->line(100, 120, 400, 165); - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokeantialias.xml b/reference/imagick/imagickdraw/setstrokeantialias.xml deleted file mode 100644 index 3fbeb3b42d..0000000000 --- a/reference/imagick/imagickdraw/setstrokeantialias.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - ImagickDraw::setStrokeAntialias - Contrôle l'anti-aliasing des pointillés - - - - &reftitle.description; - - public boolImagickDraw::setStrokeAntialias - boolenabled - - &warn.undocumented.func; - - Contrôle l'anti-aliasing des pointillés. Les contours à traits sont anti-aliasés - par défaut. Lorsque l'anti-aliasing est désactivé, les pointillés utilisent - une valeur de seuil pour définir si le pixel sous-jacent doit être coloré ou pas. - - - - - &reftitle.parameters; - - - - enabled - - - La configuration d'utilisation de l'anti-aliasing - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setStrokeAntialias</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setStrokeAntialias(false); - $draw->line(100, 100, 400, 105); - - $draw->line(100, 140, 400, 185); - - $draw->setStrokeAntialias(true); - $draw->line(100, 110, 400, 115); - $draw->line(100, 150, 400, 195); - - $image = new \Imagick(); - $image->newImage(500, 250, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokecolor.xml b/reference/imagick/imagickdraw/setstrokecolor.xml deleted file mode 100644 index eab47f3673..0000000000 --- a/reference/imagick/imagickdraw/setstrokecolor.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - ImagickDraw::setStrokeColor - Configure la couleur utilisée pour dessiner les objets - - - - &reftitle.description; - - public boolImagickDraw::setStrokeColor - ImagickPixelstringcolor - - &warn.undocumented.func; - - Configure la couleur utilisée pour dessiner les objets. - - - - - &reftitle.parameters; - - - - color - - - La couleur du trait. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setStrokeColor</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(5); - - $draw->line(100, 100, 400, 145); - $draw->rectangle(100, 200, 225, 350); - - $draw->setStrokeOpacity(0.1); - $draw->line(100, 120, 400, 165); - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokedasharray.xml b/reference/imagick/imagickdraw/setstrokedasharray.xml deleted file mode 100644 index ed8602f919..0000000000 --- a/reference/imagick/imagickdraw/setstrokedasharray.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - ImagickDraw::setStrokeDashArray - Spécifie le motif de pointillé - - - - &reftitle.description; - - public boolImagickDraw::setStrokeDashArray - arraynulldashes - - &warn.undocumented.func; - - Spécifie le motif de pointillé, les pleins et vides. L'objet - strokeDashArray représente un tableau de nombres qui spécifie les - longueurs des pleins et vides, en pixels. Si un nombre impair de valeurs - est fourni, alors la liste est répétée pour obtenir un nombre pair de valeurs. - Pour retirer un tableau de motif existant, passez un nombre d'éléments - à zéro, et &null; comme deuxième valeur. Un tableau strokeDashArray typique - contient les membres 5 3 2. - - - - - &reftitle.parameters; - - - - dashes - - - Un tableau de nombres décimaux - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setStrokeDashArray</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(4); - - $draw->setStrokeDashArray([10, 10]); - $draw->rectangle(100, 50, 225, 175); - - $draw->setStrokeDashArray([20, 5, 20, 5, 5, 5,]); - $draw->rectangle(275, 50, 400, 175); - - $draw->setStrokeDashArray([20, 5, 20, 5, 5]); - $draw->rectangle(100, 200, 225, 350); - - $draw->setStrokeDashArray([1, 1, 1, 1, 2, 2, 3, 3, 5, 5, 8, 8, 13, 13, 21, 21, 34, 34, 55, 55, 89, 89, 144, 144, 233, 233, 377, 377, 610, 610, 987, 987, 1597, 1597, 2584, 2584, 4181, 4181,]); - - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokedashoffset.xml b/reference/imagick/imagickdraw/setstrokedashoffset.xml deleted file mode 100644 index d28b4fe643..0000000000 --- a/reference/imagick/imagickdraw/setstrokedashoffset.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - ImagickDraw::setStrokeDashOffset - Spécifie la position dans le motif pour commencer le pointillé - - - - &reftitle.description; - - public boolImagickDraw::setStrokeDashOffset - floatdash_offset - - &warn.undocumented.func; - - Spécifie la position dans le motif pour commencer le pointillé. - - - - - &reftitle.parameters; - - - - dash_offset - - - La position de début du pointillé - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setStrokeDashOffset</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(4); - $draw->setStrokeDashArray([20, 20]); - $draw->setStrokeDashOffset(0); - $draw->rectangle(100, 50, 225, 175); - - //Start the dash effect halfway through the solid portion - $draw->setStrokeDashOffset(10); - $draw->rectangle(275, 50, 400, 175); - - //Start the dash effect on the space portion - $draw->setStrokeDashOffset(20); - $draw->rectangle(100, 200, 225, 350); - $draw->setStrokeDashOffset(5); - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokelinecap.xml b/reference/imagick/imagickdraw/setstrokelinecap.xml deleted file mode 100644 index 04f5bf8155..0000000000 --- a/reference/imagick/imagickdraw/setstrokelinecap.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - ImagickDraw::setStrokeLineCap - Spécifie la forme à utiliser à la fin des sous-chemins - - - - &reftitle.description; - - public boolImagickDraw::setStrokeLineCap - intlinecap - - &warn.undocumented.func; - - Spécifie la forme à utiliser à la fin des sous-chemins. - - - - - &reftitle.parameters; - - - - linecap - - - Une des constantes LINECAP - (imagick::LINECAP_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setStrokeLineCap</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(25); - - $lineTypes = [\Imagick::LINECAP_BUTT, \Imagick::LINECAP_ROUND, \Imagick::LINECAP_SQUARE,]; - - $offset = 0; - - foreach ($lineTypes as $lineType) { - $draw->setStrokeLineCap($lineType); - $draw->line(50 + $offset, 50, 50 + $offset, 250); - $offset += 50; - } - - $imagick = new \Imagick(); - $imagick->newImage(300, 300, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokelinejoin.xml b/reference/imagick/imagickdraw/setstrokelinejoin.xml deleted file mode 100644 index b4425cee5a..0000000000 --- a/reference/imagick/imagickdraw/setstrokelinejoin.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - ImagickDraw::setStrokeLineJoin - Spécifie la forme à utiliser aux coins des chemins - - - - &reftitle.description; - - public boolImagickDraw::setStrokeLineJoin - intlinejoin - - &warn.undocumented.func; - - Spécifie la forme à utiliser aux coins des chemins - (ou d'autres formes vectorielles), quand ils utilisent un trait. - - - - - &reftitle.parameters; - - - - linejoin - - - Une des constantes LINEJOIN - (imagick::LINEJOIN_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setStrokeLineJoin</function> - -setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(20); - - $offset = 220; - - $lineJoinStyle = [ - \Imagick::LINEJOIN_MITER, - \Imagick::LINEJOIN_ROUND, - \Imagick::LINEJOIN_BEVEL, - ]; - - for ($x = 0; $x < count($lineJoinStyle); $x++) { - $draw->setStrokeLineJoin($lineJoinStyle[$x]); - $points = [ - ['x' => 40 * 5, 'y' => 10 * 5 + $x * $offset], - ['x' => 20 * 5, 'y' => 20 * 5 + $x * $offset], - ['x' => 70 * 5, 'y' => 50 * 5 + $x * $offset], - ['x' => 40 * 5, 'y' => 10 * 5 + $x * $offset], - ]; - - $draw->polyline($points); - } - - $image = new \Imagick(); - $image->newImage(500, 700, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokemiterlimit.xml b/reference/imagick/imagickdraw/setstrokemiterlimit.xml deleted file mode 100644 index c1847917d1..0000000000 --- a/reference/imagick/imagickdraw/setstrokemiterlimit.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - ImagickDraw::setStrokeMiterLimit - Spécifie la limite miter - - - - &reftitle.description; - - public boolImagickDraw::setStrokeMiterLimit - intmiterlimit - - &warn.undocumented.func; - - Spécifie la limite miter. Lorsque deux lignes se rejoignent à angle aigu, - et que la limite miter a été configurée à "lineJoin", il est - possible que le miter dépasse l'épaisseur de la ligne. La limite miter impose - un ratio entre la longueur de miter et l'épaisseur de la ligne - "lineWidth". - - - - - &reftitle.parameters; - - - - miterlimit - - - La limite miter - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setStrokeMiterLimit</function> - -setStrokeColor($strokeColor); - $draw->setStrokeOpacity(0.6); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(10); - - $yOffset = 100; - - $draw->setStrokeLineJoin(\Imagick::LINEJOIN_MITER); - - for ($y = 0; $y < 3; $y++) { - - $draw->setStrokeMiterLimit(40 * $y); - - $points = [ - ['x' => 22 * 3, 'y' => 15 * 4 + $y * $yOffset], - ['x' => 20 * 3, 'y' => 20 * 4 + $y * $yOffset], - ['x' => 70 * 5, 'y' => 45 * 4 + $y * $yOffset], - ]; - - $draw->polygon($points); - } - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - $image->setImageType(\Imagick::IMGTYPE_PALETTE); - $image->setImageCompressionQuality(100); - $image->stripImage(); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokeopacity.xml b/reference/imagick/imagickdraw/setstrokeopacity.xml deleted file mode 100644 index a3f664829d..0000000000 --- a/reference/imagick/imagickdraw/setstrokeopacity.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - ImagickDraw::setStrokeOpacity - Spécifie l'opacité pour dessiner les contours - - - - &reftitle.description; - - public boolImagickDraw::setStrokeOpacity - floatopacity - - &warn.undocumented.func; - - Spécifie l'opacité pour dessiner les contours. - - - - - &reftitle.parameters; - - - - opacity - - - L'opacité du trait. 1.0 est totalement opaque. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setStrokeOpacity</function> - -setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(10); - $draw->setStrokeOpacity(1); - $draw->line(100, 80, 400, 125); - $draw->rectangle(25, 200, 150, 350); - $draw->setStrokeOpacity(0.5); - $draw->line(100, 100, 400, 145); - $draw->rectangle(200, 200, 325, 350); - $draw->setStrokeOpacity(0.2); - $draw->line(100, 120, 400, 165); - $draw->rectangle(375, 200, 500, 350); - - $image = new \Imagick(); - $image->newImage(550, 400, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokepatternurl.xml b/reference/imagick/imagickdraw/setstrokepatternurl.xml deleted file mode 100644 index cd254f550a..0000000000 --- a/reference/imagick/imagickdraw/setstrokepatternurl.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - ImagickDraw::setStrokePatternURL - Configure le motif utilisé pour dessiner les contours - - - - &reftitle.description; - - public boolImagickDraw::setStrokePatternURL - stringstroke_url - - &warn.undocumented.func; - - Configure le motif utilisé pour dessiner les contours. - - - - - &reftitle.parameters; - - - - stroke_url - - - L'URL du motif du trait - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokewidth.xml b/reference/imagick/imagickdraw/setstrokewidth.xml deleted file mode 100644 index 8956a0b6ff..0000000000 --- a/reference/imagick/imagickdraw/setstrokewidth.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - ImagickDraw::setStrokeWidth - Configure la largeur du trait pour dessiner les contours - - - - &reftitle.description; - - public boolImagickDraw::setStrokeWidth - floatwidth - - &warn.undocumented.func; - - Configure la largeur du trait pour dessiner les contours. - - - - - &reftitle.parameters; - - - - width - - - La largeur du trait - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setStrokeWidth</function> - -setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->line(100, 100, 400, 145); - $draw->rectangle(100, 200, 225, 350); - $draw->setStrokeWidth(5); - $draw->line(100, 120, 400, 165); - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/settextalignment.xml b/reference/imagick/imagickdraw/settextalignment.xml deleted file mode 100644 index 9c48afdf50..0000000000 --- a/reference/imagick/imagickdraw/settextalignment.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - ImagickDraw::setTextAlignment - Spécifie l'alignement du texte - - - - &reftitle.description; - - public boolImagickDraw::setTextAlignment - intalign - - &warn.undocumented.func; - - Spécifie l'alignement du texte à appliquer au texte d'une annotation. - - - - - &reftitle.parameters; - - - - align - - - Une des constantes ALIGN - (imagick::ALIGN_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setTextAlignment</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setFontSize(36); - - $draw->setTextAlignment(\Imagick::ALIGN_LEFT); - $draw->annotation(250, 75, "Lorem Ipsum!"); - $draw->setTextAlignment(\Imagick::ALIGN_CENTER); - $draw->annotation(250, 150, "Lorem Ipsum!"); - $draw->setTextAlignment(\Imagick::ALIGN_RIGHT); - $draw->annotation(250, 225, "Lorem Ipsum!"); - $draw->line(250, 0, 250, 500); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/settextantialias.xml b/reference/imagick/imagickdraw/settextantialias.xml deleted file mode 100644 index 353cced83d..0000000000 --- a/reference/imagick/imagickdraw/settextantialias.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - ImagickDraw::setTextAntialias - Contrôle l'anti-aliasing du texte - - - - &reftitle.description; - - public boolImagickDraw::setTextAntialias - boolantialias - - &warn.undocumented.func; - - Contrôle l'anti-aliasing du texte. Les textes sont anti-aliasés par défaut. - - - - - &reftitle.parameters; - - - - antialias - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setTextAntialias</function> - -setStrokeColor('none'); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setFontSize(32); - $draw->setTextAntialias(false); - $draw->annotation(5, 30, "Lorem Ipsum!"); - $draw->setTextAntialias(true); - $draw->annotation(5, 65, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(220, 80, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - //Scale the image so that people can see the aliasing. - $imagick->scaleImage(220 * 6, 80 * 6); - $imagick->cropImage(640, 480, 0, 0); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/settextdecoration.xml b/reference/imagick/imagickdraw/settextdecoration.xml deleted file mode 100644 index dd3902bc55..0000000000 --- a/reference/imagick/imagickdraw/settextdecoration.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - ImagickDraw::setTextDecoration - Spécifie les ornements de texte - - - - &reftitle.description; - - public boolImagickDraw::setTextDecoration - intdecoration - - &warn.undocumented.func; - - Spécifie les ornements de texte utilisés pour les annotations. - - - - - &reftitle.parameters; - - - - decoration - - - Une des constantes DECORATION - (imagick::DECORATION_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setTextDecoration</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->setTextDecoration($textDecoration); - $draw->annotation(50, 75, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(500, 200, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/settextencoding.xml b/reference/imagick/imagickdraw/settextencoding.xml deleted file mode 100644 index 656725b686..0000000000 --- a/reference/imagick/imagickdraw/settextencoding.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - ImagickDraw::setTextEncoding - Spécifie le jeu de caractères - - - - &reftitle.description; - - public boolImagickDraw::setTextEncoding - stringencoding - - &warn.undocumented.func; - - Spécifie le jeu de caractères à utiliser pour les annotations de texte. - Le seul jeu de caractères qui peut être spécifié actuellement est - "UTF-8", qui représente l'Unicode sous forme d'une séquence d'octets. - Spécifier une chaîne vide pour utiliser le jeu de caractères du système. - Le dessin des textes peut avoir besoin d'une police qui supporte Unicode. - - - - - &reftitle.parameters; - - - - encoding - - - Le jeu de caractères - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/settextinterlinespacing.xml b/reference/imagick/imagickdraw/settextinterlinespacing.xml deleted file mode 100644 index 05335b9aac..0000000000 --- a/reference/imagick/imagickdraw/settextinterlinespacing.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - ImagickDraw::setTextInterlineSpacing - Définit l'espace entre les lignes d'un texte - - - - &reftitle.description; - - public boolImagickDraw::setTextInterlineSpacing - floatspacing - - - Définit l'espace entre les lignes d'un texte. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - spacing - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickdraw/settextinterwordspacing.xml b/reference/imagick/imagickdraw/settextinterwordspacing.xml deleted file mode 100644 index e8a8340523..0000000000 --- a/reference/imagick/imagickdraw/settextinterwordspacing.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - ImagickDraw::setTextInterwordSpacing - Définit l'espace entre les mots d'un texte - - - - &reftitle.description; - - public boolImagickDraw::setTextInterwordSpacing - floatspacing - - - Définit l'espace entre les mots d'un texte. - - - - - - &reftitle.parameters; - - - spacing - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickdraw/settextkerning.xml b/reference/imagick/imagickdraw/settextkerning.xml deleted file mode 100644 index a27217360a..0000000000 --- a/reference/imagick/imagickdraw/settextkerning.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - ImagickDraw::setTextKerning - Définit le crénage d'un texte - - - - &reftitle.description; - - public boolImagickDraw::setTextKerning - floatkerning - - - Définit le crénage d'un texte. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - kerning - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickdraw/settextundercolor.xml b/reference/imagick/imagickdraw/settextundercolor.xml deleted file mode 100644 index b55e4fdc75..0000000000 --- a/reference/imagick/imagickdraw/settextundercolor.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - ImagickDraw::setTextUnderColor - Spécifie la couleur de fond d'un rectangle - - - - &reftitle.description; - - public boolImagickDraw::setTextUnderColor - ImagickPixelstringunder_color - - &warn.undocumented.func; - - Spécifie la couleur de fond d'un rectangle à placer sous les textes. - - - - - &reftitle.parameters; - - - - under_color - - - La couleur de fond - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setTextUnderColor</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->annotation(50, 75, "Lorem Ipsum!"); - $draw->setTextUnderColor($textUnderColor); - $draw->annotation(50, 175, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setvectorgraphics.xml b/reference/imagick/imagickdraw/setvectorgraphics.xml deleted file mode 100644 index 68ee60ef02..0000000000 --- a/reference/imagick/imagickdraw/setvectorgraphics.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - - ImagickDraw::setVectorGraphics - Configure le vecteur graphique - - - - &reftitle.description; - - public boolImagickDraw::setVectorGraphics - stringxml - - &warn.undocumented.func; - - Configure le vecteur graphique associé à l'objet ImagickDraw. - Utiliser cette méthode avec ImagickDraw::getVectorGraphics, pour - faire persister l'état du vecteur graphique. - - - - - &reftitle.parameters; - - - - xml - - - Code XML contenant le vecteur graphique - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setVectorGraphics</function> - -setFillColor("red"); - $draw->circle(20, 20, 50, 50); - $draw->setFillColor("blue"); - $draw->circle(50, 70, 50, 50); - $draw->rectangle(50, 120, 80, 150); - - //Get the drawing as a string - $SVG = $draw->getVectorGraphics(); - - //$svg is a string, and could be saved anywhere a string can be saved - - //Use the saved drawing to generate a new draw object - $draw2 = new \ImagickDraw(); - //Apparently the SVG text is missing the root element. - $draw2->setVectorGraphics("".$SVG.""); - - $imagick = new \Imagick(); - $imagick->newImage(200, 200, 'white'); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw2); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setviewbox.xml b/reference/imagick/imagickdraw/setviewbox.xml deleted file mode 100644 index d865c2f708..0000000000 --- a/reference/imagick/imagickdraw/setviewbox.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - ImagickDraw::setViewbox - Configure la taille du canevas - - - - &reftitle.description; - - public boolImagickDraw::setViewbox - intleft_x - inttop_y - intright_x - intbottom_y - - &warn.undocumented.func; - - Configure la taille du canevas général, à enregistrer avec les données - vectorielles. Généralement, on configure cette valeur avec la même taille - que l'image. Lorsque les données vectorielles sont sauvées en SVG ou MVG, - la boîte de vue est utilisée pour spécifier la taille de l'image dans laquelle - le visualiseur va dessiner les données. - - - - - &reftitle.parameters; - - - - left_x - - - Abscisse gauche - - - - - top_y - - - Ordonnée gauche - - - - - right_x - - - Abscisse droite - - - - - bottom_y - - - Ordonnée droite - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::setViewBox</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - /* - - Sets the overall canvas size to be recorded with the drawing vector data. Usually this will be specified using the same size as the canvas image. When the vector data is saved to SVG or MVG formats, the viewbox is use to specify the size of the canvas image that a viewer will render the vector data on. - - */ - - $draw->circle(250, 250, 250, 0); - $draw->setviewbox(0, 0, 200, 200); - $draw->circle(125, 250, 250, 250); - $draw->translate(250, 125); - $draw->circle(0, 0, 125, 0); - - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/skewx.xml b/reference/imagick/imagickdraw/skewx.xml deleted file mode 100644 index d1f2fc3b50..0000000000 --- a/reference/imagick/imagickdraw/skewx.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - - ImagickDraw::skewX - Biaise les coordonnées dans la direction horizontale - - - - &reftitle.description; - - public boolImagickDraw::skewX - floatdegrees - - &warn.undocumented.func; - - Biaise les coordonnées dans la direction horizontale. - - - - - &reftitle.parameters; - - - - degrees - - - Degré de biaisage - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::skewX</function> - -setStrokeColor($strokeColor); - $draw->setStrokeWidth(2); - $draw->setFillColor($fillColor); - $draw->rectangle($startX, $startY, $endX, $endY); - $draw->setFillColor($fillModifiedColor); - $draw->skewX($skew); - $draw->rectangle($startX, $startY, $endX, $endY); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/skewy.xml b/reference/imagick/imagickdraw/skewy.xml deleted file mode 100644 index 8083d78521..0000000000 --- a/reference/imagick/imagickdraw/skewy.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - ImagickDraw::skewY - Incline les coordonnées dans la direction verticale - - - - &reftitle.description; - - public boolImagickDraw::skewY - floatdegrees - - &warn.undocumented.func; - - Incline les coordonnées dans la direction verticale. - - - - - &reftitle.parameters; - - - - degrees - - - Le nombre de degrés d'inclinaison - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::skewY</function> - -setStrokeColor($strokeColor); - $draw->setStrokeWidth(2); - $draw->setFillColor($fillColor); - $draw->rectangle($startX, $startY, $endX, $endY); - $draw->setFillColor($fillModifiedColor); - $draw->skewY($skew); - $draw->rectangle($startX, $startY, $endX, $endY); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/translate.xml b/reference/imagick/imagickdraw/translate.xml deleted file mode 100644 index 3271730d95..0000000000 --- a/reference/imagick/imagickdraw/translate.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - ImagickDraw::translate - Applique une translation - - - - &reftitle.description; - - public boolImagickDraw::translate - floatx - floaty - - &warn.undocumented.func; - - Applique une translation au système de coordonnées actuel, - qui déplace l'origine de ce système. - - - - - &reftitle.parameters; - - - - x - - - Translation horizontale - - - - - y - - - Translation verticale - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickDraw::translate</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->rectangle($startX, $startY, $endX, $endY); - - $draw->setFillColor($fillModifiedColor); - $draw->translate($translateX, $translateY); - $draw->rectangle($startX, $startY, $endX, $endY); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdrawexception.xml b/reference/imagick/imagickdrawexception.xml deleted file mode 100644 index f4be15312a..0000000000 --- a/reference/imagick/imagickdrawexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - La classe ImagickDrawException - ImagickDrawException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - - ImagickDrawException - - - - - ImagickDrawException - - - - extends - Exception - - - - Throwable - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -     - -     - diff --git a/reference/imagick/imagickexception.xml b/reference/imagick/imagickexception.xml deleted file mode 100644 index ea6f815450..0000000000 --- a/reference/imagick/imagickexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - La classe ImagickException - ImagickException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - - ImagickException - - - - - ImagickException - - - - extends - Exception - - - - Throwable - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -     - -     - diff --git a/reference/imagick/imagickkernel.xml b/reference/imagick/imagickkernel.xml deleted file mode 100644 index bfc2ff7c10..0000000000 --- a/reference/imagick/imagickkernel.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - La classe ImagickKernel - ImagickKernel - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ImagickKernel - - - - - ImagickKernel - - - - - &Methods; - - - - -
    - -     - - &reference.imagick.entities.imagickkernel; - -     - - diff --git a/reference/imagick/imagickkernel/addkernel.xml b/reference/imagick/imagickkernel/addkernel.xml deleted file mode 100644 index 9add66de42..0000000000 --- a/reference/imagick/imagickkernel/addkernel.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - ImagickKernel::addKernel - Attache un autre noyau à une liste de noyaux - - - - &reftitle.description; - - public voidImagickKernel::addKernel - ImagickKernelImagickKernel - - - Attache un autre noyau à ce noyau pour leur permettre d'être tous deux appliqués dans une seule fonction de morphologie ou de filtre. Renvoie le nouveau noyau combiné. - - - - - - &reftitle.parameters; - - - ImagickKernel - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::addKernel</function> - - addKernel($kernel2); - - $imagick = new \Imagick(realpath($imagePath)); - $imagick->filter($kernel1); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); - -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickkernel/addunitykernel.xml b/reference/imagick/imagickkernel/addunitykernel.xml deleted file mode 100644 index 6da828ed48..0000000000 --- a/reference/imagick/imagickkernel/addunitykernel.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - ImagickKernel::addUnityKernel - Ajoute un noyau Unity à la liste des noyaux - - - - &reftitle.description; - - public voidImagickKernel::addUnityKernel - floatscale - - - Ajoute une quantité donnée du noyau de convolution 'Unity' au noyau de convolution pré-échelonné - et normalisé donné. Cela a pour effet d'ajouter cette quantité de l'image d'origine - dans le noyau de convolution résultant. L'effet résultant est de convertir les noyaux - définis en flous doux mélangés, en noyaux non tranchants ou en noyaux de netteté. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::addUnityKernel</function> - - "; - - foreach ($matrix as $row) { - $output .= ""; - foreach ($row as $cell) { - $output .= ""; - if ($cell === false) { - $output .= "false"; - } - else { - $output .= round($cell, 3); - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; - } - - $matrix = [ - [-1, 0, -1], - [ 0, 4, 0], - [-1, 0, -1], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix); - $kernel->scale(1, \Imagick::NORMALIZE_KERNEL_VALUE); - $output = "Before adding unity kernel:
    "; - $output .= renderKernelTable($kernel->getMatrix()); - $kernel->addUnityKernel(0.5); - $output .= "After adding unity kernel:
    "; - $output .= renderKernelTable($kernel->getMatrix()); - - - $kernel->scale(1, \Imagick::NORMALIZE_KERNEL_VALUE); - $output .= "After renormalizing kernel:
    "; - $output .= renderKernelTable($kernel->getMatrix()); - - echo $output; - -?> -]]> -     -     - - - <function>ImagickKernel::addUnityKernel</function> - - scale(4, \Imagick::NORMALIZE_KERNEL_VALUE); - $kernel->addUnityKernel(0.5); - - - $imagick = new \Imagick(realpath($imagePath)); - $imagick->filter($kernel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); - -} - -?> -]]> - - -     -     - -     - - diff --git a/reference/imagick/imagickkernel/frombuiltin.xml b/reference/imagick/imagickkernel/frombuiltin.xml deleted file mode 100644 index 9a0b030eba..0000000000 --- a/reference/imagick/imagickkernel/frombuiltin.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - ImagickKernel::fromBuiltIn - Crée un noyau à partir d'un noyau intégré - - - - &reftitle.description; - - public static ImagickKernelImagickKernel::fromBuiltin - intkernelType - stringkernelString - - - Crée un noyau à partir d'un noyau intégré. Voir http://www.imagemagick.org/Usage/morphology/#kernel pour des exemples. Actuellement, les symboles de 'rotation' ne sont pas supportés. Exemple : - $diamondKernel = ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DIAMOND, "2"); - - - - - - &reftitle.parameters; - - - kerneltype - - - Le type de noyau à construire par exemple \Imagick::KERNEL_DIAMOND - - - - - kernelString - - - Une chaîne qui décrit les paramètres par exemple "4,2.5" - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::fromBuiltin</function> - - getMatrix(); - - $imageMargin = 20; - - $tileSize = 20; - $tileSpace = 4; - $shadowSigma = 4; - $shadowDropX = 20; - $shadowDropY = 0; - - $radius = ($tileSize / 2) * 0.9; - - $rows = count($matrix); - $columns = count($matrix[0]); - - $imagickDraw = new \ImagickDraw(); - - $imagickDraw->setFillColor('#afafaf'); - $imagickDraw->setStrokeColor('none'); - - $imagickDraw->translate($imageMargin, $imageMargin); - $imagickDraw->push(); - - ksort($matrix); - - foreach ($matrix as $row) { - ksort($row); - $imagickDraw->push(); - foreach ($row as $cell) { - if ($cell !== false) { - $color = intval(255 * $cell); - $colorString = sprintf("rgb(%f, %f, %f)", $color, $color, $color); - $imagickDraw->setFillColor($colorString); - $imagickDraw->rectangle(0, 0, $tileSize, $tileSize); - } - $imagickDraw->translate(($tileSize + $tileSpace), 0); - } - $imagickDraw->pop(); - $imagickDraw->translate(0, ($tileSize + $tileSpace)); - } - - $imagickDraw->pop(); - - $width = ($columns * $tileSize) + (($columns - 1) * $tileSpace); - $height = ($rows * $tileSize) + (($rows - 1) * $tileSpace); - - $imagickDraw->push(); - $imagickDraw->translate($width/2 , $height/2); - $imagickDraw->setFillColor('rgba(0, 0, 0, 0)'); - $imagickDraw->setStrokeColor('white'); - $imagickDraw->circle(0, 0, $radius - 1, 0); - $imagickDraw->setStrokeColor('black'); - $imagickDraw->circle(0, 0, $radius, 0); - $imagickDraw->pop(); - - $canvasWidth = $width + (2 * $imageMargin); - $canvasHeight = $height + (2 * $imageMargin); - - $kernel = new \Imagick(); - $kernel->newPseudoImage( - $canvasWidth, - $canvasHeight, - 'canvas:none' - ); - - $kernel->setImageFormat('png'); - $kernel->drawImage($imagickDraw); - - /* créer une ombre portée sur sa propre couche */ - $canvas = $kernel->clone(); - $canvas->setImageBackgroundColor(new \ImagickPixel('rgb(0, 0, 0)')); - $canvas->shadowImage(100, $shadowSigma, $shadowDropX, $shadowDropY); - - $canvas->setImagePage($canvasWidth, $canvasHeight, -5, -5); - $canvas->cropImage($canvasWidth, $canvasHeight, 0, 0); - - /* composite original text_layer onto shadow_layer */ - $canvas->compositeImage($kernel, \Imagick::COMPOSITE_OVER, 0, 0); - $canvas->setImageFormat('png'); - - return $canvas; -} - - -function createFromBuiltin($kernelType, $kernelFirstTerm, $kernelSecondTerm, $kernelThirdTerm) { - $string = ''; - - if ($kernelFirstTerm != false && strlen(trim($kernelFirstTerm)) != 0) { - $string .= $kernelFirstTerm; - - if ($kernelSecondTerm != false && strlen(trim($kernelSecondTerm)) != 0) { - $string .= ','.$kernelSecondTerm; - if ($kernelThirdTerm != false && strlen(trim($kernelThirdTerm)) != 0) { - $string .= ','.$kernelThirdTerm; - } - } - } - - $kernel = ImagickKernel::fromBuiltIn( - $kernelType, - $string - ); - - return $kernel; -} - -function fromBuiltin($kernelType, $kernelFirstTerm, $kernelSecondTerm, $kernelThirdTerm) { - $diamondKernel = createFromBuiltin($kernelType, $kernelFirstTerm, $kernelSecondTerm, $kernelThirdTerm); - $imagick = renderKernel($diamondKernel); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -fromBuiltin(\Imagick::KERNEL_DIAMOND, 2, false, false); - - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickkernel/frommatrix.xml b/reference/imagick/imagickkernel/frommatrix.xml deleted file mode 100644 index 23ab2a9a2a..0000000000 --- a/reference/imagick/imagickkernel/frommatrix.xml +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - ImagickKernel::fromMatrix - Créer un noyau à partir d'une matrice 2D de valeurs - - - - &reftitle.description; - - public static ImagickKernelImagickKernel::fromMatrix - arraymatrix - arrayorigin - - - Crée un noyau à partir d'une matrice 2D de valeurs. Chaque valeur doit être soit un flottant - (si l'élément doit être utilisé) ou 'false' si l'élément doit être ignoré. Pour - les matrices qui ont des tailles impaires dans les deux dimensions, le pixel d'origine sera par défaut - au centre du noyau. Pour toutes les autres tailles de noyau, le pixel d'origine doit être spécifié. - - - - - - &reftitle.parameters; - - - array - - - Une matrice (c'est-à-dire un tableau 2D) de valeurs qui définissent le noyau. Chaque élément doit être soit une valeur flottante, ou FALSE si cet élément ne doit pas être utilisé par le noyau. - - - - - array - - - Quel élément du noyau doit être utilisé comme pixel d'origine. Par exemple, pour une matrice 3x3 spécifiant l'origine comme [2, 2] spécifierait que l'élément en bas à droite devrait être le pixel d'origine. - - - - - - - - &reftitle.returnvalues; - - L'objet ImagickKernel généré. - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::fromMatrix</function> - - getMatrix(); - - $imageMargin = 20; - - $tileSize = 20; - $tileSpace = 4; - $shadowSigma = 4; - $shadowDropX = 20; - $shadowDropY = 0; - - $radius = ($tileSize / 2) * 0.9; - - $rows = count($matrix); - $columns = count($matrix[0]); - - $imagickDraw = new \ImagickDraw(); - - $imagickDraw->setFillColor('#afafaf'); - $imagickDraw->setStrokeColor('none'); - - $imagickDraw->translate($imageMargin, $imageMargin); - $imagickDraw->push(); - - ksort($matrix); - - foreach ($matrix as $row) { - ksort($row); - $imagickDraw->push(); - foreach ($row as $cell) { - if ($cell !== false) { - $color = intval(255 * $cell); - $colorString = sprintf("rgb(%f, %f, %f)", $color, $color, $color); - $imagickDraw->setFillColor($colorString); - $imagickDraw->rectangle(0, 0, $tileSize, $tileSize); - } - $imagickDraw->translate(($tileSize + $tileSpace), 0); - } - $imagickDraw->pop(); - $imagickDraw->translate(0, ($tileSize + $tileSpace)); - } - - $imagickDraw->pop(); - - $width = ($columns * $tileSize) + (($columns - 1) * $tileSpace); - $height = ($rows * $tileSize) + (($rows - 1) * $tileSpace); - - $imagickDraw->push(); - $imagickDraw->translate($width/2 , $height/2); - $imagickDraw->setFillColor('rgba(0, 0, 0, 0)'); - $imagickDraw->setStrokeColor('white'); - $imagickDraw->circle(0, 0, $radius - 1, 0); - $imagickDraw->setStrokeColor('black'); - $imagickDraw->circle(0, 0, $radius, 0); - $imagickDraw->pop(); - - $canvasWidth = $width + (2 * $imageMargin); - $canvasHeight = $height + (2 * $imageMargin); - - $kernel = new \Imagick(); - $kernel->newPseudoImage( - $canvasWidth, - $canvasHeight, - 'canvas:none' - ); - - $kernel->setImageFormat('png'); - $kernel->drawImage($imagickDraw); - - /* créer une ombre portée sur sa propre couche */ - $canvas = $kernel->clone(); - $canvas->setImageBackgroundColor(new \ImagickPixel('rgb(0, 0, 0)')); - $canvas->shadowImage(100, $shadowSigma, $shadowDropX, $shadowDropY); - - $canvas->setImagePage($canvasWidth, $canvasHeight, -5, -5); - $canvas->cropImage($canvasWidth, $canvasHeight, 0, 0); - - /* composite original text_layer onto shadow_layer */ - $canvas->compositeImage($kernel, \Imagick::COMPOSITE_OVER, 0, 0); - $canvas->setImageFormat('png'); - - return $canvas; -} - -function createFromMatrix() { - $matrix = [ - [0.5, 0, 0.2], - [0, 1, 0], - [0.9, 0, false], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix); - - return $kernel; -} - -function fromMatrix() { - $kernel = createFromMatrix(); - $imagick = renderKernel($kernel); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickkernel/getmatrix.xml b/reference/imagick/imagickkernel/getmatrix.xml deleted file mode 100644 index 1821f2b28a..0000000000 --- a/reference/imagick/imagickkernel/getmatrix.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - ImagickKernel::getMatrix - Renvoie la matrice 2D des valeurs utilisées dans ce noyau - - - - &reftitle.description; - - public arrayImagickKernel::getMatrix - - - - Renvoie la matrice 2D des valeurs utilisées dans ce noyau. Les éléments sont soit - des flottants pour les éléments qui sont utilisés, soit 'false' si l'élément doit être ignoré. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une matrice (tableau 2D) des valeurs qui représentent le noyau. - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::getMatrix</function> - - "; - - foreach ($matrix as $row) { - $output .= ""; - foreach ($row as $cell) { - $output .= ""; - if ($cell === false) { - $output .= "false"; - } - else { - $output .= round($cell, 3); - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; -} - - $output = "The built-in kernel name 'ring' with parameters of '2,3.5':
    "; - $kernel = \ImagickKernel::fromBuiltIn( - \Imagick::KERNEL_RING, - "2,3.5" - ); - $matrix = $kernel->getMatrix(); - $output .= renderKernelTable($matrix); - - echo $output; - -?> -]]> -     -     -     -     - -     - - diff --git a/reference/imagick/imagickkernel/scale.xml b/reference/imagick/imagickkernel/scale.xml deleted file mode 100644 index 4f131d4e28..0000000000 --- a/reference/imagick/imagickkernel/scale.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - ImagickKernel::scale - Dimensionne une liste de noyaux par la quantité donnée - - - - &reftitle.description; - - public voidImagickKernel::scale - floatscale - intnormalizeFlag - - - Dimensionne la liste de noyaux donnée par la quantité donnée, avec ou sans - normalisation de la somme des valeurs du noyau (selon les indicateurs donnés). - - Le comportement exact de cette fonction dépend du type de normalisation utilisé. - Veuillez consulter http://www.imagemagick.org/api/morphology.php#ScaleKernelInfo pour plus de détails. - - - - - - - &reftitle.parameters; - - - - scale - - - - - - - - normalizeFlag - - - - Imagick::NORMALIZE_KERNEL_NONE - Imagick::NORMALIZE_KERNEL_VALUE - Imagick::NORMALIZE_KERNEL_CORRELATE - Imagick::NORMALIZE_KERNEL_PERCENT - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::scale</function> - - "; - - foreach ($matrix as $row) { - $output .= ""; - foreach ($row as $cell) { - $output .= ""; - if ($cell === false) { - $output .= "false"; - } - else { - $output .= round($cell, 3); - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; - } - - - $output = ""; - - $matrix = [ - [-1, 0, -1], - [ 0, 4, 0], - [-1, 0, -1], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix); - $kernelClone = clone $kernel; - - $output .= "Start kernel
    "; - $output .= renderKernelTable($kernel->getMatrix()); - - - $output .= "Scaling with NORMALIZE_KERNEL_VALUE. The
    "; - $kernel->scale(2, \Imagick::NORMALIZE_KERNEL_VALUE); - $output .= renderKernelTable($kernel->getMatrix()); - - - $kernel = clone $kernelClone; - $output .= "Scaling by percent
    "; - $kernel->scale(2, \Imagick::NORMALIZE_KERNEL_PERCENT); - $output .= renderKernelTable($kernel->getMatrix()); - - $matrix2 = [ - [-1, -1, 1], - [ -1, false, 1], - [1, 1, 1], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix2); - $output .= "Scaling by correlate
    "; - $kernel->scale(1, \Imagick::NORMALIZE_KERNEL_CORRELATE); - $output .= renderKernelTable($kernel->getMatrix()); - - return $output; -?> -]]> -     -     -     -     - -     - - diff --git a/reference/imagick/imagickkernel/separate.xml b/reference/imagick/imagickkernel/separate.xml deleted file mode 100644 index bc3b9775d8..0000000000 --- a/reference/imagick/imagickkernel/separate.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - ImagickKernel::separate - Sépare un ensemble de noyaux liés et renvoie un tableau d'ImagickKernels - - - - &reftitle.description; - - public arrayImagickKernel::separate - - - - Sépare un ensemble de noyaux liés et renvoie un tableau d'ImagickKernels. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::separate</function> - - "; - foreach ($matrix as $row) { - $output .= ""; - foreach ($row as $cell) { - $output .= ""; - if ($cell === false) { - $output .= "false"; - } - else { - $output .= round($cell, 3); - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; - } - - - $matrix = [ - [-1, 0, -1], - [ 0, 4, 0], - [-1, 0, -1], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix); - $kernel->scale(4, \Imagick::NORMALIZE_KERNEL_VALUE); - $diamondKernel = \ImagickKernel::fromBuiltIn( - \Imagick::KERNEL_DIAMOND, - "2" - ); - - $kernel->addKernel($diamondKernel); - - $kernelList = $kernel->separate(); - - $output = ''; - $count = 0; - foreach ($kernelList as $kernel) { - $output .= "
    Kernel $count
    "; - $output .= renderKernelTable($kernel->getMatrix()); - $count++; - } - - return $output; - -?> -]]> -     -     -     -     - -     - - diff --git a/reference/imagick/imagickkernelexception.xml b/reference/imagick/imagickkernelexception.xml deleted file mode 100644 index ac8320a852..0000000000 --- a/reference/imagick/imagickkernelexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - La classe ImagickKernelException - ImagickKernelException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ImagickKernelException - - - - - ImagickKernelException - - - - extends - Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -     - -     - - diff --git a/reference/imagick/imagickpixel.xml b/reference/imagick/imagickpixel.xml deleted file mode 100644 index 09d978ad8f..0000000000 --- a/reference/imagick/imagickpixel.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - La classe <classname>ImagickPixel</classname> - ImagickPixel - -
    - &reftitle.classsynopsis; - - ImagickPixel - - ImagickPixel - - - -
    -     - &reference.imagick.entities.imagickpixel; -     - - diff --git a/reference/imagick/imagickpixel/clear.xml b/reference/imagick/imagickpixel/clear.xml deleted file mode 100644 index 4ba460f7fa..0000000000 --- a/reference/imagick/imagickpixel/clear.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickPixel::clear - Supprime toutes les ressources associées avec l'objet - - - - &reftitle.description; - - public boolImagickPixel::clear - - - &warn.undocumented.func; - - Supprime l'objet ImagickPixel, le laissant dans un statut initial. - Supprime également toutes les couleurs associées avec l'objet. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixel/construct.xml b/reference/imagick/imagickpixel/construct.xml deleted file mode 100644 index a81902d3b5..0000000000 --- a/reference/imagick/imagickpixel/construct.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - - ImagickPixel::__construct - Le constructeur ImagickPixel - - - - &reftitle.description; - - public ImagickPixel::__construct - stringcolor - - &warn.undocumented.func; - - Construit un objet ImagickPixel. - Si une couleur est spécifiée, l'objet - est construit, puis initialisé avec cette couleur avant d'être retourné. - - - - - &reftitle.parameters; - - - - color - - - Une chaîne représentant la couleur optionnelle à utiliser comme valeur - initiale de l'objet. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet ImagickPixel en cas de succès ou lance - une exception ImagickPixelException si une erreur survient. - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickPixel::construct</function> - -setstrokewidth(1.0); - $draw->setStrokeColor($black); - $draw->setFillColor($color); - $offsetX = ($count % $columns) * 50 + 5; - $offsetY = intval($count / $columns) * 50 + 5; - $draw->rectangle(0 + $offsetX, 0 + $offsetY, 40 + $offsetX, 40 + $offsetY); - $count++; - } - - $image = new \Imagick(); - $image->newImage(350, 350, "blue"); - $image->setImageFormat("png"); - $image->drawImage($draw); - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/destroy.xml b/reference/imagick/imagickpixel/destroy.xml deleted file mode 100644 index b7c286d5d8..0000000000 --- a/reference/imagick/imagickpixel/destroy.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickPixel::destroy - Libère les ressources associées avec l'objet - - - - &reftitle.description; - - public boolImagickPixel::destroy - - - &warn.undocumented.func; - - Libère toutes les ressources utilisées par l'objet ImagickPixel et - supprime toutes les couleurs associées. L'objet ne doit pas être utilisé - après l'appel de cette fonction. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixel/getcolor.xml b/reference/imagick/imagickpixel/getcolor.xml deleted file mode 100644 index f29995cd88..0000000000 --- a/reference/imagick/imagickpixel/getcolor.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - ImagickPixel::getColor - Retourne la couleur - - - - &reftitle.description; - - public arrayImagickPixel::getColor - intnormalized0 - - - Retourne la couleur décrite par l'objet ImagickPixel, - sous la forme d'un &array;. Si la couleur contient un canal d'opacité, il - sera fourni comme quatrième valeur de la liste. - - - - - &reftitle.parameters; - - - - normalized - - - Normalise les valeurs de couleurs. Les valeurs possibles sont 0, - 1 ou 2. - - - - Liste des valeurs possibles pour <parameter>normalized</parameter> - - - - - normalized - &Description; - - - - - - 0 - - - Les valeurs RGB sont retournées en tant que ints dans - l'intervalle (inclusive) 0 à 255. - La valeur alpha est retournée en tant que int et est soit - 0 ou 1. - - - - - 1 - - - Les valeurs RGBA sont retournées en tant que floats dans - l'intervalle (inclusive) 0 à 1. - - - - - 2 - - - Les valeurs RGBA sont retournées en tant que ints dans - l'intervalle (inclusive) 0 à 255. - - - - -
    -     -     -     -     -     - -     - - &reftitle.returnvalues; - - Un tableau des valeurs des canaux. Lance - ImagickPixelException en cas d'erreur. - - - - - &reftitle.examples; - - - Utilisation simple de la méthode <function>Imagick::getColor</function> - -setColorValue(Imagick::COLOR_ALPHA, 64 / 256.0); - -$colorInfo = $color->getColor(); - -echo "Valeurs standards :".PHP_EOL; -print_r($colorInfo); - -$colorInfo = $color->getColor(1); - -echo "Valeurs normalisées :".PHP_EOL; -print_r($colorInfo); - -?> -]]> - - &example.outputs; - - 165 - [g] => 42 - [b] => 42 - [a] => 0 -) -Valeurs normalisées : -Array -( - [r] => 0.64705882352941 - [g] => 0.16470588235294 - [b] => 0.16470588235294 - [a] => 0.25000381475547 -) - ]]> - - - - - -     - diff --git a/reference/imagick/imagickpixel/getcolorasstring.xml b/reference/imagick/imagickpixel/getcolorasstring.xml deleted file mode 100644 index 80b8e247c2..0000000000 --- a/reference/imagick/imagickpixel/getcolorasstring.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - ImagickPixel::getColorAsString - Retourne une couleur - - - - &reftitle.description; - - public stringImagickPixel::getColorAsString - - - - Retourne la couleur de l'objet ImagickPixel, sous la forme - d'une &string;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la couleur de l'objet ImagickPixel, sous la forme d'une &string;. - - - - - &reftitle.examples; - - - Utilisation basique de la méthode <function>Imagick::getColorAsString</function> - -setColorValue(Imagick::COLOR_ALPHA, 64 / 256.0); - -$colorInfo = $color->getColorAsString(); - -print_r($colorInfo); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.notes; - - Alpha non retourné - - Cette méthode ne retourne pas la valeur de l'alpha de la couleur dans la chaîne. - - - - - - - - diff --git a/reference/imagick/imagickpixel/getcolorcount.xml b/reference/imagick/imagickpixel/getcolorcount.xml deleted file mode 100644 index 5668f88ea2..0000000000 --- a/reference/imagick/imagickpixel/getcolorcount.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - ImagickPixel::getColorCount - Retourne le nombre de couleurs associé avec une couleur - - - - &reftitle.description; - - public intImagickPixel::getColorCount - - - - Retourne le nombre de couleurs associé avec la couleur. - - Le nombre de pixels de l'image ayant la même couleur que ce ImagickPixel. - - - ImagickPixel::getColorCount semble fonctionner uniquement pour les objets ImagickPixel créés via Imagick::getImageHistogram() - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le nombre de couleurs, sous la forme d'un &integer; en - cas de succès ou lance une exception ImagickPixelException - si une - erreur survient. - - - - &reftitle.examples; - - - ImagickPixel <function>getColorCount</function> - -newPseudoImage(640, 480, "magick:logo"); - $histogramElements = $imagick->getImageHistogram(); - $lastColor = array_pop($histogramElements); - echo "Last pixel color count is: ".$lastColor->getColorCount(); -?> -]]> - - - La sortie sera similaire à : - - - - - - - - - - - diff --git a/reference/imagick/imagickpixel/getcolorquantum.xml b/reference/imagick/imagickpixel/getcolorquantum.xml deleted file mode 100644 index b62fd7b074..0000000000 --- a/reference/imagick/imagickpixel/getcolorquantum.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - ImagickPixel::getColorQuantum - Renvoie la couleur du pixel dans un tableau en tant que valeurs quantiques - - - - &reftitle.description; - - public arrayImagickPixel::getColorQuantum - - - - Renvoie la couleur du pixel dans un tableau en tant que valeurs quantiques. Si ImageMagick a été compilé - en tant que HDRI, ces valeurs seront des flottants, sinon elles seront des entiers. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un tableau avec les clés "r", "g", - "b", "a". - - - - - - - diff --git a/reference/imagick/imagickpixel/getcolorvalue.xml b/reference/imagick/imagickpixel/getcolorvalue.xml deleted file mode 100644 index f5887a64e8..0000000000 --- a/reference/imagick/imagickpixel/getcolorvalue.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - ImagickPixel::getColorValue - Récupère la valeur normalisée du canal de la couleur fournie - - - - &reftitle.description; - - public floatImagickPixel::getColorValue - intcolor - - - Récupère la valeur du canal de la couleur spécifiée, sous la forme d'un - nombre à virgule flottante compris entre 0 et 1. - - - - - &reftitle.parameters; - - - - color - - - La couleur pour laquelle la valeur sera récupérée, spécifiée - sous forme de constante de couleurs Imagick. Peut être des couleurs - RGB, des couleurs CMYK, alpha et opacité, c.-à-d. Imagick::COLOR_BLUE - ou Imagick::COLOR_MAGENTA. - - - - - - - - - &reftitle.returnvalues; - - La valeur du canal, sous la forme d'un nombre à virgule flottante normalisé, - ou lance une exception ImagickPixelException - si une erreur survient. - - - - - &reftitle.examples; - - - Utilisation basique de la méthode <function>Imagick::getColorValue</function> - -getColorValue(Imagick::COLOR_ALPHA).PHP_EOL; -echo "".PHP_EOL; -echo "La valeur rouge est ".$color->getColorValue(Imagick::COLOR_RED).PHP_EOL; -echo "La valeur verte est ".$color->getColorValue(Imagick::COLOR_GREEN).PHP_EOL; -echo "La valeur bleue est ".$color->getColorValue(Imagick::COLOR_BLUE).PHP_EOL; -echo "".PHP_EOL; -echo "La valeur Cyan est ".$color->getColorValue(Imagick::COLOR_CYAN).PHP_EOL; -echo "La valeur Magenta est ".$color->getColorValue(Imagick::COLOR_MAGENTA).PHP_EOL; -echo "La valeur jaune est ".$color->getColorValue(Imagick::COLOR_YELLOW).PHP_EOL; -echo "La valeur noire est ".$color->getColorValue(Imagick::COLOR_BLACK).PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/imagick/imagickpixel/getcolorvaluequantum.xml b/reference/imagick/imagickpixel/getcolorvaluequantum.xml deleted file mode 100644 index f5ab2ed1a6..0000000000 --- a/reference/imagick/imagickpixel/getcolorvaluequantum.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - ImagickPixel::getColorValueQuantum - Renvoie la valeur quantique d'une couleur dans ImagickPixel - - - - &reftitle.description; - - public intfloatImagickPixel::getColorValueQuantum - intcolor - - - Renvoie la valeur quantique d'une couleur dans ImagickPixel. La valeur de retour est un flottant si ImageMagick a été compilé avec HDRI, sinon un entier. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La valeur quantique de l'élément de couleur. Flottant si ImageMagick a été compilé avec HDRI, sinon un entier. - - - - - - - - &reftitle.examples; - - - <function>ImagickPixel::getColorValueQuantum</function> - - getColorValueQuantum(\Imagick::COLOR_RED); - $colorGreen = $color->getColorValueQuantum(\Imagick::COLOR_GREEN); - $colorBlue = $color->getColorValueQuantum(\Imagick::COLOR_BLUE); - $colorAlpha = $color->getColorValueQuantum(\Imagick::COLOR_ALPHA); - - printf( - "Red: %s Green: %s Blue %s Alpha: %s", - $colorRed, - $colorGreen, - $colorBlue, - $colorAlpha - ); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/gethsl.xml b/reference/imagick/imagickpixel/gethsl.xml deleted file mode 100644 index abf8b2a4f9..0000000000 --- a/reference/imagick/imagickpixel/gethsl.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - ImagickPixel::getHSL - Retourne la couleur HSL normalisée de l'objet ImagickPixel - - - - &reftitle.description; - - public arrayImagickPixel::getHSL - - - - Retourne la couleur HSL normalisée, décrite par l'objet - ImagickPixel, dont chacune des trois - valeurs sera un nombre décimal, compris entre 0.0 et 1.0. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la valeur HSL dans un tableau contenant les clés - "hue", "saturation" et - "luminosity". Lance une exception - ImagickPixelException - si une erreur survient. - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::getHSL</function> - -getHSL(); - -print_r($colorInfo); - -?> -]]> - - &example.outputs; - - 0 - [saturation] => 0.80001220740379 - [luminosity] => 0.50000762951095 -) -]]> - - - - - - - &reftitle.notes; - - - Disponible avec la version 6.2.9 et supérieure de la bibliothèque - ImageMagick. - - - - - - - diff --git a/reference/imagick/imagickpixel/getindex.xml b/reference/imagick/imagickpixel/getindex.xml deleted file mode 100644 index f34f195fd6..0000000000 --- a/reference/imagick/imagickpixel/getindex.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - ImagickPixel::getIndex - Renvoie l'index de la carte de couleurs du pixel - - - - &reftitle.description; - - public intImagickPixel::getIndex - - - - Renvoie l'index de la carte de couleurs du pixel. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagickpixel/ispixelsimilar.xml b/reference/imagick/imagickpixel/ispixelsimilar.xml deleted file mode 100644 index 7a8ef7412e..0000000000 --- a/reference/imagick/imagickpixel/ispixelsimilar.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - ImagickPixel::isPixelSimilar - Vérifie la distance entre cette couleur et une autre - - - - &reftitle.description; - - public boolImagickPixel::isPixelSimilar - ImagickPixelcolor - floatfuzz - - - Vérifie la distance entre la couleur décrite par cet objet ImagickPixel - et celle de l'objet fourni. Si la distance entre les deux points est - inférieure à la valeur du paramètre fuzz fourni, la couleur est similaire. - Cette méthode remplace la méthode - ImagickPixel::isSimilar() - et normalise correctement la valeur fuzz d'ImageMagick QuantumRange. - - - - - &reftitle.parameters; - - - - color - - - L'objet ImagickPixel à utiliser pour la comparaison. - - - - - fuzz - - - La distance maximale pour laquelle on considère les couleurs comme - similaires. La valeur maximale théorique pour cette valeur est la racine - carrée de trois (1.732). - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixel/ispixelsimilarquantum.xml b/reference/imagick/imagickpixel/ispixelsimilarquantum.xml deleted file mode 100644 index d6ab2acc15..0000000000 --- a/reference/imagick/imagickpixel/ispixelsimilarquantum.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - ImagickPixel::isPixelSimilarQuantum - Renvoie si deux couleurs diffèrent de moins de la distance spécifiée - - - - &reftitle.description; - - public boolImagickPixel::isPixelSimilarQuantum - stringcolor - stringfuzz - - - Renvoie si deux couleurs diffèrent de moins de la distance spécifiée. - La valeur de flou doit être comprise entre 0 et QuantumRange. - La valeur maximale représente la distance la plus longue possible dans l'espace colorimétrique. - par exemple de RGB(0, 0, 0) à RGB(255, 255, 255) pour l'espace colorimétrique RGB - - - - - - &reftitle.parameters; - - - color - - - - - - - - fuzz - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagickpixel/issimilar.xml b/reference/imagick/imagickpixel/issimilar.xml deleted file mode 100644 index 35557fdab1..0000000000 --- a/reference/imagick/imagickpixel/issimilar.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - - ImagickPixel::isSimilar - Vérifie la distance entre 2 couleurs - - - - &reftitle.description; - - public boolImagickPixel::isSimilar - ImagickPixelcolor - floatfuzz - - &warn.undocumented.func; - - Vérifie la distance entre la couleur décrite par l'objet ImagickPixel - et celle de l'objet fourni, en plaçant leurs valeurs RGB sur le cube - de couleur. Si la distance entre les 2 points est inférieure à la valeur - du paramètre fuzz, la couleur est similaire. - Obsolète en faveur de la méthode - ImagickPixel::isPixelSimilar(). - - - - - &reftitle.parameters; - - - - color - - - L'objet ImagickPixel utilisé pour la comparaison. - - - - - fuzz - - - La distance maximale utilisée pour considérer que les couleurs - sont similaires. La valeur maximale théorique est la racine carrée - de 3 (1.732). - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickPixel::isSimilar</function> - - - - - Color 1 - - - Color 2 - - - Test distance * 255 - - - Is within distance - - - "; - - $output .= ""; - - foreach ($tests as $testInfo) { - $color1 = $testInfo[0]; - $color2 = $testInfo[1]; - $distance = $testInfo[2]; - $expectation = $testInfo[3]; - $testDistance = ($distance / 255.0); - - $color1Pixel = new \ImagickPixel($color1); - $color2Pixel = new \ImagickPixel($color2); - - $isSimilar = $color1Pixel->isPixelSimilar($color2Pixel, $testDistance); - - - if ($isSimilar !== $expectation) { - echo "Test distance failed. Color [$color1] compared to color [$color2] is not within distance $testDistance FAILED.".NL; - } - - $layout = " - %s - %s - %s - %s - "; - - $output .= sprintf( - $layout, - $color1, - $color2, - $distance, - $isSimilar ? 'yes' : 'no' - ); - } - - $output .= ""; - - return $output; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/setcolor.xml b/reference/imagick/imagickpixel/setcolor.xml deleted file mode 100644 index b3d42bc0b6..0000000000 --- a/reference/imagick/imagickpixel/setcolor.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - ImagickPixel::setColor - Définit la couleur - - - - &reftitle.description; - - public boolImagickPixel::setColor - stringcolor - - &warn.undocumented.func; - - Définit la couleur, décrite par l'objet ImagickPixel, avec une &string; - (p. ex. "blue", "#0000ff", - "rgb(0,0,255)", "cmyk(100,100,100,10)", etc.). - - - - - &reftitle.parameters; - - - - color - - - La définition de la couleur à utiliser afin d'initialiser - l'objet ImagickPixel. - - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si la couleur spécifiée a été définie ou &false; sinon. - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickPixel::setColor</function> - -setColor('rgba(100%, 75%, 0%, 1.0)'); - - $draw->setstrokewidth(3.0); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->rectangle(200, 200, 300, 300); - - $image = new \Imagick(); - $image->newImage(500, 500, "SteelBlue2"); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/setcolorcount.xml b/reference/imagick/imagickpixel/setcolorcount.xml deleted file mode 100644 index ce7c9f4e62..0000000000 --- a/reference/imagick/imagickpixel/setcolorcount.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ImagickPixel::setColorCount - Définit la quantité de couleurs associée à ce pixel - - - - &reftitle.description; - - public boolImagickPixel::setcolorcount - intcolorCount - - - Définit la quantité de couleurs associée à ce pixel. - - - - - - &reftitle.parameters; - - - colorCount - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickpixel/setcolorvalue.xml b/reference/imagick/imagickpixel/setcolorvalue.xml deleted file mode 100644 index fb9e27ea2d..0000000000 --- a/reference/imagick/imagickpixel/setcolorvalue.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - ImagickPixel::setColorValue - Définit la valeur normalisée d'un des canaux - - - - &reftitle.description; - - public boolImagickPixel::setColorValue - intcolor - floatvalue - - - Définit la valeur du canal spécifié de l'objet à la valeur spécifiée, - qui doit être comprise entre 0 et 1. Cette fonction peut être utilisée - pour fournir un canal d'opacité à l'objet ImagickPixel. - - - - - &reftitle.parameters; - - - - color - - - Une constante de couleur Imagick, c.-à-d. \Imagick::COLOR_GREEN ou - \Imagick::COLOR_ALPHA. - - - - - value - - - La valeur à définir pour ce canal, comprise entre 0 et 1. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Imagick::setColorValue</function> - -setColorValue(Imagick::COLOR_ALPHA, 0.5); - -print_r($color->getcolor(true)); -?> -]]> - - &example.outputs; - - 0.69803921568627 - [g] => 0.13333333333333 - [b] => 0.13333333333333 - [a] => 0.50000762951095 -) -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/setcolorvaluequantum.xml b/reference/imagick/imagickpixel/setcolorvaluequantum.xml deleted file mode 100644 index 327a177054..0000000000 --- a/reference/imagick/imagickpixel/setcolorvaluequantum.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - ImagickPixel::setColorValueQuantum - Définit la valeur quantique d'un élément de couleur de ImagickPixel - - - - &reftitle.description; - - public boolImagickPixel::setColorValueQuantum - intcolor - intfloatvalue - - - Définit la valeur quantique d'un élément de couleur de ImagickPixel. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - color - - - Quelle couleur définir, par exemple \Imagick::COLOR_GREEN. - - - - - - - value - - - La valeur quantique à définir pour l'élément de couleur. Cela devrait être un flottant si ImageMagick a été compilé avec HDRI, sinon un entier dans la plage 0 à Imagick::getQuantum(). - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>ImagickPixel::setColorValueQuantum</function> - - getQuantumRange(); - - $draw = new \ImagickDraw(); - $color = new \ImagickPixel('blue'); - $color->setcolorValueQuantum(\Imagick::COLOR_RED, 128 * $quantumRange['quantumRangeLong'] / 256); - - $draw->setstrokewidth(1.0); - $draw->setStrokeColor($color); - $draw->setFillColor($color); - $draw->rectangle(200, 200, 300, 300); - - $image->newImage(500, 500, "SteelBlue2"); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/sethsl.xml b/reference/imagick/imagickpixel/sethsl.xml deleted file mode 100644 index 85c5f3f7aa..0000000000 --- a/reference/imagick/imagickpixel/sethsl.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - - - ImagickPixel::setHSL - Définit la couleur HSL normalisée - - - - &reftitle.description; - - public boolImagickPixel::setHSL - floathue - floatsaturation - floatluminosity - - - Définit la couleur décrite par l'objet ImagickPixel en utilisant - les valeurs normalisées pour la teinte, la saturation et la luminosité. - - - - - &reftitle.parameters; - - - - hue - - - La valeur normalisée pour la teinte, décrite par un arc fractionnel - (entre 0 et 1) du cercle des teintes, dont la valeur zéro correspond à - rouge. - - - - - saturation - - - La valeur normalisée pour la saturation, dont 1 correspond à une - saturation complète. - - - - - luminosity - - - La valeur normalisée pour la luminosité, comprise entre 0 (noir) - et 1 (blanc), avec la valeur HS complète à 0.5 de luminosité. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickPixel::setHSL</function> pour modifier une couleur - -getHSL(); - -// Effectue une rotation de la teinte de 180 degrés -$newHue = $colorInfo['hue'] + 0.5; -if ($newHue > 1) { - $newHue = $newHue - 1; -} - -// Définit l'objet ImagickPixel à la nouvelle couleur -$colorInfo = $color->setHSL($newHue, $colorInfo['saturation'], $colorInfo['luminosity']); - -// Vérifie que la nouvelle couleur est bien bleu/verte -$colorInfo = $color->getcolor(); -print_r($colorInfo); - -?> - ]]> - - &example.outputs; - - 26 - [g] => 230 - [b] => 230 - [a] => 255 -) -]]> - - - - - - - &reftitle.notes; - - - Disponible avec la version 6.2.9 et supérieure de la bibliothèque - ImageMagick. - - - - - - - diff --git a/reference/imagick/imagickpixel/setindex.xml b/reference/imagick/imagickpixel/setindex.xml deleted file mode 100644 index eb3b9561e8..0000000000 --- a/reference/imagick/imagickpixel/setindex.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ImagickPixel::setIndex - Définit l'index de la carte de couleurs du pixel - - - - &reftitle.description; - - public boolImagickPixel::setIndex - intindex - - - Définit l'index de la carte de couleurs du pixel. - - - - - - &reftitle.parameters; - - - index - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickpixelexception.xml b/reference/imagick/imagickpixelexception.xml deleted file mode 100644 index baf28e2c1b..0000000000 --- a/reference/imagick/imagickpixelexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - La classe ImagickPixelException - ImagickPixelException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - - ImagickPixelException - - - - - ImagickPixelException - - - - extends - Exception - - - - Throwable - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -     - -     - diff --git a/reference/imagick/imagickpixeliterator.xml b/reference/imagick/imagickpixeliterator.xml deleted file mode 100644 index 8abdbb31c3..0000000000 --- a/reference/imagick/imagickpixeliterator.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - La classe <classname>ImagickPixelIterator</classname> - ImagickPixelIterator - -
    - &reftitle.classsynopsis; - - ImagickPixelIterator - - ImagickPixelIterator - - - -
    -     - &reference.imagick.entities.imagickpixeliterator; -     - - - diff --git a/reference/imagick/imagickpixeliterator/clear.xml b/reference/imagick/imagickpixeliterator/clear.xml deleted file mode 100644 index a1634aee7d..0000000000 --- a/reference/imagick/imagickpixeliterator/clear.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - ImagickPixelIterator::clear - Efface toutes les ressources associées à PixelIterator - - - - &reftitle.description; - - public boolImagickPixelIterator::clear - - - &warn.undocumented.func; - - Efface toutes les ressources associées à PixelIterator. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickPixelIterator::clear</function> - -getPixelRegionIterator(100, 100, 250, 200); - - /* On parcourt les lignes de pixels */ - foreach ($imageIterator as $pixels) { - /** @var $pixel \ImagickPixel */ - /* On parcourt les pixels de la ligne (colonne) */ - foreach ($pixels as $column => $pixel) { - if ($column % 2) { - /* Paint every second pixel black*/ - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - } - /* On synchronise l'itérateur, ceci est important à chaque itération */ - $imageIterator->syncIterator(); - } - - $imageIterator->clear(); - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/construct.xml b/reference/imagick/imagickpixeliterator/construct.xml deleted file mode 100644 index e1a2dd85d1..0000000000 --- a/reference/imagick/imagickpixeliterator/construct.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - ImagickPixelIterator::__construct - Le constructeur ImagickPixelIterator - - - - &reftitle.description; - - public ImagickPixelIterator::__construct - Imagickwand - - &warn.undocumented.func; - - Le constructeur de la classe ImagickPixelIterator. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickPixelIterator::construct</function> - - $pixel) { - /** @var $pixel \ImagickPixel */ - if ($column % 2) { - /* On teint tous les deux pixels en noir */ - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - } - /* On synchronise l'itérateur, ceci est important à chaque itération */ - $imageIterator->syncIterator(); - } - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/destroy.xml b/reference/imagick/imagickpixeliterator/destroy.xml deleted file mode 100644 index 64160985ac..0000000000 --- a/reference/imagick/imagickpixeliterator/destroy.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickPixelIterator::destroy - Libère les ressources associées à PixelIterator - - - - &reftitle.description; - - public boolImagickPixelIterator::destroy - - - &warn.undocumented.func; - - Libère les ressources associées à PixelIterator. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml b/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml deleted file mode 100644 index 5e6e220eda..0000000000 --- a/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickPixelIterator::getCurrentIteratorRow - Retourne la ligne courante des objets ImagickPixel - - - - &reftitle.description; - - public arrayImagickPixelIterator::getCurrentIteratorRow - - - &warn.undocumented.func; - - Retourne la ligne courante, en tant que tableau, des objets ImagickPixel - depuis l'itérateur de pixel. - - - - - &reftitle.returnvalues; - - Retourne une ligne, en tant que tableau, des objets ImagickPixel, - qui peut être elle-même itérée. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/getiteratorrow.xml b/reference/imagick/imagickpixeliterator/getiteratorrow.xml deleted file mode 100644 index 872741e077..0000000000 --- a/reference/imagick/imagickpixeliterator/getiteratorrow.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickPixelIterator::getIteratorRow - Retourne la ligne courante de l'itérateur de pixel - - - - &reftitle.description; - - public intImagickPixelIterator::getIteratorRow - - - &warn.undocumented.func; - - Retourne la ligne courante de l'itérateur de pixel. - - - - - &reftitle.returnvalues; - - Retourne la position, sous la forme d'un &integer; de la ligne - ou lance une exception ImagickPixelIteratorException si une - erreur survient. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml b/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml deleted file mode 100644 index aa0f573df9..0000000000 --- a/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - ImagickPixelIterator::getNextIteratorRow - Retourne la prochaine ligne de l'itérateur de pixel - - - - &reftitle.description; - - public arrayImagickPixelIterator::getNextIteratorRow - - - &warn.undocumented.func; - - Retourne la prochaine ligne, sous la forme d'un &array;, depuis l'itérateur - de pixel. - - - - - &reftitle.returnvalues; - - Retourne la prochaine ligne, sous la forme d'un &array; d'objets ImagickPixel, - ou lance une exception ImagickPixelIteratorException si une erreur survient. - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickPixelIterator::getNextIteratorRow</function> - -getPixelIterator(); - - $count = 0; - while ($pixels = $imageIterator->getNextIteratorRow()) { - if (($count % 3) == 0) { - /* On parcourt les pixels de la ligne (colonne) */ - foreach ($pixels as $column => $pixel) { - /** @var $pixel \ImagickPixel */ - if ($column % 2) { - /* On teint tous les deux pixels en noir */ - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - } - /* On synchronise l'itérateur, ceci est important à chaque itération */ - $imageIterator->syncIterator(); - } - - $count += 1; - } - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml b/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml deleted file mode 100644 index e0627b4b47..0000000000 --- a/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickPixelIterator::getPreviousIteratorRow - Retourne la ligne précédente - - - - &reftitle.description; - - public arrayImagickPixelIterator::getPreviousIteratorRow - - - &warn.undocumented.func; - - Retourne la ligne précédente, sous la forme d'un &array;, depuis l'itérateur - de pixel. - - - - - &reftitle.returnvalues; - - Retourne la ligne précédente, sous la forme d'un &array; d'objets ImagickPixelWand, - ou lance une exception ImagickPixelIteratorException si une erreur survient. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/newpixeliterator.xml b/reference/imagick/imagickpixeliterator/newpixeliterator.xml deleted file mode 100644 index 34a9976d8d..0000000000 --- a/reference/imagick/imagickpixeliterator/newpixeliterator.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickPixelIterator::newPixelIterator - Retourne un nouvel itérateur de pixels - - - - &reftitle.description; - - public boolImagickPixelIterator::newPixelIterator - Imagickwand - - &warn.undocumented.func; - - Retourne un nouvel itérateur de pixels. - - - - - &reftitle.returnvalues; - - &imagick.return.success;. - Lance une exception ImagickPixelIteratorException si une erreur survient. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml b/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml deleted file mode 100644 index d259924d35..0000000000 --- a/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - ImagickPixelIterator::newPixelRegionIterator - Retourne un nouvel itérateur de pixels - - - - &reftitle.description; - - public boolImagickPixelIterator::newPixelRegionIterator - Imagickwand - intx - inty - intcolumns - introws - - &warn.undocumented.func; - - Retourne un nouvel itérateur de pixels. - - - - - &reftitle.parameters; - - - - wand - - - - - - - x - - - - - - - y - - - - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - Retourne un nouveau ImagickPixelIterator en cas de succès ou - lance une exception ImagickPixelIteratorException - si une erreur survient. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/resetiterator.xml b/reference/imagick/imagickpixeliterator/resetiterator.xml deleted file mode 100644 index 961a610581..0000000000 --- a/reference/imagick/imagickpixeliterator/resetiterator.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - ImagickPixelIterator::resetIterator - Réinitialise l'itérateur de pixel - - - - &reftitle.description; - - public boolImagickPixelIterator::resetIterator - - - &warn.undocumented.func; - - Réinitialise l'itérateur de pixel. Utiliser cette méthode avec - ImagickPixelIterator::getNextIteratorRow() pour itérer sur tous les - pixels d'un conteneur de pixels. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickPixelIterator::resetIterator</function> - -getPixelIterator(); - - /* On parcourt les lignes de pixels */ - foreach ($imageIterator as $pixels) { - /* On parcourt les pixels de la ligne (colonne) */ - foreach ($pixels as $column => $pixel) { - /** @var $pixel \ImagickPixel */ - if ($column % 2) { - - /* Tous les deux pixels, on ajoute 25% de rouge */ - $pixel->setColorValue(\Imagick::COLOR_RED, 64); - } - } - /* On synchronise l'itérateur, ceci est important à chaque itération */ - $imageIterator->syncIterator(); - } - - $imageIterator->resetiterator(); - - /* On parcourt les lignes de pixels */ - foreach ($imageIterator as $pixels) { - /* On parcourt les pixels de la ligne (colonne) */ - foreach ($pixels as $column => $pixel) { - /** @var $pixel \ImagickPixel */ - if ($column % 3) { - $pixel->setColorValue(\Imagick::COLOR_BLUE, 64); /* Tous les deux pixels, on les rend un peu plus bleu */ - //$pixel->setColor("rgba(0, 0, 128, 0)"); /* On teint tous les deux pixels en noir */ - } - } - $imageIterator->syncIterator(); /* On synchronise l'itérateur, ceci est important à chaque itération */ - } - - $imageIterator->clear(); - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml b/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml deleted file mode 100644 index adfa01d80a..0000000000 --- a/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickPixelIterator::setIteratorFirstRow - Définit l'itérateur de pixel sur la première ligne de pixels - - - - &reftitle.description; - - public boolImagickPixelIterator::setIteratorFirstRow - - - &warn.undocumented.func; - - Définit l'itérateur de pixel sur la première ligne de pixels. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml b/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml deleted file mode 100644 index f7c837ccfc..0000000000 --- a/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickPixelIterator::setIteratorLastRow - Définit l'itérateur de pixel sur la dernière ligne de pixels - - - - &reftitle.description; - - public boolImagickPixelIterator::setIteratorLastRow - - - &warn.undocumented.func; - - Définit l'itérateur de pixel sur la dernière ligne de pixels. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixeliterator/setiteratorrow.xml b/reference/imagick/imagickpixeliterator/setiteratorrow.xml deleted file mode 100644 index 8275b9017f..0000000000 --- a/reference/imagick/imagickpixeliterator/setiteratorrow.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - ImagickPixelIterator::setIteratorRow - Définit la ligne de l'itérateur de pixel - - - - &reftitle.description; - - public boolImagickPixelIterator::setIteratorRow - introw - - &warn.undocumented.func; - - Définit la ligne de l'itérateur de pixel. - - - - - &reftitle.parameters; - - - - row - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>ImagickPixelIterator::setIteratorRow</function> - -getPixelRegionIterator(200, 100, 200, 200); - - for ($x = 0; $x < 20; $x++) { - $imageIterator->setIteratorRow($x * 5); - $pixels = $imageIterator->getCurrentIteratorRow(); - /* On parcourt les pixels de la ligne (colonne) */ - foreach ($pixels as $pixel) { - /** @var $pixel \ImagickPixel */ - /* On teint tous les pixels en noir */ - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - - /* On synchronise l'itérateur ; ceci est important à chaque itération */ - $imageIterator->syncIterator(); - } - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/synciterator.xml b/reference/imagick/imagickpixeliterator/synciterator.xml deleted file mode 100644 index f24a0a3b2d..0000000000 --- a/reference/imagick/imagickpixeliterator/synciterator.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickPixelIterator::syncIterator - Synchronise l'itérateur de pixel - - - - &reftitle.description; - - public boolImagickPixelIterator::syncIterator - - - &warn.undocumented.func; - - Synchronise l'itérateur de pixel. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixeliteratorexception.xml b/reference/imagick/imagickpixeliteratorexception.xml deleted file mode 100644 index 0011f09e7d..0000000000 --- a/reference/imagick/imagickpixeliteratorexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - La classe ImagickPixelIteratorException - ImagickPixelIteratorException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - - ImagickPixelIteratorException - - - - - ImagickPixelIteratorException - - - - extends - Exception - - - - Throwable - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -     - -     - diff --git a/reference/imagick/ini.xml b/reference/imagick/ini.xml deleted file mode 100644 index 752d4dad19..0000000000 --- a/reference/imagick/ini.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Options de configuration Imagick - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - imagick.locale_fix - &false; - INI_ALL - Disponible depuis 2.1.0 - - - imagick.progress_monitor - &false; - INI_SYSTEM - Disponible depuis Imagick 2.2.2 - - - imagick.skip_version_check - &false; - INI_SYSTEM - Disponible depuis Imagick 3.3.0 - - - -
    - &ini.php.constants; -     - - &ini.descriptions.title; - - - - - - imagick.locale_fix - bool - - - - Corrige un bogue sur le dessin lorsque les locales utilisent - le caractère ',' comme séparateurs. - - - - - - - imagick.progress_monitor - bool - - - - Utilisé pour activer la surveillance de la progression de l'image. - - - - - - - - imagick.skip_version_check - bool - - - - Lorsque Imagick est chargé, le numéro de version d'ImageMagick - utilisé pendant la compilation est vérifié, et est comparé avec - le numéro de version actuellement utilisé ; une alerte est émise si - les deux versions ne correspondent pas. Cette alerte peut être supprimée - en activant cette option de configuration. - - - Le fait d'utiliser une version d'Imagick différente de la version - d'ImageMagick n'est pas recommandé. Malgré le fait que cela peut fonctionner, - il peut en résulter des erreurs aléatoires ou des comportements non définis. - - - - - - -
    - - diff --git a/reference/imagick/setup.xml b/reference/imagick/setup.xml deleted file mode 100644 index b917e07255..0000000000 --- a/reference/imagick/setup.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; -
    - Configuration nécessaire pour l'installation sous les plates-formes différentes de Windows - - ImageMagick >= 6.2.4 est nécessaire. Le nombre de formats supportés - par Imagick est totalement dépendant de ceux supportés par l'installation - ImageMagick. Par exemple, ImageMagick a besoin de ghostscript pour effectuer - les opérations relatives aux PDF. - -
    -
    - - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;imagick. - - - - Le nom officiel de cette extension est imagick. - - - - Les utilisateurs de Windows peuvent télécharger une DLL préconstruite depuis - le site de PECL : PECL. - Ces paquets contiennent déjà la DLL d'extension (php_imagick.dll) - qui doit être placée dans le extension_dir. - Ils contiennent également les DLL d'ImageMagick, qui doivent être placées quelque part dans le PATH. - À partir d'Imagick 3.6.0, ils contiennent également des fichiers de configuration XML dans config; - pour les utiliser à la place des valeurs par défaut intégrées, - ils doivent être placés dans %USERPROFILE%/.config/ImageMagick, - ou alternativement dans le chemin donné par la variable d'environnement MAGICK_CONFIGURE_PATH. - Se reporter à la Documentation sur les fichiers de configuration d'ImageMagick pour plus de détails. - -
    - - - &reference.imagick.ini; - -     - - - diff --git a/reference/inotify/book.xml b/reference/inotify/book.xml deleted file mode 100644 index 86ef09554f..0000000000 --- a/reference/inotify/book.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - Inotify - - - - &reftitle.intro; - - L'extension inotify fait l'interface avec les fonctions inotify_init, - inotify_add_watch et inotify_rm_watch. - - - Comme la fonction C inotify_init retourne un pointeur de fichier, la fonction - PHP inotify_init retourne un flux, à utiliser avec les fonctions - standard de flux, telle que stream_select, stream_set_blocking - et fclose. inotify_read remplace l'approche en langage C - de lecture des événements. - - - - - &reference.inotify.setup; - &reference.inotify.constants; - &reference.inotify.reference; - - - diff --git a/reference/inotify/constants.xml b/reference/inotify/constants.xml deleted file mode 100644 index 63301de426..0000000000 --- a/reference/inotify/constants.xml +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Les constantes Inotify sont utilisables avec les fonctions <function>inotify_add_watch</function> - et/ou retournées par la fonction <function>inotify_read</function> - - - IN_ACCESS - (int) - - - - Le fichier a été accédé (lu) (*) - - - - - - IN_MODIFY - (int) - - - - Le fichier a été modifié (*) - - - - - - IN_ATTRIB - (int) - - - - Les métadonnées ont changé (p. ex. les permissions, la date de modification, etc.) (*) - - - - - - IN_CLOSE_WRITE - (int) - - - - Le fichier ouvert en écriture a été refermé (*) - - - - - - IN_CLOSE_NOWRITE - (int) - - - - Le fichier non-ouvert en écriture a été refermé (*) - - - - - - IN_OPEN - (int) - - - - Le fichier a été ouvert (*) - - - - - - IN_MOVED_TO - (int) - - - - Fichier déplacé dans un dossier surveillé (*) - - - - - - IN_MOVED_FROM - (int) - - - - Fichier déplacé depuis un dossier surveillé (*) - - - - - - IN_CREATE - (int) - - - - Fichier ou dossier créé dans un dossier surveillé (*) - - - - - - IN_DELETE - (int) - - - - Fichier ou dossier supprimé dans un dossier surveillé (*) - - - - - - IN_DELETE_SELF - (int) - - - - Les fichiers ou dossiers surveillés ont été supprimés - - - - - - IN_MOVE_SELF - (int) - - - - Les fichiers ou dossiers surveillés ont été déplacés - - - - - - IN_CLOSE - (int) - - - - Égal à IN_CLOSE_WRITE | IN_CLOSE_NOWRITE - - - - - - IN_MOVE - (int) - - - - Égal à IN_MOVED_FROM | IN_MOVED_TO - - - - - - IN_ALL_EVENTS - (int) - - - - Composition de toutes les constantes précédentes - - - - - - IN_UNMOUNT - (int) - - - - Le système de fichiers contenant les objets surveillés a été démonté - - - - - - IN_Q_OVERFLOW - (int) - - - - Queue d'événements en dépassement de capacité (wd vaut -1 pour cet événement) - - - - - - IN_IGNORED - (int) - - - - La surveillance a été retirée (explicitement par inotify_rm_watch - ou parce que le fichier a été supprimé, ou que le système de fichiers a été démonté) - - - - - - IN_ISDIR - (int) - - - - Le sujet de cet événement est un dossier - - - - - - IN_ONLYDIR - (int) - - - - Ne surveille que le chemin, si c'est un dossier (Depuis Linux 2.6.15) - - - - - - IN_DONT_FOLLOW - (int) - - - - Ne déréférence pas le chemin si c'est un lien symbolique (Depuis Linux 2.6.15) - - - - - - IN_MASK_ADD - (int) - - - - Ajoute les événements au masque de surveillance pour ce chemin, s'il existe déjà - (au lieu de remplacer). - - - - - - IN_ONESHOT - (int) - - - - Surveille le chemin de cet événement, puis le supprime de la liste de surveillance. - - - - - - - Les événements marqués par un astérisque (*) ci-dessus peuvent survenir pour des fichiers - dans des dossiers sous surveillance. - - - - - diff --git a/reference/inotify/functions/inotify-add-watch.xml b/reference/inotify/functions/inotify-add-watch.xml deleted file mode 100644 index 0ba258efe1..0000000000 --- a/reference/inotify/functions/inotify-add-watch.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - inotify_add_watch - Ajoute un point de surveillance à une instance inotify - - - - &reftitle.description; - - intfalseinotify_add_watch - resourceinotify_instance - stringpathname - intmask - - - inotify_add_watch ajoute un point de surveillance - à une instance inotify ou modifie un point de surveillance en cours - vers un nouveau fichier ou dossier spécifié par le chemin - pathname. - - - Utiliser inotify_add_watch sur un objet déjà en surveillance - modifie la configuration. Utiliser la constante IN_MASK_ADD - ajoute les événements (OR logique). - - - - - &reftitle.parameters; - - - inotify_instance - - - &inotify.instance.description; - - - - - pathname - - - Fichier ou dossier à surveiller. - - - - - mask - - - Événements à surveiller. Voir - &ReservedConstants;. - - - - - - - - &reftitle.returnvalues; - - La valeur retournée est un pointeur inotify unique (inotify instance wide), - &return.falseforfailure;. - - - - - &reftitle.seealso; - - inotify_init - - - - - diff --git a/reference/inotify/functions/inotify-init.xml b/reference/inotify/functions/inotify-init.xml deleted file mode 100644 index 5aa5c82daa..0000000000 --- a/reference/inotify/functions/inotify-init.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - inotify_init - Initialise une instance inotify - - - - &reftitle.description; - - resourcefalseinotify_init - - - - Initialise une instance inotify pour utiliser avec la fonction - inotify_add_watch - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un flux ou &false; en cas d'erreur. - - - - - &reftitle.examples; - - - Exemple d'utilisation d'inotify - - 0, inotify_read() will not block - -// Arrêt de la surveillance de __FILE__ -inotify_rm_watch($fd, $watch_descriptor); - -// Destruction de l'instance inotify -// Cela aurait arrêté toutes les surveillances si ce n'était pas déjà fait -fclose($fd); - -?> -]]> - - &example.outputs.similar; - - 1, // Égale le $watch_descriptor - 'mask' => 4, // Le bit IN_ATTRIB est activé - 'cookie' => 0, // identifiant unique pour relier des événements (e.g. - // IN_MOVE_FROM et IN_MOVE_TO) - 'name' => '', // Le nom du fichier (e.g. si un dossier était sous surveillance) - ), -); -]]> - - - - - - - &reftitle.seealso; - - inotify_add_watch - inotify_rm_watch - inotify_queue_len - inotify_read - fclose - - - - - diff --git a/reference/inotify/functions/inotify-queue-len.xml b/reference/inotify/functions/inotify-queue-len.xml deleted file mode 100644 index d603b773da..0000000000 --- a/reference/inotify/functions/inotify-queue-len.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - inotify_queue_len - Retourne le nombre d'événements qui sont survenus - - - - &reftitle.description; - - intinotify_queue_len - resourceinotify_instance - - - Cette fonction permet de savoir si inotify_read va bloquer ou non. - Si un nombre supérieur à 0 est retourné, il y a des événements en attente, et - inotify_read ne va pas bloquer. - - - - - &reftitle.parameters; - - - inotify_instance - - - &inotify.instance.description; - - - - - - - - &reftitle.returnvalues; - - Retourne le nombre d'événements qui sont survenus. - - - - - &reftitle.seealso; - - inotify_init - stream_select - stream_set_blocking - - - - - diff --git a/reference/inotify/functions/inotify-read.xml b/reference/inotify/functions/inotify-read.xml deleted file mode 100644 index b6b4ef7d43..0000000000 --- a/reference/inotify/functions/inotify-read.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - inotify_read - Lit les événements dans une instance inotify - - - - &reftitle.description; - - arrayinotify_read - resourceinotify_instance - - - Lit les événements dans une instance inotify. - - - - - &reftitle.parameters; - - - inotify_instance - - - &inotify.instance.description; - - - - - - - - &reftitle.returnvalues; - - Un tableau d'événements inotify ou &false; si aucun événement n'était dans la liste, - et que inotify_instance était non-bloquant. Chaque événement dans le tableau - dispose des index suivants : - - wd, le pointeur retourné par la fonction inotify_add_watch - mask est un champ de bits de constantes inotify - cookie est un identifiant unique pour relier des événements communs (p. ex. IN_MOVE_FROM - et IN_MOVE_TO) - name est le nom du fichier (p. ex. si un fichier a été modifié dans le dossier - de surveillance) - - - - - - &reftitle.seealso; - - inotify_init - stream_select - stream_set_blocking - inotify_queue_len - - - - - diff --git a/reference/inotify/functions/inotify-rm-watch.xml b/reference/inotify/functions/inotify-rm-watch.xml deleted file mode 100644 index 079b97468c..0000000000 --- a/reference/inotify/functions/inotify-rm-watch.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - inotify_rm_watch - Supprime un point de surveillance d'une instance inotify - - - - &reftitle.description; - - boolinotify_rm_watch - resourceinotify_instance - intwatch_descriptor - - - inotify_rm_watch retire le point de surveillance - watch_descriptor de l'instance inotify - inotify_instance. - - - - - &reftitle.parameters; - - - inotify_instance - - - &inotify.instance.description; - - - - - watch_descriptor - - - Point de surveillance à retirer - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - inotify_init - - - - - diff --git a/reference/inotify/reference.xml b/reference/inotify/reference.xml deleted file mode 100644 index 8cae238149..0000000000 --- a/reference/inotify/reference.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - &Functions; Inotify - - &reference.inotify.entities.functions; - - - - - diff --git a/reference/inotify/setup.xml b/reference/inotify/setup.xml deleted file mode 100644 index 04cdfa876e..0000000000 --- a/reference/inotify/setup.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.setup; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;inotify. - -
    - - - -
    - &reftitle.resources; - - Cette extension définit un flux de données, retourné par - inotify_init. - -
    - - -     - diff --git a/reference/lua/book.xml b/reference/lua/book.xml deleted file mode 100644 index 052e14d599..0000000000 --- a/reference/lua/book.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - Lua - Lua - - - &reftitle.intro; - - "Lua est un langage de script puissant, rapide, léger et embarquable." - Cette extension embarque l'interpréteur Lua et offre une API orientée objet - des fonctions et des variables Lua. - - - - &reference.lua.setup; - - &reference.lua.lua; - &reference.lua.luaclosure; - &reference.lua.luaexception; - - diff --git a/reference/lua/configure.xml b/reference/lua/configure.xml deleted file mode 100644 index b7f8394117..0000000000 --- a/reference/lua/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;lua - - - -
    - diff --git a/reference/lua/lua.xml b/reference/lua/lua.xml deleted file mode 100644 index 45d42c1892..0000000000 --- a/reference/lua/lua.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - La classe Lua - Lua - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Lua - - - - - Lua - - - - &Constants; - - const - string - Lua::LUA_VERSION - Lua 5.1.4 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Lua::LUA_VERSION - - - - - - -
    - - - -     - - &reference.lua.entities.lua; - -     - diff --git a/reference/lua/lua/assign.xml b/reference/lua/lua/assign.xml deleted file mode 100644 index f4ad68bf54..0000000000 --- a/reference/lua/lua/assign.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - Lua::assign - Assigne une variable PHP à Lua - - - - &reftitle.description; - - public mixedLua::assign - stringname - stringvalue - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - name - - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - Retourne $this ou &null; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>Lua::assign</function> - -assign("php_var", array(1=>1, 2, 3)); //lua table index begin with 1 -$lua->eval(<< -]]> - - &example.outputs; - - 1 - [2] => 2 - [3] => 3 - ) -]]> - - - - - - diff --git a/reference/lua/lua/call.xml b/reference/lua/lua/call.xml deleted file mode 100644 index aa35e7e339..0000000000 --- a/reference/lua/lua/call.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - Lua::call - Lua::__call - Appelle les fonctions Lua - - - - &reftitle.description; - - public mixedLua::call - callablelua_func - arrayargs - intuse_self0 - - - public mixedLua::__call - callablelua_func - arrayargs - intuse_self0 - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - lua_func - - - Nom de la fonction en Lua - - - - - args - - - Arguments à passer à la fonction Lua - - - - - use_self - - - Si l'on doit ou pas utiliser self - - - - - - - - &reftitle.returnvalues; - - Retourne le résultat de la fonction appelée, &null; - si des arguments incorrects sont passés, ou bien &false; - pour les autres types d'échec. - - - - - - &reftitle.examples; - - Exemple avec <function>Lua::call</function> - -eval(<<call("dummy", array("Lua", "geiliable\n")); -$lua->dummy("Lua", "geiliable"); // __call() -var_dump($lua->call(array("table", "concat"), array(array(1=>1, 2=>2, 3=>3), "-"))); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - __call() - - - - - diff --git a/reference/lua/lua/construct.xml b/reference/lua/lua/construct.xml deleted file mode 100644 index f821bd71d0..0000000000 --- a/reference/lua/lua/construct.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Lua::__construct - Constructeur Lua - - - - &reftitle.description; - - public Lua::__construct - stringlua_script_fileNULL - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - lua_script_file - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/lua/lua/eval.xml b/reference/lua/lua/eval.xml deleted file mode 100644 index cb09e77646..0000000000 --- a/reference/lua/lua/eval.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - Lua::eval - Évalue une chaîne comme du code Lua - - - - &reftitle.description; - - public mixedLua::eval - stringstatements - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - statements - - - - - - - - - - - &reftitle.returnvalues; - - Retourne le résultat du code évalué, &null; - si de mauvais arguments sont passés, ou bien &false; - pour tout autre type d'erreur. - - - - - &reftitle.examples; - - Exemple avec <function>Lua::eval</function> - -eval(<< -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/lua/lua/getversion.xml b/reference/lua/lua/getversion.xml deleted file mode 100644 index 1f52e0c090..0000000000 --- a/reference/lua/lua/getversion.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - Lua::getVersion - Le but de getversion - - - - &reftitle.description; - - public stringLua::getVersion - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne Lua::LUA_VERSION. - - - - - - diff --git a/reference/lua/lua/include.xml b/reference/lua/lua/include.xml deleted file mode 100644 index 44d44b5b24..0000000000 --- a/reference/lua/lua/include.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Lua::include - Analyse un fichier de script Lua - - - - &reftitle.description; - - public mixedLua::include - stringfile - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - file - - - - - - - - - - - &reftitle.returnvalues; - - Retourne le résultat du code inclus, &null; - si de mauvais arguments sont passés, ou &false; - pour toute autre erreur. - - - - - - diff --git a/reference/lua/lua/registercallback.xml b/reference/lua/lua/registercallback.xml deleted file mode 100644 index 77fe3eb309..0000000000 --- a/reference/lua/lua/registercallback.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - Lua::registerCallback - Enregistre une fonction PHP en Lua - - - - &reftitle.description; - - public mixedLua::registerCallback - stringname - callablefunction - - - Enregistre une fonction PHP en Lua, portant le nom de "$name". - - - - - - &reftitle.parameters; - - - name - - - - - - - - function - - - Une fonction de rappel PHP valide - - - - - - - - &reftitle.returnvalues; - - Retourne $this, &null; - si de mauvais arguments sont passés, ou &false; - si une erreur d'un autre type survient. - - - - - &reftitle.examples; - - Exemple avec <function>Lua::registerCallback</function> - -registerCallback("echo", "var_dump"); -$lua->eval(<< -]]> - - &example.outputs; - - - float(1) - [2]=> - float(2) - [3]=> - float(3) -} -]]> - - - - - - diff --git a/reference/lua/luaclosure.xml b/reference/lua/luaclosure.xml deleted file mode 100644 index fdbcad57d3..0000000000 --- a/reference/lua/luaclosure.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - La classe LuaClosure - LuaClosure - - - - -
    - &reftitle.intro; - - LuaClosure est une classe enveloppe pour LUA_TFUNCTION qui peut être - retournée lors de l'appel d'une fonction Lua. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaClosure - - - - - LuaClosure - - - - - &Methods; - - - - -
    - -     - - &reference.lua.entities.luaclosure; - -     - diff --git a/reference/lua/luaclosure/invoke.xml b/reference/lua/luaclosure/invoke.xml deleted file mode 100644 index 92a0b23179..0000000000 --- a/reference/lua/luaclosure/invoke.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - LuaClosure::__invoke - Appelle luaclosure - - - - &reftitle.description; - - public voidLuaClosure::__invoke - mixedargs - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - args - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <function>LuaClosure::__invoke</function> - -eval(<<call($closure); -$closure(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/lua/luaexception.xml b/reference/lua/luaexception.xml deleted file mode 100644 index e2daec287d..0000000000 --- a/reference/lua/luaexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - La classe LuaException - LuaException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaException - - - - - LuaException - - - - extends - Exception - - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - -
    - - -     - - -     - diff --git a/reference/lua/setup.xml b/reference/lua/setup.xml deleted file mode 100644 index 1321e6a559..0000000000 --- a/reference/lua/setup.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Pour utiliser cette extension, il faut avoir installé Lua, - disponible sur la page du projet Lua. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;lua. - -
    - -     - diff --git a/reference/luasandbox/book.xml b/reference/luasandbox/book.xml deleted file mode 100644 index 59b05348cc..0000000000 --- a/reference/luasandbox/book.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - LuaSandbox - LuaSandbox - - - &reftitle.intro; - - LuaSandbox est une extension pour PHP 7 et PHP 8 permettant d'exécuter - en toute sécurité du code Lua 5.1 non fiable à partir de PHP. - - - Les différences par rapport à l'extension Lua : - - - - LuaSandbox a un support pour les limites de temps et de mémoire. - - - - - LuaSandbox fournit un environnement par défaut sécurisé pour l'exécution de code non fiable. - Les fonctions Lua standard ont été examinées pour la sécurité, et plusieurs ont été corrigées en - conséquence. - - - - - LuaSandbox a une interface PHP plus complexe, précise et puissante, - mais elle est moins pratique pour les développeurs. - - - - - LuaSandbox ne supporte que Lua 5.1. Il est difficile de changer cela, car - LuaSandbox utilise des bibliothèques standard Lua fortement modifiées, et - en raison du manque de compatibilité ascendante entre les principales versions de Lua. - LuaSandbox vise à maximiser la compatibilité ascendante avec les scripts fournis - par l'utilisateur. - - - - - - - &reference.luasandbox.setup; - &reference.luasandbox.differences; - &reference.luasandbox.examples; - - - &reference.luasandbox.luasandbox; - &reference.luasandbox.luasandboxfunction; - &reference.luasandbox.luasandboxerror; - &reference.luasandbox.luasandboxerrorerror; - &reference.luasandbox.luasandboxfatalerror; - &reference.luasandbox.luasandboxmemoryerror; - &reference.luasandbox.luasandboxruntimeerror; - &reference.luasandbox.luasandboxsyntaxerror; - &reference.luasandbox.luasandboxtimeouterror; - - - diff --git a/reference/luasandbox/configure.xml b/reference/luasandbox/configure.xml deleted file mode 100644 index 164ba028cc..0000000000 --- a/reference/luasandbox/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;luasandbox - - -
    - diff --git a/reference/luasandbox/differences.xml b/reference/luasandbox/differences.xml deleted file mode 100644 index 625969c8f9..0000000000 --- a/reference/luasandbox/differences.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - Différences avec Lua standard - - LuaSandbox fournit un environnement sécurisé qui diffère de certaines manières de Lua 5.1 standard. - - - - Fonctionnalités non disponibles - - - - Les packages dofile(), loadfile(), et io, car ils permettent un accès direct au système de fichiers. Si nécessaire, l'accès au système de fichiers doit être effectué via des fonctions de rappel PHP. - - - - - Le package package, y compris require() et module(), car il dépend fortement de l'accès direct au système de fichiers. Une réécriture pure Lua telle que celle utilisée dans l'extension MediaWiki Scribunto peut être utilisée à la place. - - - - - load() et loadstring(), pour permettre l'analyse statique du code Lua. - - - - - print(), depuis qu'il écrit sur la sortie standard. Si nécessaire, la sortie doit être effectuée via des fonctions de rappel PHP. - - - - - La plupart du package os, car il permet la manipulation du processus et l'exécution d'autres processus. - - - - - os.clock(), os.date(), os.difftime(), et os.time() restent disponibles. - - - - - - - La plupart du package debug, car il permet la manipulation de l'état Lua et des métadonnées de manière à pouvoir casser l'isolation. - - - - - debug.traceback() reste disponible. - - - - - - - string.dump(), car il peut exposer des données internes. - - - - - Le package collectgarbage(), gcinfo(), et coroutine n'ont pas été examinés pour la sécurité. - - - - - - - Fonctionnalités qui ont été modifiées - - - - pcall() et xpcall() ne peuvent pas attraper certaines erreurs, en particulier les erreurs de délai d'attente. - - - - - tostring() n'inclut pas les adresses de pointeur. - - - - - string.match() a été patché pour limiter la profondeur de récursion et pour vérifier périodiquement un délai d'attente. - - - - - math.random() et math.randomseed() sont remplacés par des versions qui ne partagent pas l'état avec rand() de PHP. - - - - - Les méta méthodes de Lua 5.2 __pairs et __ipairs sont supportées par pairs() et ipairs(). - - - - - - - diff --git a/reference/luasandbox/examples.xml b/reference/luasandbox/examples.xml deleted file mode 100644 index 311fcc603e..0000000000 --- a/reference/luasandbox/examples.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - &reftitle.examples; - - -
    - Utilisation de base de LuaSandbox - - Une fois qu'on a compilé PHP avec le support de LuaSandbox, il est possible de commencer à utiliser LuaSandbox pour exécuter en toute sécurité du code Lua fourni par l'utilisateur. - - - Exécuter du code Lua - -setMemoryLimit( 50 * 1024 * 1024 ); -$sandbox->setCPULimit( 10 ); - -// Enregistrer quelques fonctions dans l'environnement Lua - -function frobnosticate( $v ) { - return [ $v + 42 ]; -} - -$sandbox->registerLibrary( 'php', [ - 'frobnosticate' => 'frobnosticate', - 'output' => function ( $string ) { - echo "$string\n"; - }, - 'error' => function () { - throw new LuaSandboxRuntimeError( "Something is wrong" ); - } -] ); - -// Exécuter du code Lua, y compris des fonctions de rappels dans PHP et dans Lua - -$luaCode = <<loadString( $luaCode )->call(); -assert( $frob->call( 4000 ) === [ 4242 ] ); - -// Les exceptions LuaSandboxRuntimeError lancées par PHP peuvent être capturées dans PHP - -list( $ok, $message ) = $sandbox->loadString( 'return pcall( php.error )' )->call(); -assert( !$ok ); -assert( $message === 'Something is wrong' ); - -?> -]]> - - -
    - -     - diff --git a/reference/luasandbox/luasandbox.xml b/reference/luasandbox/luasandbox.xml deleted file mode 100644 index dd052b29e7..0000000000 --- a/reference/luasandbox/luasandbox.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - La classe LuaSandbox - LuaSandbox - - - - -
    - &reftitle.intro; - - La classe LuaSandbox crée un environnement Lua et permet l'exécution de - code Lua. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandbox - - - - - LuaSandbox - - - - &Constants; - - const - int - LuaSandbox::SAMPLES - 0 - - - const - int - LuaSandbox::SECONDS - 1 - - - const - int - LuaSandbox::PERCENT - 2 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - LuaSandbox::SAMPLES - - - Utilisé avec LuaSandbox::getProfilerFunctionReport pour retourner les durées en échantillons. - - - - - - LuaSandbox::SECONDS - - - Utilisé avec LuaSandbox::getProfilerFunctionReport pour retourner les durées en secondes. - - - - - - LuaSandbox::PERCENT - - - Utilisé avec LuaSandbox::getProfilerFunctionReport pour retourner les durées en pourcentages du total. - - - - - -
    - - - -     - - &reference.luasandbox.entities.luasandbox; - -     - diff --git a/reference/luasandbox/luasandbox/callfunction.xml b/reference/luasandbox/luasandbox/callfunction.xml deleted file mode 100644 index e15f902fa3..0000000000 --- a/reference/luasandbox/luasandbox/callfunction.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - LuaSandbox::callFunction - Appelle une fonction dans une variable globale Lua - - - - &reftitle.description; - - public arrayboolLuaSandbox::callFunction - stringname - mixedargs - - - Appelle une fonction dans une variable globale Lua. - - - Si le nom contient des caractères ".", la fonction est localisée via - des accès récursifs à la table, comme si le nom était une expression Lua. - - - Si la variable n'existe pas, ou n'est pas une fonction, false sera - retourné et un avertissement émis. - - - Pour plus d'informations sur l'appel de fonctions Lua et les valeurs de retour, - voir LuaSandboxFunction::call. - - - - - &reftitle.parameters; - - - name - - - Nom de la variable Lua. - - - - - args - - - Arguments de la fonction. - - - - - - - - &reftitle.returnvalues; - - Renvoie un array des valeurs retournées par la fonction Lua, qui peut être vide, &return.falseforfailure;. - - - - - &reftitle.examples; - - Appel d'une fonction Lua - -callFunction( 'string.match', $string, $pattern ); - -?> -]]> - - - - - - diff --git a/reference/luasandbox/luasandbox/disableprofiler.xml b/reference/luasandbox/luasandbox/disableprofiler.xml deleted file mode 100644 index 9c5e67fb93..0000000000 --- a/reference/luasandbox/luasandbox/disableprofiler.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - LuaSandbox::disableProfiler - Désactive le profileur - - - - &reftitle.description; - - public voidLuaSandbox::disableProfiler - - - - Désactive le profileur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - LuaSandbox::enableProfiler - LuaSandbox::getProfilerFunctionReport - - - - - diff --git a/reference/luasandbox/luasandbox/enableprofiler.xml b/reference/luasandbox/luasandbox/enableprofiler.xml deleted file mode 100644 index f8f4d42eb1..0000000000 --- a/reference/luasandbox/luasandbox/enableprofiler.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - LuaSandbox::enableProfiler - Active le profileur - - - - &reftitle.description; - - public boolLuaSandbox::enableProfiler - floatperiod0.02 - - - Active le profileur. Le profilage commencera lorsque du code Lua sera entré. - - - Le profileur échantillonne périodiquement l'environnement Lua pour enregistrer - la fonction en cours d'exécution. Les tests indiquent que, du moins sous Linux, - une période inférieure à 1ms entraînera un nombre élevé de dépassements mais - aucun problème de performance. - - - - - - &reftitle.parameters; - - - period - - - Période d'échantillonnage en secondes. - - - - - - - - &reftitle.returnvalues; - - Renvoie un booléen indiquant si le profileur est activé. - - - - - &reftitle.seealso; - - LuaSandbox::disableProfiler - LuaSandbox::getProfilerFunctionReport - - - - - diff --git a/reference/luasandbox/luasandbox/getcpuusage.xml b/reference/luasandbox/luasandbox/getcpuusage.xml deleted file mode 100644 index 08bdc10b66..0000000000 --- a/reference/luasandbox/luasandbox/getcpuusage.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - LuaSandbox::getCPUUsage - Récupère l'utilisation actuelle du temps CPU de l'environnement Lua - - - - &reftitle.description; - - public floatLuaSandbox::getCPUUsage - - - - Récupère l'utilisation actuelle du temps CPU de l'environnement Lua. - - - Cela inclut le temps passé dans les fonctions de rappel PHP. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'utilisation actuelle du temps CPU en secondes. - - - - Sur Windows, cette fonction renvoie toujours zéro. Sur les systèmes - d'exploitation qui ne prennent pas en charge CLOCK_THREAD_CPUTIME_ID, - tels que FreeBSD et Mac OS X, cette fonction renverra le temps écoulé - au mur, pas le temps CPU. - - - - - - &reftitle.seealso; - - LuaSandbox::getMemoryUsage - LuaSandbox::getPeakMemoryUsage - LuaSandbox::setCPULimit - - - - - diff --git a/reference/luasandbox/luasandbox/getmemoryusage.xml b/reference/luasandbox/luasandbox/getmemoryusage.xml deleted file mode 100644 index f5c5a17e00..0000000000 --- a/reference/luasandbox/luasandbox/getmemoryusage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - LuaSandbox::getMemoryUsage - Récupère l'utilisation actuelle de la mémoire de l'environnement Lua - - - - &reftitle.description; - - public intLuaSandbox::getMemoryUsage - - - - Récupère l'utilisation actuelle de la mémoire de l'environnement Lua. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'utilisation actuelle de la mémoire en octets. - - - - - &reftitle.seealso; - - LuaSandbox::getPeakMemoryUsage - LuaSandbox::getCPUUsage - LuaSandbox::setMemoryLimit - - - - - diff --git a/reference/luasandbox/luasandbox/getpeakmemoryusage.xml b/reference/luasandbox/luasandbox/getpeakmemoryusage.xml deleted file mode 100644 index d10b8a86dd..0000000000 --- a/reference/luasandbox/luasandbox/getpeakmemoryusage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - LuaSandbox::getPeakMemoryUsage - Récupère le pic d'utilisation de la mémoire de l'environnement Lua - - - - &reftitle.description; - - public intLuaSandbox::getPeakMemoryUsage - - - - Récupère le pic d'utilisation de la mémoire de l'environnement Lua. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le pic d'utilisation de la mémoire en octets. - - - - - &reftitle.seealso; - - LuaSandbox::getMemoryUsage - LuaSandbox::getCPUUsage - LuaSandbox::setMemoryLimit - - - - - diff --git a/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml b/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml deleted file mode 100644 index 0154aa5214..0000000000 --- a/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - LuaSandbox::getProfilerFunctionReport - Récupère les données du profileur - - - - &reftitle.description; - - public arrayLuaSandbox::getProfilerFunctionReport - intunitsLuaSandbox::SECONDS - - - Pour une instance de profilage précédemment démarrée par - LuaSandbox::enableProfiler, récupère un - rapport du coût de chaque fonction. - - - La mesure du coût est déterminée par le paramètre - $units : - - - - LuaSandbox::SAMPLES - Mesure en nombre d'échantillons. - - - LuaSandbox::SECONDS - Mesure en secondes de temps CPU. - - - LuaSandbox::PERCENT - Mesure en pourcentage de temps CPU. - - - - - - &reftitle.parameters; - - - units - - - L'unité de mesure constante. - - - - - - - - &reftitle.returnvalues; - - Renvoie les mesures du profileur, triées par ordre décroissant, sous forme - d'un tableau associatif. Les clés sont les noms des fonctions Lua (avec le fichier source et la ligne - définis entre crochets angulaires), les valeurs sont les mesures en int - ou float. - - - - Sur Windows, cette fonction renvoie toujours un tableau vide. Sur les systèmes - d'exploitation qui ne prennent pas en charge CLOCK_THREAD_CPUTIME_ID, - tels que FreeBSD et Mac OS X, cette fonction renverra le temps écoulé - au mur, pas le temps CPU. - - - - - - &reftitle.examples; - - Profiling Lua code - -enableProfiler( 0.01 ); - -// ... Exécutez du code Lua ici ... - -// Récupère les données du profileur -$data = $sandbox->getProfilerFunctionReport(); - -?> -]]> - - - - - - diff --git a/reference/luasandbox/luasandbox/getversioninfo.xml b/reference/luasandbox/luasandbox/getversioninfo.xml deleted file mode 100644 index d0c4dbb857..0000000000 --- a/reference/luasandbox/luasandbox/getversioninfo.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - LuaSandbox::getVersionInfo - Renvoie les versions de LuaSandbox et Lua - - - - &reftitle.description; - - public static arrayLuaSandbox::getVersionInfo - - - - Renvoie les versions de LuaSandbox et Lua. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un tableau avec deux clés : - - - - - elementtypedescription - - - - LuaSandbox - string - La version de l'extension LuaSandbox. - - - Lua - string - Le nom et la version de la bibliothèque Lua, tels que définis par la macro LUA_RELEASE, par exemple, "Lua 5.1.5". - - - - - - - - diff --git a/reference/luasandbox/luasandbox/loadbinary.xml b/reference/luasandbox/luasandbox/loadbinary.xml deleted file mode 100644 index 49062eac94..0000000000 --- a/reference/luasandbox/luasandbox/loadbinary.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - LuaSandbox::loadBinary - Charge un morceau binaire précompilé dans l'environnement Lua - - - - &reftitle.description; - - public LuaSandboxFunctionLuaSandbox::loadBinary - stringcode - stringchunkName'' - - - Charge les données générées par LuaSandboxFunction::dump. - - - - - &reftitle.parameters; - - - code - - - Les données de LuaSandboxFunction::dump. - - - - - chunkName - - - Le nom du morceau pour la fonction chargée. - - - - - - - - &reftitle.returnvalues; - - Renvoie une LuaSandboxFunction. - - - - - &reftitle.seealso; - - LuaSandbox::loadString - - - - - diff --git a/reference/luasandbox/luasandbox/loadstring.xml b/reference/luasandbox/luasandbox/loadstring.xml deleted file mode 100644 index bf56bd222c..0000000000 --- a/reference/luasandbox/luasandbox/loadstring.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - LuaSandbox::loadString - Charge du code Lua dans l'environnement Lua - - - - &reftitle.description; - - public LuaSandboxFunctionLuaSandbox::loadString - stringcode - stringchunkName'' - - - Charge du code Lua dans l'environnement Lua. - - - Ceci est l'équivalent de la fonction loadstring() de Lua standard. - - - - - - &reftitle.parameters; - - - code - - - Le code Lua. - - - - - chunkName - - - Le nom du morceau chargé, pour utilisation dans les traces d'erreur. - - - - - - - - &reftitle.returnvalues; - - Renvoie une LuaSandboxFunction qui, lorsqu'elle est exécutée, exécutera le $code passé. - - - - - &reftitle.examples; - - Chargement de code dans Lua - -loadString( -<<call() ); - -?> -]]> - - &example.outputs; - - - string(12) "Hello, world" -} -]]> - - - - - - &reftitle.seealso; - - LuaSandbox::registerLibrary - LuaSandbox::wrapPhpFunction - - - - - diff --git a/reference/luasandbox/luasandbox/pauseusagetimer.xml b/reference/luasandbox/luasandbox/pauseusagetimer.xml deleted file mode 100644 index 82632840f1..0000000000 --- a/reference/luasandbox/luasandbox/pauseusagetimer.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - LuaSandbox::pauseUsageTimer - Pause le minuteur d'utilisation du CPU - - - - &reftitle.description; - - public boolLuaSandbox::pauseUsageTimer - - - - Pause le minuteur d'utilisation du CPU. - - - Ceci n'a d'effet que lorsqu'il est appelé depuis un rappel de Lua. Lorsque - l'exécution revient à Lua, le minuteur sera automatiquement relancé. - Si un nouvel appel est fait à Lua, le minuteur sera relancé - pour la durée de cet appel. - - - Si un rappel PHP appelle à nouveau Lua avec le minuteur non mis en pause, et - que cette fonction Lua appelle à nouveau PHP, le second appel PHP ne pourra pas - mettre en pause le minuteur. La logique est que même si le second appel PHP - éviterait de compter l'utilisation du CPU contre la limite, le premier - appel le compte toujours. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un bool indiquant si le minuteur est maintenant en pause. - - - - - &reftitle.examples; - - Manipulation du minuteur d'utilisation - -setCPULimit( 1 ); - -function doWait( $t ) { - $end = microtime( true ) + $t; - while ( microtime( true ) < $end ) { - // waste CPU cycles - } -} - -// Enregistrer une fonction de rappel PHP -$sandbox->registerLibrary( 'php', [ - 'test' => function () use ( $sandbox ) { - $sandbox->pauseUsageTimer(); - doWait( 5 ); - - $sandbox->unpauseUsageTimer(); - doWait( 0.1 ); - }, - 'test2' => function () use ( $sandbox ) { - $sandbox->pauseUsageTimer(); - $sandbox->unpauseUsageTimer(); - doWait( 1.1 ); - } -] ); - -echo "This should not time out...\n"; -$sandbox->loadString( 'php.test()' )->call(); - -echo "This should time out.\n"; -try { - $sandbox->loadString( 'php.test2()' )->call(); - echo "It did not?\n"; -} catch ( LuaSandboxTimeoutError $ex ) { - echo "It did! " . $ex->getMessage() . "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - LuaSandbox::setCPULimit - LuaSandbox::unpauseUsageTimer - - - - - diff --git a/reference/luasandbox/luasandbox/registerlibrary.xml b/reference/luasandbox/luasandbox/registerlibrary.xml deleted file mode 100644 index c90b95b15b..0000000000 --- a/reference/luasandbox/luasandbox/registerlibrary.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - LuaSandbox::registerLibrary - Enregistre un ensemble de fonctions PHP en tant que bibliothèque Lua - - - - &reftitle.description; - - public voidLuaSandbox::registerLibrary - stringlibname - arrayfunctions - - - Enregistre un ensemble de fonctions PHP en tant que bibliothèque Lua, de sorte que Lua puisse - appeler le code PHP correspondant. - - - Pour plus d'informations sur l'appel des fonctions Lua et les valeurs de retour, - voir LuaSandboxFunction::call. - - - - - - &reftitle.parameters; - - - libname - - - Le nom de la bibliothèque. Dans l'état Lua, la variable globale de ce - nom sera définie sur la table des fonctions. Si la table existe déjà, - les nouvelles fonctions y seront ajoutées. - - - - - functions - - - Un array, où chaque clé est un nom de fonction, et chaque valeur est un - callable PHP correspondant. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Enregistrement de fonctions PHP à appeler depuis Lua - -registerLibrary( 'php', [ - 'frobnosticate' => 'frobnosticate', - 'output' => function ( $string ) { - echo "$string\n"; - }, - 'error' => function () { - throw new LuaSandboxRuntimeError( "Something is wrong" ); - } -] ); - -?> -]]> - - - - - - &reftitle.seealso; - - LuaSandbox::loadString - LuaSandbox::wrapPhpFunction - - - - - diff --git a/reference/luasandbox/luasandbox/setcpulimit.xml b/reference/luasandbox/luasandbox/setcpulimit.xml deleted file mode 100644 index 1fe3a2cc92..0000000000 --- a/reference/luasandbox/luasandbox/setcpulimit.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - LuaSandbox::setCPULimit - Définit la limite de temps CPU pour l'environnement Lua - - - - &reftitle.description; - - public voidLuaSandbox::setCPULimit - floatboollimit - - - Définit la limite de temps CPU pour l'environnement Lua. - - - Si le temps total utilisateur et système utilisé par l'environnement après - l'appel à cette méthode dépasse cette limite, une exception - LuaSandboxTimeoutError est lancée. - - - Le temps utilisé dans les fonctions de rappel PHP est inclus dans la limite. - - - Définir la limite de temps depuis une fonction de rappel pendant que Lua s'exécute - entraîne la réinitialisation du minuteur, ou son démarrage s'il n'était pas déjà en - cours d'exécution. - - - - Sur Windows, la limite de temps CPU sera ignorée. Sur les systèmes d'exploitation - qui ne prennent pas en charge CLOCK_THREAD_CPUTIME_ID, tels que - FreeBSD et Mac OS X, le temps écoulé au mur, plutôt que le temps CPU, sera limité. - - - - - - &reftitle.parameters; - - - limit - - - La limite en tant que float en secondes, ou &false; pour aucune limite. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Appel d'une fonction Lua - -setCPULimit( 2 ); - -// lance le code Lua -$sandbox->loadString( 'while true do end' )->call(); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - LuaSandbox::getCPUUsage - LuaSandbox::setMemoryLimit - - - - - diff --git a/reference/luasandbox/luasandbox/setmemorylimit.xml b/reference/luasandbox/luasandbox/setmemorylimit.xml deleted file mode 100644 index 61823faef9..0000000000 --- a/reference/luasandbox/luasandbox/setmemorylimit.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - LuaSandbox::setMemoryLimit - Définit la limite de mémoire pour l'environnement Lua - - - - &reftitle.description; - - public voidLuaSandbox::setMemoryLimit - intlimit - - - Définit la limite de mémoire pour l'environnement Lua. - - - Si cette limite est dépassée, une - exception LuaSandboxMemoryError est lancée. - - - - - - &reftitle.parameters; - - - limit - - - La limite de mémoire en octets. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Appel d'une fonction Lua - -setMemoryLimit( 50 * 1024 * 1024 ); - -// lance le code Lua -$sandbox->loadString( 'local x = "x"; while true do x = x .. x; end' )->call(); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - LuaSandbox::getMemoryUsage - LuaSandbox::getPeakMemoryUsage - LuaSandbox::setCPULimit - - - - - diff --git a/reference/luasandbox/luasandbox/unpauseusagetimer.xml b/reference/luasandbox/luasandbox/unpauseusagetimer.xml deleted file mode 100644 index 2a1141926b..0000000000 --- a/reference/luasandbox/luasandbox/unpauseusagetimer.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - LuaSandbox::unpauseUsageTimer - Relance le minuteur mis en pause par LuaSandbox::pauseUsageTimer - - - - &reftitle.description; - - public voidLuaSandbox::unpauseUsageTimer - - - - Relance le minuteur mis en pause par LuaSandbox::pauseUsageTimer. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - LuaSandbox::pauseUsageTimer - LuaSandbox::setCPULimit - - - - - diff --git a/reference/luasandbox/luasandbox/wrapphpfunction.xml b/reference/luasandbox/luasandbox/wrapphpfunction.xml deleted file mode 100644 index 2d04c0cfcb..0000000000 --- a/reference/luasandbox/luasandbox/wrapphpfunction.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - LuaSandbox::wrapPhpFunction - Envelope une fonction PHP dans une LuaSandboxFunction - - - - &reftitle.description; - - public LuaSandboxFunctionLuaSandbox::wrapPhpFunction - callablefunction - - - Enveloppe une fonction PHP dans une LuaSandboxFunction, de sorte - qu'elle puisse être passée dans Lua en tant que fonction anonyme. - - - La fonction doit retourner soit un tableau de valeurs (qui peut être vide), - soit &null; qui est équivalent à retourner le tableau vide. - - - Les exceptions seront levées comme des erreurs en Lua, cependant seules les - exceptions LuaSandboxRuntimeError peuvent être attrapées - à l'intérieur de Lua avec pcall() ou xpcall(). - - - Pour plus d'informations sur l'appel des fonctions Lua et les valeurs de retour, - voir LuaSandboxFunction::call. - - - - - &reftitle.parameters; - - - function - - - La fonction de rappel à envelopper. - - - - - - - - &reftitle.returnvalues; - - Renvoie un LuaSandboxFunction. - - - - - &reftitle.seealso; - - LuaSandbox::loadString - LuaSandbox::registerLibrary - - - - - diff --git a/reference/luasandbox/luasandboxerror.xml b/reference/luasandbox/luasandboxerror.xml deleted file mode 100644 index b1cfd678bf..0000000000 --- a/reference/luasandbox/luasandboxerror.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - La classe LuaSandboxError - LuaSandboxError - - - - -
    - &reftitle.intro; - - La classe de base pour les exceptions LuaSandbox - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxError - - - - - LuaSandboxError - - - - extends - Exception - - - - &Constants; - - const - int - LuaSandboxError::RUN - 2 - - - const - int - LuaSandboxError::SYNTAX - 3 - - - const - int - LuaSandboxError::MEM - 4 - - - const - int - LuaSandboxError::ERR - 5 - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - LuaSandboxError::RUN - - - - - - - LuaSandboxError::SYNTAX - - - - - - - LuaSandboxError::MEM - - - - - - - LuaSandboxError::ERR - - - - - - -
    - - - -     - - - -     - diff --git a/reference/luasandbox/luasandboxerrorerror.xml b/reference/luasandbox/luasandboxerrorerror.xml deleted file mode 100644 index 170c5b1847..0000000000 --- a/reference/luasandbox/luasandboxerrorerror.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - La classe LuaSandboxErrorError - LuaSandboxErrorError - - - - -
    - &reftitle.intro; - - Exception lancée lorsque Lua rencontre une erreur à l'intérieur d'un gestionnaire d'erreurs. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxErrorError - - - - - LuaSandboxErrorError - - - - extends - LuaSandboxFatalError - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - -     - - - -     - diff --git a/reference/luasandbox/luasandboxfatalerror.xml b/reference/luasandbox/luasandboxfatalerror.xml deleted file mode 100644 index f31300d452..0000000000 --- a/reference/luasandbox/luasandboxfatalerror.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - La classe LuaSandboxFatalError - LuaSandboxFatalError - - - - -
    - &reftitle.intro; - - Les exceptions LuaSandbox qui ne peuvent pas être attrapées. - - - Ces exceptions ne peuvent pas être attrapées en Lua en utilisant - pcall() ou xpcall(). - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxFatalError - - - - - LuaSandboxFatalError - - - - extends - LuaSandboxError - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - -     - - - -     - diff --git a/reference/luasandbox/luasandboxfunction.xml b/reference/luasandbox/luasandboxfunction.xml deleted file mode 100644 index 84f49a97a6..0000000000 --- a/reference/luasandbox/luasandboxfunction.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - La classe LuaSandboxFunction - LuaSandboxFunction - - - - -
    - &reftitle.intro; - - Représente une fonction Lua, permettant de l'appeler à partir de PHP. - - - Une LuaSandboxFunction peut être obtenue en tant que valeur de retour depuis Lua, en tant que paramètre - passé à un rappel depuis Lua, ou en utilisant - LuaSandbox::wrapPhpFunction, - LuaSandbox::loadString, ou - LuaSandbox::loadBinary. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxFunction - - - - - LuaSandboxFunction - - - - - &Methods; - - - - -
    - -     - - &reference.luasandbox.entities.luasandboxfunction; - -     - diff --git a/reference/luasandbox/luasandboxfunction/call.xml b/reference/luasandbox/luasandboxfunction/call.xml deleted file mode 100644 index 08f6e00629..0000000000 --- a/reference/luasandbox/luasandboxfunction/call.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - LuaSandboxFunction::call - Appelle une fonction Lua - - - - &reftitle.description; - - public arrayboolLuaSandboxFunction::call - stringargs - - - Appelle une fonction Lua. - - - Les erreurs considérées comme étant de la faute du code PHP entraîneront - le retour de la fonction avec la valeur &false; et l'émission de E_WARNING, - par exemple, un type resource utilisé comme argument. Les erreurs Lua - entraîneront le lancement d'une exception LuaSandboxRuntimeError. - - - Les types PHP et Lua sont convertis comme suit : - - - - Les &null; de PHP sont les nil de Lua, et vice versa. - - - - Les ints de PHP et floats sont convertis en nombres Lua. - L'infini et NAN sont supportés. - - - - - Les nombres Lua sans partie fractionnaire entre environ -2**53 - et 2**53 sont convertis en ints PHP, les autres - sont convertis en floats PHP. - - - - Les bools de PHP sont des booléens Lua, et vice versa. - - - Les strings de PHP sont des chaînes Lua, et vice versa. - - - - Les fonctions Lua sont des objets PHP LuaSandboxFunction, et vice versa. - Les callables PHP généraux ne sont pas supportés. - - - - - Les arrays de PHP sont convertis en tables Lua, et vice versa. - - - - - Il est à noter que Lua indexe typiquement les tableaux à partir de 1, tandis que PHP - indexe les tableaux à partir de 0. Aucun ajustement n'est fait pour ces conventions - différentes. - - - - Les tableaux auto-référentiels ne sont pas supportés dans les deux sens. - - - Les références PHP sont déréférencées. - - - - Les __pairs et __ipairs de Lua sont traités. - __index est ignoré. - - - - - Lors de la conversion de PHP en Lua, les clés entières entre - -2**53 et 2**53 sont représentées - comme des nombres Lua. Toutes les autres clés sont représentées comme des chaînes Lua. - - - - - Lors de la conversion de Lua en PHP, les clés autres que les chaînes et - les nombres entraîneront une erreur, tout comme les collisions lors de la conversion - de nombres en chaînes ou vice versa (puisque PHP considère des choses comme - $a[0] et $a["0"] comme étant équivalentes). - - - - - - - Tous les autres types ne sont pas supportés et entraîneront une erreur/exception, - y compris les objects PHP généraux et les types userdata et thread Lua. - - - - - Les fonctions Lua retournent intrinsèquement une liste de résultats. Donc, sur succès, - cette méthode retourne un array contenant toutes les valeurs retournées par Lua, - avec des clés int commençant à zéro. Lua peut ne retourner aucun résultat, auquel - cas un tableau vide est retourné. - - - - - &reftitle.parameters; - - - args - - - Les arguments passés à la fonction. - - - - - - - - &reftitle.returnvalues; - - Renvoie un array des valeurs retournées par la fonction, qui peut être vide, - &return.falseforfailure;. - - - - - diff --git a/reference/luasandbox/luasandboxfunction/construct.xml b/reference/luasandbox/luasandboxfunction/construct.xml deleted file mode 100644 index e236d65070..0000000000 --- a/reference/luasandbox/luasandboxfunction/construct.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - LuaSandboxFunction::__construct - Inutilisé - - - - &reftitle.description; - - final private LuaSandboxFunction::__construct - - - - Les LuaSandboxFunction sont obtenus en tant que valeur de retour de Lua, - en tant que paramètre passé à un rappel depuis Lua, ou en utilisant - LuaSandbox::wrapPhpFunction, - LuaSandbox::loadString, ou - LuaSandbox::loadBinary. Ils ne peuvent pas être construits directement. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - diff --git a/reference/luasandbox/luasandboxfunction/dump.xml b/reference/luasandbox/luasandboxfunction/dump.xml deleted file mode 100644 index 54750eebb8..0000000000 --- a/reference/luasandbox/luasandboxfunction/dump.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - LuaSandboxFunction::dump - Affiche la fonction sous forme de blob binaire - - - - &reftitle.description; - - public stringLuaSandboxFunction::dump - - - - Affiche la fonction sous forme de blob binaire. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une chaîne qui peut être passée à LuaSandbox::loadBinary. - - - - - diff --git a/reference/luasandbox/luasandboxmemoryerror.xml b/reference/luasandbox/luasandboxmemoryerror.xml deleted file mode 100644 index 06aa271789..0000000000 --- a/reference/luasandbox/luasandboxmemoryerror.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - La classe LuaSandboxMemoryError - LuaSandboxMemoryError - - - - -
    - &reftitle.intro; - - Exception lancée lorsque Lua ne peut pas allouer de mémoire. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxMemoryError - - - - - LuaSandboxMemoryError - - - - extends - LuaSandboxFatalError - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - -
    - &reftitle.seealso; - - LuaSandbox::setMemoryLimit - -
    - -     - - - -     - diff --git a/reference/luasandbox/luasandboxruntimeerror.xml b/reference/luasandbox/luasandboxruntimeerror.xml deleted file mode 100644 index 7d94c79eaf..0000000000 --- a/reference/luasandbox/luasandboxruntimeerror.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - La classe LuaSandboxRuntimeError - LuaSandboxRuntimeError - - - - -
    - &reftitle.intro; - - Les exceptions d'exécution LuaSandbox qui peuvent être attrapées. - - - Ces exceptions peuvent être attrapées en Lua en utilisant - pcall() ou xpcall(). - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxRuntimeError - - - - - LuaSandboxRuntimeError - - - - extends - LuaSandboxError - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - -     - - - -     - diff --git a/reference/luasandbox/luasandboxsyntaxerror.xml b/reference/luasandbox/luasandboxsyntaxerror.xml deleted file mode 100644 index df4484efc1..0000000000 --- a/reference/luasandbox/luasandboxsyntaxerror.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - La classe LuaSandboxSyntaxError - LuaSandboxSyntaxError - - - - -
    - &reftitle.intro; - - Exception lancée lorsque le code Lua ne peut pas être analysé. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxSyntaxError - - - - - LuaSandboxSyntaxError - - - - extends - LuaSandboxFatalError - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - -     - - - -     - diff --git a/reference/luasandbox/luasandboxtimeouterror.xml b/reference/luasandbox/luasandboxtimeouterror.xml deleted file mode 100644 index ac10ea9eac..0000000000 --- a/reference/luasandbox/luasandboxtimeouterror.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - La classe LuaSandboxTimeoutError - LuaSandboxTimeoutError - - - - -
    - &reftitle.intro; - - Exception lancée lorsque la limite de temps CPU configurée est dépassée. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxTimeoutError - - - - - LuaSandboxTimeoutError - - - - extends - LuaSandboxFatalError - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - -
    - &reftitle.seealso; - - LuaSandbox::setCPULimit - -
    - -     - - - -     - diff --git a/reference/luasandbox/setup.xml b/reference/luasandbox/setup.xml deleted file mode 100644 index ac0bd9598c..0000000000 --- a/reference/luasandbox/setup.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - Pour utiliser cette extension, Lua 5.1 doit être installé, disponible sur la page d'accueil de Lua. - - - Pour utiliser les fonctionnalités de minuterie, LuaSandbox doit être installé sur - Linux. - - - Si FreeBSD ou Mac OS X est utilisé, seul le temps réel (horloge murale) est - supporté, les fonctions prétendant retourner le temps CPU retournent - en fait le temps de l'horloge murale. - - - Si Windows est utilisé, aucune fonction de minuterie ne sera supportée. Les limites de temps - seront inopérantes. - -
    - -
    - &reftitle.install; - - - Si le système d'exploitation est Debian 10 ou plus récent, ou Ubuntu 18.04 ou plus récent, alors - LuaSandbox devrait typiquement être installé depuis le paquet - php-luasandbox : - - - - - - - - Pour installer LuaSandbox à l'aide de PIE, - exécuter la commande suivante : - - - - - - - - Les anciennes versions se trouvent dans le paquet PECL LuaSandbox. - - - -
    - -     - diff --git a/reference/lzf/book.xml b/reference/lzf/book.xml deleted file mode 100644 index c139c9f067..0000000000 --- a/reference/lzf/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - LZF - LZF - - - - &reftitle.intro; - - LZF est un algorithme de compression très rapide, idéal pour économiser - de l'espace disque sans trop de perte de temps. Il peut être optimisé - pour la vitesse ou pour la compression au moment de la compilation. - Cette extension utilise la bibliothèque liblzf - créée par Marc Lehmann. - - - - - &reference.lzf.setup; - &reference.lzf.reference; - - - diff --git a/reference/lzf/configure.xml b/reference/lzf/configure.xml deleted file mode 100644 index cd28e2cfb1..0000000000 --- a/reference/lzf/configure.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - -
    - &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;lzf. - - - Pour utiliser ces fonctions, il faut compiler PHP avec le support - lzf en utilisant l'option de configuration - . - Il est également possible de passer l'option - - pour optimiser LZF d'un point de vue d'espace au détriment de la vitesse. - - - Les utilisateurs de Windows doivent activer la bibliothèque - php_lzf.dll dans le &php.ini; - pour pouvoir utiliser ces fonctions. - -
    - diff --git a/reference/lzf/functions/lzf-compress.xml b/reference/lzf/functions/lzf-compress.xml deleted file mode 100644 index d5967c1fd5..0000000000 --- a/reference/lzf/functions/lzf-compress.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - lzf_compress - Compression LZF - - - &reftitle.description; - - stringlzf_compress - stringdata - - - lzf_compress compresse les données - data en utilisant l'encodage LZF. - - - - &reftitle.parameters; - - - data - - - La chaîne de caractères à compresser. - - - - - - - &reftitle.returnvalues; - - Retourne les données compressées ou &false; si une erreur survient. - - - - &reftitle.seealso; - - lzf_decompress - - - - diff --git a/reference/lzf/functions/lzf-decompress.xml b/reference/lzf/functions/lzf-decompress.xml deleted file mode 100644 index a4e01b432b..0000000000 --- a/reference/lzf/functions/lzf-decompress.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - lzf_decompress - Décompression LZF - - - &reftitle.description; - - stringlzf_decompress - stringdata - - - lzf_decompress décompresse les données - data en utilisant l'encodage LZF. - - - - &reftitle.parameters; - - - data - - - La chaîne compressée. - - - - - - - &reftitle.returnvalues; - - Retourne les données décompressées ou &false; si une erreur survient. - - - - &reftitle.seealso; - - lzf_compress - - - - diff --git a/reference/lzf/functions/lzf-optimized-for.xml b/reference/lzf/functions/lzf-optimized-for.xml deleted file mode 100644 index 57dbff8282..0000000000 --- a/reference/lzf/functions/lzf-optimized-for.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - lzf_optimized_for - Détermine le mode d'optimisation de l'extension LZF - - - &reftitle.description; - - intlzf_optimized_for - - - - Détermine le mode d'optimisation de l'extension LZF. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne 1 si LZF a été optimisé pour la vitesse, 0 pour la compression. - - - - diff --git a/reference/lzf/reference.xml b/reference/lzf/reference.xml deleted file mode 100644 index cda35ef302..0000000000 --- a/reference/lzf/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; LZF - - &reference.lzf.entities.functions; - - - - diff --git a/reference/lzf/setup.xml b/reference/lzf/setup.xml deleted file mode 100644 index f9e5bcde1a..0000000000 --- a/reference/lzf/setup.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.lzf.configure; - - - - - - diff --git a/reference/mailparse/book.xml b/reference/mailparse/book.xml deleted file mode 100644 index 1469baba8f..0000000000 --- a/reference/mailparse/book.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - Mailparse - - - - &reftitle.intro; - - Mailparse est une extension pour analyser et travailler avec les messages électroniques. - Elle peut gérer les messages répondant aux RFC 822 et RFC 2045 (MIME). - - - Mailparse est basé sur les flux, ce qui signifie qu'il ne conserve pas en mémoire - les copies des fichiers dont il s'occupe - ainsi, il est peu coûteux en ressources - lorsqu'il traite de gros messages. - - - - Mailparse nécessite l'extension mbstring, - et mbstring doit être chargé avant mailparse. - - - - - - &reference.mailparse.setup; - &reference.mailparse.constants; - - &reference.mailparse.reference; - - - diff --git a/reference/mailparse/configure.xml b/reference/mailparse/configure.xml deleted file mode 100644 index 4fd297022e..0000000000 --- a/reference/mailparse/configure.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - -
    - &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;mailparse. - - - Pour utiliser ces fonctions, il faut compiler PHP avec le support - mailparse en utilisant l'option de configuration - . - - - Les utilisateurs de Windows doivent activer la bibliothèque - php_mailparse.dll dans le &php.ini; - pour pouvoir utiliser ces fonctions. - &pecl.windows.download.avail; - - - Il est nécessaire que l'extension mbstring - soit chargée avant mailparse. - -
    - diff --git a/reference/mailparse/constants.xml b/reference/mailparse/constants.xml deleted file mode 100644 index a99dfd200b..0000000000 --- a/reference/mailparse/constants.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - MAILPARSE_EXTRACT_OUTPUT - (int) - - - - - - - - - MAILPARSE_EXTRACT_STREAM - (int) - - - - - - - - - MAILPARSE_EXTRACT_RETURN - (int) - - - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml b/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml deleted file mode 100755 index 8a9f2d1d76..0000000000 --- a/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - mailparse_determine_best_xfer_encoding - Détermine le meilleur encodage pour un fichier - - - &reftitle.description; - - stringmailparse_determine_best_xfer_encoding - resourcefp - - - Détermine le meilleur encodage pour le contenu du fichier fourni. - - - - - &reftitle.parameters; - - - fp - - - Un pointeur de fichier valide, qui peut être lu. - - - - - - - - &reftitle.returnvalues; - - Retourne un encodage de caractères supporté par le module - mbstring. - - - - - - &reftitle.examples; - - Exemple avec <function>mailparse_determine_best_xfer_encoding</function> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-create.xml b/reference/mailparse/functions/mailparse-msg-create.xml deleted file mode 100755 index 024bbca7f6..0000000000 --- a/reference/mailparse/functions/mailparse-msg-create.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - mailparse_msg_create - Crée une ressource email mime - - - &reftitle.description; - - resourcemailparse_msg_create - - - - Crée une ressource email MIME. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un gestionnaire qui pourra être utilisé pour analyser un message. - - - - - &reftitle.notes; - - - Il est recommandé d'appeler mailparse_msg_free sur le - résultat de cette fonction, quand il n'est plus nécessaire, pour éviter - des fuites de mémoire. - - - - - - &reftitle.seealso; - - mailparse_msg_free - mailparse_msg_parse_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-extract-part-file.xml b/reference/mailparse/functions/mailparse-msg-extract-part-file.xml deleted file mode 100755 index ab3227cedb..0000000000 --- a/reference/mailparse/functions/mailparse-msg-extract-part-file.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - mailparse_msg_extract_part_file - Extrait et décode une section de message - - - &reftitle.description; - - stringmailparse_msg_extract_part_file - resourcemimemail - mixedfilename - callablecallbackfunc - - - Extrait et décode une section de message depuis le fichier fourni. - - - Le contenu de la section sera décodé suivant son encodage de transfert - - base64, quoted-printable et texte uuencoded sont supportés. - - - - - &reftitle.parameters; - - - mimemail - - - Une ressource valide MIME, créée avec - la fonction mailparse_msg_create. - - - - - filename - - - Peut être un nom de fichier ou un flux valide. - - - - - callbackfunc - - - Si défini, ce peut être soit un callback valide qui sera passé à la - section extraite, soit &null; pour faire que cette fonction retourne - la section extraite. - - - Si non fourni, le contenu sera envoyé à "stdout". - - - - - - - - &reftitle.returnvalues; - - Si callbackfunc ne vaut pas &null; retourne &true; - en cas de succès. - - - Si callbackfunc vaut &null;, retourne la section extraite - sous la forme d'une &string;. - - - Retourne &false; si une erreur survient. - - - - - &reftitle.seealso; - - mailparse_msg_extract_part - mailparse_msg_extract_whole_part_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-extract-part.xml b/reference/mailparse/functions/mailparse-msg-extract-part.xml deleted file mode 100644 index 2abcffb57e..0000000000 --- a/reference/mailparse/functions/mailparse-msg-extract-part.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - mailparse_msg_extract_part - Extrait et décode une section de message - - - &reftitle.description; - - voidmailparse_msg_extract_part - resourcemimemail - stringmsgbody - callablecallbackfunc - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - Une ressource MIME valide. - - - - - msgbody - - - - - - - callbackfunc - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - mailparse_msg_extract_part_file - mailparse_msg_extract_whole_part_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml b/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml deleted file mode 100644 index 4dd9e4320b..0000000000 --- a/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - mailparse_msg_extract_whole_part_file - Extrait une section de message incluant les en-têtes sans décoder l'encodage de transfert - - - &reftitle.description; - - stringmailparse_msg_extract_whole_part_file - resourcemimemail - stringfilename - callablecallbackfunc - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - Une ressource MIME valide. - - - - - filename - - - - - - - callbackfunc - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - mailparse_msg_extract_part - mailparse_msg_extract_part_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-free.xml b/reference/mailparse/functions/mailparse-msg-free.xml deleted file mode 100755 index 07cee42209..0000000000 --- a/reference/mailparse/functions/mailparse-msg-free.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - mailparse_msg_free - Libère une ressource MIME - - - &reftitle.description; - - boolmailparse_msg_free - resourcemimemail - - - Libère une ressource MIME. - - - - - &reftitle.parameters; - - - mimemail - - - Une ressource MIME allouée par la fonction - mailparse_msg_create ou la fonction - mailparse_msg_parse_file. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - mailparse_msg_create - mailparse_msg_parse_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-get-part-data.xml b/reference/mailparse/functions/mailparse-msg-get-part-data.xml deleted file mode 100755 index 1eeacc2601..0000000000 --- a/reference/mailparse/functions/mailparse-msg-get-part-data.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - mailparse_msg_get_part_data - Retourne un tableau associatif avec des informations sur le message - - - &reftitle.description; - - arraymailparse_msg_get_part_data - resourcemimemail - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - Une ressource MIME valide. - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-get-part.xml b/reference/mailparse/functions/mailparse-msg-get-part.xml deleted file mode 100755 index 5d2be58dd2..0000000000 --- a/reference/mailparse/functions/mailparse-msg-get-part.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - mailparse_msg_get_part - Retourne une ressource sur une section d'un message MIME - - - &reftitle.description; - - resourcemailparse_msg_get_part - resourcemimemail - stringmimesection - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - Une ressource MIME valide. - - - - - mimesection - - - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-get-structure.xml b/reference/mailparse/functions/mailparse-msg-get-structure.xml deleted file mode 100755 index 0890fd52a5..0000000000 --- a/reference/mailparse/functions/mailparse-msg-get-structure.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - mailparse_msg_get_structure - Retourne un tableau avec les différentes sections MIME du message - - - &reftitle.description; - - arraymailparse_msg_get_structure - resourcemimemail - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - Une ressource MIME valide. - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-parse-file.xml b/reference/mailparse/functions/mailparse-msg-parse-file.xml deleted file mode 100755 index c3c053c08b..0000000000 --- a/reference/mailparse/functions/mailparse-msg-parse-file.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - mailparse_msg_parse_file - Analyse un fichier - - - &reftitle.description; - - resourcemailparse_msg_parse_file - stringfilename - - - Analyse un fichier. C'est la façon optimale d'analyser un email qu'on a sur le disque. - - - - - &reftitle.parameters; - - - filename - - - Chemin vers le fichier contenant le message. - Le fichier sera ouvert et envoyé sous forme de flux à l'analyseur. - - - - Le message contenu dans le paramètre filename est - supposé se terminer avec un caractère de nouvelle ligne - (CRLF) ; sinon, la dernière ligne du message - ne sera pas analysée. - - - - - - - - - &reftitle.returnvalues; - - Retourne une ressource MIME représentant la structure, - ou &false; si une erreur survient. - - - - - &reftitle.notes; - - - Il est recommandé d'appeler mailparse_msg_free sur le - résultat de cette fonction, quand il n'est plus nécessaire, pour éviter - des fuites de mémoire. - - - - - - &reftitle.seealso; - - mailparse_msg_free - mailparse_msg_create - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-parse.xml b/reference/mailparse/functions/mailparse-msg-parse.xml deleted file mode 100755 index 5d0801fe5b..0000000000 --- a/reference/mailparse/functions/mailparse-msg-parse.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - mailparse_msg_parse - Analyse incrémentalement des données dans un buffer - - - &reftitle.description; - - boolmailparse_msg_parse - resourcemimemail - stringdata - - - Analyse incrémentalement des données dans une ressource MIME fournie. - - - Cette fonction permet d'envoyer sous forme de flux des portions d'un - fichier à la fois, plutôt que de tout lire et de tout analyser en une seule fois. - - - - - &reftitle.parameters; - - - mimemail - - - Une ressource MIME valide. - - - - - data - - - - Le bloc final d'un data est supposé être - un caractère de nouvelle ligne - (CRLF) ; sinon, la dernière ligne du message - ne sera pas analysée. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml b/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml deleted file mode 100755 index 4150bdd603..0000000000 --- a/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - mailparse_rfc822_parse_addresses - Analyse des adresses - - - &reftitle.description; - - arraymailparse_rfc822_parse_addresses - stringaddresses - - - Analyse une liste d'adresses valides eu égard à la RFC 822, - comme celles trouvées dans l'en-tête To:. - - - - - &reftitle.parameters; - - - addresses - - - Une &string; contenant les adresses, comme : - Wez Furlong <wez@example.com>, doe@example.com - - - - Cette &string; ne doit pas contenir le nom de l'en-tête. - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau de tableaux associatifs contenant les clés suivantes pour chaque - adresse : - - - - - display - - Le nom de l'adresse, aux fins d'affichage. Si cette partie n'est pas définie - pour une adresse, il contiendra la même valeur que la clé - address. - - - - address - L'adresse email - - - is_group - &true; si l'adresse est un newsgroup, &false; sinon. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>mailparse_rfc822_parse_addresses</function> - -, doe@example.com'; -var_dump(mailparse_rfc822_parse_addresses($to)); - -?> -]]> - - &example.outputs; - - - array(3) { - ["display"]=> - string(11) "Wez Furlong" - ["address"]=> - string(15) "wez@example.com" - ["is_group"]=> - bool(false) - } - [1]=> - array(3) { - ["display"]=> - string(15) "doe@example.com" - ["address"]=> - string(15) "doe@example.com" - ["is_group"]=> - bool(false) - } -} -]]> - - - - - - diff --git a/reference/mailparse/functions/mailparse-stream-encode.xml b/reference/mailparse/functions/mailparse-stream-encode.xml deleted file mode 100755 index b903771421..0000000000 --- a/reference/mailparse/functions/mailparse-stream-encode.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - mailparse_stream_encode - - Lit les données dans un fichier, applique l'encodage et envoie le résultat à destfp - - - - &reftitle.description; - - boolmailparse_stream_encode - resourcesourcefp - resourcedestfp - stringencoding - - - Lit les données dans un fichier, applique l'encodage encoding - et envoie le résultat à destfp. - - - - - &reftitle.parameters; - - - sourcefp - - - Un gestionnaire de fichier valide. Le fichier sera envoyé à l'analyseur sous forme de flux. - - - - - destfp - - - Le gestionnaire de fichier destinataire, dans lequel les données encodées - seront écrites. - - - - - encoding - - - Un des encodages de caractères supportés par le module - mbstring. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>mailparse_stream_encode</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-uudecode-all.xml b/reference/mailparse/functions/mailparse-uudecode-all.xml deleted file mode 100755 index ffcf5563d0..0000000000 --- a/reference/mailparse/functions/mailparse-uudecode-all.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - mailparse_uudecode_all - - Scanne les données du fichier et extrait tous les fichiers encodés qui s'y trouvent - - - - &reftitle.description; - - arraymailparse_uudecode_all - resourcefp - - - Scanne les données du fichier fourni et extrait, dans un fichier temporaire, tous les fichiers encodés qui s'y trouvent. - - - - - &reftitle.parameters; - - - fp - - - Un pointeur de fichier valide. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau de tableaux associatifs listant les informations sur les - noms de fichiers. - - - - - filename - Chemin vers le fichier temporaire à créer - - - origfilename - Le nom de fichier original, pour les sections uuencoded uniquement - - - - - La première entrée du fichier est le corps du message. Les entrées suivantes - sont les fichiers décodés uuencoded. - - - - - &reftitle.examples; - - Exemple avec <function>mailparse_uudecode_all</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/mailparse/reference.xml b/reference/mailparse/reference.xml deleted file mode 100755 index 0ad35978f7..0000000000 --- a/reference/mailparse/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; Mailparse - - &reference.mailparse.entities.functions; - - - - diff --git a/reference/mailparse/setup.xml b/reference/mailparse/setup.xml deleted file mode 100644 index cd71a2c934..0000000000 --- a/reference/mailparse/setup.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - &reftitle.setup; - - - &reference.mailparse.configure; - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Mailparse &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mailparse.def_charset - "us-ascii" - INI_SYSTEM - - - - -
    - &ini.php.constants; -     - - &ini.descriptions.title; - - - - - mailparse.def_charset - string - - - - Le jeu de caractères par défaut. - - - - -
    - - - -
    - &reftitle.resources; - - Mailparse définit le type de ressource mailparse_mail_structure, - qui est retourné par mailparse_msg_create et - mailparse_msg_parse_file. - -
    - - -     - diff --git a/reference/mcrypt/book.xml b/reference/mcrypt/book.xml deleted file mode 100644 index 602ce55b66..0000000000 --- a/reference/mcrypt/book.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - Mcrypt - - - - &reftitle.intro; - - &warn.deprecated.feature.7-1-0.removed.7-2-0.alternatives; - - - Sodium - (disponible à partir de PHP 7.2.0) - - - OpenSSL - - - - - - - &pecl.moved-ver;7.2.0. - - - - Ces fonctions permettent d'accéder à la bibliothèque - mcrypt, qui dispose d'une grande variété d'algorithmes - de chiffrement, tels DES, TripleDES, Blowfish (par défaut), 3-WAY, - SAFER-SK64, SAFER-SK128, TWOFISH, TEA, RC2 et GOST en modes CBC, - OFB, CFB et ECB. De plus, elles acceptent aussi RC6 et IDEA qui sont - considérés comme "non-libres". - CFB/OFB est sur 8bit par défaut. - - - - - &reference.mcrypt.setup; - &reference.mcrypt.constants; - &reference.mcrypt.ciphers; - &reference.mcrypt.reference; - - - diff --git a/reference/mcrypt/ciphers.xml b/reference/mcrypt/ciphers.xml deleted file mode 100644 index 615336019c..0000000000 --- a/reference/mcrypt/ciphers.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Chiffrements Mcrypt - - Voici une liste non exhaustive des chiffrements de l'extension - mcrypt. Pour disposer d'une liste complète des chiffrements supportés, - voir les définitions dans le fichier mcrypt.h. La règle - générale avec l'API mcrypt-2.2.x est qu'il est possible d'accéder au - mode de chiffrement via PHP avec la constante MCRYPT_ciphername. Avec - la bibliothèque libmcrypt-2.4.x et libmcrypt-2.5.x, ces constantes fonctionnent - toujours, mais il est possible de spécifier le nom du chiffrement dans une chaîne, - lors de l'appel à mcrypt_module_open. - - MCRYPT_3DES - MCRYPT_ARCFOUR_IV (libmcrypt > 2.4.x uniquement) - MCRYPT_ARCFOUR (libmcrypt > 2.4.x uniquement) - MCRYPT_BLOWFISH - MCRYPT_CAST_128 - MCRYPT_CAST_256 - MCRYPT_CRYPT - MCRYPT_DES - MCRYPT_DES_COMPAT (libmcrypt 2.2.x uniquement) - MCRYPT_ENIGMA (libmcrypt > 2.4.x uniquement, alias de MCRYPT_CRYPT) - MCRYPT_GOST - MCRYPT_IDEA (non libre) - MCRYPT_LOKI97 (libmcrypt > 2.4.x uniquement) - MCRYPT_MARS (libmcrypt > 2.4.x uniquement, non libre) - MCRYPT_PANAMA (libmcrypt > 2.4.x uniquement) - MCRYPT_RIJNDAEL_128 (libmcrypt > 2.4.x uniquement) - MCRYPT_RIJNDAEL_192 (libmcrypt > 2.4.x uniquement) - MCRYPT_RIJNDAEL_256 (libmcrypt > 2.4.x uniquement) - MCRYPT_RC2 - MCRYPT_RC4 (libmcrypt 2.2.x uniquement) - MCRYPT_RC6 (libmcrypt > 2.4.x uniquement) - MCRYPT_RC6_128 (libmcrypt 2.2.x uniquement) - MCRYPT_RC6_192 (libmcrypt 2.2.x uniquement) - MCRYPT_RC6_256 (libmcrypt 2.2.x uniquement) - MCRYPT_SAFER64 - MCRYPT_SAFER128 - MCRYPT_SAFERPLUS (libmcrypt > 2.4.x uniquement) - MCRYPT_SERPENT(libmcrypt > 2.4.x uniquement) - MCRYPT_SERPENT_128 (libmcrypt 2.2.x uniquement) - MCRYPT_SERPENT_192 (libmcrypt 2.2.x uniquement) - MCRYPT_SERPENT_256 (libmcrypt 2.2.x uniquement) - MCRYPT_SKIPJACK (libmcrypt > 2.4.x uniquement) - MCRYPT_TEAN (libmcrypt 2.2.x uniquement) - MCRYPT_THREEWAY - MCRYPT_TRIPLEDES (libmcrypt > 2.4.x uniquement) - MCRYPT_TWOFISH (pour les anciennes versions de mcrypt 2.x ou mcrypt > 2.4.x ) - MCRYPT_TWOFISH128 (TWOFISHxxx est disponible dans les nouvelles versions 2.x, - mais pas dans les versions 2.4.x) - MCRYPT_TWOFISH192 - MCRYPT_TWOFISH256 - MCRYPT_WAKE (libmcrypt > 2.4.x uniquement) - MCRYPT_XTEA (libmcrypt > 2.4.x uniquement) - - - - Il faut (mode CFB et OFB) - ou il est possible de (mode CBC) fournir un vecteur d'initialisation - (IV) pour ces modes de chiffrement. IV doit être unique, et avoir la même - valeur au chiffrement et au déchiffrement. Pour des données qui seront - enregistrées après chiffrement, il est possible de prendre le résultat d'une - fonction telle que MD5, appliquée sur le nom du fichier. Sinon, l'on - peut envoyer le IV avec les données chiffrées, (se reporter au chapitre - 9.3 de &book.applied.cryptography; de Schneier (ISBN 0-471-11709-9) - pour plus de détails sur le sujet). - - - diff --git a/reference/mcrypt/configure.xml b/reference/mcrypt/configure.xml deleted file mode 100644 index 9813da11d8..0000000000 --- a/reference/mcrypt/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - -
    - &reftitle.install; - - &pecl.moved-ver;7.2.0 - - - &pecl.info; - &url.pecl.package;mcrypt. - -
    - diff --git a/reference/mcrypt/constants.xml b/reference/mcrypt/constants.xml deleted file mode 100644 index 426481e4dc..0000000000 --- a/reference/mcrypt/constants.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Mcrypt peut opérer en 4 modes de chiffrement (CBC, - OFB, CFB, et ECB). - Si lié contre libmcrypt-2.4.x ou ultérieur, les fonctions peuvent - aussi opérer en mode nOFB et en mode STREAM. - Ci-dessous se trouve une liste avec tous les modes de chiffrement supportés avec - les constantes qui sont définies pour le mode de chiffrement. Pour une référence - plus complète et des discussions voir &book.applied.cryptography;. - - - - MCRYPT_MODE_ECB (electronic codebook) - est un mode de chiffrement par bloc qui est généralement inapproprié à la plupart - des utilisations. L'utilisation de ce mode est déconseillée. - - - - - MCRYPT_MODE_CBC (cipher block chaining) - est un mode de chiffrement par bloc qui est considérablement plus sécurisé que - le mode ECB. - - - - - MCRYPT_MODE_CFB (cipher feedback, - in 8-bit mode) est un mode de chiffrement par flot. - Il est conseillé d'utiliser le mode NCFB plutôt - que le mode CFB. - - - - - MCRYPT_MODE_OFB (output feedback, in - 8bit) est un mode de chiffrement par flot comparable à - CFB, mais peut être utilisé dans des applications où la - propagation d'erreur ne peut être tolérée. - Il est conseillé d'utiliser le mode NOFB plutôt - que le mode OFB. - - - - - MCRYPT_MODE_NOFB (output feedback, - in n-bit mode) est comparable au mode OFB, - mais opère sur la taille de bloc complète de l'algorithme. - - - - - MCRYPT_MODE_STREAM est un mode supplémentaire, pour inclure - des algorithmes de flot tels que "WAKE" ou "RC4". - - - - - - - Mcrypt supporte d'autres modes d'opération pour lesquels il n'y a pas de constantes - prédéfinies. - Ils peuvent être utilisés en passant une &string; à la place des constantes manquantes. - - - - "ctr" (counter mode) est un mode de chiffrement par flot. - - - - - "ncfb" (cipher feedback, - in n-bit mode) est comparable au mode CFB, - mais opère sur la taille de bloc complète de l'algorithme. - - - - - - - Voici quelques autres constantes de modes et de périphériques aléatoires : - - - - MCRYPT_ENCRYPT - (int) - - - - - - - - - - MCRYPT_DECRYPT - (int) - - - - - - - - - - MCRYPT_DEV_RANDOM - (int) - - - - - - - - - - MCRYPT_DEV_URANDOM - (int) - - - - - - - - - - MCRYPT_RAND - (int) - - - - - - - - - - - - diff --git a/reference/mcrypt/functions/mcrypt-create-iv.xml b/reference/mcrypt/functions/mcrypt-create-iv.xml deleted file mode 100644 index 4bdeac2092..0000000000 --- a/reference/mcrypt/functions/mcrypt-create-iv.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - mcrypt_create_iv - Crée un vecteur d'initialisation (IV) à partir d'une source aléatoire - - - - - &warn.deprecated.function.7-1-0.removed.7-2-0.alternatives; - - random_bytes - - - - - - &reftitle.description; - - stringmcrypt_create_iv - intsize - intsourceMCRYPT_DEV_URANDOM - - - mcrypt_create_iv crée un IV - (vecteur d'initialisation) à partir d'une source aléatoire. - - - Le vecteur d'initialisation est le seul moyen de fournir une initialisation - de remplacement aux méthodes d'initialisation. Ce vecteur n'a pas besoin - d'être particulièrement secret, même si c'est mieux. Il est possible de l'envoyer - avec les documents chiffrés sans perdre en sécurité. - - - - - &reftitle.parameters; - - - size - - - La taille du vecteur. - - - - - source - - - La source d'un IV. La source peut être MCRYPT_RAND (le générateur - de nombre aléatoire du système), MCRYPT_DEV_RANDOM - (lit les données depuis /dev/random) et - MCRYPT_DEV_URANDOM (lit les données depuis - /dev/urandom). Avant la version 5.3.0, - MCRYPT_RAND était la seule constante - supportée par Windows. - - - À noter que la valeur par défaut de ce paramètre était - MCRYPT_DEV_RANDOM avant PHP 5.6.0. - - - - À noter que la constante MCRYPT_DEV_RANDOM - peut se bloquer en attendant que plus d'entropie ne soit disponible. - - - - - - - - - &reftitle.returnvalues; - - Retourne le vecteur d'initialisation, ou bien &false; en cas d'erreur. - - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_create_iv</function> - - -]]> - - - - - - &reftitle.seealso; - - &url.mcrypt.iv; - &url.mcrypt.bcm; - Chapter 9.3 of &book.applied.cryptography; - random_bytes - - - - diff --git a/reference/mcrypt/functions/mcrypt-decrypt.xml b/reference/mcrypt/functions/mcrypt-decrypt.xml deleted file mode 100644 index 77f6401816..0000000000 --- a/reference/mcrypt/functions/mcrypt-decrypt.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - mcrypt_decrypt - Déchiffre un texte avec les paramètres donnés - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - stringfalsemcrypt_decrypt - stringcipher - stringkey - stringdata - stringmode - stringiv - - - Déchiffre les données data et retourne les données déchiffrées. - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - key - - - La clé utilisée lors du chiffrement des données. Si la taille de la clé - fournie n'est pas supportée par le cipher, la fonction émettra un - warning et retournera &false; - - - - - data - - - Les données qui seront déchiffrées en utilisant les paramètres - cipher et mode. - Si la taille des données ne correspond pas à n * la taille du bloc, - les données seront complétées par des '\0'. - - - - - mode - - &mcrypt.parameter.mode; - - - - iv - - &mcrypt.parameter.iv.strict; - - - - - - - &reftitle.returnvalues; - - Retourne les données déchiffrées sous la forme d'une &string; - &return.falseforfailure;. - - - - - &reftitle.seealso; - - mcrypt_encrypt - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml b/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml deleted file mode 100644 index f9fa2e6770..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - mcrypt_enc_get_algorithms_name - Retourne le nom de l'algorithme de chiffrement - - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - stringmcrypt_enc_get_algorithms_name - resourcetd - - - mcrypt_enc_get_algorithms_name retourne le nom de - l'algorithme utilisé par td. - - - - - &reftitle.parameters; - - - td - - - La ressource de chiffrement. - - - - - - - - &reftitle.returnvalues; - - Retourne le nom de l'algorithme courant, sous forme de &string; - - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_enc_get_algorithms_name</function> - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml deleted file mode 100644 index 132a743e4a..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - mcrypt_enc_get_block_size - Retourne la taille du bloc d'un algorithme - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_enc_get_block_size - resourcetd - - - Récupère la taille du bloc d'un algorithme. - - - - &reftitle.parameters; - - - td - - - Le pointeur de fichiers. - - - - - - - &reftitle.returnvalues; - - Retourne la taille du bloc de l'algorithme, en octets. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml deleted file mode 100644 index 658960d069..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - mcrypt_enc_get_iv_size - Retourne la taille du VI d'un algorithme - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_enc_get_iv_size - resourcetd - - - Cette fonction retourne la taille du VI de l'algorithme désigné - par td, en octets. Si la valeur retournée - est 0, c'est que l'algorithme ne demande pas de VI. Un VI est - demandé en mode "cbc", "cfb" et - "ofb", et parfois en mode "stream". - - - - &reftitle.parameters; - - - td - - - Le pointeur de fichiers. - - - - - - - &reftitle.returnvalues; - - Retourne la taille du IV, ou &zero; si l'IV est ignoré par l'algorithme. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml deleted file mode 100644 index d4796208e3..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - mcrypt_enc_get_key_size - Retourne la taille maximale de la clé pour un mode - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_enc_get_key_size - resourcetd - - - Retourne la taille maximale de la clé pour un mode donné. - - - - &reftitle.parameters; - - - td - - - Le pointeur de fichier. - - - - - - - &reftitle.returnvalues; - - Retourne la taille maximale de la clé pour le mode donné. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml b/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml deleted file mode 100644 index 8eca8408c6..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - mcrypt_enc_get_modes_name - Retourne le nom du mode - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - stringmcrypt_enc_get_modes_name - resourcetd - - - Retourne le nom du mode. - - - - &reftitle.parameters; - - - td - - - La ressource de chiffrement. - - - - - - - &reftitle.returnvalues; - - Retourne le nom, sous la forme d'une &string;. - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_enc_get_modes_name</function> - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml b/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml deleted file mode 100644 index e5241dfb33..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - mcrypt_enc_get_supported_key_sizes - Retourne un tableau contenant les tailles de clés acceptées par un algorithme - - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - arraymcrypt_enc_get_supported_key_sizes - resourcetd - - - mcrypt_enc_get_supported_key_sizes lit - les tailles de clés supportées par l'algorithme courant de - la ressource de chiffrement td. - - - - - &reftitle.parameters; - - - td - - - La ressource de chiffrement. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les tailles des clés supportées par l'algorithme - désigné par td. S'il retourne un tableau - vide, c'est que toutes les clés entre 1 et - mcrypt_enc_get_key_size sont acceptées par - l'algorithme. - - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_enc_get_supported_key_sizes</function> - - -]]> - - &example.outputs; - - - int(16) - [1]=> - int(24) - [2]=> - int(32) -} -]]> - - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml deleted file mode 100644 index bdce1c6d30..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - mcrypt_enc_is_block_algorithm_mode - Teste le chiffrement par blocs d'un mode - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_enc_is_block_algorithm_mode - resourcetd - - - Teste le chiffrement par blocs d'un mode (p. ex. - &false; pour un flux, et &true; pour "cbc", "cfb", "ofb"). - - - - &reftitle.parameters; - - - td - - - La ressource de chiffrement. - - - - - - - &reftitle.returnvalues; - - Retourne &true; si ce mode utilise des algorithmes par blocs, et &false; sinon. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml deleted file mode 100644 index f9e19897d1..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - mcrypt_enc_is_block_algorithm - Teste le chiffrement par blocs d'un algorithme - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_enc_is_block_algorithm - resourcetd - - - Teste le chiffrement par blocs d'un algorithme. - - - - &reftitle.parameters; - - - td - - - La ressource de chiffrement. - - - - - - - &reftitle.returnvalues; - - Retourne &true; si l'algorithme utilisé est un algorithme par blocs, et &false; - si c'est un algorithme par flux. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml deleted file mode 100644 index 938942d79a..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - mcrypt_enc_is_block_mode - Teste si le mode retourne les données par blocs - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_enc_is_block_mode - resourcetd - - - Teste si le mode retourne les données par blocs (p. ex. &true; pour "cbc" - et "ecb", et &false; pour "cfb" et un flux). - - - - &reftitle.parameters; - - - td - - - La ressource de chiffrement. - - - - - - - &reftitle.returnvalues; - - Retourne &true; si le mode retourne des blocs d'octets, - ou bien &false; s'il ne retourne que des octets. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-self-test.xml b/reference/mcrypt/functions/mcrypt-enc-self-test.xml deleted file mode 100644 index 1af9633f5f..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-self-test.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - mcrypt_enc_self_test - Teste un module ouvert - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_enc_self_test - resourcetd - - - Effectue un test du module ouvert et désigné par td. - - - - &reftitle.parameters; - - - td - - - La ressource de chiffrement. - - - - - - - &reftitle.returnvalues; - - Retourne 0 en cas de succès ou un &integer; négatif en - cas d'échec. - - - - diff --git a/reference/mcrypt/functions/mcrypt-encrypt.xml b/reference/mcrypt/functions/mcrypt-encrypt.xml deleted file mode 100644 index fb14b66b99..0000000000 --- a/reference/mcrypt/functions/mcrypt-encrypt.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - - mcrypt_encrypt - Chiffre un texte - - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - stringfalsemcrypt_encrypt - stringcipher - stringkey - stringdata - stringmode - stringiv - - - mcrypt_encrypt chiffre les données, et retourne - les données chiffrées. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - key - - - La clé avec laquelle les données seront chiffrées. Si la taille de la clé - fournie n'est pas supportée par le cipher, la fonction émettra un - warning et retournera &false; - - - - - data - - - Les données qui seront chiffrées, avec le cipher et le - mode indiqué. - Si la taille des données n'est pas un multiple de la taille de bloc, - les données seront complétées par des caractères '\0', - autant que nécessaire. - - - Le texte chiffré retourné peut être plus long que la taille des données - passées en argument via data. - - - - - mode - - &mcrypt.parameter.mode; - - - - iv - - &mcrypt.parameter.iv.strict; - - - - - - - &reftitle.returnvalues; - - Retourne les données chiffrées, sous forme de &string; &return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_encrypt</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - mcrypt_decrypt - mcrypt_module_open - - - - diff --git a/reference/mcrypt/functions/mcrypt-generic-deinit.xml b/reference/mcrypt/functions/mcrypt-generic-deinit.xml deleted file mode 100644 index 373631105b..0000000000 --- a/reference/mcrypt/functions/mcrypt-generic-deinit.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - mcrypt_generic_deinit - Prépare le module pour le déchargement - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - boolmcrypt_generic_deinit - resourcetd - - - Prépare le module de chiffrement td pour le déchargement. - Tous les tampons sont vidés, mais le module n'est pas déchargé. - Il faut appeler mcrypt_module_close soi-même - (mais PHP le fera automatiquement à la fin du script). - - - - - &reftitle.parameters; - - - td - - - La ressource de chiffrement. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - mcrypt_module_open - mcrypt_generic_init - - - - diff --git a/reference/mcrypt/functions/mcrypt-generic-init.xml b/reference/mcrypt/functions/mcrypt-generic-init.xml deleted file mode 100644 index db3f273e26..0000000000 --- a/reference/mcrypt/functions/mcrypt-generic-init.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - mcrypt_generic_init - Initialise tous les tampons nécessaires - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_generic_init - resourcetd - stringkey - stringiv - - - Il faut appeler mcrypt_generic_init - avant chaque appel à mcrypt_generic ou - mdecrypt_generic. - - - - &reftitle.parameters; - - - td - - - La ressource de chiffrement. - - - - - key - - - La taille maximale de la clé doit être celle retournée par - mcrypt_enc_get_key_size et toutes les valeurs - inférieures seront aussi valides. - - - - - iv - - - Le vecteur d'initialisation (VI) doit avoir la taille d'un bloc, - mais il faut lire sa taille en appelant - mcrypt_enc_get_iv_size. IV est ignoré en mode - ECB. IV DOIT exister en modes "CFB", - "CBC", "STREAM", "nOFB" - et "OFB". Il doit être aléatoire et unique (mais pas secret). - Le même VI doit être utilisé pour le chiffrement et le déchiffrement. - Si l'on ne veut pas l'utiliser, il suffit de le remplir de zéros, mais - ce n'est pas recommandé. - - - - - - - &reftitle.returnvalues; - - Retourne une valeur négative en cas d'erreur : -3 si la taille - de la clé est incorrecte, -4 quand il y a eu un problème d'allocation de - mémoire et toute autre valeur en cas d'erreur inconnue. Si une erreur - survient, une alerte est affichée. &false; est retourné si des paramètres - incorrects sont passés à la fonction. - - - - &reftitle.seealso; - - mcrypt_module_open - - - - diff --git a/reference/mcrypt/functions/mcrypt-generic.xml b/reference/mcrypt/functions/mcrypt-generic.xml deleted file mode 100644 index 35b63048f4..0000000000 --- a/reference/mcrypt/functions/mcrypt-generic.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - mcrypt_generic - Chiffre les données - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - stringmcrypt_generic - resourcetd - stringdata - - - mcrypt_generic chiffre les données - data. Les données sont complétées - par des "\0" pour obtenir une taille multiple de la taille - d'un bloc. Elle retourne les données chiffrées. À noter que la longueur - de la chaîne retournée peut être plus longue que celle - passée en argument, à cause du complément. - - - Pour enregistrer les données chiffrées dans une base de données - il faut s'assurer d'enregistrer la chaîne entière retournée par cette fonction, - sinon la chaîne ne sera pas déchiffrée correctement. Si la chaîne d'origine - comporte 10 caractères et que la taille d'un bloc est de 8 (utiliser - mcrypt_enc_get_block_size pour déterminer cette taille), - on aura besoin d'au moins 16 caractères dans le champ de la base de données. - À noter que la chaîne retournée par mdecrypt_generic aura - 16 caractères de long... utiliser rtrim($str, "\0") - pour supprimer le complément. - - - Par exemple, si on enregistre les données dans une base de données MySQL, - il faut se souvenir que les champs de type VARCHAR suppriment automatiquement les - espaces en trop durant l'insertion. Comme les données chiffrées peuvent se - terminer avec un espace (ASCII 32), les données seront endommagées par cette - suppression. Stockez les données dans un champ de type TINYBLOB/TINYTEXT - (ou plus grand) pour que tout fonctionne normalement. - - - - - &reftitle.parameters; - - - td - - - La ressource de chiffrement. - - - Le gestionnaire de chiffrement td doit être - initialisé avec la fonction mcrypt_generic_init, - avec une clé et un VI, avant d'appeler cette fonction. Lorsque le chiffrement - est réalisé, il faut libérer les buffers en appelant la fonction - mcrypt_generic_deinit. - Voir mcrypt_module_open pour un exemple. - - - - - data - - - Les données à chiffrer. - - - - - - - - &reftitle.returnvalues; - - Retourne les données chiffrées. - - - - - &reftitle.seealso; - - mdecrypt_generic - mcrypt_generic_init - mcrypt_generic_deinit - - - - - diff --git a/reference/mcrypt/functions/mcrypt-get-block-size.xml b/reference/mcrypt/functions/mcrypt-get-block-size.xml deleted file mode 100644 index 6e3be1e481..0000000000 --- a/reference/mcrypt/functions/mcrypt-get-block-size.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - mcrypt_get_block_size - Retourne la taille de blocs d'un chiffrement - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - intfalsemcrypt_get_block_size - intcipher - - - intfalsemcrypt_get_block_size - stringcipher - stringmode - - - Le premier prototype sert lorsque PHP est compilé avec la bibliothèque - libmcrypt 2.2.x, le second lorsqu'il est compilé avec - libmcrypt 2.4.x ou 2.5.x. - - - mcrypt_get_block_size sert à lire la taille - de blocs du chiffrement cipher (en - combinaison avec un mode de chiffrement). - - - Il est recommandé de se servir de la fonction - mcrypt_enc_get_block_size, - car elle utilise la ressource retournée par - mcrypt_module_open. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - mode - - &mcrypt.parameter.mode; - - - - - - - &reftitle.returnvalues; - - Lit la taille de bloc, sous forme d'un &integer;. - - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_get_block_size</function> - - Cet exemple montre comment utiliser cette fonction lorsque PHP - est compilé avec libmcrypt 2.4.x et 2.5.x. - - - -]]> - - - - - - &reftitle.seealso; - - mcrypt_get_key_size - mcrypt_enc_get_block_size - mcrypt_encrypt - - - - diff --git a/reference/mcrypt/functions/mcrypt-get-cipher-name.xml b/reference/mcrypt/functions/mcrypt-get-cipher-name.xml deleted file mode 100644 index 9a5a46b625..0000000000 --- a/reference/mcrypt/functions/mcrypt-get-cipher-name.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - mcrypt_get_cipher_name - Lit le nom du chiffrement utilisé - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - stringmcrypt_get_cipher_name - intcipher - - - stringmcrypt_get_cipher_name - stringcipher - - - mcrypt_get_cipher_name retourne le nom du chiffrement - utilisé. - - - mcrypt_get_cipher_name prend le numéro de - chiffrement (avec libmcrypt 2.2.x) ou prend le nom du chiffrement - (avec libmcrypt 2.4.x) comme paramètre, et retourne le nom du - chiffrement, ou &false;, s'il n'existe pas. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - - - - &reftitle.returnvalues; - - Cette fonction retourne le nom du cipher ou &false; si le cipher n'existe pas. - - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_get_cipher_name</function> - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mcrypt/functions/mcrypt-get-iv-size.xml b/reference/mcrypt/functions/mcrypt-get-iv-size.xml deleted file mode 100644 index e9c8f3107b..0000000000 --- a/reference/mcrypt/functions/mcrypt-get-iv-size.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - mcrypt_get_iv_size - Retourne la taille du VI utilisé par un couple chiffrement/mode - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - intmcrypt_get_iv_size - stringcipher - stringmode - - - mcrypt_get_iv_size retourne la taille du - vecteur d'initialisation (VI). Si l'algorithme n'utilise - pas de vecteur d'initialisation, zéro est retourné. - - - Il est plus utile d'utiliser la fonction mcrypt_enc_get_iv_size, - car elle utilise la ressource retournée par mcrypt_module_open. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - mode - - &mcrypt.parameter.mode; - - IV est ignoré en mode ECB sachant que ce mode ne le demande pas. - Il faut avoir le même IV (point de départ) lors du chiffrement - et du déchiffrement, sinon, le chiffrement échouera. - - - - - - - - &reftitle.returnvalues; - - Retourne la taille du vecteur d'initialisation (IV), en octets. - En cas d'erreur, la fonction retourne &false;. Si le vecteur d'initialisation - est inutile, 0 est retourné. - - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_get_iv_size</function> - - -]]> - - - - - - &reftitle.seealso; - - mcrypt_get_block_size - mcrypt_enc_get_iv_size - mcrypt_create_iv - - - - - diff --git a/reference/mcrypt/functions/mcrypt-get-key-size.xml b/reference/mcrypt/functions/mcrypt-get-key-size.xml deleted file mode 100644 index 4245b7f66f..0000000000 --- a/reference/mcrypt/functions/mcrypt-get-key-size.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - mcrypt_get_key_size - Retourne la taille de la clé de chiffrement - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - intfalsemcrypt_get_key_size - intcipher - - - intfalsemcrypt_get_key_size - stringcipher - stringmode - - - La première syntaxe utilise libmcrypt 2.2.x, et la seconde - libmcrypt 2.4.x ou plus récent. - - - mcrypt_get_key_size sert à lire la taille de - clé du chiffrement cipher. - - - Il est plus intéressant d'utiliser la fonction - mcrypt_enc_get_key_size sachant qu'elle utilise la ressource - retournée par la fonction mcrypt_module_open. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - mode - - &mcrypt.parameter.mode; - - - - - - - &reftitle.returnvalues; - - Retourne la taille maximale supportée pour une clé de l'algorithme, en octets - &return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_get_key_size</function> - - -]]> - - - L'exemple ci-dessus montre l'utilisation de la fonction - lorsqu'elle a été compilée avec la bibliothèque - 2.4.x ou 2.5.x. - - &example.outputs; - - - - - - - - &reftitle.seealso; - - mcrypt_get_block_size - mcrypt_enc_get_key_size - mcrypt_encrypt - - - - - diff --git a/reference/mcrypt/functions/mcrypt-list-algorithms.xml b/reference/mcrypt/functions/mcrypt-list-algorithms.xml deleted file mode 100644 index 931e8f9818..0000000000 --- a/reference/mcrypt/functions/mcrypt-list-algorithms.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - mcrypt_list_algorithms - Liste tous les algorithmes de chiffrement supportés - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - arraymcrypt_list_algorithms - stringlib_dirini_get("mcrypt.algorithms_dir") - - - Liste tous les algorithmes de chiffrement de lib_dir. - - - - - &reftitle.parameters; - - - lib_dir - - - Spécifie le dossier où les algorithmes sont situés. Si omis, - la valeur de la directive mcrypt.algorithms_dir du fichier - &php.ini; est utilisée. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les algorithmes supportés. - - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_list_algorithms</function> - - -]]> - - &example.outputs.similar; - - cast-128 - [1] => gost - [2] => rijndael-128 - [3] => twofish - [4] => arcfour - [5] => cast-256 - [6] => loki97 - [7] => rijndael-192 - [8] => saferplus - [9] => wake - [10] => blowfish-compat - [11] => des - [12] => rijndael-256 - [13] => serpent - [14] => xtea - [15] => blowfish - [16] => enigma - [17] => rc2 - [18] => tripledes -) -]]> - - - - - diff --git a/reference/mcrypt/functions/mcrypt-list-modes.xml b/reference/mcrypt/functions/mcrypt-list-modes.xml deleted file mode 100644 index dbafd70029..0000000000 --- a/reference/mcrypt/functions/mcrypt-list-modes.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - mcrypt_list_modes - Liste tous les modes de chiffrement supportés - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - arraymcrypt_list_modes - stringlib_dirini_get("mcrypt.modes_dir") - - - Liste tous les modes de chiffrement de lib_dir. - - - - - &reftitle.parameters; - - - lib_dir - - - Spécifie le dossier où tous les modes sont situés. - Si omis, la valeur de la directive mcrypt.modes_dir - dans le &php.ini; est utilisée. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec tous les modes supportés. - - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_list_modes</function> - -\n"; -} -?> -]]> - - - L'exemple ci-dessus va afficher tous les modes supportés - dans le dossier par défaut. Si le mode n'est pas défini - par la directive mcrypt.modes_dir du &php.ini;, - le dossier par défaut de mcrypt sera utilisé (soit le dossier - /usr/local/lib/libmcrypt). - - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-close.xml b/reference/mcrypt/functions/mcrypt-module-close.xml deleted file mode 100644 index ca31815214..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-close.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - mcrypt_module_close - Décharge le module de chiffrement - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_module_close - resourcetd - - - Décharge le module td. - - - - &reftitle.parameters; - - - td - - - La ressource de chiffrement. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - mcrypt_module_open - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml b/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml deleted file mode 100644 index bde2ab8112..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - mcrypt_module_get_algo_block_size - Retourne la taille de blocs d'un algorithme - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_module_get_algo_block_size - stringalgorithm - stringlib_dir - - - Retourne la taille de blocs d'un algorithme. - - - - &reftitle.parameters; - - - algorithm - - - Le nom de l'algorithme. - - - - - lib_dir - - - Le paramètre optionnel lib_dir contient le - chemin jusqu'au module de l'algorithme sur le système. - - - - - - - &reftitle.returnvalues; - - Retourne la taille de blocs d'un algorithme, en octets. - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml b/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml deleted file mode 100644 index 54b62a32b8..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - mcrypt_module_get_algo_key_size - Retourne la taille maximale de clé - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_module_get_algo_key_size - stringalgorithm - stringlib_dir - - - Retourne la taille maximale de clé. - - - - &reftitle.parameters; - - - algorithm - - - Le nom de l'algorithme. - - - - - lib_dir - - - Le paramètre optionnel lib_dir contient le chemin - jusqu'au module de l'algorithme sur le système. - - - - - - - &reftitle.returnvalues; - - Retourne la taille maximale de la clé supportée par l'algorithme - algorithm. - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml b/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml deleted file mode 100644 index 6eaac8f7b7..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - mcrypt_module_get_supported_key_sizes - Retourne un tableau contenant les tailles de clés supportées par l'algorithme ouvert - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - arraymcrypt_module_get_supported_key_sizes - stringalgorithm - stringlib_dir - - - Retourne un tableau contenant les tailles de clés supportées par - l'algorithme de chiffrement algorithm. - S'il retourne un tableau vide, alors toutes les clés entre - 1 et mcrypt_module_get_algo_key_size sont - supportées par l'algorithme. - - - - &reftitle.parameters; - - - algorithm - - - L'algorithme à utiliser. - - - - - lib_dir - - - Le paramètre optionnel - lib_dir peut contenir le chemin - du dossier d'installation du module, sur le système. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les tailles de clés supportées par - l'algorithme de chiffrement algorithm. - S'il retourne un tableau vide, alors toutes les clés entre - 1 et mcrypt_module_get_algo_key_size sont - supportées par l'algorithme. - - - - - &reftitle.seealso; - - mcrypt_enc_get_supported_key_sizes - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml deleted file mode 100644 index c0266ba4c3..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - mcrypt_module_is_block_algorithm_mode - Indique si un mode fonctionne par blocs - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - boolmcrypt_module_is_block_algorithm_mode - stringmode - stringlib_dir - - - Cette fonction retourne &true; si le mode doit être utilisé - avec un algorithme par bloc, sinon, elle retourne &false; - (c.-à-d. &false; pour un flux, et &true; pour cbc, cfb, ofb). - - - - &reftitle.parameters; - - - mode - - - Le mode à vérifier. - - - - - lib_dir - - - Le paramètre optionnel lib_dir - peut contenir le dossier où les modules d'algorithme - se trouvent sur le système. - - - - - - - - &reftitle.returnvalues; - - Cette fonction retourne &true; si le mode doit être utilisé - avec un algorithme par bloc, sinon, elle retourne &false; - (c.-à-d. &false; pour un flux, et &true; pour cbc, cfb, ofb). - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml deleted file mode 100644 index 7beef51b36..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - mcrypt_module_is_block_algorithm - Indique si un algorithme fonctionne par blocs - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - boolmcrypt_module_is_block_algorithm - stringalgorithm - stringlib_dir - - - mcrypt_module_is_block_algorithm retourne &true; - si algorithm est un algorithme par blocs, - ou &false; si c'est un algorithme par flux. - - - - - &reftitle.parameters; - - - algorithm - - - L'algorithme à vérifier. - - - - - lib_dir - - - Le paramètre optionnel lib_dir - peut contenir le chemin où se trouvent les modules des algorithmes - sur le disque système. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si l'algorithme spécifié est un algorithme par blocs - ou &false; si c'est un algorithme par flux. - - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml b/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml deleted file mode 100644 index 4ad5614183..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - mcrypt_module_is_block_mode - Indique si un mode travaille par blocs - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - boolmcrypt_module_is_block_mode - stringmode - stringlib_dir - - - Cette fonction retourne &true; si ce mode fournit des blocs d'octets ou - &false; s'il ne sort que des octets. - (c.-à-d. &true; pour "cbc" et "ecb", - et &false; pour "cfb" et "stream"). - - - - - &reftitle.parameters; - - - mode - - &mcrypt.parameter.mode; - - - - lib_dir - - - Le paramètre optionnel lib_dir contient - le chemin jusqu'au module de l'algorithme sur le système. - - - - - - - - &reftitle.returnvalues; - - Cette fonction retourne &true; si ce mode fournit des blocs d'octets ou - &false; s'il ne sort que des octets. - (c.-à-d. &true; pour "cbc" et "ecb", - et &false; pour "cfb" et "stream"). - - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-open.xml b/reference/mcrypt/functions/mcrypt-module-open.xml deleted file mode 100644 index 82a6b7a171..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-open.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - mcrypt_module_open - Ouvre le module de l'algorithme et du mode à utiliser - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - resourcemcrypt_module_open - stringalgorithm - stringalgorithm_directory - stringmode - stringmode_directory - - - mcrypt_module_open ouvre le module de l'algorithme - et du mode à utiliser. Le nom de l'algorithme est spécifié par le paramètre - algorithm (par exemple : "twofish"), - ou bien une des constantes MCRYPT_ciphername. La bibliothèque est refermée - en appelant mcrypt_module_close. - - - - - &reftitle.parameters; - - - algorithm - - &mcrypt.parameter.cipher; - - - - algorithm_directory - - - Le paramètre algorithm_directory est utilisé - pour localiser le module de chiffrement. Lorsqu'on spécifie un - nom de dossier, il sera utilisé. Si on spécifie une chaîne vide - (""), la valeur définie dans la directive - mcrypt.algorithms_dir du fichier &php.ini; sera - utilisée. Lorsqu'elle n'est pas définie, le dossier par défaut utilisé - sera celui dans lequel se trouve la bibliothèque libmcrypt - (habituellement, /usr/local/lib/libmcrypt). - - - - - mode - - &mcrypt.parameter.mode; - - - - mode_directory - - - Le paramètre mode_directory est utilisé pour localiser - le module de chiffrement. Si un nom de dossier est spécifié, il sera utilisé. - Lorsqu'on spécifie une chaîne vide (""), la valeur - de la directive mcrypt.modes_dir du fichier &php.ini; - sera utilisée. Si elle n'est pas définie, le dossier par défaut utilisé - sera celui dans lequel se trouve la bibliothèque libmcrypt - (habituellement /usr/local/lib/libmcrypt). - - - - - - - - &reftitle.returnvalues; - - Normalement, cette fonction retourne un descripteur de chiffrement, ou - &false; si une erreur survient. - - - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_module_open</function> - - -]]> - - - - La première ligne de l'exemple ci-dessus va essayer d'ouvrir le chiffrement - DES, dans le dossier par défaut, et le mode ECB dans le dossier - /usr/lib/mcrypt-modes. Le second exemple utilise - les chaînes comme nom pour le chiffrement et le mode. Cela ne fonctionne - que si l'extension est compilée avec libmcrypt 2.4.x ou 2.5.x. - - - Utilisation de <function>mcrypt_module_open</function> pour chiffrer - - -]]> - - - - - - &reftitle.seealso; - - mcrypt_module_close - mcrypt_generic - mdecrypt_generic - mcrypt_generic_init - mcrypt_generic_deinit - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-self-test.xml b/reference/mcrypt/functions/mcrypt-module-self-test.xml deleted file mode 100644 index 4586aed32f..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-self-test.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - mcrypt_module_self_test - Teste un mode - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - boolmcrypt_module_self_test - stringalgorithm - stringlib_dir - - - Effectue un test sur l'algorithme spécifié. - - - - - &reftitle.parameters; - - - algorithm - - &mcrypt.parameter.cipher; - - - - lib_dir - - - Le paramètre optionnel lib_dir contient - le chemin jusqu'au module de l'algorithme sur le système. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si le test fonctionne, et &false; sinon. - - - - - &reftitle.examples; - - Exemple avec <function>mcrypt_module_self_test</function> - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mcrypt/functions/mdecrypt-generic.xml b/reference/mcrypt/functions/mdecrypt-generic.xml deleted file mode 100644 index 80d303be95..0000000000 --- a/reference/mcrypt/functions/mdecrypt-generic.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - mdecrypt_generic - Déchiffre les données - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - stringmdecrypt_generic - resourcetd - stringdata - - - Déchiffre les données data. À noter que la longueur de - la chaîne déchiffrée peut être plus longue que la chaîne originale, car elle - peut avoir été complétée par des caractères. - - - - - &reftitle.parameters; - - - td - - - Un descripteur de chiffrement, retourné par la fonction - mcrypt_module_open - - - - - data - - - Les données chiffrées. - - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne déchiffrée. - - - - - &reftitle.examples; - - Exemple avec <function>mdecrypt_generic</function> - - -]]> - - - - L'exemple ci-dessus montre comment vérifier que les données avant - chiffrement sont bien les mêmes que celles après - chiffrement/déchiffrement. Il est très important de réinitialiser - le buffer de chiffrement avec mcrypt_generic_init - avant de déchiffrer les données. - - - Le gestionnaire de déchiffrement doit toujours être initialisé - par la fonction mcrypt_generic_init avec une clé - et un VI avant d'appeler cette fonction. Lorsque le chiffrement est fait, - il faut qu'on libère les données chiffrées en appelant - mcrypt_generic_deinit. - Voir mcrypt_module_open pour un exemple. - - - - - &reftitle.seealso; - - mcrypt_generic - mcrypt_generic_init - mcrypt_generic_deinit - - - - diff --git a/reference/mcrypt/ini.xml b/reference/mcrypt/ini.xml deleted file mode 100644 index 7d2bb8866f..0000000000 --- a/reference/mcrypt/ini.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; mcrypt - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mcrypt.algorithms_dir - &null; - INI_ALL - - - - mcrypt.modes_dir - &null; - INI_ALL - - - - -
    - &ini.php.constants; -     - - &ini.descriptions.title; - - - - mcrypt.algorithms_dir - string - - - - Le dossier contenant les algorithmes. Par défaut il s'agit du dossier indiqué à la - compilation de libmcrypt, typiquement il s'agit de - /usr/local/lib/libmcrypt. Voir - mcrypt_list_algorithms pour plus de détails. - - - - - - mcrypt.modes_dir - string - - - - Le dossier contenant les modes. Par défaut il s'agit du dossier indiqué à la - compilation de libmcrypt, typiquement il s'agit de - /usr/local/lib/libmcrypt. Voir - mcrypt_list_modes pour plus de détails. - - - - -
    - diff --git a/reference/mcrypt/reference.xml b/reference/mcrypt/reference.xml deleted file mode 100644 index a32872c9a9..0000000000 --- a/reference/mcrypt/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - &Functions; Mcrypt - - &reference.mcrypt.entities.functions; - - - - diff --git a/reference/mcrypt/setup.xml b/reference/mcrypt/setup.xml deleted file mode 100644 index b713833596..0000000000 --- a/reference/mcrypt/setup.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Ces fonctions utilisent mcrypt. - Pour utiliser cette bibliothèque, téléchargez - le fichier libmcrypt-x.x.tar.gz sur - &url.mcrypt; - et suivez les instructions d'installation fournies. - - - La version 2.5.6 ou suivante de la bibliothèque libmcrypt est requise. - - - Les utilisateurs de Windows trouveront la bibliothèque dans la version Windows - de PHP 5.2. La version binaire Windows de PHP 5.3 utilise la version statique - de la bibliothèque MCrypt, aucune DLL n'est nécessaire. - - - Si on compile PHP avec la bibliothèque libmcrypt 2.4.x, - les algorithmes suivants sont supportés : "CAST", "LOKI97", "RIJNDAEL", "SAFERPLUS", - "SERPENT" ainsi que les chiffrements suivants : "ENIGMA" (chiffrement), "PANAMA", - "RC4" et "WAKE". Avec libmcrypt 2.4.x un autre mode de chiffrement - est disponible : "nOFB". - -
    - - - - &reference.mcrypt.configure; - - - - &reference.mcrypt.ini; - - - -
    - &reftitle.resources; - - mcrypt_module_open retourne un pointeur de chiffrement. - -
    - - -     - diff --git a/reference/memcache/book.xml b/reference/memcache/book.xml deleted file mode 100644 index cf71d1d95f..0000000000 --- a/reference/memcache/book.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - Memcache - - - - &reftitle.intro; - - Le module Memcache fournit une interface procédurale maniable - ainsi qu'orientée objet à Memcache, un démon fortement efficace dans - la gestion du cache, qui est principalement destiné à faire baisser la charge des bases - de données dans les applications web dynamiques. - - - Le module Memcache fournit également un - gestionnaire de session (memcache). - - - Plus d'informations concernant Memcache peuvent être - consultées sur &url.memcache;. - - - - - &reference.memcache.setup; - &reference.memcache.constants; - &reference.memcache.examples; - &reference.memcache.memcache; - &reference.memcache.reference; - - - diff --git a/reference/memcache/configure.xml b/reference/memcache/configure.xml deleted file mode 100644 index 3d9ac77f6a..0000000000 --- a/reference/memcache/configure.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - -
    - &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;memcache. - - - - Il est possible de désactiver le support du gestionnaire de sessions memcache. - L'option 'pecl install' le demande (activé par défaut), cependant, lors - de la compilation statique dans PHP, l'option de configuration - peut être utilisée. - - - -
    - diff --git a/reference/memcache/constants.xml b/reference/memcache/constants.xml deleted file mode 100644 index 9d7a6cdf4a..0000000000 --- a/reference/memcache/constants.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - &reftitle.constants; - - Constantes MemCache - - - - Nom - Description - - - - - - MEMCACHE_COMPRESSED - (int) - - - Utilisée pour activer à la volée la compression des données avec les fonctions - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - - MEMCACHE_HAVE_SESSION - (int) - - - 1 si le gestionnaire de session Memcache est disponible, 0 sinon. - - - - - MEMCACHE_USER1 - (int) - - - Utilisé pour activer les drapeaux d'application définis - par les utilisateurs, avec les méthodes - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - - MEMCACHE_USER2 - (int) - - - Utilisé pour activer les drapeaux d'application définis - par les utilisateurs, avec les méthodes - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - - MEMCACHE_USER3 - (int) - - - Utilisé pour activer les drapeaux d'application définis - par les utilisateurs, avec les méthodes - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - - MEMCACHE_USER4 - (int) - - - Utilisé pour activer les drapeaux d'application définis - par les utilisateurs, avec les méthodes - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - -
    -     - - diff --git a/reference/memcache/examples.xml b/reference/memcache/examples.xml deleted file mode 100644 index 4b5a1e3b63..0000000000 --- a/reference/memcache/examples.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - &reftitle.examples; -
    - Utilisation basique - - Exemple avec l'extension <literal>Memcache</literal> - - Dans cet exemple, un objet est sauvegardé dans le cache et ensuite, affiché. - Les objets ainsi que les autres types non-scalaires sont sérialisés avant d'être - sauvegardés ; il est donc impossible d'y stocker des ressources - (c.-à-d. identifiant de connexion et autres) dans le cache. - - -connect('localhost', 11211) or die ("Connexion impossible"); - -$version = $memcache->getVersion(); -echo "Version du serveur : ".$version."
    \n"; - -$tmp_object = new stdClass; -$tmp_object->str_attr = 'test'; -$tmp_object->int_attr = 123; - -$memcache->set('key', $tmp_object, false, 10) or die ("Échec de la sauvegarde des données sur le serveur"); -echo "Les données ont été stockées dans le cache (les données expireront dans 10 secondes)
    \n"; - -$get_result = $memcache->get('key'); -echo "Données depuis le cache :
    \n"; - -var_dump($get_result); - -?> -]]> -     -     - - Utilisation de memcache comme gestionnaire de session - - -]]> - - -
    -     - diff --git a/reference/memcache/functions/memcache-debug.xml b/reference/memcache/functions/memcache-debug.xml deleted file mode 100644 index bc6e1cfc8d..0000000000 --- a/reference/memcache/functions/memcache-debug.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - memcache_debug - Active ou non l'affichage des informations de débogage - - - - &reftitle.description; - - boolmemcache_debug - boolon_off - - - - memcache_debug active l'affichage des informations - de débogage si le paramètre on_off vaut &true; et le désactive - s'il vaut &false;. - - - memcache_debug est accessible uniquement si PHP - a été compilé avec l'option et retournera - toujours &true; dans ce cas. Sinon, cette fonction n'aura aucun effet et - retourne toujours &false;. - - - - - - - - &reftitle.parameters; - - - on_off - - - Active l'affichage de débogage si égal à &true;. - Désactive l'affichage de débogage si égal à &false;. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si PHP était compilé avec l'option --enable-debug, - autrement retourne &false;. - - - - - diff --git a/reference/memcache/ini.xml b/reference/memcache/ini.xml deleted file mode 100644 index 93cd1b1cc5..0000000000 --- a/reference/memcache/ini.xml +++ /dev/null @@ -1,318 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; memcache - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - memcache.allow_failover - "1" - INI_ALL - Disponible à partir de memcache 2.0.2. - - - memcache.max_failover_attempts - "20" - INI_ALL - Disponible à partir de memcache 2.1.0. - - - memcache.chunk_size - "8192" - INI_ALL - Disponible à partir de memcache 2.0.2. - - - memcache.default_port - "11211" - INI_ALL - Disponible à partir de memcache 2.0.2. - - - memcache.hash_strategy - "standard" - INI_ALL - Disponible à partir de memcache 2.2.0. - - - memcache.hash_function - "crc32" - INI_ALL - Disponible à partir de memcache 2.2.0. - - - memcache.protocol - ascii - INI_ALL - Supporté à partir de memcache 3.0.0 - - - memcache.redundancy - 1 - INI_ALL - Supporté à partir de memcache 3.0.0 - - - memcache.session_redundancy - 2 - INI_ALL - Supporté à partir de memcache 3.0.0 - - - memcache.compress_threshold - 20000 - INI_ALL - Supporté à partir de memcache 3.0.3 - - - memcache.lock_timeout - 15 - INI_ALL - Supporté à partir de memcache 3.0.4 - - - -
    - - Options de Configurations de Session Affectant le Comportement de Memcache - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - session.save_handler - "files" - INI_ALL - Supporté à partir de memcache 2.1.2 - - - session.save_path - "" - INI_ALL - Supporté à partir de memcache 2.1.2 - - - -
    - &ini.php.constants; -     - -&ini.descriptions.title; - - - - - - memcache.allow_failover - bool - - - - Si l'on doit basculer sur d'autres serveurs en cas d'erreur. - - - - - - - memcache.max_failover_attempts - int - - - - Définit combien de serveurs à essayer lorsque l'on fixe ou récupère des - données. À utiliser uniquement en conjonction avec memcache.allow_failover. - - - - - - - memcache.chunk_size - int - - - - Les données doivent être transférées en morceaux de cette taille ; - Configurer cette valeur à une petite valeur provoque plus d'écritures - sur le réseau. Il est recommandé d'augmenter cette valeur à 32768 si l'on - rencontre des ralentissements inexplicables. - - - - - - - memcache.default_port - string - - - - Le numéro du port TCP par défaut à utiliser lors de la connexion - au serveur memcache si aucun autre port n'est spécifié. - - - - - - - memcache.hash_strategy - string - - - - Contrôle la stratégie à appliquer lors du mappage des clés sur les serveurs. - Définir cette valeur à consistent pour activer la cohérence - de hachage qui permet aux serveurs d'être ajoutés ou supprimés de la réserver sans - pour autant avoir besoin d'effectuer un nouveau mappage des clés. Définir cette - valeur à standard fera que l'ancienne stratégie sera utilisée. - - - - - - - memcache.hash_function - string - - - - Contrôle la fonction de hachage à appliquer lors du mappage des clés - sur les serveurs, crc32 utilisera le CRC32 standard, - tandis que fnv utilisera FNV-1a. - - - - - - - memcache.protocol - string - - - - - - - - - - - memcache.redundancy - int - - - - - - - - - - - memcache.session_redundancy - int - - - - - - - - - - - memcache.compress_threshold - int - - - - - - - - - - - memcache.lock_timeout - int - - - - - - - - - - - session.save_handler - string - - - - Utiliser memcache comme gestionnaire de session en définissant cette valeur à - memcache. - - - - - - - session.save_path - string - - - - Définit les URL serveur, séparées par une virgule, à utiliser pour le stockage des - sessions, par exemple : "tcp://host1:11211, tcp://host2:11211". - - - Chaque URL peut contenir des paramètres qui seront appliqués au serveur, de la même - façon que pour la méthode Memcache::addServer. Par exemple : - "tcp://host1:11211?persistent=1&weight=1&timeout=1&retry_interval=15" - - - - - -
    - diff --git a/reference/memcache/memcache.xml b/reference/memcache/memcache.xml deleted file mode 100644 index 51ae2da543..0000000000 --- a/reference/memcache/memcache.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - La classe Memcache - Memcache - - - - -
    - &reftitle.intro; - - Représente une connexion vers un pool de serveurs memcache. - -
    - - -
    - &reftitle.classsynopsis; - - - - Memcache - - - - - Memcache - - - - - - - - -
    - -     - - &reference.memcache.entities.memcache; - -     - diff --git a/reference/memcache/memcache/add.xml b/reference/memcache/memcache/add.xml deleted file mode 100644 index 2dc6e39675..0000000000 --- a/reference/memcache/memcache/add.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Memcache::add - memcache_add - Ajoute un élément dans le serveur - - - - &reftitle.description; - - boolMemcache::add - stringkey - mixedvar - intflag - intexpire - - - boolmemcache_add - Memcachememcache - stringkey - mixedvar - intflag - intexpire - - - - Memcache::add stocke la variable - var avec la clé key seulement si cette clé - n'existe pas déjà dans le serveur. - - - - - - &reftitle.parameters; - - - key - - - La clé à associer à l'élément. - - - - - var - - - La variable à stocker. Les chaines et les entiers sont stockés tels quels, - les autres types sont sérialisés. - - - - - flag - - - Utiliser MEMCACHE_COMPRESSED pour compresser l'élément - (utilise zlib). - - - - - expire - - - Temps d'expiration de l'élément. Si égal à zéro, l'élément n'expirera jamais. - Il est également possible d'utiliser un timestamp Unix ou un nombre de secondes partant - du temps actuel, mais dans ce cas le nombre de secondes ne doit pas excéder - 2592000 (30 jours). - - - - - - - - &reftitle.returnvalues; - - &return.success; - Retourne &false; si la clé existe déjà. Pour le reste, le comportement de - Memcache::add est le même que - Memcache::set. - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::add</function> - -add('var_key', 'test variable', false, 30); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::set - Memcache::replace - - - - - diff --git a/reference/memcache/memcache/addserver.xml b/reference/memcache/memcache/addserver.xml deleted file mode 100644 index 2715ff52e1..0000000000 --- a/reference/memcache/memcache/addserver.xml +++ /dev/null @@ -1,265 +0,0 @@ - - - - - - Memcache::addServer - memcache_add_server - Ajoute un serveur memcache à la liste de connexion - - - - &reftitle.description; - - boolMemcache::addServer - stringhost - intport11211 - boolpersistent - intweight - inttimeout - intretry_interval - boolstatus - callablefailure_callback - inttimeoutms - - - boolmemcache_add_server - Memcachememcache - stringhost - intport11211 - boolpersistent - intweight - inttimeout - intretry_interval - boolstatus - callablefailure_callback - inttimeoutms - - - - Memcache::addServer ajoute un serveur à la liste de - connexion. - - - - Lors de l'utilisation de cette méthode (contrairement aux méthodes - Memcache::connect et Memcache::pconnect), - la connexion au réseau n'est pas établie sans qu'elle ne soit nécessaire. De plus, - il n'y a aucun inconvénient à ajouter beaucoup de serveurs à la liste, même s'ils ne - seront pas tous utilisés. - - - - Le basculement peut se produire à n'importe quel moment avec n'importe - quelle méthode tant que les autres serveurs sont disponibles, la requête - n'émettra pas d'erreur. N'importe quelle interface de connexion ou niveau - d'erreurs de serveur Memcache (à l'exception du manque de mémoire) peut - lancer le basculement. Des erreurs normales de client comme l'ajout d'une - clé existante ne lanceront pas un basculement. - - - - - Cette fonction a été ajoutée à la version de Memcache 2.0.0. - - - - - - - &reftitle.parameters; - - - host - - - Pointe à l'hôte où memcache écoute pour des connexions. Ce paramètre peut également - spécifier d'autres transporteurs comme unix:///path/to/memcached.sock - pour utiliser les sockets Unix, et dans ce cas, port doit également - être défini à 0. - - - - - port - - - Pointe au port où memcache écoute pour des connexions. - Définir ce paramètre à 0 lors de l'utilisation des sockets Unix. - - - Note : Par défaut, le paramètre port - prend la valeur de l'option de configuration - memcache.default_port - lorsqu'il n'est pas spécifié. Pour cette raison, il convient - de spécifier explicitement le port lors de l'appel à cette méthode. - - - - - persistent - - - Contrôle l'utilisation d'une connexion persistante. La valeur par - défaut est &true;. - - - - - weight - - - Nombre d'entrées à créer pour ce serveur qui en retour contrôle sa - probabilité d'être choisi. La probabilité est relative au poids total - de tous les serveurs. - - - - - timeout - - - Valeur en seconde qui sera utilisée pour se connecter au démon. - Pensez-y deux fois avant de changer la valeur par défaut d'une seconde - - il est possible que l'on perde tous les avantages de l'utilisation du cache - si la connexion est trop lente. - - - - - retry_interval - - - Contrôle combien de fois un serveur qui échoue sera tenté à nouveau, la valeur - par défaut est de 15 secondes. Si ce paramètre vaut -1, aucune nouvelle - tentative ne sera effectuée. Ni ce paramètre, ni le paramètre - persistent n'ont d'effet lorsque cette extension - est chargée dynamiquement via la fonction dl. - - - Chaque structure de connexion échouée a son propre dépassement de temps - et avant que celui-ci expire, il sera sauté lors de la sélection du - processus pour servir une requête. Une fois expiré, la connexion sera - correctement reconnectée ou marquée comme échouée pour un autre - intervalle de retry_interval secondes. L'effet - typique est que chaque enfant de serveur Web essaiera la connexion - chaque retry_interval secondes lorsqu'il sert - une page. - - - - - status - - - Contrôle si le serveur doit être indiqué comme étant en ligne. - Quand ce paramètre vaut &false; et le paramètre retry_interval - vaut -1, cela permet de conserver un serveur qui a échoué dans la liste - et n'affectera pas l'algorithme de distribution des clés. Les demandes - pour ce serveur échoueront immédiatement suivant la configuration du - paramètre memcache.allow_failover. - Par défaut, ce paramètre vaut &true;, signifiant que le serveur doit être - considéré comme étant en ligne. - - - - - failure_callback - - - Permet à l'utilisateur de spécifier une fonction de rappel permettant de - contourner une erreur. La fonction de rappel est exécutée avant d'atteindre la limite - de tentative. La fonction prend deux paramètres ; le nom de l'hôte et le port - du serveur qui a échoué. - - - - - timeoutms - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::addServer</function> - -addServer('memcache_host', 11211); -$memcache->addServer('memcache_host2', 11211); - -/* API procédurale */ - -$memcache_obj = memcache_connect('memcache_host', 11211); -memcache_add_server($memcache_obj, 'memcache_host2', 11211); - -?> -]]> - - - - - - &reftitle.notes; - - - Lorsque le paramètre port n'est pas spécifié, cette méthode - prendra la valeur de la directive de configuration INI - memcache.default_port. - Si cette valeur a été modifiée à un autre endroit dans l'application, - cela peut conduire à des résultats inattendus : pour cette raison, il convient - de toujours spécifier le port explicitement lors de l'appel à la méthode. - - - - - - &reftitle.seealso; - - Memcache::connect - Memcache::pconnect - Memcache::close - Memcache::setServerParams - Memcache::getServerStatus - - - - - diff --git a/reference/memcache/memcache/close.xml b/reference/memcache/memcache/close.xml deleted file mode 100644 index 62feaf3a7b..0000000000 --- a/reference/memcache/memcache/close.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Memcache::close - memcache_close - Ferme la connexion avec le serveur Memcache - - - - &reftitle.description; - - boolMemcache::close - - - - boolmemcache_close - Memcachememcache - - - - Memcache::close ferme la connexion au serveur - Memcache. Cette fonction ne ferme pas les connexions - persistantes qui seront fermées uniquement lors du redémarrage du serveur web. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::close</function> - -connect('memcache_host', 11211); -/* -faites quelque chose ici ... -*/ -$memcache_obj->close(); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::connect - Memcache::pconnect - - - - - diff --git a/reference/memcache/memcache/connect.xml b/reference/memcache/memcache/connect.xml deleted file mode 100644 index 44b572ac4d..0000000000 --- a/reference/memcache/memcache/connect.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Memcache::connect - memcache_connect - Ouvre une connexion avec le serveur Memcache - - - - &reftitle.description; - - boolMemcache::connect - stringhost - intport - inttimeout - - - Memcachememcache_connect - stringhost - intport - inttimeout - - - - Memcache::connect établit une connexion avec le serveur - de cache Memcache. - La connexion, qui a été ouverte en utilisant la fonction - Memcache::connect sera automatiquement fermée - à la fin du script. Il est possible de néanmoins la refermer en utilisant la - fonction Memcache::close. - - - - - - &reftitle.parameters; - - - host - - - Pointe à l'hôte où memcache écoute pour des connexions. Ce paramètre peut également - spécifier d'autres transporteurs comme unix:///path/to/memcached.sock - pour utiliser les sockets Unix, et, dans ce cas, port doit également - être défini à 0. - - - - - port - - - Pointe au port où memcache écoute pour des connexions. Définir ce paramètre à - 0 lors de l'utilisation des sockets Unix. - - - Note : Par défaut, le paramètre port prend la valeur - de l'option de configuration memcache.default_port - s'il n'est pas spécifié. Pour cette raison, il convient de spécifier explicitement - le port lors de l'appel à cette méthode. - - - - - timeout - - - Valeur en seconde qui sera utilisée pour se connecter au démon. - Pensez-y deux fois avant de changer la valeur par défaut d'une seconde - - il est possible que l'on perde tous les avantages de l'utilisation du cache - si la connexion est trop lente. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::connect</function> - -connect('memcache_host', 11211); - -?> -]]> - - - - - - &reftitle.notes; - - - Lorsque le paramètre port n'est pas spécifié, cette méthode - prendra la valeur de la directive de configuration INI - memcache.default_port. - Si cette valeur a été modifiée à un autre endroit dans l'application, - cela peut conduire à des résultats inattendus : pour cette raison, il convient - de toujours spécifier le port explicitement lors de l'appel à la méthode. - - - - - - &reftitle.seealso; - - Memcache::pconnect - Memcache::close - - - - - diff --git a/reference/memcache/memcache/decrement.xml b/reference/memcache/memcache/decrement.xml deleted file mode 100644 index 0b1a6be786..0000000000 --- a/reference/memcache/memcache/decrement.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - Memcache::decrement - memcache_decrement - Décrémente la valeur d'un élément - - - - &reftitle.description; - - intfalseMemcache::decrement - stringkey - intvalue1 - - - intfalsememcache_decrement - Memcachememcache - stringkey - intvalue1 - - - - Memcache::decrement décrémente la valeur de - l'élément par value. De la même façon - que la fonction memcache::increment, la valeur courante - de l'élément est tout d'abord convertie en numérique et seulement ensuite, - on soustrait la valeur value. - - - La nouvelle valeur de l'élément ne peut être inférieure à zéro. - - - - - Il ne faut pas utiliser la fonction Memcache::decrement avec les éléments - stockés compressés. Dans ce cas, l'appel à la fonction - Memcache::get échouera. - - - Memcache::decrement ne crée pas - d'élément s'il n'existe pas. - - - - - - &reftitle.parameters; - - - key - - - Clé de l'élément à décrémenter. - - - - - value - - - Décrémente l'élément par value. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur du nouvel élément en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::decrement</function> - -connect('memcache_host', 11211); -/* décrémentation de l'élément par 3 */ -$new_value = $memcache_obj->decrement('test_item', 3); -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::increment - Memcache::replace - - - - - diff --git a/reference/memcache/memcache/delete.xml b/reference/memcache/memcache/delete.xml deleted file mode 100644 index 25d8fee5a2..0000000000 --- a/reference/memcache/memcache/delete.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - Memcache::delete - memcache_delete - Efface un élément du serveur de cache - - - - &reftitle.description; - - boolMemcache::delete - stringkey - intexptime0 - - - boolmemcache_delete - Memcachememcache - stringkey - intexptime0 - - - - Memcache::delete efface l'élément identifié par la clé - key. - - - - - - &reftitle.parameters; - - - key - - - La clé associée à l'élément à supprimer. - - - - - exptime - - - Ce paramètre obsolète n'est pas supporté, et vaut par défaut - 0 seconde. Ce paramètre ne doit pas être utilisé. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcache 3.0.5 - - Le paramètre exptime est déprécié et ne devrait pas être fourni. - Des valeurs autres que 0 peuvent provoquer des erreurs inattendues. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::delete</function> - -connect('memcache_host', 11211); - -$memcache_obj->delete('key_to_delete'); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::set - Memcache::replace - - - - - diff --git a/reference/memcache/memcache/flush.xml b/reference/memcache/memcache/flush.xml deleted file mode 100644 index b6804dc4c5..0000000000 --- a/reference/memcache/memcache/flush.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Memcache::flush - memcache_flush - Efface tous les éléments existant sur le serveur de cache - - - - &reftitle.description; - - boolMemcache::flush - - - - boolmemcache_flush - Memcachememcache - - - - Memcache::flush invalide immédiatement tous les - éléments existant sur le serveur de cache. Memcache::flush - ne libère aucune ressource actuellement, il marque uniquement tous les - éléments comme ayant expirés, donc la mémoire occupée sera - réutilisée avec de nouveaux éléments. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::flush</function> - -connect('memcache_host', 11211); - -$memcache_obj->flush(); - -?> -]]> - - - - - - diff --git a/reference/memcache/memcache/get.xml b/reference/memcache/memcache/get.xml deleted file mode 100644 index c2a99ed4c6..0000000000 --- a/reference/memcache/memcache/get.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - Memcache::get - memcache_get - Récupère un élément du serveur de cache - - - - &reftitle.description; - - stringMemcache::get - stringkey - intflags - - - arrayMemcache::get - arraykeys - arrayflags - - - stringmemcache_get - Memcachememcache - stringkey - intflags - - - arraymemcache_get - Memcachememcache - arraykeys - arrayflags - - - - Memcache::get retourne les données précédemment stockées - dans l'élément identifié par la clé key s'il existe sur - le serveur au moment de l'appel. - - - - Il est possible de passer un tableau de clés à la fonction - Memcache::get pour obtenir un tableau de valeurs. Le - tableau résultant contiendra seulement les paires de clé-valeur trouvées. - - - - - - &reftitle.parameters; - - - key - - - La clé ou le tableau de clés à récupérer. - - - - - flags - - - Si ce paramètre est présent, il représentera les drapeaux des valeurs - à récupérer. Ces drapeaux sont les mêmes que ceux donnés en exemple de - la fonction Memcache::set. L'octet le plus faible - de la valeur est réservé à un usage interne de pecl/memcache - (p. ex. pour indiquer le statut de compression et de sérialisation). - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur associée avec le paramètre key - ou un tableau contenant les paires clé/valeur trouvées lorsque le paramètre - key est un &array;. Retourne &false; si une erreur - survient, si le paramètre key n'est pas trouvé, - ou si le paramètre key est un &array; vide. - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::get</function> - -connect('memcache_host', 11211); -$var = $memcache_obj->get('some_key'); - -/* -Vous pouvez également utiliser un tableau de clés en tant que paramètre. -Si un tel élément n'est pas trouvé sur le serveur, le tableau -résultat ne comprendra simplement pas une telle clé. -*/ - -/* API procédurale */ -$memcache_obj = memcache_connect('memcache_host', 11211); -$var = memcache_get($memcache_obj, Array('some_key', 'another_key')); - -/* API Orientée Objet */ -$memcache_obj = new Memcache; -$memcache_obj->connect('memcache_host', 11211); -$var = $memcache_obj->get(Array('some_key', 'second_key')); - -?> -]]> - - - - - - diff --git a/reference/memcache/memcache/getextendedstats.xml b/reference/memcache/memcache/getextendedstats.xml deleted file mode 100644 index d1a2d027fb..0000000000 --- a/reference/memcache/memcache/getextendedstats.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - Memcache::getExtendedStats - memcache_get_extended_stats - Récupère des statistiques de tous les serveurs dans la liste - - - - &reftitle.description; - - arrayMemcache::getExtendedStats - stringtype - intslabid - intlimit100 - - - arraymemcache_get_extended_stats - Memcachememcache - stringtype - intslabid - intlimit100 - - - - Memcache::getExtendedStats retourne un tableau - associatif à deux dimensions avec des statistiques de serveurs. Les clés - des tableaux correspondent à hôte:port des serveurs et les valeurs - contiennent des statistiques du serveur individuel. Un serveur en échec - aura ses entrées correspondantes fixées à &false;. - - - - - Cette fonction a été ajoutée à la version de Memcache 2.0.0. - - - - - - - &reftitle.parameters; - - - - type - - - Le type de statistiques à récupérer. Les valeurs valides sont : "reset", - "malloc", "maps", "cachedump", - "slabs", "items", "sizes". - Suivant les spécifications du protocole memcached, ces arguments optionnels sont susceptibles - d'être modifiés suivant les besoins des développeurs de memcache. - - - - - slabid - - - Utilisé avec le paramètre type défini à cachedump - pour identifier le slab à récupérer. La commande cachedump - met à mal le serveur et ne doit être utilisée que dans un but de débogage. - - - - - limit - - - Utilisé avec le paramètre type défini à - cachedump pour limiter le nombre d'entrées à récupérer. - - - - - - - Le type de statistique cachedump a été supprimé du processus - memcached pour des contraintes de sécurité. - - - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif avec des statistiques des serveurs ou - &false; en cas d'erreur. - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::getExtendedStats</function> - -addServer('memcache_host', 11211); - $memcache_obj->addServer('failed_host', 11211); - - $stats = $memcache_obj->getExtendedStats(); - print_r($stats); -?> -]]> - - &example.outputs; - - Array - ( - [pid] => 3756 - [uptime] => 603011 - [time] => 1133810435 - [version] => 1.1.12 - [rusage_user] => 0.451931 - [rusage_system] => 0.634903 - [curr_items] => 2483 - [total_items] => 3079 - [bytes] => 2718136 - [curr_connections] => 2 - [total_connections] => 807 - [connection_structures] => 13 - [cmd_get] => 9748 - [cmd_set] => 3096 - [get_hits] => 5976 - [get_misses] => 3772 - [bytes_read] => 3448968 - [bytes_written] => 2318883 - [limit_maxbytes] => 33554432 - ) - - [failed_host:11211] => false -) -]]> - - - - - - &reftitle.seealso; - - Memcache::getVersion - Memcache::getStats - - - - - diff --git a/reference/memcache/memcache/getserverstatus.xml b/reference/memcache/memcache/getserverstatus.xml deleted file mode 100644 index cb40e2e17e..0000000000 --- a/reference/memcache/memcache/getserverstatus.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Memcache::getServerStatus - memcache_get_server_status - Retourne le statut du serveur - - - - &reftitle.description; - - intMemcache::getServerStatus - stringhost - intport11211 - - - intmemcache_get_server_status - Memcachememcache - stringhost - intport11211 - - - - Memcache::getServerStatus retourne le statut - en ligne/hors ligne du serveur. - - - - - Cette fonction a été ajoutée en Memcache version 2.1.0. - - - - - - - &reftitle.parameters; - - - host - - - Pointe à l'hôte où memcache écoute pour des connexions. - - - - - port - - - Pointe au port où memcache écoute pour des connexions. - - - - - - - - &reftitle.returnvalues; - - Retourne le statut du serveur. 0 si le serveur échoue, une valeur - différente de zéro sinon. - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::getServerStatus</function> - -addServer('memcache_host', 11211); -echo $memcache->getServerStatus('memcache_host', 11211); - -/* API procédurale */ -$memcache = memcache_connect('memcache_host', 11211); -echo memcache_get_server_status($memcache, 'memcache_host', 11211); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::addServer - Memcache::setServerParams - - - - - diff --git a/reference/memcache/memcache/getstats.xml b/reference/memcache/memcache/getstats.xml deleted file mode 100644 index 3c652afd81..0000000000 --- a/reference/memcache/memcache/getstats.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Memcache::getStats - memcache_get_stats - Lit les statistiques du serveur - - - - &reftitle.description; - - arrayfalseMemcache::getStats - stringtype - intslabid - intlimit100 - - - arrayfalsememcache_get_stats - Memcachememcache - stringtype - intslabid - intlimit100 - - - - Memcache::getStats retourne un tableau associatif - avec les statistiques du serveur. Les index du tableau correspondent - aux paramètres de statistiques, et la valeur associée est la valeur de - ces statistiques. - - - - - - &reftitle.parameters; - - - type - - - Le type de statistiques à récupérer. Les valeurs valides sont {"reset", - "malloc", "maps", "cachedump", - "slabs", "items", "sizes"}. - Suivant les spécifications du protocole memcached, ces arguments optionnels sont susceptibles - d'être modifiés suivant les besoins des développeurs de memcache. - - - - - slabid - - - Utilisé avec le paramètre type défini à cachedump - pour identifier le slab à récupérer. La commande cachedump - met à mal le serveur et ne doit être utilisée que dans un but de débogage. - - - - - limit - - - Utilisé avec le paramètre type défini à - cachedump pour limiter le nombre d'entrées à récupérer. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif des statistiques d'un serveur&return.falseforfailure;. - - - - - &reftitle.seealso; - - Memcache::getVersion - Memcache::getExtendedStats - - - - - diff --git a/reference/memcache/memcache/getversion.xml b/reference/memcache/memcache/getversion.xml deleted file mode 100644 index 4f3e62225b..0000000000 --- a/reference/memcache/memcache/getversion.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Memcache::getVersion - memcache_get_version - Retourne le numéro de version du serveur - - - - &reftitle.description; - - stringfalseMemcache::getVersion - - - - stringfalsememcache_get_version - Memcachememcache - - - - Memcache::getVersion retourne une chaîne avec - le numéro de version du serveur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; du numéro de version de serveur&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::getVersion</function> - -connect('memcache_host', 11211); -echo $memcache->getVersion(); - -/* API procédurale */ -$memcache = memcache_connect('memcache_host', 11211); -echo memcache_get_version($memcache); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::getExtendedStats - Memcache::getStats - - - - - diff --git a/reference/memcache/memcache/increment.xml b/reference/memcache/memcache/increment.xml deleted file mode 100644 index b698366f13..0000000000 --- a/reference/memcache/memcache/increment.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - Memcache::increment - memcache_increment - Incrémente la valeur d'un élément - - - - &reftitle.description; - - intfalseMemcache::increment - stringkey - intvalue1 - - - intfalsememcache_increment - Memcachememcache - stringkey - intvalue1 - - - - Memcache::increment incrémente la valeur d'un élément - identifié par la clé key par la valeur - value. Si l'élément identifié par la clé - key n'est pas de type numérique et ne peut - être converti en nombre, la valeur de cet élément sera définie à - value. - Memcache::increment ne crée pas - un élément s'il n'existe pas. - - - Il ne faut pas utiliser memcache::increment avec les éléments - stockés compressés. Dans ce cas, l'appel à la fonction - Memcache::get échouera. - - - - - - - - &reftitle.parameters; - - - key - - - Clé de l'élément à incrémenter. - - - - - value - - - Incrémente l'élément par value. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur du nouvel élément en cas de succès &return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::increment</function> - -connect('memcache_host', 11211); -/* incrémentation du compteur de 3 */ -$current_value = $memcache_obj->increment('counter', 3); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::decrement - Memcache::replace - - - - - diff --git a/reference/memcache/memcache/pconnect.xml b/reference/memcache/memcache/pconnect.xml deleted file mode 100644 index 21dd11e63a..0000000000 --- a/reference/memcache/memcache/pconnect.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - Memcache::pconnect - memcache_pconnect - Ouvre une connexion persistante à un serveur de cache - - - - &reftitle.description; - - boolMemcache::pconnect - stringhost - intport - inttimeout - - - MemcacheMemcache::pconnect - stringhost - intport - inttimeout - - - - Memcache::pconnect est similaire à la fonction - Memcache::connect avec la différence que la connexion - sera persistante. - Ce type de connexion n'est pas fermé à la fin du script et par la fonction - Memcache::close. - - - - - - &reftitle.parameters; - - - host - - - Pointe à l'hôte où memcache écoute pour des connexions. Ce paramètre - peut également spécifier d'autres transporteurs comme - unix:///path/to/memcached.sock - pour utiliser les sockets Unix, et, dans ce cas, - port doit également être défini - à 0. - - - - - port - - - Pointe au port où memcache écoute pour des connexions. Définir ce paramètre - à 0 lors de l'utilisation des sockets Unix. - - - - - timeout - - - Valeur en seconde qui sera utilisée pour se connecter au démon. - Pensez-y deux fois avant de changer la valeur par défaut d'une seconde - - il est possible que l'on perde tous les avantages de l'utilisation du cache - si la connexion est trop lente. - - - - - - - - &reftitle.returnvalues; - - Retourne un objet Memcache&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::pconnect</function> - -pconnect('memcache_host', 11211); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::connect - - - - - diff --git a/reference/memcache/memcache/replace.xml b/reference/memcache/memcache/replace.xml deleted file mode 100644 index 29a93f0d95..0000000000 --- a/reference/memcache/memcache/replace.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - Memcache::replace - memcache_replace - Remplace une valeur d'un élément existant - - - - &reftitle.description; - - boolMemcache::replace - stringkey - mixedvar - intflag - intexpire - - - boolmemcache_replace - Memcachememcache - stringkey - mixedvar - intflag - intexpire - - - - Memcache::replace est utilisé pour remplacer la valeur - d'un élément identifié par la clé key. Dans le cas où - l'élément identifié par la clé key n'existe pas, - la fonction Memcache::replace retournera &false;. - Pour le reste, la fonction Memcache::replace fonctionne - de la même façon que la fonction Memcache::set. - - - - - - &reftitle.parameters; - - - key - - - La clé qui sera associée avec l'élément. - - - - - var - - - La variable à enregistrer. Les chaînes de caractères et les entiers - sont enregistrés comme tels, les autres types sont enregistrés de - manière sérialisée. - - - - - flag - - - Utiliser MEMCACHE_COMPRESSED pour enregistrer - l'élément compressé (utilise zlib). - - - - - expire - - - Temps d'expiration pour l'élément. S'il est égal à &zero;, l'élément n'expirera - jamais. Il est également possible d'utiliser un timestamp Unix ou un nombre de - secondes à partir du moment actuel, mais dans le dernier - cas, le nombre de secondes ne doit pas excéder 2592000 (30 jours). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::replace</function> - -replace("test_key", "some variable", false, 30); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::set - Memcache::add - - - - - diff --git a/reference/memcache/memcache/set.xml b/reference/memcache/memcache/set.xml deleted file mode 100644 index 095f425447..0000000000 --- a/reference/memcache/memcache/set.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - Memcache::set - memcache_set - Stocke des données dans le serveur de cache - - - - &reftitle.description; - - boolMemcache::set - stringkey - mixedvar - intflag - intexpire - - - boolmemcache_set - Memcachememcache - stringkey - mixedvar - intflag - intexpire - - - - Memcache::set stocke l'élément var - avec la clé key sur le serveur de cache. - Le paramètre expire représente le délai en secondes - d'expiration de l'élément. S'il vaut 0, l'élément n'expirera jamais (mais le serveur - de cache ne garantit pas que cet élément sera toujours stocké, il peut être - effacé du cache pour faire de la place à d'autres éléments). - Il est possible d'utiliser la constante MEMCACHE_COMPRESSED - comme valeur du paramètre flag - pour utiliser la compression à la volée (utilisation de la bibliothèque zlib). - - - Il faut se souvenir que les ressources (c.-à-d. identifiant de fichiers ou de connexion) - ne peuvent pas être stockées dans le cache, car elles ne peuvent pas être - représentées linéairement. - - - - - - - - &reftitle.parameters; - - - key - - - La clé qui sera associée avec l'élément. - - - - - var - - - La variable à enregistrer. Les chaînes de caractères et les entiers - sont enregistrés comme tels, les autres types sont enregistrés de - manière sérialisée. - - - - - flag - - - Utiliser MEMCACHE_COMPRESSED pour enregistrer - l'élément compressé (utilise zlib). - - - - - expire - - - Temps d'expiration pour l'élément. S'il est égal à &zero;, l'élément n'expirera - jamais. Il est également possible d'utiliser un timestamp Unix ou un nombre de - secondes à partir du moment actuel, mais dans le dernier - cas, le nombre de secondes ne doit pas excéder 2592000 (30 jours). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Memcache::set</function> - - -]]> - - - - Exemple avec <function>Memcache::set</function> - -connect('memcache_host', 11211); - -/* -définie la valeur de l'élément identifié par la clé 'var_key' ; -utilisation de la compression à la volée ; -le délai d'expiration vaut 50 secondes -*/ -$memcache_obj->set('var_key', 'quelques grosses variables', MEMCACHE_COMPRESSED, 50); - -echo $memcache_obj->get('var_key'); - -?> -]]> - - - - - - - &reftitle.seealso; - - Memcache::add - Memcache::replace - - - - diff --git a/reference/memcache/memcache/setcompressthreshold.xml b/reference/memcache/memcache/setcompressthreshold.xml deleted file mode 100644 index 9b64d2ce30..0000000000 --- a/reference/memcache/memcache/setcompressthreshold.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Memcache::setCompressThreshold - memcache_set_compress_threshold - Active la compression automatique des valeurs volumineuses - - - - &reftitle.description; - - boolMemcache::setCompressThreshold - intthreshold - floatmin_savings - - - boolmemcache_set_compress_threshold - Memcachememcache - intthreshold - floatmin_savings - - - - Memcache::setCompressThreshold active la compression - automatique des valeurs volumineuses. - - - - - Cette fonction a été ajoutée à la version de Memcache 2.0.0. - - - - - - - &reftitle.parameters; - - - threshold - - - Contrôle la taille de la valeur minimale avant d'essayer de compresser - automatiquement. - - - - - min_saving - - - Spécifie le nombre minimum de sauvegarde pour enregistrer les valeurs - compressées. La valeur fournie doit être comprise entre 0 et 1. La - valeur par défaut est 0.2, ce qui donne un minimum de 20% de sauvegarde - de compression. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::setCompressThreshold</function> - -addServer('memcache_host', 11211); -$memcache_obj->setCompressThreshold(20000, 0.2); - -/* API procédurale */ - -$memcache_obj = memcache_connect('memcache_host', 11211); -memcache_set_compress_threshold($memcache_obj, 20000, 0.2); - -?> -]]> - - - - - - diff --git a/reference/memcache/memcache/setserverparams.xml b/reference/memcache/memcache/setserverparams.xml deleted file mode 100644 index bb8d4f8a81..0000000000 --- a/reference/memcache/memcache/setserverparams.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - Memcache::setServerParams - memcache_set_server_params - Modifie les paramètres et les statuts du serveur pendant l'exécution - - - - &reftitle.description; - - boolMemcache::setServerParams - stringhost - intport11211 - inttimeout - intretry_interval&false; - boolstatus - callablefailure_callback - - - boolmemcache_set_server_params - Memcachememcache - stringhost - intport11211 - inttimeout - intretry_interval&false; - boolstatus - callablefailure_callback - - - - Memcache::setServerParams modifie les paramètres du - serveur durant l'exécution. - - - - Cette fonction a été ajoutée en Memcache version 2.1.0. - - - - - - - &reftitle.parameters; - - - host - - - Hôte où memcache écoute pour des connexions. - - - - - port - - - Port où memcache écoute pour des connexions. - - - - - timeout - - - Valeur en seconde qui sera utilisée pour se connecter au démon. - Pensez-y deux fois avant de changer la valeur par défaut d'une seconde - - il est possible que l'on perde tous les avantages de l'utilisation de la cache - si la connexion est trop lente. - - - - - retry_interval - - - Contrôle combien de fois la connexion à un serveur qui échoue sera essayée : - la valeur par défaut est de 15 secondes. Si ce paramètre vaut -1, aucune nouvelle - tentative ne sera effectuée. Ni ce paramètre, ni le paramètre - persistent n'ont d'effet lorsque cette extension - est chargée dynamiquement via la fonction dl. - - - - - status - - - Contrôle si le serveur doit être indiqué comme étant en ligne. - Quand ce paramètre vaut &false; et le paramètre retry_interval - vaut -1, cela permet de conserver un serveur qui a échoué dans la liste - et n'affectera pas l'algorithme de distribution des clés. Les demandes - pour ce serveur échoueront immédiatement suivant la configuration du - paramètre memcache.allow_failover. - Par défaut, ce paramètre vaut &true;, signifiant que le serveur doit être - considéré comme étant en ligne. - - - - - failure_callback - - - Permet à l'utilisateur de spécifier une fonction de rappel permettant de - contourner une erreur. La fonction est exécutée avant d'atteindre la limite - de tentative. La fonction prend deux paramètres ; le nom de l'hôte et le port - du serveur qui a échoué. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>Memcache::setServerParams</function> - -addServer('memcache_host', 11211, false, 1, 1, -1, false); - -// Replace le serveur en ligne -$memcache->setServerParams('memcache_host', 11211, 1, 15, true, '_callback_memcache_failure'); - -/* API procédurale */ - -$memcache_obj = memcache_connect('memcache_host', 11211); -memcache_set_server_params($memcache_obj, 'memcache_host', 11211, 1, 15, true, '_callback_memcache_failure'); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::addServer - Memcache::getServerStatus - - - - - diff --git a/reference/memcache/reference.xml b/reference/memcache/reference.xml deleted file mode 100644 index 9ee63ed0d9..0000000000 --- a/reference/memcache/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - &Functions; Memcache - &reference.memcache.entities.functions; - - - - diff --git a/reference/memcache/setup.xml b/reference/memcache/setup.xml deleted file mode 100644 index 297d1b0548..0000000000 --- a/reference/memcache/setup.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Ce module utilise les fonctions de la bibliothèque zlib - pour supporter la compression des données à la volée. Zlib est donc requis pour installer - ce module. - -
    - - - - &reference.memcache.configure; - - - - &reference.memcache.ini; - - - -
    - &reftitle.resources; - - Il n'y a qu'une seule ressource utilisée par le module Memcache : - c'est le lien identifiant représentant la connexion du serveur de cache. - -
    - - -     - diff --git a/reference/memcached/book.xml b/reference/memcached/book.xml deleted file mode 100644 index bdfdfe15fe..0000000000 --- a/reference/memcached/book.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - Memcached - Memcached - - - &reftitle.intro; - - memcached est un système à haute - performance, distribué et en mémoire, de cache d'objet, générique par nature, - mais principalement destiné à l'utilisation avec des sites Web dynamiques, - pour soulager les bases de données. - - - Cette extension utilise la bibliothèque libmemcached pour - assurer les communications avec les serveurs memcached. Elle - fournit aussi un gestionnaire de - sessions, appelé - memcached. - - - Des informations sur libmemcached sont disponibles à - &url.libmemcached;. - - - - &reference.memcached.setup; - &reference.memcached.constants; - &reference.memcached.expiration; - &reference.memcached.callbacks; - &reference.memcached.sessions; - &reference.memcached.memcached; - &reference.memcached.memcachedexception; - - - - - diff --git a/reference/memcached/callbacks.xml b/reference/memcached/callbacks.xml deleted file mode 100644 index 4e5602662d..0000000000 --- a/reference/memcached/callbacks.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - Fonctions de rappel - -
    - Fonctions de rappel de résultats - - Les fonctions de rappel de résultats (type callable) - sont appelées par les fonctions - Memcached::getDelayed ou - Memcached::getDelayedBykey, pour chaque - élément du jeu de résultat. Les fonctions de rappel reçoivent un objet - Memcached et un tableau avec les informations sur l'élément. La fonction - de rappel n'a pas besoin de retourner quoi que ce soit. - - - Exemple de fonction de rappel de résultats - -addServer('localhost', 11211); -$items = array( - 'key1' => 'value1', - 'key2' => 'value2', - 'key3' => 'value3' -); -$m->setMulti($items); -$m->getDelayed(array('key1', 'key3'), true, 'result_cb'); - -function result_cb($memc, $item) -{ - var_dump($item); -} -?> -]]> - - &example.outputs.similar; - - - string(4) "key1" - ["value"]=> - string(6) "value1" - ["cas"]=> - float(49) -} -array(3) { - ["key"]=> - string(4) "key3" - ["value"]=> - string(6) "value3" - ["cas"]=> - float(50) -} -]]> - - -
    - -
    - Fonctions de rappel sur clé absente - - Les fonctions de rappel sur clé absente sont appelées quand un élément ne peut - pas être lu sur le serveur. La fonction de rappel reçoit un objet Memcached, - la clé demandée, et une valeur de variable par référence. La fonction de rappel - est alors responsable d'affecter la valeur, puis de retourner - &true; ou &false;. Si la fonction de rappel retourne &true; - Memcached va stocker la valeur ainsi créée dans le serveur, et la retourner - à la fonction appelante. Seules Memcached::get et - Memcached::getByKey supportent ces fonctions, - car le protocole memcache ne fournit aucune information sur l'absence de - clé dans une requête multiclé. - - - Fonctions de rappel sur clé absente - -addServer('localhost', 11211); - -$profile_info = $m->get('user:'.$user_id, 'user_info_cb'); - -function user_info_cb($memc, $key, &$value) -{ - $user_id = substr($key, 5); - /* Lit un profil dans une base de données */ - /* ... */ - $value = $profile_info; - return true; -} -?> -]]> - - -
    - -     - - diff --git a/reference/memcached/configure.xml b/reference/memcached/configure.xml deleted file mode 100644 index ba8966c45d..0000000000 --- a/reference/memcached/configure.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;memcached - - - Si libmemcached est installé dans un dossier non-standard, utiliser l'option - , où DIR est le préfixe - d'installation libmemcached. Ce dossier doit contenir le fichier - include/libmemcached/memcached.h. - - - Zlib est nécessaire pour le support de la compression. Pour spécifier un dossier - d'installation non-standard de Zlib, utiliser l'option - , où DIR est le préfixe - d'installation. - - - Le support du gestionnaire de sessions est activé par défaut. Pour le désactiver, - utiliser . - - - Le support de l'authentification SASL est désactivé par défaut. Pour l'activer, - utiliser l'option de compilation . - Ceci nécessite l'installation préalable de la bibliothèque libsasl2 ainsi que - la compilation de libmemcached avec l'activation du support SASL. - -
    - - - diff --git a/reference/memcached/constants.xml b/reference/memcached/constants.xml deleted file mode 100644 index 53e65efdf1..0000000000 --- a/reference/memcached/constants.xml +++ /dev/null @@ -1,1032 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - Memcached::OPT_COMPRESSION - - - Active ou désactive la compression du contenu. Si elle est - activée, les éléments qui dépassent une taille (actuellement - 2000 octets), seront compressés durant le stockage, et - décompressés au déstockage, de manière transparente. Le seuil peut être configuré à - l'aide du paramètre ini memcached.compression_threshold. - - Type : bool, par défaut : &true;. - - - - - Memcached::OPT_COMPRESSION_TYPE - - - Spécifie l'algorithme de compression à utiliser, si la compression est activée. - Les algorithmes valides sont Memcached::COMPRESSION_FASTLZ, - Memcached::COMPRESSION_ZLIB et - Memcached::COMPRESSION_ZSTD. - - Type : int, par défaut : Memcached::COMPRESSION_FASTLZ. - - - - - Memcached::COMPRESSION_FASTLZ - - - L'algorithme de compression FASTLZ. - - - - - - Memcached::COMPRESSION_ZLIB - - L'algorithme de compression ZLIB. - - - - - Memcached::COMPRESSION_ZSTD - - - L'algorithme de compression ZSTD. - - - Disponible à partir de Memcached 3.3.0. - - - - - - Memcached::OPT_COMPRESSION_LEVEL - - - Spécifie le niveau de compression à utiliser, si la compression est activée. - - - Memcached::COMPRESSION_FASTLZ ne supporte pas les niveaux de compression. - Memcached::COMPRESSION_ZSTD : le niveau minimum est -22 et le niveau maximum est 22. - Memcached::COMPRESSION_ZLIB : le niveau minimum est 0 et le niveau maximum est 9. - - Type : int, par défaut : 3. - - - - - Memcached::OPT_SERIALIZER - - - Spécifie la fonction de sérialisation à utiliser pour les valeurs non - scalaires. Les fonctions valides sont - Memcached::SERIALIZER_PHP, - Memcached::SERIALIZER_IGBINARY, - Memcached::SERIALIZER_JSON, - Memcached::SERIALIZER_JSON_ARRAY et - Memcached::SERIALIZER_MSGPACK. - - - Type : int, par défaut : Memcached::SERIALIZER_IGBINARY si disponible, - puis Memcached::SERIALIZER_MSGPACK si disponible, - puis Memcached::SERIALIZER_PHP. - - - - - - Memcached::SERIALIZER_PHP - - - La fonction de sérialisation par défaut de PHP. - - - - - - Memcached::SERIALIZER_IGBINARY - - - Le sérialiseur igbinary. - Au lieu d'une représentation textuelle, cette fonction stocke les - structures PHP dans un format compact et binaire, avec un gain - de temps et d'espace. - - - Ce sérialiseur est pris en charge uniquement si memcached est configuré avec - l'option et si l'extension - igbinary est chargée. - - - - - - Memcached::SERIALIZER_JSON - - Le sérialiseur JSON. Ce sérialiseur désérialise le JSON en un objet. - - - - - Memcached::SERIALIZER_JSON_ARRAY - - - Le sérialiseur JSON en tableau. - Ce sérialiseur désérialise le JSON en un tableau associatif. - - - - - - Memcached::SERIALIZER_MSGPACK - - - Le sérialiseur MessagePack. - - - Ce sérialiseur est pris en charge uniquement si memcached est configuré avec - l'option et si l'extension - msgpack est chargée. - - - - - - Memcached::OPT_PREFIX_KEY - - - Cette option peut être utilisée pour créer un "domaine" pour les clés. - La valeur spécifiée ici sera préfixée à chaque clé. Elle ne peut pas être - plus longue que 128 caractères, et réduira d'autant - la taille maximale de clé disponible. Le préfixe est appliqué uniquement - aux clés d'élément, et non pas aux clés de serveur. - - Type : string, par défaut : "". - - - - - Memcached::OPT_HASH - - - Spécifie l'algorithme de hachage utilisé pour les clés. Les valeurs valides - sont fournies avec les constantes Memcached::HASH_*. - Chaque algorithme de hachage a ses avantages et inconvénients. Utiliser - celui qui est donné par défaut, si on ne comprend pas, ou que cela - importe peu. - - Type : int, par défaut : Memcached::HASH_DEFAULT - - - - - Memcached::HASH_DEFAULT - - - L'algorithme par défaut (Jenkins one-at-a-time) - de hachage. - - - - - - Memcached::HASH_MD5 - - - L'algorithme de hachage par MD5 - - - - - - Memcached::HASH_CRC - - - L'algorithme de hachage par CRC - - - - - - Memcached::HASH_FNV1_64 - - - L'algorithme de hachage par FNV1_64 - - - - - - Memcached::HASH_FNV1A_64 - - - L'algorithme de hachage par FNV1_64A - - - - - - Memcached::HASH_FNV1_32 - - - L'algorithme de hachage par FNV1_32 - - - - - - Memcached::HASH_FNV1A_32 - - - L'algorithme de hachage par FNV1_32A - - - - - - Memcached::HASH_HSIEH - - - L'algorithme de hachage par Hsieh - - - - - - Memcached::HASH_MURMUR - - - L'algorithme de hachage par Murmur - - - - - - Memcached::OPT_DISTRIBUTION - - - Spécifie la méthode de distribution des clés sur les serveurs. - Actuellement, cette option supporte les modulo et le hachage cohérent. - Le hachage cohérent fournit la meilleure distribution, et permet - aux serveurs d'être ajoutés au groupe avec un minimum de pertes de - cache. - - Type : int, par défaut : Memcached::DISTRIBUTION_MODULA. - - - - - Memcached::DISTRIBUTION_MODULA - - - L'algorithme de distribution par modulo - - - - - - Memcached::DISTRIBUTION_CONSISTENT - - - L'algorithme de distribution par hachage cohérent (basé sur libketama) - - - - - - Memcached::DISTRIBUTION_VIRTUAL_BUCKET - - - Algorithme de distribution de clé de hachage Virtual Bucket (également appelé vbucket). - - - - - - Memcached::OPT_LIBKETAMA_COMPATIBLE - - - Active ou non la compatibilité avec le comportement type libketama. - Quand cette option est activée, l'algorithme de hachage est MD5, - et la distribution est le hachage cohérent. Ceci est pratique car - d'autres client qui utilisent libketama (Python, Ruby, etc.) avec - la même configuration serveur seront capables d'utiliser les mêmes - clés, de manière transparente. - - - - Cette option est hautement recommandée, pour utiliser - le hachage cohérent, et il est probable qu'elle soit activée - par défaut dans de futures versions. - - - Type : bool, par défaut : &false;. - - - - - Memcached::OPT_LIBKETAMA_HASH - - - Spécifie l'algorithme de hachage pour le mappage de l'hôte. - - Type : int. - - - - - Memcached::OPT_TCP_KEEPALIVE - - - Active le maintien de la connexion TCP (keep-alive). - - Type : bool, par défaut : &false;. - - - - - Memcached::OPT_BUFFER_WRITES - - - Active ou non la bufferisation d'entrée / sortie. La bufferisation - fait que les commandes de stockage mettent en buffer, au lieu de - faire des envois. Toute action qui lit des données fait que le - buffer d'écriture est envoyé au serveur distant. La fermeture de la - connexion ou son arrêt vont aussi forcer l'envoi des données du - buffer. - - Type : bool, par défaut : &false;. - - - - - Memcached::OPT_BINARY_PROTOCOL - - - Activer cette option pour utiliser le protocole binaire. - À noter qu'il n'est pas possible de changer cette option pour - une connexion déjà ouverte. - - Type : bool, par défaut : &false;. - - - - - Memcached::OPT_NO_BLOCK - - - Active ou non les transferts asynchrones. Ceci est le mode de transfert - le plus rapide, pour les fonctions de stockage. - - Type : bool, par défaut : &false;. - - - - - Memcached::OPT_NOREPLY - - - Active ou désactive l'ignorance du résultat des commandes de stockage - (set, add, replace, append, prepend, delete, increment, decrement, etc.). - Les commandes de stockage seront envoyées sans passer du temps à attendre - pour une réponse (il n'y aurait pas de réponse). - Les commandes de récupérations tel que Memcached::get - ne sont pas affectées par ce paramétrage. - - Type: bool, par défaut: &false;. - - - - - Memcached::OPT_TCP_NODELAY - - - Active ou non les connexions sans délai des sockets (cela peut être - un gain de performances dans certains environnements). - - Type: bool, par défaut: &false;. - - - - - Memcached::OPT_SOCKET_SEND_SIZE - - - La taille maximale du buffer d'envoi par socket, en octets. - - - Type : int, par défaut : varie en fonction de la configuration de la plateforme/du noyau. - - - - - - Memcached::OPT_SOCKET_RECV_SIZE - - - La taille maximale du buffer de réception par socket, en octets. - - - Type : int, par défaut : varie en fonction de la configuration de la plateforme/du noyau. - - - - - - Memcached::OPT_CONNECT_TIMEOUT - - - En mode non-bloquant, cette option configure le délai d'expiration - durant la connexion du socket, en millisecondes. - - Type: int, par défaut: 1000. - - - - - Memcached::OPT_RETRY_TIMEOUT - - - La durée, en secondes, d'attente avant de tenter à nouveau une - connexion qui a échoué. - - Type: int, par défaut: 2. - - - - Memcached::OPT_DEAD_TIMEOUT - - - La durée, en secondes, à attendre avant de réessayer les serveurs morts. - 0 signifie aucun réessai. - - Type : int, par défaut : 0. - - - - - Memcached::OPT_SEND_TIMEOUT - - - Délai d'expiration d'envoi pour le socket, en microsecondes. Dans les cas - où on utilise un socket non bloquant, cela permettra d'avoir - des délais d'expiration en envoi de données, malgré tout. - - Type : int, par défaut : 0. - - - - - Memcached::OPT_RECV_TIMEOUT - - - Délai d'expiration de réception pour le socket, en microsecondes. Dans les cas - où on utilise un socket non bloquant, cela permettra d'avoir - des délais d'expiration en réception de données, malgré tout. - - Type : int, par défaut : 0. - - - - - Memcached::OPT_POLL_TIMEOUT - - - Délai d'expiration pour le polling de connexions, en millisecondes. - - Type : int, par défaut : 1000. - - - - - Memcached::OPT_CACHE_LOOKUPS - - - Active ou non le cache de DNS. - - Type : bool, par défaut : &false;. - - - - - Memcached::OPT_SERVER_FAILURE_LIMIT - - - Spécifie la limite du nombre d'échec de connexions. Le serveur sera - alors retiré de la liste après autant d'échec de connexions en succession. - - Type : int, par défaut : 5. - - - - Memcached::OPT_SERVER_TIMEOUT_LIMIT - - - Spécifie la limite de délai d'attente pour les tentatives de connexion au serveur. - Le serveur sera supprimé après ce nombre de délais d'attente continus de connexion. - - Type : int, par défaut : 0. - - - - - Memcached::OPT_AUTO_EJECT_HOSTS - - - Supprime les serveurs désactivés de la liste. À utiliser avec - Memcached::OPT_SERVER_FAILURE_LIMIT et - Memcached::OPT_SERVER_TIMEOUT_LIMIT. - - - - Cette option est remplacée par - Memcached::OPT_REMOVE_FAILED_SERVERS. - - - Type : bool, par défaut : &false;. - - - - - Memcached::OPT_VERIFY_KEY - - - Active la vérification des clés par memcached. - - Type : bool, par défaut : &false;. - - - - - Memcached::OPT_USE_UDP - - - Utilise UDP au lieu de TCP. - - Type : bool, par défaut : &false;. - - - - - Memcached::OPT_NUMBER_OF_REPLICAS - - - Stocke ce nombre de répliques de chaque élément sur différents serveurs. - - Type : int, par défaut : 0. - - - - - Memcached::OPT_RANDOMIZE_REPLICA_READS - - - Randomise le serveur de lecture de réplique. - - Type : bool, par défaut : &false;. - - - - - Memcached::OPT_REMOVE_FAILED_SERVERS - - - Supprime les serveurs désactivés de la liste. À utiliser avec - Memcached::OPT_SERVER_FAILURE_LIMIT et - Memcached::OPT_SERVER_TIMEOUT_LIMIT. - - Type : bool, par défaut : &false;. - - - - - Memcached::HAVE_IGBINARY - - - Indique si le support de la fonction de sérialisation - igbinary est activé. - - Type: bool. - - - - - Memcached::HAVE_JSON - - - Indique si la fonction de sérialisation JSON - est disponible. - - Type: bool. - - - - - Memcached::HAVE_MSGPACK - - Indique si le support du sérialiseur msgpack est disponible. - Type: bool. - Disponible à partir de Memcached 3.0.0. - - - - - Memcached::HAVE_ZSTD - - Indique si la prise en charge de la compression ZSTD est disponible. - Type : bool. - Disponible à partir de Memcached 3.3.0. - - - - - Memcached::HAVE_ENCODING - - - Indique si le chiffrement des données via - Memcached::setEncodingKey est pris en charge. - - Type : bool. - Disponible à partir de Memcached 3.1.0. - - - - - Memcached::HAVE_SESSION - - Type: bool. - Disponible à partir de Memcached 3.0.0. - - - - - Memcached::HAVE_SASL - - Type: bool. - Disponible à partir de Memcached 3.0.0. - - - - - Memcached::GET_EXTENDED - - - Un drapeau pour Memcached::get, - Memcached::getMulti et - Memcached::getMultiByKey pour s'assurer - que les valeurs du jeton CAS sont également renvoyées. - - Disponible à partir de Memcached 3.0.0. - - - - - Memcached::GET_PRESERVE_ORDER - - Une option pour Memcached::getMulti et - Memcached::getMultiByKey afin de s'assurer que les - clés sont retournées dans le même ordre que leur ordre de requête. - Les clés inexistantes prennent alors la valeur &null; - - - - - - Memcached::RES_SUCCESS - - - L'opération a réussi. - - - - - - Memcached::RES_FAILURE - - - L'opération a échoué, d'une manière ou d'une autre. - - - - - - Memcached::RES_HOST_LOOKUP_FAILURE - - - La recherche DNS a échoué. - - - - - - Memcached::RES_UNKNOWN_READ_FAILURE - - - Échec de lecture sur le réseau. - - - - - - Memcached::RES_PROTOCOL_ERROR - - - Mauvaise commande dans le protocole memcached. - - - - - - Memcached::RES_CLIENT_ERROR - - - Erreur du côté du client. - - - - - - Memcached::RES_SERVER_ERROR - - - Erreur du côté du serveur. - - - - - - Memcached::RES_WRITE_FAILURE - - - Échec de l'écriture sur le réseau. - - - - - - Memcached::RES_DATA_EXISTS - - - Échec de la comparaison et échange : l'élément qu'on essaie - de stocker a été modifié depuis la dernière lecture. - - - - - - Memcached::RES_NOTSTORED - - - L'élément n'a pas été stocké, mais pas à cause d'une erreur. Ceci est - normal, et signifie qu'une condition pour un ajout "add" - ou un remplacement "replace" n'a pas été satisfait, ou - qu'un élément a été mis dans une file d'effacement. - - - - - - Memcached::RES_NOTFOUND - - - L'élément avec cette clé n'a pas été trouvé (avec une opération - "get" ou "cas"). - - - - - - Memcached::RES_PARTIAL_READ - - - Erreur de lecture partielle sur le réseau. - - - - - - Memcached::RES_SOME_ERRORS - - - Des erreurs sont survenues durant une lecture multiple. - - - - - - Memcached::RES_NO_SERVERS - - - Liste de serveurs vide. - - - - - - Memcached::RES_END - - - Fin de jeu de résultats. - - - - - - Memcached::RES_ERRNO - - - Erreur système. - - - - - - Memcached::RES_BUFFERED - - - L'opération a été bufferisée. - - - - - - Memcached::RES_TIMEOUT - - - Le délai d'exécution de l'opération a expiré. - - - - - - Memcached::RES_BAD_KEY_PROVIDED - - - Mauvaise clé. - - - - - - Memcached::RES_STORED - - Élément stocké. - - - - - Memcached::RES_DELETED - - Élément supprimé. - - - - - Memcached::RES_STAT - - Statistiques. - - - - - Memcached::RES_ITEM - - Élément. - - - - - Memcached::RES_NOT_SUPPORTED - - Non pris en charge. - - - - - Memcached::RES_FETCH_NOTFINISHED - - Récupération non terminée. - - - - - Memcached::RES_SERVER_MARKED_DEAD - - Serveur marqué comme mort. - - - - - Memcached::RES_UNKNOWN_STAT_KEY - - Clé de statistique inconnue. - - - - - Memcached::RES_INVALID_HOST_PROTOCOL - - Protocole d'hôte invalide. - - - - - Memcached::RES_MEMORY_ALLOCATION_FAILURE - - Échec d'allocation mémoire. - - - - - Memcached::RES_CONNECTION_SOCKET_CREATE_FAILURE - - Impossible de créer un socket. - - - - - Memcached::RES_PAYLOAD_FAILURE - - - Échec de traitement : impossible de compresser, - décompresser ou sérialiser la valeur. - - - - - - Memcached::RES_AUTH_PROBLEM - - Disponible à partir de Memcached 3.0.0. - - - - - Memcached::RES_AUTH_FAILURE - - Disponible à partir de Memcached 3.0.0. - - - - - Memcached::RES_AUTH_CONTINUE - - Disponible à partir de Memcached 3.0.0. - - - - - Memcached::RES_E2BIG - - Disponible à partir de Memcached 3.0.0. - - - - - Memcached::RES_KEY_TOO_BIG - - Disponible à partir de Memcached 3.0.0. - - - - - Memcached::RES_SERVER_TEMPORARILY_DISABLED - - Disponible à partir de Memcached 3.0.0. - - - - - Memcached::RES_SERVER_MEMORY_ALLOCATION_FAILURE - - Disponible à partir de Memcached 3.0.0. - - - - - - - diff --git a/reference/memcached/expiration.xml b/reference/memcached/expiration.xml deleted file mode 100644 index 4522d36460..0000000000 --- a/reference/memcached/expiration.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - Délai d'expiration - - Certaines commandes de stockage imposent l'envoi d'un délai d'expiration - (relatif à un élément ou à une commande émise par le client), sur le serveur. - Dans ce cas, cette valeur doit être envoyée sous la forme d'un timestamp - Unix (nombre de secondes depuis le 1er janvier 1970, sous forme d'entier), - ou d'un nombre de secondes depuis l'heure courante. Dans le dernier cas, - ce nombre de secondes ne peut pas excéder 30 jours, soit 60*60*24*30 - secondes; si la valeur d'expiration est plus grande que cette valeur, - le serveur le considérera comme un timestamp, plutôt qu'un délai. - - - Si la valeur d'expiration est 0 (la valeur par défaut), - l'élément n'expire jamais, même s'il peut être effacé par le serveur - pour faire de la place aux autres éléments. - - - - - diff --git a/reference/memcached/ini.xml b/reference/memcached/ini.xml deleted file mode 100644 index 0884cdd06f..0000000000 --- a/reference/memcached/ini.xml +++ /dev/null @@ -1,682 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; Memcached - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - memcached.sess_locking - On - INI_ALL - Disponible depuis memcached 0.1.0. - - - memcached.sess_consistent_hash - On - INI_ALL - Disponible depuis memcached 2.1.0. La valeur par défaut est Actif depuis memcached 3.0.0. - - - memcached.sess_binary - Off - INI_ALL - Disponible depuis memcached 2.0.0. Remplacé par memcached.sess_binary_protocol depuis memcached 3.0.0. - - - memcached.sess_lock_wait - 150000 - INI_ALL - Disponible depuis memcached 0.1.0. Supprimé depuis memcached 3.0.0. - - - memcached.sess_prefix - memc.sess.key. - INI_ALL - Disponible depuis memcached 0.1.0. - - - memcached.sess_number_of_replicas - 0 - INI_ALL - Disponible depuis memcached 2.1.0. - - - memcached.sess_randomize_replica_read - Off - INI_ALL - Disponible depuis memcached 2.1.0. - - - memcached.sess_remove_failed - On - INI_ALL - Disponible depuis memcached 2.1.0. Remplacé par memcached.sess_remove_failed_servers depuis memcached 3.0.0. - - - memcached.compression_type - fastlz - INI_ALL - Disponible depuis memcached 0.1.0. - - - memcached.compression_factor - 1.3 - INI_ALL - Disponible depuis memcached 0.1.0. - - - memcached.compression_threshold - 2000 - INI_ALL - Disponible depuis memcached 0.1.0. - - - memcached.serializer - igbinary - INI_ALL - Disponible depuis memcached 0.1.0. - - - memcached.use_sasl - Off - INI_ALL - Disponible depuis memcached 2.2.0. Supprimé depuis memcached 3.0.0. - - - memcached.default_binary_protocol - Off - INI_ALL - Disponible depuis memcached 3.0.0. - - - memcached.default_connect_timeout - 0 - INI_ALL - Disponible depuis memcached 3.0.0. - - - memcached.default_consistent_hash - Off - INI_ALL - Disponible depuis memcached 3.0.0. - - - memcached.sess_binary_protocol - On - INI_ALL - Disponible depuis memcached 3.0.0. Remplace memcached.sess_binary. - - - memcached.sess_connect_timeout - 1000 - INI_ALL - Disponible depuis memcached 2.2.0. - - - memcached.sess_consistent_hash_type - ketama - INI_ALL - Disponible depuis memcached 3.1.0. - - - memcached.sess_lock_expire - 0 - INI_ALL - Disponible depuis memcached 2.2.0. - - - memcached.sess_lock_retries - 5 - INI_ALL - Disponible depuis memcached 3.0.0. - - - memcached.sess_lock_wait_max - 150 - INI_ALL - Disponible depuis memcached 3.0.0. Par défaut à 150 depuis memcached 3.1.0 (avant 2000). - - - memcached.sess_lock_wait_min - 150 - INI_ALL - Disponible depuis memcached 3.0.0. Par défaut à 150 depuis memcached 3.1.0 (avant 1000). - - - memcached.sess_persistent - Off - INI_ALL - Disponible depuis memcached 3.0.0. - - - memcached.sess_remove_failed_servers - Off - INI_ALL - Disponible depuis memcached 3.0.0. Remplace memcached.sess_remove_failed. - - - memcached.sess_server_failure_limit - 0 - INI_ALL - Disponible depuis memcached 3.0.0. - - - memcached.sess_sasl_password - null - INI_ALL - Disponible depuis memcached 2.2.0. - - - memcached.sess_sasl_username - null - INI_ALL - Disponible depuis memcached 2.2.0. - - - memcached.store_retry_count - 0 - INI_ALL - - Disponible depuis memcached 2.2.0. - Par défaut à 0 depuis memcached 3.2.0 - (avant 2). - - - - -
    -     - - &ini.descriptions.title; - - - - - - memcached.sess_locking - bool - - - - Utilise les verrous de session. Les valeurs valides sont On et Off, la valeur par défaut est On. - - - - - - memcached.sess_consistent_hash - bool - - - - Si défini à On, utilise le hachage consistant (libketama) pour la gestion des sessions. - Lorsque le hachage consistant est utilisé, - on peut ajouter ou supprimer des nœuds de cache sans perturber les clés existantes. - La valeur par défaut est On. - - - - - - memcached.sess_binary - bool - - - - Utilise le mode binaire pour les sessions memcached. Les répliques de libmemcached ne fonctionnent - que si le mode binaire est activé. La valeur par défaut est Off. - - - - - - memcached.sess_lock_wait - int - - - - La durée d'attente du verrou de session en microsecondes. Il faut être prudent lorsqu'on définit cette valeur. - Les valeurs valides sont des entiers, où 0 est interprété comme la valeur par défaut. - Les valeurs négatives entraînent une réduction du verrouillage à un verrou d'essai. - La valeur par défaut est 150000. - - - - - - memcached.sess_prefix - string - - - - Le préfixe de clé de session Memcached. Les valeurs valides sont des chaînes de moins de 219 octets. - La valeur par défaut est memc.sess.key. - - - - - - memcached.sess_number_of_replicas - int - - - - Ecrit les données sur un certain nombre de serveurs Memcached supplémentaires. C'est ce que libmemcached appelle le "pauvre homme HA". - Si cette valeur est positive et que sess_remove_failed_servers est activé, - lorsqu'un serveur Memcached échoue, la session continuera d'être disponible à partir d'une réplique. - Cependant, si le serveur Memcached en panne redevient disponible, la session sera lue à partir de là, - ce qui pourrait avoir des données obsolètes ou aucune donnée du tout. - La valeur par défaut est 0. - - - - - - memcached.sess_randomize_replica_read - bool - - - - La session Memcached lit la réplication aléatoire. - - - - - - memcached.sess_remove_failed - int - - - - Autorise le serveur Memcached en panne à être automatiquement supprimé. - - - - - - memcached.compression_type - string - - - - Définit le type de compression, les valeurs valides sont: fastlz, zlib. - La valeur par défaut est fastlz. - - - - - - memcached.compression_factor - float - - - - Le facteur de compression. Stockez la valeur compressée uniquement si le facteur de compression - (économie) dépasse la limite définie. Stockez compressé si: - plain_len > comp_len * factor. La valeur par défaut est - 1.3 (23% d'économie d'espace). - - - - - - memcached.compression_threshold - int - - - - Le seuil de compression. Ne pas compresser les valeurs sérialisées en dessous de ce seuil. - La valeur par défaut est 2000 octets. - - - - - - memcached.serializer - string - - - - Définit le sérialiseur par défaut pour les nouveaux objets Memcached. Les valeurs valides sont: - php, igbinary, json, - json_array, msgpack. - - - - json - - - La sérialisation JSON PHP standard. Ce sérialiseur est rapide et compact mais - ne fonctionne que sur des données encodées en UTF-8 et n'implémente pas entièrement - la sérialisation. Voir l'extension JSON. Disponible depuis memcached 0.2.0. - - - - - json_array - - - Comme json, mais décode en tableaux. Disponible depuis memcached 2.0.0. - - - - - php - - - Le sérialiseur PHP standard. - - - - - igbinary - - - Un sérialiseur binaire. Disponible depuis memcached 0.1.4. - - - - - msgpack - - - Un sérialiseur binaire multi-langage. Disponible depuis memcached 2.2.0. - - - - - - La valeur par défaut est igbinary si disponible, puis msgpack si disponible, - puis sinon php. - - - - - - memcached.use_sasl - bool - - - - Utiliser l'authentification SASL pour les connexions. Les valeurs valides sont On et Off. - La valeur par défaut est Off. - - - - - - memcached.default_binary_protocol - bool - - - - Définit le protocole memcached par défaut pour les nouvelles connexions. (Pour configurer le protocole memcached pour - les connexions utilisées par les sessions, utiliser memcached.sess_binary_protocol à la place.) - - Si défini à On, le protocole binaire memcached est utilisé par défaut. - Si défini à Off, le protocole texte memcached est utilisé. - La valeur par défaut est Off. - - - - - - memcached.default_connect_timeout - int - - - - Définit le délai de connexion memcached par défaut pour les nouvelles connexions. - (Pour configurer le délai de connexion memcached pour les sessions, utiliser memcached.sess_connect_timeout à la place.) - - Dans un mode non bloquant, cela change la valeur du délai. - Pendant la connexion du socket en millisecondes. - Spécifier -1 signifie un délai infini. - Spécifier 0 signifie utiliser le délai de connexion par défaut de la bibliothèque memcached. - La valeur par défaut est 0. - - - - - - memcached.default_consistent_hash - bool - - - - Définit le hachage consistant par défaut pour les nouvelles connexions. - (Pour configurer le hachage consistant pour les connexions utilisées par les sessions, - utiliser memcached.sess_consistent_hash à la place.) - - Si défini à On, le hachage consistant (libketama) est utilisé pour la - gestion des sessions. Lorsque le hachage consistant est utilisé, on peut ajouter ou supprimer des nœuds de cache - sans perturber les clés existantes. La valeur par défaut est Off. - - - - - - memcached.sess_binary_protocol - bool - - - - Utiliser le protocole binaire memcached pour les sessions memcached au lieu du protocole texte. - Les répliques de libmemcached ne fonctionnent que si le mode binaire est activé. - Cependant, certains proxies (comme twemproxy) ne fonctionneront que si le protocole binaire est désactivé. - La valeur par défaut est On depuis libmemcached 1.0.18. - Avant libmemcached 1.0.18, la valeur par défaut était Off. - - - - Dans les versions précédentes de php-memcached, ce paramètre s'appelait - memcached.sess_binary. - - - - - - - memcached.sess_connect_timeout - int - - - - La valeur du temps d'attente de connexion memcached. - En mode non bloquant, cela change la valeur du délai pendant - la connexion du socket en millisecondes. - Spécifier -1 signifie un délai infini. - - - - - - memcached.sess_consistent_hash_type - string - - - - Type de hachage consistant de session Memcached. - Si défini à ketama, le hachage consistant (libketama) - est utilisé pour la gestion des sessions. - Si défini à ketama_weighted, le hachage consistant pondéré (libketama) - est utilisé pour la gestion des sessions. - La valeur par défaut est ketama. - Avant php-memcached 3.0, la valeur par défaut était ketama_weighted. - - - - - - memcached.sess_lock_expire - int - - - - Le temps, en secondes, avant qu'un verrou ne se libère. - Définir sur 0 donne le comportement par défaut, - qui est d'utiliser max_execution_time de PHP. - La valeur par défaut est 0. - - - - - - memcached.sess_lock_retries - int - - - - Le nombre de tentatives de verrouillage de session, sans compter la première tentative. - La valeur par défaut est 5. - - - - - - memcached.sess_lock_wait_max - int - - - - Le temps maximum, en millisecondes, à attendre entre les tentatives de verrouillage de session. - La valeur par défaut est 150. - - - - - - memcached.sess_lock_wait_min - int - - - - Le temps minimum, en millisecondes, à attendre entre les tentatives de verrouillage de session. - Cette valeur est doublée à chaque nouvelle tentative de verrouillage jusqu'à ce que - memcached.sess_lock_wait_max soit atteint, après quoi toute nouvelle tentative prendra - memcached.sess_lock_wait_max secondes. - La valeur par défaut est 150. - - - - - - memcached.sess_persistent - bool - - - - Si les connexions memcached correspondent à la valeur(s) de - session.save_path doivent être réutilisées après l'exécution du script. Ne pas utiliser - si certains paramètres (par exemple, les paramètres SASL, sess_binary_protocol) seraient écrasés entre les requêtes. - La valeur par défaut est Off. - - - - - - memcached.sess_remove_failed_servers - bool - - - - Autorise le serveur Memcached en panne à être automatiquement supprimé. - La valeur par défaut est Off. - - - - Dans les versions précédentes de php-memcached, ce paramètre s'appelait - memcached.sess_remove_failed. - - - - - - - memcached.sess_server_failure_limit - int - - - - Définir cette valeur pour permettre la suppression automatique - du serveur après un certain nombre de tentatives de connexion échouées. - La valeur par défaut est 0. - - - - - - memcached.sess_sasl_password - string - - - - Le mot de passe SASL de session. - Le nom d'utilisateur et le mot de passe doivent être définis pour activer SASL. - - - - - - memcached.sess_sasl_username - string - - - - Le nom d'utilisateur SASL de session. - Le nom d'utilisateur et le mot de passe doivent être définis pour activer SASL. - - - - - - memcached.store_retry_count - int - - - - La quantité de tentatives pour les commandes de stockage échouées. - Ce mécanisme permet un basculement transparent vers les serveurs secondaires lorsque - les opérations set/increment/decrement/setMulti échouent sur - le serveur souhaité dans un environnement multi-serveurs. - La valeur par défaut est 2. - - - - - -
    - - diff --git a/reference/memcached/memcached.xml b/reference/memcached/memcached.xml deleted file mode 100644 index 5514296a86..0000000000 --- a/reference/memcached/memcached.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La classe Memcached - Memcached - - - - -
    - &reftitle.intro; - - Représente une connexion avec un serveur memcache. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Memcached - - - - - Memcached - - - - &Methods; - - - - - - - - - -
    - -     - - &reference.memcached.entities.memcached; - -     - - diff --git a/reference/memcached/memcached/add.xml b/reference/memcached/memcached/add.xml deleted file mode 100644 index 640c3d7961..0000000000 --- a/reference/memcached/memcached/add.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - Memcached::add - Ajoute un nouvel élément sous une nouvelle clé - - - - &reftitle.description; - - public boolMemcached::add - stringkey - mixedvalue - intexpiration0 - - - Memcached::add est similaire à - Memcached::set, mais l'opération échoue si - la clé key existe déjà. - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - La méthode Memcached::getResultCode retourne la constante - Memcached::RES_NOTSTORED si la clé existe déjà. - - - - - &reftitle.seealso; - - - Memcached::addByKey - Memcached::set - Memcached::replace - - - - - - - diff --git a/reference/memcached/memcached/addbykey.xml b/reference/memcached/memcached/addbykey.xml deleted file mode 100644 index 07e9c3b676..0000000000 --- a/reference/memcached/memcached/addbykey.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Memcached::addByKey - Ajoute un élément sur un serveur désigné - - - - &reftitle.description; - - public boolMemcached::addByKey - stringserver_key - stringkey - mixedvalue - intexpiration0 - - - Memcached::addByKey est fonctionnellement équivalent - à Memcached::add, mais la variable libre - server_key peut être utilisée pour diriger - la clé key sur un serveur spécifique. Ceci est utile pour - conserver un groupe de variables groupées sur un serveur. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - La méthode Memcached::getResultCode va retourner - la constante Memcached::RES_NOTSTORED si la clé existe déjà. - - - - - &reftitle.seealso; - - - Memcached::add - Memcached::set - Memcached::replace - - - - - - - diff --git a/reference/memcached/memcached/addserver.xml b/reference/memcached/memcached/addserver.xml deleted file mode 100644 index 1a6085e0d9..0000000000 --- a/reference/memcached/memcached/addserver.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - Memcached::addServer - Ajoute un serveur au pool - - - - &reftitle.description; - - public boolMemcached::addServer - stringhost - intport - intweight0 - - - Memcached::addServer ajoute le serveur indiqué - au pool de serveurs. Aucune connexion n'est établie à ce moment-là, mais - lors de l'utilisation de la clé de distribution par hachage cohérent (via - Memcached::DISTRIBUTION_CONSISTENT ou - Memcached::OPT_LIBKETAMA_COMPATIBLE), certaines structures - internes vont être mises à jour. Par conséquent, s'il faut ajouter plusieurs - serveurs, il est recommandé d'utiliser Memcached::addServers - pour que la mise à jour n'arrive qu'une seule fois. - - - Le même serveur peut apparaître plusieurs fois dans le pool, car aucune - recherche de doublon n'est faite. Ce n'est pas recommandé : utiliser plutôt - le paramètre weight pour augmenter le poids d'un serveur - dans la sélection. - - - - - &reftitle.parameters; - - - - host - - - Le nom d'hôte du serveur memcache. Si le nom d'hôte n'est pas valide, - les opérations sur les données vont définir le code résultat - Memcached::RES_HOST_LOOKUP_FAILURE. Depuis - la version 2.0.0b1, ce paramètre peut aussi spécifier le chemin - vers un socket Unix, par exemple; /chemin/vers/memcached.sock - pour utiliser le socket de domaine Unix, et dans ce cas, - le paramètre port doit aussi être défini à - 0. - - - - - port - - - Le port sur lequel memcache fonctionne. Généralement, c'est - 11211. Depuis la version 2.0.0b1, définissez - ce paramètre à 0 lorsqu'on utilise des sockets - de domaine Unix. - - - - - weight - - - Le poids du serveur relativement au poids total de tous les serveurs. Cela - contrôle la probabilité qu'un serveur soit sélectionné durant les opérations. - Cette option n'est utilisée qu'avec la distribution cohérente, et généralement, - cela correspond au total de mémoire disponible sur ce serveur. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::addServer</function> - -addServer('mem1.domain.com', 11211, 33); -$m->addServer('mem2.domain.com', 11211, 67); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::addServers - Memcached::resetServerList - - - - - - - diff --git a/reference/memcached/memcached/addservers.xml b/reference/memcached/memcached/addservers.xml deleted file mode 100644 index a744f0cb29..0000000000 --- a/reference/memcached/memcached/addservers.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - Memcached::addServers - Ajoute plusieurs serveurs au pool - - - - &reftitle.description; - - public boolMemcached::addServers - arrayservers - - - Memcached::addServers ajoute les serveurs - servers au pool de serveurs. Chaque entrée - dans servers doit être un tableau, contenant - le nom d'hôte, le port, et optionnellement son poids. Aucune connexion n'est - établie au serveur à ce moment-là. - - - Le même serveur peut apparaître plusieurs fois dans le pool, car - aucune vérification de duplication n'est faite. Ce n'est pas recommandé. - Au lieu de cela, il vaut mieux utiliser le paramètre - weight pour augmenter le poids du serveur. - - - - - &reftitle.parameters; - - - - array - - - Un tableau de serveurs à ajouter. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::addServers</function> - -addServers($servers); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::addServer - Memcached::resetServerList - - - - - - - diff --git a/reference/memcached/memcached/append.xml b/reference/memcached/memcached/append.xml deleted file mode 100644 index 4cce4bdeb4..0000000000 --- a/reference/memcached/memcached/append.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - Memcached::append - Ajoute des données à un élément - - - - &reftitle.description; - - public boolnullMemcached::append - stringkey - stringvalue - - - Memcached::append ajoute les données de - value à la fin d'un élément existant. La raison qui - fait que value doit être une chaîne est que les - autres types ne supportent pas cette opération. - - - - Si la constante Memcached::OPT_COMPRESSION est activée, - l'opération va échouer, et une alerte sera émise, car le préfixage - de données compressées n'est pas possible. - - - - - - &reftitle.parameters; - - - - key - - - La clé de l'élément à suffixer. - - - - - value - - - La chaîne suffixée. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Retourne &null; si la compression est activée. - - - - - &reftitle.errors; - - Retourne &null; et lève un E_WARNING - si la compression est activée. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::append</function> - -addServer('localhost', 11211); -$m->setOption(Memcached::OPT_COMPRESSION, false); - -$m->set('foo', 'abc'); -$m->append('foo', 'def'); -var_dump($m->get('foo')); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::appendByKey - Memcached::prepend - - - - - - - diff --git a/reference/memcached/memcached/appendbykey.xml b/reference/memcached/memcached/appendbykey.xml deleted file mode 100644 index 58e2be0478..0000000000 --- a/reference/memcached/memcached/appendbykey.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - Memcached::appendByKey - Ajoute des données à un élément - - - - &reftitle.description; - - public boolnullMemcached::appendByKey - stringserver_key - stringkey - stringvalue - - - Memcached::appendByKey est fonctionnellement équivalent - à Memcached::append, mais la variable libre - server_key peut être utilisée pour diriger - la clé key sur un serveur spécifique. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - La clé de l'élément à qui ajouter des données. - - - - - value - - - La chaîne à ajouter. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Retourne &null; si la compression est activée. - - - - - &reftitle.errors; - - Retourne &null; et lève un E_WARNING - si la compression est activée. - - - - - &reftitle.seealso; - - - Memcached::append - Memcached::prepend - - - - - - - diff --git a/reference/memcached/memcached/cas.xml b/reference/memcached/memcached/cas.xml deleted file mode 100644 index 639855a4f4..0000000000 --- a/reference/memcached/memcached/cas.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - Memcached::cas - Compare et échange un élément - - - - &reftitle.description; - - public boolMemcached::cas - stringintfloatcas_token - stringkey - mixedvalue - intexpiration0 - - - Memcached::cas effectue une opération de - "check and set" (littéralement, vérifie et assigne), - de manière que l'élément ne soit stocké que si aucun autre client - ne l'a mis à jour depuis qu'il a été lu par le client courant. La vérification - est faite via le paramètre cas_token qui est une - valeur 64 bits unique, assignée à l'élément par memcached. Voir la documentation - de Memcached::get* pour savoir comment obtenir cette - valeur. À noter que cette valeur est représentée par un nombre flottant, à cause - de limitations dans l'espace des entiers de PHP. - - - - - &reftitle.parameters; - - - - cas_token - - - Valeur unique associée à un élément existant. Généré par memcached. - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - La méthode Memcached::getResultCode va retourner - la constante Memcached::RES_DATA_EXISTS si l'élément - qu'on essaie de stocker a été modifié depuis la dernière lecture. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::cas</function> - -addServer('localhost', 11211); - -do { - /* Lit une IP et son CAS */ - $ips = $m->get('ip_block', null, $cas); - /* Si l'IP n'existe pas encore, on la crée et on fait un - ajout atomique qui va échouer si l'IP a déjà été ajoutée */ - if ($m->getResultCode() == Memcached::RES_NOTFOUND) { - $ips = array($_SERVER['REMOTE_ADDR']); - $m->add('ip_block', $ips); - /* Sinon, on ajoute l'IP à la liste, et on la stocke avec l'opération - compare-and-swap et le token, qui va échouer si la liste a été mise à jour */ - } else { - $ips[] = $_SERVER['REMOTE_ADDR']; - $m->cas($cas, 'ip_block', $ips); - } -} while ($m->getResultCode() != Memcached::RES_SUCCESS); - -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::casByKey - - - - - - - diff --git a/reference/memcached/memcached/casbykey.xml b/reference/memcached/memcached/casbykey.xml deleted file mode 100644 index bdf3fbe4a6..0000000000 --- a/reference/memcached/memcached/casbykey.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - Memcached::casByKey - Compare et échange un élément sur un serveur - - - - &reftitle.description; - - public boolMemcached::casByKey - stringintfloatcas_token - stringserver_key - stringkey - mixedvalue - intexpiration0 - - - Memcached::casByKey est fonctionnellement équivalent - à Memcached::cas, mais la variable libre - server_key peut être utilisée pour diriger - la clé key sur un serveur spécifique. Ceci est utile pour - conserver un groupe de variables groupées sur un serveur. - - - - - &reftitle.parameters; - - - - cas_token - - - Valeur unique, associée à un élément existant. Généré par memcache. - - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - La méthode Memcached::getResultCode va retourner - Memcached::RES_DATA_EXISTS si l'élément qu'on essaie - de stocker a été modifié depuis la dernière lecture. - - - - - &reftitle.seealso; - - - Memcached::cas - - - - - - - diff --git a/reference/memcached/memcached/construct.xml b/reference/memcached/memcached/construct.xml deleted file mode 100644 index 543667003b..0000000000 --- a/reference/memcached/memcached/construct.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Memcached::__construct - Crée un objet Memcached - - - - &reftitle.description; - - public Memcached::__construct - stringnullpersistent_id&null; - callablenullcallback&null; - stringnullconnection_str&null; - - - Crée un objet Memcached représentant la connexion au serveur memcache. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - persistent_id - - - Par défaut, les instances Memcached sont détruites à la fin de la - requête. Pour créer un objet qui persiste entre les requêtes, utiliser - le paramètre persistent_id pour spécifier un identifiant - unique pour l'instance. Tous les objets créés avec le même - identifiant persistent_id partageront la même connexion. - - - - - callback - - - voidcallback - Memcachedmemcached - stringnullpersistent_id - - - Le paramètre callback est appelé lorsque la - connexion est établie. Il devrait être un callable PHP - valide qui reçoit l'objet Memcached comme premier - paramètre, et persistent_id comme second. - - - - - connection_str - - - Ce paramètre est utilisé pour passer des options de connexion - supplémentaires aux serveurs memcache, comme un poids de serveur - dans un cluster. - - - - - - - - - &reftitle.examples; - - - Création d'un objet Memcached - - -]]> - - - - - - - diff --git a/reference/memcached/memcached/decrement.xml b/reference/memcached/memcached/decrement.xml deleted file mode 100644 index d0e7dcc96f..0000000000 --- a/reference/memcached/memcached/decrement.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - Memcached::decrement - Décrémente une valeur numérique - - - - &reftitle.description; - - public intfalseMemcached::decrement - stringkey - intoffset1 - intinitial_value0 - intexpiry0 - - - Memcached::decrement décrémente la valeur numérique - de offset unités. Si l'élément n'est pas numérique, - une erreur sera émise. Si l'opération tente de décrémenter en dessous de 0, - la nouvelle valeur sera 0. Memcached::decrement - va définir l'élément à la valeur du paramètre initial_value - si la clé n'existe pas. - - - - - &reftitle.parameters; - - - - key - - - La clé de l'élément à décrémenter. - - - - - offset - - - La quantité avec laquelle diminuer l'élément. - - - - - initial_value - - - La valeur à utiliser pour définir l'élément s'il n'existe - pas. - - - - - expiry - - - Le délai d'expiration dans la définition de l'élément. - - - - - - - - - &reftitle.returnvalues; - - Retourne la nouvelle valeur de l'élément en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::decrement</function> - -addServer('localhost', 11211); - -$m->set('counter', 5); -$n = $m->decrement('counter'); -var_dump($n); - -$n = $m->decrement('counter', 10); -var_dump($n); - -var_dump($m->get('counter')); - -$m->set('counter', 'abc'); -$n = $m->increment('counter'); -// ^ va échouer en raison du fait que la valeur de l'élément n'est pas un numérique -var_dump($n); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::increment - Memcached::incrementByKey - Memcached::decrementByKey - - - - - - - diff --git a/reference/memcached/memcached/decrementbykey.xml b/reference/memcached/memcached/decrementbykey.xml deleted file mode 100644 index 41d81d3309..0000000000 --- a/reference/memcached/memcached/decrementbykey.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - Memcached::decrementByKey - Décrémente une valeur numérique d'un élément, stocké sur un serveur spécifique - - - - &reftitle.description; - - public intfalseMemcached::decrementByKey - stringserver_key - stringkey - intoffset1 - intinitial_value0 - intexpiry0 - - - Memcached::decrementByKey décrémente une valeur numérique - d'un élément en spécifiant l'incrément via le paramètre offset. - Si la valeur de l'élément n'est pas un numérique, une erreur sera émise. - Si l'opération décrémente la valeur en dessous de 0, la nouvelle valeur sera 0. - Memcached::decrementByKey va définir l'élément à la valeur - du paramètre initial_value si la clé n'existe pas. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - La clé de l'élément à décrémenter. - - - - - offset - - - L'incrément à utiliser sur la valeur de l'élément. - - - - - initial_value - - - La valeur à définir si l'élément n'existe pas. - - - - - expiry - - - Le délai d'expiration pour la définition de l'élément. - - - - - - - - - &reftitle.returnvalues; - - Retourne la nouvelle valeur de l'élément en cas de succès&return.falseforfailure;. - - - - - &reftitle.seealso; - - - Memcached::decrement - Memcached::increment - Memcached::incrementByKey - - - - - - - diff --git a/reference/memcached/memcached/delete.xml b/reference/memcached/memcached/delete.xml deleted file mode 100644 index b138da145d..0000000000 --- a/reference/memcached/memcached/delete.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - Memcached::delete - Efface un élément - - - - &reftitle.description; - - public boolMemcached::delete - stringkey - inttime0 - - - Efface l'élément représenté par la clé key du serveur. - - - - - &reftitle.parameters; - - - - key - - - La clé à effacer. - - - - - time - - - La durée d'effacement sur le serveur. - - &memcached.note.delete-time; - - - - - - - - &reftitle.returnvalues; - - &return.success; - La méthode Memcached::getResultCode retourne - Memcached::RES_NOTFOUND si la clé n'existe pas. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::delete</function> - -addServer('localhost', 11211); - -$m->delete('key1'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::deleteByKey - Memcached::deleteMulti - - - - - - - diff --git a/reference/memcached/memcached/deletebykey.xml b/reference/memcached/memcached/deletebykey.xml deleted file mode 100644 index 122cc214f7..0000000000 --- a/reference/memcached/memcached/deletebykey.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - Memcached::deleteByKey - Supprime un élément d'un serveur spécifique - - - - &reftitle.description; - - public boolMemcached::deleteByKey - stringserver_key - stringkey - inttime0 - - - Memcached::deleteByKey est fonctionnellement équivalente à - Memcached::delete, hormis la variable libre - server_key qui peut être utilisée pour diriger la variable - key sur un serveur spécifique. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - La clé à effacer. - - - - - time - - - La durée d'attente de l'effacement. - - &memcached.note.delete-time; - - - - - - - - &reftitle.returnvalues; - - &return.success; - La méthode Memcached::getResultCode retourne - Memcached::RES_NOTFOUND si la clé n'existe pas. - - - - - &reftitle.seealso; - - - Memcached::delete - Memcached::deleteMulti - Memcached::deleteMultiByKey - - - - - - - diff --git a/reference/memcached/memcached/deletemulti.xml b/reference/memcached/memcached/deletemulti.xml deleted file mode 100644 index 3d8dcdc563..0000000000 --- a/reference/memcached/memcached/deletemulti.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - Memcached::deleteMulti - Supprime plusieurs éléments - - - - &reftitle.description; - - public arrayMemcached::deleteMulti - arraykeys - inttime0 - - - Supprime le tableau de clés keys du serveur. - - - - - &reftitle.parameters; - - - - keys - - - Les clés à supprimer. - - - - - time - - - Le délai d'attente du serveur pour supprimer les éléments. - - &memcached.note.delete-time; - - - - - - - - &reftitle.returnvalues; - &memcached.result.delete-multi; - - - - &reftitle.seealso; - - - Memcached::delete - Memcached::deleteByKey - Memcached::deleteMultiByKey - - - - - - - diff --git a/reference/memcached/memcached/deletemultibykey.xml b/reference/memcached/memcached/deletemultibykey.xml deleted file mode 100644 index 7d04542972..0000000000 --- a/reference/memcached/memcached/deletemultibykey.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - Memcached::deleteMultiByKey - Supprime plusieurs éléments depuis un serveur spécifique - - - - &reftitle.description; - - public arrayMemcached::deleteMultiByKey - stringserver_key - arraykeys - inttime0 - - - Memcached::deleteMultiByKey est fonctionnellement identique - à la méthode Memcached::deleteMulti, excepté le fait que - le paramètre server_key peut être utilisé pour lier - les clés keys avec un serveur spécifique. - - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - keys - - - Les clés à supprimer. - - - - - time - - - Le délai d'attente du serveur avant suppression des éléments. - - &memcached.note.delete-time; - - - - - - - - &reftitle.returnvalues; - &memcached.result.delete-multi; - - - - &reftitle.seealso; - - - Memcached::delete - Memcached::deleteByKey - Memcached::deleteMulti - - - - - - - diff --git a/reference/memcached/memcached/fetch.xml b/reference/memcached/memcached/fetch.xml deleted file mode 100644 index e3a0105000..0000000000 --- a/reference/memcached/memcached/fetch.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - Memcached::fetch - Lit le prochain résultat - - - - &reftitle.description; - - public arrayfalseMemcached::fetch - - - - Memcached::fetch lit le prochain résultat de la dernière - requête. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le résultat suivant, ou bien &false; sinon. - La méthode Memcached::getResultCode va retourner - Memcached::RES_END si le jeu de résultats est fini. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::fetch</function> - -addServer('localhost', 11211); - -$m->set('int', 99); -$m->set('string', 'a simple string'); -$m->set('array', array(11, 12)); - -$m->getDelayed(array('int', 'array'), true); -while ($result = $m->fetch()) { - var_dump($result); -} -?> -]]> - - &example.outputs.similar; - - - string(3) "int" - ["value"]=> - int(99) - ["cas"]=> - float(2363) -} -array(3) { - ["key"]=> - string(5) "array" - ["value"]=> - array(2) { - [0]=> - int(11) - [1]=> - int(12) - } - ["cas"]=> - float(2365) -} -]]> - - - - - - - &reftitle.seealso; - - - Memcached::fetchAll - Memcached::getDelayed - - - - - - - diff --git a/reference/memcached/memcached/fetchall.xml b/reference/memcached/memcached/fetchall.xml deleted file mode 100644 index 98a63aede5..0000000000 --- a/reference/memcached/memcached/fetchall.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - Memcached::fetchAll - Lit tous les autres éléments - - - - &reftitle.description; - - public arrayfalseMemcached::fetchAll - - - - Memcached::fetchAll lit tous les éléments de la - dernière requête. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les résultats&return.falseforfailure;. - Utiliser Memcached::getResultCode si nécessaire. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::fetchAll</function> - -addServer('localhost', 11211); - -$m->set('int', 99); -$m->set('string', 'a simple string'); -$m->set('array', array(11, 12)); - -$m->getDelayed(array('int', 'array'), true); -var_dump($m->fetchAll()); -?> -]]> - - &example.outputs; - - - array(3) { - ["key"]=> - string(3) "int" - ["value"]=> - int(99) - ["cas"]=> - float(2363) - } - [1]=> - array(3) { - ["key"]=> - string(5) "array" - ["value"]=> - array(2) { - [0]=> - int(11) - [1]=> - int(12) - } - ["cas"]=> - float(2365) - } -} -]]> - - - - - - - &reftitle.seealso; - - - Memcached::fetch - Memcached::getDelayed - - - - - - - diff --git a/reference/memcached/memcached/flush.xml b/reference/memcached/memcached/flush.xml deleted file mode 100644 index 80c8f8c370..0000000000 --- a/reference/memcached/memcached/flush.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - Memcached::flush - Invalide tous les éléments du cache - - - - &reftitle.description; - - public boolMemcached::flush - intdelay0 - - - Memcached::flush invalide tous les éléments du cache, - immédiatement (par défaut), ou après un délai de delay - secondes. Après une invalidation, aucun élément ne sera retourné en réponse - à une commande de lecture (à moins qu'il ne soit stocké une nouvelle fois - sous la même clé, après l'opération de Memcached::flush). - Cette opération ne libère pas la mémoire occupée par les éléments - existants : cela se fera graduellement, avec le stockage des nouveaux - éléments. - - - - - &reftitle.parameters; - - - - delay - - - Le nombre de secondes d'attente avant l'invalidation. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::flush</function> - -addServer('localhost', 11211); - -/* invalide tous les éléments dans 10 secondes */ -$m->flush(10); -?> -]]> - - - - - - - - diff --git a/reference/memcached/memcached/get.xml b/reference/memcached/memcached/get.xml deleted file mode 100644 index ad83d6d817..0000000000 --- a/reference/memcached/memcached/get.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - Memcached::get - Lit un élément - - - - &reftitle.description; - - public mixedMemcached::get - stringkey - callablenullcache_cb&null; - intget_flags0 - - - Memcached::get lit un élément qui a été stocké précédemment - avec la clé key. Si l'élément est trouvé, et que - get_flags est fourni Memcached::GET_EXTENDED, - la valeur du jeton CAS de l'élément sera aussi retournée. - Voir Memcached::cas pour savoir comment utiliser les - jetons CAS. Une Fonction de rappel en cas - d'absence peut être - spécifiée avec le paramètre cache_cb. - - - - - - - &reftitle.parameters; - - - - key - - - La clé de l'élément à lire. - - - - - cache_cb - - - Une fonction de rappel en cas d'absence ou &null;. - - - - - get_flags - - - Drapeaux pour contrôler le résultat retourné. - Quand Memcached::GET_EXTENDED - est fourni, la fonction retournera aussi le jeton CAS. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur stockée dans le cache, ou bien &false; sinon. - Si get_flags est défini à - Memcached::GET_EXTENDED, un &array; contenant - la valeur et le jeton CAS est retourné au lieu d'uniquement la valeur. - La méthode Memcached::getResultCode retourne - Memcached::RES_NOTFOUND si la clé n'existe pas. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcached 3.0.0 - - Le paramètre cas_token a été supprimé. - Memcached::GET_EXTENDED a été ajoutée et quand passé en - tant que drapeau il s'assure que les jetons CAS sont récupérés. - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::get</function> 1 - -addServer('localhost', 11211); - -$m->set('foo', 100); -var_dump($m->get('foo')); -?> -]]> - - &example.outputs; - - - - - - Exemple avec <function>Memcached::get</function> 2 - -addServer('localhost', 11211); - -if (!($ip = $m->get('ip_block'))) { - if ($m->getResultCode() == Memcached::RES_NOTFOUND) { - $ip = array(); - $m->set('ip_block', $ip); - } else { - /* log error */ - /* ... */ - } -} -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::getByKey - Memcached::getMulti - Memcached::getDelayed - - - - - - - diff --git a/reference/memcached/memcached/getallkeys.xml b/reference/memcached/memcached/getallkeys.xml deleted file mode 100644 index c6e2b47be9..0000000000 --- a/reference/memcached/memcached/getallkeys.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - Memcached::getAllKeys - Récupère toutes les clés stockées sur tous les serveurs - - - - &reftitle.description; - - public arrayfalseMemcached::getAllKeys - - - - Memcached::getAllKeys interroge chaque serveur memcache - et récupère un tableau contenant toutes les clés stockées sur chacun d'eux. - Ce n'est pas une opération atomique, aussi, ce n'est pas une image - réellement consistante des clés à l'instant donné. Sachant que memcache - ne garantit pas de retourner toutes les clés, il n'est pas possible d'être certain - que toutes les clés ont bien été retournées. - - - - Cette méthode est destinée à des fins de débogage et ne doit pas être utilisée à grande échelle ! - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les clés stockées sur tous les serveurs en cas - de succès&return.falseforfailure;. - - - - - - diff --git a/reference/memcached/memcached/getbykey.xml b/reference/memcached/memcached/getbykey.xml deleted file mode 100644 index c3847ba195..0000000000 --- a/reference/memcached/memcached/getbykey.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - Memcached::getByKey - Lit un élément sur un serveur spécifique - - - - &reftitle.description; - - public mixedMemcached::getByKey - stringserver_key - stringkey - callablenullcache_cb&null; - intget_flags0 - - - Memcached::getByKey est fonctionnellement équivalente à - Memcached::get, hormis le fait que la variable libre - server_key peut être utilisée pour diriger la clé - key sur un serveur spécifique. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - La clé de l'élément à lire. - - - - - cache_cb - - - Fonction de rappel en cas d'absence, ou &null; - - - - - get_flags - - - Drapeaux pour contrôler le résultat retourné. - Quand Memcached::GET_EXTENDED - est fourni, la fonction retournera aussi le jeton CAS. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur stockée dans le cache, ou &false; sinon. - La méthode Memcached::getResultCode retourne - Memcached::RES_NOTFOUND si la clé n'existe pas. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcached 3.0.0 - - Le paramètre cas_token a été supprimé. - Memcached::GET_EXTENDED a été ajoutée et quand passé en - tant que drapeau il s'assure que les jetons CAS sont récupérés. - - - - - - - - - &reftitle.seealso; - - - Memcached::get - Memcached::getMulti - Memcached::getDelayed - - - - - - - diff --git a/reference/memcached/memcached/getdelayed.xml b/reference/memcached/memcached/getdelayed.xml deleted file mode 100644 index 896d5530a4..0000000000 --- a/reference/memcached/memcached/getdelayed.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - Memcached::getDelayed - Lit plusieurs éléments - - - - &reftitle.description; - - public boolMemcached::getDelayed - arraykeys - boolwith_cas&false; - callablenullvalue_cb&null; - - - Memcached::getDelayed émet une commande à memcache pour - lire plusieurs clés qui sont spécifiées dans le tableau keys. - La méthode n'attend pas la réponse et retourne immédiatement. Lorsqu'on est prêt - à lire les éléments, appelez les méthodes Memcached::fetch ou - Memcached::fetchAll. Si with_cas - vaut &true; le CAS sera aussi lu. - - - Au lieu de lire les résultats explicitement, il est possible de spécifier une - fonction de rappel de résultats via - le paramètre value_cb. - - - - - &reftitle.parameters; - - - - keys - - - Un tableau de clés à lire. - - - - - with_cas - - - S'il faut lire les CAS. - - - - - value_cb - - - Une fonction de rappel de résultats, ou &null;. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::getDelayed</function> - -addServer('localhost', 11211); - -$m->set('int', 99); -$m->set('string', 'a simple string'); -$m->set('array', array(11, 12)); - -$m->getDelayed(array('int', 'array'), true); -var_dump($m->fetchAll()); -?> -]]> - - &example.outputs; - - - array(3) { - ["key"]=> - string(3) "int" - ["value"]=> - int(99) - ["cas"]=> - float(2363) - } - [1]=> - array(3) { - ["key"]=> - string(5) "array" - ["value"]=> - array(2) { - [0]=> - int(11) - [1]=> - int(12) - } - ["cas"]=> - float(2365) - } -} -]]> - - - - - - - &reftitle.seealso; - - - Memcached::getDelayedByKey - Memcached::fetch - Memcached::fetchAll - - - - - - - diff --git a/reference/memcached/memcached/getdelayedbykey.xml b/reference/memcached/memcached/getdelayedbykey.xml deleted file mode 100644 index a87c2aa3f7..0000000000 --- a/reference/memcached/memcached/getdelayedbykey.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - Memcached::getDelayedByKey - Lit plusieurs éléments sur un serveur - - - - &reftitle.description; - - public boolMemcached::getDelayedByKey - stringserver_key - arraykeys - boolwith_cas&false; - callablenullvalue_cb&null; - - - Memcached::getDelayedByKey est fonctionnellement équivalent - à Memcached::getDelayed, mais la variable libre - server_key peut être utilisée pour diriger - la clé key sur un serveur spécifique. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - keys - - - Un tableau de clés à lire. - - - - - with_cas - - - S'il faut aussi lire les CAS. - - - - - value_cb - - - Une fonction de rappel de résultats, ou &null;. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.seealso; - - - Memcached::getDelayed - Memcached::fetch - Memcached::fetchAll - - - - - - - diff --git a/reference/memcached/memcached/getmulti.xml b/reference/memcached/memcached/getmulti.xml deleted file mode 100644 index 291b66c809..0000000000 --- a/reference/memcached/memcached/getmulti.xml +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - Memcached::getMulti - Lit plusieurs éléments - - - - &reftitle.description; - - public arrayfalseMemcached::getMulti - arraykeys - intget_flags0 - - - Memcached::getMulti est similaire à la méthode - Memcached::get, mais au lieu d'un seul élément, - elle sait lire plusieurs éléments spécifiés par le tableau - keys. - - - Avant v3.0 un deuxième argument - cas_tokens était utilisé. - Il était rempli avec les valeurs des jetons CAS pour les éléments trouvés. - Le paramètre cas_tokens a été supprimé - dans la v3.0 de l'extension. - Il a été remplacé par un nouveau drapeau Memcached::GET_EXTENDED - qui doit être utilisé comme valeur pour get_flags. - - - - - Le paramètre get_flags sert à spécifier des options - supplémentaires pour Memcached::getMulti. - Memcached::GET_PRESERVE_ORDER garantit que les - clés sont retournées dans le même ordre que celui de leur requête. - Memcached::GET_EXTENDED garantit que les - jetons CAS seront aussi récupérés. - - - - - &reftitle.parameters; - - - - keys - - - Un tableau de clés à lire. - - - - - get_flags - - - Les options pour cette opération. - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau d'éléments lus&return.falseforfailure;. - &memcached.result.getresultcode; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcached 3.0.0 - - Le paramètre cas_tokens a été supprimé. - Memcached::GET_EXTENDED a été ajoutée et quand passé en - tant que drapeau il s'assure que les jetons CAS sont récupérés. - - - - - - - - - &reftitle.examples; - - - Exemple de <function>Memcached::getMulti</function> pour Memcached v3 - -addServer('localhost', 11211); - -$items = array( - 'key1' => 'value1', - 'key2' => 'value2', - 'key3' => 'value3' -); -$m->setMulti($items); -$result = $m->getMulti(array('key1', 'key3', 'badkey')); -var_dump($result); -?> -]]> - - &example.outputs.similar; - - - string(6) "value1" - ["key3"]=> - string(6) "value3" -} -]]> - - - - - - - Exemple de <function>Memcached::getMulti</function> pour Memcached v1 et v2 - -addServer('localhost', 11211); - -$items = array( - 'key1' => 'value1', - 'key2' => 'value2', - 'key3' => 'value3' -); -$m->setMulti($items); -$result = $m->getMulti(array('key1', 'key3', 'badkey'), $cas); -var_dump($result, $cas); -?> -]]> - - &example.outputs.similar; - - - string(6) "value1" - ["key3"]=> - string(6) "value3" -} -array(2) { - ["key1"]=> - float(2360) - ["key3"]=> - float(2362) -} -]]> - - - - - - Exemple de <constant>Memcached::GET_PRESERVE_ORDER</constant> pour Memcached v3 - -addServer('localhost', 11211); - -$data = array( - 'foo' => 'foo-data', - 'bar' => 'bar-data', - 'baz' => 'baz-data', - 'lol' => 'lol-data', - 'kek' => 'kek-data', -); - -$m->setMulti($data, 3600); - -$keys = array_keys($data); -$keys[] = 'zoo'; -$got = $m->getMulti($keys, Memcached::GET_PRESERVE_ORDER); - -foreach ($got as $k => $v) { - echo "$k $v\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - Exemple de <constant>Memcached::GET_PRESERVE_ORDER</constant> pour Memcached v1 et v2 - -addServer('localhost', 11211); - -$data = array( - 'foo' => 'foo-data', - 'bar' => 'bar-data', - 'baz' => 'baz-data', - 'lol' => 'lol-data', - 'kek' => 'kek-data', -); - -$m->setMulti($data, 3600); - -$null = null; -$keys = array_keys($data); -$keys[] = 'zoo'; -$got = $m->getMulti($keys, $null, Memcached::GET_PRESERVE_ORDER); - -foreach ($got as $k => $v) { - echo "$k $v\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Memcached::getMultiByKey - Memcached::get - Memcached::getDelayed - - - - - - - diff --git a/reference/memcached/memcached/getmultibykey.xml b/reference/memcached/memcached/getmultibykey.xml deleted file mode 100644 index a812d10567..0000000000 --- a/reference/memcached/memcached/getmultibykey.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - Memcached::getMultiByKey - Lit plusieurs éléments d'un serveur spécifique - - - - &reftitle.description; - - public arrayfalseMemcached::getMultiByKey - stringserver_key - arraykeys - intget_flags0 - - - Memcached::getMultiByKey est fonctionnellement équivalent - à Memcached::getMulti, mais la variable libre - server_key peut être utilisée pour diriger - la clé key sur un serveur spécifique. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - keys - - - Un tableau de clés à lire. - - - - - get_flags - - - Les options de l'opération. - - - - - - - - - &reftitle.returnvalues; - - Retourne le tableau des éléments trouvés&return.falseforfailure;. - &memcached.result.getresultcode; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcached 3.0.0 - - Le paramètre cas_tokens a été supprimé. - Memcached::GET_EXTENDED a été ajoutée et quand passé en - tant que drapeau il s'assure que les jetons CAS sont récupérés. - - - - - - - - - &reftitle.seealso; - - - Memcached::getMulti - Memcached::get - Memcached::getDelayed - - - - - - - diff --git a/reference/memcached/memcached/getoption.xml b/reference/memcached/memcached/getoption.xml deleted file mode 100644 index 035c64ba3c..0000000000 --- a/reference/memcached/memcached/getoption.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - Memcached::getOption - Lit une option Memcached - - - - &reftitle.description; - - public mixedMemcached::getOption - intoption - - - Retourne la valeur de l'option Memcached - option. Ces options sont définies par - libmemcached, et d'autres sont spécifiques à cette extension. - Voir constantes Memcached - pour plus d'informations. - - - - - &reftitle.parameters; - - - - option - - - Une des constantes Memcached::OPT_*. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur de l'option demandée, ou - bien &false; si une erreur survient. - - - - - &reftitle.examples; - - - Lecture des options Memcached - -getOption(Memcached::OPT_COMPRESSION)); -var_dump($m->getOption(Memcached::OPT_POLL_TIMEOUT)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Memcached::getOption - Memcached::setOption - les constantes Memcached - - - - - - - diff --git a/reference/memcached/memcached/getresultcode.xml b/reference/memcached/memcached/getresultcode.xml deleted file mode 100644 index beaecb1a46..0000000000 --- a/reference/memcached/memcached/getresultcode.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Memcached::getResultCode - Retourne le code de résultat de la dernière opération - - - - &reftitle.description; - - public intMemcached::getResultCode - - - - Memcached::getResultCode retourne une des constantes - Memcached::RES_* qui indique l'état du résultat - de la dernière opération. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le code de résultat de la dernière opération Memcached. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::getResultCode</function> - -addServer('localhost', 11211); - -$m->add('foo', 'bar'); -if ($m->getResultCode() == Memcached::RES_NOTSTORED) { - /* ... */ -} -?> -]]> - - - - - - - - diff --git a/reference/memcached/memcached/getresultmessage.xml b/reference/memcached/memcached/getresultmessage.xml deleted file mode 100644 index bd26802b2a..0000000000 --- a/reference/memcached/memcached/getresultmessage.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Memcached::getResultMessage - Retourne un message décrivant le résultat de la dernière opération - - - - &reftitle.description; - - public stringMemcached::getResultMessage - - - - Memcached::getResultMessage retourne une chaîne qui - décrit le code résultat de la dernière méthode Memcached exécutée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Message décrivant le résultat de la dernière opération Memcached. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::getResultMessage</function> - -addServer('localhost', 11211); - -$m->add('foo', 'bar'); // Succès la première fois -$m->add('foo', 'bar'); -echo $m->getResultMessage(),"\n"; -?> -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/memcached/memcached/getserverbykey.xml b/reference/memcached/memcached/getserverbykey.xml deleted file mode 100644 index 3917147b10..0000000000 --- a/reference/memcached/memcached/getserverbykey.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - Memcached::getServerByKey - Dirige une clé sur un serveur - - - - &reftitle.description; - - public arrayfalseMemcached::getServerByKey - stringserver_key - - - Memcached::getServerByKey retourne le serveur qui devrait - être sélectionné par une clé server_key dans les - opérations de type Memcached::*ByKey. - - - - - &reftitle.parameters; - - - - server_key - - - La clé d'identification du serveur. - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant 3 clés : host, - port, et weight en cas de succès - &return.falseforfailure;. - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::getServerByKey</function> - -addServers(array( - array('mem1.domain.com', 11211, 40), - array('mem2.domain.com', 11211, 40), - array('mem3.domain.com', 11211, 20), -)); - -$m->setOption(Memcached::OPT_LIBKETAMA_COMPATIBLE, true); - -var_dump($m->getServerByKey('user')); -var_dump($m->getServerByKey('log')); -var_dump($m->getServerByKey('ip')); -?> -]]> - - &example.outputs.similar; - - - string(15) "mem3.domain.com" - ["port"]=> - int(11211) - ["weight"]=> - int(20) -} -array(3) { - ["host"]=> - string(15) "mem2.domain.com" - ["port"]=> - int(11211) - ["weight"]=> - int(40) -} -array(3) { - ["host"]=> - string(15) "mem2.domain.com" - ["port"]=> - int(11211) - ["weight"]=> - int(40) -} -]]> - - - - - - - - diff --git a/reference/memcached/memcached/getserverlist.xml b/reference/memcached/memcached/getserverlist.xml deleted file mode 100644 index 7f536a1452..0000000000 --- a/reference/memcached/memcached/getserverlist.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - Memcached::getServerList - Liste les serveurs du pool memcached - - - - &reftitle.description; - - public arrayMemcached::getServerList - - - - Memcached::getServerList retourne la liste de tous les serveurs - qui sont dans sa liste. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La liste de tous les serveurs du pool. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::getServerList</function> - -addServers(array( - array('mem1.domain.com', 11211, 20), - array('mem2.domain.com', 11311, 80), -)); -var_dump($m->getServerList()); -?> -]]> - - &example.outputs; - - - array(3) { - ["host"]=> - string(15) "mem1.domain.com" - ["port"]=> - int(11211) - ["weight"]=> - int(20) - } - [1]=> - array(3) { - ["host"]=> - string(15) "mem2.domain.com" - ["port"]=> - int(11311) - ["weight"]=> - int(80) - } -} -]]> - - - - - - - - diff --git a/reference/memcached/memcached/getstats.xml b/reference/memcached/memcached/getstats.xml deleted file mode 100644 index 7603bc27d3..0000000000 --- a/reference/memcached/memcached/getstats.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - Memcached::getStats - Lit des statistiques du pool de serveurs - - - - &reftitle.description; - - public arrayfalseMemcached::getStats - stringnulltype&null; - - - Memcached::getStats retourne un tableau contenant - l'état de toutes les machines en fonctionnement. Voir le - protocole memcached pour - plus de détails sur ces statistiques. - - - - - &reftitle.parameters; - - - - type - - - Le type de statistiques à récupérer. - - - - - - - - - &reftitle.returnvalues; - - Un tableau de statistiques de serveurs, une entrée par serveur, &return.falseforfailure;. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::getStats</function> - -addServer('localhost', 11211); - -print_r($m->getStats()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [pid] => 4933 - [uptime] => 786123 - [threads] => 1 - [time] => 1233868010 - [pointer_size] => 32 - [rusage_user_seconds] => 0 - [rusage_user_microseconds] => 140000 - [rusage_system_seconds] => 23 - [rusage_system_microseconds] => 210000 - [curr_items] => 145 - [total_items] => 2374 - [limit_maxbytes] => 67108864 - [curr_connections] => 2 - [total_connections] => 151 - [connection_structures] => 3 - [bytes] => 20345 - [cmd_get] => 213343 - [cmd_set] => 2381 - [get_hits] => 204223 - [get_misses] => 9120 - [evictions] => 0 - [bytes_read] => 9092476 - [bytes_written] => 15420512 - [version] => 1.2.6 - ) - -) -]]> - - - - - - - - diff --git a/reference/memcached/memcached/getversion.xml b/reference/memcached/memcached/getversion.xml deleted file mode 100644 index 8d9c6e93cd..0000000000 --- a/reference/memcached/memcached/getversion.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - Memcached::getVersion - Lit les informations de version du pool serveur - - - - &reftitle.description; - - public arrayfalseMemcached::getVersion - - - - Memcached::getVersion retourne un tableau contenant - les informations de version disponibles de tous les serveurs memcache. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Tableau de versions de serveurs, une par serveur. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::getVersion</function> - -addServer('localhost', 11211); - -print_r($m->getVersion()); -?> -]]> - - &example.outputs.similar; - - 1.2.6 -) -]]> - - - - - - - - diff --git a/reference/memcached/memcached/increment.xml b/reference/memcached/memcached/increment.xml deleted file mode 100644 index 1c2f61cdce..0000000000 --- a/reference/memcached/memcached/increment.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - Memcached::increment - Incrémente numériquement un élément - - - - &reftitle.description; - - public intfalseMemcached::increment - stringkey - intoffset1 - intinitial_value0 - intexpiry0 - - - Memcached::increment incrémente la valeur numérique - de offset unités. Si l'élément n'est pas numérique, - une erreur sera émise. Memcached::increment va définir - l'élément à la valeur du paramètre initial_value si la - clé n'existe pas. - - - - - &reftitle.parameters; - - - - key - - - La clé de l'élément à incrémenter. - - - - - offset - - - La quantité avec laquelle augmenter l'élément. - - - - - initial_value - - - La valeur à utiliser pour définir l'élément s'il n'existe pas. - - - - - expiry - - - Le délai d'expiration pour définir l'élément. - - - - - - - - - &reftitle.returnvalues; - - Retourne la nouvelle valeur de l'élément, en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::increment</function> - -addServer('localhost', 11211); - -$m->set('counter', 0); -$m->increment('counter'); -$n = $m->increment('counter', 10); -var_dump($n); - -$m->set('counter', 'abc'); -$n = $m->increment('counter'); -// ^ va échouer en raison du fait que la valeur de l'élément n'est pas un numérique -var_dump($n); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::decrement - Memcached::decrementByKey - Memcached::incrementByKey - - - - - - - diff --git a/reference/memcached/memcached/incrementbykey.xml b/reference/memcached/memcached/incrementbykey.xml deleted file mode 100644 index aaa24961ce..0000000000 --- a/reference/memcached/memcached/incrementbykey.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - Memcached::incrementByKey - Incrémente une valeur numérique d'un élément, stocké sur un serveur spécifique - - - - &reftitle.description; - - public intfalseMemcached::incrementByKey - stringserver_key - stringkey - intoffset1 - intinitial_value0 - intexpiry0 - - - Memcached::incrementByKey incrémente une valeur numérique - d'un élément en spécifiant l'incrément via le paramètre offset. - Si la valeur de l'élément n'est pas un numérique, une erreur sera émise. - Memcached::incrementByKey va définir l'élément à la valeur - du paramètre initial_value si la clé n'existe pas. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - La clé de l'élément à incrémenter. - - - - - offset - - - L'incrément à utiliser sur la valeur de l'élément. - - - - - initial_value - - - La valeur à définir si l'élément n'existe pas. - - - - - expiry - - - Le délai d'expiration pour la définition de l'élément. - - - - - - - - - &reftitle.returnvalues; - - Retourne la nouvelle valeur de l'élément en cas de succès&return.falseforfailure;. - - - - - &reftitle.seealso; - - - Memcached::decrement - Memcached::decrementByKey - Memcached::increment - - - - - - - diff --git a/reference/memcached/memcached/ispersistent.xml b/reference/memcached/memcached/ispersistent.xml deleted file mode 100644 index 8deb398e2f..0000000000 --- a/reference/memcached/memcached/ispersistent.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Memcached::isPersistent - Vérifie si une connexion persistante vers memcache est en cours d'utilisation - - - - &reftitle.description; - - public boolMemcached::isPersistent - - - - Memcached::isPersistent vérifie si les connexions - aux serveurs memcache sont des connexions persistantes. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si l'instance Memcache utilise une connexion persistante, - &false; sinon. - - - - - &reftitle.seealso; - - - Memcached::isPristine - - - - - - - diff --git a/reference/memcached/memcached/ispristine.xml b/reference/memcached/memcached/ispristine.xml deleted file mode 100644 index 94336dbdb0..0000000000 --- a/reference/memcached/memcached/ispristine.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Memcached::isPristine - Vérifie si l'instance a été créée récemment - - - - &reftitle.description; - - public boolMemcached::isPristine - - - - Memcached::isPristine vérifie si l'instance Memcache - a été créée récemment. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si l'instance a été récemment créée, &false; sinon. - - - - - &reftitle.seealso; - - - Memcached::isPersistent - - - - - - - diff --git a/reference/memcached/memcached/prepend.xml b/reference/memcached/memcached/prepend.xml deleted file mode 100644 index 305f32cf7e..0000000000 --- a/reference/memcached/memcached/prepend.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - Memcached::prepend - Préfixe des données à un élément existant - - - - &reftitle.description; - - public boolnullMemcached::prepend - stringkey - stringvalue - - - Memcached::prepend ajoute les données de - value au début d'un élément existant. La raison qui - fait que value doit être une chaîne est que les - autres types ne supportent pas cette opération. - - - - Si la constante Memcached::OPT_COMPRESSION est activée, - l'opération va échouer, et une alerte sera émise, car le préfixage - de données compressées n'est pas possible. - - - - - - &reftitle.parameters; - - - - key - - - La clé de l'élément à préfixer. - - - - - value - - - La chaîne préfixée. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Retourne &null; si la compression est activée. - - - - - &reftitle.errors; - - Retourne &null; et lève un E_WARNING - si la compression est activée. - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::prepend</function> - -addServer('localhost', 11211); -$m->setOption(Memcached::OPT_COMPRESSION, false); - -$m->set('foo', 'abc'); -$m->prepend('foo', 'def'); -var_dump($m->get('foo')); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::prependByKey - Memcached::append - - - - - - - diff --git a/reference/memcached/memcached/prependbykey.xml b/reference/memcached/memcached/prependbykey.xml deleted file mode 100644 index 6eae44c24d..0000000000 --- a/reference/memcached/memcached/prependbykey.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - Memcached::prependByKey - Préfixe un élément existant - - - - &reftitle.description; - - public boolnullMemcached::prependByKey - stringserver_key - stringkey - stringvalue - - - Memcached::prependByKey est fonctionnellement équivalent - à Memcached::prepend, mais la variable libre - server_key peut être utilisée pour diriger - la clé key sur un serveur spécifique. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - La clé de l'élément à préfixer. - - - - - value - - - La chaîne à préfixer. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Retourne &null; si la compression est activée. - - - - - &reftitle.errors; - - Retourne &null; et lève un E_WARNING - si la compression est activée. - - - - - &reftitle.seealso; - - - Memcached::prepend - Memcached::append - - - - - - - diff --git a/reference/memcached/memcached/quit.xml b/reference/memcached/memcached/quit.xml deleted file mode 100644 index 6d162c25c4..0000000000 --- a/reference/memcached/memcached/quit.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - Memcached::quit - Ferme toutes les connexions ouvertes - - - - &reftitle.description; - - public boolMemcached::quit - - - - Memcached::quit ferme toutes les connexions - ouvertes avec des serveurs memcache. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/memcached/memcached/replace.xml b/reference/memcached/memcached/replace.xml deleted file mode 100644 index b29321ef05..0000000000 --- a/reference/memcached/memcached/replace.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - Memcached::replace - Remplace un élément sous une clé - - - - &reftitle.description; - - public boolMemcached::replace - stringkey - mixedvalue - intexpiration0 - - - Memcached::replace est similaire à - Memcached::set, mais l'opération va échouer - si la clé key n'existe pas sur le serveur. - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - La méthode Memcached::getResultCode retourne - Memcached::RES_NOTSTORED si la clé n'existe pas. - - - - - &reftitle.seealso; - - - Memcached::replaceByKey - Memcached::set - Memcached::add - - - - - - - diff --git a/reference/memcached/memcached/replacebykey.xml b/reference/memcached/memcached/replacebykey.xml deleted file mode 100644 index e3edf7be91..0000000000 --- a/reference/memcached/memcached/replacebykey.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Memcached::replaceByKey - Remplace un élément spécifique sur un serveur désigné - - - - &reftitle.description; - - public boolMemcached::replaceByKey - stringserver_key - stringkey - mixedvalue - intexpiration0 - - - Memcached::replaceByKey est fonctionnellement équivalent - à la fonction Memcached::replace, hormis le fait que la - variable libre server_key peut être utilisée pour diriger la - clé key vers un serveur spécifique. Ceci est utile pour - conserver un groupe de variables groupées sur un serveur. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - La méthode Memcached::getResultCode va retourner - Memcached::RES_NOTSTORED si la clé n'existe pas. - - - - - &reftitle.seealso; - - - Memcached::replace - Memcached::set - Memcached::add - - - - - - - diff --git a/reference/memcached/memcached/resetserverlist.xml b/reference/memcached/memcached/resetserverlist.xml deleted file mode 100644 index e3121f4d82..0000000000 --- a/reference/memcached/memcached/resetserverlist.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - Memcached::resetServerList - Supprime tous les serveurs depuis la liste des serveurs - - - - &reftitle.description; - - public boolMemcached::resetServerList - - - - Memcached::resetserverlist supprime tous les serveurs - depuis la liste des serveurs connus, la rendant ainsi vide. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - Memcached::addServer - Memcached::addServers - - - - - - - diff --git a/reference/memcached/memcached/set.xml b/reference/memcached/memcached/set.xml deleted file mode 100644 index f9a17b3018..0000000000 --- a/reference/memcached/memcached/set.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - Memcached::set - Stocke un élément - - - - &reftitle.description; - - public boolMemcached::set - stringkey - mixedvalue - intexpiration0 - - - Memcached::set stocke la valeur value - sur un serveur memcache, avec la clé d'identification key. - Le paramètre expiration permet de contrôler le délai d'expiration - automatique de la valeur. - - - La valeur peut être n'importe quel type de valeur PHP, hormis une ressource, car elles - ne peuvent pas être représentées sous forme linéaire. Si l'option - Memcached::OPT_COMPRESSION est activée, la valeur sérialisée sera - aussi compressée avant stockage. - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::set</function> - -addServer('localhost', 11211); - -$m->set('int', 99); -$m->set('string', 'a simple string'); -$m->set('array', array(11, 12)); -/* L'objet va être détruit dans 5 minutes */ -$m->set('object', new stdClass, time() + 300); - - -var_dump($m->get('int')); -var_dump($m->get('string')); -var_dump($m->get('array')); -var_dump($m->get('object')); -?> -]]> - - &example.outputs.similar; - - - int(11) - [1]=> - int(12) -} -object(stdClass)#1 (0) { -} -]]> - - - - - - - &reftitle.seealso; - - - Memcached::setByKey - Memcached::add - Memcached::replace - - - - - - - diff --git a/reference/memcached/memcached/setbykey.xml b/reference/memcached/memcached/setbykey.xml deleted file mode 100644 index a721fbf02b..0000000000 --- a/reference/memcached/memcached/setbykey.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - Memcached::setByKey - Stocke un élément sur un serveur spécifique - - - - &reftitle.description; - - public boolMemcached::setByKey - stringserver_key - stringkey - mixedvalue - intexpiration0 - - - Memcached::setByKey est fonctionnellement équivalente à - Memcached::set, hormis le fait que la variable libre - server_key peut être utilisée pour envoyer la clé - key sur un serveur spécifique. Ceci est utile si on veut - grouper certaines clés sur un serveur. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::setByKey</function> - -addServer('localhost', 11211); - -/* Conserve les blocs d'IP sur un serveur */ -$m->setByKey('api-cache', 'block-ip:169.254.253.252', 1); -$m->setByKey('api-cache', 'block-ip:169.127.127.202', 1); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::set - - - - - - - diff --git a/reference/memcached/memcached/setencodingkey.xml b/reference/memcached/memcached/setencodingkey.xml deleted file mode 100644 index 93a359c170..0000000000 --- a/reference/memcached/memcached/setencodingkey.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Memcached::setEncodingKey - Définit la clé de chiffrement AES pour les données dans Memcached - - - - &reftitle.description; - - public boolMemcached::setEncodingKey - stringkey - - - Cette méthode définit la clé de chiffrement/déchiffrement AES pour les données écrites et lues depuis Memcached. - - - - - &reftitle.parameters; - - - key - - - La clé AES. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - Memcached::get - Memcached::add - Memcached::set - - - - - diff --git a/reference/memcached/memcached/setmulti.xml b/reference/memcached/memcached/setmulti.xml deleted file mode 100644 index c7199c496f..0000000000 --- a/reference/memcached/memcached/setmulti.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - Memcached::setMulti - Stocke plusieurs éléments - - - - &reftitle.description; - - public boolMemcached::setMulti - arrayitems - intexpiration0 - - - Memcached::setMulti est similaire à - Memcached::set, et au lieu de stocker une seule paire - clé / valeur, elle fonctionne sur plusieurs éléments via - items. Le délai d'expiration expiration - s'applique à tous les éléments dans leur ensemble. - - - - - &reftitle.parameters; - - - - items - - - &memcached.parameter.items; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - Exemple avec <function>Memcached::setMulti</function> - -addServer('localhost', 11211); - -$items = array( - 'key1' => 'value1', - 'key2' => 'value2', - 'key3' => 'value3' -); -$m->setMulti($items, time() + 300); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::setMultiByKey - Memcached::set - - - - - - - diff --git a/reference/memcached/memcached/setmultibykey.xml b/reference/memcached/memcached/setmultibykey.xml deleted file mode 100644 index 4fbf211a25..0000000000 --- a/reference/memcached/memcached/setmultibykey.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - Memcached::setMultiByKey - Stocke plusieurs éléments sur un serveur - - - - &reftitle.description; - - public boolMemcached::setMultiByKey - stringserver_key - arrayitems - intexpiration0 - - - Memcached::setMultiByKey est l'équivalent fonctionnel - de Memcached::setMulti, hormis le fait que le - paramètre libre server_key peut être utilisé pour - diriger les clés de items vers un serveur spécifique. - Ceci est utile pour conserver certaines clés groupées sur un seul - serveur. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - items - - - &memcached.parameter.items; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.seealso; - - - Memcached::setMulti - Memcached::set - - - - - - - diff --git a/reference/memcached/memcached/setoption.xml b/reference/memcached/memcached/setoption.xml deleted file mode 100644 index 876d02103e..0000000000 --- a/reference/memcached/memcached/setoption.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Memcached::setOption - Configure une option Memcached - - - - &reftitle.description; - - public boolMemcached::setOption - intoption - mixedvalue - - - Memcached::setOption configure une valeur de l'option Memcached - option avec la valeur value. - Certaines options correspondent à celles définies dans libmemcached, et d'autres - sont spécifiques à l'extension. - - - - - &reftitle.parameters; - - - - option - - - Une des constantes Memcached::OPT_*. - Voir les constantes Memcached pour plus d'informations. - - - - - value - - - La valeur à définir. - - - - Les options ci-dessous nécessitent que les valeurs soient spécifiées via les constantes. - - - Memcached::OPT_HASH nécessite des valeurs - Memcached::HASH_*. - - - Memcached::OPT_DISTRIBUTION nécessite des valeurs - Memcached::DISTRIBUTION_*. - - - Memcached::OPT_SERIALIZER nécessite des valeurs - Memcached::SERIALIZER_*. - - - Memcached::OPT_COMPRESSION_TYPE nécessite des valeurs - Memcached::COMPRESSION_*. - - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Configuration d'une option Memcached - -getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT); -$m->setOption(Memcached::OPT_HASH, Memcached::HASH_MURMUR); -$m->setOption(Memcached::OPT_PREFIX_KEY, "widgets"); -echo "Le préfixe de la clé est maintenant : ", $m->getOption(Memcached::OPT_PREFIX_KEY), "\n"; -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::getOption - Memcached::setOptions - Les constantes Memcached - - - - - - - diff --git a/reference/memcached/memcached/setoptions.xml b/reference/memcached/memcached/setoptions.xml deleted file mode 100644 index 3f01a1f567..0000000000 --- a/reference/memcached/memcached/setoptions.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - Memcached::setOptions - Définit des options Memcache - - - - &reftitle.description; - - public boolMemcached::setOptions - arrayoptions - - - Memcached::setOptions est une variante de la méthode - Memcached::setOption qui prend un tableau d'options - à définir. - - - - - &reftitle.parameters; - - - options - - - Un tableau associatif d'options où les clés représentent l'option - à définir, et les valeurs, la nouvelle valeur pour l'option. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Définit des options Memcache - -getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT); - -$m->setOptions(array(Memcached::OPT_HASH => Memcached::HASH_MURMUR, Memcached::OPT_PREFIX_KEY => "widgets")); - -var_dump($m->getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT); -echo "Le préfixe des clés est maintenant : ", $m->getOption(Memcached::OPT_PREFIX_KEY), "\n"; -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::getOption - Memcached::setOption - Les constantes Memcache - - - - - - - diff --git a/reference/memcached/memcached/setsaslauthdata.xml b/reference/memcached/memcached/setsaslauthdata.xml deleted file mode 100644 index a6fe0f5912..0000000000 --- a/reference/memcached/memcached/setsaslauthdata.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - Memcached::setSaslAuthData - Définit les informations à utiliser pour l'authentification - - - - &reftitle.description; - - public boolMemcached::setSaslAuthData - stringusername - stringpassword - - - Memcached::setSaslAuthData définit le nom - d'utilisateur ainsi que le mot de passe à utiliser lors de l'authentification - SASL avec les serveurs memcache. - - - - Cette méthode n'est disponible que lorsque l'extension memcache - a été compilée avec le support SASL. - - Pour plus d'informations, se reporter à la section sur l'installation de Memcache. - - - - - &reftitle.parameters; - - - - username - - - Le nom d'utilisateur à utiliser pour l'authentification. - - - - - password - - - Le mot de passe à utiliser pour l'authentification. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/memcached/memcached/touch.xml b/reference/memcached/memcached/touch.xml deleted file mode 100644 index 3c7d82fe50..0000000000 --- a/reference/memcached/memcached/touch.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - Memcached::touch - Définit une nouvelle expiration sur un élément - - - - &reftitle.description; - - public boolMemcached::touch - stringkey - intexpiration0 - - - Memcached::touch définit une nouvelle valeur d'expiration - pour une clé donnée. - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.seealso; - - - Memcached::touchByKey - - - - - - - diff --git a/reference/memcached/memcached/touchbykey.xml b/reference/memcached/memcached/touchbykey.xml deleted file mode 100644 index 81b4c2948e..0000000000 --- a/reference/memcached/memcached/touchbykey.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - Memcached::touchByKey - Définit une nouvelle expiration sur un élément d'un serveur spécifique - - - - &reftitle.description; - - public boolMemcached::touchByKey - stringserver_key - stringkey - intexpiration0 - - - Memcached::touchByKey est équivalente à la méthode - Memcached::touch, excepté le fait que le paramètre - server_key peut être utilisé pour lier la clé - key avec un serveur spécifique. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.seealso; - - - Memcached::touch - - - - - - - diff --git a/reference/memcached/memcachedexception.xml b/reference/memcached/memcachedexception.xml deleted file mode 100644 index 7cb0fb2c3e..0000000000 --- a/reference/memcached/memcachedexception.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - La classe <classname>MemcachedException</classname> - MemcachedException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - MemcachedException - - - - - MemcachedException - - - - extends - RuntimeException - - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - - -     - -     - - diff --git a/reference/memcached/sessions.xml b/reference/memcached/sessions.xml deleted file mode 100644 index 22746855a2..0000000000 --- a/reference/memcached/sessions.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Support des sessions - - Memcached fournit un gestionnaire de sessions qui peut être utilisé - pour stocker les sessions sur memcache. Une instance distincte de - memcached est utilisée en interne, ce qui fait qu'il est possible d'avoir - un pool de serveurs différent, si nécessaire. Les clés de sessions sont - stockées avec le préfixe memc.sess.key., alors - il faut en être conscient lors de l'utilisation du même serveur pour les sessions - et pour le cache. - - - - - - - session.save_handler - string - - - - Le définir à memcached pour activer le - support des sessions sur memcached. - - - - - - - session.save_path - string - - - - Définit une liste de valeurs séparées par des virgules, avec la syntaxe - nomdhote:port, à utiliser pour le pool de serveurs - de sessions. Par exemple, "sess1:11211, sess2:11211". - - - - - - - - - diff --git a/reference/memcached/setup.xml b/reference/memcached/setup.xml deleted file mode 100644 index cbacca11ab..0000000000 --- a/reference/memcached/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - - Cette extension requiert la bibliothèque cliente - libmemcached - (version 1.0.0 ou supérieure). Pour un support de l'authentification SASL, - la bibliothèque libmemcached doit avoir été compilée avec l'activation de SASL. - - - Depuis la version 0.2.0, cette extension requiert PHP version 5.2.0 ou supérieure. - -
    - - - &reference.memcached.configure; - - - - &reference.memcached.ini; - - -     - - - diff --git a/reference/mongodb/architecture.xml b/reference/mongodb/architecture.xml deleted file mode 100644 index 1e194011af..0000000000 --- a/reference/mongodb/architecture.xml +++ /dev/null @@ -1,1002 +0,0 @@ - - - - Architecture et fonctionnalités spéciales - Explications de l'architecture du pilote et des fonctionnalités spéciales - -
    - Architecture - Aperçu de l'architecture - - - Cet article explique comment tous les différents composants du pilote PHP - s'emboîtent, des bibliothèques système de base, à l'extension, et aux - bibliothèques PHP en haut. - - - - - - Le diagramme d'architecture du pilote MongoDB PHP. Le niveau le plus bas - du pilote est nos bibliothèques système : libmongoc, libbson, et - libmongocrypt. Le niveau intermédiaire est l'extension PHP MongoDB. Le - niveau supérieur est le code utilisateur PHP et inclut la bibliothèque - MongoDB PHP et des packages de plus haut niveau tels que les intégrations - de frameworks et les applications. - - - - - - - - - En haut de cette pile se trouve une - bibliothèque PHP, - qui distribue un - package Composer. - Cette bibliothèque fournit une API cohérente avec d'autres - drivers - MongoDB et implémente diverses - spécifications - croisées. Bien que l'extension puisse être utilisée directement, la bibliothèque - a un surcoût minimal et devrait être une dépendance commune pour la plupart - des applications construites avec MongoDB. - - - - En dessous de cette bibliothèque se trouve une extension PHP, qui est - distribuée via - PECL. - L'extension forme la colle entre PHP et nos bibliothèques système - (libmongoc, - libbson, et - libmongocrypt). - Son API publique fournit uniquement les fonctionnalités les plus essentielles : - - Gestion de connexions - Encodage et décodage BSON - Sérialisation et désérialisation de documents (support des bibliothèques ODM) - Exécution de commandes, requêtes, et opérations d'écriture - Gestion des curseurs pour les résultats de commandes et de requêtes - - - - - - Code source du pilote et projets JIRA - - - - Project - GitHub - JIRA - - - - - Bibliothèques PHP - mongodb/mongo-php-library - PHPLIB - - - Extensions PHP - mongodb/mongo-php-driver - PHPC - - - -
    -     -
    - -
    - Connections - Gestion de la connexion et de la persistance - - &mongodb.note.forking; - -
    - Connexions et topologie persistante (version PHP depuis 1.2.0) - - - Toutes les versions de l'extension depuis 1.2.0 conservent l'objet client - libmongoc dans le processus - PHP, ce qui lui permet de réutiliser les connexions de base de données, les - états d'authentification, et les informations de - topologie à travers plusieurs requêtes. - - - - Lorsque MongoDB\Driver\Manager::__construct est - invoqué, un hachage est créé à partir de ses arguments (c'est-à-dire la - chaîne URI et le tableau d'options). L'extension tentera de trouver un objet - client libmongoc persisté - précédemment pour ce hachage. Si un client existant ne peut pas être trouvé - pour le hachage, un nouveau client sera créé et persisté pour une utilisation - future. Ce comportement peut être désactivé via l'option du pilote - "disableClientPersistence". - - - - Chaque client contient ses propres connexions de base de données et une vue - de la topologie du serveur (par exemple, autonome, ensemble de réplicas, - grappe de fragments). En persistant le client entre les requêtes PHP, - l'extension est capable de réutiliser les connexions de base de données - établies et d'éliminer le besoin de - découvrir la topologie du serveur - à chaque requête. - - - - Considérez l'exemple suivant : - - - - 'myReplicaSet']), -]; - -foreach ($managers as $manager) { - $manager->executeCommand('test', new MongoDB\Driver\Command(['ping' => 1])); -} - -?> -]]> - - - - Les deux premiers objets Manager partageront le même - client libmongoc car leurs - arguments de constructeur sont identiques. Les troisième et quatrième objets - utiliseront chacun leur propre client. Au total, trois clients seront créés - et le processus PHP exécutant ce script ouvrira deux connexions à - 127.0.0.1 et une connexion à chacun de - rs1.example.com et rs2.example.com. - Si l'extension découvre des membres supplémentaires de l'ensemble de réplicas - après avoir émis des commandes hello, elle ouvrira des - connexions supplémentaires à ces serveurs également. - - - - Si les mêmes connexions sont réutilisées par le même processus PHP, les trois - clients seront réutilisés et aucune nouvelle connexion ne sera établie. En - fonction de la durée écoulée depuis la dernière requête servie, l'extension - peut avoir besoin d'émettre des commandes hello supplémentaires - pour mettre à jour sa vue des topologies. - -
    - -
    - Persistance des sockets (versions PHP avant 1.2.0) - - - Les versions de l'extension avant 1.2.0 utilisent l'API des flux PHP pour - les connexions de base de données, utilisant une API dans - libmongoc pour désigner des - gestionnaires personnalisés pour la communication par socket ; cependant, un - nouveau client libmongoc est créé pour chaque - MongoDB\Driver\Manager. En conséquence, l'extension - persiste les connexions de base de données individuelles mais pas l'état - d'authentification ou les informations de topologie. Cela signifie que - l'extension doit émettre des commandes au début de chaque requête pour - s'authentifier et - découvrir la topologie du serveur. - - - - Les connexions de base de données sont persistées par un hachage dérivé de - l'hôte du serveur, du port et de la chaîne URI utilisée pour construire le - MongoDB\Driver\Manager. Les options du tableau du - constructeur ne sont pas incluses dans ce hachage. - - - - - Les versions de l'extension >= 1.1.8 et < 1.2.0 ne persistent pas les - sockets pour les connexions SSL. Voir - PHPC-720 pour plus - d'informations. - - - - - Malgré ses lacunes avec les connexions SSL persistantes et les informations - de topologie, cette version de l'extension supporte toutes les - options de contexte SSL puisqu'elle - utilise l'API des flux PHP. - -
    -
    - -
    - Persister des données - Sérialisation et désérialisation des variables PHP dans MongoDB - - - Ce document explique comment les structures composées (c'est-à-dire les - documents, les tableaux et les objets) sont converties entre les valeurs BSON et PHP. - - -
    - Sérialisation en BSON - -
    - Tableaux - - - Si un tableau est un tableau compact — c'est-à-dire un - tableau vide ou les clés commencent à 0 et sont séquentielles sans trous : - tableau BSON. - - - - Si le tableau n'est pas compact — c'est-à-dire qu'il a des clés - associatives (chaînes), que les clés ne commencent pas à 0, ou qu'il y a - des trous : objet BSON. - - - - Un document de niveau supérieur (racine), toujours - sérialisé en tant que document BSON. - - -
    - Exemples - - - Ces exemples sérialisent en tant que tableau BSON : - - - - [ 8, 5, 2, 3 ] -[ 0 => 4, 1 => 9 ] => [ 4, 9 ] -]]> - - - - Ces exemples sérialisent en tant qu'objet BSON : - - - - 1, 2 => 8, 3 => 12 ] => { "0" : 1, "2" : 8, "3" : 12 } -[ "foo" => 42 ] => { "foo" : 42 } -[ 1 => 9, 0 => 10 ] => { "1" : 9, "0" : 10 } -]]> - - - - Il est à noter que les cinq exemples sont des extraits - d'un document complet, et ne représentent qu'une valeur - à l'intérieur d'un document. - - -
    -
    - -
    - Objets - - - Si un objet est de la classe stdClass, sérialiser - en tant que document BSON. - - - - Si un objet est une classe supportée qui implémente - MongoDB\BSON\Type, alors utiliser la logique - de sérialisation BSON pour ce type spécifique. - Les instances de MongoDB\BSON\Type (à - l'exclusion de MongoDB\BSON\Serializable) - ne peuvent être sérialisées que comme valeur de champ de document. Tenter - de sérialiser un tel objet en tant que document racine lèvera une - MongoDB\Driver\Exception\UnexpectedValueException. - - - - Si un objet est d'une classe inconnue implémentant l'interface - MongoDB\BSON\Type, alors une - MongoDB\Driver\Exception\UnexpectedValueException est lancée. - - - - Si un objet est d'une classe autre, sans implémenter une interface spéciale, - sérialiser en tant que document BSON. Garder seulement - les propriétés public, et ignorer les propriétés - protected et private. - - - - Si un objet est d'une classe qui implémente - MongoDB\BSON\Serializable, appeler - MongoDB\BSON\Serializable::bsonSerialize et - utiliser le tableau ou stdClass retourné pour - sérialiser en tant que document BSON ou tableau. Le type BSON sera - déterminé par les règles suivantes : - - - - - - Les documents racines doivent être sérialisés en tant que - document BSON. - - - - - Les objets MongoDB\BSON\Persistable doivent - être sérialisés en tant que document BSON. - - - - - Si MongoDB\BSON\Serializable::bsonSerialize - retourne un tableau compact, sérialiser en tant que tableau BSON. - - - - - Si MongoDB\BSON\Serializable::bsonSerialize - retourne un tableau non-compact ou stdClass, - sérialiser en tant qu'objet BSON. - - - - - Si MongoDB\BSON\Serializable::bsonSerialize - ne retourne pas un tableau ou stdClass, lance - une exception - MongoDB\Driver\Exception\UnexpectedValueException. - - - - - - - Si un objet est d'une classe qui implémente l'interface - MongoDB\BSON\Persistable (qui implique - MongoDB\BSON\Serializable), obtenir les - propriétés de manière similaire aux paragraphes précédents, mais - aussi ajouter une propriété - __pclass en tant que valeur binaire, avec un sous-type - 0x80 et des données portant le nom de la classe - entièrement qualifié de l'objet qui est sérialisé. - - - - La propriété __pclass est ajoutée au tableau ou à - l'objet retourné par - MongoDB\BSON\Serializable::bsonSerialize, ce qui - signifie qu'elle écrasera toute clé/propriété __pclass - dans la valeur de retour de - MongoDB\BSON\Serializable::bsonSerialize. Si l'on - veut éviter ce comportement et définir sa propre valeur - __pclass, - il ne faut pas implémenter - MongoDB\BSON\Persistable et devriez plutôt - implémenter - MongoDB\BSON\Serializable directement. - - -
    - Exemples - - - {"foo": 42} - -class MyClass -{ - public $foo = 42; - protected $prot = 'wine'; - private $fpr = 'cheese'; -} // => {"foo": 42} - -class AnotherClass1 implements MongoDB\BSON\Serializable -{ - public $foo = 42; - protected $prot = 'wine'; - private $fpr = 'cheese'; - - public function bsonSerialize(): array - { - return ['foo' => $this->foo, 'prot' => $this->prot]; - } -} // => {"foo": 42, "prot": "wine"} - -class AnotherClass2 implements MongoDB\BSON\Serializable -{ - public $foo = 42; - - public function bsonSerialize(): self - { - return $this; - } -} // => MongoDB\Driver\Exception\UnexpectedValueException("bsonSerialize() did not return an array or stdClass") - -class AnotherClass3 implements MongoDB\BSON\Serializable -{ - private $elements = ['foo', 'bar']; - - public function bsonSerialize(): array - { - return $this->elements; - } -} // => {"0": "foo", "1": "bar"} - -/** - * Nesting Serializable classes - */ - -class AnotherClass4 implements MongoDB\BSON\Serializable -{ - private $elements = [0 => 'foo', 2 => 'bar']; - - public function bsonSerialize(): array - { - return $this->elements; - } -} // => {"0": "foo", "2": "bar"} - -class ContainerClass1 implements MongoDB\BSON\Serializable -{ - public $things; - - public function __construct() - { - $this->things = new AnotherClass4(); - } - - function bsonSerialize(): array - { - return ['things' => $this->things]; - } -} // => {"things": {"0": "foo", "2": "bar"}} - - -class AnotherClass5 implements MongoDB\BSON\Serializable -{ - private $elements = [0 => 'foo', 2 => 'bar']; - - public function bsonSerialize(): array - { - return array_values($this->elements); - } -} // => {"0": "foo", "1": "bar"} en tant que classe racine - // ["foo", "bar"] en tant que valeur imbriquée - -class ContainerClass2 implements MongoDB\BSON\Serializable -{ - public $things; - - public function __construct() - { - $this->things = new AnotherClass5(); - } - - public function bsonSerialize(): array - { - return ['things' => $this->things]; - } -} // => {"things": ["foo", "bar"]} - - -class AnotherClass6 implements MongoDB\BSON\Serializable -{ - private $elements = ['foo', 'bar']; - - function bsonSerialize(): object - { - return (object) $this->elements; - } -} // => {"0": "foo", "1": "bar"} - -class ContainerClass3 implements MongoDB\BSON\Serializable -{ - public $things; - - public function __construct() - { - $this->things = new AnotherClass6(); - } - - public function bsonSerialize(): array - { - return ['things' => $this->things]; - } -} // => {"things": {"0": "foo", "1": "bar"}} - -class UpperClass implements MongoDB\BSON\Persistable -{ - public $foo = 42; - protected $prot = 'wine'; - private $fpr = 'cheese'; - - private $data; - - public function bsonUnserialize(array $data): void - { - $this->data = $data; - } - - public function bsonSerialize(): array - { - return ['foo' => $this->foo, 'prot' => $this->prot]; - } -} // => {"foo": 42, "prot": "wine", "__pclass": {"$type": "80", "$binary": "VXBwZXJDbGFzcw=="}} - -?> -]]> - -
    -
    -
    - -
    - Deserialization from BSON - - &mongodb.warning.duplicate-keys; - - - L'ancienne extension mongo désérialisait les documents BSON - et les tableaux BSON en tant que tableaux PHP. Tant que les tableaux PHP sont - pratiques à utiliser, ce comportement était problématique car différents - types BSON pouvaient être désérialisés en la même valeur PHP (par exemple - {"0": "foo"} et ["foo"]) et rendait - impossible d'inférer le type BSON original. Par défaut, l'extension - mongodb adresse cette préoccupation en s'assurant que les - tableaux BSON et les documents BSON sont convertis en tableaux et objets PHP, - respectivement. - - - Pour les types composés, il existe trois types de données : - - - - - - root - - - réfère à un document BSON de niveau supérieur seulement - - - - - document - - - réfère à des documents BSON imbriqués seulement - - - - - array - - - réfère à un tableau BSON - - - - - - - - A part les trois types collectifs, il est aussi possible de configurer des - champs spécifiques dans le document pour mapper les types de données - mentionnés ci-dessous. Par exemple, le type de carte suivant permet de - mapper chaque document intégré dans un tableau "addresses" - à une classe Address et chaque - champ "city" dans ces documents d'adresse intégrés à une - classe City: - - - [ - 'addresses.$' => 'MyProject\Address', - 'addresses.$.city' => 'MyProject\City', - ], -] -]]> - - - - - Chacun de ces trois types de données, ainsi que les mappages spécifiques - aux champs, peuvent être mappés contre différents types PHP. Les valeurs de - mappage possibles sont: - - - - - - non défini ou NULL (par défaut) - - - - - - Un tableau BSON sera désérialisé en un array PHP. - - - - - Un document BSON (racine ou imbriqué) sans propriété - __pclass - - - Une propriété __pclass n'est considérée comme existante que si - une propriété portant ce nom existe, et qu'elle est une valeur - binaire, et que le sous-type de la valeur binaire est 0x80. Si - une de ces trois conditions n'est pas remplie, la propriété - __pclass n'existe pas et doit être traitée comme toute autre - propriété normale. - - - devient un objet stdClass, avec chaque clé de document - BSON définie comme une propriété de stdClass - publique. - - - - - Un document BSON (racine ou imbriqué) avec une propriété - __pclass devient un objet PHP de la classe - nommée par la propriété __pclass. - - - Si la classe nommée implémente l'interface - MongoDB\BSON\Persistable, alors les - propriétés du document BSON, y compris la propriété - __pclass, sont envoyées sous forme de tableau - associatif à la fonction - MongoDB\BSON\Unserializable::bsonUnserialize - pour initialiser les propriétés de l'objet. - - - Si la classe nommée n'existe pas ou n'implémente pas - l'interface MongoDB\BSON\Persistable, - stdClass sera - utilisé et chaque clé de document BSON (y compris __pclass) - sera définie comme une propriété publique de stdClass. - - - La fonctionnalité __pclass repose sur le fait - que la propriété soit partie d'un document MongoDB récupéré. Si l'on - utilise une - projection - lors de la recherche de documents, il faut inclure le champ - __pclass dans la projection pour que cette - fonctionnalité fonctionne. - - - - - - - - - "array" - - - Transforme un tableau BSON en un array PHP. Il n'y aura - pas de traitement spécial d'une propriété __pclass - mais elle peut être définie comme un élément dans le tableau retourné - si elle était présente dans le document BSON. - - - - - - "object" ou "stdClass" - - - Transforme un tableau BSON ou un document BSON en un objet - stdClass. Il n'y aura pas de traitement spécial d'une - propriété __pclass - mais elle peut être définie comme une propriété publique dans l'objet - retourné si elle était présente dans le document BSON. - - - - - - "bson" - - - Transforme un tableau BSON en un MongoDB\BSON\PackedArray - et un document BSON en un MongoDB\BSON\Document, - indépendamment du fait que le document BSON ait une propriété - __pclass . - - - - La valeur bson n'est disponible que pour les trois - types racines, et non dans les mappages spécifiques aux champs. - - - - - - - toutes les autres chaînes de caractères - - - Définit le nom de la classe à laquelle le document BSON doit être - désérialisé. Pour les documents BSON qui incluent des propriétés - __pclass, - cette classe prendra la priorité. - - - - Si la classe nommée n'existe pas, n'est pas concrète (c'est-à-dire - qu'elle est abstraite ou une interface), ou n'implémente pas - l'interface MongoDB\BSON\Unserializable, - une exception - MongoDB\Driver\Exception\InvalidArgumentException - est lancée. - - - - Si l'objet BSON a une propriété __pclass et que - cette classe existe et implémente - MongoDB\BSON\Persistable, elle prendra - le pas sur la classe fournie dans la carte de type. - - - - Les propriétés du document BSON, y compris la propriété - __pclass, - seront envoyées sous forme de tableau associatif à la fonction - MongoDB\BSON\Unserializable::bsonUnserialize - pour initialiser les propriétés de l'objet. - - - - - - -
    - TypeMaps - - - Les TypeMaps peuvent être définis via la méthode - MongoDB\Driver\Cursor::setTypeMap sur un objet - MongoDB\Driver\Cursor, ou l'argument - $typeMap de - MongoDB\BSON\toPHP, - MongoDB\BSON\Document::toPHP, et - MongoDB\BSON\PackedArray::toPHP. Chacune des trois - classes (racine, document, et - array) peut être définie individuellement, en plus des - types spécifiques aux champs. - - - - Si la valeur dans le TypeMap est NULL, cela signifie la même - chose que la valeur par défaut pour cet élément. - -
    - -
    - Exemples - - - Ces exemples utilisent les classes suivantes: - - - - - - MyClass - - - qui n'implémente aucune interface - - - - - YourClass - - - qui implémente - MongoDB\BSON\Unserializable - - - - - OurClass - - - qui implémente - MongoDB\BSON\Persistable - - - - - TheirClass - - - qui étend OurClass - - - - - - - - La méthode MongoDB\BSON\Unserializable::bsonUnserialize - d'YourClass, OurClass, TheirClass itère sur le tableau et définit les - propriétés sans modifications. Elle ajoute aussi la - propriété $unserialized à &true;: - - - $value ) - { - $this->$k = $value; - } - $this->unserialized = true; -} -]]> - - - - - - stdClass { $foo => 'yes', $bar => false } - -{ "foo": "no", "array" : [ 5, 6 ] } - -> stdClass { $foo => 'no', $array => [ 5, 6 ] } - -{ "foo": "no", "obj" : { "embedded" : 3.14 } } - -> stdClass { $foo => 'no', $obj => stdClass { $embedded => 3.14 } } - -{ "foo": "yes", "__pclass": "MyClass" } - -> stdClass { $foo => 'yes', $__pclass => 'MyClass' } - -{ "foo": "yes", "__pclass": { "$type" : "80", "$binary" : "MyClass" } } - -> stdClass { $foo => 'yes', $__pclass => Binary(0x80, 'MyClass') } - -{ "foo": "yes", "__pclass": { "$type" : "80", "$binary" : "YourClass") } - -> stdClass { $foo => 'yes', $__pclass => Binary(0x80, 'YourClass') } - -{ "foo": "yes", "__pclass": { "$type" : "80", "$binary" : "OurClass") } - -> OurClass { $foo => 'yes', $__pclass => Binary(0x80, 'OurClass'), $unserialized => true } - -{ "foo": "yes", "__pclass": { "$type" : "44", "$binary" : "YourClass") } - -> stdClass { $foo => 'yes', $__pclass => Binary(0x44, 'YourClass') } -]]> - - - - - - "MissingClass" ] */ -{ "foo": "yes" } - -> MongoDB\Driver\Exception\InvalidArgumentException("MissingClass does not exist") - -/* typemap: [ "root" => "MyClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "MyClass" } } - -> MongoDB\Driver\Exception\InvalidArgumentException("MyClass does not implement Unserializable interface") - -/* typemap: [ "root" => "MongoDB\BSON\Unserializable" ] */ -{ "foo": "yes" } - -> MongoDB\Driver\Exception\InvalidArgumentException("Unserializable is not a concrete class") - -/* typemap: [ "root" => "YourClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "MongoDB\BSON\Unserializable" } } - -> YourClass { $foo => "yes", $__pclass => Binary(0x80, "MongoDB\BSON\Unserializable"), $unserialized => true } - -/* typemap: [ "root" => "YourClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "MyClass" } } - -> YourClass { $foo => "yes", $__pclass => Binary(0x80, "MyClass"), $unserialized => true } - -/* typemap: [ "root" => "YourClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "OurClass" } } - -> OurClass { $foo => "yes", $__pclass => Binary(0x80, "OurClass"), $unserialized => true } - -/* typemap: [ "root" => "YourClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "TheirClass" } } - -> TheirClass { $foo => "yes", $__pclass => Binary(0x80, "TheirClass"), $unserialized => true } - -/* typemap: [ "root" => "OurClass" ] */ -{ foo: "yes", "__pclass" : { "$type": "80", "$binary": "TheirClass" } } - -> TheirClass { $foo => "yes", $__pclass => Binary(0x80, "TheirClass"), $unserialized => true } -]]> - - - - - - 'YourClass' ] */ -{ foo: "yes", "__pclass" : { "$type": "80", "$binary": "YourClass" } } - -> YourClass { $foo => 'yes', $__pclass => Binary(0x80, 'YourClass'), $unserialized => true } -]]> - - - - - - 'array', 'document' => 'array' ] */ -{ "foo": "yes", "bar" : false } - -> [ "foo" => "yes", "bar" => false ] - -{ "foo": "no", "array" : [ 5, 6 ] } - -> [ "foo" => "no", "array" => [ 5, 6 ] ] - -{ "foo": "no", "obj" : { "embedded" : 3.14 } } - -> [ "foo" => "no", "obj" => [ "embedded => 3.14 ] ] - -{ "foo": "yes", "__pclass": "MyClass" } - -> [ "foo" => "yes", "__pclass" => "MyClass" ] - -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "MyClass" } } - -> [ "foo" => "yes", "__pclass" => Binary(0x80, "MyClass") ] - -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "OurClass" } } - -> [ "foo" => "yes", "__pclass" => Binary(0x80, "OurClass") ] -]]> - - - - - - 'object', 'document' => 'object' ] */ -{ "foo": "yes", "__pclass": { "$type": "80", "$binary": "MyClass" } } - -> stdClass { $foo => "yes", "__pclass" => Binary(0x80, "MyClass") } -]]> - - - -
    -
    - -
    -     - - diff --git a/reference/mongodb/book.xml b/reference/mongodb/book.xml deleted file mode 100644 index 8e937cbeff..0000000000 --- a/reference/mongodb/book.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - L'extension MongoDB - MongoDB - - - - - Cette extension est développée au-dessus des bibliothèques - libmongoc et - libbson. - Elle fournit une API minimale pour les fonctionnalités de base du pilote : - commandes, - requêtes, - écritures, - gestion de connexion, - et sérialisation BSON. - - - Les bibliothèques PHP côté utilisateur qui dépendent de cette extension - peuvent fournir des API de plus haut niveau, telles que des constructeurs - de requêtes, des méthodes d'aide pour les commandes individuelles, et - GridFS. Les développeurs d'applications devraient envisager d'utiliser - cette extension en conjonction avec la - bibliothèque MongoDB PHP, - qui implémente les mêmes API de plus haut niveau que l'on trouve dans les - pilotes MongoDB pour d'autres langages. Cette séparation des préoccupations - permet à l'extension de se concentrer sur les fonctionnalités essentielles - pour lesquelles une implémentation d'extension est primordiale pour les - performances. - - - - - &reference.mongodb.setup; - &reference.mongodb.constants; - &reference.mongodb.tutorial; - &reference.mongodb.architecture; - &reference.mongodb.security; - - &reference.mongodb.mongodb; - &reference.mongodb.bson; - &reference.mongodb.monitoring; - &reference.mongodb.exceptions; - - - diff --git a/reference/mongodb/bson.xml b/reference/mongodb/bson.xml deleted file mode 100644 index ef24d25e40..0000000000 --- a/reference/mongodb/bson.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - Classes et fonctions BSON de MongoDB - MongoDB\BSON - - - &Functions; - &reference.mongodb.functions.entities.bson; - - - &reference.mongodb.bson.document; - &reference.mongodb.bson.packedarray; - &reference.mongodb.bson.iterator; - - &reference.mongodb.bson.binary; - &reference.mongodb.bson.vectortype; - &reference.mongodb.bson.decimal128; - &reference.mongodb.bson.javascript; - &reference.mongodb.bson.maxkey; - &reference.mongodb.bson.minkey; - &reference.mongodb.bson.objectid; - &reference.mongodb.bson.regex; - &reference.mongodb.bson.timestamp; - &reference.mongodb.bson.utcdatetime; - - &reference.mongodb.bson.type; - &reference.mongodb.bson.persistable; - &reference.mongodb.bson.serializable; - &reference.mongodb.bson.unserializable; - - &reference.mongodb.bson.binaryinterface; - &reference.mongodb.bson.decimal128interface; - &reference.mongodb.bson.javascriptinterface; - &reference.mongodb.bson.maxkeyinterface; - &reference.mongodb.bson.minkeyinterface; - &reference.mongodb.bson.objectidinterface; - &reference.mongodb.bson.regexinterface; - &reference.mongodb.bson.timestampinterface; - &reference.mongodb.bson.utcdatetimeinterface; - - &reference.mongodb.bson.dbpointer; - &reference.mongodb.bson.int64; - &reference.mongodb.bson.symbol; - &reference.mongodb.bson.undefined; - diff --git a/reference/mongodb/bson/binary.xml b/reference/mongodb/bson/binary.xml deleted file mode 100644 index eca6f039d5..0000000000 --- a/reference/mongodb/bson/binary.xml +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - La classe MongoDB\BSON\Binary - MongoDB\BSON\Binary - - - - -
    - &reftitle.intro; - - Type BSON pour les données binaires (c.-à-d. tableau d'octets). Les valeurs - binaires ont également un sous-type, qui est utilisé pour indiquer quel type - de données se trouve dans le tableau d'octets. Les sous-types de zéro à 127 - sont prédéfinis ou réservés. Les sous-types de 128-255 sont définis par - l'utilisateur. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Binary - - - - final - - MongoDB\BSON\Binary - - - - MongoDB\BSON\BinaryInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - &Constants; - - const - int - MongoDB\BSON\Binary::TYPE_GENERIC - 0 - - - const - int - MongoDB\BSON\Binary::TYPE_FUNCTION - 1 - - - const - int - MongoDB\BSON\Binary::TYPE_OLD_BINARY - 2 - - - const - int - MongoDB\BSON\Binary::TYPE_OLD_UUID - 3 - - - const - int - MongoDB\BSON\Binary::TYPE_UUID - 4 - - - const - int - MongoDB\BSON\Binary::TYPE_MD5 - 5 - - - const - int - MongoDB\BSON\Binary::TYPE_ENCRYPTED - 6 - - - const - int - MongoDB\BSON\Binary::TYPE_COLUMN - 7 - - - const - int - MongoDB\BSON\Binary::TYPE_SENSITIVE - 8 - - - const - int - MongoDB\BSON\Binary::TYPE_VECTOR - 9 - - - const - int - MongoDB\BSON\Binary::TYPE_USER_DEFINED - 128 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\BSON\Binary::TYPE_GENERIC - - Données binaires génériques. - - - - - MongoDB\BSON\Binary::TYPE_FUNCTION - - Fonction. - - - - - MongoDB\BSON\Binary::TYPE_OLD_BINARY - - - Données binaires génériques (déconseillées en faveur de MongoDB\BSON\Binary::TYPE_GENERIC). - - - - - - MongoDB\BSON\Binary::TYPE_OLD_UUID - - - Identificateur universellement unique (déconseillé en faveur de - MongoDB\BSON\Binary::TYPE_UUID). Lors de l'utilisation - de ce type, les données du binaire doivent être de 16 octets de longueur. - - - Historiquement, d'autres pilotes encodent des valeurs avec ce type en - fonction de leurs conventions linguistiques (par exemple, variable - endianness), ce qui le rend non-portable. Le pilote PHP n'applique - aucune manipulation spéciale pour coder ou décoder des données avec ce - type. - - - - - - MongoDB\BSON\Binary::TYPE_UUID - - Identificateur universellement unique. Lors de l'utilisation - de ce type, les données du binaire doivent être de 16 octets de longueur et encodées selon RFC 4122. - - - - - MongoDB\BSON\Binary::TYPE_MD5 - - - Hachage MD5. Lors de l'utilisation de ce type, les données du binaire - doivent être de 16 octets de longueur. - - - - - - MongoDB\BSON\Binary::TYPE_ENCRYPTED - - Valeur chiffrée. Ce sous type est utilisé pour le chiffrement côté client. - - - - - MongoDB\BSON\Binary::TYPE_COLUMN - - Donnée de colonne. Ce sous type est utilisé pour les collections de série temporelle. - - - - - MongoDB\BSON\Binary::TYPE_SENSITIVE - - - Données sensibles. Ce sous type est utilisé pour les données sensibles - qui devraient être exclues des journaux d'évènements côté serveur si possible. - - - - - - MongoDB\BSON\Binary::TYPE_VECTOR - - - Données vectorielles. Ce sous-type est utilisé pour stocker efficacement - des données vectorielles pour une utilisation avec la recherche vectorielle - de MongoDB. - - - - - - MongoDB\BSON\Binary::TYPE_USER_DEFINED - - - Type défini par l'utilisateur. Alors que les types entre 0 et 127 sont - prédéfinis ou réservés, les types entre 128 et 255 sont définis par - l'utilisateur et peuvent être utilisés pour n'importe quoi. - - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.2.0 - - Ajout de MongoDB\BSON\Binary::TYPE_VECTOR, ainsi que des - fonctions MongoDB\BSON\Binary::fromVector, - MongoDB\BSON\Binary::getVectorType et - MongoDB\BSON\Binary::toArray. - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.17.0 - - Ajout de MongoDB\BSON\Binary::TYPE_SENSITIVE. - - - - PECL mongodb 1.12.0 - - - Implémente Stringable pour PHP 8.0+. - - - Ajout de MongoDB\BSON\Binary::TYPE_COLUMN. - - - - - PECL mongodb 1.7.0 - - Ajout de MongoDB\BSON\Binary::TYPE_ENCRYPTED. - - - - PECL mongodb 1.3.0 - - Implémente MongoDB\BSON\BinaryInterface. - - - - PECL mongodb 1.2.0 - - Implémente Serializable et - JsonSerializable. - - - - - -
    - -     - - &reference.mongodb.bson.entities.binary; - -     - - diff --git a/reference/mongodb/bson/binary/construct.xml b/reference/mongodb/bson/binary/construct.xml deleted file mode 100644 index 38e09fbd2d..0000000000 --- a/reference/mongodb/bson/binary/construct.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - - MongoDB\BSON\Binary::__construct - Construit un nouveau binaire - - - - &reftitle.description; - - final public MongoDB\BSON\Binary::__construct - stringdata - inttypeMongoDB\BSON\Binary::TYPE_GENERIC - - - - - &reftitle.parameters; - - - data (string) - - - Les données binaires. - - - - - type (int) - - - Entier 8 bits non signé indiquant le type de données. Par défaut, - la valeur est MongoDB\BSON\Binary::TYPE_GENERIC si elle n'est pas spécifiée. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lève une exception MongoDB\Driver\Exception\InvalidArgumentException si type n'est pas un entier non signé de 8 bits. - Lève une exception MongoDB\Driver\Exception\InvalidArgumentException si type est MongoDB\BSON\Binary::TYPE_UUID ou MongoDB\BSON\Binary::TYPE_OLD_UUID et data n'a pas exactement 16 octets de longueur. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.15.0 - - - Le paramètre type est désormais facultatif - et a pour valeur par défaut MongoDB\BSON\Binary::TYPE_GENERIC s'il n'est pas spécifié. - - - - - PECL mongodb 1.3.0 - - - MongoDB\Driver\Exception\InvalidArgumentException - est levée si type est - MongoDB\BSON\Binary::TYPE_UUID ou - MongoDB\BSON\Binary::TYPE_OLD_UUID et - data n'a pas exactement 16 octets de longueur. - - - - - PECL mongodb 1.1.3 - - - MongoDB\Driver\Exception\InvalidArgumentException - est levée si type n'est pas un entier non signé - de 8 bits. - - - - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Binary::__construct</function> - - -]]> - - &example.outputs; - - - string(3) "foo" - ["type"]=> - int(0) -} -]]> - - - - - - &reftitle.seealso; - - Les types BSON - - - - - - diff --git a/reference/mongodb/bson/binary/fromvector.xml b/reference/mongodb/bson/binary/fromvector.xml deleted file mode 100644 index 0cf532ddc9..0000000000 --- a/reference/mongodb/bson/binary/fromvector.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - MongoDB\BSON\Binary::fromVector - Crée un nouveau binaire avec le sous-type MongoDB\BSON\Binary::SUBTYPE_VECTOR à partir du tableau et du type de vecteur donnés - - - - &reftitle.description; - - final public static MongoDB\BSON\BinaryMongoDB\BSON\Binary::fromVector - arrayvector - MongoDB\BSON\VectorTypevectorType - - - - - &reftitle.parameters; - - - vector (array) - - - Un tableau de valeurs représentant les données vectorielles. Le type de chaque valeur doit correspondre au type indiqué par le paramètre vectorType: - - pour MongoDB\BSON\VectorType::Float32, chaque valeur doit être un float - pour MongoDB\BSON\VectorType::Int8, chaque valeur doit être un int de 8 bits, c'est-à-dire de -127 à 128 - pour MongoDB\BSON\VectorType::PackedBit, chaque valeur doit être un bool ou un int de 1 bit, c'est-à-dire 0 ou 1 - - - - - - vectorType (MongoDB\BSON\VectorType) - - - Le type de donnée du vecteur. - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouveau binaire avec le sous-type MongoDB\BSON\Binary::SUBTYPE_VECTOR. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::toArray - MongoDB\BSON\Binary::getVectorType - MongoDB\BSON\VectorType - BSON Types - - - - - - diff --git a/reference/mongodb/bson/binary/getdata.xml b/reference/mongodb/bson/binary/getdata.xml deleted file mode 100644 index ede7cc63ed..0000000000 --- a/reference/mongodb/bson/binary/getdata.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - MongoDB\BSON\Binary::getData - Retourne les données de Binary - - - - &reftitle.description; - - final public stringMongoDB\BSON\Binary::getData - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les données de Binary. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Binary::getData</function> - -getData()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/binary/gettype.xml b/reference/mongodb/bson/binary/gettype.xml deleted file mode 100644 index 3c251dd055..0000000000 --- a/reference/mongodb/bson/binary/gettype.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - MongoDB\BSON\Binary::getType - Retourne le type de Binary - - - - &reftitle.description; - - final public intMongoDB\BSON\Binary::getType - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le type de Binary. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Binary::getType</function> - -getType()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/binary/getvectortype.xml b/reference/mongodb/bson/binary/getvectortype.xml deleted file mode 100644 index 895b990169..0000000000 --- a/reference/mongodb/bson/binary/getvectortype.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - MongoDB\BSON\Binary::getVectorType - Renvoie le type de données pour un binaire avec le sous-type vecteur - - - - &reftitle.description; - - final public MongoDB\BSON\VectorTypeMongoDB\BSON\Binary::getVectorType - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le type de données du vecteur binaire. - - - - - &reftitle.errors; - - Lève une MongoDB\Driver\Exception\LogicException si le sous-type n'est pas MongoDB\BSON\Binary::SUBTYPE_VECTOR. - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - Types BSON - MongoDB\BSON\VectorType - - - - - - diff --git a/reference/mongodb/bson/binary/jsonserialize.xml b/reference/mongodb/bson/binary/jsonserialize.xml deleted file mode 100644 index 1e5d5dc37a..0000000000 --- a/reference/mongodb/bson/binary/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\Binary::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Binary::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\Binary. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/binary/toarray.xml b/reference/mongodb/bson/binary/toarray.xml deleted file mode 100644 index af91c2f64c..0000000000 --- a/reference/mongodb/bson/binary/toarray.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - MongoDB\BSON\Binary::toArray - Renvoie le vecteur sous forme de tableau pour un binaire avec le sous-type MongoDB\BSON\Binary::SUBTYPE_VECTOR - - - - &reftitle.description; - - final public arrayMongoDB\BSON\Binary::toArray - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un tableau contenant les données vectorielles. - - - - - &reftitle.errors; - - Lève une MongoDB\Driver\Exception\LogicException si le sous-type n'est pas MongoDB\BSON\Binary::SUBTYPE_VECTOR. - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::fromVector - Types BSON - - - - - - diff --git a/reference/mongodb/bson/binary/tostring.xml b/reference/mongodb/bson/binary/tostring.xml deleted file mode 100644 index 3da1293e27..0000000000 --- a/reference/mongodb/bson/binary/tostring.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - MongoDB\BSON\Binary::__toString - Retourne les données de Binary - - - - &reftitle.description; - - final public stringMongoDB\BSON\Binary::__toString - - - - &info.method.alias; MongoDB\BSON\Binary::getData. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les données de Binary. - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Binary::__toString</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::getData - Types BSON - - - - - - diff --git a/reference/mongodb/bson/binaryinterface.xml b/reference/mongodb/bson/binaryinterface.xml deleted file mode 100644 index 07c4681a72..0000000000 --- a/reference/mongodb/bson/binaryinterface.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - L'interface MongoDB\BSON\BinaryInterface - MongoDB\BSON\BinaryInterface - - -
    - &reftitle.intro; - - Cette interface est implémentée par MongoDB\BSON\Binary - pour être utilisée comme type de paramètre, de retour ou de propriété dans les classes utilisateurs. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\BinaryInterface - - - MongoDB\BSON\BinaryInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -     - - &reference.mongodb.bson.entities.binaryinterface; - -     - - diff --git a/reference/mongodb/bson/binaryinterface/getdata.xml b/reference/mongodb/bson/binaryinterface/getdata.xml deleted file mode 100644 index 5fb118bea3..0000000000 --- a/reference/mongodb/bson/binaryinterface/getdata.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\BinaryInterface::getData - Retourne les données de BinaryInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\BinaryInterface::getData - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les données de BinaryInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::getData - - - - - - diff --git a/reference/mongodb/bson/binaryinterface/gettype.xml b/reference/mongodb/bson/binaryinterface/gettype.xml deleted file mode 100644 index 7dfcaef534..0000000000 --- a/reference/mongodb/bson/binaryinterface/gettype.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\BinaryInterface::getType - Retourne le type de BinaryInterface - - - - &reftitle.description; - - abstract public intMongoDB\BSON\BinaryInterface::getType - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le type de BinaryInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::getType - - - - - - diff --git a/reference/mongodb/bson/binaryinterface/tostring.xml b/reference/mongodb/bson/binaryinterface/tostring.xml deleted file mode 100644 index 91f3300bde..0000000000 --- a/reference/mongodb/bson/binaryinterface/tostring.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - MongoDB\BSON\BinaryInterface::__toString - Retourne les données de BinaryInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\BinaryInterface::__toString - - - - &info.method.alias; MongoDB\BSON\BinaryInterface::getData. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les données de BinaryInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\BinaryInterface::getData - MongoDB\BSON\Binary::__toString - - - - - - diff --git a/reference/mongodb/bson/dbpointer.xml b/reference/mongodb/bson/dbpointer.xml deleted file mode 100644 index c9e631d95c..0000000000 --- a/reference/mongodb/bson/dbpointer.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - La classe MongoDB\BSON\DBPointer - MongoDB\BSON\DBPointer - - - - -
    - &reftitle.intro; - - Le type BSON pour le type "DBPointer". Ce type BSON est déprécié, et cette - classe ne peut pas être instanciée. Elle sera créée à partir d'un type BSON DBPointer - lors de la conversion BSON en PHP, et peut également être convertie en - BSON lors du stockage de documents dans la base de données. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\DBPointer - - - - final - - MongoDB\BSON\DBPointer - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implémente Stringable pour PHP 8.0+. - - - - - -
    - -     - - &reference.mongodb.bson.entities.dbpointer; - -     - - diff --git a/reference/mongodb/bson/dbpointer/construct.xml b/reference/mongodb/bson/dbpointer/construct.xml deleted file mode 100644 index 3b217c0f31..0000000000 --- a/reference/mongodb/bson/dbpointer/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - MongoDB\BSON\DBPointer::__construct - Construit un nouveau DBPointer (inutilisé) - - - - &reftitle.description; - - final private MongoDB\BSON\DBPointer::__construct - - - - Les objets MongoDB\BSON\DBPointer sont créés à travers - une conversion depuis un type BSON obsolète et ne peuvent pas être construits directement. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/dbpointer/jsonserialize.xml b/reference/mongodb/bson/dbpointer/jsonserialize.xml deleted file mode 100644 index 1d6d526c4b..0000000000 --- a/reference/mongodb/bson/dbpointer/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\DBPointer::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\DBPointer::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\DBPointer. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/dbpointer/tostring.xml b/reference/mongodb/bson/dbpointer/tostring.xml deleted file mode 100644 index 4bffb5789e..0000000000 --- a/reference/mongodb/bson/dbpointer/tostring.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\DBPointer::__toString - Retourne une chaîne vide - - - - &reftitle.description; - - final public stringMongoDB\BSON\DBPointer::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne vide. - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/decimal128.xml b/reference/mongodb/bson/decimal128.xml deleted file mode 100644 index fa0d4ac1ca..0000000000 --- a/reference/mongodb/bson/decimal128.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - La classe MongoDB\BSON\Decimal128 - MongoDB\BSON\Decimal128 - - - - -
    - &reftitle.intro; - - Type BSON pour le - format à virgule flottante Decimal128, - qui supporte les nombres avec jusqu'à 34 chiffres décimaux (c.-à-d. chiffres - significatifs) et une plage d'exposants de −6143 à +6144. - - - Contrairement au type BSON double (c.-à-d. float en PHP), qui ne - stocke qu'une approximation des valeurs décimales, le type de données décimal stocke - la valeur exacte. Par exemple, MongoDB\BSON\Decimal128('9.99') - a une valeur précise de 9.99 alors qu'un double 9.99 aurait une valeur - approximative de 9.9900000000000002131628…. - - &mongodb.note.decimal128; -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Decimal128 - - - - final - - MongoDB\BSON\Decimal128 - - - - MongoDB\BSON\Decimal128Interface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implémente Stringable pour PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implémente MongoDB\BSON\Decimal128Interface. - - - - PECL mongodb 1.2.0 - - Implémente Serializable et - JsonSerializable. - - - - - -
    - -     - - &reference.mongodb.bson.entities.decimal128; - -     - - diff --git a/reference/mongodb/bson/decimal128/construct.xml b/reference/mongodb/bson/decimal128/construct.xml deleted file mode 100644 index abae8cc796..0000000000 --- a/reference/mongodb/bson/decimal128/construct.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - MongoDB\BSON\Decimal128::__construct - Construit un nouveau Decimal128 - - - - &reftitle.description; - - final public MongoDB\BSON\Decimal128::__construct - stringvalue - - &mongodb.note.decimal128; - - - - &reftitle.parameters; - - - value (&string;) - - - Une chaîne décimale - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance MongoDB\Driver\Exception\InvalidArgumentException si value n'est pas une chaîne décimale valide. - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Decimal128::__construct</function> - - -]]> - - &example.outputs.similar; - - - string(9) "1234.5678" -} -object(MongoDB\BSON\Decimal128)#1 (1) { - ["dec"]=> - string(3) "NaN" -} -object(MongoDB\BSON\Decimal128)#1 (1) { - ["dec"]=> - string(8) "Infinity" -} - -]]> - - - - - - - &reftitle.seealso; - - Format de virgule flottante Decimal128 - Types BSON - - - - - - diff --git a/reference/mongodb/bson/decimal128/jsonserialize.xml b/reference/mongodb/bson/decimal128/jsonserialize.xml deleted file mode 100644 index f60ecf621c..0000000000 --- a/reference/mongodb/bson/decimal128/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\Decimal128::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Decimal128::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\Decimal128. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/decimal128/tostring.xml b/reference/mongodb/bson/decimal128/tostring.xml deleted file mode 100644 index 1c42dcf66a..0000000000 --- a/reference/mongodb/bson/decimal128/tostring.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - MongoDB\BSON\Decimal128::__toString - Retourne la représentation sous forme de chaîne de caractères de Decimal128 - - - - &reftitle.description; - - final public stringMongoDB\BSON\Decimal128::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation sous forme de chaîne de caractères de Decimal128. - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Decimal128::__toString</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Format de virgule flottante Decimal128 - Types BSON - - - - - - diff --git a/reference/mongodb/bson/decimal128interface.xml b/reference/mongodb/bson/decimal128interface.xml deleted file mode 100644 index 8000dffafc..0000000000 --- a/reference/mongodb/bson/decimal128interface.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - L'interface MongoDB\BSON\Decimal128Interface - MongoDB\BSON\Decimal128Interface - - -
    - &reftitle.intro; - - Cette interface est implémentée par - MongoDB\BSON\Decimal128 pour être utilisée comme type de paramètre, - de retour ou de propriété dans les classes utilisateurs. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\Decimal128Interface - - - MongoDB\BSON\Decimal128Interface - - - &Methods; - - -
    -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -     - - &reference.mongodb.bson.entities.decimal128interface; - -     - - diff --git a/reference/mongodb/bson/decimal128interface/tostring.xml b/reference/mongodb/bson/decimal128interface/tostring.xml deleted file mode 100644 index d8ac2f97d0..0000000000 --- a/reference/mongodb/bson/decimal128interface/tostring.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\Decimal128Interface::__toString - Retourne une représentation sous chaîne de caractères de Decimal128Interface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\Decimal128Interface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une représentation sous chaîne de caractères de Decimal128Interface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Decimal128::__toString - - - - - - diff --git a/reference/mongodb/bson/document.xml b/reference/mongodb/bson/document.xml deleted file mode 100644 index 623987b381..0000000000 --- a/reference/mongodb/bson/document.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - La classe MongoDB\BSON\Document - MongoDB\BSON\Document - - - - -
    - &reftitle.intro; - - Représente un document BSON. Cette classe est utilisée lors de la lecture de données en tant que BSON brut - et ne peut pas être modifiée. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Document - - - - final - - MongoDB\BSON\Document - - - - MongoDB\BSON\Type - - - - ArrayAccess - - - - IteratorAggregate - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.17.0 - - Implémente MongoDB\BSON\Type. - - - - - -
    - -     - - &reference.mongodb.bson.entities.document; - -     - - diff --git a/reference/mongodb/bson/document/construct.xml b/reference/mongodb/bson/document/construct.xml deleted file mode 100644 index c7defc3a4f..0000000000 --- a/reference/mongodb/bson/document/construct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\Document::__construct - Construit un nouveau document BSON (inutilisée) - - - - &reftitle.description; - - final private MongoDB\BSON\Document::__construct - - - - Les objets MongoDB\BSON\Document sont créés à travers - des méthodes de fabrique statiques et ne peuvent pas être instanciés directement. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromPHP - MongoDB\BSON\Document::fromBSON - MongoDB\BSON\Document::fromJSON - Types BSON - - - - - - diff --git a/reference/mongodb/bson/document/frombson.xml b/reference/mongodb/bson/document/frombson.xml deleted file mode 100644 index 644fce47c9..0000000000 --- a/reference/mongodb/bson/document/frombson.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - MongoDB\BSON\Document::fromBSON - Construit une nouvelle instance de document depuis une chaîne de caractères BSON - - - - &reftitle.description; - - final static public MongoDB\BSON\DocumentMongoDB\BSON\Document::fromBSON - stringbson - - - - - &reftitle.parameters; - - - bson (string) - - - Une chaîne de caractères contenant un document au format BSON. - - - - - - - - &reftitle.returnvalues; - - Retourne une nouvelle instance de MongoDB\BSON\Document. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\UnexpectedValueException si bson est une chaîne de caractères invalide ou contenant plus d'un seul document - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromPHP - MongoDB\BSON\Document::fromJSON - BSON Types - - - - - - diff --git a/reference/mongodb/bson/document/fromjson.xml b/reference/mongodb/bson/document/fromjson.xml deleted file mode 100644 index 7e5c4b9a0b..0000000000 --- a/reference/mongodb/bson/document/fromjson.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - MongoDB\BSON\Document::fromJSON - Construit une nouvelle instance de document depuis une chaîne de caractères JSON - - - - &reftitle.description; - - final static public MongoDB\BSON\DocumentMongoDB\BSON\Document::fromJSON - stringjson - - - Convertit une chaîne de caractères - JSON étendue - en sa représentation BSON. - - - - - &reftitle.parameters; - - - json (string) - - - La valeur JSON à convertir. - - - - - - - - &reftitle.returnvalues; - - Retourne une nouvelle instance de MongoDB\BSON\Document. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - Lance - MongoDB\Driver\Exception\UnexpectedValueException si - la valeur JSON ne peut pas être convertie en document BSON (par exemple en raison d'une erreur - de syntaxe). - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromPHP - MongoDB\BSON\Document::fromBSON - MongoDB JSON étendu - Type BSON - - - - - - diff --git a/reference/mongodb/bson/document/fromphp.xml b/reference/mongodb/bson/document/fromphp.xml deleted file mode 100644 index 12ac1f35c3..0000000000 --- a/reference/mongodb/bson/document/fromphp.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - MongoDB\BSON\Document::fromPHP - Construit une nouvelle instance de document depuis des données PHP - - - - &reftitle.description; - - final static public MongoDB\BSON\DocumentMongoDB\BSON\Document::fromPHP - objectarrayvalue - - - - - &reftitle.parameters; - - - value (objectarray) - - - Un objet PHP ou un tableau contenant le document. Lorsqu'on passe un - tableau avec des clés numériques, les valeurs numériques sont converties - en chaînes de caractères et utilisées comme clés de document. - - - - - - - - &reftitle.returnvalues; - - Retourne une nouvelle instance de MongoDB\BSON\Document. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromBSON - MongoDB\BSON\Document::fromJSON - Types BSON - - - - - - diff --git a/reference/mongodb/bson/document/get.xml b/reference/mongodb/bson/document/get.xml deleted file mode 100644 index 52f7a97f96..0000000000 --- a/reference/mongodb/bson/document/get.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MongoDB\BSON\Document::get - Retourne la valeur d'une clé dans un document - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Document::get - stringkey - - - - - &reftitle.parameters; - - - key (string) - - - La clé à récupérer dans le document. - - - - - - - - &reftitle.returnvalues; - - Renvoie la valeur associée à la clé donnée. Si la clé n'est pas présente dans - le document, une exception est lancée. - - - - Lorsqu'une valeur encodée en tant qu'entier 64 bits est rencontrée dans le document BSON, - la valeur de retour de cette méthode sera une - instance de MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\RuntimeException si la clé n'est pas présente dans le document. - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::has - Types BSON - - - - - - diff --git a/reference/mongodb/bson/document/getiterator.xml b/reference/mongodb/bson/document/getiterator.xml deleted file mode 100644 index e5d6bd429b..0000000000 --- a/reference/mongodb/bson/document/getiterator.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - MongoDB\BSON\Document::getIterator - Renvoie un itérateur pour le document BSON - - - - &reftitle.description; - - final public MongoDB\BSON\IteratorMongoDB\BSON\Document::getIterator - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une instance de MongoDB\BSON\Iterator qui peut être - utilisée pour itérer sur toutes les clés du document. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\UnexpectedValueException si l'itérateur BSON ne peut pas être initialisé. - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/document/has.xml b/reference/mongodb/bson/document/has.xml deleted file mode 100644 index dac3dd2f18..0000000000 --- a/reference/mongodb/bson/document/has.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - MongoDB\BSON\Document::has - Renvoie si une clé est présente dans le document - - - - &reftitle.description; - - final public boolMongoDB\BSON\Document::has - stringkey - - - - - &reftitle.parameters; - - - key (string) - - - La clé à rechercher dans le document. - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; si la clé est présente dans le document sinon &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::get - Types BSON - - - - - - diff --git a/reference/mongodb/bson/document/offsetexists.xml b/reference/mongodb/bson/document/offsetexists.xml deleted file mode 100644 index 9bd1076f60..0000000000 --- a/reference/mongodb/bson/document/offsetexists.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\BSON\Document::offsetExists - Renvoie si une clé est présente dans le document - - - &reftitle.description; - - final public boolMongoDB\BSON\Document::offsetExists - mixedkey - - - - - &reftitle.parameters; - - - - key - - - La clé à rechercher dans le document. - - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; si la clé est présente dans le document sinon &false;. - - - - - &reftitle.seealso; - - - ArrayAccess::offsetExists - MongoDB\BSON\Document::has - - - - - - diff --git a/reference/mongodb/bson/document/offsetget.xml b/reference/mongodb/bson/document/offsetget.xml deleted file mode 100644 index c651da3f5c..0000000000 --- a/reference/mongodb/bson/document/offsetget.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - MongoDB\BSON\Document::offsetGet - Retourne la valeur d'une clé dans un document - - - &reftitle.description; - - final public mixedMongoDB\BSON\Document::offsetGet - mixedkey - - - - - &reftitle.parameters; - - - - key - - - La clé à récupérer dans le document. - - - - - - - - - &reftitle.returnvalues; - - Renvoie la valeur associée à la clé donnée. Si la clé n'est pas présente dans - le document, une exception est lancée. - - - - Lorsqu'une valeur encodée en tant qu'entier 64 bits est rencontrée dans le document BSON, - la valeur de retour de cette méthode sera une - instance de MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\RuntimeException si la clé n'est pas présente dans le document. - - - - - &reftitle.seealso; - - - ArrayAccess::offsetGet - MongoDB\BSON\Document::get - - - - - - diff --git a/reference/mongodb/bson/document/offsetset.xml b/reference/mongodb/bson/document/offsetset.xml deleted file mode 100644 index c40f187f41..0000000000 --- a/reference/mongodb/bson/document/offsetset.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\BSON\Document::offsetSet - Implémentation d'ArrayAccess - - - &reftitle.description; - - final public voidMongoDB\BSON\Document::offsetSet - mixedkey - mixedvalue - - - - Change la valeur à la key spécifiée pour value. - - - - - &reftitle.parameters; - - - - key - - - L'index à définir. - - - - - value - - - La nouvelle valeur pour la key. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Lance toujours une MongoDB\Driver\Exception\LogicException. - - - - - diff --git a/reference/mongodb/bson/document/offsetunset.xml b/reference/mongodb/bson/document/offsetunset.xml deleted file mode 100644 index 3349f2225f..0000000000 --- a/reference/mongodb/bson/document/offsetunset.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\BSON\Document::offsetUnset - Implémentation d'ArrayAccess - - - &reftitle.description; - - final public voidMongoDB\BSON\Document::offsetUnset - mixedkey - - - Retire la valeur à l'index spécifié. - - - - - &reftitle.parameters; - - - - key - - - L'index à retirer. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Lance toujours une MongoDB\Driver\Exception\LogicException. - - - - - diff --git a/reference/mongodb/bson/document/tocanonicalextendedjson.xml b/reference/mongodb/bson/document/tocanonicalextendedjson.xml deleted file mode 100644 index 86382d70cd..0000000000 --- a/reference/mongodb/bson/document/tocanonicalextendedjson.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - MongoDB\BSON\Document::toCanonicalExtendedJSON - Renvoie la représentation Canonique Etendue JSON du document BSON - - - - &reftitle.description; - - final public stringMongoDB\BSON\Document::toCanonicalExtendedJSON - - - - Convertit le document BSON en sa - représentation Canonique Étendue JSON. - Le format canonique préfère la fidélité des types au détriment de - la sortie concise et est le plus adapté pour produire une sortie qui peut être convertie - en BSON sans perte d'informations de type (par exemple, les types numériques - resteront différenciés). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant la - représentation Canonical Extended JSON - du document BSON. - - - - - &reftitle.examples; - - Exemple de <methodname>MongoDB\BSON\Document::toCanonicalExtendedJSON</methodname> - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0 ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\Document::fromPHP($document); - echo $bson->toCanonicalExtendedJSON(), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - MongoDB\BSON\Document::toRelaxedExtendedJSON - MongoDB\BSON\toCanonicalExtendedJSON - Canonique Etendue JSON - Types BSON - - - - - - diff --git a/reference/mongodb/bson/document/tophp.xml b/reference/mongodb/bson/document/tophp.xml deleted file mode 100644 index b30ba2cd8e..0000000000 --- a/reference/mongodb/bson/document/tophp.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - MongoDB\BSON\Document::toPHP - Renvoie la représentation PHP du document BSON - - - - &reftitle.description; - - final public arrayobjectMongoDB\BSON\Document::toPHP - arraynulltypeMap&null; - - - Désérialise le document BSON en sa représentation PHP. Le paramètre - typeMap peut être utilisé pour contrôler les types PHP - utilisés pour convertir les tableaux et documents BSON (racine et intégrés). - - &mongodb.warning.duplicate-keys; - - - - &reftitle.parameters; - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - La valeur décodée PHP. - - - - Lorsqu'une valeur encodée en tant qu'entier 64 bits est rencontrée dans le document BSON, - la valeur de retour de cette méthode sera une - instance de MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - - Lance une - MongoDB\Driver\Exception\InvalidArgumentException si - un type dans la carte de type ne peut pas être instancié ou n'implémente pas - MongoDB\BSON\Unserializable. - - - - - - &reftitle.seealso; - - MongoDB\BSON\toPHP - Types BSON - - - - - - diff --git a/reference/mongodb/bson/document/torelaxedextendedjson.xml b/reference/mongodb/bson/document/torelaxedextendedjson.xml deleted file mode 100644 index a5d6e9e4f2..0000000000 --- a/reference/mongodb/bson/document/torelaxedextendedjson.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - MongoDB\BSON\Document::toRelaxedExtendedJSON - Renvoie la représentation relaxée étendue JSON du document BSON - - - - &reftitle.description; - - final public stringMongoDB\BSON\Document::toRelaxedExtendedJSON - - - - Convertit le document BSON en sa représentation - Relaxée Étendue JSON. - Le format relaxé préfère l'utilisation des primitives de type JSON au - détriment de la fidélité des types et est le plus adapté pour produire une sortie qui peut être - facilement consommée par les API web et les humains. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant la - représentation Relaxed Extended JSON - du document BSON. - - - - - &reftitle.examples; - - Exemple de <methodname>MongoDB\BSON\Document::toRelaxedExtendedJSON</methodname> - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0 ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\Document::fromPHP($document); - echo $bson->toRelaxedExtendedJSON(), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - MongoDB\BSON\Document::toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - Spécification JSON étendue - Types BSON - - - - - - diff --git a/reference/mongodb/bson/document/tostring.xml b/reference/mongodb/bson/document/tostring.xml deleted file mode 100644 index 4cfd63036d..0000000000 --- a/reference/mongodb/bson/document/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\Document::__toString - Renvoie la représentation en chaîne de caractères de ce document BSON - - - - &reftitle.description; - - final public stringMongoDB\BSON\Document::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la représentation en chaîne de caractères de ce document BSON. - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/int64.xml b/reference/mongodb/bson/int64.xml deleted file mode 100644 index 8b10dbac4a..0000000000 --- a/reference/mongodb/bson/int64.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - La classe MongoDB\BSON\Int64 - MongoDB\BSON\Int64 - - - - -
    - &reftitle.intro; - - Type BSON pour un entier 64 bits. Lors du décodage BSON en données PHP, cette classe - est utilisée lorsqu'un entier 64 bits ne peut pas être représenté en tant qu'entier PHP sur - des plateformes 32 bits. Ces objets supportent les opérateurs - arithmétiques, - bit à bit, et - comparaison surchargés. - - - Lors du travail avec des données BSON brutes à travers les classes - MongoDB\BSON\Document, - MongoDB\BSON\PackedArray, et - MongoDB\BSON\Iterator, tout entier 64 bits - sera retourné en tant qu'instance de cette classe, indépendamment de la plateforme et - de la possibilité de représenter la valeur en tant qu'entier PHP. Cela garantit que - les valeurs peuvent être parcourues sans changer le type. - - - Lors de l'encodage BSON, les objets de cette classe seront convertis en un type entier - 64 bits, même lorsque la valeur pourrait tenir dans un entier 32 bits. Cela - permet de stocker explicitement des valeurs en tant qu'entiers 64 bits dans BSON. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Int64 - - - - final - - MongoDB\BSON\Int64 - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.16.0 - - Cette classe peut maintenant être instanciée sur toutes les plateformes. Ajout du support pour - les opérateurs arithmétiques, bit à bit, et de comparaison surchargés. - - - - PECL mongodb 1.12.0 - - Implémente Stringable pour PHP 8.0+. - - - - - -
    - -     - - &reference.mongodb.bson.entities.int64; - -     - - diff --git a/reference/mongodb/bson/int64/construct.xml b/reference/mongodb/bson/int64/construct.xml deleted file mode 100644 index 5d823acec2..0000000000 --- a/reference/mongodb/bson/int64/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - MongoDB\BSON\Int64::__construct - Construit un nouveau Int64 - - - - &reftitle.description; - - final public MongoDB\BSON\Int64::__construct - intstringvalue - - - Crée une nouvelle instance de MongoDB\BSON\Int64 pour la - valeur entière donnée. - - - - - &reftitle.parameters; - - - value (intstring) - - - La valeur à assigner à l'instance de Int64. Cette - valeur peut être fournie en tant que int ou string, - ce dernier étant requis sur les plateformes 32 bits pour représenter les valeurs 64 bits. - - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.16.0 - - - Cette méthode a été rendue publique pour prendre en charge la création d'instances Int64 lors - de la manipulation de BSON brut. - - - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\InvalidArgumentException si la chaîne - value ne peut pas être analysée en tant qu'un entier 64 bits. - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/int64/jsonserialize.xml b/reference/mongodb/bson/int64/jsonserialize.xml deleted file mode 100644 index 90b7888ac8..0000000000 --- a/reference/mongodb/bson/int64/jsonserialize.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - MongoDB\BSON\Int64::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Int64::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\Int64. - - - - La sortie est concordante avec la fonction - MongoDB\BSON\toCanonicalExtendedJSON, qui - utilise le format JSON étendu - canonical. - Ceci diffère des autres classes BSON, qui utilisent le format - JSON étendu hérité du pilote spécifique - (MongoDB\BSON\toJSON), afin de s'assurer que les - valeurs entières 64-bit soient correctement représentées sur les plateformes 32-bits. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/int64/tostring.xml b/reference/mongodb/bson/int64/tostring.xml deleted file mode 100644 index a2f8c218c2..0000000000 --- a/reference/mongodb/bson/int64/tostring.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - MongoDB\BSON\Int64::__toString - Retourne la représentation sous forme de chaîne de caractères d'Int64 - - - - &reftitle.description; - - final public stringMongoDB\BSON\Int64::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation sous forme de chaîne de caractères d'Int64. - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Int64::__toString</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/iterator.xml b/reference/mongodb/bson/iterator.xml deleted file mode 100644 index 2e0309fa30..0000000000 --- a/reference/mongodb/bson/iterator.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - La classe MongoDB\BSON\Iterator - MongoDB\BSON\Iterator - - - - -
    - &reftitle.intro; - - Itérateur utilisé pour parcourir un document ou un tableau BSON. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Iterator - - - - final - - MongoDB\BSON\Iterator - - - - Iterator - - - - - &Methods; - - - - -
    - -     - - &reference.mongodb.bson.entities.iterator; - -     - - diff --git a/reference/mongodb/bson/iterator/construct.xml b/reference/mongodb/bson/iterator/construct.xml deleted file mode 100644 index 0692ef73ae..0000000000 --- a/reference/mongodb/bson/iterator/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::__construct - Construit un nouvel itérateur BSON (inutilisée) - - - - &reftitle.description; - - final private MongoDB\BSON\Iterator::__construct - - - - Les objets MongoDB\BSON\Iterator sont créés en appelant - MongoDB\BSON\Document::getIterator ou - MongoDB\BSON\PackedArray::getIterator et ne peuvent pas être - instanciés directement. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\BSON\Document::getIterator - MongoDB\BSON\PackedArray::getIterator - Types BSON - - - - - - diff --git a/reference/mongodb/bson/iterator/current.xml b/reference/mongodb/bson/iterator/current.xml deleted file mode 100644 index 119fa06ed5..0000000000 --- a/reference/mongodb/bson/iterator/current.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::current - Renvoie l'élément actuel - - - - &reftitle.description; - - public mixedMongoDB\BSON\Iterator::current - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la valeur de l'élément actuel. - - - - Lorsqu'une valeur encodée en tant qu'entier 64 bits dans la structure BSON est rencontrée, - la valeur de retour de cette méthode sera une instance de - MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\LogicException si l'itérateur n'est pas valide. - - - - - &reftitle.seealso; - - Iterator::current - - - - diff --git a/reference/mongodb/bson/iterator/key.xml b/reference/mongodb/bson/iterator/key.xml deleted file mode 100644 index 5b2e3a57aa..0000000000 --- a/reference/mongodb/bson/iterator/key.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::key - Renvoie la clé de l'élément actuel - - - - &reftitle.description; - - public stringintMongoDB\BSON\Iterator::key - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la clé de l'élément actuel. Lors de l'itération d'un document BSON, la - clé sera toujours une string. Lors de l'itération d'un tableau BSON, la - clé sera un int. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\LogicException si l'itérateur n'est pas valide. - - - - - &reftitle.seealso; - - Iterator::key - - - - diff --git a/reference/mongodb/bson/iterator/next.xml b/reference/mongodb/bson/iterator/next.xml deleted file mode 100644 index d8a213b336..0000000000 --- a/reference/mongodb/bson/iterator/next.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::next - Avance l'itérateur à l'élément suivant - - - - &reftitle.description; - - public voidMongoDB\BSON\Iterator::next - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Iterator::next - - - - diff --git a/reference/mongodb/bson/iterator/rewind.xml b/reference/mongodb/bson/iterator/rewind.xml deleted file mode 100644 index d75f6cbbbb..0000000000 --- a/reference/mongodb/bson/iterator/rewind.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::rewind - Rembobine l'itérateur au premier élément - - - - &reftitle.description; - - public voidMongoDB\BSON\Iterator::rewind - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Iterator::rewind - - - - diff --git a/reference/mongodb/bson/iterator/valid.xml b/reference/mongodb/bson/iterator/valid.xml deleted file mode 100644 index 0b101ec4c1..0000000000 --- a/reference/mongodb/bson/iterator/valid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::valid - Vérifie si la position courante est valide - - - - &reftitle.description; - - public boolMongoDB\BSON\Iterator::valid - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si la position courante de l'itérateur est valide, sinon &false;. - - - - - &reftitle.seealso; - - Iterator::valid - - - - diff --git a/reference/mongodb/bson/javascript.xml b/reference/mongodb/bson/javascript.xml deleted file mode 100644 index f8f1bdabb6..0000000000 --- a/reference/mongodb/bson/javascript.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - La classe MongoDB\BSON\Javascript - MongoDB\BSON\Javascript - - - - -
    - &reftitle.intro; - - Type BSON pour le code JavaScript. Un document d'étendue optionnel peut - être spécifié qui mappe les identificateurs aux valeurs et définit l'étendue - dans laquelle le code doit être évalué par le serveur. - - - - Ce type BSON est principalement utilisé lors de l'exécution de commandes - de base de données qui prennent une fonction JavaScript comme paramètre, tel que - mapReduce. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Javascript - - - - final - - MongoDB\BSON\Javascript - - - - MongoDB\BSON\JavascriptInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implémente Stringable pour PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implémente MongoDB\BSON\JavascriptInterface. - - - - PECL mongodb 1.2.0 - - Implémente Serializable et - JsonSerializable. - - - - - -
    - -     - - &reference.mongodb.bson.entities.javascript; - -     - - diff --git a/reference/mongodb/bson/javascript/construct.xml b/reference/mongodb/bson/javascript/construct.xml deleted file mode 100644 index 05e542e91f..0000000000 --- a/reference/mongodb/bson/javascript/construct.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - - MongoDB\BSON\Javascript::__construct - Construit un nouvel objet Javascript - - - - &reftitle.description; - - final public MongoDB\BSON\Javascript::__construct - stringcode - arrayobjectnullscope&null; - - - - - &reftitle.parameters; - - - code (string) - - - Le code Javascript. - - - - - scope (arrayobject) - - - La portée du Javascript. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lève MongoDB\Driver\Exception\InvalidArgumentException si code contient un octet nul. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.2.0 - - - MongoDB\Driver\Exception\InvalidArgumentException - est levée si code contient un octet nul. - Auparavant, les valeurs étaient tronquées au premier octet nul. - - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Javascript::__construct</function> example - - 'bar']); -var_dump($codews); - -?> -]]> - - &example.outputs; - - - string(24) "function() { return 1; }" - ["scope"]=> - object(stdClass)#2 (0) { - } -} -object(MongoDB\BSON\Javascript)#2 (2) { - ["javascript"]=> - string(26) "function() { return foo; }" - ["scope"]=> - object(stdClass)#1 (1) { - ["foo"]=> - string(3) "bar" - } -} -]]> - - - - - - - &reftitle.seealso; - - Les types BSON - - - - - - diff --git a/reference/mongodb/bson/javascript/getcode.xml b/reference/mongodb/bson/javascript/getcode.xml deleted file mode 100644 index e840766712..0000000000 --- a/reference/mongodb/bson/javascript/getcode.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - MongoDB\BSON\Javascript::getCode - Retourne le code Javascript - - - - &reftitle.description; - - final public stringMongoDB\BSON\Javascript::getCode - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le code Javascript. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Javascript::getCode</function> - -getCode()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/javascript/getscope.xml b/reference/mongodb/bson/javascript/getscope.xml deleted file mode 100644 index 34a213710f..0000000000 --- a/reference/mongodb/bson/javascript/getscope.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - MongoDB\BSON\Javascript::getScope - Retourne le document de portée de Javascript - - - - &reftitle.description; - - final public objectnullMongoDB\BSON\Javascript::getScope - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le document de portée de Javascript, ou &null; s'il n'a pas de portée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Javascript::getScope</function> - -getScope()); - -$js = new MongoDB\BSON\Javascript('function foo() { return foo; }', ['foo' => 42]); -var_dump($js->getScope()); - -?> -]]> - - &example.outputs; - - - int(42) -} -]]> - - - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/javascript/jsonserialize.xml b/reference/mongodb/bson/javascript/jsonserialize.xml deleted file mode 100644 index b7492a2114..0000000000 --- a/reference/mongodb/bson/javascript/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\Javascript::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Javascript::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\Javascript. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/javascript/tostring.xml b/reference/mongodb/bson/javascript/tostring.xml deleted file mode 100644 index e1916e39da..0000000000 --- a/reference/mongodb/bson/javascript/tostring.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - MongoDB\BSON\Javascript::__toString - Retourne le code Javascript - - - - &reftitle.description; - - final public stringMongoDB\BSON\Javascript::__toString - - - - &info.method.alias; MongoDB\BSON\Javascript::getCode. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le code Javascript. - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Javascript::__toString</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Javascript::getCode - Types BSON - - - - - - diff --git a/reference/mongodb/bson/javascriptinterface.xml b/reference/mongodb/bson/javascriptinterface.xml deleted file mode 100644 index c9573d7f73..0000000000 --- a/reference/mongodb/bson/javascriptinterface.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - L'interface MongoDB\BSON\JavascriptInterface - MongoDB\BSON\JavascriptInterface - - -
    - &reftitle.intro; - - Cette interface est implémentée par - MongoDB\BSON\Javascript pour être utilisée comme type de paramètre, - de retour ou de propriété dans les classes utilisateurs. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\JavascriptInterface - - - MongoDB\BSON\JavascriptInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -     - - &reference.mongodb.bson.entities.javascriptinterface; - -     - - diff --git a/reference/mongodb/bson/javascriptinterface/getcode.xml b/reference/mongodb/bson/javascriptinterface/getcode.xml deleted file mode 100644 index 9e0d14a811..0000000000 --- a/reference/mongodb/bson/javascriptinterface/getcode.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\JavascriptInterface::getCode - Retourne le code de JavascriptInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\JavascriptInterface::getCode - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le code de JavascriptInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Javascript::getCode - - - - - - diff --git a/reference/mongodb/bson/javascriptinterface/getscope.xml b/reference/mongodb/bson/javascriptinterface/getscope.xml deleted file mode 100644 index 77d0553975..0000000000 --- a/reference/mongodb/bson/javascriptinterface/getscope.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\JavascriptInterface::getScope - Retourne le document de portée de JavascriptInterface - - - - &reftitle.description; - - abstract public objectnullMongoDB\BSON\JavascriptInterface::getScope - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le document de portée de JavascriptInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Javascript::getScope - - - - - - diff --git a/reference/mongodb/bson/javascriptinterface/tostring.xml b/reference/mongodb/bson/javascriptinterface/tostring.xml deleted file mode 100644 index 0413163073..0000000000 --- a/reference/mongodb/bson/javascriptinterface/tostring.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - MongoDB\BSON\JavascriptInterface::__toString - Retourne le code de JavascriptInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\JavascriptInterface::__toString - - - - &info.method.alias; MongoDB\BSON\JavascriptInterface::getCode. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le code de JavascriptInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\JavascriptInterface::getCode - MongoDB\BSON\Javascript::__toString - - - - - - diff --git a/reference/mongodb/bson/maxkey.xml b/reference/mongodb/bson/maxkey.xml deleted file mode 100644 index 0cdc71a3fc..0000000000 --- a/reference/mongodb/bson/maxkey.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - La classe MongoDB\BSON\MaxKey - MongoDB\BSON\MaxKey - - - - -
    - &reftitle.intro; - - Type BSON spécial qui compare la plus grande valeur possible de toutes les - autres valeurs d'éléments BSON possibles. - - - - Il s'agit d'un type interne de MongoDB utilisé pour l'indexation et la - défragmentation. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\MaxKey - - - - final - - MongoDB\BSON\MaxKey - - - - MongoDB\BSON\MaxKeyInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.3.0 - - Implémente MongoDB\BSON\MaxKeyInterface. - - - - PECL mongodb 1.2.0 - - Implémente Serializable et - JsonSerializable. - - - - - -
    - -     - - &reference.mongodb.bson.entities.maxkey; - -     - - diff --git a/reference/mongodb/bson/maxkey/construct.xml b/reference/mongodb/bson/maxkey/construct.xml deleted file mode 100644 index 08cd108d79..0000000000 --- a/reference/mongodb/bson/maxkey/construct.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - MongoDB\BSON\MaxKey::__construct - Construit un nouveau MaxKey - - - - &reftitle.description; - - final public MongoDB\BSON\MaxKey::__construct - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\MaxKey::__construct</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/maxkey/jsonserialize.xml b/reference/mongodb/bson/maxkey/jsonserialize.xml deleted file mode 100644 index acbbd071a2..0000000000 --- a/reference/mongodb/bson/maxkey/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\MaxKey::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\MaxKey::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\MaxKey. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/maxkeyinterface.xml b/reference/mongodb/bson/maxkeyinterface.xml deleted file mode 100644 index fbb3dd3fec..0000000000 --- a/reference/mongodb/bson/maxkeyinterface.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - L'interface MongoDB\BSON\MaxKeyInterface - MongoDB\BSON\MaxKeyInterface - - -
    - &reftitle.intro; - - Cette interface est implémentée par MongoDB\BSON\MaxKey - pour être utilisée comme type de paramètre, de retour ou de propriété dans les classes utilisateurs. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\MaxKeyInterface - - - MongoDB\BSON\MaxKeyInterface - - - - - - Cette interface ne contient pas de méthodes. - -
    -     - -     - - diff --git a/reference/mongodb/bson/minkey.xml b/reference/mongodb/bson/minkey.xml deleted file mode 100644 index 47816fd933..0000000000 --- a/reference/mongodb/bson/minkey.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - La classe MongoDB\BSON\MinKey - MongoDB\BSON\MinKey - - - - -
    - &reftitle.intro; - - Type BSON spécial qui compare la plus petite valeur possible de toutes les autres valeurs d'éléments BSON possibles. - - - - Il s'agit d'un type interne de MongoDB utilisé pour l'indexation et la - défragmentation. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\MinKey - - - - final - - MongoDB\BSON\MinKey - - - - - MongoDB\BSON\MinKeyInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.3.0 - - Implémente MongoDB\BSON\MinKeyInterface. - - - - PECL mongodb 1.2.0 - - Implémente Serializable et - JsonSerializable. - - - - - -
    - -     - - &reference.mongodb.bson.entities.minkey; - -     - - diff --git a/reference/mongodb/bson/minkey/construct.xml b/reference/mongodb/bson/minkey/construct.xml deleted file mode 100644 index d8bac9479d..0000000000 --- a/reference/mongodb/bson/minkey/construct.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - MongoDB\BSON\MinKey::__construct - Construit un nouveau MinKey - - - - &reftitle.description; - - final public MongoDB\BSON\MinKey::__construct - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\MinKey::__construct</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/minkey/jsonserialize.xml b/reference/mongodb/bson/minkey/jsonserialize.xml deleted file mode 100644 index d82cc36ed0..0000000000 --- a/reference/mongodb/bson/minkey/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\MinKey::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\MinKey::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\MinKey. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/minkeyinterface.xml b/reference/mongodb/bson/minkeyinterface.xml deleted file mode 100644 index 5d216cf4c9..0000000000 --- a/reference/mongodb/bson/minkeyinterface.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - L'interface MongoDB\BSON\MinKeyInterface - MongoDB\BSON\MinKeyInterface - - -
    - &reftitle.intro; - - Cette interface est implémentée par MongoDB\BSON\MinKey - pour être utilisée comme type de paramètre, de retour ou de propriété dans les classes utilisateurs. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\MinKeyInterface - - - MongoDB\BSON\MinKeyInterface - - - - - - Cette interface ne contient pas de méthodes. - -
    -     - -     - - diff --git a/reference/mongodb/bson/objectid.xml b/reference/mongodb/bson/objectid.xml deleted file mode 100644 index 5a1a672216..0000000000 --- a/reference/mongodb/bson/objectid.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - La classe MongoDB\BSON\ObjectId - MongoDB\BSON\ObjectId - - - - -
    - &reftitle.intro; - - Type BSON pour un - ObjectId. La - valeur se compose de 12 octets, où les quatre premiers octets sont un - timestamp qui reflètent la création de l'ObjectId. Plus précisément, - la valeur se compose de : - - - une valeur de 4 octets représentant les secondes depuis l'époque UNIX, - un nombre aléatoire de 5 octets unique à une machine et un processus, et - un compteur de 3 octets, commençant par une valeur aléatoire. - - - Dans MongoDB, chaque document stocké dans une collection requiert un champ - _id unique qui agit comme clé primaire. Si un document - inséré omet le champ _id, l'extension génère - automatiquement un ObjectId pour le champ _id. - - - L'utilisation d'ObjectId pour le champ _id fournit les - avantages supplémentaires suivants: - - - - L'heure de création de l'ObjectId peut être accédée à l'aide de la méthode - MongoDB\BSON\ObjectId::getTimestamp. - - - Le tri sur un champ _id qui stocke des valeurs ObjectId - équivaut à peu près au tri par date de création. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\ObjectId - - - - final - - MongoDB\BSON\ObjectId - - - - MongoDB\BSON\ObjectIdInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implémente Stringable pour PHP 8.0+. - - - - PECL mongodb 1.3.0 - - - Renommé de MongoDB\BSON\ObjectID vers - MongoDB\BSON\ObjectId. - - - Implémente MongoDB\BSON\ObjectIdInterface. - - - - - PECL mongodb 1.2.0 - - Implémente Serializable et - JsonSerializable. - - - - - -
    - -     - - &reference.mongodb.bson.entities.objectid; - -     - diff --git a/reference/mongodb/bson/objectid/construct.xml b/reference/mongodb/bson/objectid/construct.xml deleted file mode 100644 index 9673463a04..0000000000 --- a/reference/mongodb/bson/objectid/construct.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - MongoDB\BSON\ObjectId::__construct - Construit un nouvel ObjectId - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectId::__construct - stringnullid&null; - - - - - &reftitle.parameters; - - - id (string) - - - Une chaîne héxadécimale de 24 caractères. Si elle n'est pas fournie, l'extension - génèrera un ObjectId. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une exception MongoDB\Driver\Exception\InvalidArgumentException - si id n'est pas une chaîne héxadécimale de 24 caractères. - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\ObjectId::__construct</function> - - -]]> - - &example.outputs.similar; - - - string(24) "56732d3dda14d81214634921" -} -object(MongoDB\BSON\ObjectId)#1 (1) { - ["oid"]=> - string(24) "000000000000000000000001" -} - -]]> - - - - - - - &reftitle.seealso; - - La référence ObjectId - Le type BSON : ObjectId - - - - - - diff --git a/reference/mongodb/bson/objectid/gettimestamp.xml b/reference/mongodb/bson/objectid/gettimestamp.xml deleted file mode 100644 index 30fdc80640..0000000000 --- a/reference/mongodb/bson/objectid/gettimestamp.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - MongoDB\BSON\ObjectId::getTimestamp - Retourne le composant d'horodatage d'ObjectId - - - - &reftitle.description; - - final public intMongoDB\BSON\ObjectId::getTimestamp - - - - Le composant d'horodatage d'un ObjectId est ses 32 bits les plus significatifs, - qui dénote le nombre de secondes depuis l'epoch Unix. Cette valeur est lue comme - un entier 32-bit non signé avec un ordre d'octets big-endian. - - &mongodb.note.uint32; - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le composant d'horodatage d'ObjectId. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\ObjectId::getTimestamp</function> - -getTimestamp()); - -var_dump((new MongoDB\BSON\ObjectId('0000002a0000000000000000'))->getTimestamp()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Référence ObjectId - Types BSON : ObjectId - - - - - - diff --git a/reference/mongodb/bson/objectid/jsonserialize.xml b/reference/mongodb/bson/objectid/jsonserialize.xml deleted file mode 100644 index bfe8f358d1..0000000000 --- a/reference/mongodb/bson/objectid/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\ObjectId::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\ObjectId::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\ObjectId. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/objectid/tostring.xml b/reference/mongodb/bson/objectid/tostring.xml deleted file mode 100644 index 7520af74d0..0000000000 --- a/reference/mongodb/bson/objectid/tostring.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - MongoDB\BSON\ObjectId::__toString - Retourne la représentation hexadécimale de cet ObjectId - - - - &reftitle.description; - - final public stringMongoDB\BSON\ObjectId::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation hexadécimale de cet ObjectId. - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\ObjectId::__toString</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - La référence ObjectId - Le type BSON : ObjectId - - - - - - diff --git a/reference/mongodb/bson/objectidinterface.xml b/reference/mongodb/bson/objectidinterface.xml deleted file mode 100644 index e2cfe0f977..0000000000 --- a/reference/mongodb/bson/objectidinterface.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - L'interface MongoDB\BSON\ObjectIdInterface - MongoDB\BSON\ObjectIdInterface - - -
    - &reftitle.intro; - - Cette interface est implémentée par - MongoDB\BSON\ObjectId pour être utilisée comme type de paramètre, - de retour ou de propriété dans les classes utilisateurs. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\ObjectIdInterface - - - MongoDB\BSON\ObjectIdInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -     - - &reference.mongodb.bson.entities.objectidinterface; - -     - - diff --git a/reference/mongodb/bson/objectidinterface/gettimestamp.xml b/reference/mongodb/bson/objectidinterface/gettimestamp.xml deleted file mode 100644 index 7f7b07962a..0000000000 --- a/reference/mongodb/bson/objectidinterface/gettimestamp.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\ObjectIdInterface::getTimestamp - Retourne le composant d'horodatage d'ObjectIdInterface - - - - &reftitle.description; - - abstract public intMongoDB\BSON\ObjectIdInterface::getTimestamp - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le composant d'horodatage d'ObjectIdInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\ObjectId::getTimestamp - - - - - - diff --git a/reference/mongodb/bson/objectidinterface/tostring.xml b/reference/mongodb/bson/objectidinterface/tostring.xml deleted file mode 100644 index 60ff7b372c..0000000000 --- a/reference/mongodb/bson/objectidinterface/tostring.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\ObjectIdInterface::__toString - Retourne la représentation hexadécimale d'ObjectIdInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\ObjectIdInterface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation hexadécimale d'ObjectIdInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\ObjectId::__toString - - - - - - diff --git a/reference/mongodb/bson/packedarray.xml b/reference/mongodb/bson/packedarray.xml deleted file mode 100644 index 5b4e63bfac..0000000000 --- a/reference/mongodb/bson/packedarray.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - La classe MongoDB\BSON\PackedArray - MongoDB\BSON\PackedArray - - - - -
    - &reftitle.intro; - - Représente un tableau BSON. Cette classe est utilisée lors de la lecture de données en tant que BSON brut - et ne peut pas être modifiée. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\PackedArray - - - - final - - MongoDB\BSON\PackedArray - - - - MongoDB\BSON\Type - - - - ArrayAccess - - - - IteratorAggregate - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.17.0 - - Implémente MongoDB\BSON\Type. - - - - PECL mongodb 1.17.0 - - MongoDB\BSON\PackedArray ne peut pas être sérialisé - dans des contextes où un document BSON est attendu. Dans les versions précédentes, - le tableau BSON aurait été converti en document. - - - - - -
    - -     - - &reference.mongodb.bson.entities.packedarray; - -     - - diff --git a/reference/mongodb/bson/packedarray/construct.xml b/reference/mongodb/bson/packedarray/construct.xml deleted file mode 100644 index dbe045cd95..0000000000 --- a/reference/mongodb/bson/packedarray/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::__construct - Construit un nouveau tableau BSON (inutilisé) - - - - &reftitle.description; - - final private MongoDB\BSON\PackedArray::__construct - - - - Les objets MongoDB\BSON\PackedArray sont créés avec - des méthodes de fabrique statiques et ne peuvent pas être instanciés directement. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::fromPHP - Types BSON - - - - - - diff --git a/reference/mongodb/bson/packedarray/fromjson.xml b/reference/mongodb/bson/packedarray/fromjson.xml deleted file mode 100644 index ec3a234058..0000000000 --- a/reference/mongodb/bson/packedarray/fromjson.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::fromJSON - Construit une nouvelle instance de tableau BSON à partir d'une chaîne JSON - - - - &reftitle.description; - - final static public MongoDB\BSON\PackedArrayMongoDB\BSON\PackedArray::fromJSON - stringjson - - - Convertit une chaîne - JSON étendu - en sa représentation BSON. - - - - - &reftitle.parameters; - - - json (string) - - - La valeur JSON à convertir. - - - - - - - - &reftitle.returnvalues; - - Renvoie une nouvelle instance de MongoDB\BSON\PackedArray. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - Lance une - MongoDB\Driver\Exception\UnexpectedValueException si - la valeur JSON ne peut pas être convertie en tableau BSON (par exemple, en raison - d'une erreur de syntaxe). - - - - - - &reftitle.examples; - - Exemple de <methodname>MongoDB\BSON\PackedArray::fromJSON</methodname> - - -]]> - - &example.outputs; - - - string(68) "MQAAAAIwAAQAAABmb28AEDEAewAAABIyAP////8AAAAABzMAVjFafGEY/RuSAnCxAA==" - ["value"]=> - array(4) { - [0]=> - string(3) "foo" - [1]=> - int(123) - [2]=> - int(4294967295) - [3]=> - object(MongoDB\BSON\ObjectId)#2 (1) { - ["oid"]=> - string(24) "56315a7c6118fd1b920270b1" - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::fromPHP - Json étendu de MongoDB - Types BSON - - - - - diff --git a/reference/mongodb/bson/packedarray/fromphp.xml b/reference/mongodb/bson/packedarray/fromphp.xml deleted file mode 100644 index 21a0058cd6..0000000000 --- a/reference/mongodb/bson/packedarray/fromphp.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::fromPHP - Construit une nouvelle instance de tableau BSON depuis des données PHP - - - - &reftitle.description; - - final static public MongoDB\BSON\PackedArrayMongoDB\BSON\PackedArray::fromPHP - arrayvalue - - - - - &reftitle.parameters; - - - value (array) - - - Le tableau PHP à convertir en tableau BSON. Le tableau doit être une liste - (c'est-à-dire avoir des clés numériques séquentielles commençant par 0). - - - - - - - - &reftitle.returnvalues; - - Retourne une nouvelle instance de MongoDB\BSON\PackedArray. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\InvalidArgumentException si le tableau donné n'est pas une liste (c'est-à-dire il a des clés numériques séquentielles commençant par 0). - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/packedarray/get.xml b/reference/mongodb/bson/packedarray/get.xml deleted file mode 100644 index 6a0bdf23f6..0000000000 --- a/reference/mongodb/bson/packedarray/get.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::get - Renvoie la valeur d'un index du tableau - - - - &reftitle.description; - - final public mixedMongoDB\BSON\PackedArray::get - intkey - - - - - &reftitle.parameters; - - - key (int) - - - L'index à récupérer du tableau. - - - - - - - - &reftitle.returnvalues; - - Renvoie la valeur associée à l'index donné. Si l'index n'est pas - présent dans le tableau, une exception est lancée. - - - - Lorsqu'une valeur encodée en tant qu'entier 64 bits est rencontrée dans le tableau BSON, - la valeur de retour de cette méthode sera une instance de - MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\RuntimeException si l'index n'est pas présent dans le tableau. - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::has - Types BSON - - - - - - diff --git a/reference/mongodb/bson/packedarray/getiterator.xml b/reference/mongodb/bson/packedarray/getiterator.xml deleted file mode 100644 index 2565d20ae4..0000000000 --- a/reference/mongodb/bson/packedarray/getiterator.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::getIterator - Renvoie l'itérateur pour le tableau BSON - - - - &reftitle.description; - - final public MongoDB\BSON\IteratorMongoDB\BSON\PackedArray::getIterator - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une instance de MongoDB\BSON\Iterator qui peut être - utilisée pour itérer sur tous les index du tableau. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\UnexpectedValueException si l'itérateur BSON ne peut pas être instancié. - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/packedarray/has.xml b/reference/mongodb/bson/packedarray/has.xml deleted file mode 100644 index 579fe4599d..0000000000 --- a/reference/mongodb/bson/packedarray/has.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::has - Renvoie si un index est présent dans le tableau - - - - &reftitle.description; - - final public boolMongoDB\BSON\PackedArray::has - intindex - - - - - &reftitle.parameters; - - - index (int) - - - L'index à chercher dans le tableau. - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; si l'index est présent dans le tableau sinon &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::get - Types BSON - - - - - - diff --git a/reference/mongodb/bson/packedarray/offsetexists.xml b/reference/mongodb/bson/packedarray/offsetexists.xml deleted file mode 100644 index 232caf88df..0000000000 --- a/reference/mongodb/bson/packedarray/offsetexists.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::offsetExists - Renvoie si un index est présent dans le tableau - - - &reftitle.description; - - final public boolMongoDB\BSON\PackedArray::offsetExists - mixedkey - - - - - &reftitle.parameters; - - - - key - - - L'index à chercher dans le tableau. - - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; si l'index est présent dans le tableau sinon &false;. - - - - - &reftitle.seealso; - - - ArrayAccess::offsetExists - MongoDB\BSON\PackedArray::has - - - - - - diff --git a/reference/mongodb/bson/packedarray/offsetget.xml b/reference/mongodb/bson/packedarray/offsetget.xml deleted file mode 100644 index fd89cb1c36..0000000000 --- a/reference/mongodb/bson/packedarray/offsetget.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::offsetGet - Renvoie la valeur d'un index du tableau - - - &reftitle.description; - - final public mixedMongoDB\BSON\PackedArray::offsetGet - mixedkey - - - - - &reftitle.parameters; - - - - key - - - L'index à récupérer du tableau. Seulement int est supporté. - - - - - - - - - &reftitle.returnvalues; - - Renvoie la valeur associée à l'index donné. Si l'index n'est pas - présent dans le tableau, une exception est lancée. - - - - Lorsqu'une valeur encodée en tant qu'entier 64 bits est rencontrée dans le tableau BSON, - la valeur de retour de cette méthode sera une instance de - MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\RuntimeException si l'index n'est pas présent dans le tableau. - - - - - &reftitle.seealso; - - - ArrayAccess::offsetGet - MongoDB\BSON\PackedArray::get - - - - - - diff --git a/reference/mongodb/bson/packedarray/offsetset.xml b/reference/mongodb/bson/packedarray/offsetset.xml deleted file mode 100644 index d85e99f2eb..0000000000 --- a/reference/mongodb/bson/packedarray/offsetset.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::offsetSet - Implémentation de ArrayAccess - - - &reftitle.description; - - final public voidMongoDB\BSON\PackedArray::offsetSet - mixedkey - mixedvalue - - - - Change la valeur de key pour value. - - - - - &reftitle.parameters; - - - - key - - - L'index à modifier. - - - - - value - - - La nouvelle valeur de key. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Lance toujours une MongoDB\Driver\Exception\LogicException. - - - - - diff --git a/reference/mongodb/bson/packedarray/offsetunset.xml b/reference/mongodb/bson/packedarray/offsetunset.xml deleted file mode 100644 index 7d12df0854..0000000000 --- a/reference/mongodb/bson/packedarray/offsetunset.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::offsetUnset - Implémentation de ArrayAccess - - - &reftitle.description; - - final public voidMongoDB\BSON\PackedArray::offsetUnset - mixedkey - - - Retire la valeur à l'index donné. - - - - - &reftitle.parameters; - - - - key - - - La valeur à retirer. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Lance toujours une MongoDB\Driver\Exception\LogicException. - - - - - diff --git a/reference/mongodb/bson/packedarray/tocanonicalextendedjson.xml b/reference/mongodb/bson/packedarray/tocanonicalextendedjson.xml deleted file mode 100644 index efcf77d38c..0000000000 --- a/reference/mongodb/bson/packedarray/tocanonicalextendedjson.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::toCanonicalExtendedJSON - Renvoie la représentation JSON étendue canonique du tableau BSON - - - - &reftitle.description; - - final public stringMongoDB\BSON\PackedArray::toCanonicalExtendedJSON - - - - Convertit le tableau BSON en sa représentation - JSON étendue canonique. - Le format canonique privilégie la fidélité des types au détriment de la - concision de la sortie et est le plus adapté pour produire une sortie qui - peut être convertie en BSON sans perte d'informations de type (par exemple, - les types numériques resteront différenciés). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une chaîne contenant la représentation - JSON étendue canonique - du tableau BSON. - - - - - &reftitle.examples; - - Exemple de <methodname>MongoDB\BSON\PackedArray::toCanonicalExtendedJSON</methodname> - - toCanonicalExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::fromJSON - MongoDB\BSON\PackedArray::toRelaxedExtendedJSON - MongoDB\BSON\toCanonicalExtendedJSON - Spécification du JSON étendu - Types BSON - - - - - diff --git a/reference/mongodb/bson/packedarray/tophp.xml b/reference/mongodb/bson/packedarray/tophp.xml deleted file mode 100644 index a5f2f47a3a..0000000000 --- a/reference/mongodb/bson/packedarray/tophp.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::toPHP - Renvoie la représentation PHP du tableau BSON - - - - &reftitle.description; - - final public arrayobjectMongoDB\BSON\PackedArray::toPHP - arraynulltypeMap&null; - - - - - &reftitle.parameters; - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - La valeur décodée en PHP. - - - - Lorsqu'une valeur encodée en tant qu'entier 64 bits est rencontrée dans le tableau BSON, - la valeur de retour de cette méthode sera une instance de - MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - - Lance une - MongoDB\Driver\Exception\InvalidArgumentException si - une classe dans le type map ne peut pas être instanciée ou n'implémente pas - MongoDB\BSON\Unserializable. - - - - - - &reftitle.seealso; - - MongoDB\BSON\toPHP - Types BSON - - - - - - diff --git a/reference/mongodb/bson/packedarray/torelaxedextendedjson.xml b/reference/mongodb/bson/packedarray/torelaxedextendedjson.xml deleted file mode 100644 index 608c784626..0000000000 --- a/reference/mongodb/bson/packedarray/torelaxedextendedjson.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::toRelaxedExtendedJSON - Renvoie la représentation JSON étendue relaxée du tableau BSON - - - - &reftitle.description; - - final public stringMongoDB\BSON\PackedArray::toRelaxedExtendedJSON - - - - Convertit le tableau BSON en sa représentation - JSON étendue relaxée. - Le format relaxé préfère l'utilisation des types primitifs JSON au détriment de la - fidélité des types et est le plus adapté pour produire une sortie qui peut être - facilement consommée par des API web et des humains. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une chaîne contenant la représentation - JSON étendue relaxée - du tableau BSON. - - - - - &reftitle.examples; - - Exemple de <methodname>MongoDB\BSON\PackedArray::toRelaxedExtendedJSON</methodname> - - toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::fromJSON - MongoDB\BSON\PackedArray::toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - Spécification du JSON étendu - Types BSON - - - - - diff --git a/reference/mongodb/bson/packedarray/tostring.xml b/reference/mongodb/bson/packedarray/tostring.xml deleted file mode 100644 index c5f1975037..0000000000 --- a/reference/mongodb/bson/packedarray/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::__toString - Renvoie la représentation en chaîne de caractères pour ce tableau BSON - - - - &reftitle.description; - - final public stringMongoDB\BSON\PackedArray::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la représentation en chaîne de caractères de ce tableau BSON. - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/persistable.xml b/reference/mongodb/bson/persistable.xml deleted file mode 100644 index 471abce2e7..0000000000 --- a/reference/mongodb/bson/persistable.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - La classe MongoDB\BSON\Persistable - MongoDB\BSON\Persistable - - - - -
    - &reftitle.intro; - - Les classes peuvent implémenter cette interface pour avoir la possibilité - d'utiliser les ODM automatique (les objets de cartographie des documents) - de cette extension. Pendant la sérialisation, l'extension va injecter une propriété - __pclass contenant le nom de la classe PHP dans les données - retournées par MongoDB\BSON\Serializable::bsonSerialize. - Pendant la désérialisation, la même propriété __pclass - sera utilisée pour demander à la classe PHP (indépendamment de la configuration - type map) de se construire - avant que MongoDB\BSON\Unserializable::bsonUnserialize ne - soit invoquée. Voir pour plus d'informations. - - - - Même si MongoDB\BSON\Serializable::bsonSerialize - veut retourner un tableau séquentiel, l'injection de la propriété - __pclass fera que l'objet sera sérialisé comme - document BSON. - - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\BSON\Persistable - - - - - MongoDB\BSON\Persistable - - - - MongoDB\BSON\Unserializable - - - - MongoDB\BSON\Serializable - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.mongodb.bson.entities.persistable; - -     - - diff --git a/reference/mongodb/bson/persistable/bsonserialize.xml b/reference/mongodb/bson/persistable/bsonserialize.xml deleted file mode 100644 index 705d7c8af6..0000000000 --- a/reference/mongodb/bson/persistable/bsonserialize.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - MongoDB\BSON\Persistable::bsonSerialize - Fournit un tableau ou un document à sérialiser en tant que BSON - - - - &reftitle.description; - - abstract public arraystdClassMongoDB\BSON\DocumentMongoDB\BSON\Persistable::bsonSerialize - - - - Appelée lors de la sérialisation de l'objet en BSON. La méthode doit retourner un - array, stdClass, ou - MongoDB\BSON\Document. - - - La valeur de retour sera toujours sérialisée en tant que document BSON. Le document - sérialisé inclura un champ contenant le nom de la classe de l'objet. Pour cette - raison, il n'est pas possible de retourner une instance de - MongoDB\BSON\PackedArray dans cette méthode. - - - Les utilisateurs sont encouragés à inclure une propriété _id (par exemple - un MongoDB\BSON\ObjectId initialisé dans le constructeur) lors du retour - de données pour un document racine BSON. En l'absence d'une propriété - _id, l'extension ou le serveur générera un - MongoDB\BSON\ObjectId pour les opérations d'insertion ou d'upsert, - respectivement. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array, stdClass, ou MongoDB\BSON\Document - à sérialiser en tant que document BSON. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - - PECL mongodb 1.17.0 - - - Cette méthode peut maintenant également retourner des instances de MongoDB\BSON\Document - en plus de array et stdClass. - - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - MongoDB\BSON\Unserializable::bsonUnserialize - MongoDB\BSON\Persistable - - - - - - - diff --git a/reference/mongodb/bson/regex.xml b/reference/mongodb/bson/regex.xml deleted file mode 100644 index 5ce1d990cf..0000000000 --- a/reference/mongodb/bson/regex.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - La classe MongoDB\BSON\Regex - MongoDB\BSON\Regex - - - - -
    - &reftitle.intro; - - Type BSON pour un modèle d'expression régulière et - flags facultatif. - - - - Ce type BSON est principalement utilisé lors de l'interrogation de la base - de données. Alternativement, l'opérateur de requête - $regex - peut être utilisé. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Regex - - - - final - - MongoDB\BSON\Regex - - - - MongoDB\BSON\RegexInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implémente Stringable pour PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implémente MongoDB\BSON\RegexInterface. - - - - PECL mongodb 1.2.0 - - Implémente Serializable et - JsonSerializable. - - - - - -
    - -     - - &reference.mongodb.bson.entities.regex; - -     - diff --git a/reference/mongodb/bson/regex/construct.xml b/reference/mongodb/bson/regex/construct.xml deleted file mode 100644 index f820bb791f..0000000000 --- a/reference/mongodb/bson/regex/construct.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - - MongoDB\BSON\Regex::__construct - Construit une nouvelle REGEX - - - - &reftitle.description; - - final public MongoDB\BSON\Regex::__construct - stringpattern - stringflags"" - - - - - &reftitle.parameters; - - - pattern (string) - - - Le masque de l'expression régulière. - - - - Le masque ne doit pas être entouré de caractères délimitants. - - - - - - flags (string) - - - Les - drapeaux de l'expression régulière. Les caractères de cet argument - seront triés par ordre alphabétique. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lève une exception MongoDB\Driver\Exception\InvalidArgumentException si pattern ou flags contient un octet nul. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.2.0 - - - L'argument flags est optionnel et la valeur - par défaut est une chaîne vide. - - - Les caractères dans l'argument flags seront - triés par ordre alphabétique lorsqu'une Regex est construite. - Auparavant, les caractères étaient stockés dans l'ordre fourni. - - - MongoDB\Driver\Exception\InvalidArgumentException - est levé si pattern ou - flags contient un octet nul. Auparavant, - les valeurs étaient tronquées au premier octet nul. - - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Regex::__construct</function> example - - -]]> - - &example.outputs; - - - string(4) "^foo" - ["flags"]=> - string(1) "i" -} -]]> - - - - - - - &reftitle.seealso; - - Les types BSON - Les drapeaux supportés - pour les expressions régulières - - - - - - diff --git a/reference/mongodb/bson/regex/getflags.xml b/reference/mongodb/bson/regex/getflags.xml deleted file mode 100644 index 615440d260..0000000000 --- a/reference/mongodb/bson/regex/getflags.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - MongoDB\BSON\Regex::getFlags - Retourne les drapeaux de la REGEX - - - - &reftitle.description; - - final public stringMongoDB\BSON\Regex::getFlags - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les drapeaux de la REGEX. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>BSON\Regex::getFlags</function> - -getFlags()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Les types BSON - Les drapeaux supportés - des expressions régulières - - - - - - diff --git a/reference/mongodb/bson/regex/getpattern.xml b/reference/mongodb/bson/regex/getpattern.xml deleted file mode 100644 index 17d1412d1f..0000000000 --- a/reference/mongodb/bson/regex/getpattern.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - MongoDB\BSON\Regex::getPattern - Retourne le masque du REGEX - - - - &reftitle.description; - - final public stringMongoDB\BSON\Regex::getPattern - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le masque du REGEX. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>BSON\Regex::getPattern</function> - -getPattern()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Les types BSON - - - - - - diff --git a/reference/mongodb/bson/regex/jsonserialize.xml b/reference/mongodb/bson/regex/jsonserialize.xml deleted file mode 100644 index 0d0fb96c82..0000000000 --- a/reference/mongodb/bson/regex/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\Regex::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Regex::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\Regex. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/regex/tostring.xml b/reference/mongodb/bson/regex/tostring.xml deleted file mode 100644 index 8c3d82bbf1..0000000000 --- a/reference/mongodb/bson/regex/tostring.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - MongoDB\BSON\Regex::__toString - Retourne la chaîne représentant cette REGEX - - - - &reftitle.description; - - final public stringMongoDB\BSON\Regex::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la chaîne représentant cette REGEX. - - - - - &reftitle.examples; - - Exemple avec <function>BSON\Regex::__toString</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Les types BSON - - - - - - diff --git a/reference/mongodb/bson/regexinterface.xml b/reference/mongodb/bson/regexinterface.xml deleted file mode 100644 index 1ee7d7328c..0000000000 --- a/reference/mongodb/bson/regexinterface.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - L'interface MongoDB\BSON\RegexInterface - MongoDB\BSON\RegexInterface - - -
    - &reftitle.intro; - - Cette interface est implémentée par MongoDB\BSON\Regex - pour être utilisée comme type de paramètre, de retour ou de propriété dans les classes utilisateurs. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\RegexInterface - - - MongoDB\BSON\RegexInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -     - - &reference.mongodb.bson.entities.regexinterface; - -     - - diff --git a/reference/mongodb/bson/regexinterface/getflags.xml b/reference/mongodb/bson/regexinterface/getflags.xml deleted file mode 100644 index dac32adee4..0000000000 --- a/reference/mongodb/bson/regexinterface/getflags.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\RegexInterface::getFlags - Retourne les drapeaux de RegexInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\RegexInterface::getFlags - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les drapeaux de RegexInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Regex::getFlags - - - - - - diff --git a/reference/mongodb/bson/regexinterface/getpattern.xml b/reference/mongodb/bson/regexinterface/getpattern.xml deleted file mode 100644 index 05959054b8..0000000000 --- a/reference/mongodb/bson/regexinterface/getpattern.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\RegexInterface::getPattern - Retourne le masque de RegexInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\RegexInterface::getPattern - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le masque de RegexInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Regex::getPattern - - - - - - diff --git a/reference/mongodb/bson/regexinterface/tostring.xml b/reference/mongodb/bson/regexinterface/tostring.xml deleted file mode 100644 index fa4bae97f1..0000000000 --- a/reference/mongodb/bson/regexinterface/tostring.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\RegexInterface::__toString - Retourne la représentation sous forme de chaîne de caractères de cette RegexInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\RegexInterface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation sous forme de &string; de cette RegexInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Regex::__toString - - - - - - diff --git a/reference/mongodb/bson/serializable.xml b/reference/mongodb/bson/serializable.xml deleted file mode 100644 index 4aa0bc7095..0000000000 --- a/reference/mongodb/bson/serializable.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - La classe MongoDB\BSON\Serializable - MongoDB\BSON\Serializable - - - - -
    - &reftitle.intro; - - Les classes qui implémentent cette interface peuvent retourner des données - à sérialiser comme un tableau ou un document BSON, à la place des propriétés - publiques de l'objet. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\BSON\Serializable - - - - - MongoDB\BSON\Serializable - - - - MongoDB\BSON\Type - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    - -     - - &reference.mongodb.bson.entities.serializable; - -     - - diff --git a/reference/mongodb/bson/serializable/bsonserialize.xml b/reference/mongodb/bson/serializable/bsonserialize.xml deleted file mode 100644 index 9e921e73e5..0000000000 --- a/reference/mongodb/bson/serializable/bsonserialize.xml +++ /dev/null @@ -1,251 +0,0 @@ - - - - - - - MongoDB\BSON\Serializable::bsonSerialize - Fournit un tableau ou un document à sérialiser en tant que BSON - - - - &reftitle.description; - - abstract public arraystdClassMongoDB\BSON\DocumentMongoDB\BSON\PackedArrayMongoDB\BSON\Serializable::bsonSerialize - - - - Appelé pendant la sérialisation de l'objet à BSON. La méthode doit retourner - un &array;, stdClass, - MongoDB\BSON\Document ou - MongoDB\BSON\PackedArray. - - - Les documents racine (par exemple, un - MongoDB\BSON\Serializable passé à - MongoDB\BSON\Document::fromPHP) seront toujours sérialisés en tant - que document BSON. Pour les valeurs de champ, les tableaux associatifs et les - instances stdClass seront sérialisés en tant que - document BSON et les tableaux séquentiels (c'est-à-dire les index numériques - séquentiels commençant à 0) seront sérialisés en tant que - tableau BSON. - - - Les utilisateurs sont encouragés à inclure une propriété _id - (par exemple un MongoDB\BSON\ObjectId initialisé dans le constructeur) - lors du retour des données pour un document racine BSON. En l'absence d'une - propriété _id, l'extension ou le serveur générera un - MongoDB\BSON\ObjectId pour les opérations d'insertion ou - de mise à jour, respectivement. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &array;, stdClass, MongoDB\BSON\Document, - ou MongoDB\BSON\PackedArray à sérialiser en tant que tableau ou document BSON. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - - PECL mongodb 1.17.0 - - - Le type de retour n'est plus arrayobject. - Plutôt qu'un object, le type de retour spécifie désormais - stdClass. Les classes implémentant cette interface doivent - être modifiées pour ne plus utiliser le type de retour object. - Le type de retour étant prévisionnel, un avertissement de dépréciation est émis en PHP 8.1 - ou ultérieur si les implémentations n'utilisent pas le bon type de retour. - - - Additionnellement aux changements ci-dessus, l'extension supporte - désormais de retourner des instances de - MongoDB\BSON\Document - et MongoDB\BSON\PackedArray. À noter que - toute instance de MongoDB\BSON\PackedArray - sera silencieusement convertie en objet lorsqu'il est stocké comme document - racine. - Ces instances sont stockées sous forme de tableaux lorsqu'elles sont - utilisées comme valeur de champ intégrée. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Serializable::bsonSerialize</function> renvoyant un tableau associatif pour le document racine - -id = new MongoDB\BSON\ObjectId; - } - - function bsonSerialize(): array - { - return ['_id' => $this->id, 'foo' => 'bar']; - } -} - -echo MongoDB\BSON\Document::fromPHP(new MyDocument)->toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - - <function>MongoDB\BSON\Serializable::bsonSerialize</function> renvoyant un tableau séquentiel pour le document racine - -toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - <function>MongoDB\BSON\Serializable::bsonSerialize</function> renvoyant un tableau associatif pour le champ de document - - 'bar']; - } -} - -$value = ['document' => new MyDocument]; - -echo MongoDB\BSON\Document::fromPHP($value)->toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - <function>MongoDB\BSON\Serializable::bsonSerialize</function> renvoyant un tableau séquentiel pour le champ de document - - new MyArray]; - -echo MongoDB\BSON\Document::fromPHP($value)->toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Unserializable::bsonUnserialize - MongoDB\BSON\Persistable - - - - - - - diff --git a/reference/mongodb/bson/symbol.xml b/reference/mongodb/bson/symbol.xml deleted file mode 100644 index ec972cc299..0000000000 --- a/reference/mongodb/bson/symbol.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - La classe MongoDB\BSON\Symbol - MongoDB\BSON\Symbol - - - - -
    - &reftitle.intro; - - Type BSON pour le type "Symbol". Ce type BSON est déprécié, et cette - classe ne peut pas être instanciée. Elle sera créée à partir d'un type - symbol BSON lors de la conversion BSON en PHP, et peut également être - convertie en BSON lors du stockage de documents dans la base de données. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Symbol - - - - final - - MongoDB\BSON\Symbol - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implémente Stringable pour PHP 8.0+. - - - - - -
    - -     - - &reference.mongodb.bson.entities.symbol; - -     - - diff --git a/reference/mongodb/bson/symbol/construct.xml b/reference/mongodb/bson/symbol/construct.xml deleted file mode 100644 index 57b63acad2..0000000000 --- a/reference/mongodb/bson/symbol/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - MongoDB\BSON\Symbol::__construct - Construit un nouveau Symbol (inutilisé) - - - - &reftitle.description; - - final private MongoDB\BSON\Symbol::__construct - - - - Les objets MongoDB\BSON\Symbol sont créés à travers une - conversion depuis un type BSON obsolète et ne peuvent pas être construits directement. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/symbol/jsonserialize.xml b/reference/mongodb/bson/symbol/jsonserialize.xml deleted file mode 100644 index 2465b32468..0000000000 --- a/reference/mongodb/bson/symbol/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\Symbol::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Symbol::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\Symbol. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/symbol/tostring.xml b/reference/mongodb/bson/symbol/tostring.xml deleted file mode 100644 index c02618538e..0000000000 --- a/reference/mongodb/bson/symbol/tostring.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\Symbol::__toString - Retourne la représentation sous forme de chaîne de caractères de Symbol - - - - &reftitle.description; - - final public stringMongoDB\BSON\Symbol::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation sous forme de chaîne de caractères de Symbol. - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/timestamp.xml b/reference/mongodb/bson/timestamp.xml deleted file mode 100644 index 78fa8a5bb8..0000000000 --- a/reference/mongodb/bson/timestamp.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - La classe MongoDB\BSON\Timestamp - MongoDB\BSON\Timestamp - - - - -
    - &reftitle.intro; - - Représente un - horodatage BSON, - la valeur se compose d'un horodatage de 4 octets (c.-à-d. secondes depuis - l'époque) et d'une incrémentation de 4 octets. - - - - Il s'agit d'un type MongoDB interne utilisé pour la réplication et la - fragmentation. Il n'est pas prévu pour le stockage de date générale - (MongoDB\BSON\UTCDateTime doit être utilisé à la place). - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Timestamp - - - - final - - MongoDB\BSON\Timestamp - - - - - MongoDB\BSON\TimestampInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implémente Stringable pour PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implémente MongoDB\BSON\TimestampInterface. - - - - PECL mongodb 1.2.0 - - Implémente Serializable et - JsonSerializable. - - - - - -
    - -     - - &reference.mongodb.bson.entities.timestamp; - -     - diff --git a/reference/mongodb/bson/timestamp/construct.xml b/reference/mongodb/bson/timestamp/construct.xml deleted file mode 100644 index 95c54320fb..0000000000 --- a/reference/mongodb/bson/timestamp/construct.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - - MongoDB\BSON\Timestamp::__construct - Construit un nouveau Timestamp - - - - &reftitle.description; - - final public MongoDB\BSON\Timestamp::__construct - intincrement - inttimestamp - - - - - &reftitle.parameters; - - - increment (int) - - - Entier de 32-bit qui indique l'ordinal incrémentiel pour les opérations dans une seconde donnée. - - - - - timestamp (int) - - - Entier de 32-bit indiquant des secondes depuis l'époque UNIX. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Timestamp::__construct</function> - - -]]> - - &example.outputs; - - - int(1234) - ["timestamp"]=> - int(5678) -} -]]> - - - - - - - &reftitle.seealso; - - Le type BSON : Timestamps - - - - - - diff --git a/reference/mongodb/bson/timestamp/getincrement.xml b/reference/mongodb/bson/timestamp/getincrement.xml deleted file mode 100644 index 6771fabfc0..0000000000 --- a/reference/mongodb/bson/timestamp/getincrement.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - MongoDB\BSON\Timestamp::getIncrement - Retourne le composant d'incrémentation de ce Timestamp - - - - &reftitle.description; - - final public intMongoDB\BSON\Timestamp::getIncrement - - - - Le composant d'incrémentation d'un Timestamp est ses 32 bits les moins significatifs, - qui désignent l'ordinal incrémentant pour les opérations pour une seconde donnée. - Cette valeur est lue comme un entier 32-bits non signé avec un ordre d'octet big-endian. - - &mongodb.note.uint32; - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le composant d'incrémentation de ce Timestamp. - - - - Sur les systèmes 32 bits cette méthode peut retourner un nombre négatif. - Bien que les parties d'incrémentation et d'horodatages du type BSON timestamp - consiste de deux valeurs 32-bits non signé, PHP ne peut les représenter sur les - plateformes 32-bit. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - Types BSON : Timestamps - - - - - - diff --git a/reference/mongodb/bson/timestamp/gettimestamp.xml b/reference/mongodb/bson/timestamp/gettimestamp.xml deleted file mode 100644 index 3ac452b584..0000000000 --- a/reference/mongodb/bson/timestamp/gettimestamp.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - MongoDB\BSON\Timestamp::getTimestamp - Retourne le composant d'horodatage de Timestamp - - - - &reftitle.description; - - final public intMongoDB\BSON\Timestamp::getTimestamp - - - - Le composant d'horodatage d'un Timestamp est ses 32 bits les plus significatifs, - qui dénote le nombre de secondes depuis l'epoch Unix. Cette valeur est lue comme - un entier 32-bit non signé avec un ordre d'octets big-endian. - - &mongodb.note.uint32; - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le composant d'horodatage de Timestamp. - - - - Sur les systèmes 32-bits cette méthode peut retourner un nombre négatif. - Bien que les parties d'incrémentation et d'horodatage du type timestamp BSON - consiste de deux valeurs 32-bits non signé, PHP ne peut pas les représenter sur les plateformes 32-bits. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - Types BSON : Timestamps - - - - - - diff --git a/reference/mongodb/bson/timestamp/jsonserialize.xml b/reference/mongodb/bson/timestamp/jsonserialize.xml deleted file mode 100644 index 63e610f160..0000000000 --- a/reference/mongodb/bson/timestamp/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\Timestamp::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Timestamp::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\Timestamp. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/timestamp/tostring.xml b/reference/mongodb/bson/timestamp/tostring.xml deleted file mode 100644 index c15495dd58..0000000000 --- a/reference/mongodb/bson/timestamp/tostring.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - MongoDB\BSON\Timestamp::__toString - Retourne la représentation sous forme de chaîne de cet horodatage - - - - &reftitle.description; - - final public stringMongoDB\BSON\Timestamp::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation sous forme de chaîne de cet horodatage. - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Timestamp::__toString</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Le type BSON : Timestamps - - - - - - diff --git a/reference/mongodb/bson/timestampinterface.xml b/reference/mongodb/bson/timestampinterface.xml deleted file mode 100644 index b8c4db43c8..0000000000 --- a/reference/mongodb/bson/timestampinterface.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - L'interface MongoDB\BSON\TimestampInterface - MongoDB\BSON\TimestampInterface - - -
    - &reftitle.intro; - - Cette interface est implémentée par MongoDB\BSON\Timestamp pour être utilisée comme type de paramètre, - de retour ou de propriété dans les classes utilisateurs. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\TimestampInterface - - - MongoDB\BSON\TimestampInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -     - - &reference.mongodb.bson.entities.timestampinterface; - -     - - diff --git a/reference/mongodb/bson/timestampinterface/getincrement.xml b/reference/mongodb/bson/timestampinterface/getincrement.xml deleted file mode 100644 index 24db32efe2..0000000000 --- a/reference/mongodb/bson/timestampinterface/getincrement.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - MongoDB\BSON\TimestampInterface::getIncrement - Retourne le composant d'incrémentation de ce TimestampInterface - - - - &reftitle.description; - - abstract public intMongoDB\BSON\TimestampInterface::getIncrement - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le composant d'incrémentation de ce TimestampInterface. - - - - Sur les systèmes 32 bits cette méthode peut retourner un nombre négatif. - Bien que les parties d'incrémentation et d'horodatages du type BSON timestamp - consiste de deux valeurs 32-bits non signé, PHP ne peut les représenter sur les - plateformes 32-bit. - - - - - - &reftitle.seealso; - - MongoDB\BSON\Timestamp::getIncrement - - - - - - diff --git a/reference/mongodb/bson/timestampinterface/gettimestamp.xml b/reference/mongodb/bson/timestampinterface/gettimestamp.xml deleted file mode 100644 index f624f51e64..0000000000 --- a/reference/mongodb/bson/timestampinterface/gettimestamp.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - MongoDB\BSON\TimestampInterface::getTimestamp - Retourne le composant d'horodatage de TimestampInterface - - - - &reftitle.description; - - abstract public intMongoDB\BSON\TimestampInterface::getTimestamp - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le composant d'horodatage de TimestampInterface. - - - - Sur les systèmes 32-bits cette méthode peut retourner un nombre négatif. - Bien que les parties d'incrémentation et d'horodatage du type timestamp BSON - consiste de deux valeurs 32-bits non signé, PHP ne peut pas les représenter sur les plateformes 32-bits. - - - - - - &reftitle.seealso; - - MongoDB\BSON\Timestamp::getTimestamp - - - - - - diff --git a/reference/mongodb/bson/timestampinterface/tostring.xml b/reference/mongodb/bson/timestampinterface/tostring.xml deleted file mode 100644 index b4d26ef041..0000000000 --- a/reference/mongodb/bson/timestampinterface/tostring.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\TimestampInterface::__toString - Retourne la représentation sous forme de chaîne de caractères de TimestampInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\TimestampInterface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation sous forme de chaîne de caractères de TimestampInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Timestamp::__toString - - - - - - diff --git a/reference/mongodb/bson/type.xml b/reference/mongodb/bson/type.xml deleted file mode 100644 index ac0e647c14..0000000000 --- a/reference/mongodb/bson/type.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - L'interface MongoDB\BSON\Type - MongoDB\BSON\Type - - - - -
    - &reftitle.intro; - - Interface de base abstraite qui ne doit pas être implémentée directement. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\BSON\Type - - - - - MongoDB\BSON\Type - - - - - - - - - Cette interface n'a pas de méthodes. Son seul but est d'être l'interface - de base pour toutes les classes de type BSON. - - -
    - -     - -     - - diff --git a/reference/mongodb/bson/undefined.xml b/reference/mongodb/bson/undefined.xml deleted file mode 100644 index dbe8a78b75..0000000000 --- a/reference/mongodb/bson/undefined.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - La classe MongoDB\BSON\Undefined - MongoDB\BSON\Undefined - - - - -
    - &reftitle.intro; - - Type BSON pour le type "Undefined". Ce type BSON est déprécié, et cette - classe ne peut pas être instanciée. Elle sera créée à partir d'un type - BSON undefined lors de la conversion BSON en PHP, et peut également être - convertie en BSON lors du stockage de documents dans la base de données. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Undefined - - - - final - - MongoDB\BSON\Undefined - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implémente Stringable pour PHP 8.0+. - - - - - -
    - -     - - &reference.mongodb.bson.entities.undefined; - -     - - diff --git a/reference/mongodb/bson/undefined/construct.xml b/reference/mongodb/bson/undefined/construct.xml deleted file mode 100644 index c23daf6291..0000000000 --- a/reference/mongodb/bson/undefined/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - MongoDB\BSON\Undefined::__construct - Construit un nouveau Undefined (inutilisé) - - - - &reftitle.description; - - final private MongoDB\BSON\Undefined::__construct - - - - Les objets MongoDB\BSON\Undefined sont créés à travers - une conversion depuis un type BSON obsolète et ne peuvent pas être construits directement. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/undefined/jsonserialize.xml b/reference/mongodb/bson/undefined/jsonserialize.xml deleted file mode 100644 index 656d674b3b..0000000000 --- a/reference/mongodb/bson/undefined/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\Undefined::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Undefined::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\Undefined. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/undefined/tostring.xml b/reference/mongodb/bson/undefined/tostring.xml deleted file mode 100644 index 9e0221bb43..0000000000 --- a/reference/mongodb/bson/undefined/tostring.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\Undefined::__toString - Retourne une chaîne vide - - - - &reftitle.description; - - final public stringMongoDB\BSON\Undefined::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne vide. - - - - - &reftitle.seealso; - - Types BSON - - - - - - diff --git a/reference/mongodb/bson/unserializable.xml b/reference/mongodb/bson/unserializable.xml deleted file mode 100644 index 5e261e87f9..0000000000 --- a/reference/mongodb/bson/unserializable.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - L'interface MongoDB\BSON\Unserializable - MongoDB\BSON\Unserializable - - - - -
    - &reftitle.intro; - - Les classes qui implémentent cette interface peuvent être spécifiées - dans une carte de type - pour les tableaux et les documents BSON désérialisés (à la fois racine et - embarqué). - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\BSON\Unserializable - - - - - MongoDB\BSON\Unserializable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    - -     - - &reference.mongodb.bson.entities.unserializable; - -     - - diff --git a/reference/mongodb/bson/unserializable/bsonunserialize.xml b/reference/mongodb/bson/unserializable/bsonunserialize.xml deleted file mode 100644 index 739df515cd..0000000000 --- a/reference/mongodb/bson/unserializable/bsonunserialize.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - MongoDB\BSON\Unserializable::bsonUnserialize - Construit l'objet à partir d'un tableau ou d'un document BSON - - - - &reftitle.description; - - abstract public voidMongoDB\BSON\Unserializable::bsonUnserialize - arraydata - - - Appelé lors de la désérialisation de l'objet à partir de BSON. Les propriétés - du tableau ou du document BSON seront transmises à la méthode sous la forme - d'un &array;. - - - Il ne faut pas oublier de rechercher une propriété _id lors de - la gestion des données à partir d'un document BSON. - - - - Cette méthode agit comme le - constructeur de - l'objet. La méthode __construct() - ne sera pas appelée après cette méthode. - - - - - - &reftitle.parameters; - - - data (array) - - - Propriétés ayant le tableau ou le document BSON. - - - - - - - - &reftitle.returnvalues; - - La valeur de retour de cette méthode est ignorée. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\Unserializable::bsonUnserialize</function> - -data = $data; - } -} - -$bson = MongoDB\BSON\Document::fromJSON('{ "foo": "bar" }'); - -var_dump($bson->toPHP(['root' => 'MyDocument'])); - -?> -]]> - - &example.outputs; - - - array(1) { - ["foo"]=> - string(3) "bar" - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - MongoDB\BSON\Persistable - - - - - - - diff --git a/reference/mongodb/bson/utcdatetime.xml b/reference/mongodb/bson/utcdatetime.xml deleted file mode 100644 index f72d8c7e8e..0000000000 --- a/reference/mongodb/bson/utcdatetime.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - La classe MongoDB\BSON\UTCDatetime - MongoDB\BSON\UTCDatetime - - - - -
    - &reftitle.intro; - - Représente une - date BSON. La valeur - est un entier de 64 bits qui représente le nombre de millisecondes depuis - l'époque UNIX (1 janvier 1970). Les valeurs négatives représentent des - dates avant le 1970. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\UTCDateTime - - - - final - - MongoDB\BSON\UTCDateTime - - - - MongoDB\BSON\UTCDateTimeInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implémente Stringable pour PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implémente MongoDB\BSON\UTCDateTimeInterface. - - - - PECL mongodb 1.2.0 - - Implémente Serializable et - JsonSerializable. - - - - - -
    - -     - - &reference.mongodb.bson.entities.utcdatetime; - -     - diff --git a/reference/mongodb/bson/utcdatetime/construct.xml b/reference/mongodb/bson/utcdatetime/construct.xml deleted file mode 100644 index 36040cb3b2..0000000000 --- a/reference/mongodb/bson/utcdatetime/construct.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - MongoDB\BSON\UTCDateTime::__construct - Construit un nouveau UTCDateTime - - - - &reftitle.description; - - final public MongoDB\BSON\UTCDateTime::__construct - intMongoDB\BSON\Int64DateTimeInterfacenullmilliseconds&null; - - - - - &reftitle.parameters; - - - milliseconds (intMongoDB\BSON\Int64DateTimeInterfacenull) - - - Nombre de millisecondes depuis l'époque UNIX (1 janvier 1970). Les valeurs - négatives représentent des dates avant le 1970. Cette valeur peut être - fournie en tant qu'&integer; 64 bits. Pour la compatibilité sur les - systèmes 32 bits, ce paramètre peut également être fourni comme une - MongoDB\BSON\Int64. - - - Si l'argument est un DateTimeInterface, le nombre - de millisecondes depuis l'époque UNIX sera dérivé de cette valeur. - - - Si cet argument est &null;, l'heure actuelle sera utilisée par défaut. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - Le paramètre milliseconds n'accepte désormais plus - de string ou de float. - - - - - PECL mongodb 1.20.0 - - - L'argument milliseconds accepte désormais un objet - MongoDB\BSON\Int64 (pour compatibilité avec les - plateformes 32 bits). Spécifier une string ou un - float est déprécié. - - - - - PECL mongodb 1.2.0 - - - L'argument milliseconds est facultatif et par - défaut à &null; (c'est-à-dire l'heure actuelle). L'argument accepte - également un DateTimeInterface, qui peut être - utilisé pour calculer le nombre de millisecondes depuis l'époque UNIX. - Auparavant, seuls les types &integer;, &float; et &string; étaient acceptés. - - - - - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\UTCDatetime::__construct</function> - - -]]> - - &example.outputs.similar; - - - string(13) "1484852905560" -} -object(MongoDB\BSON\UTCDateTime)#1 (1) { - ["milliseconds"]=> - string(13) "1484852905560" -} -object(MongoDB\BSON\UTCDateTime)#1 (1) { - ["milliseconds"]=> - string(13) "1416445411987" -} -]]> - - - - - - - &reftitle.seealso; - - BSON Types: Date - - - - - - diff --git a/reference/mongodb/bson/utcdatetime/jsonserialize.xml b/reference/mongodb/bson/utcdatetime/jsonserialize.xml deleted file mode 100644 index d2fdde05d8..0000000000 --- a/reference/mongodb/bson/utcdatetime/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\UTCDateTime::jsonSerialize - Retourne une représentation qui peut être convertie en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\UTCDateTime::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne des données qui peuvent être sérialisées par json_encode - pour produire une représentation JSON étendue de - MongoDB\BSON\UTCDateTime. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Étendue - - - - - - diff --git a/reference/mongodb/bson/utcdatetime/todatetime.xml b/reference/mongodb/bson/utcdatetime/todatetime.xml deleted file mode 100644 index 75307b6cb7..0000000000 --- a/reference/mongodb/bson/utcdatetime/todatetime.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - MongoDB\BSON\UTCDateTime::toDateTime - Retourne la représentation DateTime de ce UTCDateTime - - - - &reftitle.description; - - final public DateTimeMongoDB\BSON\UTCDatetime::toDateTime - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation DateTime de ce UTCDateTime. - Le DateTime retourné utilisera le fuseau horaire UTC. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\UTCDatetime::toDateTime</function> - -toDateTime(); -var_dump($datetime->format('r')); -var_dump($datetime->format('U.u')); -var_dump($datetime->getTimezone()); - -?> -]]> - - &example.outputs.similar; - - - int(1) - ["timezone"]=> - string(6) "+00:00" -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::toDateTimeImmutable - Le type BSON : Date - - - - - - diff --git a/reference/mongodb/bson/utcdatetime/todatetimeimmutable.xml b/reference/mongodb/bson/utcdatetime/todatetimeimmutable.xml deleted file mode 100644 index c6ad250258..0000000000 --- a/reference/mongodb/bson/utcdatetime/todatetimeimmutable.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTime::toDateTimeImmutable - Renvoie la représentation DateTimeImmutable de cette UTCDateTime - - - - &reftitle.description; - - final public DateTimeImmutableMongoDB\BSON\UTCDateTime::toDateTimeImmutable - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la représentation DateTimeImmutable de cette - UTCDateTime. Le DateTimeImmutable renvoyé utilisera - le fuseau horaire UTC. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\BSON\UTCDatetime::toDateTimeImmutable</function> - -toDateTimeImmutable(); -var_dump($datetime->format('r')); -var_dump($datetime->format('U.u')); -var_dump($datetime->getTimezone()); - -?> -]]> - - &example.outputs.similar; - - - int(1) - ["timezone"]=> - string(6) "+00:00" -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::toDateTime - Types BSON : Date - - - - - - diff --git a/reference/mongodb/bson/utcdatetime/tostring.xml b/reference/mongodb/bson/utcdatetime/tostring.xml deleted file mode 100644 index 852e8815c7..0000000000 --- a/reference/mongodb/bson/utcdatetime/tostring.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - MongoDB\BSON\UTCDateTime::__toString - Retourne la représentation sous forme de chaîne de ce UTCDateTime - - - - &reftitle.description; - - final public stringMongoDB\BSON\UTCDateTime::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation sous forme de chaîne de ce UTCDateTime. - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\UTCDatetime::__toString</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - BSON Types: Date - - - - - - diff --git a/reference/mongodb/bson/utcdatetimeinterface.xml b/reference/mongodb/bson/utcdatetimeinterface.xml deleted file mode 100644 index d488abe03d..0000000000 --- a/reference/mongodb/bson/utcdatetimeinterface.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - L'interface MongoDB\BSON\UTCDateTimeInterface - MongoDB\BSON\UTCDateTimeInterface - - -
    - &reftitle.intro; - - Cette interface est implémentée par MongoDB\BSON\UTCDateTime pour être utilisée comme - type de paramètre, de retour ou de propriété dans les classes utilisateurs. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\UTCDateTimeInterface - - - MongoDB\BSON\UTCDateTimeInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -     - - &reference.mongodb.bson.entities.utcdatetimeinterface; - -     - - diff --git a/reference/mongodb/bson/utcdatetimeinterface/todatetime.xml b/reference/mongodb/bson/utcdatetimeinterface/todatetime.xml deleted file mode 100644 index b0c825528f..0000000000 --- a/reference/mongodb/bson/utcdatetimeinterface/todatetime.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - MongoDB\BSON\UTCDateTimeInterface::toDateTime - Retourne la représentation DateTime d'UTCDateTimeInterface - - - - &reftitle.description; - - abstract public DateTimeMongoDB\BSON\UTCDateTimeInterface::toDateTime - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation DateTime de cette - UTCDateTimeInterface. Le DateTime devrait utiliser - le fuseau horaire UTC. - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::toDateTime - - - - - - diff --git a/reference/mongodb/bson/utcdatetimeinterface/todatetimeimmutable.xml b/reference/mongodb/bson/utcdatetimeinterface/todatetimeimmutable.xml deleted file mode 100644 index 13fda84410..0000000000 --- a/reference/mongodb/bson/utcdatetimeinterface/todatetimeimmutable.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - MongoDB\BSON\UTCDateTimeInterface::toDateTimeImmutable - Renvoie la représentation DateTimeImmutable de cette UTCDateTimeInterface - - - - &reftitle.description; - - abstract public DateTimeImmutableMongoDB\BSON\UTCDateTimeInterface::toDateTimeImmutable - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la représentation DateTimeImmutable de cette - UTCDateTimeInterface. La DateTimeImmutable retournée utilisera le fuseau - horaire UTC. - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::toDateTimeImmutable - - - - - - diff --git a/reference/mongodb/bson/utcdatetimeinterface/tostring.xml b/reference/mongodb/bson/utcdatetimeinterface/tostring.xml deleted file mode 100644 index 849e9e56a6..0000000000 --- a/reference/mongodb/bson/utcdatetimeinterface/tostring.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\UTCDateTimeInterface::__toString - Retourne la représentation sous forme de chaîne de caractères d'UTCDateTimeInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\UTCDateTimeInterface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation sous forme de chaîne de caractères d'UTCDateTimeInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::__toString - - - - - - diff --git a/reference/mongodb/bson/vectortype.xml b/reference/mongodb/bson/vectortype.xml deleted file mode 100644 index 3a4c92112d..0000000000 --- a/reference/mongodb/bson/vectortype.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - L'énumération MongoDB\BSON\VectorType - MongoDB\BSON\VectorType - - -
    - &reftitle.intro; - - L'énumération MongoDB\BSON\VectorType est utilisée pour spécifier le type de - données vectorielles stockées dans une MongoDB\BSON\Binary avec le - sous-type MongoDB\BSON\Binary::TYPE_VECTOR. - -
    - -
    - &reftitle.enumsynopsis; - - - MongoDB\BSON\VectorType - - - Float32 - - Chaque élément dans le vecteur est une valeur à virgule flottante de 32 bits. - - - - - Int8 - - Chaque élément dans le vecteur est une valeur entière de 8 bits. - - - - - PackedBit - - Chaque élément dans le vecteur est une valeur de 1 bit. Lors de la création de vecteurs - de ce type, il est possible de passer soit des valeurs bool, soit des valeurs int de 1 bit, c'est-à-dire 0 ou 1. - - - -
    -     -     - - diff --git a/reference/mongodb/configure.xml b/reference/mongodb/configure.xml deleted file mode 100644 index b9c7837c3f..0000000000 --- a/reference/mongodb/configure.xml +++ /dev/null @@ -1,331 +0,0 @@ - - -
    - &reftitle.install; - -
    - Installer l'extension de MongoDB PHP avec PIE - - &pecl.moving.to.pie; - - - Pour installer l'extension MongoDB avec PIE, exécutez la commande suivante : - - - - - -
    - - -
    - Installer l'extension de MongoDB PHP avec PECL - - - &pecl.info; - &url.pecl.package;mongodb - - - - Linux, Unix et les utilisateurs de macOS peuvent exécuter la commande suivante pour - installer l'extension : - - - - - - - Sur les systèmes avec plusieurs versions de PHP installées (par exemple, macOS par défaut, - Homebrew), chaque version de PHP - aura sa propre commande pecl - et fichier &php.ini;. De plus, chaque environnement PHP (par exemple - CLI, web) peut utiliser des fichiers &php.ini; séparés. - - - - Depuis la version 1.17.0 de l'extension, PECL demandera diverses options de - configure. Pour installer l'extension avec les options par défaut - dans un script non interactif, une entrée vide peut être envoyée à - pecl install en utilisant la commande yes : - - - - - - - Une liste complète des options configure supportées peut être - trouvée dans le fichier package.xml inclus dans le paquet PECL. - Pour installer l'extension avec des options de configure spécifiques - dans un script non interactif, l'option - --configureoptions pour - pecl install peut être utilisée : - - - - - - - Par défaut l'installation de l'extension via PECL utilisera les versions incluses de - libbson, - libmongoc, et - libmongocrypt et essayera automatiquement - de configurer. - - - - - Si le processus de construction échoue à trouver une bibliothèque SSL, vérifiez que les - paquets de développement (par exemple libssl-dev) et - pkg-config sont tous deux - installés. Si cela ne résout pas le problème, envisagez d'utiliser le - processus - d'installation manuel. - - - - - Pour finir, ajoutez la ligne suivante au fichier &php.ini; pour chaque environnement - qui aura besoin d'utiliser l'extension : - - - - -
    - -
    - Installer l'extension de MongoDB PHP sur macOS avec Homebrew - - - Homebrew 1.5.0 - a déprécié le tap Homebrew/php - et a supprimé les formules pour les extensions PHP individuelles. À l'avenir, les utilisateurs - de macOS sont invités à installer la formule - php et à suivre les instructions - d'installation standard de PECL - en utilisant la commande pecl - fournie par l'installation PHP Homebrew. - - - Sinon, le - tap shivammathur/extensions - fourni des formules pour les extensions PHP individuelles. Par exemple, pour installer - l'extension pour PHP 8.4, exécutez : - - - - Il est à noter que seule la dernière version de l'extension est disponible dans brew. - - - Installer les dépendances requises - - Pour garantir que le support SSL peut être configuré correctement, il faut s'assurer que les - formules openssl et pkgconf sont - installées. Si l'un de ces paquets est manquant, l'extension sera compilée - avec Secure Transport, ce qui peut entraîner des problèmes de compatibilité. - - -
    - -
    - Installer l'extension de MongoDB PHP sur Windows - - - Les binaires précompilés sont attachés aux - versions Github - du projet. Les archives sont publiées pour diverses combinaisons de version PHP, - de sécurité des threads (TS ou NTS) et d'architecture (x86 ou x64). Déterminez - l'archive correcte pour l'environnement PHP et extrayez le fichier - php_mongodb.dll dans le répertoire d'extension ("ext" par défaut). - - - - Ajouter la ligne suivante au fichier &php.ini; pour chaque environnement qui aura - besoin d'utiliser l'extension : - - - - - - - L'échec de sélection du binaire correct entraînera une erreur lors de la tentative - de chargement de l'extension DLL à l'exécution : - - - - - - - Il faut s'assurer que la DLL téléchargée correspond aux propriétés d'exécution PHP - suivantes : - - Version de PHP(PHP_VERSION) - Sécurité des threads (PHP_ZTS) - Architecture (PHP_INT_SIZE) - - - - - En plus des constantes mentionnées ci-dessus, ces propriétés peuvent également être - déduites de phpinfo. Si un système a plusieurs exécutions PHP - installées, vérifiez que la sortie de phpinfo est pour - l'environnement correct. - - - - Dépendances additionnelles DLL pour les utilisateurs Windows - - &ext.windows.path.dll; - libsasl.dll - - -
    - -
    - Installation manuelle de l'extension de MongoDB PHP - - - Pour les développeurs et les utilisateurs intéressés par les dernières corrections de bogues, - l'extension peut être compilée à partir du dernier code source sur - Github. Exécuter les commandes suivantes - pour cloner et construire le projet : - - - - - - - Sur les systèmes avec plusieurs versions de PHP installées (par exemple, macOS par défaut, - Homebrew), chaque version de PHP - aura sa propre commande phpize - et fichier &php.ini;. De plus, chaque environnement PHP (par exemple - CLI, web) peut utiliser des fichiers &php.ini; séparés. - - - - Par défaut, l'extension utilisera les versions incluses de - libbson, - libmongoc, et - libmongocrypt et - essayera de configurer automatiquement. Si ces bibliothèques sont déjà - installées en tant que bibliothèques système, l'extension peut les utiliser en - spécifiant --with-mongodb-system-libs=yes comme option à - configure. - - - - Pour une liste complète des options configure, exécutez - configure --help. - - - - Lorsqu'on utilise les versions groupées de libmongoc et libmongocrypt, - l'extension tentera également de sélectionner une bibliothèque SSL selon - l'option configure --with-mongodb-ssl. - À partir de la version 1.17.0 de l'extension, OpenSSL est toujours préféré par défaut. - Auparavant, Secure Transport était le défaut sur macOS et OpenSSL était le défaut - sur toutes les autres plates-formes. - - - - - Si le processus de construction échoue à trouver une bibliothèque SSL, vérifiez que les - paquets de développement (par exemple libssl-dev) et - pkg-config sont tous deux - installés. - - - - Lorsqu'on utilise Homebrew sur macOS, il est courant qu'un système ait - plusieurs versions d'OpenSSL installées. Pour garantir que la version d'OpenSSL - souhaitée est sélectionnée, la variable d'environnement PKG_CONFIG_PATH - peut être utilisée pour contrôler le chemin de recherche de pkg-config. - - - - - La dernière étape de construction, make install, indiquera où - mongodb.so a été installé, similaire à : - - - - - - - Il faut s'assurer que l'option extension_dir - dans &php.ini; pointe vers le répertoire où mongodb.so - a été installé. L'option peut être interrogée en exécutant : - - /usr/lib/php/extensions/debug-non-zts-20220829 => - /usr/lib/php/extensions/debug-non-zts-20220829 -]]> - - - - - Si les répertoires diffèrent, modifiez - extension_dir dans &php.ini; ou - déplacez manuellement mongodb.so dans le répertoire correct. - - - - Pour finir, ajoutez la ligne suivante au fichier &php.ini; pour chaque environnement - qui aura besoin d'utiliser l'extension : - - - - -
    - -
    - - - diff --git a/reference/mongodb/constants.xml b/reference/mongodb/constants.xml deleted file mode 100644 index a5235f8bd2..0000000000 --- a/reference/mongodb/constants.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - - MONGODB_VERSION - (string) - - - - Numéro de version de l'extension au format x.y.z - - - - - - MONGODB_STABILITY - (string) - - - - Stabilité actuelle (alpha/beta/stable) - - - - - - - - diff --git a/reference/mongodb/exceptions.xml b/reference/mongodb/exceptions.xml deleted file mode 100644 index fc2049e1fa..0000000000 --- a/reference/mongodb/exceptions.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - MongoDB\Driver\Exception - Les classes d'exception - - &reference.mongodb.mongodb.driver.exception.authenticationexception; - &reference.mongodb.mongodb.driver.exception.bulkwriteexception; - &reference.mongodb.mongodb.driver.exception.bulkwritecommandexception; - &reference.mongodb.mongodb.driver.exception.commandexception; - &reference.mongodb.mongodb.driver.exception.connectionexception; - &reference.mongodb.mongodb.driver.exception.connectiontimeoutexception; - &reference.mongodb.mongodb.driver.exception.encryptionexception; - &reference.mongodb.mongodb.driver.exception.exception; - &reference.mongodb.mongodb.driver.exception.executiontimeoutexception; - &reference.mongodb.mongodb.driver.exception.invalidargumentexception; - &reference.mongodb.mongodb.driver.exception.logicexception; - &reference.mongodb.mongodb.driver.exception.runtimeexception; - &reference.mongodb.mongodb.driver.exception.serverexception; - &reference.mongodb.mongodb.driver.exception.sslconnectionexception; - &reference.mongodb.mongodb.driver.exception.unexpectedvalueexception; - &reference.mongodb.mongodb.driver.exception.writeexception; - -
    - Arbre de classes - L'arbre des exceptions MongoDB - - - La hiérarchie de classes pour les exceptions MongoDB est modélisée d'après - celle des Exceptions SPL. Les classes - de base étendent leur homologue SPL et toutes les classes d'exception de - l'extension implémentent l'interface MongoDB\Driver\Exception\Exception. - - - - MongoDB\Driver\Exception\LogicException (extends LogicException) - MongoDB\Driver\Exception\InvalidArgumentException (extends InvalidArgumentException) - MongoDB\Driver\Exception\UnexpectedValueException (extends UnexpectedValueException) - - MongoDB\Driver\Exception\RuntimeException (extends RuntimeException) - - - MongoDB\Driver\Exception\ConnectionException - - MongoDB\Driver\Exception\AuthenticationException - MongoDB\Driver\Exception\ConnectionTimeoutException - MongoDB\Driver\Exception\SSLConnectionException (dépréciée) - - - MongoDB\Driver\Exception\EncryptionException - - MongoDB\Driver\Exception\ServerException - - MongoDB\Driver\Exception\BulkWriteCommandException - MongoDB\Driver\Exception\CommandException - MongoDB\Driver\Exception\ExecutionTimeoutException - - MongoDB\Driver\Exception\WriteException (dépréciée) - - MongoDB\Driver\Exception\BulkWriteException - - - - - - - -
    - -     diff --git a/reference/mongodb/functions/bson/fromjson.xml b/reference/mongodb/functions/bson/fromjson.xml deleted file mode 100644 index d7578fe697..0000000000 --- a/reference/mongodb/functions/bson/fromjson.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - MongoDB\BSON\fromJSON - Retourne la représentation BSON d'une valeur JSON - - - - - - Cette fonction a été DÉPRÉCIÉE depuis la version 1.20.0 de l'extension - et a été supprimée dans la version 2.0. Les applications devraient utiliser - MongoDB\BSON\Document::fromJSON à la place. - - - - - - &reftitle.description; - - stringMongoDB\BSON\fromJSON - stringjson - - - Convertit une chaîne - JSON étendu - en sa représentation BSON. - - - - - &reftitle.parameters; - - - json (string) - - - Valeur JSON à convertir. - - - - - - - - &reftitle.returnvalues; - - Le document sérialisé BSON en tant que chaîne binaire. - - - - - &reftitle.errors; - - - Lève une exception - MongoDB\Driver\Exception\UnexpectedValueException si - la valeur JSON ne peut pas être convertie en BSON (par exemple en raison - d'une erreur de syntaxe). - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\fromJSON</function> - - -]]> - - &example.outputs; - - - object(MongoDB\BSON\ObjectId)#1 (1) { - ["oid"]=> - string(24) "563143b280d2387c91807965" - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - MongoDB\BSON\toJSON - MongoDB JSON étendu - MongoDB BSON - - - - - - diff --git a/reference/mongodb/functions/bson/fromphp.xml b/reference/mongodb/functions/bson/fromphp.xml deleted file mode 100644 index 3f304a0c70..0000000000 --- a/reference/mongodb/functions/bson/fromphp.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - MongoDB\BSON\fromPHP - Retourne la représentation BSON d'une valeur PHP - - - - - - Cette fonction a été DÉPRÉCIÉE depuis la version 1.20.0 de l'extension - et a été supprimée dans la version 2.0. Les applications devraient utiliser - MongoDB\BSON\Document::fromPHP à la place. - - - - - - &reftitle.description; - - stringMongoDB\BSON\fromPHP - arrayobjectvalue - - - Sérialise un tableau ou objet PHP (par exemple document) en sa - représentation BSON. - La chaîne binaire retournée décrira un document BSON. - - - - - &reftitle.parameters; - - - value (arrayobject) - - - La valeur PHP à sérialiser. - - - - - - - - &reftitle.returnvalues; - - Le document BSON sérialisé en tant que chaîne binaire. - - - - - &reftitle.errors; - - - Lance - MongoDB\Driver\Exception\UnexpectedValueException si - la valeur PHP ne peut pas être convertie en BSON. Les raisons possibles incluent, - mais sans s'y limiter à, rencontrer une instance inattendue de - MongoDB\BSON\Type ou - MongoDB\BSON\Serializable::bsonSerialize échouant à - retourner un &array; ou une stdClass. - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\fromPHP</function> - - 1]); -echo bin2hex($bson), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromPHP - MongoDB\BSON\toPHP - MongoDB BSON - - - - - - - diff --git a/reference/mongodb/functions/bson/tocanonicalextendedjson.xml b/reference/mongodb/functions/bson/tocanonicalextendedjson.xml deleted file mode 100644 index 276fe97d23..0000000000 --- a/reference/mongodb/functions/bson/tocanonicalextendedjson.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - MongoDB\BSON\toCanonicalExtendedJSON - Renvoie la représentation JSON étendue canonique d'une valeur BSON - - - - - - Cette fonction a été DÉPRÉCIÉE depuis la version 1.20.0 de l'extension - et a été supprimée dans la version 2.0. Les applications devraient utiliser - MongoDB\BSON\Document::toCanonicalExtendedJSON à la place. - - - - - - &reftitle.description; - - stringMongoDB\BSON\toCanonicalExtendedJSON - stringbson - - - Convertit une chaîne BSON en sa - représentation JSON étendue canonique. - Le format canonique privilégie la fidélité des types au détriment de la - concision de la sortie et est le plus adapté pour produire une sortie qui - peut être convertie en BSON sans perte d'informations de type (par exemple, - les types numériques resteront différenciés). - - - - - &reftitle.parameters; - - - bson (string) - - - Le BSON à convertir. - - - - - - - - &reftitle.returnvalues; - - Le JSON converti. - - - - - &reftitle.errors; - - &mongodb.throws.bson.unexpected; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\BSON\toCanonicalExtendedJSON</function> - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0, ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\fromPHP($document); - echo MongoDB\BSON\toCanonicalExtendedJSON($bson), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - MongoDB\BSON\Document::toCanonicalExtendedJSON - MongoDB\BSON\fromJSON - MongoDB\BSON\toRelaxedExtendedJSON - Spécification de JSON étendu - MongoDB BSON - - - - - - diff --git a/reference/mongodb/functions/bson/tojson.xml b/reference/mongodb/functions/bson/tojson.xml deleted file mode 100644 index b5b90e6897..0000000000 --- a/reference/mongodb/functions/bson/tojson.xml +++ /dev/null @@ -1,206 +0,0 @@ - - - - - - - MongoDB\BSON\toJSON - Retourne la représentation JSON étendue héritée d'une valeur BSON - - - - - - Cette fonction a été DÉPRÉCIÉE depuis la version 1.20.0 de l'extension - et a été supprimée dans la version 2.0. Les applications devraient utiliser - MongoDB\BSON\Document::toCanonicalExtendedJSON ou - MongoDB\BSON\Document::toRelaxedExtendedJSON à la place. - - - - - - - &reftitle.description; - - stringMongoDB\BSON\toJSON - stringbson - - - Convertit une chaîne BSON en sa représentation JSON étendue héritée. - - - - Il existe plusieurs formats JSON pour représenter BSON. Cette fonction - implémente le "strict mode" défini dans - MongoDB Extended JSON, - qui a été remplacé par les formats canoniques et étendues définis dans la - spécification JSON étendue - et implémenté par MongoDB\BSON\toCanonicalExtendedJSON - et MongoDB\BSON\toRelaxedExtendedJSON, respectivement. - - - - - JSON ne prend pas en charge - NAN et - INF et le - format JSON étendu de MongoDB ne définit pas une autre représentation pour - ces valeurs (libbson va - produire nan et inf littéralement, - qui ne peuvent pas être analysés comme JSON valide). Si on travaille avec - BSON qui peut contenir des nombres non finis, utiliser svp - MongoDB\BSON\toCanonicalExtendedJSON ou - MongoDB\BSON\toRelaxedExtendedJSON. - - - - - - &reftitle.parameters; - - - bson (string) - - - Valeur BSON à convertir. - - - - - - - - &reftitle.returnvalues; - - La valeur JSON convertie. - - - - - &reftitle.errors; - - &mongodb.throws.bson.unexpected; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\BSON\toJSON</function> - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0, ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\fromPHP($document); - echo MongoDB\BSON\toJSON($bson), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\fromJSON - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Etendu - MongoDB BSON - - - - - - diff --git a/reference/mongodb/functions/bson/tophp.xml b/reference/mongodb/functions/bson/tophp.xml deleted file mode 100644 index e0aed16e38..0000000000 --- a/reference/mongodb/functions/bson/tophp.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - MongoDB\BSON\toPHP - Renvoie la représentation PHP d'une valeur BSON - - - - - - Cette fonction a été DÉPRÉCIÉE depuis la version 1.20.0 de l'extension - et a été supprimée dans la version 2.0. Les applications devraient utiliser - MongoDB\BSON\Document::toPHP à la place. - - - - - - - &reftitle.description; - - arrayobjectMongoDB\BSON\toPHP - stringbson - arraytypeMaparray() - - - Désérialise un document BSON (c'est-à-dire une chaîne binaire) en sa représentation PHP. - Le paramètre typeMap peut être utilisé pour contrôler les types PHP utilisés - pour convertir les tableaux et documents BSON (à la fois racine et intégrés). - - &mongodb.warning.duplicate-keys; - - - - &reftitle.parameters; - - - bson (string) - - - La valeur BSON à désérialiser. - - - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - La valeur PHP non sérialisée. - - - - - &reftitle.errors; - - - Lance une - MongoDB\Driver\Exception\InvalidArgumentException si - une classe dans la table de types ne peut pas être instanciée ou n'implémente pas - MongoDB\BSON\Unserializable. - - &mongodb.throws.bson.unexpected; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - PECL mongodb 1.4.0 - - - Si l'entrée contient un type BSON non pris en charge ou obsolète, l'extension - ne générera plus un avertissement dans le journal de débogage, mais créera - plutôt un objet représentant ce type. - - - - - PECL mongodb 1.3.2 - - - MongoDB\Driver\Exception\UnexpectedValueException - ne lance plus d'exception si l'entrée contient un type BSON non pris en charge - ou obsolète. Ces types seront ignorés (comme ils l'étaient dans les versions - antérieures à 1.3.0), bien que l'extension écrira désormais un avertissement - dans le journal de débogage (voir : mongodb.debug). - - - - - PECL mongodb 1.3.0 - - - MongoDB\Driver\Exception\UnexpectedValueException - est lancée si l'entrée contient un type BSON non pris en charge ou obsolète. - Auparavant, de tels types étaient ignorés. - - - - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\BSON\toPHP</function> - - -]]> - - &example.outputs; - - - int(1) -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::toPHP - MongoDB\BSON\fromPHP - MongoDB BSON - - - - - - - diff --git a/reference/mongodb/functions/bson/torelaxedextendedjson.xml b/reference/mongodb/functions/bson/torelaxedextendedjson.xml deleted file mode 100644 index da23ece7e5..0000000000 --- a/reference/mongodb/functions/bson/torelaxedextendedjson.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - MongoDB\BSON\toRelaxedExtendedJSON - Renvoie la représentation JSON étendue détendue d'une valeur BSON - - - - - - Cette fonction a été DÉPRÉCIÉE depuis la version 1.20.0 de l'extension - et a été supprimée dans la version 2.0. Les applications devraient utiliser - MongoDB\BSON\Document::toRelaxedExtendedJSON à la place. - - - - - - &reftitle.description; - - stringMongoDB\BSON\toRelaxedExtendedJSON - stringbson - - - Convertit une chaîne BSON en sa représentation - JSON étendue détendue. - Le format détendu privilégie l'utilisation des types primitifs JSON - au détriment de la fidélité des types et est le plus adapté pour produire une sortie qui peut - être facilement consommée par des API web et des humains. - - - - - &reftitle.parameters; - - - bson (string) - - - La chaîne BSON à convertir. - - - - - - - - &reftitle.returnvalues; - - La valeur JSON convertie. - - - - - &reftitle.errors; - - &mongodb.throws.bson.unexpected; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\BSON\toRelaxedExtendedJSON</function> - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0, ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\fromPHP($document); - echo MongoDB\BSON\toRelaxedExtendedJSON($bson), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - MongoDB\BSON\Document::toRelaxedExtendedJSON - MongoDB\BSON\fromJSON - MongoDB\BSON\toCanonicalExtendedJSON - JSON étendu - MongoDB BSON - - - - - - diff --git a/reference/mongodb/functions/driver/monitoring/addsubscriber.xml b/reference/mongodb/functions/driver/monitoring/addsubscriber.xml deleted file mode 100644 index 86a8f94732..0000000000 --- a/reference/mongodb/functions/driver/monitoring/addsubscriber.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - MongoDB\Driver\Monitoring\addSubscriber - Enregistre un abonnement de surveillance d'événement - - - - &reftitle.description; - - voidMongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Monitoring\Subscribersubscriber - - - Enregistre un abonnement de surveillance d'événement global. - Les abonnés seront notifiés de tous les événements dans l'extension - pour tout type de Manager. - - - - Si subscriber est déjà enregistré globalement, cette - fonction est un no-op. Si subscriber est aussi - enregistré pour un ou plusieurs Managers, ils seront toujours notifiés qu'une - seule fois par événement pour chaque Manager. - - - - - - &reftitle.parameters; - - - subscriber (MongoDB\Driver\Monitoring\Subscriber) - - - Un objet d'abonnement de surveillance d'événement à enregistrer globalement. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\removeSubscriber - MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - - diff --git a/reference/mongodb/functions/driver/monitoring/removesubscriber.xml b/reference/mongodb/functions/driver/monitoring/removesubscriber.xml deleted file mode 100644 index a41ed29ef6..0000000000 --- a/reference/mongodb/functions/driver/monitoring/removesubscriber.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - MongoDB\Driver\Monitoring\removeSubscriber - Retire un abonnement de surveillance d'événement global - - - - &reftitle.description; - - voidMongoDB\Driver\Monitoring\removeSubscriber - MongoDB\Driver\Monitoring\Subscribersubscriber - - - Retire un abonnement de surveillance d'événement global. - - - - Si subscriber n'est pas déjà enregistré globalement, - cette fonction est un no-op. - - - - - - &reftitle.parameters; - - - subscriber (MongoDB\Driver\Monitoring\Subscriber) - - - Un abonnement de surveillance d'événement à retirer globalement. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Manager::removeSubscriber - - - - - - diff --git a/reference/mongodb/ini.xml b/reference/mongodb/ini.xml deleted file mode 100644 index 6a7e7c13a1..0000000000 --- a/reference/mongodb/ini.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; de mongodb - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mongodb.debug - "" - INI_ALL - - - - -
    -     - - &ini.descriptions.title; - - - - - - mongodb.debug - string - - - - Cette option peut être utilisée pour activer ou désactiver le journal de débogage de niveau trace - dans l'extension (et libmongoc). - - - Spécifier une chaîne vide, "0", - "off", "no", ou - "false" pour désactiver le journal. - - - Spécifier "stderr" ou "stdout" pour journaliser - vers stderr ou stdout, respectivement. - - - Spécifier "1", "on", - "yes", ou "true" pour journaliser dans un nouveau - fichier temporaire dans le répertoire temporaire système par défaut (c'est-à-dire - sys_get_temp_dir). - - - Spécifier une autre chaîne pour journaliser dans un nouveau fichier temporaire dans ce - répertoire. Si le répertoire ne peut pas être utilisé, le répertoire temporaire système par défaut - sera utilisé à la place. - - - - Il est à noter que le journal de débogage peut contenir des informations sensibles, - telles que les informations d'identification du serveur MongoDB et les documents complets - écrits ou lus à partir du serveur. Il est recommandé de vérifier tout journal de débogage avant de le partager - avec d'autres personnes. - - - - - - -
    - - diff --git a/reference/mongodb/mongodb.xml b/reference/mongodb/mongodb.xml deleted file mode 100644 index 51814bc2fe..0000000000 --- a/reference/mongodb/mongodb.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - Classes de l'extension MongoDB - MongoDB\Driver - - &reference.mongodb.mongodb.driver.manager; - &reference.mongodb.mongodb.driver.command; - &reference.mongodb.mongodb.driver.query; - &reference.mongodb.mongodb.driver.bulkwrite; - &reference.mongodb.mongodb.driver.bulkwritecommand; - &reference.mongodb.mongodb.driver.session; - &reference.mongodb.mongodb.driver.clientencryption; - &reference.mongodb.mongodb.driver.serverapi; - - &reference.mongodb.mongodb.driver.writeconcern; - &reference.mongodb.mongodb.driver.readpreference; - &reference.mongodb.mongodb.driver.readconcern; - - &reference.mongodb.mongodb.driver.cursor; - &reference.mongodb.mongodb.driver.cursorid; - &reference.mongodb.mongodb.driver.cursorinterface; - - &reference.mongodb.mongodb.driver.server; - &reference.mongodb.mongodb.driver.serverdescription; - &reference.mongodb.mongodb.driver.topologydescription; - - &reference.mongodb.mongodb.driver.writeconcernerror; - &reference.mongodb.mongodb.driver.writeerror; - &reference.mongodb.mongodb.driver.writeresult; - &reference.mongodb.mongodb.driver.bulkwritecommandresult; - diff --git a/reference/mongodb/mongodb/driver/bulkwrite.xml b/reference/mongodb/mongodb/driver/bulkwrite.xml deleted file mode 100644 index 84ee618cf1..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - La classe MongoDB\Driver\BulkWrite - MongoDB\Driver\BulkWrite - - - - -
    - &reftitle.intro; - - Le MongoDB\Driver\BulkWrite collecte une ou plusieurs - opérations d'écriture qui devraient être envoyées au serveur. Après avoir ajouté - un nombre quelconque d'opérations d'insertion, de mise à jour et de suppression, - la collection peut être exécutée via - MongoDB\Driver\Manager::executeBulkWrite. - - - Les opérations d'écriture peuvent être ordonnées (par défaut) ou non ordonnées. - Les opérations d'écriture ordonnées sont envoyées au serveur, dans l'ordre - fourni, pour une exécution sérielle. Si une écriture échoue, toutes les - opérations restantes seront annulées. Les opérations non ordonnées sont envoyées - au serveur dans un ordre arbitraire où elles peuvent être exécutées en parallèle. - Toutes les erreurs qui se produisent sont signalées après que toutes les - opérations ont été tentées. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\BulkWrite - - - - final - - MongoDB\Driver\BulkWrite - - - - Countable - - - - - &Methods; - - - - -
    - -
    - &reftitle.examples; - - - Opérations d'écriture mixtes regroupées par type - - Les opérations d'écriture mixtes (c'est-à-dire les insertions, les mises à - jour et les suppressions) seront assemblées en commandes d'écriture typées - à envoyer séquentiellement au serveur. - - - true]); -$bulk->insert(['_id' => 1, 'x' => 1]); -$bulk->insert(['_id' => 2, 'x' => 2]); -$bulk->update(['x' => 2], ['$set' => ['x' => 1]]); -$bulk->insert(['_id' => 3, 'x' => 3]); -$bulk->delete(['x' => 1]); - -?> -]]> - - - Résulte en quatre commandes d'écriture (c'est-à-dire des allers-retours) - exécutées. Puisque les opérations sont ordonnées, la troisième insertion ne peut pas être envoyée - avant que la mise à jour précédente ne soit exécutée. - - - - Opérations d'écriture ordonnées causant une erreur - - true]); -$bulk->delete([]); -$bulk->insert(['_id' => 1]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 3, 'hello' => 'world']); -$bulk->update(['_id' => 3], ['$set' => ['hello' => 'earth']]); -$bulk->insert(['_id' => 4, 'hello' => 'pluto']); -$bulk->update(['_id' => 4], ['$set' => ['hello' => 'moon']]); -$bulk->insert(['_id' => 3]); -$bulk->insert(['_id' => 4]); -$bulk->insert(['_id' => 5]); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$writeConcern = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, 1000); - -try { - $result = $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - $result = $e->getWriteResult(); - - // Vérifie si l'écriture n'a pas pu être satisfaite - if ($writeConcernError = $result->getWriteConcernError()) { - printf("%s (%d): %s\n", - $writeConcernError->getMessage(), - $writeConcernError->getCode(), - var_export($writeConcernError->getInfo(), true) - ); - } - - // Vérifie si une opération d'écriture n'a pas pu être complétée - foreach ($result->getWriteErrors() as $writeError) { - printf("Operation#%d: %s (%d)\n", - $writeError->getIndex(), - $writeError->getMessage(), - $writeError->getCode() - ); - } -} catch (MongoDB\Driver\Exception\Exception $e) { - printf("Other error: %s\n", $e->getMessage()); - exit; -} - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); -printf("Updated %d document(s)\n", $result->getModifiedCount()); - -?> -]]> - - - &example.outputs; - - - - - Si le write concern ne peut pas être satisfait, l'exemple ci-dessus affichera - quelque chose comme: - - - true, -) -Operation#7: E11000 duplicate key error index: databaseName.collectionName.$_id_ dup key: { : 3 } (11000) -Inserted 4 document(s) -Updated 2 document(s) -]]> - - - Si on exécute l'exemple ci-dessus, mais qu'on permet des écritures non ordonnées: - - - false]); -/* ... */ - -?> -]]> - - &example.outputs; - - - -
    - -
    - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcernError - MongoDB\Driver\WriteError - -
    - -     - - &reference.mongodb.mongodb.driver.entities.bulkwrite; - -     - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/construct.xml b/reference/mongodb/mongodb/driver/bulkwrite/construct.xml deleted file mode 100644 index 0dc6b2f776..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/construct.xml +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::__construct - Créer un nouveau BulkWrite - - - - &reftitle.description; - - public MongoDB\Driver\BulkWrite::__construct - arraynulloptions&null; - - - Construit un nouveau MongoDB\Driver\BulkWrite, qui est un - objet mutable auquel une ou plusieurs opérations d'écriture peuvent être ajoutées. Les - écritures peuvent ensuite être exécutées avec - MongoDB\Driver\Manager::executeBulkWrite. - - - - - &reftitle.parameters; - - - options (array) - - - - options - - - - Option - Type - Description - Défaut - - - - - bypassDocumentValidation - bool - - - Si &true;, permet aux opérations d'insertion et de mise à jour de - contourner la validation au niveau du document. - - - Cette option est disponible dans MongoDB 3.2+ et est ignorée pour les - anciennes versions du serveur, qui ne prennent pas en charge la validation au niveau du document. - - - &false; - - - comment - mixed - - - Un commentaire arbitraire pour aider à tracer l'opération à travers le - profil du serveur de base de données, la sortie currentOp et les journaux. - - - Cette option est disponible dans MongoDB 4.4+ et entraînera une - exception au moment de l'exécution si elle est spécifiée pour une version de serveur plus ancienne. - - - - &mongodb.option.let; - - ordered - bool - - Les opérations ordonnées (&true;) sont exécutées séquentiellement sur le serveur MongoDB, - tandis que les opérations non ordonnées (&false;) sont envoyées au serveur - dans un ordre arbitraire et peuvent être exécutées en parallèle. - - &true; - - - -
    -     -     -     -     -     - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.14.0 - - Ajout des options "comment" et "let". - - - - PECL mongodb 1.1.0 - - Ajout de l'option "bypassDocumentValidation". - - - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWrite::__construct</function> - - true]); -$bulk->delete([]); -$bulk->insert(['_id' => 1, 'x' => 1]); -$bulk->insert(['_id' => 2, 'x' => 2]); -$bulk->update( - ['x' => 2], - ['$set' => ['x' => 1]], - ['limit' => 1, 'upsert' => false] -); -$bulk->delete(['x' => 1], ['limit' => 1]); -$bulk->update( - ['_id' => 3], - ['$set' => ['x' => 3]], - ['limit' => 1, 'upsert' => true] -); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$writeConcern = new MongoDB\Driver\WriteConcern(1); - -try { - $result = $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - $result = $e->getWriteResult(); - - // Vérifie si l'écriture n'a pas pu être effectuée - if ($writeConcernError = $result->getWriteConcernError()) { - printf("%s (%d): %s\n", - $writeConcernError->getMessage(), - $writeConcernError->getCode(), - var_export($writeConcernError->getInfo(), true) - ); - } - - // Vérifie si certaines opérations d'écriture n'ont pas été effectuées du tout - foreach ($result->getWriteErrors() as $writeError) { - printf("Operation#%d: %s (%d)\n", - $writeError->getIndex(), - $writeError->getMessage(), - $writeError->getCode() - ); - } -} catch (MongoDB\Driver\Exception\Exception $e) { - printf("Other error: %s\n", $e->getMessage()); - exit; -} - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); -printf("Updated %d document(s)\n", $result->getModifiedCount()); -printf("Upserted %d document(s)\n", $result->getUpsertedCount()); -printf("Deleted %d document(s)\n", $result->getDeletedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - - - -     - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/count.xml b/reference/mongodb/mongodb/driver/bulkwrite/count.xml deleted file mode 100644 index d61044713e..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/count.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::count - Compte le nombre d'opérations d'écriture dans le lot - - - - &reftitle.description; - - public intMongoDB\Driver\BulkWrite::count - - - - Renvoie le nombre d'opérations d'écriture ajoutées à l'objet - MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nombre d'opérations d'écriture ajoutées à l'objet - MongoDB\Driver\BulkWrite. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.2.0 - - Renvoie le nombre d'opérations d'écriture ajoutées à l'objet - MongoDB\Driver\BulkWrite. Les versions antérieures - renvoyaient le nombre d'aller-retours client-serveur nécessaires pour exécuter - toutes les opérations d'écriture. - - - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWrite::count</function> - -insert(['_id' => 1, 'x' => 1]); -$bulk->insert(['_id' => 2, 'x' => 2]); -$bulk->update(['x' => 2], ['$set' => ['x' => 1]]); -$bulk->delete(['x' => 1]); - -var_dump(count($bulk)); - -?> -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/delete.xml b/reference/mongodb/mongodb/driver/bulkwrite/delete.xml deleted file mode 100644 index 81dc12248a..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/delete.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::delete - Ajoute une opération de suppression au lot - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWrite::delete - arrayobjectfilter - arraynulldeleteOptions&null; - - - Ajoute une opération de suppression au - MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - - &mongodb.parameter.filter; - - deleteOptions - - - - deleteOptions - - - - Option - Type - Description - Défaut - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Spécification d'index. Spécifiez soit le nom de l'index en tant que chaîne - soit le modèle de clé d'index. Si spécifié, le système de requête - ne considérera que les plans utilisant l'index suggéré. - - - Cette option est disponible dans MongoDB 4.4+ et entraînera une - exception au moment de l'exécution si elle est spécifiée pour une version de serveur - plus ancienne. - - - - - limit - bool - Supprime tous les documents correspondants (&false;), ou seulement le premier document correspondant (&true;) - &false; - - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.8.0 - - Ajout de l'option "hint". - - - - PECL mongodb 1.2.0 - - Ajout de l'option "collation". - - - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWrite::delete</function> - -delete(['x' => 1], ['limit' => 1]); -$bulk->delete(['x' => 2], ['limit' => 0]); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$result = $manager->executeBulkWrite('db.collection', $bulk); - -?> -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - - - -     - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/insert.xml b/reference/mongodb/mongodb/driver/bulkwrite/insert.xml deleted file mode 100644 index 29e6a9aeae..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/insert.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::insert - Ajoute une opération d'insertion au lot - - - - &reftitle.description; - - public mixedMongoDB\Driver\BulkWrite::insert - arrayobjectdocument - - - Ajoute une opération d'insertion au - MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - - - document (arrayobject) - - - Le document à insérer. - - - - - - - - &reftitle.returnvalues; - - Renvoie l'_id du document inséré. Si le - document n'avait pas d'_id, le - MongoDB\BSON\ObjectId généré pour l'insertion sera - renvoyé. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.3.0 - - L'_id du document inséré est toujours renvoyé. - Auparavant, la méthode ne renvoyait une valeur que si un - MongoDB\BSON\ObjectId était généré. - - - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWrite::insert</function> - - 1]; -$doc2 = ['_id' => 'custom-id', 'x' => 2]; -$doc3 = ['_id' => new MongoDB\BSON\ObjectId('0123456789abcdef01234567'), 'x' => 3]; - -$id1 = $bulk->insert($doc1); -$id2 = $bulk->insert($doc2); -$id3 = $bulk->insert($doc3); - -var_dump($id1, $id2, $id3); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$result = $manager->executeBulkWrite('db.collection', $bulk); - -?> -]]> - - &example.outputs.similar; - - - string(24) "67f58058d1a0aa2fd80d55d0" -} -string(9) "custom-id" -object(MongoDB\BSON\ObjectId)#4 (1) { - ["oid"]=> - string(24) "0123456789abcdef01234567" -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - MongoDB\BSON\ObjectId - MongoDB\BSON\Persistable - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/update.xml b/reference/mongodb/mongodb/driver/bulkwrite/update.xml deleted file mode 100644 index d0fb04bf76..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/update.xml +++ /dev/null @@ -1,266 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::update - Ajoute une opération de mise à jour au lot - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWrite::update - arrayobjectfilter - arrayobjectnewObj - arraynullupdateOptions&null; - - - Ajoute une opération de mise à jour au - MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - - &mongodb.parameter.filter; - - newObj (arrayobject) - - - Un document contenant des opérateurs de mise à jour (par exemple - $set), un document de remplacement (c'est-à-dire - seulement des expressions field:valeur), ou - une pipeline d'agrégation. - - - - - updateOptions - - - - updateOptions - - - - Option - Type - Description - Défaut - - - - - arrayFilters - array - - - Un tableau de documents de filtre qui détermine quels éléments de tableau - à modifier pour une opération de mise à jour sur un champ de tableau. Voir - Spécifier des arrayFilters pour les opérations de mise à jour de tableau - dans le manuel MongoDB pour plus d'informations. - - - Cette option est disponible dans MongoDB 3.6+ et entraînera une - exception au moment de l'exécution si elle est spécifiée pour une version de serveur - plus ancienne. - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Spécification d'index. Spécifiez soit le nom de l'index en tant que chaîne - soit le modèle de clé d'index. Si spécifié, le système de requête - ne considérera que les plans utilisant l'index suggéré. - - - Cette option est disponible dans MongoDB 4.2+ et entraînera une - exception au moment de l'exécution si elle est spécifiée pour une version de serveur - plus ancienne. - - - - - multi - bool - - Met à jour uniquement le premier document correspondant si &false;, ou tous - les documents correspondants si &true;. Cette option ne peut pas être &true; si - newObj est un document de remplacement. - - &false; - - - sort - arrayobject - - - Spécifie quel document l'opération met à jour si la requête correspond - à plusieurs documents. Le premier document correspondant par l'ordre de tri - sera mis à jour. - - - Cette option ne peut pas être utilisée si "multi" est &true;. - - - Cette option est disponible dans MongoDB 8.0+ et entraînera une - exception au moment de l'exécution si elle est spécifiée pour une version de serveur - plus ancienne. - - - - - upsert - bool - - Si filter ne correspond pas à un document existant, - insère un unique document. Le document sera - créé à partir de newObj s'il s'agit d'un document de remplacement - (c'est-à-dire aucun opérateurs de mise à jour); sinon, les opérateurs dans - newObj seront appliqués à - filter pour créer le nouveau document. - - &false; - - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.21.0 - - Ajout de l'option "sort". - - - - PECL mongodb 1.7.0 - - Ajout de l'option "hint". - - - - PECL mongodb 1.6.0 - - Le paramètre newObj accepte désormais un pipeline - d'agrégation. Cette fonctionnalité nécessite MongoDB 4.2+ et entraînera une - exception au moment de l'exécution si elle est spécifiée pour une version de serveur - plus ancienne. - - - - PECL mongodb 1.5.0 - - Utiliser l'option "arrayFilters" entraînera une exception - au moment de l'exécution si elle n'est pas prise en charge par le serveur. - Auparavant, aucune exception n'était levée et l'option pouvait être ignorée. - - - - PECL mongodb 1.4.0 - - Ajout de l'option "arrayFilters". - - - - PECL mongodb 1.2.0 - - Ajout de l'option "collation". - - - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWrite::update</function> - -update( - ['x' => 2], - ['$set' => ['y' => 3]], - ['multi' => false, 'upsert' => false] -); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$result = $manager->executeBulkWrite('db.collection', $bulk); - -?> -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - - - -     - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand.xml b/reference/mongodb/mongodb/driver/bulkwritecommand.xml deleted file mode 100644 index b8903e56c8..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand.xml +++ /dev/null @@ -1,203 +0,0 @@ - - - - - - - La classe MongoDB\Driver\BulkWriteCommand - MongoDB\Driver\BulkWriteCommand - - - - -
    - &reftitle.intro; - - MongoDB\Driver\BulkWriteCommand récupère une ou plusieurs - opérations d'écriture qui doivent être envoyées au serveur à l'aide de la commande - bulkWrite - introduite dans MongoDB 8.0. Après avoir ajouté un nombre quelconque d'opérations d'écriture, - d'opérations de modification et d'opérations de suppression, la commande peut être exécutée via - MongoDB\Driver\Manager::executeBulkWriteCommand. - - - Contrairement à MongoDB\Driver\BulkWrite, où toutes les opérations - d'écriture doivent cibler la même collection, chaque opération d'écriture dans - MongoDB\Driver\BulkWriteCommand peut cibler une - collection différente. - - - Les opérations d'écriture peuvent être triées (par défaut) ou non triées. Les opérations - triées sont envoyées au serveur, dans l'ordre fourni, pour une exécution - sérielle. Si une écriture échoue, toutes les opérations restantes seront annulées. - Les opérations non triées sont envoyées au serveur dans un ordre arbitraire - où elles peuvent être exécutées en parallèle. Toutes les erreurs qui se produisent - sont signalées après que toutes les opérations ont été tentées. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\BulkWriteCommand - - - - final - - MongoDB\Driver\BulkWriteCommand - - - - Countable - - - - - &Methods; - - - - -
    - -
    - &reftitle.examples; - - - Opérations d'écriture mixtes - - Les opérations d'écriture mixtes (par exemple, insertions, mises à jour et suppressions) seront envoyées - au serveur à l'aide d'une seule - commande - bulkWrite. - - -deleteMany('db.coll_one', []); -$bulk->deleteMany('db.coll_two', []); - -// Insert documents into two collections -$bulk->insertOne('db.coll_one', ['_id' => 1]); -$bulk->insertOne('db.coll_two', ['_id' => 2]); -$bulk->insertOne('db.coll_two', ['_id' => 3]); - -// Update a document in "coll_one" -$bulk->updateOne('db.coll_one', ['_id' => 1], ['$set' => ['x' => 1]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -printf("%d document(s) ont été inséré(s)\n", $result->getInsertedCount()); -printf("%d document(s) ont été mis à jour(s)\n", $result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - Opérations d'écriture ordonnées causant une erreur - -deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 2]); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 3]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - $result = $e->getPartialResult(); - - var_dump($e->getWriteErrors()); -} - -printf("%d document(s) ont été inséré(s)\n", $result->getInsertedCount()); - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(78) "E11000 duplicate key error collection: db.coll index: _id_ dup key: { _id: 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(3) - ["info"]=> - object(stdClass)#6 (0) { - } - } -} -2 document(s) ont été inséré(s) -]]> - - -
    - -
    - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\Exception\BulkWriteCommandException - MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcernError - MongoDB\Driver\WriteError - -
    - -     - - &reference.mongodb.mongodb.driver.entities.bulkwritecommand; - -     - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/construct.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/construct.xml deleted file mode 100644 index 18506ca2b1..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/construct.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommand::__construct - Créer une nouvelle BulkWriteCommand - - - - &reftitle.description; - - public MongoDB\Driver\BulkWriteCommand::__construct - arraynulloptions&null; - - - Construit une nouvelle MongoDB\Driver\BulkWriteCommand, - qui peut être utilisée pour effectuer de nombreuses opérations d'insertions, de mises à jour et de suppressions - sur plusieurs collections dans une seule requête à l'aide de la commande - bulkWrite - introduite dans MongoDB 8.0. Cela diffère de - MongoDB\Driver\BulkWrite, qui est supporté par toutes - les versions du serveur mais limité à une seule collection. - - - Après que toutes les opérations d'écriture ont été ajoutées, cet objet peut être exécuté avec - MongoDB\Driver\Manager::executeBulkWriteCommand. - - - - - &reftitle.parameters; - - - options (array) - - - - options - - - - Option - Type - Description - Défaut - - - - - bypassDocumentValidation - bool - - - Si &true;, permet aux opérations d'insertion et de mise à jour de contourner - la validation au niveau du document. - - - &false; - - - comment - mixed - - - Un commentaire arbitraire pour aider à tracer l'opération à travers le - profileur de base de données, la sortie currentOp et les journaux. - - - - &mongodb.option.let; - - ordered - bool - - - Si les opérations dans cette écriture groupée doivent être exécutées dans - l'ordre dans lequel elles ont été spécifiées. Si &false;, les écritures - continueront à être exécutées si une écriture individuelle échoue. Si &true;, - les écritures s'arrêteront si une écriture individuelle échoue. - - - &true; - - - verboseResults - bool - - - Si les détails des résultats de chaque opération réussie doivent être - inclus dans le résultat dans la - MongoDB\Driver\BulkWriteCommandResult retournée. - - - &false; - - - -
    -     -     -     -     -     - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommand::__construct</function> - -deleteMany('db.coll_one', []); -$bulk->deleteMany('db.coll_two', []); - -// Ajoute les documents de deux collections -$bulk->insertOne('db.coll_one', ['_id' => 1]); -$bulk->insertOne('db.coll_two', ['_id' => 2]); -$bulk->insertOne('db.coll_two', ['_id' => 3]); - -// Modifie un document dans "coll_one" -$bulk->updateOne('db.coll_one', ['_id' => 1], ['$set' => ['x' => 1]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -printf("%d document(s) ont été inséré(s)\n", $result->getInsertedCount()); -printf("%d document(s) ont été mis à jour(s)\n", $result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -     - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/count.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/count.xml deleted file mode 100644 index acab31aad5..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/count.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommand::count - Compte le nombre d'opérations d'écriture dans la BulkWriteCommand - - - - &reftitle.description; - - public intMongoDB\Driver\BulkWriteCommand::count - - - - Renvoie le nombre d'opérations d'écriture ajoutées à - l'objet MongoDB\Driver\BulkWriteCommand. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nombre d'opérations d'écriture ajoutées à - l'objet MongoDB\Driver\BulkWriteCommand. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommand::count</function> - -insertOne('db.coll', ['_id' => 1, 'x' => 1]); -$bulk->insertOne('db.coll', ['_id' => 2, 'x' => 2]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['x' => 1]]); -$bulk->deleteMany('db.coll', ['x' => 1]); - -var_dump(count($bulk)); - -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/deletemany.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/deletemany.xml deleted file mode 100644 index 18a3c05add..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/deletemany.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommand::deleteMany - Ajoute une opération deleteMany - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::deleteMany - stringnamespace - arrayobjectfilter - arraynulloptions&null; - - - Ajoute une opération deleteMany à la - MongoDB\Driver\BulkWriteCommand. Tous les documents - qui correspondent à filter dans la collection identifiée par - namespace seront supprimés. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - options - - - - options - - - - Option - Type - Description - Défaut - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Spécification de l'index. Spécifiez soit le nom de l'index sous forme de chaîne - ou le modèle de clé de l'index. Si spécifié, le système de requête ne - considérera que les plans utilisant l'index suggéré. - - - - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommand::deleteMany</function> - -deleteMany('db.coll', ['x' => ['$gt' => 1]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::deleteOne - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -     - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/deleteone.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/deleteone.xml deleted file mode 100644 index aff937ba3e..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/deleteone.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommand::deleteOne - Ajoute une opération deleteOne - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::deleteOne - stringnamespace - arrayobjectfilter - arraynulloptions&null; - - - Ajoute une opération deleteOne à la - MongoDB\Driver\BulkWriteCommand. Le premier document - qui correspond à filter dans la collection identifiée par - namespace sera supprimé. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - options - - - - options - - - - Option - Type - Description - Défaut - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Spécification de l'index. Spécifiez soit le nom de l'index sous forme de chaîne - ou le modèle de clé de l'index. Si spécifié, le système de requête ne - considérera que les plans utilisant l'index suggéré. - - - - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommand::deleteOne</function> - -deleteOne('db.coll', ['x' => 1]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::deleteMany - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -     - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/insertone.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/insertone.xml deleted file mode 100644 index 57930ef3ad..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/insertone.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommand::insertOne - Ajoute une opération insertOne - - - - &reftitle.description; - - public mixedMongoDB\Driver\BulkWriteCommand::insertOne - stringnamespace - arrayobjectdocument - - - Ajoute une opération insertOne à la - MongoDB\Driver\BulkWriteCommand. Le document sera - inséré dans la collection identifiée par - namespace. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - - document (arrayobject) - - - Le document à insérer. - - - - - - - - &reftitle.returnvalues; - - Retourne le _id du document inséré. Si le - document n'avait pas de _id, le - MongoDB\BSON\ObjectId généré pour l'insertion sera - retourné. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommand::insertOne</function> - - 1]; -$doc2 = ['_id' => 'custom-id', 'x' => 2]; -$doc3 = ['_id' => new MongoDB\BSON\ObjectId('0123456789abcdef01234567'), 'x' => 3]; - -$id1 = $bulk->insertOne('db.coll', $doc1); -$id2 = $bulk->insertOne('db.coll', $doc2); -$id3 = $bulk->insertOne('db.coll', $doc3); - -var_dump($id1, $id2, $id3); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - &example.outputs.similar; - - - string(24) "67f58058d1a0aa2fd80d55d0" -} -string(9) "custom-id" -object(MongoDB\BSON\ObjectId)#4 (1) { - ["oid"]=> - string(24) "0123456789abcdef01234567" -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - MongoDB\BSON\ObjectId - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/replaceone.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/replaceone.xml deleted file mode 100644 index 329296ad9d..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/replaceone.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommand::replaceOne - Ajoute une opération replaceOne - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::replaceOne - stringnamespace - arrayobjectfilter - arrayobjectreplacement - arraynulloptions&null; - - - Ajoute une opération replaceOne à la - MongoDB\Driver\BulkWriteCommand. Le premier document à - correspondre à filter dans la collection identifiée par - namespace sera remplacé. - - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - replacement (arrayobject) - - - Un document de remplacement. - - - - - options - - - - options - - - - Option - Type - Description - Défaut - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Spécification de l'index. Spécifiez soit le nom de l'index sous forme de chaîne - ou le modèle de clé de l'index. Si spécifié, le système de requête ne - considérera que les plans utilisant l'index suggéré. - - - - - sort - arrayobject - - - Spécifier quel document l'opération remplace si la requête correspond à - plusieurs documents. Le premier document correspondant à l'ordre de tri - sera remplacé. - - - - - upsert - bool - - Si filter ne correspond à aucun document, - insère un document unique. Le document sera - créé depuis replacement. - - &false; - - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommand::replaceOne</function> - -replaceOne('db.coll', ['x' => 1], ['x' => 1, 'y' => 2]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::updateOne - MongoDB\Driver\BulkWriteCommand::updateMany - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -     - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/updatemany.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/updatemany.xml deleted file mode 100644 index 5ff39206b2..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/updatemany.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommand::updateMany - Ajoute une opération updateMany - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::updateMany - stringnamespace - arrayobjectfilter - arrayobjectupdate - arraynulloptions&null; - - - Ajoute une opération updateMany à la - MongoDB\Driver\BulkWriteCommand. Tous les documents - correspondant à filter dans la collection identifiée par - namespace seront mis à jour. - - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - update (arrayobject) - - - Un document contenant soit des opérateurs de mise à jour (par exemple - $set) ou une - pipeline d'agrégation. - - - - - options - - - - options - - - - Option - Type - Description - Défaut - - - - - arrayFilters - array - - - Un tableau de documents de filtre qui détermine quels éléments de tableau - à modifier pour une opération de mise à jour sur un champ de tableau. Voir - Spécifier arrayFilters pour les opérations de mise à jour de tableau - dans le manuel MongoDB pour plus d'informations. - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Spécification de l'index. Spécifiez soit le nom de l'index sous forme de chaîne ou - par le modèle de clé de l'index. Si spécifié, le système de requête ne - considérera que les plans utilisant l'index suggéré. - - - - - upsert - bool - - Si filter ne correspond à aucun document existant, - insérer un document unique. Le document sera créé - en appliquant les opérateurs dans update à toutes - les valeurs de champ dans filter. - - &false; - - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommand::updateMany</function> - -updateMany('db.coll', ['x' => ['$gt' => 1]], ['$set' => ['y' => 2]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::replaceOne - MongoDB\Driver\BulkWriteCommand::updateMany - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -     - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/updateone.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/updateone.xml deleted file mode 100644 index 3142927164..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/updateone.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommand::updateOne - Ajoute une opération updateOne - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::updateOne - stringnamespace - arrayobjectfilter - arrayobjectupdate - arraynulloptions&null; - - - Ajoute une opération updateOne à la - MongoDB\Driver\BulkWriteCommand. Le premier document à - correspondre à filter dans la collection identifiée par - namespace sera mis à jour. - - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - update (arrayobject) - - - Un document contenant soit des opérateurs de mise à jour (par exemple - $set) ou une - pipeline d'agrégation. - - - - - options - - - - options - - - - Option - Type - Description - Défaut - - - - - arrayFilters - array - - - Un tableau de documents de filtre qui détermine quels éléments de tableau - doivent être modifiés pour une opération de mise à jour sur un champ de tableau. Voir - Spécifier arrayFilters pour les opérations de mise à jour de tableau - dans la documentation MongoDB pour plus d'informations. - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Spécification de l'index. Spécifiez soit le nom de l'index sous forme de chaîne - ou le modèle de clé de l'index. Si spécifié, le système de requête ne - considérera que les plans utilisant l'index suggéré. - - - - - sort - arrayobject - - - Spécifie quel document l'opération met à jour si la requête correspond à - plusieurs documents. Le premier document correspondant à l'ordre de tri - sera mis à jour. - - - - - upsert - bool - - Si filter ne correspond à aucun document existant, - insérer un document unique. Le document sera créé - en appliquant les opérateurs dans update à toutes - les valeurs de champ dans filter. - - &false; - - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommand::updateOne</function> - -updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 2]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::replaceOne - MongoDB\Driver\BulkWriteCommand::updateMany - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -     - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult.xml deleted file mode 100644 index 3b81e245a8..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - La classe MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\BulkWriteCommandResult - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\BulkWriteCommandResult encapsule - les informations sur une - MongoDB\Driver\BulkWriteCommand exécuté et renvoyé par - MongoDB\Driver\Manager::executeBulkWriteCommand. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\BulkWriteCommandResult - - - - final - - MongoDB\Driver\BulkWriteCommandResult - - - - - &Methods; - - - - -
    - -     - - &reference.mongodb.mongodb.driver.entities.bulkwritecommandresult; - -     - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeletedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeletedcount.xml deleted file mode 100644 index 3c4c7d2b3b..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeletedcount.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommandResult::getDeletedCount - Renvoie le nombre de documents supprimés - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getDeletedCount - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nombre total de documents supprimés par toutes les opérations. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommandResult::getDeletedCount</function> - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getDeletedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getDeleteResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeleteresults.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeleteresults.xml deleted file mode 100644 index bf9ed6bd53..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeleteresults.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommandResult::getDeleteResults - Renvoie les résultats détaillés des suppressions réussies - - - - &reftitle.description; - - final public MongoDB\BSON\DocumentnullMongoDB\Driver\BulkWriteCommandResult::getDeleteResults - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un document contenant les résultats de chaque opération de - suppression réussie, ou &null; si les résultats détaillés n'ont pas été demandés. Les - clés du document correspondront à l'index de l'opération d'écriture de - MongoDB\Driver\BulkWriteCommand. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommandResult::getDeleteResults</function> - - true]); -$bulk->insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getDeleteResults()->toPHP()); - -?> -]]> - - &example.outputs.similar; - - - object(stdClass)#6 (1) { - ["deletedCount"]=> - object(MongoDB\BSON\Int64)#5 (1) { - ["integer"]=> - string(1) "3" - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getDeletedCount - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertedcount.xml deleted file mode 100644 index d2f257dc60..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertedcount.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommandResult::getInsertedCount - Renvoie le nombre de documents insérés - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getInsertedCount - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nombre total de documents insérés (excluant les upserts) par toutes - les opérations. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommandResult::getInsertedCount</function> - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getInsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getInsertResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertresults.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertresults.xml deleted file mode 100644 index 46652049f8..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertresults.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getInsertResults - Renvoie les résultats détaillés des insertions réussies - - - - &reftitle.description; - - final public MongoDB\BSON\DocumentnullMongoDB\Driver\BulkWriteCommandResult::getInsertResults - - - - Depuis que les champs _id des documents insérés sont générés par - l'extension lorsqu'ils ne sont pas explicitement fournis, la valeur de - insertedId dans chaque résultat correspondra à la valeur de retour de - MongoDB\Driver\BulkWriteCommand::insertOne pour - l'opération d'insertion correspondante. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un document contenant les résultats de chaque opération d'insertion - ou &null; si les résultats détaillés n'ont pas été demandés. Les clés - du document correspondront à l'index de l'opération d'écriture de - MongoDB\Driver\BulkWriteCommand. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommandResult::getInsertResults</function> - - true]); - -$generatedId = $bulk->insertOne('db.coll', ['x' => 1]); - -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($generatedId); - -var_dump($result->getInsertResults()->toPHP()); - -?> -]]> - - &example.outputs.similar; - - - string(24) "67f7ee69783dcce702097b41" -} -object(stdClass)#8 (1) { - ["0"]=> - object(stdClass)#7 (1) { - ["insertedId"]=> - object(MongoDB\BSON\ObjectId)#6 (1) { - ["oid"]=> - string(24) "67f7ee69783dcce702097b41" - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getInsertedCount - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - MongoDB\Driver\BulkWriteCommand::insertOne - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmatchedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmatchedcount.xml deleted file mode 100644 index 90e6c0057c..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmatchedcount.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommandResult::getMatchedCount - Renvoie le nombre de documents sélectionnés pour la mise à jour - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getMatchedCount - - - - Si l'opération de mise à jour ne fait aucun changement au document (par exemple, en - définissant la valeur d'un champ à sa valeur actuelle), le nombre de documents peut être plus grand - que la valeur renvoyée par - MongoDB\Driver\BulkWriteCommandResult::getModifiedCount. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nombre total de documents sélectionnés pour la mise à jour par toutes les opérations. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommandResult::getMatchedCount</function> - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getMatchedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getModifiedCount - MongoDB\Driver\BulkWriteCommandResult::getUpdateResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmodifiedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmodifiedcount.xml deleted file mode 100644 index e9a9c9f51b..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmodifiedcount.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommandResult::getModifiedCount - Renvoie le nombre de documents existants mis à jour - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getModifiedCount - - - - Si l'opération de mise à jour ne fait aucun changement au document (par exemple, en - définissant la valeur d'un champ à sa valeur actuelle), le nombre de documents peut être plus petit - que la valeur renvoyée par - MongoDB\Driver\BulkWriteCommandResult::getMatchedCount. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nombre total de documents existants mis à jour par toutes les opérations. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommandResult::getModifiedCount</function> - -updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getMatchedCount - MongoDB\Driver\BulkWriteCommandResult::getUpdateResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupdateresults.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupdateresults.xml deleted file mode 100644 index 0720e969f3..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupdateresults.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommandResult::getUpdateResults - Renvoie les résultats détaillés des mises à jour réussies - - - - &reftitle.description; - - final public MongoDB\BSON\DocumentnullMongoDB\Driver\BulkWriteCommandResult::getUpdateResults - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un document contenant les résultats de chaque opération de mise à jour - réussie, ou &null; si les résultats détaillés n'ont pas été demandés. Les clés - du document correspondront à l'index de l'opération d'écriture de - MongoDB\Driver\BulkWriteCommand. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommandResult::getUpdateResults</function> - - true]); -$bulk->insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getUpdateResults()->toPHP()); - -?> -]]> - - &example.outputs.similar; - - - object(stdClass)#7 (2) { - ["matchedCount"]=> - object(MongoDB\BSON\Int64)#5 (1) { - ["integer"]=> - string(1) "1" - } - ["modifiedCount"]=> - object(MongoDB\BSON\Int64)#6 (1) { - ["integer"]=> - string(1) "1" - } - } - ["2"]=> - object(stdClass)#11 (3) { - ["matchedCount"]=> - object(MongoDB\BSON\Int64)#8 (1) { - ["integer"]=> - string(1) "1" - } - ["modifiedCount"]=> - object(MongoDB\BSON\Int64)#9 (1) { - ["integer"]=> - string(1) "0" - } - ["upsertedId"]=> - object(MongoDB\BSON\ObjectId)#10 (1) { - ["oid"]=> - string(24) "67f7eb9b1f198bbcb880d575" - } - } - ["3"]=> - object(stdClass)#15 (3) { - ["matchedCount"]=> - object(MongoDB\BSON\Int64)#12 (1) { - ["integer"]=> - string(1) "1" - } - ["modifiedCount"]=> - object(MongoDB\BSON\Int64)#13 (1) { - ["integer"]=> - string(1) "0" - } - ["upsertedId"]=> - object(MongoDB\BSON\ObjectId)#14 (1) { - ["oid"]=> - string(24) "67f7eb9b1f198bbcb880d576" - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getMatchedCount - MongoDB\Driver\BulkWriteCommandResult::getModifiedCount - MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupsertedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupsertedcount.xml deleted file mode 100644 index 35309366e6..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupsertedcount.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount - Renvoie le nombre de documents insérés/mis à jour - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getUpsertedCount - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nombre total de documents insérés/mis à jour par toutes les opérations. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount</function> - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getUpsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getUpdateResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/isacknowledged.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/isacknowledged.xml deleted file mode 100644 index 6c90e6bd5a..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/isacknowledged.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - Renvoie si l'écriture a été reconnue - - - - &reftitle.description; - - final public boolMongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - Si l'écriture a été reconnue, les autres champs seront disponibles sur - l'objet MongoDB\Driver\BulkWriteCommandResult. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si l'écriture a été reconnue, et &false; sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommandResult::isAcknowledged</function> avec un write concern reconnu - -insertOne('db.coll', ['x' => 1]); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - <function>MongoDB\Driver\BulkWriteCommandResult::isAcknowledged</function> avec un write concern non reconnu - - false]); -$bulk->insertOne('db.coll', ['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(0); - -$result = $manager->executeBulkWriteCommand($bulk, ['writeConcern' => $writeConcern]); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - Write Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption.xml b/reference/mongodb/mongodb/driver/clientencryption.xml deleted file mode 100644 index 3622f23b8b..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption.xml +++ /dev/null @@ -1,252 +0,0 @@ - - - - - La classe MongoDB\Driver\ClientEncryption - MongoDB\Driver\ClientEncryption - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\ClientEncryption gère la - création de clés de données pour le chiffrement côté client, ainsi que le - chiffrement et le déchiffrement manuels des valeurs. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\ClientEncryption - - - - final - - MongoDB\Driver\ClientEncryption - - - - - - &Constants; - - const - string - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC - AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic - - - const - string - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM - AEAD_AES_256_CBC_HMAC_SHA_512-Random - - - const - string - MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED - Indexed - - - const - string - MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED - Unindexed - - - const - string - MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE - Range - - - const - string - MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY - equality - - - const - string - MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE - range - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC - - Spécifie un algorithme pour le chiffrement déterministe, qui est adapté aux requêtes. - - - - - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM - - Spécifie un algorithme pour le chiffrement aléatoire. - - - - - MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED - - Spécifie un algorithme pour une charge utile indexée et chiffrée, qui peut être utilisée avec le chiffrement de requêtes. - Pour insérer ou interroger avec une charge utile indexée et chiffrée, le MongoDB\Driver\Manager doit être configuré avec l'option de pilote "autoEncryption". L'option de chiffrement automatique "bypassQueryAnalysis" peut être &true;. L'option de chiffrement automatique "bypassAutoEncryption" doit être &false;. - - - - - MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED - - Spécifie un algorithme pour une charge utile non indexée et chiffrée. - - - - - MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE - - - Spécifie un algorithme pour une charge utile chiffrée par plage, qui peut être utilisée - avec le chiffrement de requêtes. - - - Pour interroger avec une charge utile chiffrée par plage, le - MongoDB\Driver\Manager doit être configuré avec l'option de pilote - "autoEncryption". L'option de chiffrement automatique - "bypassQueryAnalysis" peut être &true;. L'option de chiffrement automatique - "bypassAutoEncryption" doit être &false;. - - - L'extension ne prend pas encore en charge les requêtes de plage pour les types de champ BSON Decimal128. - - - - - - MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY - - - Spécifie un type de requête d'égalité, qui est utilisé en conjonction avec - MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED. - - - - - - MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE - - - Spécifie un type de requête de plage, qui est utilisé en conjonction avec - MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE. - - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - Suppression de MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW - et MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW. - - - - - PECL mongodb 1.20.0 - - - Ajout MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE - et MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE. - - - Déprécié MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW - et MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW. - - - - - PECL mongodb 1.16.0 - - Ajout MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW - et MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW. - - - - PECL mongodb 1.14.0 - - Ajout MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED, - MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED, - et MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY. - - - - - -
    - -
    - &reftitle.seealso; - - MongoDB\Driver\Manager::createClientEncryption - -
    - -     - - &reference.mongodb.mongodb.driver.entities.clientencryption; - -     - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml b/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml deleted file mode 100644 index 88fe0d2bb3..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::addKeyAltName - Ajoute un nom alternatif à un document clé - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ClientEncryption::addKeyAltName - MongoDB\BSON\BinarykeyId - stringkeyAltName - - - Ajoute keyAltName à l'ensemble des noms alternatifs pour le - document clé avec l'UUID donné keyId. - - - - - &reftitle.parameters; - - - keyId - - - Une instance MongoDB\BSON\Binary avec le sous-type 4 - (UUID) identifiant le document clé. - - - - - - keyAltName - - - Nom alternatif à ajouter au document clé. - - - - - - - - &reftitle.returnvalues; - - Renvoie la version précédente du document clé, ou &null; si aucun document - correspondant n'a été trouvé. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs. - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::getKeyByAltName - MongoDB\Driver\ClientEncryption::removeKeyAltName - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/construct.xml b/reference/mongodb/mongodb/driver/clientencryption/construct.xml deleted file mode 100644 index 2e6180d4f7..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/construct.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::__construct - Créer un nouvel objet ClientEncryption - - - - &reftitle.description; - - final public MongoDB\Driver\ClientEncryption::__construct - arrayoptions - - - Construit un nouvel objet MongoDB\Driver\ClientEncryption avec les options spécifiées. - - - - - &reftitle.parameters; - - - options - - - - options - - - - Option - Type - Description - - - - - keyVaultClient - MongoDB\Driver\Manager - Le gestionnaire utilisé pour router les requêtes de clé de données. Cette option est requise (contrairement à MongoDB\Driver\Manager::createClientEncryption). - - &mongodb.option.encryption.keyVaultNamespace; - &mongodb.option.encryption.kmsProviders; - &mongodb.option.encryption.tlsOptions; - - -
    -     -     -     -     -     - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\RuntimeException si l'extension n'a pas été compilée avec le support libmongocrypt - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.16.0 - - - Le fournisseur AWS KMS pour le chiffrement côté client accepte désormais - une option "sessionToken", qui peut être utilisée pour - s'authentifier avec des informations d'identification AWS temporaires. - - - Ajout de "tlsDisableOCSPEndpointCheck" à - l'option "tlsOptions". - - - Si un document vide est spécifié pour le fournisseur KMS "azure" ou - "gcp", le pilote tentera de configurer le fournisseur en utilisant les - Les informations d'identification automatiques. - - - - - PECL mongodb 1.15.0 - - - Si un document vide est spécifié pour le fournisseur KMS "aws", - le pilote tentera de configurer le fournisseur en utilisant les - Les informations d'identification automatiques. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::createClientEncryption - Le chiffrement côté client explicite (manuel) dans le manuel MongoDB - - - -     - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml b/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml deleted file mode 100644 index 7c53ff7d6c..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::createDataKey - Créer un document clé - - - - &reftitle.description; - - final public MongoDB\BSON\BinaryMongoDB\Driver\ClientEncryption::createDataKey - stringkmsProvider - arraynulloptions&null; - - - Crée un nouveau document clé et l'insère dans la collection de coffre de clés. - - - - - &reftitle.parameters; - - - kmsProvider - - - Le fournisseur KMS (par exemple "local", - "aws") qui sera utilisé pour chiffrer le nouveau document clé. - - - - - - options - - - - Options de données de clé - - - - Option - Type - Description - - - - - masterKey - array - - - Le document masterKey identifie une clé spécifique à KMS utilisée pour - chiffrer le nouveau document clé. Cette option est requise à moins que - kmsProvider soit "local". - - &mongodb.option.encryption.masterKey-options-by-provider; - - - - keyAltNames - array - - - Une liste optionnelle de noms alternatifs de chaîne utilisés pour référencer une clé. - Si une clé est créée avec des noms alternatifs, alors le chiffrement peut se référer - à la clé par le nom alternatif unique au lieu de par - _id. - - - - - keyMaterial - MongoDB\BSON\Binary - - - Une valeur optionnelle de 96 octets à utiliser comme matériel de clé - pour le document clé en cours de création. Si keyMaterial est donné, - le matériel de clé personnalisé est utilisé pour chiffrer et déchiffrer - les données. Sinon, le matériel de clé pour le nouveau document clé est - généré à partir d'un dispositif aléatoire cryptographiquement sécurisé. - - - - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - Renvoie un identifiant du nouveau document clé en tant qu'objet - MongoDB\BSON\Binary avec le sous-type 4 (UUID). - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Ajout de "delegated" aux options masterKey du fournisseur KMIP. - - - - PECL mongodb 1.15.0 - - Ajout de l'option "keyMaterial". - - - - PECL mongodb 1.10.0 - - Azure et GCP sont désormais pris en charge en tant que fournisseurs KMS pour - le chiffrement côté client. - - - - - - - -     - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml b/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml deleted file mode 100644 index 0fed49c6b3..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::decrypt - Déchiffre une valeur - - - - &reftitle.description; - - final public mixedMongoDB\Driver\ClientEncryption::decrypt - MongoDB\BSON\Binaryvalue - - - Déchiffre la valeur. - - - - - &reftitle.parameters; - - - value - - - Une instance de MongoDB\BSON\Binary avec le sous-type 6 - contenant la valeur chiffrée. - - - - - - - - &reftitle.returnvalues; - - Renvoie la valeur déchiffrée telle qu'elle a été passée à - MongoDB\Driver\ClientEncryption::encrypt. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\EncryptionException si une erreur se produit lors du déchiffrement de la valeur - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::encrypt - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/deletekey.xml b/reference/mongodb/mongodb/driver/clientencryption/deletekey.xml deleted file mode 100644 index 2790b54370..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/deletekey.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::deleteKey - Supprime un document clé - - - - &reftitle.description; - - final public objectMongoDB\Driver\ClientEncryption::deleteKey - MongoDB\BSON\BinarykeyId - - - Enlève le document clé avec l'UUID donné keyId - de la collection de coffre de clés. - - - - - &reftitle.parameters; - - - keyId - - - Une instance de MongoDB\BSON\Binary avec le sous-type 4 - (UUID) identifiant le document clé. - - - - - - - - &reftitle.returnvalues; - - Renvoie le résultat de l'opération interne deleteOne sur - la collection de coffre de clés. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs. - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml b/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml deleted file mode 100644 index e78ce34d72..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::encrypt - Chiffre une valeur - - - - &reftitle.description; - - final public MongoDB\BSON\BinaryMongoDB\Driver\ClientEncryption::encrypt - mixedvalue - arraynulloptions&null; - - - Chiffre la valeur. - - - - - &reftitle.parameters; - - - value - - - La valeur à chiffrer. Toute valeur qui peut être insérée dans MongoDB peut - être chiffrée en utilisant cette méthode. - - - - &mongodb.parameter.encryptOpts; - - - - - &reftitle.returnvalues; - - Renvoie la valeur chiffrée en tant qu'objet - MongoDB\BSON\Binary de sous-type 6. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\EncryptionException si une erreur se produit lors du chiffrement de la valeur - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Ajouté l'option de plage "trimFactor". L'option de plage - "sparsity" est désormais optionnelle. - - - - PECL mongodb 1.16.0 - - Ajouté l'option "rangeOpts". - - - - PECL mongodb 1.14.0 - - Ajout des options "contentionFactor" et - "queryType". - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::decrypt - MongoDB\Driver\ClientEncryption::encryptExpression - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml b/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml deleted file mode 100644 index af369693ec..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::encryptExpression - Chiffre une expression de correspondance ou d'agrégation - - - - &reftitle.description; - - final public objectMongoDB\Driver\ClientEncryption::encryptExpression - arrayobjectexpr - arraynulloptions&null; - - - Chiffre une expression de correspondance ou d'agrégation pour interroger un index de plage. - - Pour interroger avec une charge utile chiffrée par plage, l'option de pilote MongoDB\Driver\Manager doit être configurée avec l'option de pilote "autoEncryption". L'option de chiffrement automatique "bypassQueryAnalysis" peut être &true;. L'option de chiffrement automatique "bypassAutoEncryption" doit être &false;. - - L'extension ne prend pas encore en charge les requêtes de plage pour les types de champ BSON Decimal128. - - - - - &reftitle.parameters; - - - expr - - - L'expression de correspondance ou d'agrégation à chiffrer. Les expressions doivent - utiliser au moins un des opérateurs $gt, $gte, - $lt ou $lte. Un opérateur $and - de premier niveau est requis, même si un seul opérateur de comparaison est utilisé. - - - Un exemple d'expression de correspondance prise en charge (s'applique aux requêtes et à l'étape d'agrégation - $match) est le suivant : - - - [ - [ '' => [ '$gt' => '' ] ], - [ '' => [ '$lte' => '' ] ], - ], -] -]]> - - - Un exemple d'expression d'agrégation prise en charge est le suivant : - - - [ - [ '$gte' => [ '', '' ] ], - [ '$lt' => [ '', '' ] ], - ], -] -]]> - - - - &mongodb.parameter.encryptOpts; - - - - - &reftitle.returnvalues; - - Renvoie l'expression chiffrée en tant qu'objet. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\EncryptionException si une erreur se produit lors du chiffrement de l'expression - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Ajouté l'option de plage "trimFactor". L'option de plage - "sparsity" est désormais optionnelle. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::__construct - MongoDB\Driver\ClientEncryption::encrypt - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/getkey.xml b/reference/mongodb/mongodb/driver/clientencryption/getkey.xml deleted file mode 100644 index df75938e0f..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/getkey.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::getKey - Renvoie un document clé - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ClientEncryption::getKey - MongoDB\BSON\BinarykeyId - - - Trouve un document clé unique dans la collection de coffre de clés avec l'UUID donné - keyId. - - - - - &reftitle.parameters; - - - keyId - - - Une instance de MongoDB\BSON\Binary avec le sous-type 4 - (UUID) identifiant le document clé. - - - - - - - - &reftitle.returnvalues; - - Renvoie le document clé, ou &null; si aucun document n'a été trouvé. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs. - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml b/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml deleted file mode 100644 index ded2a9b611..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::getKeyByAltName - Renvoie un document clé par un nom alternatif - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ClientEncryption::getKeyByAltName - stringkeyAltName - - - Trouve un document clé unique dans la collection de coffre de clés avec - le nom alternatif donné keyAltName. - - - - - &reftitle.parameters; - - - keyAltName - - - Le nom alternatif pour le document clé. - - - - - - - - &reftitle.returnvalues; - - Renvoie le document clé, ou &null; si aucun document n'a été trouvé. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs. - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::addKeyAltName - MongoDB\Driver\ClientEncryption::removeKeyAltName - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml b/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml deleted file mode 100644 index c2a4279c6b..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::getKeys - Renvoie tous les documents clés - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\ClientEncryption::getKeys - - - - Trouve tous les documents clés dans la collection de coffre de clés. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs. - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml b/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml deleted file mode 100644 index 09f150b91d..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::removeKeyAltName - Enlève un nom alternatif d'un document clé - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ClientEncryption::removeKeyAltName - MongoDB\BSON\BinarykeyId - stringkeyAltName - - - Enlève keyAltName de l'ensemble des noms alternatifs pour - le document clé avec l'UUID donné keyId. - - - - - &reftitle.parameters; - - - keyId - - - Une instance de MongoDB\BSON\Binary avec le sous-type 4 - (UUID) identifiant le document clé. - - - - - - keyAltName - - - Le nom alternatif à enlever du document clé. - - - - - - - - &reftitle.returnvalues; - - Renvoie la version précédente du document clé, ou &null; si aucun document - n'a été trouvé. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs. - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::addKeyAltName - MongoDB\Driver\ClientEncryption::getKeyByAltName - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml b/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml deleted file mode 100644 index a3905e7fc2..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::rewrapManyDataKey - Ré-emballe les clés de données - - - - &reftitle.description; - - final public objectMongoDB\Driver\ClientEncryption::rewrapManyDataKey - arrayobjectfilter - arraynulloptions&null; - - - Ré-emballe (c'est-à-dire déchiffre et rechiffre) zéro ou plusieurs clés de données - dans la collection de coffre de clés qui correspondent au filter donné. - - - Si l'option "provider" n'est pas spécifiée, les clés de données - correspondantes seront ré-emballées avec leur fournisseur KMS actuel. Sinon, les clés de données - correspondantes seront rechiffrées selon les options "provider" et - "masterKey" spécifiées. - - - - - &reftitle.parameters; - - &mongodb.parameter.filter; - - options - - - - Options de RewrapManyDataKey - - - - Option - Type - Description - - - - - provider - string - - - Le fournisseur KMS (par exemple "local", - "aws") qui sera utilisé pour rechiffrer les - clés de données correspondantes. - - - Si un fournisseur KMS n'est pas spécifié, les clés de données - correspondantes seront rechiffrées avec leur fournisseur KMS actuel. - - - - - masterKey - array - - - La clé masterKey identifie une clé spécifique à un KMS utilisée pour - chiffrer la nouvelle clé de données. Cette option ne doit pas être spécifiée sans - l'option "provider". Cette option est requise si - "provider" est spécifié et n'est pas - "local". - - &mongodb.option.encryption.masterKey-options-by-provider; - - - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - Renvoie un objet, qui aura éventuellement une propriété - bulkWriteResult contenant le résultat de l'opération - bulkWrite interne sous forme d'un objet. Si aucune clé de données - n'a correspondu au filtre ou si l'écriture n'a pas été acquittée, la propriété - bulkWriteResult sera &null;. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\EncryptionException si une erreur se produit lors du déchiffrement ou du rechiffrement d'une clé de données. - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Ajout de "delegated" aux options masterKey du fournisseur KMIP. - - - - - - -     - - diff --git a/reference/mongodb/mongodb/driver/command.xml b/reference/mongodb/mongodb/driver/command.xml deleted file mode 100644 index 9f7f2aa91b..0000000000 --- a/reference/mongodb/mongodb/driver/command.xml +++ /dev/null @@ -1,195 +0,0 @@ - - - - - La classe MongoDB\Driver\Command - MongoDB\Driver\Command - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Command est un objet de valeur - qui représente une commande de base de données. - - - Pour fournir des Command Helpers, l'objet MongoDB\Driver\Command doit être composé. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Command - - - - final - - MongoDB\Driver\Command - - - - - &Methods; - - - - -
    - -
    - &reftitle.examples; - - - Composé <classname>MongoDB\Driver\Command</classname> pour fournir un assistant pour créer des collections - -cmd["create"] = (string) $collectionName; - } - function setCappedCollection($maxBytes, $maxDocuments = false) { - $this->cmd["capped"] = true; - $this->cmd["size"] = (int) $maxBytes; - - if ($maxDocuments) { - $this->cmd["max"] = (int) $maxDocuments; - } - } - function usePowerOf2Sizes($bool) { - if ($bool) { - $this->cmd["flags"] = 1; - } else { - $this->cmd["flags"] = 0; - } - } - function setFlags($flags) { - $this->cmd["flags"] = (int) $flags; - } - function getCommand() { - return new MongoDB\Driver\Command($this->cmd); - } - function getCollectionName() { - return $this->cmd["create"]; - } -} - - -$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017"); - -$createCollection = new CreateCollection("cappedCollection"); -$createCollection->setCappedCollection(64 * 1024); - -try { - $command = $createCollection->getCommand(); - $cursor = $manager->executeCommand("databaseName", $command); - $response = $cursor->toArray()[0]; - var_dump($response); - - $collstats = ["collstats" => $createCollection->getCollectionName()]; - $cursor = $manager->executeCommand("databaseName", new MongoDB\Driver\Command($collstats)); - $response = $cursor->toArray()[0]; - var_dump($response); -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} - -?> -]]> - - - &example.outputs; - - - array(3) { - ["create"]=> - string(16) "cappedCollection" - ["capped"]=> - bool(true) - ["size"]=> - int(65536) - } -} -array(1) { - ["ok"]=> - float(1) -} -array(16) { - ["ns"]=> - string(29) "databaseName.cappedCollection" - ["count"]=> - int(0) - ["size"]=> - int(0) - ["numExtents"]=> - int(1) - ["storageSize"]=> - int(65536) - ["nindexes"]=> - int(1) - ["lastExtentSize"]=> - float(65536) - ["paddingFactor"]=> - float(1) - ["paddingFactorNote"]=> - string(101) "paddingFactor is unused and unmaintained in 2.8. It remains hard coded to 1.0 for compatibility only." - ["userFlags"]=> - int(0) - ["capped"]=> - bool(true) - ["max"]=> - int(9223372036854775807) - ["maxSize"]=> - int(65536) - ["totalIndexSize"]=> - int(8176) - ["indexSizes"]=> - object(stdClass)#4 (1) { - ["_id_"]=> - int(8176) - } - ["ok"]=> - float(1) -} -]]> - -
    - -     - - &reference.mongodb.mongodb.driver.entities.command; - -     - - diff --git a/reference/mongodb/mongodb/driver/command/construct.xml b/reference/mongodb/mongodb/driver/command/construct.xml deleted file mode 100644 index 672aee2ce2..0000000000 --- a/reference/mongodb/mongodb/driver/command/construct.xml +++ /dev/null @@ -1,264 +0,0 @@ - - - - - - - - MongoDB\Driver\Command::__construct - Crée une nouvelle commande - - - - &reftitle.description; - - final public MongoDB\Driver\Command::__construct - arrayobjectdocument - arraynullcommandOptions&null; - - - Construit un nouveau MongoDB\Driver\Command, qui est - un objet valeur immuable qui représente une commande de base de données. - La commande peut alors être exécutée avec - MongoDB\Driver\Manager::executeCommand. - - - Le document de commande complet, qui inclut le nom de la commande et ses - options, doit être exprimé dans le paramètre document. - Le paramètre commandOptions est utilisé uniquement - pour spécifier les options liées à l'exécution de la commande et le résultat - MongoDB\Driver\Cursor. - - - - - - &reftitle.parameters; - - - document - - - Le document de commande complet, qui sera envoyé au serveur. - - - - - - commandOptions - - - - Ne pas utiliser ce paramètre pour spécifier les options décrites dans la - référence de la commande dans le manuel MongoDB. Ce paramètre ne doit - être utilisé que pour les options explicitement énumérées ci-dessous. - - - - - commandOptions - - - - Option - Type - &Description; - - - - - maxAwaitTimeMS - int - - - Entier positif indiquant la limite de temps en millisecondes pour - que le serveur bloque une opération getMore si aucune donnée n'est - disponible. Cette option ne doit être utilisée qu'en conjonction - avec les commandes qui retournent un curseur à queue (par exemple - Change Streams). - - - - - -
    -     -     -     -     -     - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.0 - - - Ajout d'un deuxième argument commandOptions, qui - prend en charge l'option "maxAwaitTimeMS". - - - - - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\Command::__construct</function> - - 1)); - -try { - $cursor = $manager->executeCommand("admin", $command); - $response = $cursor->toArray()[0]; -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} -var_dump($response); - -?> -]]> - - &example.outputs.similar; - - - string(14) "2.8.0-rc2-pre-" - ["gitVersion"]=> - string(62) "b743d7158f7642f4da6b7eac8320374b3b88dc2e modules: subscription" - ["OpenSSLVersion"]=> - string(25) "OpenSSL 1.0.1f 6 Jan 2014" - ["sysInfo"]=> - string(104) "Linux infant 3.16.0-24-generic #32-Ubuntu SMP Tue Oct 28 13:07:32 UTC 2014 x86_64 BOOST_LIB_VERSION=1_49" - ["loaderFlags"]=> - string(91) "-fPIC -pthread -Wl,-z,now -rdynamic -Wl,-Bsymbolic-functions -Wl,-z,relro -Wl,-z,now -Wl,-E" - ["compilerFlags"]=> - string(301) "-Wnon-virtual-dtor -Woverloaded-virtual -std=c++11 -fPIC -fno-strict-aliasing -ggdb -pthread -Wall -Wsign-compare -Wno-unknown-pragmas -Winvalid-pch -pipe -Werror -O3 -Wno-unused-local-typedefs -Wno-unused-function -Wno-deprecated-declarations -Wno-unused-but-set-variable -fno-builtin-memcmp -std=c99" - ["allocator"]=> - string(8) "tcmalloc" - ["versionArray"]=> - array(4) { - [0]=> - int(2) - [1]=> - int(8) - [2]=> - int(0) - [3]=> - int(-8) - } - ["javascriptEngine"]=> - string(2) "V8" - ["bits"]=> - int(64) - ["debug"]=> - bool(false) - ["maxBsonObjectSize"]=> - int(16777216) - ["ok"]=> - float(1) -} - -]]> - - - - - Exemple avec <function>MongoDB\Driver\Command::__construct</function> - - Les commandes peuvent également accepter des options, dans le cadre de la - structure normale qu'on crée pour envoyer au serveur. Par exemple, - l'option maxTimeMS peut être passée avec la plupart des - commandes pour restreindre la durée pendant laquelle une commande spécifique - peut s'exécuter sur le serveur. - - - "beer", - "key" => "beer_name", - "maxTimeMS" => 10, - ) -); - -try { - $cursor = $manager->executeCommand("beerdb", $command); - $response = $cursor->toArray()[0]; -} catch(MongoDB\Driver\Exception\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} -var_dump($response); - -?> -]]> - - &example.outputs.similar; - - operation exceeded time limit - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Cursor - - - -     - - diff --git a/reference/mongodb/mongodb/driver/cursor.xml b/reference/mongodb/mongodb/driver/cursor.xml deleted file mode 100644 index f615a17d35..0000000000 --- a/reference/mongodb/mongodb/driver/cursor.xml +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - La classe MongoDB\Driver\Cursor - MongoDB\Driver\Cursor - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Cursor - encapsule le résultat d'une commande ou d'une requête MongoDB, - pouvant être retournée par, respectivement, - MongoDB\Driver\Manager::executeCommand ou - MongoDB\Driver\Manager::executeQuery. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Cursor - - - - final - - MongoDB\Driver\Cursor - - - - MongoDB\Driver\CursorInterface - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.9.0 - - Implémente Iterator. - - - - PECL mongodb 1.6.0 - - Implémentation de MongoDB\Driver\CursorInterface, - qui étend Traversable. - - - - - -
    - -
    - &reftitle.examples; - - - Lecture d'un jeu de résultats - - MongoDB\Driver\Manager::executeCommand et - MongoDB\Driver\Manager::executeQuery les deux - renvoient leur (s) résultat (s) en tant qu'objet MongoDB\Driver\Cursor. - Cet objet peut être utilisé pour itérer au sein du jeu de résultats de la - commande ou de la requête. - - - Parce que MongoDB\Driver\Cursor implémente l'interface - Traversable, il est possible de simplement itérer - sur le jeu de résultats avec - foreach. - - -insert(['name' => 'Ceres', 'size' => 946, 'distance' => 2.766]); -$bulkWrite->insert(['name' => 'Vesta', 'size' => 525, 'distance' => 2.362]); -$manager->executeBulkWrite("test.asteroids", $bulkWrite); - -/* Requête pour tous les éléments de la collection */ -$query = new MongoDB\Driver\Query( [] ); - -/* Interrogez la collection "asteroids" de la base de données "test" */ -$cursor = $manager->executeQuery("test.asteroids", $query); - -/* $cursor contient maintenant un objet qui entoure le jeu de résultats. - * Utiliser foreach() pour itérer sur tous les résultats */ -foreach($cursor as $document) { - print_r($document); -} - -?> -]]> - - &example.outputs.similar; - - MongoDB\BSON\ObjectId Object - ( - [oid] => 5a4cff2f122d3321565d8cc2 - ) - - [name] => Ceres - [size] => 946 - [distance] => 2.766 -) -stdClass Object -( - [_id] => MongoDB\BSON\ObjectId Object - ( - [oid] => 5a4cff2f122d3321565d8cc3 - ) - - [name] => Vesta - [size] => 525 - [distance] => 2.362 -) -]]> - - - - - Lecture d'un jeu de résultats pour un curseur à queue - - Les curseurs à queue - sont un type spécial de curseur MongoDB qui permet au client de lire - quelques résultats et d'attendre jusqu'à ce que plus de documents - deviennent disponibles. Ces curseurs sont principalement utilisés avec - Capped Collections - et Change Streams. - - - Bien que les curseurs normaux puissent être parcourus une fois avec - foreach, cette approche ne fonctionnera pas avec les - curseurs à queue. Lorsque foreach est utilisé avec un - curseur à queue, la boucle s'arrêtera à la fin du jeu de résultats initial. - Tenter de continuer l'itération sur le curseur avec une seconde - foreach lèverait une exception, car PHP tente de - rembobiner le curseur. Comme pour les objets result dans d'autres pilotes - de base de données, les curseurs dans MongoDB prennent uniquement en charge - l'itération en avant, ce qui signifie qu'ils ne peuvent pas être rembobinés. - - - Afin de lire en continu à partir d'un curseur de queue, l'objet Cursor doit - être enveloppé avec un IteratorIterator. Cela permet - à l'application de contrôler directement l'itération du curseur, d'éviter - de rembobiner par inadvertance le curseur et de décider quand attendre les - nouveaux résultats ou arrêter complètement l'itération. - - - Afin de démontrer un curseur en action, deux scripts seront utilisés: un - "Producer" et un "Consumer". Le script Producer créera une nouvelle collection - plafonnée à l'aide de la commande - Create et - procédera à l'insertion d'un nouveau document dans cette collection - chaque seconde. - - -executeCommand('test', new MongoDB\Driver\Command([ - 'create' => 'asteroids', - 'capped' => true, - 'size' => 1048576, -])); - -while (true) { - $bulkWrite = new MongoDB\Driver\BulkWrite; - $bulkWrite->insert(['createdAt' => new MongoDB\BSON\UTCDateTime]); - $manager->executeBulkWrite('test.asteroids', $bulkWrite); - - sleep(1); -} - -?> -]]> - - - Avec le script Producer toujours en cours d'exécution, un deuxième script - consommateur peut être exécuté pour lire les documents insérés à l'aide - d'un curseur de queue, indiqué par les options tailable - et awaitData à - MongoDB\Driver\Query::__construct. - - - true, - 'awaitData' => true, -]); - -$cursor = $manager->executeQuery('test.asteroids', $query); - -$iterator = new IteratorIterator($cursor); - -$iterator->rewind(); - -while (true) { - if ($iterator->valid()) { - $document = $iterator->current(); - printf("Consumed document created at: %s\n", $document->createdAt); - } - - $iterator->next(); -} - -?> -]]> - - - Le script consommateur va commencer par imprimer rapidement tous les - documents disponibles dans la collection plafonnée (comme si - foreach avait été utilisé); toutefois, il ne se - terminera pas à la fin du jeu de résultats initial. Étant donné que - le curseur est en file d'attente, l'appel de - IteratorIterator::next se bloque et attend des - résultats supplémentaires. IteratorIterator::valid - est également utilisé pour vérifier s'il y a effectivement des données - disponibles à lire à chaque étape. - - - - Cet exemple utilise l'option de requête awaitData pour - indiquer au serveur de bloquer pendant une courte période (par exemple une - seconde) à la fin du jeu de résultats avant de retourner une réponse au - pilote. Ceci est utilisé pour empêcher le pilote d'interroger agressivement - le serveur lorsqu'il n'y a aucun résultat disponible. L'option - maxAwaitTimeMS peut être utilisée conjointement avec - tailable et awaitData pour spécifier - la durée pendant laquelle le serveur doit se bloquer lorsqu'il atteint la - fin du jeu de résultats. - - - -
    - -
    - &reftitle.errors; - - Lors de l'itération sur l'objet Cursor, les données BSON sont converties en variables PHP. Cette itération peut provoquer les exceptions suivantes: - - - - Lève une exception - MongoDB\Driver\Exception\InvalidArgumentException si - une classe dans le mappage de type ne peut pas être instanciée ou - n'implémente pas MongoDB\BSON\Unserializable. - - &mongodb.throws.bson.unexpected; - -
    -     - - &reference.mongodb.mongodb.driver.entities.cursor; - -     - - diff --git a/reference/mongodb/mongodb/driver/cursor/construct.xml b/reference/mongodb/mongodb/driver/cursor/construct.xml deleted file mode 100644 index a8c9eb50ae..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/construct.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - MongoDB\Driver\Cursor::__construct - Créer un nouveau curseur (non utilisé) - - - - &reftitle.description; - - final private MongoDB\Driver\Cursor::__construct - - - - Les objets MongoDB\Driver\Cursor sont retournés en tant - que résultat d'une commande ou d'une requête exécutée et ne peuvent pas être - construits directement. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Manager::executeQuery - MongoDB\Driver\Server::executeCommand - MongoDB\Driver\Server::executeQuery - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/current.xml b/reference/mongodb/mongodb/driver/cursor/current.xml deleted file mode 100644 index eda87e8511..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/current.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::current - Renvoie l'élément courant - - - - &reftitle.description; - - public arrayobjectnullMongoDB\Driver\Cursor::current - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le document résultant actuel sous forme de tableau ou d'objet, en fonction du - type de carte du curseur. Si l'itération n'a pas commencé ou si la position actuelle - n'est pas valide, &null; sera renvoyé. - - - - - &reftitle.seealso; - - Iterator::current - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/getid.xml b/reference/mongodb/mongodb/driver/cursor/getid.xml deleted file mode 100644 index fb733b8875..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/getid.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - MongoDB\Driver\Cursor::getId - Retourne l'ID de ce curseur - - - - &reftitle.description; - - final public MongoDB\BSON\Int64MongoDB\Driver\Cursor::getId - - - - Renvoie l'ID de ce curseur, qui identifie de manière unique le curseur sur le serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'ID de ce curseur. L'ID sera retourné sous la forme d'un objet - MongoDB\BSON\Int64. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - Le type de retour a été changé en MongoDB\BSON\Int64. - Le paramètre asInt64 a été supprimé. - - - - PECL mongodb 1.20.0 - - Dépréciation du retour d'un MongoDB\Driver\CursorId. - Ajout de l'argument asInt64 pour faciliter - la migration vers les versions futures. Si asInt64 - est &true;, l'ID sera retourné sous la forme d'un - MongoDB\BSON\Int64. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\Cursor::getId</function> - - 2]); - -$bulk = new MongoDB\Driver\BulkWrite; -$bulk->insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$cursor = $manager->executeQuery('db.collection', $query); -var_dump($cursor->getId(true)); - -?> -]]> - - &example.outputs.similar; - - - string(11) "94810124093" -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Int64 - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/getserver.xml b/reference/mongodb/mongodb/driver/cursor/getserver.xml deleted file mode 100644 index e109449619..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/getserver.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::getServer - Retourne le serveur associé à ce curseur - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Cursor::getServer - - - - Retourne le MongoDB\Driver\Server associé à ce curseur. - Il s'agit du serveur qui a exécuté la - MongoDB\Driver\Query ou - MongoDB\Driver\Command. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le MongoDB\Driver\Server associé à ce curseur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\Cursor::getServer</function> - -insert(['x' => 1]); -$manager->executeBulkWrite('db.collection', $bulk); - -$cursor = $manager->executeQuery('db.collection', $query); -var_dump($cursor->getServer()); - -?> -]]> - - &example.outputs.similar; - - - string(9) "localhost" - ["port"]=> - int(27017) - ["type"]=> - int(1) - ["is_primary"]=> - bool(false) - ["is_secondary"]=> - bool(false) - ["is_arbiter"]=> - bool(false) - ["is_hidden"]=> - bool(false) - ["is_passive"]=> - bool(false) - ["last_hello_response"]=> - array(8) { - ["isWritablePrimary"]=> - bool(true) - ["maxBsonObjectSize"]=> - int(16777216) - ["maxMessageSizeBytes"]=> - int(48000000) - ["maxWriteBatchSize"]=> - int(1000) - ["localTime"]=> - object(MongoDB\BSON\UTCDateTime)#6 (1) { - ["milliseconds"]=> - int(1446505367907) - } - ["maxWireVersion"]=> - int(3) - ["minWireVersion"]=> - int(0) - ["ok"]=> - float(1) - } - ["round_trip_time"]=> - int(584) -} - -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/isdead.xml b/reference/mongodb/mongodb/driver/cursor/isdead.xml deleted file mode 100644 index 0622f00f64..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/isdead.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - - MongoDB\Driver\Cursor::isDead - Vérifie si le curseur est épuisé ou peut avoir des résultats supplémentaires - - - - &reftitle.description; - - final public boolMongoDB\Driver\Cursor::isDead - - - - Vérifie s'il n'y a plus aucun résultat supplémentaire disponible sur le - curseur. Cette méthode est similaire à la méthode - cursor.isExhausted() - dans le shell MongoDB et son utilité primaire est lors de l'itération de - curseurs de queue. - - - Un curseur n'a plus de résultats supplémentaires et est considéré "mort" s'il - satisfait l'une des conditions ci-dessous: - - - Le lot actuel a été complètement itéré et l'ID du - curseur est zéro (c.à.d. il est impossible de délivrer un getMore). - - Une erreur a été rencontrée lors de l'itération du curseur. - Le curseur a atteint sa limite configurée. - - - - Par sa conception, il n'est pas toujours possible de déterminer si un curseur - a des résultats supplémentaires. Les cas où un curseur peut - avoir plus de données disponibles sont les suivants : - - - Il y a des documents supplémentaires dans le lot courant, qui sont tamponnés - du côté client. Itérer récupérera un document du tampon local. - - - Il n'y a pas de documents supplémentaires dans le lot courant (c.à.d. - tampon local), mais l'ID du curseur est différent de zéro. Itérer - sollicitera plus de documents depuis le serveur via une opération - getMore, - qui retournera ou pas des résultats supplémentaires et / ou indiquera que - le curseur a été fermé sur le serveur en retournant zéro pour son ID. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si c'est confirmé qu'aucun résultat supplémentaire n'est - disponible sur le curseur, et &false; sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\Cursor::isDead</function> - -insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$cursor = $manager->executeQuery('db.collection', $query); - -$iterator = new IteratorIterator($cursor); - -$iterator->rewind(); -var_dump($cursor->isDead()); - -$iterator->next(); -var_dump($cursor->isDead()); - -$iterator->next(); -var_dump($cursor->isDead()); - -$iterator->next(); -var_dump($cursor->isDead()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Tailable Cursors in the MongoDB manual - cursor.isExhausted() in the MongoDB manual - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/key.xml b/reference/mongodb/mongodb/driver/cursor/key.xml deleted file mode 100644 index 498cfe73b3..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/key.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::key - Renvoie le numéro de l'index du résultat courant dans le curseur - - - - &reftitle.description; - - public intMongoDB\Driver\Cursor::key - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'index numérique du résultat actuel dans le curseur. - - - - - &reftitle.seealso; - - Iterator::key - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/next.xml b/reference/mongodb/mongodb/driver/cursor/next.xml deleted file mode 100644 index 93559caa9c..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/next.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::next - Avance le curseur vers le résultat suivant - - - - &reftitle.description; - - public voidMongoDB\Driver\Cursor::next - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Déplace la position actuelle vers l'élément suivant dans le curseur. - - - - - &reftitle.errors; - - &mongodb.throws.std; - - - - - &reftitle.seealso; - - Iterator::next - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/rewind.xml b/reference/mongodb/mongodb/driver/cursor/rewind.xml deleted file mode 100644 index 7899faacca..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/rewind.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::rewind - Rembobine le curseur jusqu'au premier résultat - - - - &reftitle.description; - - public voidMongoDB\Driver\Cursor::rewind - - - - Si le curseur a avancé au-delà de sa première position, il ne peut plus être - rembobiné. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &null;. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\LogicException si cette méthode est appelée après que le curseur a avancé au-delà de sa première position. - - - - - &reftitle.seealso; - - Iterator::rewind - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/settypemap.xml b/reference/mongodb/mongodb/driver/cursor/settypemap.xml deleted file mode 100644 index 33bdfcb12a..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/settypemap.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - MongoDB\Driver\Cursor::setTypeMap - Définit un type de carte à utiliser pour la désérialisation BSON - - - - &reftitle.description; - - final public voidMongoDB\Driver\Cursor::setTypeMap - arraytypemap - - - Définit la - configuration de mappage de type - à utiliser lors de la désérialisation des résultats BSON en valeurs PHP. - - - - - - &reftitle.parameters; - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - Lors de l'itération sur le curseur, les exceptions suivantes peuvent également - être levées en raison d'une configuration de mappage de type incorrecte : - - - Lève une exception - MongoDB\Driver\Exception\InvalidArgumentException si - une classe dans le mappage de type ne peut pas être instanciée ou - n'implémente pas - MongoDB\BSON\Unserializable. - - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\Cursor::setTypeMap</function> - -insert(['x' => 1]); -$manager->executeBulkWrite('db.collection', $bulk); - -$query = new MongoDB\Driver\Query(['_id' => $id]); -$cursor = $manager->executeQuery('db.collection', $query); -$cursor->setTypeMap(['root' => 'array']); - -foreach ($cursor as $document) { - var_dump($document); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\BSON\ObjectId)#6 (1) { - ["oid"]=> - string(24) "56424fb76118fd3267180741" - } - ["x"]=> - int(1) -} -]]> - - - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/toarray.xml b/reference/mongodb/mongodb/driver/cursor/toarray.xml deleted file mode 100644 index 31b73ec663..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/toarray.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - MongoDB\Driver\Cursor::toArray - Retourne un tableau contenant tous les résultats pour ce curseur - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Cursor::toArray - - - - Itère le curseur et retourne ses résultats dans un tableau. - MongoDB\Driver\Cursor::setTypeMap peut être utilisé pour - contrôler comment les documents sont désérialisés en valeurs PHP. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &array; contenant tous les résultats pour ce curseur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\Cursor::toArray</function> - -insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$query = new MongoDB\Driver\Query([]); -$cursor = $manager->executeQuery('db.collection', $query); - -var_dump($cursor->toArray()); - -?> -]]> - - &example.outputs.similar; - - - object(stdClass)#6 (2) { - ["_id"]=> - object(MongoDB\BSON\ObjectId)#5 (1) { - ["oid"]=> - string(24) "564259a96118fd40b41bcf61" - } - ["x"]=> - int(1) - } - [1]=> - object(stdClass)#8 (2) { - ["_id"]=> - object(MongoDB\BSON\ObjectId)#7 (1) { - ["oid"]=> - string(24) "564259a96118fd40b41bcf62" - } - ["x"]=> - int(2) - } - [2]=> - object(stdClass)#10 (2) { - ["_id"]=> - object(MongoDB\BSON\ObjectId)#9 (1) { - ["oid"]=> - string(24) "564259a96118fd40b41bcf63" - } - ["x"]=> - int(3) - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::setTypeMap - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/valid.xml b/reference/mongodb/mongodb/driver/cursor/valid.xml deleted file mode 100644 index 7297327520..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/valid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::valid - Vérifie si la position actuelle du curseur est valide - - - - &reftitle.description; - - public boolMongoDB\Driver\Cursor::valid - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si la position actuelle du curseur est valide, sinon &false;. - - - - - &reftitle.seealso; - - Iterator::valid - - - - diff --git a/reference/mongodb/mongodb/driver/cursorid.xml b/reference/mongodb/mongodb/driver/cursorid.xml deleted file mode 100644 index dafa649ebc..0000000000 --- a/reference/mongodb/mongodb/driver/cursorid.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - La classe MongoDB\Driver\CursorId - MongoDB\Driver\CursorId - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\CursorID est un objet - valeur qui représente un identificateur de curseur. - Les instances de cette classe sont retournées par - MongoDB\Driver\Cursor::getId. - - - - Cette classe a été DÉPRÉCIÉE depuis la version - 1.20.0 de l'extension et a été supprimée dans la version 2.0. Les - applications devraient mettre à jour leur utilisation de - MongoDB\Driver\Cursor::getId pour retourner - MongoDB\BSON\Int64 à la place. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\CursorId - - - - final - - MongoDB\Driver\CursorId - - - - Serializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.class-removed; - - PECL mongodb 1.20.0 - - Cette classe a été dépréciée et sera supprimée dans la version 2.0. - - - - PECL mongodb 1.12.0 - - Implémente Stringable pour PHP 8.0+. - - - - PECL mongodb 1.7.0 - - Implémente Serializable. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.entities.cursorid; - -     - - diff --git a/reference/mongodb/mongodb/driver/cursorid/construct.xml b/reference/mongodb/mongodb/driver/cursorid/construct.xml deleted file mode 100644 index b6a01cebcb..0000000000 --- a/reference/mongodb/mongodb/driver/cursorid/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - MongoDB\Driver\CursorId::__construct - Créer un nouveau CursorId (non utilisé) - - - - &reftitle.description; - - final private MongoDB\Driver\CursorId::__construct - - - - Les objets MongoDB\Driver\CursorId sont retournés par - MongoDB\Driver\Cursor::getId et ne peuvent pas être - construits directement. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getId - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorid/tostring.xml b/reference/mongodb/mongodb/driver/cursorid/tostring.xml deleted file mode 100644 index 007fcf2294..0000000000 --- a/reference/mongodb/mongodb/driver/cursorid/tostring.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - MongoDB\Driver\CursorId::__toString - Représentation sous forme de chaîne de l'ID de curseur - - - - &reftitle.description; - - final public stringMongoDB\Driver\CursorId::__toString - - - - Retourne la représentation sous forme de &string; de l'ID de curseur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la représentation sous forme de &string; de l'ID de curseur. - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\CursorId::__toString</function> - - 2]); - -$bulk = new MongoDB\Driver\BulkWrite; -$bulk->insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$cursor = $manager->executeQuery('db.collection', $query); -var_dump((string) $cursor->getId()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getId - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface.xml b/reference/mongodb/mongodb/driver/cursorinterface.xml deleted file mode 100644 index 733b3f3ff8..0000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - L'interface MongoDB\Driver\CursorInterface - MongoDB\Driver\CursorInterface - - - - -
    - &reftitle.intro; - - Cette interface est implémentée par - MongoDB\Driver\Cursor pour être utilisée comme - type de paramètre, de retour ou de propriété dans les classes utilisateur. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\CursorInterface - - - - - MongoDB\Driver\CursorInterface - - - - Iterator - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - Cette interface étend désormais Iterator. - - - Les types de retour précédemment déclarés comme étant tentatifs sont désormais appliqués. - - - - &mongodb.changelog.tentative-return-types; - - - -
    - -     - - &reference.mongodb.mongodb.driver.entities.cursorinterface; - -     - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/getid.xml b/reference/mongodb/mongodb/driver/cursorinterface/getid.xml deleted file mode 100644 index f9461d7b4d..0000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/getid.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::getId - Renvoie l'ID du curseur - - - - &reftitle.description; - - abstract public MongoDB\BSON\Int64MongoDB\Driver\CursorInterface::getId - - - - Renvoie l'ID de ce curseur, qui identifie de manière unique le curseur sur le - serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'ID de ce curseur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Ajout de MongoDB\BSON\Int64 au type de retour - provisoire pour cette méthode. MongoDB\Driver\CursorId - sera supprimé du type de retour dans la version 2.0. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getId - MongoDB\Driver\CursorId - MongoDB\BSON\Int64 - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/getserver.xml b/reference/mongodb/mongodb/driver/cursorinterface/getserver.xml deleted file mode 100644 index 296732f147..0000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/getserver.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::getServer - Renvoie le serveur associé à ce curseur - - - - &reftitle.description; - - abstract public MongoDB\Driver\ServerMongoDB\Driver\CursorInterface::getServer - - - - Renvoie le MongoDB\Driver\Server associé à ce - curseur. C'est le serveur qui a exécuté la - MongoDB\Driver\Query ou - MongoDB\Driver\Command. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le MongoDB\Driver\Server pour ce - curseur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getServer - MongoDB\Driver\Server - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/isdead.xml b/reference/mongodb/mongodb/driver/cursorinterface/isdead.xml deleted file mode 100644 index 455bbb254c..0000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/isdead.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::isDead - Renvoie si le curseur peut avoir des résultats supplémentaires - - - - &reftitle.description; - - abstract public boolMongoDB\Driver\CursorInterface::isDead - - - - Vérifie si le curseur peut avoir des résultats supplémentaires à lire. Un - curseur est initialement "vivant" mais peut devenir "mort" pour l'une des - raisons suivantes : - - Avancer un curseur non-tailable n'a pas renvoyé de document - Le curseur a rencontré une erreur - Le curseur a lu son dernier lot jusqu'à la fin - Le curseur a atteint sa limite configurée - - C'est principalement utile avec les curseurs tailables. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si des résultats supplémentaires ne sont pas disponibles, et &false; - sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::isDead - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/settypemap.xml b/reference/mongodb/mongodb/driver/cursorinterface/settypemap.xml deleted file mode 100644 index d577f13ea9..0000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/settypemap.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::setTypeMap - Définit une carte de type à utiliser pour la désérialisation BSON - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\CursorInterface::setTypeMap - arraytypemap - - - Définit la configuration - type map à utiliser lors de la désérialisation des résultats BSON en - valeurs PHP. - - - - - &reftitle.parameters; - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::setTypeMap - - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/toarray.xml b/reference/mongodb/mongodb/driver/cursorinterface/toarray.xml deleted file mode 100644 index ae6827217e..0000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/toarray.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::toArray - Renvoie un tableau contenant tous les résultats de ce curseur - - - - &reftitle.description; - - abstract public arrayMongoDB\Driver\CursorInterface::toArray - - - - Itère le curseur et renvoie ses résultats dans un tableau. - MongoDB\Driver\CursorInterface::setTypeMap peut être utilisé - pour contrôler comment les documents sont désérialisés en valeurs PHP. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un array contenant tous les résultats de ce curseur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::toArray - MongoDB\Driver\CursorInterface::setTypeMap - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/authenticationexception.xml b/reference/mongodb/mongodb/driver/exception/authenticationexception.xml deleted file mode 100644 index fe91eebab3..0000000000 --- a/reference/mongodb/mongodb/driver/exception/authenticationexception.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - La classe MongoDB\Driver\Exception\AuthenticationException - MongoDB\Driver\Exception\AuthenticationException - - - - -
    - &reftitle.intro; - - Levée lorsque le pilote ne parvient pas à s'authentifier auprès du serveur. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\AuthenticationException - - - - - MongoDB\Driver\Exception\AuthenticationException - - - - extends - MongoDB\Driver\Exception\ConnectionException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - - - - -
    - -     - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception.xml deleted file mode 100644 index 15524f8c31..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - La classe MongoDB\Driver\Exception\BulkWriteCommandException - MongoDB\Driver\Exception\BulkWriteCommandException - - - - -
    - &reftitle.intro; - - Exception lancée lors de l'exécution échouée d'une - MongoDB\Driver\BulkWriteCommand. Les méthodes de la - classe apportent plus de détails sur les erreurs qui se sont produites, incluant les erreurs - de réponse et les résultats partiels de l'écriture en masse. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\BulkWriteCommandException - - - - - MongoDB\Driver\Exception\BulkWriteCommandException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - private - MongoDB\BSON\Documentnull - errorReply - - - private - MongoDB\Driver\BulkWriteCommandResultnull - partialResult - - - private - array - writeConcernErrors - - - private - array - writeErrors - - - &InheritedProperties; - - - - - - &Methods; - - - &InheritedMethods; - - - - - - - -
    - - -
    - &reftitle.properties; - - - errorReply - - - Chacune des erreurs du plus haut niveau qui ont eu lieu lors de l'essai de la communication - avec le serveur ou de l'exécution de l'écriture en masse. Cette valeur peut être &null; si - l'exception a été lancée à cause d'erreurs survenant lors d'écritures individuelles. - - - - - partialResult - - - Une MongoDB\Driver\BulkWriteCommandResult apporte - le résultat de toutes les opérations qui ont été effectuées avant - l'erreur. Cette valeur peut être &null; s'il ne peut pas être - déterminé qu'au moins une écriture a été effectuée avec succès (et - reconnue). - - - - - writeConcernErrors - - - Un tableau de chacun des MongoDB\Driver\WriteConcernErrors - qui se sont produits lors de l'exécution de l'écriture en masse. Cette liste peut avoir - plusieurs entrées si plus d'une commande serveur a été requise pour exécuter - l'écriture en masse. - - - - - writeErrors - - - Un tableau de chacun des MongoDB\Driver\WriteErrors - qui se sont produits lors de l'exécution de l'écriture individuelle. Les clés - de tableau correspondent à l'index de l'opération d'écriture de - MongoDB\Driver\BulkWriteCommand. Cette liste va - contenir au plus une entrée si l'écriture en masse était ordonnée. - - - - -
    - - -     - - &reference.mongodb.mongodb.driver.exception.entities.bulkwritecommandexception; - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/geterrorreply.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/geterrorreply.xml deleted file mode 100644 index 4162e98989..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/geterrorreply.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - MongoDB\Driver\Exception\BulkWriteCommandException::getErrorReply - Renvoie une erreur de commande de niveau supérieur - - - - &reftitle.description; - - final public MongoDB\BSON\DocumentnullMongoDB\Driver\Exception\BulkWriteCommandException::getErrorReply - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une erreur de commande de niveau supérieur qui s'est produite lors de l'essai de communication - avec le serveur ou d'exécution de l'écriture en masse. Cette valeur peut être &null; si l'exception - a été lancée en raison d'erreurs survenant sur des écritures individuelles. - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\Exception\BulkWriteCommandException::getErrorReply</function> - -executeCommand('admin', new MongoDB\Driver\Command([ - 'configureFailPoint' => 'failCommand', - 'mode' => ['times' => 1], - 'data' => [ - 'failCommands' => ['bulkWrite'], - 'errorCode' => 8, /* UnknownError */ - ], -])); - -$bulk = new MongoDB\Driver\BulkWriteCommand; -$bulk->insertOne('db.coll', ['x' => 1]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - var_dump($e->getErrorReply()?->toPHP()); -} - -?> -]]> - - &example.outputs.similar; - - - float(0) - ["errmsg"]=> - string(43) "Failing command via 'failCommand' failpoint" - ["code"]=> - int(8) - ["codeName"]=> - string(12) "UnknownError" - ["$clusterTime"]=> - object(stdClass)#10 (2) { - ["clusterTime"]=> - object(MongoDB\BSON\Timestamp)#6 (2) { - ["increment"]=> - string(1) "7" - ["timestamp"]=> - string(10) "1744319389" - } - ["signature"]=> - object(stdClass)#9 (2) { - ["hash"]=> - object(MongoDB\BSON\Binary)#7 (2) { - ["data"]=> - string(20) "" - ["type"]=> - int(0) - } - ["keyId"]=> - object(MongoDB\BSON\Int64)#8 (1) { - ["integer"]=> - string(1) "0" - } - } - } - ["operationTime"]=> - object(MongoDB\BSON\Timestamp)#11 (2) { - ["increment"]=> - string(1) "7" - ["timestamp"]=> - string(10) "1744319389" - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getpartialresult.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getpartialresult.xml deleted file mode 100644 index 85a4a68982..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getpartialresult.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - MongoDB\Driver\Exception\BulkWriteCommandException::getPartialResult - Renvoie le résultat de toutes les opérations d'écriture réussies - - - - &reftitle.description; - - final public MongoDB\Driver\BulkWriteCommandResultnullMongoDB\Driver\Exception\BulkWriteCommandException::getPartialResult - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un MongoDB\Driver\BulkWriteCommandResult - apportant les résultats de chacune des opérations réussies qui ont été faites avant - que l'erreur ne soit rencontrée. La valeur retournée sera &null; si on ne peut - pas déterminer si au moins une écriture a été effectuée avec succès (et - reconnue). - - - - - &reftitle.examples; - - Résultat partiel si au moins une écriture est réussie - -deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 1]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - $result = $e->getPartialResult(); -} - -var_dump($result?->getInsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - Aucun résultat partiel si aucune écriture n'est réussie - -deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$manager->executeBulkWriteCommand($bulk); - -$bulk = new MongoDB\Driver\BulkWriteCommand; -$bulk->insertOne('db.coll', ['_id' => 1]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - $result = $e->getPartialResult(); -} - -var_dump($result?->getInsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\Manager::executeBulkWriteCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml deleted file mode 100644 index cab4b2c653..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - MongoDB\Driver\Exception\BulkWriteCommandException::getWriteConcernErrors - Renvoie les erreurs de write concern - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Exception\BulkWriteCommandException::getWriteConcernErrors - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau de chacun des MongoDB\Driver\WriteConcernErrors - qui se sont produits lors de l'exécution de l'écriture en masse. Cette liste peut avoir - plusieurs entrées si plus d'une commande de serveur était nécessaire pour exécuter l'écriture - en masse. - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\Exception\BulkWriteCommandException::getWriteConcernErrors</function> - -insertOne('db.coll', ['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(50); - -try { - $result = $manager->executeBulkWriteCommand($bulk, ['writeConcern' => $writeConcern]); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - var_dump($e->getWriteConcernErrors()); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteConcernError)#6 (3) { - ["message"]=> - string(29) "Not enough data-bearing nodes" - ["code"]=> - int(100) - ["info"]=> - object(stdClass)#8 (1) { - ["writeConcern"]=> - object(stdClass)#7 (3) { - ["w"]=> - int(50) - ["wtimeout"]=> - int(0) - ["provenance"]=> - string(14) "clientSupplied" - } - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcernError - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml deleted file mode 100644 index 7103cf1f88..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - MongoDB\Driver\Exception\BulkWriteCommandException::getWriteErrors - Renvoie les erreurs d'écriture - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Exception\BulkWriteCommandException::getWriteErrors - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau de MongoDB\Driver\WriteErrors qui se - sont produits lors de l'exécution de l'écriture individuelle. Les clés de tableau - correspondent à l'index de l'opération d'écriture dans - MongoDB\Driver\BulkWriteCommand. Cette liste - contiendra au plus une entrée si l'écriture en masse était ordonnée. - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\Exception\BulkWriteCommandException::getWriteErrors</function> - - false]); -$bulk->deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 1]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - var_dump($e->getWriteErrors()); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(78) "E11000 duplicate key error collection: db.coll index: _id_ dup key: { _id: 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(2) - ["info"]=> - object(stdClass)#6 (0) { - } - } - [3]=> - object(MongoDB\Driver\WriteError)#7 (4) { - ["message"]=> - string(78) "E11000 duplicate key error collection: db.coll index: _id_ dup key: { _id: 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(3) - ["info"]=> - object(stdClass)#8 (0) { - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\WriteError - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml b/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml deleted file mode 100644 index e50029a609..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - La classe MongoDB\Driver\Exception\BulkWriteException - MongoDB\Driver\Exception\BulkWriteException - - - - -
    - &reftitle.intro; - - Levée lorsqu'une opération d'écriture en bloc échoue. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\BulkWriteException - - - - - MongoDB\Driver\Exception\BulkWriteException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - public - readonly - MongoDB\Driver\WriteResult - writeResult - - &InheritedProperties; - - - - - - &Methods; - - - &InheritedMethods; - - - - - - - - -
    - - -
    - &reftitle.properties; - - - writeResult - - - Le MongoDB\Driver\WriteResult associé à l'opération d'écriture - échouée. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - - La propriété writeResult est désormais - public readonly. - - - - - PECL mongodb 2.0.0 - - - Cette classe étend désormais - MongoDB\Driver\Exception\ServerException - au lieu de - MongoDB\Driver\Exception\WriteException. - - - - - - -
    - -     - &reference.mongodb.mongodb.driver.exception.entities.bulkwriteexception; - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwriteexception/getwriteresult.xml b/reference/mongodb/mongodb/driver/exception/bulkwriteexception/getwriteresult.xml deleted file mode 100644 index 7cd237970b..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwriteexception/getwriteresult.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - MongoDB\Driver\Exception\BulkWriteException::getWriteResult - Renvoie le WriteResult pour l'opération d'écriture échouée - - - - &reftitle.description; - - final public MongoDB\Driver\WriteResultMongoDB\Driver\Exception\BulkWriteException::getWriteResult - - - - Renvoie le MongoDB\Driver\WriteResult pour l'opération - d'écriture échouée. Les méthodes - MongoDB\Driver\WriteResult::getWriteErrors et - MongoDB\Driver\WriteResult::getWriteConcernError - peuvent être utilisées pour obtenir des détails supplémentaires sur l'erreur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le MongoDB\Driver\WriteResult pour l'opération - d'écriture échouée. - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\Exception\BulkWriteException::getWriteResult</function> - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - $writeResult = $e->getWriteResult(); - - if ($writeConcernError = $writeResult->getWriteConcernError()) { - var_dump($writeConcernError); - } - - if ($writeErrors = $writeResult->getWriteErrors()) { - var_dump($writeErrors); - } -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(70) "E11000 duplicate key error index: db.collection.$_id_ dup key: { : 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(1) - ["info"]=> - NULL - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult - MongoDB\Driver\Manager::executeBulkWrite - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/commandexception.xml b/reference/mongodb/mongodb/driver/exception/commandexception.xml deleted file mode 100644 index 68b7655af4..0000000000 --- a/reference/mongodb/mongodb/driver/exception/commandexception.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - La classe MongoDB\Driver\Exception\CommandException - MongoDB\Driver\Exception\CommandException - - - - -
    - &reftitle.intro; - - Lancée lorsqu'une commande échoue. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\CommandException - - - - - MongoDB\Driver\Exception\CommandException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - public - readonly - object - resultDocument - - - &InheritedProperties; - - - - - - &Methods; - - - &InheritedMethods; - - - - - - - - -
    - - - -
    - &reftitle.properties; - - - resultDocument - - - Le document résultant associé à la commande échouée. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - - La propriété resultDocument est désormais - public readonly. - - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.exception.entities.commandexception; - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/commandexception/getresultdocument.xml b/reference/mongodb/mongodb/driver/exception/commandexception/getresultdocument.xml deleted file mode 100644 index a6543cba6e..0000000000 --- a/reference/mongodb/mongodb/driver/exception/commandexception/getresultdocument.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - MongoDB\Driver\Exception\CommandException::getResultDocument - Retourne le document résultant pour la commande échouée - - - - &reftitle.description; - - final public objectMongoDB\Driver\Exception\CommandException::getResultDocument - - - - Retourne le document résultant pour la commande échouée. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le document résultant pour la commande échouée. - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/connectionexception.xml b/reference/mongodb/mongodb/driver/exception/connectionexception.xml deleted file mode 100644 index 6b37474f5a..0000000000 --- a/reference/mongodb/mongodb/driver/exception/connectionexception.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - La classe MongoDB\Driver\Exception\ConnectionException - MongoDB\Driver\Exception\ConnectionException - - - - -
    - &reftitle.intro; - - Classe de base pour les exceptions levées lorsque le pilote ne parvient pas - à établir une connexion de base de données. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\ConnectionException - - - - - MongoDB\Driver\Exception\ConnectionException - - - - extends - MongoDB\Driver\Exception\RuntimeException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - - -
    - -     - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/connectiontimeoutexception.xml b/reference/mongodb/mongodb/driver/exception/connectiontimeoutexception.xml deleted file mode 100644 index 26ae235402..0000000000 --- a/reference/mongodb/mongodb/driver/exception/connectiontimeoutexception.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - La classe MongoDB\Driver\Exception\ConnectionTimeoutException - MongoDB\Driver\Exception\ConnectionTimeoutException - - - - -
    - &reftitle.intro; - - Lancée lorsque le pilote échoue à établir une connexion à la base de données - dans un délai spécifié - (connectTimeoutMS) - ou lorsque la sélection du serveur échoue - (serverSelectionTimeoutMS). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\ConnectionTimeoutException - - - - final - - MongoDB\Driver\Exception\ConnectionTimeoutException - - - - extends - MongoDB\Driver\Exception\ConnectionException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - - - - -
    - -     - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/encryptionexception.xml b/reference/mongodb/mongodb/driver/exception/encryptionexception.xml deleted file mode 100644 index a726dd366d..0000000000 --- a/reference/mongodb/mongodb/driver/exception/encryptionexception.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - La classe MongoDB\Driver\Exception\EncryptionException - MongoDB\Driver\Exception\EncryptionException - - - - -
    - &reftitle.intro; - - La classe de base pour les exceptions lancées lors du chiffrement côté client. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\EncryptionException - - - - - MongoDB\Driver\Exception\EncryptionException - - - - extends - MongoDB\Driver\Exception\RuntimeException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - - -
    - -     - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/exception.xml b/reference/mongodb/mongodb/driver/exception/exception.xml deleted file mode 100644 index 6e09bbc031..0000000000 --- a/reference/mongodb/mongodb/driver/exception/exception.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - L'interface MongoDB\Driver\Exception\Exception - MongoDB\Driver\Exception\Exception - - - - -
    - &reftitle.intro; - - Interface commune pour toutes les exceptions de l'extension. Cette interface est également utilisée - par la bibliothèque, et peut être utilisée pour identifier toute exception provenant - du pilote PHP de MongoDB (c'est-à-dire l'extension et la bibliothèque). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\Exception - - - - - MongoDB\Driver\Exception\Exception - - - - - - - -
    - -     - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml b/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml deleted file mode 100644 index c7b178553a..0000000000 --- a/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - La classe MongoDB\Driver\Exception\ExecutionTimeoutException - MongoDB\Driver\Exception\ExecutionTimeoutException - - - - -
    - &reftitle.intro; - - Lancée lorsqu'une requête ou une commande échoue à se terminer dans un - délai spécifié (par exemple - maxTimeMS). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\ExecutionTimeoutException - - - - final - - MongoDB\Driver\Exception\ExecutionTimeoutException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.5.0 - - - Cette classe étend maintenant - MongoDB\Driver\Exception\ServerException - à la place de - MongoDB\Driver\Exception\RuntimeException. - - - - - - -
    - -     - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/invalidargumentexception.xml b/reference/mongodb/mongodb/driver/exception/invalidargumentexception.xml deleted file mode 100644 index 70f2bc2c35..0000000000 --- a/reference/mongodb/mongodb/driver/exception/invalidargumentexception.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - La classe MongoDB\Driver\Exception\InvalidArgumentException - MongoDB\Driver\Exception\InvalidArgumentException - - - - -
    - &reftitle.intro; - - Levée lorsqu'une méthode de pilote reçoit des arguments non valides (par - exemple, des types d'options non valides). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\InvalidArgumentException - - - - - MongoDB\Driver\Exception\InvalidArgumentException - - - - extends - InvalidArgumentException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -     - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/logicexception.xml b/reference/mongodb/mongodb/driver/exception/logicexception.xml deleted file mode 100644 index 31c7387c50..0000000000 --- a/reference/mongodb/mongodb/driver/exception/logicexception.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - La classe MongoDB\Driver\Exception\LogicException - MongoDB\Driver\Exception\LogicException - - - - -
    - &reftitle.intro; - - Lancée lorsque le pilote est incorrectement utilisé (par exemple, rembobiner un curseur). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\LogicException - - - - - MongoDB\Driver\Exception\LogicException - - - - extends - LogicException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -     - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/runtimeexception.xml b/reference/mongodb/mongodb/driver/exception/runtimeexception.xml deleted file mode 100644 index 0835358c97..0000000000 --- a/reference/mongodb/mongodb/driver/exception/runtimeexception.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - - La classe MongoDB\Driver\Exception\RuntimeException - MongoDB\Driver\Exception\RuntimeException - - - - -
    - &reftitle.intro; - - Levée lorsque le pilote rencontre une erreur d'exécution (par exemple, erreur interne de libmongoc). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\RuntimeException - - - - - MongoDB\Driver\Exception\RuntimeException - - - - extends - RuntimeException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - protected - arraynull - errorLabels - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -
    - &reftitle.properties; - - - errorLabels - - - Contient un tableau d'étiquettes d'erreur à parcourir avec une exception. - Par exemple, les étiquettes d'erreur peuvent être utilisées pour détecter - si une transaction peut être réessayée en toute sécurité si l'étiquette - TransientTransactionError est présente. L'existence - d'une étiquette d'erreur spécifique doit être testée avec - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel, - au lieu d'interpréter manuellement la propriété - errorLabels. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.6.0 - - - La méthode - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel - et la propriété - MongoDB\Driver\Exception\RuntimeException::errorLabels - ont été ajoutées. - - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.exception.entities.runtimeexception; - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/runtimeexception/haserrorlabel.xml b/reference/mongodb/mongodb/driver/exception/runtimeexception/haserrorlabel.xml deleted file mode 100644 index b0bdfefb49..0000000000 --- a/reference/mongodb/mongodb/driver/exception/runtimeexception/haserrorlabel.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel - Retourne si un label d'erreur est associé avec une exception - - - - &reftitle.description; - - final public boolMongoDB\Driver\Exception\RuntimeException::hasErrorLabel - stringerrorLabel - - - Retourne si le errorLabel a été défini pour cette exception. - Les labels d'erreurs sont définis soit par le serveur soit par l'extension pour - indiquer des situations spécifiques où on voudrait décider comment on gèrera - une exception spécifique. Une situation commune serait de déterminer si l'on peut - relancer une transaction qui a échoué à cause d'une erreur passagère - (telle qu'une erreur de réseau, ou un conflit de transaction) sans encombre. - Des exemples de labels d'erreurs sont TransientTransactionError - et UnknownTransactionCommitResult. - - - - - - &reftitle.parameters; - - - errorLabel - - Le nom de l'errorLabel à vérifier. - - - - - - - &reftitle.returnvalues; - - Si le errorLabel fourni est associé avec cette - exception. - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::commitTransaction - Documentation MongoDB sur les transactions - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/serverexception.xml b/reference/mongodb/mongodb/driver/exception/serverexception.xml deleted file mode 100644 index 95cd6f9702..0000000000 --- a/reference/mongodb/mongodb/driver/exception/serverexception.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - La classe MongoDB\Driver\Exception\ServerException - MongoDB\Driver\Exception\ServerException - - - - -
    - &reftitle.intro; - - La classe de base pour les exceptions lancées par le serveur. Le code de cette exception et de ses sous-classes correspondra au code d'erreur d'origine du serveur. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\ServerException - - - - - MongoDB\Driver\Exception\ServerException - - - - extends - MongoDB\Driver\Exception\RuntimeException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - - -
    - -     - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml b/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml deleted file mode 100644 index 74b3def6fe..0000000000 --- a/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - La classe MongoDB\Driver\Exception\SSLConnectionException - MongoDB\Driver\Exception\SSLConnectionException - - - - - - Cette classe d'exception est DÉPRÉCIÉE depuis la version 1.5.0 de l'extension - et a été supprimée dans la version 2.0. Cette exception n'a jamais été lancée par l'extension. - Les applications devraient utiliser MongoDB\Driver\Exception\ConnectionException - à la place. - - - - -
    - &reftitle.intro; - - Levée lorsque le pilote ne parvient pas à établir une connexion SSL avec - le serveur. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\SSLConnectionException - - - - final - - MongoDB\Driver\Exception\SSLConnectionException - - - - extends - MongoDB\Driver\Exception\ConnectionException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - - - - -
    - -     - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/unexpectedvalueexception.xml b/reference/mongodb/mongodb/driver/exception/unexpectedvalueexception.xml deleted file mode 100644 index 135fa367b1..0000000000 --- a/reference/mongodb/mongodb/driver/exception/unexpectedvalueexception.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - La classe MongoDB\Driver\Exception\UnexpectedValueException - MongoDB\Driver\Exception\UnexpectedValueException - - - - -
    - &reftitle.intro; - - Lancée lorsque le pilote rencontre une valeur inattendue (par exemple lors de la sérialisation - ou de la désérialisation BSON). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\UnexpectedValueException - - - - - MongoDB\Driver\Exception\UnexpectedValueException - - - - extends - UnexpectedValueException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -     - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/writeexception.xml b/reference/mongodb/mongodb/driver/exception/writeexception.xml deleted file mode 100644 index b4bcd336bb..0000000000 --- a/reference/mongodb/mongodb/driver/exception/writeexception.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - La classe MongoDB\Driver\Exception\WriteException - MongoDB\Driver\Exception\WriteException - - - - - - Cette classe d'exception est DÉPRÉCIÉE depuis la version 1.20.0 de l'extension - et a été supprimée dans la version 2.0. - Cette exception n'a jamais été directement lancée par l'extension. - Les applications devraient utiliser MongoDB\Driver\Exception\BulkWriteException - à la place. - - - - -
    - &reftitle.intro; - - Classe de base pour les exceptions levées par une opération d'écriture - défaillante. L'exception encapsule un objet MongoDB\Driver\WriteResult . - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\WriteException - - - - - abstract - MongoDB\Driver\Exception\WriteException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - protected - MongoDB\Driver\WriteResult - writeResult - - - &InheritedProperties; - - - - - - &Methods; - - - &InheritedMethods; - - - - - - - - -
    - - - -
    - &reftitle.properties; - - - writeResult - - - MongoDB\Driver\WriteResult associé à l'opération - d'écriture défaillante. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.class-removed; - - PECL mongodb 1.20.0 - - Cette classe a été dépréciée et sera supprimée dans la version 2.0. - - - - PECL mongodb 1.5.0 - - - Cette classe étend maintenant - MongoDB\Driver\Exception\ServerException - à la place de - MongoDB\Driver\Exception\RuntimeException. - - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.exception.entities.writeexception; - -     - - diff --git a/reference/mongodb/mongodb/driver/exception/writeexception/getwriteresult.xml b/reference/mongodb/mongodb/driver/exception/writeexception/getwriteresult.xml deleted file mode 100644 index c57a9a0d87..0000000000 --- a/reference/mongodb/mongodb/driver/exception/writeexception/getwriteresult.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - MongoDB\Driver\Exception\WriteException::getWriteResult - Retourne le WriteResult pour l'opération d'écriture qui a échoué - - - - &reftitle.description; - - final public MongoDB\Driver\WriteResultMongoDB\Driver\Exception\WriteException::getWriteResult - - - - Retourne le MongoDB\Driver\WriteResult pour l'opération d'écriture - qui a échoué. Les méthodes - MongoDB\Driver\WriteResult::getWriteErrors et - MongoDB\Driver\WriteResult::getWriteConcernError - peuvent être utilisées pour récupérer plus de détails à propos de l'échec. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le MongoDB\Driver\WriteResult pour l'opération d'écriture - qui a échoué. - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\Exception\WriteException::getWriteResult</function> - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch (MongoDB\Driver\Exception\WriteException $e) { - $writeResult = $e->getWriteResult(); - - if ($writeConcernError = $writeResult->getWriteConcernError()) { - var_dump($writeConcernError); - } - - if ($writeErrors = $writeResult->getWriteErrors()) { - var_dump($writeErrors); - } -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(70) "E11000 duplicate key error index: db.collection.$_id_ dup key: { : 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(1) - ["info"]=> - NULL - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult - MongoDB\Driver\Manager::executeBulkWrite - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager.xml b/reference/mongodb/mongodb/driver/manager.xml deleted file mode 100644 index 5f3a91d3d2..0000000000 --- a/reference/mongodb/mongodb/driver/manager.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - La classe MongoDB\Driver\Manager - MongoDB\Driver\Manager - - - - -
    - &reftitle.intro; - - Le MongoDB\Driver\Manager est le point d'entrée - principal de l'extension. Il est responsable de maintenir les connexions à MongoDB - (qu'il s'agisse d'un serveur autonome, d'un ensemble de réplicas ou d'un cluster partagé). - - - Aucune connexion à MongoDB n'est établie lors de l'instanciation du Manager. - Cela signifie que la MongoDB\Driver\Manager peut toujours être - construit, même si un ou plusieurs serveurs MongoDB sont hors service. - - - Toute écriture ou requête peut lancer des exceptions de connexion car les connexions sont créées de manière paresseuse. - Un serveur MongoDB peut également devenir indisponible pendant la durée de vie du script. - Il est donc important que toutes les actions sur le Manager soient enveloppées dans des instructions try/catch. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Manager - - - - final - - MongoDB\Driver\Manager - - - - - &Methods; - - - - -
    - -
    - &reftitle.examples; - - - Usage basique de <function>MongoDB\Driver\Manager::__construct</function> - - var_dumper un - MongoDB\Driver\Manager affichera divers - détails sur le Manager qui ne sont pas normalement exposés. - Cela peut être utile pour déboguer comment le pilote voit la configuration MongoDB, et - quelles options sont utilisées. - - - -]]> - - &example.outputs.similar; - - - string(26) "mongodb://127.0.0.1:27017/" - ["cluster"]=> - array(0) { - } -} -]]> - - -
    -     - - &reference.mongodb.mongodb.driver.entities.manager; - -     - - diff --git a/reference/mongodb/mongodb/driver/manager/addsubscriber.xml b/reference/mongodb/mongodb/driver/manager/addsubscriber.xml deleted file mode 100644 index 3c75d3afaf..0000000000 --- a/reference/mongodb/mongodb/driver/manager/addsubscriber.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - MongoDB\Driver\Manager::addSubscriber - Enregistre un observateur d'événements de surveillance avec ce manager - - - - &reftitle.description; - - final public voidMongoDB\Driver\Manager::addSubscriber - MongoDB\Driver\Monitoring\Subscribersubscriber - - - Enregistre un observateur d'événements de surveillance avec ce Manager. L'observateur - sera notifié de tous les événements pour ce Manager. - - - - Si subscriber est déjà enregistré avec ce manager, cette - fonction ne fait rien. Si subscriber est également - enregistré globalement, il ne sera notifié qu'une seule fois de chaque événement - pour ce manager. - - - - - - &reftitle.parameters; - - - subscriber (MongoDB\Driver\Monitoring\Subscriber) - - - Un observateur d'événements de surveillance à enregistrer avec ce Manager. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - Lance une - MongoDB\Driver\Exception\InvalidArgumentException si - subscriber est un - MongoDB\Driver\Monitoring\LogSubscriber, car les - observateurs ne peuvent être enregistrés que globalement. - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::removeSubscriber - MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Monitoring\addSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/construct.xml b/reference/mongodb/mongodb/driver/manager/construct.xml deleted file mode 100644 index 687b45d730..0000000000 --- a/reference/mongodb/mongodb/driver/manager/construct.xml +++ /dev/null @@ -1,1292 +0,0 @@ - - - - - MongoDB\Driver\Manager::__construct - Crée un nouveau Manager MongoDB - - - - &reftitle.description; - - final public MongoDB\Driver\Manager::__construct - stringnulluri&null; - arraynulluriOptions&null; - arraynulldriverOptions&null; - - - Construit un nouvel objet MongoDB\Driver\Manager avec les options spécifiées. - - - - Avec la Spécification de découverte et de surveillance du serveur, - ce constructeur n'effectue pas d'E/S. Les connexions seront initialisées à la demande, - lors de l'exécution de la première opération. - - - - - Lorsque des options d'URI SSL ou TLS sont spécifiées via la chaîne de connexion ou le - paramètre uriOptions, l'extension activera implicitement TLS pour ses connexions. - Pour éviter cela, désactivez explicitement l'option - tls ou ne spécifiez aucune option TLS. - - - &mongodb.note.forking; - - - - &reftitle.parameters; - - - uri - - Une URI de connexion mongodb://: - - - - - Par défaut, "mongodb://127.0.0.1:27017" si non spécifié. - - - Pour les détails sur les options d'URI prises en charge, voir - Options de chaîne de connexion - dans le manuel MongoDB. - Options de pool de connexions - ne sont pas prises en charge, car l'extension n'implémente pas de pools de connexions. - - - L'uri est une URL, donc tous les caractères spéciaux dans - ses composants doivent être encodés en URL selon la - RFC 3986. Cela est particulièrement - pertinent pour le nom d'utilisateur et le mot de passe, qui peuvent souvent inclure des caractères spéciaux tels que - @, : ou %. - Lors de la connexion via un socket de domaine Unix, le chemin du socket - peut contenir des caractères spéciaux tels que des barres obliques et doit être encodé. - La fonction rawurlencode peut être utilisée pour encoder - les parties constitutives de l'URI. - - - Le composant defaultAuthDb peut être utilisé pour spécifier la - base de données associée aux informations d'identification de l'utilisateur; cependant, l'option d'URI - authSource aura la priorité si elle est spécifiée. - Si ni defaultAuthDb ni authSource ne sont spécifiés, la base de données - admin sera utilisée par défaut. Le composant defaultAuthDb - n'a aucun effet en l'absence d'informations d'identification utilisateur. - - - - - uriOptions - - - Options supplémentaires - de chaîne de connexion, - qui écraseront toute option portant le même nom dans le paramètre - uri. - - - - uriOptions - - - - Option - Type - Description - - - - - appname - string - - - MongoDB 3.4+ a la capacité d'annoter les connexions avec des métadonnées - fournies par le client connecté. Ces métadonnées sont incluses dans les - journaux du serveur lors de l'établissement d'une connexion et également enregistrées dans - les journaux de requêtes lentes lorsque le profilage de la base de données est activé. - - - Cette option peut être utilisée pour spécifier un nom d'application, qui sera - inclus dans les métadonnées. La valeur ne peut pas dépasser 128 caractères - de longueur. - - - - - authMechanism - string - - - Le mécanisme d'authentification que MongoDB utilisera pour authentifier - la connexion. Pour plus de détails et une liste des valeurs prises en charge, voir - Options d'authentification - dans le manuel MongoDB. - - - - - authMechanismProperties - array - - - Les propriétés spécifiques au mécanisme d'authentification sélectionné. Pour plus - de détails et une liste des propriétés prises en charge, voir la - Spécification d'authentification du pilote. - - - - Lorsque non spécifiée dans la chaîne d'URI, cette option est exprimée comme - un tableau de paires clé/valeur. Les clés et valeurs de ce tableau - doivent être des chaînes. - - - - - - authSource - string - - - Le nom de la base de données associée aux informations d'identification de l'utilisateur. Par défaut - au composant de la base de données de l'URI de connexion, ou à la base de données - admin si les deux sont non spécifiés. - - - Pour les mécanismes d'authentification qui ne prennent pas en charge la notion de base de données - (e.g. GSSAPI), cela devrait être - "$external". - - - - - compressors - string - - - Une liste priorisée et délimitée par des virgules de compresseurs que le client - souhaite utiliser. Les messages ne sont compressés que si le client et le serveur - partagent des compresseurs en commun, et le compresseur utilisé dans chaque - direction dépendra de la configuration individuelle du serveur - ou du pilote. Voir la - Spécification de compression de pilote - pour plus d'informations. - - - - - connectTimeoutMS - int - - - Le temps en millisecondes pour tenter une connexion avant d'expirer. - Par défaut à 10 000 millisecondes. - - - - - directConnection - bool - - - Cette option peut être utilisée pour contrôler le comportement de découverte de l'ensemble de réplicas - lorsqu'un seul hôte est fourni dans la chaîne de connexion. - Par défaut, fournir un seul membre dans la chaîne de connexion - établira une connexion directe ou découvrira des membres supplémentaires - selon que l'option d'URI "replicaSet" est omise ou présente, - respectivement. Spécifier &false; pour forcer la découverte à se produire - (si "replicaSet" est omis) - ou spécifiez &true; pour forcer une connexion directe (si - "replicaSet" est présent). - - - - - enableOverloadRetargeting - bool - - - Lorsque définie à &true;, force la sélection du serveur après une - SystemOverloadedError. Par défaut à &false;. - - - - - heartbeatFrequencyMS - int - - - Spécifie l'intervalle en millisecondes entre les vérifications de la topologie MongoDB, - compté de la fin de la vérification précédente jusqu'au début de la suivante. - Par défaut à 60 000 millisecondes. - - - Pour la - Spécification de découverte et de surveillance du serveur, - cette valeur ne peut pas être inférieure à 500 millisecondes. - - - - - journal - bool - - - Correspond à l'option journal du write concern par défaut. - Si &true;, les écritures nécessiteront un accusé de réception de MongoDB indiquant que l'opération a été - écrite dans le journal. Pour plus de détails, voir - MongoDB\Driver\WriteConcern. - - - - - loadBalanced - bool - - - Spécifie si le pilote se connecte à un cluster MongoDB via - un équilibreur de charge. Si &true;, le pilote ne peut se connecter qu'à - un seul hôte (spécifié par la chaîne de connexion ou la recherche SRV), - l'option d'URI "directConnection" ne peut - pas être &true;, et l'option d'URI "replicaSet" - doit être omise. Par défaut à &false;. - - - - - localThresholdMS - int - - - La taille en millisecondes de la fenêtre de latence pour la sélection parmi - plusieurs instances MongoDB appropriées lors de la résolution d'une préférence de lecture. - Par défaut à 15 millisecondes. - - - - - maxAdaptiveRetries - int - - - Cette option peut être utilisée pour modifier le nombre maximum de tentatives - lorsqu'une SystemOverloadedError se produit. Doit être un - entier positif; par défaut à 2. - - - - - maxStalenessSeconds - int - - - Correspond à l'option maxStalenessSeconds de la préférence de lecture. - Spécifie, en secondes, la durée de validité maximale d'une instance secondaire avant que le client ne cesse de l'utiliser pour les - opérations de lecture. Par défaut, il n'y a pas de durée de validité maximale et - les clients ne tiendront pas compte du délai d'une instance secondaire lors du choix de la direction d'une opération de lecture. Pour plus de détails, voir - MongoDB\Driver\ReadPreference. - - - Si spécifié, la durée de validité maximale doit être un entier signé de 32 bits - supérieur ou égal à - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS - (par exemple 90 secondes). - - - - - password - string - - Le mot de passe de l'utilisateur en cours d'authentification. Cette option est utile - si le mot de passe contient des caractères spéciaux, qui devraient autrement - être encodés en URL pour l'URI de connexion. - - - - readConcernLevel - string - - Correspond à l'option level de la préférence de lecture. - Spécifie le niveau d'isolation de lecture. Pour plus de détails, voir - MongoDB\Driver\ReadConcern. - - - - readPreference - string - - - Correspond à l'option mode de la préférence de lecture. - Par défaut à "primary". Pour plus de détails, voir - MongoDB\Driver\ReadPreference. - - - - - readPreferenceTags - array - - - Correspond à l'option tagSets de la préférence de lecture. - Les ensembles de balises permettent de cibler les opérations de lecture sur des - membres spécifiques d'un ensemble de réplicas. Pour plus de détails, - voir MongoDB\Driver\ReadPreference. - - - - Lorsque non spécifiée dans la chaîne d'URI, cette option est exprimée comme - un tableau conforme au format attendu par - MongoDB\Driver\ReadPreference::__construct. - - - - - - replicaSet - string - - - Spécifie le nom de l'ensemble de réplicas. - - - - - retryReads - bool - - - Spécifie si le pilote doit automatiquement réessayer - certaines opérations de lecture qui échouent en raison d'erreurs réseau transitoires - ou d'élections d'ensemble de réplicas. Cette fonctionnalité nécessite MongoDB 3.6+. - Par défaut à &true;. - - - Voir la - Spécification de lecture réessayable - pour plus d'informations. - - - - - retryWrites - bool - - - Spécifie si le pilote doit automatiquement réessayer - certaines opérations d'écriture qui échouent en raison d'erreurs réseau transitoires - ou d'élections d'ensemble de réplicas. Cette fonctionnalité nécessite MongoDB 3.6+. - Par défaut à &true;. - - - Voir - Écritures réessayables - dans le manuel MongoDB pour plus d'informations. - - - - - serverSelectionTimeoutMS - int - - - Spécifie combien de temps en millisecondes bloquer pour la sélection du serveur - avant de lancer une exception. Par défaut à 30 000 millisecondes. - - - - - serverSelectionTryOnce - bool - - - Lorsque &true;, indique au pilote de scanner le déploiement MongoDB - exactement une fois après un échec de sélection du serveur, puis de sélectionner - un serveur ou de lancer une exception. Lorsque &false;, le pilote bloque et - recherche un serveur jusqu'à la valeur de - "serverSelectionTimeoutMS". Par défaut à - &true;. - - - - - socketCheckIntervalMS - int - - - Si un socket n'a pas été utilisé récemment, le pilote doit le vérifier via - une commande hello avant de l'utiliser pour toute - opération. Par défaut à 5 000 millisecondes. - - - - - socketTimeoutMS - int - - - Le temps en millisecondes pour tenter un envoi ou une réception sur un socket - avant d'expirer. Par défaut à 300 000 millisecondes (c.-à-d. cinq - minutes). - - - - - srvMaxHosts - int - - - Le nombre maximum de résultats SRV à sélectionner aléatoirement lors de la - première population de la liste de semences ou, lors du sondage SRV, l'ajout de nouveaux hôtes à - la topologie. Par défaut à 0 (c.-à-d. pas de maximum). - - - - - srvServiceName - string - - - Le nom de service à utiliser pour la recherche SRV dans la liste de semences initiale - et le sondage SRV. Par défaut à "mongodb". - - - - - tls - bool - - - Initialise la connexion avec TLS/SSL si &true;. Par défaut à - &false;. - - - - - tlsAllowInvalidCertificates - bool - - - Spécifie si le pilote doit générer une erreur lorsque le certificat - TLS du serveur est invalide. Par défaut à &false;. - - - - Désactiver la validation du certificat créant une vulnérabilité. - - - - - - tlsAllowInvalidHostnames - bool - - - Spécifie si le pilote doit générer une erreur lorsqu'il y a un - désaccord entre le nom d'hôte du serveur et le nom d'hôte spécifié par - le certificat TLS. Par défaut à &false;. - - - - Désactive la validation du certificat créant une vulnérabilité. Autoriser - les noms d'hôte invalides peut exposer le pilote à une - attaque de l'homme du milieu. - - - - - - tlsCAFile - string - - - Le chemin du fichier contenant un seul certificat ou un ensemble de certificats - d'autorités à considérer comme fiables lors de l'établissement d'une connexion TLS. - Le magasin de certificats système sera utilisé par défaut. - - - - - tlsCertificateKeyFile - string - - - Le chemin du fichier de certificat client ou du fichier de clé privée client; - dans le cas où les deux sont nécessaires, les fichiers doivent être - concaténés. - - - - - tlsCertificateKeyFilePassword - string - - - Le mot de passe pour déchiffrer la clé privée client (c.-à-d. - l'option d'URI "tlsCertificateKeyFile") à utiliser - pour les connexions TLS. - - - - - tlsDisableCertificateRevocationCheck - bool - - - Si &true;, le pilote n'essaiera pas de vérifier l'état de révocation du certificat - (e.g. OCSP, CRL). Par défaut à &false;. - - - - - tlsDisableOCSPEndpointCheck - bool - - - Si &true;, le pilote n'essaiera pas de contacter un point de terminaison de répondeur OCSP - si nécessaire (c.-à-d. une réponse OCSP n'est pas agrafée). Par défaut à &false;. - - - - - tlsInsecure - bool - - - Détend les contraintes TLS autant que possible. Spécifier &true; pour - que cette option ait le même effet que de spécifier &true; pour les - options d'URI "tlsAllowInvalidCertificates" et - "tlsAllowInvalidHostnames". Par défaut à &false;. - - - - Désactive la validation du certificat créant une vulnérabilité. Autoriser - les noms d'hôte invalides peut exposer le pilote à une - attaque de l'homme du milieu. - - - - - - username - string - - Le nom d'utilisateur de l'utilisateur en cours d'authentification. Cette option est utile - si le nom d'utilisateur contient des caractères spéciaux, qui devraient autrement - être encodés en URL pour l'URI de connexion. - - - - w - intstring - - - Correspond à l'option w du write concern par défaut. - Pour plus de détails, voir - MongoDB\Driver\WriteConcern. - - - - - wTimeoutMS - intstring - - - Correspond à l'option wtimeout du write concern - par défaut. Spécifie une limite de temps, - en millisecondes, pour le write concern. Pour plus de détails, voir - MongoDB\Driver\WriteConcern. - - - Si spécifié, wTimeoutMS doit être un entier signé de 32 bits - supérieur ou égal à zéro. - - - - - zlibCompressionLevel - int - - - Spécifie le niveau de compression à utiliser pour le compresseur zlib. Cette - option n'a aucun effet si zlib n'est pas inclus dans - l'option d'URI "compressors". Voir la - Spécification de compression de pilote - pour plus d'informations. - - - - - -
    -     -     -     - - driverOptions - - - - driverOptions - - - - Option - Type - Description - - - - - autoEncryption - array - - - Apporte des options pour activer le chiffrement côté client au niveau - des champs. La liste des options est décrite dans la - table en dessous. - - - - Le chiffrement automatique est une fonctionnalité d'entreprise - qui ne s'applique qu'aux opérations sur une collection. Le chiffrement automatique n'est pas - pris en charge pour les opérations sur une base de données ou une vue, et les opérations qui ne - sont pas contournées entraîneront une erreur (voir - libmongocrypt: La liste d'autorisation de chiffrement automatique). Pour contourner le chiffrement automatique - pour toutes les opérations, définissez bypassAutoEncryption à - &true;. - - - Le chiffrement automatique nécessite que l'utilisateur authentifié ait le - privilège d'action - listCollections. - - - Le chiffrement explicite et automatique est une fonctionnalité de la communauté. - Le pilote peut toujours déchiffrer automatiquement lorsque - bypassAutoEncryption est &true;. - - - - - - ca_dir - string - - - Le chemin du répertoire de certificats correctement hachés. Le magasin de certificats système - sera utilisé par défaut. - - - - - crl_file - string - Le chemin du fichier de liste de révocation de certificat. - - - disableClientPersistence - bool - - - Si &true;, ce Manager utilisera un nouveau client libmongoc, qui ne sera - pas persisté ou partagé avec d'autres objets Manager. Lorsque cet - objet Manager est libéré, son client sera détruit et toutes - les connexions seront fermées. Par défaut à &false;. - - - - Désactiver la persistance du client n'est généralement pas recommandé. - - - - - - driver - array - - - Autorise un niveau supérieur de bibliothèque à ajouter ses propres métadonnées - à la poignée de main du serveur. Par défaut, l'extension soumet son propre nom, - version et plateforme (c.-à-d. version PHP) dans la poignée de main. Les chaînes - peuvent être spécifiées pour les clés "name", - "version" et "platform" de ce tableau, et seront - ajoutées au champ respectif(s) - de la poignée de main du serveur. - - - - Les informations de poignée de main sont limitées à 512 octets. L'extension - tronquera les données de poignée de main pour s'adapter à cette chaîne de 512 octets. Les - bibliothèques de niveau supérieur sont encouragées à conserver leurs propres métadonnées concises. - - - - - - serverApi - MongoDB\Driver\ServerApi - - - Cette option est utilisée pour déclarer une version d'API serveur pour le Manager. - Si omis, aucune version d'API n'est déclarée. - - - - - -
    -     - - Les options suivantes sont prises en charge: - - - Options pour le chiffrement automatique - - - - Option - Type - Description - - - - &mongodb.option.encryption.keyVaultClient; - &mongodb.option.encryption.keyVaultNamespace; - &mongodb.option.encryption.kmsProviders; - &mongodb.option.encryption.tlsOptions; - - schemaMap - arrayobject - - - Mappe les espaces de noms de collection à un schéma JSON local. Ceci est - utilisé pour configurer le chiffrement automatique. Voir - Règles de chiffrement automatique - dans le manuel MongoDB pour plus d'informations. Il est une erreur de - spécifier une collection à la fois dans schemaMap et - encryptedFieldsMap. - - - - Fournir un schemaMap fournit plus - de sécurité que de se fier aux schémas JSON obtenus du - serveur. Cela protège contre un serveur malveillant annonçant un faux - schéma JSON, qui pourrait tromper le client en envoyant - des données non chiffrées qui devraient être chiffrées. - - - - - Les schémas fournis dans le schemaMap s'appliquent uniquement - à la configuration du chiffrement automatique pour le chiffrement côté client. - D'autres règles de validation dans le schéma JSON ne seront - pas appliquées par le pilote et entraîneront une erreur. - - - - - - bypassAutoEncryption - bool - - Si &true;, mongocryptd ne sera pas lancé - automatiquement. Ceci est utilisé pour désactiver le chiffrement automatique. - Par défaut à &false;. - - - - bypassQueryAnalysis - bool - - - Si &true;, l'analyse automatique des commandes sortantes sera désactivée et - mongocryptd ne sera pas lancé automatiquement. Cela permet - le cas d'utilisation du chiffrement explicite pour interroger des champs indexés sans nécessiter - la bibliothèque crypt_shared sous licence entreprise ou - le processus mongocryptd. Par défaut à &false;. - - - - - encryptedFieldsMap - arrayobject - - - Mappe les espaces de noms de collection à un document - encryptedFields. Ceci est utilisé pour - configurer le chiffrement interrogeable. Voir - Chiffrement de champ et interrogeabilité - dans le manuel MongoDB pour plus d'informations. Il est une erreur de - spécifier une collection à la fois dans - encryptedFieldsMap et - schemaMap. - - - - Fournir un encryptedFieldsMap fournit plus - de sécurité que de se fier aux - encryptedFields obtenus du serveur. - Cela protège contre un serveur malveillant annonçant un faux - encryptedFields. - - - - - - extraOptions - array - - - Le extraOptions se rapportent au - processus mongocryptd. Les options suivantes - sont prises en charge: - - - mongocryptdURI (string): URI pour se connecter à un processus mongocryptd existant. Par défaut à "mongodb://localhost:27020". - mongocryptdBypassSpawn (bool): Si &true;, empêche le pilote de lancer mongocryptd. Par défaut à &false;. - mongocryptdSpawnPath (string): Chemin absolu pour rechercher le binaire mongocryptd. Par défaut à une chaîne vide et consulte les chemins système. - mongocryptdSpawnArgs (array): Tableau d'arguments de chaîne à passer à mongocryptd lors du lancement. Par défaut à ["--idleShutdownTimeoutSecs=60"]. - cryptSharedLibPath (string): Chemin absolu vers la bibliothèque partagée crypt_shared. Par défaut à une chaîne vide et consulte les chemins système. - cryptSharedLibRequired (bool): Si &true;, exige que le pilote charge crypt_shared. Par défaut à &false;. - - - Voir la Spécification de chiffrement côté client pour plus d'informations. - - - - - -
    - - - Le chiffrement automatique est une fonctionnalité d'entreprise qui - ne s'applique qu'aux opérations sur une collection. Le chiffrement automatique n'est pas - pris en charge pour les opérations sur une base de données ou une vue, et les opérations qui - ne sont pas contournées entraîneront une erreur. Pour contourner le chiffrement automatique - pour toutes les opérations, définissez bypassAutoEncryption=true - dans autoEncryption. Pour plus d'informations sur les opérations autorisées, - voir la Spécification de chiffrement côté client. - - -     -     -     -     -     - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une exception MongoDB\Driver\Exception\RuntimeException si le format de l'uri est invalide - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - L'option d'URI "canonicalizeHostname" a été supprimée. - Utiliser la propriété "CANONICALIZE_HOST_NAME" de l'option d'URI - "authMechanismProperties" plutôt. - - - L'option d'URI "gssapiServiceName" a été supprimée. - Utiliser la propriété "SERVICE_NAME" de l'option d'URI - "authMechanismProperties" plutôt. - - - L'option d'URI "safe" a été supprimée. - Utiliser les options d'URI "w" et "wTimeoutMS" - plutôt. - - - L'option d'URI "ssl" a été supprimée. Utiliser l'option - d'URI "tls" plutôt. - - - L'option de pilote "allow_invalid_hostname" a - été supprimée. Utiliser l'option d'URI - "tlsAllowInvalidHostnames" plutôt. - - - L'option de pilote "ca_file" a - été supprimée. Utiliser l'option d'URI - "tlsCAFile" plutôt. - - - L'option de pilote "context" a été supprimée. Toutes les - options de contexte ont été dépréciées en faveur des diverses options - d'URI liées à TLS. - - - L'option de pilote "pem_file" a été supprimée. Utiliser - l'option d'URI "tlsCertificateKeyFile" plutôt. - - - L'option de pilote "pem_pwd" a été supprimée. Utiliser - l'option d'URI "tlsCertificateKeyFilePassword" plutôt. - - - L'option de pilote "weak_cert_validation" a été supprimée. - Utiliser l'option d'URI "tlsAllowInvalidCertificates" - plutôt. - - - - - PECL mongodb 1.16.0 - - - Le fournisseur AWS KMS pour le chiffrement côté client accepte désormais une - option "sessionToken", qui peut être utilisée pour - s'authentifier avec des informations d'identification AWS temporaires. - - - Ajout de "tlsDisableOCSPEndpointCheck" au - champ "tlsOptions" de l'option de pilote - "autoEncryption". - - - Si un document vide est spécifié pour le fournisseur KMS "azure" ou - "gcp", le pilote tentera de configurer le fournisseur en utilisant - les informations d'identification automatiques. - - - - - PECL mongodb 1.15.0 - - - Si un document vide est spécifié pour le fournisseur KMS "aws", le pilote - tentera de configurer le fournisseur en utilisant - les informations d'identification automatiques. - - - - - PECL mongodb 1.14.0 - - - Ajout des options de chiffrement côté client "bypassQueryAnalysis" et - "encryptedFieldsMap". - Des options supplémentaires concernant crypt_shared sont - désormais prises en charge dans l'option de chiffrement côté client - "extraOptions". - - - - - PECL mongodb 1.13.0 - - - Ajout des options d'URI "srvMaxHosts" et - "srvServiceName". - - - - - PECL mongodb 1.12.0 - - - KMIP est désormais pris en charge en tant que fournisseur KMS pour le chiffrement côté client et - peut être configuré dans le champ "kmsProviders" de l'option de pilote - "autoEncryption". De plus, les options TLS - pour les fournisseurs KMS peuvent désormais être configurées dans le - champ "tlsOptions" de l'option de pilote - "autoEncryption". - - - - - PECL mongodb 1.11.0 - - - Ajout de l'option d'URI "loadBalanced". - - - - - PECL mongodb 1.10.0 - - - Ajout de l'option de pilote "disableClientPersistence". - - - Azure et GCP sont désormais pris en charge en tant que fournisseurs KMS pour - le chiffrement côté client et peuvent être configurés dans le champ - "kmsProviders" de l'option de pilote - "autoEncryption". Les chaînes encodées en base64 sont désormais acceptées - en tant qu'alternative à MongoDB\BSON\Binary pour les options dans - "kmsProviders". - - - - - PECL mongodb 1.8.0 - - - Ajout des options d'URI "directConnection", - "tlsDisableCertificateRevocationCheck" et - "tlsDisableOCSPEndpointCheck". - - - Ajout de l'option de pilote "driver". - - - - - PECL mongodb 1.7.0 - - - Ajout de l'option de pilote "autoEncryption". - - - Spécifier n'importe quelle option SSL ou TLS via le paramètre - driverOptions activera désormais implicitement TLS, comme - c'est le cas pour les options d'URI correspondantes. - - - - - PECL mongodb 1.6.0 - - - Ajout des options d'URI "retryReads", "tls", - "tlsAllowInvalidCertificates", - "tlsAllowInvalidHostnames", - "tlsCAFile", - "tlsCertificateKeyFile", - "tlsCertificateKeyFilePassword", et - "tlsInsecure". - - - L'option d'URI "retryWrites" est désormais à &true; par défaut. - - - Spécifier une option d'URI SSL ou TLS via la chaîne de connexion ou - le paramètre uriOptions activera désormais - implicitement TLS à moins que ssl ou tls ne soit &false;. - TLS n'est pas implicitement activé pour les options dans - le paramètre driverOptions, ce qui est inchangé - par rapport aux versions précédentes. - - - - - PECL mongodb 1.5.0 - - - "wtimeoutMS" est désormais toujours validé et appliqué au - write concern. Auparavant, l'option était ignorée si - "w" était <= 1, car le délai s'applique uniquement à - la réplication. - - - - - PECL mongodb 1.4.0 - - - Ajout des options d'URI "compressors", - "retryWrites", et - "zlibCompressionLevel". - - - - - PECL mongodb 1.3.0 - - - L'argument uriOptions accepte désormais - les options "authMechanism" et - "authMechanismProperties". Auparavant, ces - options n'étaient prises en charge que dans l'argument - uri. - - - - - PECL mongodb 1.2.0 - - - L'argument uri est désormais facultatif et - par défaut à "mongodb://. Le port par défaut reste - 27017. - - - Ajout de l'option d'URI "appname". - - - Ajout des options de pilote "allow_invalid_hostname", - "ca_file", "ca_dir", - "clr_file", "pem_file", - "pem_pwd", et - "weak_cert_validation". - - - L'API des flux PHP n'est plus utilisée pour la communication par socket. L'option - "connectTimeoutMS" de l'URI est désormais par défaut à 10 - secondes au lieu de - default_socket_timeout - dans les versions précédentes. De plus, l'extension ne prend plus en charge - toutes les options de contexte SSL via - l'option de pilote "context". - - - - - PECL mongodb 1.1.0 - - - L'argument uri est désormais facultatif et par défaut à - "mongodb://localhost:27017/". - - - - - - - - - - &reftitle.examples; - - Exemples basiques <function>MongoDB\Driver\Manager::__construct</function> - Connexion à un nœud MongoDB autonome: - - -]]> - - - Connexion à un nœud MongoDB autonome via un socket de domaine Unix. Le chemin du - socket peut inclure des caractères spéciaux tels que des barres obliques et doit être encodé - avec rawurlencode. - - - -]]> - - Connexion à un ensemble de réplicas: - - -]]> - - Connexion à un cluster fragmenté (c'est-à-dire un ou plusieurs instances mongos): - - -]]> - - Connexion à MongoDB avec des informations d'authentification pour un utilisateur et une base de données particuliers: - - -]]> - - - - Connexion à MongoDB avec des informations d'authentification pour un utilisateur - et une base de données particuliers, où le nom d'utilisateur ou le mot de passe inclut - des caractères spéciaux (par exemple @, :, - %). Dans l'exemple suivant, la chaîne de mot de passe - myp@ss:w%rd a été manuellement échappée; cependant, - rawurlencode peut également être utilisé pour échapper - les composants d'URI qui peuvent contenir des caractères spéciaux. - - - -]]> - - - Connexion à MongoDB avec l'authentification X509: - - "/path/to/client.pem", - ] -); -?> -]]> - - - - - - &reftitle.seealso; - - Gestion de la connexion et de la persistance - Format de chaîne de connexion MongoDB - - - -     - - diff --git a/reference/mongodb/mongodb/driver/manager/createclientencryption.xml b/reference/mongodb/mongodb/driver/manager/createclientencryption.xml deleted file mode 100644 index b46f560444..0000000000 --- a/reference/mongodb/mongodb/driver/manager/createclientencryption.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - MongoDB\Driver\Manager::createClientEncryption - Créer un nouvel objet ClientEncryption - - - - &reftitle.description; - - final public MongoDB\Driver\ClientEncryptionMongoDB\Driver\Manager::createClientEncryption - arrayoptions - - - Construit un nouvel objet MongoDB\Driver\ClientEncryption avec les options spécifiées. - - - - - &reftitle.parameters; - - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.encryption.keyVaultClient; - &mongodb.option.encryption.keyVaultNamespace; - &mongodb.option.encryption.kmsProviders; - &mongodb.option.encryption.tlsOptions; - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - Renvoie une nouvelle instance de MongoDB\Driver\ClientEncryption. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une exception MongoDB\Driver\Exception\RuntimeException si l'extension a été compilée sans le support de libmongocrypt - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.16.0 - - - Le fournisseur AWS KMS pour le chiffrement côté client accepte - désormais une option "sessionToken", qui peut être utilisée - pour s'authentifier avec des informations d'identification AWS temporaires. - - - Ajout de "tlsDisableOCSPEndpointCheck" à l'option - "tlsOptions". - - - Si un document vide est spécifié pour le fournisseur KMS "azure" ou - "gcp", le pilote tentera de - configurer le fournisseur en utilisant - Les informations d'identification automatiques. - - - - - PECL mongodb 1.15.0 - - - Si un document vide est spécifié pour le fournisseur KMS "aws", - le pilote tentera de configurer le fournisseur en utilisant - Les informations d'identification automatiques. - - - - - PECL mongodb 1.12.0 - - - KMIP est désormais pris en charge en tant que fournisseur KMS pour le chiffrement - côté client et peut être configuré dans l'option "kmsProviders". - - - Ajout de l'option "tlsOptions". - - - - - PECL mongodb 1.10.0 - - Azure et GCP sont désormais pris en charge en tant que fournisseurs KMS pour le chiffrement - côté client et peuvent être configurés dans l'option - "kmsProviders". - Les chaînes encodées en base64 sont désormais acceptées en tant qu'alternative à - MongoDB\BSON\Binary - pour les options dans "kmsProviders". - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::__construct - Chiffrement côté client explicite (manuel) dans le manuel MongoDB - - - -     - - diff --git a/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml b/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml deleted file mode 100644 index 69c1502946..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeBulkWrite - Exécute une ou plusieurs opérations d'écriture - - - - &reftitle.description; - - final public MongoDB\Driver\WriteResultMongoDB\Driver\Manager::executeBulkWrite - stringnamespace - MongoDB\Driver\BulkWritebulk - arraynulloptions&null; - - - Exécute une ou plusieurs opérations d'écriture sur le serveur primaire. - - - Un MongoDB\Driver\BulkWrite peut être construit avec - une ou plusieurs opérations d'écriture de types variés (par exemple, mises à - jour, suppressions et insertions). Le pilote tentera d'envoyer les - opérations du même type au serveur en aussi peu de requêtes que possible - pour optimiser les allers-retours. - - - La valeur par défaut de l'option "writeConcern" sera - déduite à partir d'une transaction active (indiquée par l'option - "session"), suivie de l' - URI de connexion. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.bulkwrite; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.writeresult; - - - - &reftitle.errors; - - Lance une MongoDB\Driver\Exception\InvalidArgumentException si bulk ne contient aucune opération d'écriture. - Lance une MongoDB\Driver\Exception\InvalidArgumentException si bulk a déjà été exécuté. Les objets MongoDB\Driver\BulkWrite ne peuvent pas être exécutés plusieurs fois. - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - &mongodb.throws.bulkwriteexception; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - Le paramètre options n'accepte plus - une instance de MongoDB\Driver\WriteConcern. - - - - PECL mongodb 1.21.0 - - Passer un objet MongoDB\Driver\WriteConcern en tant - qu'options est obsolète et sera supprimé dans la 2.0. - - - - PECL mongodb 1.4.4 - - Une MongoDB\Driver\Exception\InvalidArgumentException - sera lancée si l'option "session" est utilisée en - combinaison avec un "writeConcern" non-acknowledged. - - - - PECL mongodb 1.4.0 - - Le troisième paramètre est maintenant un tableau d'options. - Pour des raisons de compatibilité ascendante, ce paramètre acceptera - toujours un objet MongoDB\Driver\WriteConcern. - - - - PECL mongodb 1.3.0 - - Une MongoDB\Driver\Exception\InvalidArgumentException - est maintenant lancée si bulk ne contient aucune - opération d'écriture. Précédemment, une - MongoDB\Driver\Exception\BulkWriteException était - lancée. - - - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\Manager::executeBulkWrite</function> - -insert(['_id' => 1, 'x' => 1]); -$bulk->insert(['_id' => 2, 'x' => 2]); - -$bulk->update(['x' => 2], ['$set' => ['x' => 1]], ['multi' => false, 'upsert' => false]); -$bulk->update(['x' => 3], ['$set' => ['x' => 3]], ['multi' => false, 'upsert' => true]); -$bulk->update(['_id' => 3], ['$set' => ['x' => 3]], ['multi' => false, 'upsert' => true]); - -$bulk->insert(['_id' => 4, 'x' => 2]); - -$bulk->delete(['x' => 1], ['limit' => 1]); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$writeConcern = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, 100); -$result = $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); -printf("Matched %d document(s)\n", $result->getMatchedCount()); -printf("Updated %d document(s)\n", $result->getModifiedCount()); -printf("Upserted %d document(s)\n", $result->getUpsertedCount()); -printf("Deleted %d document(s)\n", $result->getDeletedCount()); - -foreach ($result->getUpsertedIds() as $index => $id) { - printf('upsertedId[%d]: ', $index); - var_dump($id); -} - -/* Si le WriteConcern n'a pas pu être satisfait */ -if ($writeConcernError = $result->getWriteConcernError()) { - printf("%s (%d): %s\n", $writeConcernError->getMessage(), $writeConcernError->getCode(), var_export($writeConcernError->getInfo(), true)); -} - -/* Si une écriture n'a pas pu se faire du tout */ -foreach ($result->getWriteErrors() as $writeError) { - printf("Operation#%d: %s (%d)\n", $writeError->getIndex(), $writeError->getMessage(), $writeError->getCode()); -} -?> -]]> - - &example.outputs.similar; - - - string(24) "54d3adc3ce7a792f4d703756" -} -upsertedId[4]: int(3) -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWrite - MongoDB\Driver\WriteResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\Server::executeBulkWrite - - - -     - - diff --git a/reference/mongodb/mongodb/driver/manager/executebulkwritecommand.xml b/reference/mongodb/mongodb/driver/manager/executebulkwritecommand.xml deleted file mode 100644 index c78a59e6f4..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executebulkwritecommand.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - - MongoDB\Driver\Manager::executeBulkWriteCommand - Exécute les opérations d'écriture en utilisant la commande bulkWrite - - - - &reftitle.description; - - final public MongoDB\Driver\BulkWriteCommandResultMongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandbulk - arraynulloptions&null; - - - Exécute une ou plusieurs opérations d'écriture sur le serveur principal en utilisant la - commande bulkWrite - introduite dans MongoDB 8.0. - - - Une MongoDB\Driver\BulkWriteCommand peut être construite - avec une ou plusieurs opérations d'écriture de types variés (par exemple, des - insertions, des mises à jour et des suppressions). Chaque opération d'écriture peut cibler une différente collection. - - - La valeur par défaut pour l'option "writeConcern" sera - déduite d'une transaction active (indiquée par l'option - "session"), suivie de - l'URI de connexion. - - - - - &reftitle.parameters; - - &mongodb.parameter.bulkwritecommand; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.bulkwritecommandresult; - - - - &reftitle.errors; - - Lance une MongoDB\Driver\Exception\InvalidArgumentException si bulk ne contient pas d'opérations d'écriture valides. - Lance une MongoDB\Driver\Exception\InvalidArgumentException si bulk a déjà été exécutée. Les objets MongoDB\Driver\BulkWriteCommand ne peuvent pas être exécutés plusieurs fois. - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - &mongodb.throws.bulkwritecommandexception; - Lance MongoDB\Driver\Exception\RuntimeException en cas d'autre erreur. - - - - - &reftitle.examples; - - Opérations d'écriture mixtes - - Les opérations d'écriture mixées (par exemple, insertion, mise à jour et suppression) seront envoyées - au serveur en utilisant une seule - commande - bulkWrite - - -deleteMany('db.coll_one', []); -$bulk->deleteMany('db.coll_two', []); - -// Ajoute les documents des deux collections -$bulk->insertOne('db.coll_one', ['_id' => 1]); -$bulk->insertOne('db.coll_two', ['_id' => 2]); -$bulk->insertOne('db.coll_two', ['_id' => 3]); - -// Met à jour un document dans "coll_one" -$bulk->updateOne('db.coll_one', ['_id' => 1], ['$set' => ['x' => 1]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); -printf("Updated %d document(s)\n", $result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - Opération d'écriture ordonnée qui provoque une erreur - -deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 2]); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 3]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - $result = $e->getPartialResult(); - - var_dump($e->getWriteErrors()); -} - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(78) "E11000 duplicate key error collection: db.coll index: _id_ dup key: { _id: 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(3) - ["info"]=> - object(stdClass)#6 (0) { - } - } -} -Inserted 2 document(s) -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\Server::executeBulkWriteCommand - - - -     - - diff --git a/reference/mongodb/mongodb/driver/manager/executecommand.xml b/reference/mongodb/mongodb/driver/manager/executecommand.xml deleted file mode 100644 index ebace35d6d..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executecommand.xml +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeCommand - Exécute une commande de base de données - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Sélectionne un serveur en fonction de l'option "readPreference" - et exécute la commande sur ce serveur. - - - Cette méthode n'applique aucune logique spéciale à la commande. Les valeurs - par défaut des options "readPreference", - "readConcern" et "writeConcern" seront - déduites à partir d'une transaction active (indiquée par l'option - "session"). S'il n'y a pas de transaction active, une - préférence de lecture primaire sera utilisée pour la sélection du serveur. - - - Les valeurs par défaut ne seront pas déduites à partir de - l'URI de connexion. - Il est donc recommandé aux utilisateurs d'utiliser des méthodes de commande - de lecture et/ou d'écriture spécifiques si possible. - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -     - &mongodb.option.transactionReadWriteConcern; -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs (par exemple: commande invalide, délivrance d'une commande d'écriture à un secondaire). - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - Le paramètre options n'accepte plus - une instance de MongoDB\Driver\ReadPreference. - - - - PECL mongodb 1.21.0 - - Passer un objet MongoDB\Driver\ReadPreference en tant - qu'options est obsolète et sera supprimé dans la 2.0. - - - - PECL mongodb 1.4.4 - - Une MongoDB\Driver\Exception\InvalidArgumentException - sera lancée si l'option "session" est utilisée en - combinaison avec une préférence d'écriture non reconnue. - - - - PECL mongodb 1.4.0 - - Ce troisième paramètre est maintenant un tableau d'options. - Pour des raisons de compatibilité ascendante, ce paramètre acceptera - toujours un objet MongoDB\Driver\ReadPreference. - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Manager::executeCommand</function> avec une commande retournant un seul document de résultat - - 1]); - -try { - $cursor = $manager->executeCommand('admin', $command); -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} - -/* La commande ping retourne un seul document de résultat, nous devons donc - * accéder au premier résultat dans le curseur. */ -$response = $cursor->toArray()[0]; - -var_dump($response); - -?> -]]> - - &example.outputs; - - - float(1) -} -]]> - - - - <function>MongoDB\Driver\Manager::executeCommand</function> avec une commande retournant un curseur - -insert(['x' => 1, 'y' => 'foo']); -$bulk->insert(['x' => 2, 'y' => 'bar']); -$bulk->insert(['x' => 3, 'y' => 'bar']); -$manager->executeBulkWrite('db.collection', $bulk); - -$command = new MongoDB\Driver\Command([ - 'aggregate' => 'collection', - 'pipeline' => [ - ['$group' => ['_id' => '$y', 'sum' => ['$sum' => '$x']]], - ], - 'cursor' => new stdClass, -]); -$cursor = $manager->executeCommand('db', $command); - -/* La commande d'agrégation peut éventuellement retourner ses résultats dans - * un curseur au lieu d'un seul document de résultat. Dans ce cas, nous pouvons - * itérer directement sur le curseur pour accéder à ces résultats. */ -foreach ($cursor as $document) { - var_dump($document); -} - -?> -]]> - - &example.outputs; - - - string(3) "bar" - ["sum"]=> - int(10) -} -object(stdClass)#7 (2) { - ["_id"]=> - string(3) "foo" - ["sum"]=> - int(2) -} -]]> - - - - - Limiter le temps d'exécution d'une commande - - Le temps d'exécution d'une commande peut être limité en spécifiant une - valeur pour "maxTimeMS" dans le document - MongoDB\Driver\Command. Il est à noter que cette limite de - temps est appliquée côté serveur et ne prend pas en compte la latence du - réseau. Voir - Terminer les opérations en cours - dans le manuel MongoDB pour plus d'informations. - - - 'collection', - 'query' => ['x' => ['$gt' => 1]], - 'maxTimeMS' => 1000, -]); - -$cursor = $manager->executeCommand('db', $command); - -var_dump($cursor->toArray()[0]); - -?> -]]> - - - Si la commande ne parvient pas à se terminer après une seconde d'exécution - sur le serveur, une - MongoDB\Driver\Exception\ExecutionTimeoutException - sera lancée. - - - - - - &reftitle.notes; - - - Si un readPreference secondaire est utilisé, il est de - la responsabilité de l'appelant de s'assurer que la - command peut être exécutée sur un secondaire. Aucune - validation n'est effectuée par le pilote. - - - - - Cette méthode n'utilise pas par défaut la préférence de lecture de - l'URI de connexion - MongoDB. Les applications qui en ont besoin devraient envisager - d'utiliser MongoDB\Driver\Manager::executeReadCommand. - - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Manager::executeReadCommand - MongoDB\Driver\Manager::executeReadWriteCommand - MongoDB\Driver\Manager::executeWriteCommand - MongoDB\Driver\Server::executeCommand - - - -     - - diff --git a/reference/mongodb/mongodb/driver/manager/executequery.xml b/reference/mongodb/mongodb/driver/manager/executequery.xml deleted file mode 100644 index dc6b4d5ac8..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executequery.xml +++ /dev/null @@ -1,230 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeQuery - Exécute une requête de base de données - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeQuery - stringnamespace - MongoDB\Driver\Queryquery - arraynulloptions&null; - - - Sélectionne un serveur en fonction de l'option "readPreference" - et exécute la requête sur ce serveur. - - - Les valeurs par défaut de l'option "readPreference" et de - l'option "readConcern" de la requête seront déduites à - partir d'une transaction active (indiquée par l'option "session"), - suivie de l'URI de connexion. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.query; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readPreference; - &mongodb.option.session; - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs (par exemple: opérateurs de requête invalides). - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - Le paramètre options n'accepte plus - une instance de MongoDB\Driver\ReadPreference. - - - - PECL mongodb 1.21.0 - - Passer un objet MongoDB\Driver\ReadPreference en tant - qu'options est obsolète et sera supprimé dans la 2.0. - - - - PECL mongodb 1.4.0 - - Le troisième paramètre est maintenant un tableau options. - Pour des raisons de compatibilité ascendante, ce paramètre acceptera toujours un - objet MongoDB\Driver\ReadPreference. - - - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\Manager::executeQuery</function> - -insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$filter = ['x' => ['$gt' => 1]]; -$options = [ - 'projection' => ['_id' => 0], - 'sort' => ['x' => -1], -]; - -$query = new MongoDB\Driver\Query($filter, $options); -$cursor = $manager->executeQuery('db.collection', $query); - -foreach ($cursor as $document) { - var_dump($document); -} - -?> -]]> - - &example.outputs; - - - int(3) -} -object(stdClass)#7 (1) { - ["x"]=> - int(2) -} -]]> - - - - - Limiter le temps d'exécution d'une requête - - L'option "maxTimeMS" de la classe - MongoDB\Driver\Query peut être utilisée pour limiter - le temps d'exécution d'une requête. Il est à noter que cette limite de temps est - appliquée côté serveur et ne prend pas en compte la latence réseau. Voir - Terminer les opérations en cours - dans le manuel MongoDB pour plus d'informations. - - - ['$gt' => 1]]; -$options = [ - 'maxTimeMS' => 1000, -]; - -$query = new MongoDB\Driver\Query($filter, $options); -$cursor = $manager->executeQuery('db.collection', $query); - -foreach ($cursor as $document) { - var_dump($document); -} - -?> -]]> - - - Si la requête ne parvient pas à se terminer après une seconde d'exécution - sur le serveur, une - MongoDB\Driver\Exception\ExecutionTimeoutException - sera lancée. - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor - MongoDB\Driver\Query - MongoDB\Driver\ReadPreference - MongoDB\Driver\Server::executeQuery - - - -     - - diff --git a/reference/mongodb/mongodb/driver/manager/executereadcommand.xml b/reference/mongodb/mongodb/driver/manager/executereadcommand.xml deleted file mode 100644 index c2c5be9378..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executereadcommand.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeReadCommand - Exécute une commande de base de données qui lit - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeReadCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Sélectionne un serveur en fonction de l'option "readPreference" - et exécute la commande sur ce serveur. - - - Cette méthode appliquera une logique spécifique aux commandes qui lisent (par exemple - distinct). - Les valeurs par défaut des options "readPreference" et - "readConcern" seront déduites à partir d'une transaction active - (indiquée par l'option "session"), suivie de l' - URI de connexion. - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.session; - - -
    -     - &mongodb.option.transactionReadWriteConcern; -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs (par exemple: commande invalide). - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Manager::executeReadWriteCommand - MongoDB\Driver\Manager::executeWriteCommand - MongoDB\Driver\Server::executeReadCommand - - - -     - - diff --git a/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml b/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml deleted file mode 100644 index a1f09ccdf7..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeReadWriteCommand - Exécute une commande de base de données qui lit et écrit - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeReadWriteCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Exécute une commande sur le serveur primaire. - - - Cette méthode appliquera une logique spécifique aux commandes qui lisent et écrivent - (par exemple aggregate). - Les valeurs par défaut des options "readConcern" et - "writeConcern" seront déduites à partir d'une transaction active - (indiquée par l'option "session"), suivie de l' - URI de connexion. - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readConcern; - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -     - &mongodb.option.transactionReadWriteConcern; -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs (par exemple: commande invalide). - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - Une MongoDB\Driver\Exception\InvalidArgumentException - sera lancée si l'option "session" est utilisée en - combinaison avec un critère de lecture ou d'écriture non reconnu. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Manager::executeReadCommand - MongoDB\Driver\Manager::executeWriteCommand - MongoDB\Driver\Server::executeReadWriteCommand - - - -     - - diff --git a/reference/mongodb/mongodb/driver/manager/executewritecommand.xml b/reference/mongodb/mongodb/driver/manager/executewritecommand.xml deleted file mode 100644 index ebcb4b99e9..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executewritecommand.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeWriteCommand - Exécute une commande de base de données qui écrit - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeWriteCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Exécute la commande sur le serveur primaire. - - - Cette méthode appliquera une logique spécifique aux commandes qui écrivent (par exemple - drop). - Les valeurs par défaut de l'option "writeConcern" seront déduites à - partir d'une transaction active (indiquée par l'option "session"), suivie de - l'URI de connexion. - - - - Cette méthode n'est pas destinée à être utilisée pour exécuter - insert, - update, - ou delete. - Il est recommandé aux utilisateurs d'utiliser - MongoDB\Driver\Manager::executeBulkWrite pour ces - opérations. - - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -     - &mongodb.option.transactionReadWriteConcern; -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs (par exemple: commande invalide). - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - Une MongoDB\Driver\Exception\InvalidArgumentException - sera lancée si l'option "session" est utilisée en - combinaison avec un "writeConcern" non reconnu. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Manager::executeReadCommand - MongoDB\Driver\Manager::executeReadWriteCommand - MongoDB\Driver\Server::executeWriteCommand - - - -     - - diff --git a/reference/mongodb/mongodb/driver/manager/getencryptedfieldsmap.xml b/reference/mongodb/mongodb/driver/manager/getencryptedfieldsmap.xml deleted file mode 100644 index aea2acea9c..0000000000 --- a/reference/mongodb/mongodb/driver/manager/getencryptedfieldsmap.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getEncryptedFieldsMap - Renvoie l'option de chiffrement automatique encryptedFieldsMap pour le Manager - - - - &reftitle.description; - - final public arrayobjectnullMongoDB\Driver\Manager::getEncryptedFieldsMap - - - - Renvoie l'option de chiffrement automatique encryptedFieldsMap - pour le Manager, si spécifiée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'option de chiffrement automatique encryptedFieldsMap pour le - Manager, ou &null; si elle n'a pas été spécifiée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::__construct - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getreadconcern.xml b/reference/mongodb/mongodb/driver/manager/getreadconcern.xml deleted file mode 100644 index fc0451950a..0000000000 --- a/reference/mongodb/mongodb/driver/manager/getreadconcern.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getReadConcern - Renvoie le ReadConcern pour le Manager - - - - &reftitle.description; - - final public MongoDB\Driver\ReadConcernMongoDB\Driver\Manager::getReadConcern - - - - Renvoie le MongoDB\Driver\ReadConcern pour le - Manager, qui est dérivé de ses options URI. C'est le ReadConcern par défaut - pour les requêtes et commandes exécutées sur le Manager. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le MongoDB\Driver\ReadConcern pour le Manager. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple <function>MongoDB\Driver\Manager::getReadConcern</function> - -getReadConcern()); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017/?readConcernLevel=local'); -var_dump($manager->getReadConcern()); - -?> -]]> - - &example.outputs.similar; - - - string(5) "local" -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadConcern - MongoDB\Driver\Manager::__construct - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getreadpreference.xml b/reference/mongodb/mongodb/driver/manager/getreadpreference.xml deleted file mode 100644 index d619731dc1..0000000000 --- a/reference/mongodb/mongodb/driver/manager/getreadpreference.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getReadPreference - Renvoie le ReadPreference pour le Manager - - - - &reftitle.description; - - final public MongoDB\Driver\ReadPreferenceMongoDB\Driver\Manager::getReadPreference - - - - Renvoie le MongoDB\Driver\ReadPreference pour le - Manager, qui est dérivé de ses options URI. C'est le ReadPreference par défaut - pour les requêtes et commandes exécutées sur le Manager. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le MongoDB\Driver\ReadPreference pour le Manager. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\Manager::getReadPreference</function> - -getReadPreference()); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017/?readPreference=secondaryPreferred&readPreferenceTags=dc:ny,rack:1&readPreferenceTags=dc:ny&readPreferenceTags='); -var_dump($manager->getReadPreference()); - -?> -]]> - - &example.outputs.similar; - - - string(7) "primary" -} -object(MongoDB\Driver\ReadPreference)#1 (2) { - ["mode"]=> - string(18) "secondaryPreferred" - ["tags"]=> - array(3) { - [0]=> - object(stdClass)#3 (2) { - ["dc"]=> - string(2) "ny" - ["rack"]=> - string(1) "1" - } - [1]=> - object(stdClass)#4 (1) { - ["dc"]=> - string(2) "ny" - } - [2]=> - object(stdClass)#5 (0) { - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadPreference - MongoDB\Driver\Manager::__construct - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getservers.xml b/reference/mongodb/mongodb/driver/manager/getservers.xml deleted file mode 100644 index 4033350c23..0000000000 --- a/reference/mongodb/mongodb/driver/manager/getservers.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getServers - Retourner les serveurs auxquels ce gestionnaire est connecté - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Manager::getServers - - - - Retourne un &array; d'instances MongoDB\Driver\Server auxquelles ce gestionnaire est connecté. - - - - Étant donné que le pilote se connecte paresseusement à la base de données, cette méthode peut retourner un &array; vide s'il est appelé avant d'exécuter une opération sur le MongoDB\Driver\Manager. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &array; d'instances MongoDB\Driver\Server auxquelles ce gestionnaire est connecté. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\Manager::getServers</function> - -getServers()); - -$command = new MongoDB\Driver\Command(['ping' => 1]); -$manager->executeCommand('db', $command); - -var_dump($manager->getServers()); - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\Server)#3 (10) { - ["host"]=> - string(9) "localhost" - ["port"]=> - int(27017) - ["type"]=> - int(1) - ["is_primary"]=> - bool(false) - ["is_secondary"]=> - bool(false) - ["is_arbiter"]=> - bool(false) - ["is_hidden"]=> - bool(false) - ["is_passive"]=> - bool(false) - ["last_hello_response"]=> - array(8) { - ["isWritablePrimary"]=> - bool(true) - ["maxBsonObjectSize"]=> - int(16777216) - ["maxMessageSizeBytes"]=> - int(48000000) - ["maxWriteBatchSize"]=> - int(1000) - ["localTime"]=> - object(MongoDB\BSON\UTCDateTime)#4 (1) { - ["milliseconds"]=> - int(1447267964517) - } - ["maxWireVersion"]=> - int(3) - ["minWireVersion"]=> - int(0) - ["ok"]=> - float(1) - } - ["round_trip_time"]=> - int(554) - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server - MongoDB\Driver\Manager::selectServer - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getwriteconcern.xml b/reference/mongodb/mongodb/driver/manager/getwriteconcern.xml deleted file mode 100644 index 63745eb0c3..0000000000 --- a/reference/mongodb/mongodb/driver/manager/getwriteconcern.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getWriteConcern - Renvoie le WriteConcern pour le Manager - - - - &reftitle.description; - - final public MongoDB\Driver\WriteConcernMongoDB\Driver\Manager::getWriteConcern - - - - Renvoie le MongoDB\Driver\WriteConcern pour le - Manager, qui est dérivé de ses options URI. C'est le WriteConcern par défaut - pour les écritures et commandes exécutées sur le Manager. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le MongoDB\Driver\WriteConcern pour le Manager. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\Manager::getWriteConcern</function> - -getWriteConcern()); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017/?w=majority&wtimeoutMS=2000'); -var_dump($manager->getWriteConcern()); - -?> -]]> - - &example.outputs.similar; - - - string(8) "majority" - ["wtimeout"]=> - int(2000) -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - MongoDB\Driver\Manager::__construct - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/removesubscriber.xml b/reference/mongodb/mongodb/driver/manager/removesubscriber.xml deleted file mode 100644 index 0edfc44537..0000000000 --- a/reference/mongodb/mongodb/driver/manager/removesubscriber.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - MongoDB\Driver\Manager::removeSubscriber - Enlève un observateur d'événements de surveillance de ce Manager - - - - &reftitle.description; - - final public voidMongoDB\Driver\Manager::removeSubscriber - MongoDB\Driver\Monitoring\Subscribersubscriber - - - Enlève un observateur d'événements de surveillance de ce Manager. - - - - Si subscriber n'est pas déjà enregistré avec ce - Manager, cette fonction ne fait rien. - - - - - - &reftitle.parameters; - - - subscriber (MongoDB\Driver\Monitoring\Subscriber) - - - Un observateur d'événements de surveillance à enlever de ce Manager. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::addSubscriber - MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Monitoring\removeSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/selectserver.xml b/reference/mongodb/mongodb/driver/manager/selectserver.xml deleted file mode 100644 index d94fc5effc..0000000000 --- a/reference/mongodb/mongodb/driver/manager/selectserver.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - MongoDB\Driver\Manager::selectServer - Sélectionne un serveur correspondant à une préférence de lecture - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Manager::selectServer - MongoDB\Driver\ReadPreferencenullreadPreference&null; - - - Sélectionne un MongoDB\Driver\Server correspondant à - readPreference. Si readPreference - est &null; ou omis, le serveur primaire sera sélectionné par défaut. Cela peut - être utilisé pour pré-sélectionner un serveur afin d'effectuer une vérification - de version avant d'exécuter une opération. - - - - Contrairement à MongoDB\Driver\Manager::getServers, cette - méthode initialisera les connexions de base de données et effectuera la - découverte de serveurs si nécessaire. Voir la - Spécification de sélection de serveur - pour plus d'informations. - - - - - - &reftitle.parameters; - - - readPreference (MongoDB\Driver\ReadPreference) - - - Les préférences de lecture à utiliser pour sélectionner un serveur. Si - &null; ou omis, le serveur primaire sera sélectionné par défaut. - - - - - - - - &reftitle.returnvalues; - - Renvoie un MongoDB\Driver\Server correspondant à la - préférence de lecture. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException si un serveur correspondant à la préférence de lecture n'a pas pu être trouvé. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - Le readPreference est maintenant optionnel. Si &null; ou - omis, le serveur primaire sera sélectionné par défaut. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server - MongoDB\Driver\Manager::getServers - Spécification de sélection de serveur - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/startsession.xml b/reference/mongodb/mongodb/driver/manager/startsession.xml deleted file mode 100644 index 16866d276c..0000000000 --- a/reference/mongodb/mongodb/driver/manager/startsession.xml +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - MongoDB\Driver\Manager::startSession - Démarre une nouvelle session client pour être utilisée avec ce client - - - - &reftitle.description; - - final public MongoDB\Driver\SessionMongoDB\Driver\Manager::startSession - arraynulloptions&null; - - - Crée une MongoDB\Driver\Session pour les options données. - La session peut ensuite être spécifiée lors de l'exécution de commandes, de requêtes - et d'opérations d'écriture. - - - - Une MongoDB\Driver\Session ne peut être utilisée qu'avec le - MongoDB\Driver\Manager à partir duquel elle a été créée. - - - - - - &reftitle.parameters; - - - options - - - - options - - - - Option - Type - Description - Défaut - - - - - causalConsistency - bool - - - Configure la cohérence causale dans une session. Si &true;, chaque opération - dans la session sera ordonnée de manière causale après l'opération de lecture - ou d'écriture précédente. Définir à &false; pour désactiver la cohérence causale. - - - Voir - Consistance causale - dans le manuel MongoDB pour plus d'informations. - - - &true; - - - defaultTransactionOptions - array - - - Les options par défaut à appliquer aux transactions nouvellement créées. Ces - options sont utilisées sauf si elles sont remplacées lorsqu'une transaction est - démarrée avec une valeur différente pour chaque option. - - -
    - options - - - - Option - Type - Description - - - - &mongodb.option.maxCommitTimeMS; - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.writeConcern; - - -
    -     - - Cette option est disponible dans MongoDB 4.0+. - - - [] - - - snapshot - bool - - - Configure les lectures instantanées dans une session. Si &true;, un horodatage sera - obtenu à partir de la première opération de lecture prise en charge dans la session - (c'est-à-dire find, aggregate, ou - distinct non fragmenté). Les opérations de lecture ultérieures - dans la session utiliseront ensuite un niveau de cohérence de lecture "snapshot" - pour lire des données majoritairement engagées à partir de cet horodatage. Définissez - à &false; pour désactiver les lectures instantanées. - - - Les lectures instantanées nécessitent MongoDB 5.0+ et ne peuvent pas être utilisées - avec la cohérence causale, les transactions ou les opérations d'écriture. Si - "snapshot" est &true;, - "causalConsistency" sera par défaut à &false;. - - - Voir - Read Concern "instantanés" - dans le manuel MongoDB pour plus d'informations. - - - &false; - - - - - -     -     -     -     - - - &reftitle.returnvalues; - - Renvoie une MongoDB\Driver\Session. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\InvalidArgumentException si les options "causalConsistency" et "snapshot" sont toutes les deux &true;. - Lance une MongoDB\Driver\Exception\RuntimeException si la session ne peut pas être créée (par exemple, libmongoc ne prend pas en charge le chiffrement). - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - - L'option "snapshot" a été ajoutée. - - - - - PECL mongodb 1.6.0 - - - L'option "maxCommitTimeMS" a été ajoutée à - "defaultTransactionOptions". - - - - - PECL mongodb 1.5.0 - - - L'option "defaultTransactionOptions" a été ajoutée. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Session - Consistance causale dans le manuel MongoDB - - - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent.xml deleted file mode 100644 index 8a577d8066..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent.xml +++ /dev/null @@ -1,258 +0,0 @@ - - - - - - - - La classe MongoDB\Driver\Monitoring\CommandFailedEvent - MongoDB\Driver\Monitoring\CommandFailedEvent - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Monitoring\CommandFailedEvent - contient les informations sur une commande ayant échoué. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\CommandFailedEvent - - - - final - - MongoDB\Driver\Monitoring\CommandFailedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - string - commandName - - - public - readonly - string - databaseName - - - public - readonly - int - duration - - - public - readonly - Exception - error - - - public - readonly - object - reply - - - public - readonly - string - operationId - - - public - readonly - string - requestId - - - public - readonly - MongoDB\BSON\ObjectIdnull - serviceId - - - public - readonly - intnull - serverConnectionId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - Le nom d'hôte du serveur ayant exécuté la commande. - - - - port - - Le port du serveur ayant exécuté la commande. - - - - commandName - - Le nom de la commande. - - - - databaseName - - Le nom de la base de données. - - - - duration - - - La durée de la commande en microsecondes. La durée est une valeur - calculée qui inclut le temps d'envoi du message et de réception de - la réponse du serveur. - - - - - error - - L'exception qui a été levée lorsque la commande a échoué. - - - - reply - - Le document de réponse d'échec retourné par le serveur. - - - - operationId - - - L'identifiant d'opération. Il peut être utilisé pour relier des - évènements entre eux, comme les écritures groupées (bulk writes), - qui peuvent dispatcher plusieurs commandes. - - - - - requestId - - - L'identifiant de requête. Il peut être utilisé pour associer cet - MongoDB\Driver\Monitoring\CommandFailedEvent - avec un - MongoDB\Driver\Monitoring\CommandStartedEvent - correspondant. - - - - - serviceId - - - L'identifiant de service, ou &null; si le serveur ne le prend pas - en charge (c'est-à-dire qu'il n'utilise pas le mode équilibrage de - charge). - - - - - serverConnectionId - - - L'identifiant de connexion au serveur, ou &null; s'il n'est pas - disponible. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. La - propriété duration remplace la méthode - getDurationMicros. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.commandfailedevent; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getcommandname.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getcommandname.xml deleted file mode 100644 index 48963d6693..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getcommandname.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getCommandName - Renvoie le nom de la commande - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getCommandName - - - - Renvoie le nom de la commande (par exemple "find", - "aggregate"). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom de la commande. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdatabasename.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdatabasename.xml deleted file mode 100644 index 9a520a48ed..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdatabasename.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getDatabaseName - Renvoie le nom de la base de données sur laquelle la commande a été exécutée - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getDatabaseName - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la base de données sur laquelle la commande a été exécutée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdurationmicros.xml deleted file mode 100644 index 623e3ec2fa..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdurationmicros.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getDurationMicros - Renvoie la durée de la commande en microsecondes - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandFailedEvent::getDurationMicros - - - - La durée de la commande est une valeur calculée qui inclut le temps pour envoyer - le message et recevoir la réponse du serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la durée de la commande en microsecondes. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml deleted file mode 100644 index c8159cd6d4..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getError - Renvoie l'exception associée à la commande échouée - - - - &reftitle.description; - - final public ExceptionMongoDB\Driver\Monitoring\CommandFailedEvent::getError - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'Exception associée à la commande échouée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/gethost.xml deleted file mode 100644 index 2a8e3b746f..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getHost - Renvoie le nom d'hôte du serveur pour la commande - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom d'hôte du serveur sur lequel la commande a été exécutée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getoperationid.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getoperationid.xml deleted file mode 100644 index 067c31d777..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getoperationid.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId - Renvoie l'identifiant de l'opération de la commande - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId - - - - L'id de l'opération est généré par l'extension et peut être utilisé pour lier des événements - ensemble tels que des opérations d'écriture en masse, qui peuvent avoir été divisées en plusieurs - commandes au niveau du protocole. - - - - Depuis que plusieurs commandes peuvent partager le même ID d'opération, il n'est pas fiable - d'utiliser cette valeur pour associer des objets d'événement les uns aux autres. L'ID de requête - renvoyé par - MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - devrait être utilisé à la place. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de l'opération de la commande. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId - MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getport.xml deleted file mode 100644 index 6f9c02dcda..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getPort - Renvoie le port du serveur pour la commande - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandFailedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le port du serveur sur lequel la commande a été exécutée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getreply.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getreply.xml deleted file mode 100644 index d6291d1e73..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getreply.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getReply - Renvoie le document de réponse de la commande - - - - &reftitle.description; - - final public objectMongoDB\Driver\Monitoring\CommandFailedEvent::getReply - - - - Le document de réponse sera converti de BSON en PHP en utilisant les règles de - désérialisation - par défaut (par exemple, les documents BSON seront convertis en stdClass). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le document de réponse de la commande sous forme d'un - objet stdClass. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getrequestid.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getrequestid.xml deleted file mode 100644 index b0fc9374bd..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getrequestid.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - Renvoie l'identifiant de la requête de la commande - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - - - - L'identifiant de la requête est généré par l'extension et peut être utilisé pour associer - cet MongoDB\Driver\Monitoring\CommandFailedEvent avec un - MongoDB\Driver\Monitoring\CommandStartedEvent précédent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de la requête de la commande. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserver.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserver.xml deleted file mode 100644 index 709cd0aa31..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserver.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServer - Renvoie le serveur sur lequel la commande a été exécutée - - - - - - Cette méthode a été DÉPRÉCIÉE à partir de la version - 1.20.0 de l'extension et a été supprimée dans la version 2.0. Les applications doivent utiliser - MongoDB\Driver\Monitoring\CommandFailedEvent::getHost - et - MongoDB\Driver\Monitoring\CommandFailedEvent::getPort - à la place. - - - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Monitoring\CommandFailedEvent::getServer - - - - Renvoie le MongoDB\Driver\Server sur lequel la commande - a été exécutée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le MongoDB\Driver\Server sur lequel la commande - a été exécutée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.method-removed; - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserverconnectionid.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserverconnectionid.xml deleted file mode 100644 index f066589b8b..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserverconnectionid.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServerConnectionId - Renvoie l'identifiant de connexion du serveur pour la commande - - - - &reftitle.description; - - final public intnullMongoDB\Driver\Monitoring\CommandFailedEvent::getServerConnectionId - - - - Renvoie l'identifiant de connexion du serveur pour la commande. L'identifiant de connexion du serveur est - distinct du serveur (c'est-à-dire - MongoDB\Driver\Monitoring\CommandFailedEvent::getServer) - et est renvoyé dans le champ "connectionId" d'une réponse de commande hello - MongoDB 4.2+. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de connexion du serveur, ou &null; s'il n'est pas disponible. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserviceid.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserviceid.xml deleted file mode 100644 index 4c97452413..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserviceid.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServiceId - Renvoie l'identifiant du service de l'équilibreur de charge pour la commande - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdnullMongoDB\Driver\Monitoring\CommandFailedEvent::getServiceId - - - - Lorsque le pilote est connecté à un cluster MongoDB via un équilibreur de charge, - l'identifiant du service correspond au champ serviceId dans la - réponse de la commande hello. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant du service de l'équilibreur de charge, ou &null; si le pilote n'est pas - connecté à un équilibreur de charge. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent.xml deleted file mode 100644 index f4d919c74f..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent.xml +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - - - La classe MongoDB\Driver\Monitoring\CommandStartedEvent - MongoDB\Driver\Monitoring\CommandStartedEvent - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Monitoring\CommandStartedEvent - contient les informations sur une commande ayant démarrée. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\CommandStartedEvent - - - - final - - MongoDB\Driver\Monitoring\CommandStartedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - string - commandName - - - public - readonly - string - databaseName - - - public - readonly - object - command - - - public - readonly - string - operationId - - - public - readonly - string - requestId - - - public - readonly - MongoDB\BSON\ObjectIdnull - serviceId - - - public - readonly - intnull - serverConnectionId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - Le nom d'hôte du serveur ayant exécuté la commande. - - - - port - - Le port du serveur ayant exécuté la commande. - - - - commandName - - Le nom de la commande. - - - - databaseName - - Le nom de la base de données. - - - - command - - Le document de la commande. - - - - operationId - - - L'identifiant d'opération. Il peut être utilisé pour relier des - évènements entre eux, comme les écritures groupées (bulk writes), - qui peuvent dispatcher plusieurs commandes. - - - - - requestId - - - L'identifiant de requête. Il peut être utilisé pour associer cet - MongoDB\Driver\Monitoring\CommandStartedEvent - avec un - MongoDB\Driver\Monitoring\CommandSucceededEvent - ou un - MongoDB\Driver\Monitoring\CommandFailedEvent - correspondant. - - - - - serviceId - - - L'identifiant de service, ou &null; si le serveur ne le prend pas - en charge (c'est-à-dire qu'il n'utilise pas le mode équilibrage de - charge). - - - - - serverConnectionId - - L'identifiant de connexion au serveur, ou &null; s'il n'est pas disponible. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.commandstartedevent; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommand.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommand.xml deleted file mode 100644 index 8be5bb4aa0..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommand.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getCommand - Renvoie le document de commande - - - - &reftitle.description; - - final public objectMongoDB\Driver\Monitoring\CommandStartedEvent::getCommand - - - - Le document renvoyé sera converti de BSON en PHP en utilisant les règles de - désérialisation - par défaut (par exemple, les documents BSON seront convertis en stdClass). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le document de commande sous forme d'objet stdClass. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommandname.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommandname.xml deleted file mode 100644 index 46148524bf..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommandname.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getCommandName - Renvoie le nom de la commande - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getCommandName - - - - Renvoie le nom de la commande (par exemple, "find", - "aggregate"). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom de la commande. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getdatabasename.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getdatabasename.xml deleted file mode 100644 index 1d974ad8c7..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getdatabasename.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getDatabaseName - Renvoie la base de données sur laquelle la commande a été exécutée - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getDatabaseName - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la base de données sur laquelle la commande a été exécutée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/gethost.xml deleted file mode 100644 index 9605691c79..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getHost - Renvoie le nom d'hôte du serveur pour la commande - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom d'hôte du serveur sur lequel la commande a été exécutée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getoperationid.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getoperationid.xml deleted file mode 100644 index b8a00d2670..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getoperationid.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId - Renvoie l'identifiant de l'opération de la commande - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId - - - - L'identifiant de l'opération est généré par l'extension et peut être utilisé - pour lier des événements ensemble, tels que des opérations d'écriture en - masse, qui peuvent avoir été divisées en plusieurs commandes au niveau du - protocole. - - - - Depuis que plusieurs commandes peuvent partager le même identifiant - d'opération, il n'est pas fiable d'utiliser cette valeur pour associer des - objets d'événement les uns aux autres. L'identifiant de la requête renvoyé - par - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - devrait être utilisé à la place. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de l'opération de la commande. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId - MongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getport.xml deleted file mode 100644 index 8165c5da45..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getPort - Renvoie le port du serveur pour la commande - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandStartedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le port du serveur sur lequel la commande a été exécutée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getrequestid.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getrequestid.xml deleted file mode 100644 index 814f2845cb..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getrequestid.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - Renvoie l'identifiant de la requête de la commande - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - - - - L'identifiant de la requête est généré par l'extension et peut être utilisé - pour associer cet événement - MongoDB\Driver\Monitoring\CommandStartedEvent - avec un - MongoDB\Driver\Monitoring\CommandFailedEvent ou - MongoDB\Driver\Monitoring\CommandSucceededEvent ultérieur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de la requête de la commande. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserver.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserver.xml deleted file mode 100644 index 7f5ded6be7..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserver.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer - Renvoie le serveur sur lequel la commande a été exécutée - - - - - - Cette méthode a été DÉPRÉCIÉE à partir de la version - 1.20.0 de l'extension et a été supprimée dans la version 2.0. Les applications doivent utiliser - MongoDB\Driver\Monitoring\CommandStartedEvent::getHost - et - MongoDB\Driver\Monitoring\CommandStartedEvent::getPort - à la place. - - - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Monitoring\CommandStartedEvent::getServer - - - - Renvoie le MongoDB\Driver\Server sur lequel la commande - a été exécutée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le MongoDB\Driver\Server sur lequel la commande - a été exécutée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.method-removed; - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServer - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserverconnectionid.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserverconnectionid.xml deleted file mode 100644 index 8aee8988a8..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserverconnectionid.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServerConnectionId - Renvoie l'identifiant de connexion du serveur pour la commande - - - - &reftitle.description; - - final public intnullMongoDB\Driver\Monitoring\CommandStartedEvent::getServerConnectionId - - - - Renvoie l'identifiant de connexion du serveur pour la commande. L'identifiant de connexion du serveur est - distinct du serveur (c'est-à-dire - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer) - et est renvoyé dans le champ "connectionId" d'une réponse de commande hello - MongoDB 4.2+. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de connexion du serveur, ou &null; s'il n'est pas disponible. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserviceid.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserviceid.xml deleted file mode 100644 index 0a87624720..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserviceid.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServiceId - Renvoie l'identifiant du service de l'équilibreur de charge pour la commande - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdnullMongoDB\Driver\Monitoring\CommandStartedEvent::getServiceId - - - - Lorsque le pilote est connecté à un cluster MongoDB via un équilibreur de charge, - l'identifiant de service correspond au champ serviceId dans la - réponse de la commande hello. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant du service de l'équilibreur de charge, ou &null; si le pilote n'est pas - connecté à un équilibreur de charge. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber.xml b/reference/mongodb/mongodb/driver/monitoring/commandsubscriber.xml deleted file mode 100644 index cdce94f144..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - L'interface MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Monitoring\CommandSubscriber - - - - -
    - &reftitle.intro; - - Les classes peuvent implémenter cette interface pour enregistrer un observateur - d'événements qui est notifié pour chaque événement de commande démarré, - réussi et échoué. Voir pour plus d'informations. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\Driver\Monitoring\CommandSubscriber - - - - - MongoDB\Driver\Monitoring\CommandSubscriber - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -     - - &reference.mongodb.mongodb.driver.monitoring.entities.commandsubscriber; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandfailed.xml b/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandfailed.xml deleted file mode 100644 index 626a4cfc58..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandfailed.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSubscriber::commandFailed - Méthode de notification pour une commande échouée - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\CommandSubscriber::commandFailed - MongoDB\Driver\Monitoring\CommandFailedEventevent - - - Si l'observateur est enregistré, cette méthode est appelée lorsqu'une commande échoue. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\CommandFailedEvent) - - - Un objet d'événement encapsulant des informations sur la commande échouée. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandstarted.xml b/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandstarted.xml deleted file mode 100644 index e53c81e9e3..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandstarted.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSubscriber::commandStarted - Méthode de notification pour une commande démarrée - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\CommandSubscriber::commandStarted - MongoDB\Driver\Monitoring\CommandStartedEventevent - - - Si l'observateur est enregistré, cette méthode est appelée lorsqu'une commande est envoyée - au serveur. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\CommandStartedEvent) - - - Un objet d'événement encapsulant des informations sur la commande démarrée. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandsucceeded.xml b/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandsucceeded.xml deleted file mode 100644 index 7c9f902581..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandsucceeded.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSubscriber::commandSucceeded - Méthode de notification pour une commande réussie - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\CommandSubscriber::commandSucceeded - MongoDB\Driver\Monitoring\CommandSucceededEventevent - - - Si l'observateur est enregistré, cette méthode est appelée lorsqu'une - commande réussit. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\CommandSucceededEvent) - - - Un objet d'événement encapsulant des informations sur la commande réussie. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandSucceededEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent.xml deleted file mode 100644 index 4291781b00..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent.xml +++ /dev/null @@ -1,240 +0,0 @@ - - - - - La classe MongoDB\Driver\Monitoring\CommandSucceededEvent - MongoDB\Driver\Monitoring\CommandSucceededEvent - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Monitoring\CommandSucceededEvent - encapsule des informations sur une commande réussie. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent - - - - final - - MongoDB\Driver\Monitoring\CommandSucceededEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - string - commandName - - - public - readonly - string - databaseName - - - public - readonly - int - duration - - - public - readonly - object - reply - - - public - readonly - string - operationId - - - public - readonly - string - requestId - - - public - readonly - MongoDB\BSON\ObjectIdnull - serviceId - - - public - readonly - intnull - serverConnectionId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - Le nom d'hôte du serveur ayant exécuté la commande. - - - - port - - Le port du serveur ayant exécuté la commande. - - - - commandName - - Le nom de la commande. - - - - databaseName - - Le nom de la base de données. - - - - duration - - - La durée de la commande en microsecondes. La durée est une valeur - calculée qui inclut le temps d'envoi du message et de réception de - la réponse du serveur. - - - - - reply - - Le document de réponse retourné par le serveur. - - - - operationId - - - L'identifiant d'opération. Il peut être utilisé pour relier des - évènements entre eux, comme les écritures groupées (bulk writes), - qui peuvent dispatcher plusieurs commandes. - - - - - requestId - - - L'identifiant de requête. Il peut être utilisé pour associer cet - MongoDB\Driver\Monitoring\CommandSucceededEvent - avec un - MongoDB\Driver\Monitoring\CommandStartedEvent - correspondant. - - - - - serviceId - - - L'identifiant de service, ou &null; si le serveur ne le prend pas - en charge (c'est-à-dire qu'il n'utilise pas le mode équilibrage de - charge). - - - - - serverConnectionId - - L'identifiant de connexion au serveur, ou &null; s'il n'est pas disponible. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. La - propriété duration remplace la méthode - getDurationMicros. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.commandsucceededevent; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getcommandname.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getcommandname.xml deleted file mode 100644 index e91ef5361c..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getcommandname.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getCommandName - Renvoie le nom de la commande - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getCommandName - - - - Renvoie le nom de la commande (par exemple "find", - "aggregate"). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom de la commande. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdatabasename.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdatabasename.xml deleted file mode 100644 index 6fe8f5d123..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdatabasename.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getDatabaseName - Renvoie le nom de la base de données sur laquelle la commande a été exécutée - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getDatabaseName - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom de la base de données sur laquelle la commande a été exécutée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdurationmicros.xml deleted file mode 100644 index 1f431fadaa..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdurationmicros.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getDurationMicros - Renvoie la durée de la commande en microsecondes - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandSucceededEvent::getDurationMicros - - - - La durée de la commande est une valeur calculée qui inclut le temps pour envoyer - le message et recevoir la réponse du serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la durée de la commande en microsecondes. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/gethost.xml deleted file mode 100644 index 85d96fa2ad..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getHost - Renvoie le nom d'hôte du serveur pour la commande - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom d'hôte du serveur sur lequel la commande a été exécutée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getoperationid.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getoperationid.xml deleted file mode 100644 index d9945124fb..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getoperationid.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId - Renvoie l'identifiant de l'opération de la commande - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId - - - - L'identifiant de l'opération est généré par l'extension et peut être utilisé pour lier des événements - ensemble tels que des opérations d'écriture en masse, qui peuvent avoir été divisées - en plusieurs commandes au niveau du protocole. - - - - Depuis que plusieurs commandes peuvent partager le même identifiant d'opération, il n'est pas fiable - d'utiliser cette valeur pour associer des objets d'événement les uns aux autres. L'identifiant de la requête - renvoyé par - MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - devrait être utilisé à la place. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de l'opération de la commande. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId - MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getport.xml deleted file mode 100644 index ef8e64c563..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getPort - Renvoie le port du serveur pour la commande - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandSucceededEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le port du serveur sur lequel la commande a été exécutée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getreply.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getreply.xml deleted file mode 100644 index 5ce0661405..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getreply.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getReply - Renvoie le document de réponse de la commande - - - - &reftitle.description; - - final public objectMongoDB\Driver\Monitoring\CommandSucceededEvent::getReply - - - - Le document de réponse sera converti de BSON à PHP en utilisant les règles de - désérialisation - par défaut (par exemple, les documents BSON seront convertis en stdClass). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le document de réponse de la commande sous forme d'un objet - stdClass. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getrequestid.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getrequestid.xml deleted file mode 100644 index 363e2c899e..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getrequestid.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - Renvoie l'identifiant de la requête de la commande - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - - - - L'identifiant de la requête est généré par l'extension et peut être utilisé pour associer - cet MongoDB\Driver\Monitoring\CommandSucceededEvent avec un - MongoDB\Driver\Monitoring\CommandStartedEvent précédent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de la requête de la commande. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserver.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserver.xml deleted file mode 100644 index aa68a207bb..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserver.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer - Renvoie le serveur sur lequel la commande a été exécutée - - - - - - Cette méthode a été DÉPRÉCIÉE à partir de la version - 1.20.0 de l'extension et a été supprimée dans la version 2.0. Les applications doivent utiliser - MongoDB\Driver\Monitoring\CommandSucceededEvent::getHost - et - MongoDB\Driver\Monitoring\CommandSucceededEvent::getPort - à la place. - - - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Monitoring\CommandSucceededEvent::getServer - - - - Renvoie le MongoDB\Driver\Server sur lequel la commande - a été exécutée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le MongoDB\Driver\Server sur lequel la commande - a été exécutée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.method-removed; - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer - MongoDB\Driver\Cursor::getServer - MongoDB\Driver\WriteResult::getServer - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserverconnectionid.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserverconnectionid.xml deleted file mode 100644 index 64d764167b..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserverconnectionid.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServerConnectionId - Renvoie l'identifiant de connexion du serveur pour la commande - - - - &reftitle.description; - - final public intnullMongoDB\Driver\Monitoring\CommandSucceededEvent::getServerConnectionId - - - - Renvoie l'identifiant de connexion du serveur pour la commande. L'identifiant de connexion du serveur est - distinct du serveur (c'est-à-dire - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer) - et est renvoyé dans le champ "connectionId" d'une réponse de commande hello - MongoDB 4.2+. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de connexion du serveur, ou &null; s'il n'est pas disponible. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserviceid.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserviceid.xml deleted file mode 100644 index e8b9f52c1b..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserviceid.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServiceId - Renvoie l'identifiant du service de l'équilibreur de charge pour la commande - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdnullMongoDB\Driver\Monitoring\CommandSucceededEvent::getServiceId - - - - Lorsque le pilote est connecté à un cluster MongoDB via un équilibreur de charge, - l'identifiant du service correspond au champ serviceId dans la - réponse de la commande hello. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant du service de l'équilibreur de charge, ou &null; si le pilote n'est pas - connecté à un équilibreur de charge. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/logsubscriber.xml b/reference/mongodb/mongodb/driver/monitoring/logsubscriber.xml deleted file mode 100644 index e174de867d..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/logsubscriber.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - L'interface MongoDB\Driver\Monitoring\LogSubscriber - MongoDB\Driver\Monitoring\LogSubscriber - - - - -
    - &reftitle.intro; - - Les classes implémentant cette interface peuvent être enregistrées en tant - qu'observateurs et recevoir des messages de journalisation de l'extension. - Cela est similaire à la journalisation de débogage basée sur des flux - (c'est-à-dire mongodb.debug) sauf - que les messages de journalisation de niveau trace ne sont pas - reçus. - - - Comme avec la journalisation basée sur des flux, il est seulement possible d'enregistrer - un journalisateur globalement en utilisant MongoDB\Driver\Monitoring\addSubscriber. - L'extension n'est pas capable de distinguer les messages de journalisation pour des objets - MongoDB\Driver\Manager individuels. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\Driver\Monitoring\LogSubscriber - - - - - MongoDB\Driver\Monitoring\LogSubscriber - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - &Constants; - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_ERROR - 0 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_CRITICAL - 1 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_WARNING - 2 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_MESSAGE - 3 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_INFO - 4 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_DEBUG - 5 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_ERROR - - - Le niveau de journalisation d'erreur. Une condition d'erreur que l'extension - n'est pas capable de rapporter via son API. C'est le niveau de journalisation le plus sévère de l'extension. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_CRITICAL - - - Le niveau de journalisation critique. Une condition d'erreur avec une sévérité légèrement inférieure. Cette - constante existe pour la cohérence avec libmongoc; cependant, l'extension est peu - susceptible de l'utiliser en pratique. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_WARNING - - - Le niveau de journalisation d'avertissement. Indique une situation où un comportement indésirable - de l'application peut se produire. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_MESSAGE - - - Le niveau de journalisation de message ou de notification. Indique un événement inhabituel mais non - problématique. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_INFO - - - Le niveau de journalisation d'information. Informations de haut niveau sur le comportement normal du pilote. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_DEBUG - - - Le niveau de journalisation de débogage. Informations détaillées qui peuvent être utiles lors du débogage - d'une application. - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.logsubscriber; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/logsubscriber/log.xml b/reference/mongodb/mongodb/driver/monitoring/logsubscriber/log.xml deleted file mode 100644 index 915c2d5fce..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/logsubscriber/log.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::log - Méthode de notification pour un message de journal - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\LogSubscriber::log - intlevel - stringdomain - stringmessage - - - Si l'observateur est enregistré, cette méthode est appelée pour chaque message - de journal enregistré. - - - - - &reftitle.parameters; - - - level - - - Le niveau de gravité. Ce sera l'une des - constantes d'interface. - - - - - domain - - - Le nom du composant du pilote qui a émis le message de journal. - - - - - message - - - Le message de journal. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber.xml deleted file mode 100644 index 6e62495d74..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - L'interface MongoDB\Driver\Monitoring\SDAMSubscriber - MongoDB\Driver\Monitoring\SDAMSubscriber - - - - -
    - &reftitle.intro; - - Les classes peuvent implémenter cette interface pour enregistrer un observateur - d'événements qui est notifié pour divers événements SDAM. Voir les - spécifications Découverte et surveillance de serveur - et Surveillance de SDAM - pour plus d'informations. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\Driver\Monitoring\SDAMSubscriber - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -     - - &reference.mongodb.mongodb.driver.monitoring.entities.sdamsubscriber; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverchanged.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverchanged.xml deleted file mode 100644 index 31dae9626c..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverchanged.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverChanged - Méthode de notification pour un changement de description de serveur - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverChanged - MongoDB\Driver\Monitoring\ServerChangedEventevent - - - Si un observateur est enregistré, cette méthode est appelée lorsqu'une - description de serveur change. Par exemple, le type d'un serveur passant de secondaire à - primaire entraînerait un changement de la description de ce serveur. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerChangedEvent) - - - Un objet d'événement encapsulant des informations sur la description de - serveur modifiée. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerChangedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverclosed.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverclosed.xml deleted file mode 100644 index 894116ca79..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverclosed.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverClosed - Méthode de notification pour la fermeture d'un serveur - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverClosed - MongoDB\Driver\Monitoring\ServerClosedEventevent - - - Si un observateur est enregistré, cette méthode est appelée lorsqu'un serveur existant - est retiré de la topologie. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerClosedEvent) - - - Un objet d'événement encapsulant des informations sur le serveur fermé. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerClosedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatfailed.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatfailed.xml deleted file mode 100644 index 9c498122d7..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatfailed.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatFailed - Méthode de notification pour un échec de battement de cœur de serveur - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatFailed - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEventevent - - - Si un observateur est enregistré, cette méthode est appelée lorsqu'un battement de cœur de - serveur (c'est-à-dire une commande - hello - émise par le biais de - surveillance de serveur) échoue. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent) - - - Un objet d'événement encapsulant des informations sur l'échec de battement de cœur - de serveur. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatstarted.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatstarted.xml deleted file mode 100644 index 80fff6a3f9..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatstarted.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatStarted - Méthode de notification pour un battement de cœur de serveur démarré - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatStarted - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEventevent - - - Si un observateur est enregistré, cette méthode est appelée lorsqu'un battement de cœur de - serveur (c'est-à-dire une commande - hello - émise par le biais de - surveillance de serveur) est envoyé - au serveur. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent) - - - Un objet d'événement encapsulant des informations sur le battement de cœur de serveur - démarré. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatsucceeded.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatsucceeded.xml deleted file mode 100644 index 736eaa0ffa..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatsucceeded.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatSucceeded - Méthode de notification pour un battement de cœur de serveur réussi - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatSucceeded - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEventevent - - - Si un observateur est enregistré, cette méthode est appelée lorsqu'un battement de cœur de - serveur (c'est-à-dire une commande - hello - émise par le biais de - surveillance de serveur) réussit. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent) - - - Un objet d'événement encapsulant des informations sur le battement de cœur de serveur - réussi. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serveropening.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serveropening.xml deleted file mode 100644 index 83729797a4..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serveropening.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverOpening - Méthode de notification pour l'ouverture d'un serveur - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverOpening - MongoDB\Driver\Monitoring\ServerOpeningEventevent - - - Si un observateur est enregistré, cette méthode est appelée lorsqu'un nouveau serveur - est ajouté à la topologie. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerOpeningEvent) - - - Un objet d'événement encapsulant des informations sur le serveur ouvert. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerOpeningEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologychanged.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologychanged.xml deleted file mode 100644 index ef59836d31..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologychanged.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::topologyChanged - Méthode de notification pour un changement de description de topologie - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::topologyChanged - MongoDB\Driver\Monitoring\TopologyChangedEventevent - - - Si un observateur est enregistré, cette méthode est appelée lorsqu'une - description de topologie change. Par exemple, la découverte d'un nouveau primaire dans un ensemble de répliques - entraînerait un changement de la description de la topologie. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\TopologyChangedEvent) - - - Un objet d'événement encapsulant des informations sur la description de - topologie modifiée. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\TopologyChangedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyclosed.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyclosed.xml deleted file mode 100644 index a029b90dbc..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyclosed.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::topologyClosed - Méthode de notification pour la fermeture de topologie - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::topologyClosed - MongoDB\Driver\Monitoring\TopologyClosedEventevent - - - Si un observateur est enregistré, cette méthode est appelée lorsqu'une - topologie est fermée. - - - - En raison du comportement du pilote - de gestion et de persistance des connexions, - cet événement ne peut être observé que lorsqu'un - MongoDB\Driver\Manager est créé avec l'option du pilote - "disableClientPersistence" et libéré avant la fermeture de la requête (RSHUTDOWN). - - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\TopologyClosedEvent) - - - Un objet d'événement encapsulant des informations sur la topologie fermée. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\TopologyClosedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyopening.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyopening.xml deleted file mode 100644 index f20676dbd7..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyopening.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::topologyOpening - Méthode de notification pour l'ouverture de topologie - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::topologyOpening - MongoDB\Driver\Monitoring\TopologyOpeningEventevent - - - Si un observateur est enregistré, cette méthode est appelée lorsqu'une - topologie est ouverte. - - - - En raison du comportement du pilote - de gestion et de persistance des connexions, - cet événement peut ne pas être observé si un - MongoDB\Driver\Manager utilise un client - libmongoc précédemment persistant. - - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\TopologyOpeningEvent) - - - Un objet d'événement encapsulant des informations sur la topologie ouverte. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\TopologyOpeningEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent.xml deleted file mode 100644 index 5e2333f647..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - La classe MongoDB\Driver\Monitoring\ServerChangedEvent - MongoDB\Driver\Monitoring\ServerChangedEvent - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Monitoring\ServerChangedEvent - encapsule des informations sur une description de serveur modifiée. Par - exemple, le type d'un serveur passant de secondaire à primaire entraînerait - un changement de la description de ce serveur. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerChangedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerChangedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - public - readonly - MongoDB\Driver\ServerDescription - newDescription - - - public - readonly - MongoDB\Driver\ServerDescription - previousDescription - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - Le nom d'hôte du serveur. - - - - port - - Le port du serveur. - - - - topologyId - - L'identifiant de la topologie. - - - - newDescription - - La nouvelle description du serveur. - - - - previousDescription - - La description antérieure du serveur. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.serverchangedevent; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gethost.xml deleted file mode 100644 index d91b5d6372..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getHost - Renvoie le nom d'hôte du serveur - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerChangedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom d'hôte du serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getnewdescription.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getnewdescription.xml deleted file mode 100644 index d4a7f84ad1..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getnewdescription.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getNewDescription - Renvoie la nouvelle description du serveur - - - - &reftitle.description; - - final public MongoDB\Driver\ServerDescriptionMongoDB\Driver\Monitoring\ServerChangedEvent::getNewDescription - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la nouvelle MongoDB\Driver\ServerDescription - du serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getport.xml deleted file mode 100644 index 44e571c5a4..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getPort - Renvoie le port sur lequel ce serveur écoute - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerChangedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le port sur lequel ce serveur écoute. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getpreviousdescription.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getpreviousdescription.xml deleted file mode 100644 index 6774d7b32c..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getpreviousdescription.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getPreviousDescription - Renvoie la description précédente du serveur - - - - &reftitle.description; - - final public MongoDB\Driver\ServerDescriptionMongoDB\Driver\Monitoring\ServerChangedEvent::getPreviousDescription - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la MongoDB\Driver\ServerDescription précédente - du serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gettopologyid.xml deleted file mode 100644 index 60a6d3b967..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getTopologyId - Renvoie l'ID de topologie associé à ce serveur - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\ServerChangedEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'ID de topologie. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverclosedevent.xml deleted file mode 100644 index ed5836c69e..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - La classe MongoDB\Driver\Monitoring\ServerClosedEvent - MongoDB\Driver\Monitoring\ServerClosedEvent - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Monitoring\ServerClosedEvent - encapsule des informations sur un serveur fermé. Cela correspond à un - serveur existant étant retiré de la topologie. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerClosedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerClosedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - Le nom d'hôte du serveur. - - - - port - - Le port du serveur. - - - - topologyId - - L'identifiant de la topologie. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.serverclosedevent; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gethost.xml deleted file mode 100644 index 14c82f395e..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerClosedEvent::getHost - Renvoie le nom d'hôte du serveur - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerClosedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom d'hôte du serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/getport.xml deleted file mode 100644 index d038a5b142..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerClosedEvent::getPort - Renvoie le port sur lequel ce serveur écoute - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerClosedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le port sur lequel ce serveur écoute. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gettopologyid.xml deleted file mode 100644 index 56e88799dc..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerClosedEvent::getTopologyId - Renvoie l'ID de topologie associé à ce serveur - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\ServerClosedEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'ID de topologie. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent.xml deleted file mode 100644 index fa44b80486..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - La classe MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - encapsule des informations sur un échec de battement de cœur de serveur (c'est-à-dire - hello - commande émise par le biais de - surveillance du serveur). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - bool - awaited - - - public - readonly - int - duration - - - public - readonly - Exception - error - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - Le nom d'hôte du serveur. - - - - port - - Le port du serveur. - - - - awaited - - - Indique si le battement de cœur a utilisé un protocole en flux. L'extension - n'utilise pas le protocole en flux pour la surveillance, cette méthode - retournera donc toujours &false;. - - - - - duration - - - La durée du battement de cœur en microsecondes. La durée est une valeur - calculée qui inclut le temps d'envoi du message et de réception de la - réponse du serveur. - - - - - error - - L'exception qui a été levée lors de l'échec du battement de cœur. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. La - propriété duration remplace la méthode - getDurationMicros. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.serverheartbeatfailedevent; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getdurationmicros.xml deleted file mode 100644 index 84eaf68657..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getdurationmicros.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getDurationMicros - Renvoie la durée du signal périodique en microsecondes - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getDurationMicros - - - - La durée du signal périodique est une valeur calculée qui inclut le temps - pour envoyer le message et recevoir la réponse du serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la durée du signal périodique en microsecondes. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml deleted file mode 100644 index 9df11527b2..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getError - Renvoie l'exception associée au signal périodique échoué - - - - &reftitle.description; - - final public ExceptionMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getError - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'Exception associée au signal périodique - échoué. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/gethost.xml deleted file mode 100644 index aecfcf5a47..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getHost - Renvoie le nom d'hôte du serveur - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom d'hôte du serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getport.xml deleted file mode 100644 index cee18aad19..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getPort - Renvoie le port sur lequel ce serveur écoute - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le port sur lequel ce serveur écoute. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/isawaited.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/isawaited.xml deleted file mode 100644 index 5d092d56fc..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/isawaited.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::isAwaited - Renvoie si le signal périodique a utilisé un protocole de diffusion de flux - - - - &reftitle.description; - - final public boolMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::isAwaited - - - - Renvoie si le signal périodique a utilisé un protocole de diffusion de flux. - L'extension n'utilise pas le protocole de diffusion de flux pour la surveillance, donc cette méthode renverra - toujours &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent.xml deleted file mode 100644 index 2882467b31..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - La classe MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - encapsule des informations sur un battement de cœur de serveur démarré (c'est-à-dire - commande hello - émise par le biais de - la surveillance du serveur). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - bool - awaited - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - Le nom d'hôte du serveur. - - - - port - - Le port du serveur. - - - - awaited - - - Indique si le battement de cœur a utilisé un protocole en flux. L'extension - n'utilise pas le protocole en flux pour la surveillance, cette méthode - retournera donc toujours &false;. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.serverheartbeatstartedevent; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/gethost.xml deleted file mode 100644 index 237ab8b000..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getHost - Renvoie le nom d'hôte du serveur - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom d'hôte du serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/getport.xml deleted file mode 100644 index 32c71726db..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getPort - Renvoie le port sur lequel ce serveur écoute - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le port sur lequel ce serveur écoute. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/isawaited.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/isawaited.xml deleted file mode 100644 index de19073287..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/isawaited.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::isAwaited - Renvoie si le signal périodique a utilisé un protocole de diffusion de flux - - - - &reftitle.description; - - final public boolMongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::isAwaited - - - - Renvoie si le signal périodique a utilisé un protocole de diffusion de flux. - L'extension n'utilise pas le protocole de diffusion de flux pour la surveillance, donc cette méthode renverra - toujours &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent.xml deleted file mode 100644 index a90265b3ec..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - La classe MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - encapsule des informations sur un battement de cœur de serveur réussi (c'est-à-dire - commande hello - émise via - la surveillance du serveur). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - - - - final - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - bool - awaited - - - public - readonly - int - duration - - - public - readonly - object - reply - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - Le nom d'hôte du serveur. - - - - port - - Le port du serveur. - - - - awaited - - - Indique si le battement de cœur a utilisé un protocole de streaming. - L'extension n'utilise pas le protocole de streaming pour la surveillance, - donc cette méthode retournera toujours &false;. - - - - - duration - - - La durée en microsecondes du battement de cœur. La durée est une valeur - calculée qui inclut le temps d'envoi du message et de réception de la - réponse depuis le serveur. - - - - - reply - - Le document de réponse retourné par le serveur. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout de propriétés publiques readonly. La - propriété duration remplace la méthode - getDurationMicros. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.serverheartbeatsucceededevent; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getdurationmicros.xml deleted file mode 100644 index 287066510c..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getdurationmicros.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getDurationMicros - Renvoie la durée du signal périodique en microsecondes - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getDurationMicros - - - - La durée du signal périodique est une valeur calculée qui inclut le temps - pour envoyer le message et recevoir la réponse du serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la durée du signal périodique en microsecondes. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/gethost.xml deleted file mode 100644 index e2c94ff92c..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getHost - Renvoie le nom d'hôte du serveur - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom d'hôte du serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getport.xml deleted file mode 100644 index 0815e0b091..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getPort - Renvoie le port sur lequel ce serveur écoute - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le port sur lequel ce serveur écoute. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getreply.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getreply.xml deleted file mode 100644 index 6b0694735e..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getreply.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getReply - Renvoie le document de réponse du heartbeat - - - - &reftitle.description; - - final public objectMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getReply - - - - Le document de réponse sera converti de BSON en PHP en utilisant les règles de - désérialisation - par défaut (par exemple, les documents BSON seront convertis en stdClass). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le document de réponse du heartbeat sous forme d'un objet - stdClass. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/isawaited.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/isawaited.xml deleted file mode 100644 index 047eeb5004..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/isawaited.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::isAwaited - Renvoie si le signal périodique a utilisé un protocole de diffusion de flux - - - - &reftitle.description; - - final public boolMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::isAwaited - - - - Renvoie si le signal périodique a utilisé un protocole de diffusion de flux. - L'extension n'utilise pas le protocole de diffusion de flux pour la surveillance, donc cette méthode renverra - toujours &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent.xml b/reference/mongodb/mongodb/driver/monitoring/serveropeningevent.xml deleted file mode 100644 index 73000fc893..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - La classe MongoDB\Driver\Monitoring\ServerOpeningEvent - MongoDB\Driver\Monitoring\ServerOpeningEvent - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Monitoring\ServerOpeningEvent - encapsule des informations sur un serveur ouvert. Cela correspond à un - nouveau serveur étant ajouté à la topologie. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent - - - - final - - MongoDB\Driver\Monitoring\ServerOpeningEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - Le nom d'hôte du serveur. - - - - port - - Le port du serveur. - - - - topologyId - - L'identifiant de la topologie. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.serveropeningevent; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gethost.xml deleted file mode 100644 index 78834e17b5..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent::getHost - Renvoie le nom d'hôte du serveur - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerOpeningEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom d'hôte du serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/getport.xml deleted file mode 100644 index 18a5945a35..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent::getPort - Renvoie le port sur lequel ce serveur écoute - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerOpeningEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le port sur lequel ce serveur écoute. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gettopologyid.xml deleted file mode 100644 index 1dccc8af28..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent::getTopologyId - Renvoie l'ID de topologie associé à ce serveur - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\ServerOpeningEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'ID de topologie. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/subscriber.xml b/reference/mongodb/mongodb/driver/monitoring/subscriber.xml deleted file mode 100644 index c6626e2cb7..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/subscriber.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - L'interface MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\Subscriber - - - - -
    - &reftitle.intro; - - L'interface de base pour les observateurs d'événements. Elle est utilisée comme type de paramètre dans les fonctions - MongoDB\Driver\Monitoring\addSubscriber et - MongoDB\Driver\Monitoring\removeSubscriber et ne doit - pas être implémentée directement. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - - - - - Cette interface n'a pas de méthodes. Son seul but est d'être l'interface de base - pour tous les observateurs d'événements. - - -
    - -     - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent.xml b/reference/mongodb/mongodb/driver/monitoring/topologychangedevent.xml deleted file mode 100644 index 28632b16c8..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - La classe MongoDB\Driver\Monitoring\TopologyChangedEvent - MongoDB\Driver\Monitoring\TopologyChangedEvent - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Monitoring\TopologyChangedEvent - encapsule des informations sur une description de topologie modifiée. Par - exemple, la découverte d'un nouveau primaire dans un ensemble de répliques - entraînerait un changement de la description de la topologie. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent - - - - final - - MongoDB\Driver\Monitoring\TopologyChangedEvent - - - - - &Properties; - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - public - readonly - MongoDB\Driver\TopologyDescription - newDescription - - - public - readonly - MongoDB\Driver\TopologyDescription - previousDescription - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - topologyId - - L'identifiant de la topologie. - - - - newDescription - - La nouvelle description de la topologie. - - - - previousDescription - - La description antérieure de la topologie. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.topologychangedevent; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getnewdescription.xml b/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getnewdescription.xml deleted file mode 100644 index 0a5d8ed639..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getnewdescription.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent::getNewDescription - Renvoie la nouvelle description de la topologie - - - - &reftitle.description; - - final public MongoDB\Driver\TopologyDescriptionMongoDB\Driver\Monitoring\TopologyChangedEvent::getNewDescription - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la nouvelle MongoDB\Driver\TopologyDescription - pour la topologie. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getpreviousdescription.xml b/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getpreviousdescription.xml deleted file mode 100644 index 9b775cf225..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getpreviousdescription.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent::getPreviousDescription - Renvoie la description précédente de la topologie - - - - &reftitle.description; - - final public MongoDB\Driver\TopologyDescriptionMongoDB\Driver\Monitoring\TopologyChangedEvent::getPreviousDescription - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la description précédente MongoDB\Driver\TopologyDescription - pour la topologie. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/gettopologyid.xml deleted file mode 100644 index a3d4c0803d..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent::getTopologyId - Renvoie l'identifiant de la topologie - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\TopologyChangedEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de la topologie. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent.xml b/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent.xml deleted file mode 100644 index 8ffb5ec30a..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - La classe MongoDB\Driver\Monitoring\TopologyClosedEvent - MongoDB\Driver\Monitoring\TopologyClosedEvent - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Monitoring\TopologyClosedEvent - encapsule des informations sur une topologie fermée. - - - - En raison du comportement - de gestion et de persistance des connexions - du pilote, cet événement ne peut être observé que lorsqu'un - MongoDB\Driver\Manager est créé avec l'option du pilote - "disableClientPersistence" et libéré avant la fermeture de la requête (RSHUTDOWN). - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\TopologyClosedEvent - - - - final - - MongoDB\Driver\Monitoring\TopologyClosedEvent - - - - - &Properties; - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - topologyId - - L'identifiant de la topologie. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.topologyclosedevent; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent/gettopologyid.xml deleted file mode 100644 index 1289d9ec45..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyClosedEvent::getTopologyId - Renvoie l'identifiant de la topologie - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\TopologyClosedEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de la topologie. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent.xml b/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent.xml deleted file mode 100644 index 2911b08377..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - La classe MongoDB\Driver\Monitoring\TopologyOpeningEvent - MongoDB\Driver\Monitoring\TopologyOpeningEvent - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Monitoring\TopologyOpeningEvent - encapsule des informations sur une topologie ouverte. - - - - En raison du comportement - de gestion et de persistance des connexions - du pilote, cet événement peut ne pas être observé si un - MongoDB\Driver\Manager utilise un client - libmongoc précédemment persistant. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\TopologyOpeningEvent - - - - final - - MongoDB\Driver\Monitoring\TopologyOpeningEvent - - - - - &Properties; - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - topologyId - - L'identifiant de la topologie. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.monitoring.entities.topologyopeningevent; - -     - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent/gettopologyid.xml deleted file mode 100644 index 245cc77725..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyOpeningEvent::getTopologyId - Renvoie l'identifiant de la topologie - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\TopologyOpeningEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de la topologie. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/query.xml b/reference/mongodb/mongodb/driver/query.xml deleted file mode 100644 index 3cc5edb814..0000000000 --- a/reference/mongodb/mongodb/driver/query.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - La classe MongoDB\Driver\Query - MongoDB\Driver\Query - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Query est un objet de valeur - qui représente une requête de base de données. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Query - - - - final - - MongoDB\Driver\Query - - - - - &Methods; - - - - -
    - - -     - - &reference.mongodb.mongodb.driver.entities.query; - -     - - diff --git a/reference/mongodb/mongodb/driver/query/construct.xml b/reference/mongodb/mongodb/driver/query/construct.xml deleted file mode 100644 index 5b8766f339..0000000000 --- a/reference/mongodb/mongodb/driver/query/construct.xml +++ /dev/null @@ -1,542 +0,0 @@ - - - - - - MongoDB\Driver\Query::__construct - Créer une nouvelle requête - - - - &reftitle.description; - - final public MongoDB\Driver\Query::__construct - arrayobjectfilter - arraynullqueryOptions&null; - - - Construit un nouvel objet MongoDB\Driver\Query, qui est un objet - de valeur immuable qui représente une requête de base de données. La requête peut - ensuite être exécutée avec - MongoDB\Driver\Manager::executeQuery. - - - - - &reftitle.parameters; - - &mongodb.parameter.filter; - - queryOptions - - - - queryOptions - - - - Option - Type - Description - - - - - allowDiskUse - bool - - - Autorise MongoDB à utiliser des fichiers temporaires sur le disque - pour stocker des données dépassant la limite de mémoire système de - 100 mégaoctets lors du traitement d'une opération de tri bloquante. - - - - - allowPartialResults - bool - - - Pour les requêtes sur une collection fragmentée, retourne des - résultats partiels du mongos si certains fragments ne sont pas - disponibles au lieu de générer une erreur. - - - Retombe sur l'option dépréciée "partial" si non - spécifiée. - - - - - awaitData - bool - - Utiliser en conjonction avec l'option "tailable" pour - bloquer temporairement une opération getMore sur le curseur si à la fin - des données plutôt que de ne pas retourner de données. Après une période - d'attente, la requête se termine normalement. - - - - batchSize - int - - - Le nombre de documents à retourner dans le premier lot. Par défaut à - 101. Une taille de lot de 0 signifie que le curseur sera établi, mais - aucun document ne sera retourné dans le premier lot. - - - Dans les versions de MongoDB antérieures à 3.2, où les requêtes - utilisent le protocole de filaire hérité OP_QUERY, une taille de lot - de 1 fermera le curseur indépendamment du nombre de documents. - - - - &mongodb.option.collation; - - comment - mixed - - - Un commentaire arbitraire pour aider à tracer l'opération à travers - le profil de la base de données, la sortie currentOp et les journaux. - - - Le commentaire peut être n'importe quel type BSON valide pour MongoDB - 4.4+. Les versions de serveur antérieures ne prennent en charge que - les valeurs de chaîne. - - - Retombe sur l'option dépréciée "$comment" si non - spécifiée. - - - - - exhaust - bool - - - Le flux de données en aval à pleine puissance dans plusieurs paquets - "more", en supposant que le client lira entièrement toutes les données - interrogées. Plus rapide lorsqu'on tire beaucoup de données et - qu'on sait qu'on veut tout tirer. Remarque : le client n'est pas autorisé - à ne pas lire toutes les données sauf s'il ferme la connexion. - - - Cette option n'est pas prise en charge par la commande find dans MongoDB - 3.2+ et forcera le pilote à utiliser la version du protocole de filaire - hérité (c'est-à-dire OP_QUERY). - - - - - explain - bool - - - Si &true; le curseur MongoDB\Driver\Cursor retourné - contiendra un seul document qui décrit le processus et les index utilisés - pour retourner la requête. - - - Retombe sur l'option dépréciée "$explain" si non - spécifiée. - - - Cette option n'est pas prise en charge par la commande find dans MongoDB - 3.2+ et ne sera respectée que lors de l'utilisation de la version du - protocole de filaire hérité (c'est-à-dire OP_QUERY). La commande - explain - doit être utilisée sur MongoDB 3.0+. - - - - - hint - stringarrayobject - - - Spécification de l'index. Spécifiez soit le nom de l'index en tant que - chaîne, soit le modèle de clé d'index. Si spécifié, le système de requête - ne considérera que les plans utilisant l'index suggéré. - - - Retombe sur l'option dépréciée "hint" si non spécifiée. - - - - &mongodb.option.let; - - limit - int - - - Le nombre maximum de documents à retourner. Si non spécifié, alors - par défaut à aucune limite. Une limite de 0 est équivalente à ne pas - définir de limite. - - - - - max - arrayobject - - - La limite supérieure exclusive pour un index spécifique. - - - Retombe sur l'option dépréciée "$max" si non - spécifiée. - - - - - maxAwaitTimeMS - int - - - Entier positif indiquant la limite de temps en millisecondes pour le - serveur pour bloquer une opération getMore si aucune donnée n'est - disponible. Cette option ne doit être utilisée qu'en conjonction avec - les options "tailable" et - "awaitData". - - - - - maxTimeMS - int - - - La limite de temps cumulative en millisecondes pour le traitement des - opérations sur le curseur. MongoDB arrête l'opération au premier point - d'interruption le plus proche. - - - Retombe sur l'option dépréciée "$maxTimeMS" si non - spécifiée. - - - - - min - arrayobject - - - La limite inférieure inclusive pour un index spécifique. - - - Retombe sur l'option dépréciée "$min" si non - spécifiée. - - - - - noCursorTimeout - bool - - Empêche le serveur de mettre fin aux curseurs inactifs après une période - d'inactivité (10 minutes). - - - - projection - arrayobject - - - Les spécifications de projection - pour déterminer quels champs inclure dans les documents retournés. - - - Lors de l'utilisation de la - fonctionnalité ODM - pour désérialiser les documents en tant que leur classe PHP d'origine, - il faut s'assurer d'inclure le champ __pclass dans la - projection. Cela est nécessaire pour que la désérialisation fonctionne - et sans cela, l'extension renverra (par défaut) un objet - stdClass à la place. - - - - - readConcern - MongoDB\Driver\ReadConcern - - - Un read concern à appliquer à l'opération. Par défaut, le read concern - de l'URI - de connexion MongoDB - sera utilisé. - - - Cette option est disponible dans MongoDB 3.2+ et entraînera une - exception au moment de l'exécution si elle est spécifiée pour une - version de serveur plus ancienne. - - - - - returnKey - bool - - - Si &true;, ne retourne que les clés d'index dans les documents - résultants. La valeur par défaut est &false;. Si &true; et que la - commande find n'utilise pas d'index, les documents retournés seront vides. - - - Retombe sur l'option dépréciée "$returnKey" si non - spécifiée. - - - - - showRecordId - bool - - - Détermine si l'identifiant d'enregistrement doit être retourné pour - chaque document. Si &true;, ajoute un champ "$recordId" - de premier niveau aux documents retournés. - - - Retombe sur l'option dépréciée "$showDiskLoc" si non - spécifiée. - - - - - singleBatch - bool - - Détermine si le curseur doit être fermé après le premier lot. - Par défaut à &false;. - - - - skip - int - Nombre de documents à sauter. Par défaut à 0. - - - sort - arrayobject - - La spécification de tri pour l'ordonnancement des résultats. - - Retombe sur l'option dépréciée "$orderby" si non - spécifiée. - - - - - tailable - bool - Renvoie un curseur tailable pour une collection capée. - - - -
    -     -     -     -     -     - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - L'option "partial" a été supprimée. Utiliser - "allowPartialResults" à la place. - - - L'option "maxScan" a été supprimée. Le support - pour cette option a été supprimé dans MongoDB 4.2. - - - L'option "modifiers" a été supprimée. Cette option était - utilisée pour les modificateurs d'ancienne requête, qui sont tous dépréciés. - - - L'option "oplogReplay" a été supprimée. Cela est ignoré - dans MongoDB 4.4 et plus récent. - - - L'option "snapshot" a été supprimée. Son support a été - supprimé dans MongoDB 4.0. - - - Une valeur négative pour l'option "limit" n'implique plus - &true; pour l'option "singleBatch". Pour ne recevoir - qu'un seul lot de résultats, combinez une valeur positive - "limit" avec l'option - "singleBatch". - - - - - PECL mongodb 1.14.0 - - - Ajout de l'option "let". L'option - "comment" accepte désormais n'importe quel type. - - - - - PECL mongodb 1.8.0 - - - Ajout de l'option "allowDiskUse". - - - L'option "oplogReplay" est dépréciée. - - - - - PECL mongodb 1.5.0 - - - Les options "maxScan" et "snapshot" - sont dépréciées. - - - - - PECL mongodb 1.3.0 - - - Ajout de l'option "maxAwaitTimeMS" - - - - - PECL mongodb 1.2.0 - - - Ajout des options "allowPartialResults", - "collation", "comment", - "hint", "max", - "maxScan", "maxTimeMS", - "min", "returnKey", - "showRecordId", et "snapshot". - - - Renommer l'option "partial" en - "allowPartialResults". Pour la compatibilité ascendante, - "partial" sera toujours lu si - "allowPartialResults" n'est pas spécifié. - - - Supprime l'option "secondaryOk" obsolète. Pour les - requêtes utilisant le protocole de filaire hérité OP_QUERY, le pilote - définira le bit secondaryOk selon les besoins - conformément à la - Spécification de sélection du serveur. - - - - - PECL mongodb 1.1.0 - Ajout de l'option "readConcern". - - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\Query::__construct</function> - - 'bjori', - 'views' => [ - '$gte' => 100, - ], -]; - -$options = [ - /* Retourne uniquement les champs suivants dans les documents correspondants */ - 'projection' => [ - 'title' => 1, - 'article' => 1, - ], - /* Retourne les documents dans l'ordre décroissant des vues */ - 'sort' => [ - 'views' => -1 - ], -]; - -$query = new MongoDB\Driver\Query($filter, $options); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$readPreference = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY); -$cursor = $manager->executeQuery('databaseName.collectionName', $query, ['readPreference' => $readPreference]); - -foreach($cursor as $document) { - var_dump($document); -} - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeQuery - MongoDB\Driver\Cursor - - - -     - - diff --git a/reference/mongodb/mongodb/driver/readconcern.xml b/reference/mongodb/mongodb/driver/readconcern.xml deleted file mode 100644 index a31717131c..0000000000 --- a/reference/mongodb/mongodb/driver/readconcern.xml +++ /dev/null @@ -1,340 +0,0 @@ - - - - La classe MongoDB\Driver\ReadConcern - MongoDB\Driver\ReadConcern - - - - -
    - &reftitle.intro; - - MongoDB\Driver\ReadConcern contrôle le niveau - d'isolation pour les opérations de lecture pour les ensembles de réplicas et les fragments d'ensembles de réplicas. Cette - option nécessite MongoDB 3.2 ou ultérieur. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\ReadConcern - - - - final - - MongoDB\Driver\ReadConcern - - - - MongoDB\BSON\Serializable - - - - Serializable - - - - &Properties; - - public - readonly - stringnull - level - - - &Constants; - - const - string - MongoDB\Driver\ReadConcern::AVAILABLE - "available" - - - const - string - MongoDB\Driver\ReadConcern::LINEARIZABLE - "linearizable" - - - const - string - MongoDB\Driver\ReadConcern::LOCAL - "local" - - - const - string - MongoDB\Driver\ReadConcern::MAJORITY - "majority" - - - const - string - MongoDB\Driver\ReadConcern::SNAPSHOT - "snapshot" - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - level - - - Le niveau de lecture. &null; si aucun niveau n'a été spécifié. - - - - -
    - - - -
    - &reftitle.constants; - - - - MongoDB\Driver\ReadConcern::AVAILABLE - - - Par défaut pour les lectures sur les secondaires lorsque - afterClusterTime et level ne sont pas - spécifiés. - - - La requête renvoie les données les plus récentes de l'instance. Ne garantit - pas que les données ont été écrites sur la majorité des membres de l'ensemble de réplicas - (c'est-à-dire qu'elles peuvent être annulées). - - - Pour les collections non fragmentées (y compris les collections dans un - déploiement autonome ou un déploiement de réplicas), les lectures - "local" et "available" se comportent de manière identique. - - - Pour un cluster partagé, la lecture "available" fournit - une plus grande tolérance aux partitions car elle n'attend pas pour - garantir des garanties de cohérence. Cependant, une requête avec - une lecture "available" peut renvoyer des documents orphelins - si le fragment est en cours de migration de morceaux car la lecture - "available", contrairement à la lecture - "local", ne contacte pas le - primaire du fragment ni les serveurs de configuration pour obtenir des métadonnées mises à jour. - - - - - - MongoDB\Driver\ReadConcern::LINEARIZABLE - - - La requête renvoie les données qui reflètent toutes les écritures réussies émises avec un - niveau d'écriture de "majority" et - reconnu avant le début de l'opération de lecture. Pour les ensembles de réplicas - qui fonctionnent avec writeConcernMajorityJournalDefault défini - sur &true;, la lecture linéarisable renvoie des données qui ne seront jamais - annulées. - - - Avec writeConcernMajorityJournalDefault défini sur - &false;, MongoDB n'attendra pas que les écritures w: "majority" - soient durables avant d'accuser réception des écritures. En tant que tel, - les opérations d'écriture "majority" pourraient éventuellement être annulées - en cas de perte d'un membre de l'ensemble de réplicas. - - - Il est possible de spécifier un niveau de lecture linéarisable pour les opérations de lecture sur le - primaire uniquement. - - - La lecture linéarisable garantit que les opérations - de lecture spécifient un filtre de requête qui identifie de manière unique un seul - document. - - - - Toujours utiliser maxTimeMS avec une lecture linéarisable - en cas de non-disponibilité de la majorité des membres porteurs de données. - maxTimeMS garantit que l'opération ne bloque pas - indéfiniment et garantit plutôt que l'opération renvoie une erreur si - le niveau de lecture ne peut pas être satisfait. - - - - La lecture linéarisable nécessite MongoDB 3.4. - - - - - - MongoDB\Driver\ReadConcern::LOCAL - - - Défaut pour les lectures sur le primaire si level n'est pas - spécifié et pour les lectures sur les secondaires si level - n'est pas spécifié mais que afterClusterTime est spécifié. - - - La requête renvoie les données les plus récentes de l'instance. Ne garantit - pas que les données ont été écrites sur la majorité des membres de l'ensemble de réplicas - (c'est-à-dire qu'elles peuvent être annulées). - - - - - - MongoDB\Driver\ReadConcern::MAJORITY - - - La requête renvoie les données les plus récentes reconnues comme ayant été - écrites sur la majorité des membres de l'ensemble de réplicas. - - - Pour utiliser le niveau de lecture "majority", les ensembles de réplicas - doivent utiliser le moteur de stockage WiredTiger et le protocole d'élection version 1. - - - - - - MongoDB\Driver\ReadConcern::SNAPSHOT - - - La lecture "snapshot" est disponible pour les transactions - multi-documents, et à partir de MongoDB 5.0, pour certaines opérations de lecture - en dehors des transactions multi-documents. - - - Si la transaction ne fait pas partie d'une session cohérente, lors de - la validation de la transaction avec un niveau d'écriture "majority", les - opérations de transaction sont garanties d'avoir lu à partir d'un instantané des données - majoritairement engagées. - - - Si la transaction fait partie d'une session cohérente, lors de - la validation de la transaction avec un niveau d'écriture "majority", les - opérations de transaction sont garanties d'avoir lu à partir d'un instantané des données - majoritairement engagées qui assure la cohérence causale avec l'opération immédiatement - précédent le début de la transaction. - - - En dehors des transactions multi-documents, le niveau de lecture - "snapshot" est disponible sur les primaires et les secondaires - pour les opérations de lecture suivantes : find, - aggregate et distinct (sur - les collections non fragmentées). Toutes les autres commandes de lecture interdisent - "snapshot". - - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - PECL mongodb 1.11.0 - - - Ajout de la constante - MongoDB\Driver\ReadConcern::SNAPSHOT. - - - - - PECL mongodb 1.7.0 - - Implémente Serializable. - - - - PECL mongodb 1.4.0 - - - Ajout de la constante - MongoDB\Driver\ReadConcern::MAJORITY. - - - - - PECL mongodb 1.2.0 - - - Ajout de la constante - MongoDB\Driver\ReadConcern::LINEARIZABLE - - - Implémente MongoDB\BSON\Serializable. - - - - - - -
    - -
    - &reftitle.seealso; - - Référence de lecture - -
    - -     - - &reference.mongodb.mongodb.driver.entities.readconcern; - -     - - diff --git a/reference/mongodb/mongodb/driver/readconcern/bsonserialize.xml b/reference/mongodb/mongodb/driver/readconcern/bsonserialize.xml deleted file mode 100644 index 9b5e63cc7d..0000000000 --- a/reference/mongodb/mongodb/driver/readconcern/bsonserialize.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::bsonSerialize - Renvoie un objet pour la sérialisation BSON - - - - &reftitle.description; - - final public stdClassMongoDB\Driver\ReadConcern::bsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un objet pour la sérialisation du ReadConcern en BSON. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadConcern::bsonSerialize</function> avec un read concern vide - -bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($rc)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - - - <function>MongoDB\Driver\ReadConcern::bsonSerialize</function> avec un read concern local - -bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($rc)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - string(5) "local" -} - -{ "level" : "local" } -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - Référence de Read Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern/construct.xml b/reference/mongodb/mongodb/driver/readconcern/construct.xml deleted file mode 100644 index 27a6f1f08b..0000000000 --- a/reference/mongodb/mongodb/driver/readconcern/construct.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::__construct - Créer un nouveau ReadConcern - - - - &reftitle.description; - - final public MongoDB\Driver\ReadConcern::__construct - stringnulllevel&null; - - - Construit un nouvel MongoDB\Driver\ReadConcern, qui est - un objet de valeur immuable. - - - - - &reftitle.parameters; - - - level - - - Le niveau du read concern. - Il est possible d'utiliser, sans toutefois s'y limiter, une des - constantes de classe. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\ReadConcern::__construct</function> - - -]]> - - - - - - - &reftitle.seealso; - - Référence de Read Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern/getlevel.xml b/reference/mongodb/mongodb/driver/readconcern/getlevel.xml deleted file mode 100644 index 3f18363996..0000000000 --- a/reference/mongodb/mongodb/driver/readconcern/getlevel.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::getLevel - Renvoie l'option "level" du ReadConcern - - - - &reftitle.description; - - final public stringnullMongoDB\Driver\ReadConcern::getLevel - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'option "level" du ReadConcern. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\ReadConcern::getLevel</function> - -getLevel()); - -$rc = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::LOCAL); -var_dump($rc->getLevel()); - -$rc = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY); -var_dump($rc->getLevel()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Référence de Read Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern/isdefault.xml b/reference/mongodb/mongodb/driver/readconcern/isdefault.xml deleted file mode 100644 index ec6873cef1..0000000000 --- a/reference/mongodb/mongodb/driver/readconcern/isdefault.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::isDefault - Vérifie si c'est le read concern par défaut - - - - &reftitle.description; - - final public boolMongoDB\Driver\ReadConcern::isDefault - - - - Renvoie si c'est le read concern par défaut (c'est-à-dire sans - options spécifiées). Cette méthode est principalement destinée à être utilisée en conjonction avec - MongoDB\Driver\Manager::getReadConcern pour déterminer - si le Manager a été construit sans aucune option de read concern. - - - Le pilote n'inclura pas de read concern par défaut dans ses opérations de lecture - (par exemple MongoDB\Driver\Manager::executeQuery) afin - de permettre au serveur d'appliquer son propre défaut. Les bibliothèques qui accèdent - au read concern du Manager pour l'inclure dans leurs propres commandes de lecture - devraient utiliser cette méthode pour s'assurer que les read concerns par défaut sont laissés non définis. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si c'est le read concern par défaut et &false; sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\ReadConcern::isDefault</function> - -isDefault()); - -$rc = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY); -var_dump($rc->isDefault()); - -$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/?readConcernLevel=majority'); -$rc = $manager->getReadConcern(); -var_dump($rc->isDefault()); - -$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/'); -$rc = $manager->getReadConcern(); -var_dump($rc->isDefault()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::getReadConcern - Référence de Read Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference.xml b/reference/mongodb/mongodb/driver/readpreference.xml deleted file mode 100644 index caa9bdf4c9..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference.xml +++ /dev/null @@ -1,362 +0,0 @@ - - - - - - La classe MongoDB\Driver\ReadPreference - MongoDB\Driver\ReadPreference - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\ReadPreference - - - - final - - MongoDB\Driver\ReadPreference - - - - MongoDB\BSON\Serializable - - - - Serializable - - - - &Properties; - - public - readonly - string - mode - - - public - readonly - arraynull - tags - - - public - readonly - int - maxStalenessSeconds - - - public - readonly - objectnull - hedge - - - &Constants; - - const - string - MongoDB\Driver\ReadPreference::PRIMARY - primary - - - const - string - MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED - primaryPreferred - - - const - string - MongoDB\Driver\ReadPreference::SECONDARY - secondary - - - const - string - MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED - secondaryPreferred - - - const - string - MongoDB\Driver\ReadPreference::NEAREST - nearest - - - const - int - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS - -1 - - - const - int - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS - 90 - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - mode - - - Le mode de préférence de lecture sous forme de chaîne (par exemple - "primary", "secondary"). - - - - - tags - - - La liste des jeux d'étiquettes utilisés par la préférence de lecture, ou - &null; si aucun jeu d'étiquettes n'a été spécifié. - - - - - maxStalenessSeconds - - - L'obsolescence maximale en secondes pour les lectures, ou - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS - si aucune obsolescence maximale n'a été spécifiée. - - - - - hedge - - - Un document spécifiant les options de couverture (hedge) pour la préférence - de lecture, ou &null; si aucune option de couverture n'a été spécifiée. - - - - Cette propriété est obsolète car les lectures couvertes (hedged reads) sont - obsolètes dans MongoDB 8.0. - - - - - -
    - - - -
    - &reftitle.constants; - - - - MongoDB\Driver\ReadPreference::PRIMARY - - - Toutes les opérations lues à partir du jeu de réplicas actuel primaire. - Il s'agit de la préférence de lecture par défaut pour MongoDB. - - - - - - MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED - - - Dans la plupart des situations, les opérations sont lues à partir du - primaire, mais s'il n'est pas disponible, les opérations sont lues à partir - de membres secondaires. - - - - - - MongoDB\Driver\ReadPreference::SECONDARY - - - Toutes les opérations sont lues à partir des membres secondaires du jeu de réplicas. - - - - - - MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED - - - Dans la plupart des cas, les opérations sont lues par des membres - secondaires, mais si aucun membre secondaire n'est disponible, les - opérations sont lues à partir du primaire. - - - - - - MongoDB\Driver\ReadPreference::NEAREST - - - Les opérations sont lues à partir du membre du jeu de réplicas avec la - latence de réseau la moins élevée, quel que soit le type du membre. - - - - - - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS - - - La valeur par défaut de l'option "maxStalenessSeconds" - est de ne spécifier aucune limite sur l'obsolescence maximale, ce qui - signifie que le pilote ne prendra pas en compte le décalage d'un - secondaire lors du choix de l'endroit où diriger une opération de lecture. - - - - - - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS - - - La valeur minimale de l'option "maxStalenessSeconds" - est de 90 secondes. Le pilote estime l'obsolescence des secondes en - vérifiant périodiquement la dernière date d'écriture de chaque membre du - jeu de réplicas. Comme ces contrôles sont peu fréquents, l'estimation de - l'obsolescence est grossière. Ainsi, le pilote ne peut pas appliquer une - valeur d'obsolescence maximale inférieure à 90 secondes. - - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - PECL mongodb 2.0.0 - - - Supprimer les constantes - MongoDB\Driver\ReadPreference::RP_PRIMARY, - MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED, - MongoDB\Driver\ReadPreference::RP_SECONDARY, - MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED, - et MongoDB\Driver\ReadPreference::RP_NEAREST. - La méthode getMode a également été supprimée. - - - - - PECL mongodb 1.20.0 - - - Les constantes - MongoDB\Driver\ReadPreference::RP_PRIMARY, - MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED, - MongoDB\Driver\ReadPreference::RP_SECONDARY, - MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED, - et MongoDB\Driver\ReadPreference::RP_NEAREST - sont obsolètes. - - - - - PECL mongodb 1.7.0 - - - Ajout des constantes - MongoDB\Driver\ReadPreference::PRIMARY, - MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED, - MongoDB\Driver\ReadPreference::SECONDARY, - MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED, - MongoDB\Driver\ReadPreference::NEAREST. - - - Implémente Serializable. - - - - - PECL mongodb 1.2.0 - - - Ajout des constantes - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS - et - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS. - - - Implémente MongoDB\BSON\Serializable. - - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.entities.readpreference; - -     - - diff --git a/reference/mongodb/mongodb/driver/readpreference/bsonserialize.xml b/reference/mongodb/mongodb/driver/readpreference/bsonserialize.xml deleted file mode 100644 index 72cdb3a39a..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/bsonserialize.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::bsonSerialize - Renvoie un objet pour la sérialisation BSON - - - - &reftitle.description; - - final public stdClassMongoDB\Driver\ReadPreference::bsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un objet pour la sérialisation de la ReadPreference en BSON. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadPreference::bsonSerialize</function> avec une préférence de lecture primaire - -bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($rp)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - string(7) "primary" -} - -{ "mode" : "primary" } -]]> - - - - <function>MongoDB\Driver\ReadPreference::bsonSerialize</function> avec une préférence de lecture secondaire - - 'ny'], - ['dc' => 'sf', 'use' => 'reporting'], - [] - ] -); -var_dump($rp->bsonSerialize()); - -echo "\n", MongoDB\BSON\toJSON(MongoDB\BSON\fromPHP($rp)); - -?> -]]> - - &example.outputs.similar; - - - string(9) "secondary" - ["tags"]=> - array(3) { - [0]=> - object(stdClass)#1 (1) { - ["dc"]=> - string(2) "ny" - } - [1]=> - object(stdClass)#5 (2) { - ["dc"]=> - string(2) "sf" - ["use"]=> - string(9) "reporting" - } - [2]=> - object(stdClass)#4 (0) { - } - } -} - -{ "mode" : "secondary", "tags" : [ { "dc" : "ny" }, { "dc" : "sf", "use" : "reporting" }, { } ] } -]]> - - - - <function>MongoDB\Driver\ReadPreference::bsonSerialize</function> avec une préférence de lecture secondaire et un délai maximal - - 120] -); -var_dump($rp->bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($rp)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - string(9) "secondary" - ["maxStalenessSeconds"]=> - int(120) -} - -{ "mode" : "secondary", "maxStalenessSeconds" : 120 } -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - Référence de Read Preference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/construct.xml b/reference/mongodb/mongodb/driver/readpreference/construct.xml deleted file mode 100644 index 2ada67eb4b..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/construct.xml +++ /dev/null @@ -1,353 +0,0 @@ - - - - - - - MongoDB\Driver\ReadPreference::__construct - Créer un nouveau ReadPreference - - - - &reftitle.description; - - final public MongoDB\Driver\ReadPreference::__construct - stringmode - arraynulltagSets&null; - arraynulloptions&null; - - - Construit un nouveau MongoDB\Driver\ReadPreference, qui est un objet de valeur immuable. - - - - - - &reftitle.parameters; - - - mode - - - - Mode de préférence de lecture - - - - Valeur - Description - - - - - "primary" - - - Toutes les opérations lues à partir du jeu de réplicas actuel primaire. - Il s'agit de la préférence de lecture par défaut pour MongoDB. - - - - - "primaryPreferred" - - - Dans la plupart des situations, les opérations sont lues à partir du - primaire, mais s'il n'est pas disponible, les opérations sont lues à - partir d'un membre secondaire. - - - - - "secondary" - - - Toutes les opérations sont lues à partir des membres secondaires du jeu - de réplicas. - - - - - "secondaryPreferred" - - - Dans la plupart des cas, les opérations sont lues par des membres - secondaires, mais si aucun membre secondaire n'est disponible, les - opérations sont lues à partir du primaire. - - - - - "nearest" - - - Opérations lues à partir du membre du jeu de réplicas ayant la latence - réseau la moins élevée, quel que soit le type du membre. - - - - - -
    -     -     -     - - tagSets - - - Les jeux de tag permettent de cibler des opérations de lecture sur des - membres spécifiques d'un jeu de réplicas. Ce paramètre doit être un tableau de - tableaux associatifs, qui contiennent chacun zéro ou plusieurs paires - clé/valeur. Lors de la sélection d'un serveur pour une opération de lecture, - le pilote tente de sélectionner un nœud comportant toutes les balises d'un - ensemble (c'est-à-dire le tableau associatif de paires clé/valeur). Si la - sélection échoue, le pilote essaiera les jeux suivants. Un jeu de balises vide - (array()) correspond à n'importe quel nœud et peut être - utilisé comme secours. - - - Les tags ne sont pas compatibles avec le mode - "primary" et, en général, - s'appliquent uniquement lors de la sélection d'un membre secondaire d'un jeu - pour une opération de lecture. Toutefois, le mode - "nearest", lorsqu'il est - combiné avec un jeu de balises, sélectionne le membre correspondant avec la - latence réseau la plus basse. Ce membre peut être primaire ou secondaire. - - - - - options - - - - options - - - - Option - Type - Description - - - - - hedge - objectarray - - Spécifie si l'on doit utiliser ou non les lectures - couvertes, qui sont supportées depuis MongoDB 4.4+ pour les - requêtes partagées. - - Les lectures couvertes côté serveur sont disponibles pour toutes les - préférences de lecture non primaires, et sont activées par défaut - lors de l'utilisation du mode "nearest". Cette option - permet d'activer explicitement les lectures couvertes côté serveur - pour les préférences de lecture non primaires en spécifiant - ['enabled' => true], ou de désactiver explicitement - les lectures couvertes côté serveur pour la préférence de lecture - "nearest" en spécifiant - ['enabled' => false]. - - - - - maxStalenessSeconds - &integer; - - - Spécifie un décalage de réplication maximal, ou "obsolescence", pour - les lectures des secondaires. Lorsque l'obsolescence estimée d'un - secondaire dépasse cette valeur, le pilote cesse de l'utiliser pour les - opérations de lecture. - - - Si elle est spécifiée, l'obsolescence maximale doit être un entier signé - 32 bits supérieur ou égal à - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS. - - - Par défaut, - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS, - ce qui signifie que le pilote ne prendra pas en compte le décalage d'un - secondaire lors du choix de l'endroit où diriger une opération de - lecture. - - - Cette option n'est pas compatible avec le mode - "primary". - La spécification d'une obsolescence maximale requiert également que - toutes les instances MongoDB du déploiement utilisent MongoDB 3.4+. Une - exception sera levée au moment de l'exécution si toutes les instances de - MongoDB dans le déploiement sont d'une version de serveur plus ancienne. - - - - - -
    -     -     -     -     -     - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lève une exception MongoDB\Driver\Exception\InvalidArgumentException si mode est incorrect. - Lève une exception MongoDB\Driver\Exception\InvalidArgumentException si tagSets est fourni pour une préférence de lecture primaire ou est incorrect (c.-à-d. pas un tableau de zéro ou plus de documents). - Lève une exception MongoDB\Driver\Exception\InvalidArgumentException si l'option "maxStalenessSeconds" est fournie pour une préférence de lecture primaire ou est hors de la plage. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - Passer un int pour l'argument mode - n'est plus pris en charge. - - - - PECL mongodb 1.20.0 - - Passer un int pour l'argument mode - est DÉPRÉCIÉ. - - - - PECL mongodb 1.8.0 - - Ajout de l'option "hedge". - - - - PECL mongodb 1.3.0 - - - L'argument mode accepte maintenant une valeur de - chaîne, ce qui est compatible avec l'option URI - "readPreference" pour - MongoDB\Driver\Manager::__construct - - - - - PECL mongodb 1.2.0 - - - Ajout d'un troisième argument d'options, qui prend - en charge l'option "maxStalenessSeconds" . - - - - - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\ReadPreference::__construct</function> - - 'ny']])); - -/* Nécessite un nœud secondaire dont le décalage de réplication se trouve dans les deux minutes */ -var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY, null, ['maxStalenessSeconds' => 120])); - -/* Active explicitement le serveur des lectures croisées */ -var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY, null, ['hedge' => ['enabled' => true]])); -?> -]]> - - &example.outputs; - - - string(18) "secondaryPreferred" -} -object(MongoDB\Driver\ReadPreference)#1 (2) { - ["mode"]=> - string(7) "nearest" - ["tags"]=> - array(1) { - [0]=> - object(stdClass)#2 (1) { - ["dc"]=> - string(2) "ny" - } - } -} -object(MongoDB\Driver\ReadPreference)#1 (2) { - ["mode"]=> - string(9) "secondary" - ["maxStalenessSeconds"]=> - int(120) -} -object(MongoDB\Driver\ReadPreference)#1 (2) { - ["mode"]=> - string(9) "secondary" - ["hedge"]=> - object(stdClass)#1 (1) { - ["enabled"]=> - bool(true) - } -} -]]> - - - - - - - &reftitle.seealso; - - Read Preference reference - - - -     - - diff --git a/reference/mongodb/mongodb/driver/readpreference/gethedge.xml b/reference/mongodb/mongodb/driver/readpreference/gethedge.xml deleted file mode 100644 index 0aeddeaf52..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/gethedge.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getHedge - Renvoie l'option "hedge" du ReadPreference - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ReadPreference::getHedge - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'option "hedge" du ReadPreference. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - Référence de Read Preference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/getmaxstalenessseconds.xml b/reference/mongodb/mongodb/driver/readpreference/getmaxstalenessseconds.xml deleted file mode 100644 index 14af1040e9..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/getmaxstalenessseconds.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getMaxStalenessSeconds - Renvoie l'option "maxStalenessSeconds" du ReadPreference - - - - &reftitle.description; - - final public intMongoDB\Driver\ReadPreference::getMaxStalenessSeconds - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'option "maxStalenessSeconds" du ReadPreference. Si aucun délai - maximal n'a été spécifié, - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS sera - retourné. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\ReadPreference::getMaxStalenessSeconds</function> - -getMaxStalenessSeconds()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY, null, [ - 'maxStalenessSeconds' => MongoDB\Driver\ReadPreference::NO_MAX_STALENESS, -]); -var_dump($rp->getMaxStalenessSeconds()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY, null, [ - 'maxStalenessSeconds' => MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS, -]); -var_dump($rp->getMaxStalenessSeconds()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY, null, [ - 'maxStalenessSeconds' => 1000, -]); -var_dump($rp->getMaxStalenessSeconds()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Référence de Read Preference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/getmode.xml b/reference/mongodb/mongodb/driver/readpreference/getmode.xml deleted file mode 100644 index 7da4266c59..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/getmode.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getMode - Renvoie l'option "mode" du ReadPreference - - - - - - Cette fonction a été DÉPRÉCIÉE depuis la version 1.20.0 de l'extension - et a été supprimée dans la version 2.0. Les applications devraient utiliser - MongoDB\Driver\ReadPreference::getModeString à la place. - - - - - - &reftitle.description; - - final public intMongoDB\Driver\ReadPreference::getMode - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'option "mode" du ReadPreference. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.method-removed; - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\ReadPreference::getMode</function> - -getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED); -var_dump($rp->getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY); -var_dump($rp->getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED); -var_dump($rp->getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::NEAREST); -var_dump($rp->getMode()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadPreference::getModeString - Référence de Read Preference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/getmodestring.xml b/reference/mongodb/mongodb/driver/readpreference/getmodestring.xml deleted file mode 100644 index 1b9dafb5d9..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/getmodestring.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getModeString - Renvoie l'option "mode" du ReadPreference - - - - &reftitle.description; - - final public stringMongoDB\Driver\ReadPreference::getModeString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'option "mode" du ReadPreference en tant que chaîne. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\ReadPreference::getModeString</function> - -getModeString()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED); -var_dump($rp->getModeString()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY); -var_dump($rp->getModeString()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED); -var_dump($rp->getModeString()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::NEAREST); -var_dump($rp->getModeString()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadPreference::getMode - Référence de Read Preference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/gettagsets.xml b/reference/mongodb/mongodb/driver/readpreference/gettagsets.xml deleted file mode 100644 index c340319082..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/gettagsets.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getTagSets - Renvoie l'option "tagSets" de ReadPreference - - - - &reftitle.description; - - final public arrayMongoDB\Driver\ReadPreference::getTagSets - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'option "tagSets" de ReadPreference. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\ReadPreference::getTagSets</function> - -getTagSets()); - -$rp = new MongoDB\Driver\ReadPreference($mode, []); -var_dump($rp->getTagSets()); - -/* Préférer un nœud à New York, mais revenir à tout nœud disponible. */ -$rp = new MongoDB\Driver\ReadPreference($mode, [['dc' => 'ny']]); -var_dump($rp->getTagSets()); - -/* Préférer un nœud à New York, suivi d'un nœud à San Francisco - étiqueté pour le reporting, et enfin revenir à tout nœud disponible. */ -$rp = new MongoDB\Driver\ReadPreference($mode, [ - ['dc' => 'ny'], - ['dc' => 'sf', 'use' => 'reporting'], - [], -]); -var_dump($rp->getTagSets()); - -?> -]]> - - &example.outputs; - - - array(1) { - ["dc"]=> - string(2) "ny" - } - [1]=> - array(0) { - } -} -array(3) { - [0]=> - array(1) { - ["dc"]=> - string(2) "ny" - } - [1]=> - array(2) { - ["dc"]=> - string(2) "sf" - ["use"]=> - string(9) "reporting" - } - [2]=> - array(0) { - } -} -]]> - - - - - - - &reftitle.seealso; - - Référence de Read Preference - - - - - - diff --git a/reference/mongodb/mongodb/driver/server.xml b/reference/mongodb/mongodb/driver/server.xml deleted file mode 100644 index a5a3d8ca28..0000000000 --- a/reference/mongodb/mongodb/driver/server.xml +++ /dev/null @@ -1,246 +0,0 @@ - - - - - - - La classe MongoDB\Driver\Server - MongoDB\Driver\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Server - - - - final - - MongoDB\Driver\Server - - - - &Constants; - - const - int - MongoDB\Driver\Server::TYPE_UNKNOWN - 0 - - - const - int - MongoDB\Driver\Server::TYPE_STANDALONE - 1 - - - const - int - MongoDB\Driver\Server::TYPE_MONGOS - 2 - - - const - int - MongoDB\Driver\Server::TYPE_POSSIBLE_PRIMARY - 3 - - - const - int - MongoDB\Driver\Server::TYPE_RS_PRIMARY - 4 - - - const - int - MongoDB\Driver\Server::TYPE_RS_SECONDARY - 5 - - - const - int - MongoDB\Driver\Server::TYPE_RS_ARBITER - 6 - - - const - int - MongoDB\Driver\Server::TYPE_RS_OTHER - 7 - - - const - int - MongoDB\Driver\Server::TYPE_RS_GHOST - 8 - - - const - int - MongoDB\Driver\Server::TYPE_LOAD_BALANCER - 9 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\Server::TYPE_UNKNOWN - - Type de serveur inconnu, retourné par MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_STANDALONE - - Type de serveur autonome, retourné par MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_MONGOS - - Type de serveur Mongos, retourné par MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_POSSIBLE_PRIMARY - - Type de serveur primaire possible du jeu de réplique, retourné par MongoDB\Driver\Server::getType. - Un serveur peut être identifié comme un possible primaire s'il n'a pas encore été vérifié, mais un autre membre du jeu de réplique pense qu'il est le primaire. - - - - - MongoDB\Driver\Server::TYPE_RS_PRIMARY - - Type de serveur primaire du jeu de réplique, retourné par MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_RS_SECONDARY - - Type de serveur secondaire du jeu de réplique, retourné par MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_RS_ARBITER - - Type de serveur arbitre de jeu de réplique, retourné par MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_RS_OTHER - - Type de serveur autre de jeu de réplique, retourné par MongoDB\Driver\Server::getType. - Ces serveurs peuvent être masqués, en cours de démarrage ou en cours de récupération. Ils ne peuvent pas être interrogés, mais leurs listes d'hôtes sont utiles pour découvrir la configuration actuelle du jeu de réplique. - - - - - MongoDB\Driver\Server::TYPE_RS_GHOST - - Type de serveur fantôme de jeu de réplique, retourné par MongoDB\Driver\Server::getType. - - Les serveurs peuvent être identifiés comme tels dans au moins trois - situations : brièvement pendant le démarrage du serveur ; - dans un jeu de réplique non initialisé ; ou lorsque le serveur est évité - (c'est-à-dire supprimé de la config du jeu de réplique). - Ils ne peuvent pas être interrogés et leur liste d'hôtes ne peut pas - être utilisée pour découvrir la configuration actuelle du jeu de - réplique ; toutefois, le client peut surveiller ce serveur dans l'espoir - qu'il change vers un état plus utile. - - - - - - MongoDB\Driver\Server::TYPE_LOAD_BALANCER - - Type de serveur de Load balancer, retourné par MongoDB\Driver\Server::getType. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - - Ajout de la constante - MongoDB\Driver\Server::TYPE_LOAD_BALANCER. - - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.entities.server; - -     - - diff --git a/reference/mongodb/mongodb/driver/server/construct.xml b/reference/mongodb/mongodb/driver/server/construct.xml deleted file mode 100644 index 42024ac42f..0000000000 --- a/reference/mongodb/mongodb/driver/server/construct.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - MongoDB\Driver\Server::__construct - Créer un nouveau serveur (non utilisé) - - - - &reftitle.description; - - final private MongoDB\Driver\Server::__construct - - - - Les objets MongoDB\Driver\Server sont créés en interne - par MongoDB\Driver\Manager lorsqu'une connexion de base de - données est établie et peut être retournée par - MongoDB\Driver\Manager::getServers et - MongoDB\Driver\Manager::selectServer. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::getServers - MongoDB\Driver\Manager::selectServer - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/executebulkwrite.xml b/reference/mongodb/mongodb/driver/server/executebulkwrite.xml deleted file mode 100644 index 719e9b7787..0000000000 --- a/reference/mongodb/mongodb/driver/server/executebulkwrite.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - MongoDB\Driver\Server::executeBulkWrite - Exécute une ou plusieurs opérations d'écriture sur ce serveur - - - - &reftitle.description; - - final public MongoDB\Driver\WriteResultMongoDB\Driver\Server::executeBulkWrite - stringnamespace - MongoDB\Driver\BulkWritebulk - arraynulloptions&null; - - - Exécute une ou plusieurs opérations en écriture sur ce serveur. - - - Un objet MongoDB\Driver\BulkWrite peut être construit avec - une ou plusieurs opérations de types différents (c.-à-d. mise à jour, suppression, - et insertion). Le driver va tenter d'envoyer les opérations de même type au - serveur en un minimum de requête possible afin d'optimiser les aller/retour. - - - La valeur par défaut pour l'option "writeConcern" sera - déduite d'une transaction active (indiquée par l'option - "session"), puis par le - URI de connexion. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.bulkwrite; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.writeresult; - - - - &reftitle.errors; - - Lance une exception MongoDB\Driver\Exception\InvalidArgumentException si bulk ne contient aucune opération d'écriture. - Lance une exception MongoDB\Driver\Exception\InvalidArgumentException si bulk a déjà été exécuté. Les objets MongoDB\Driver\BulkWrite ne peuvent pas être exécutés plusieurs fois. - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - &mongodb.throws.bulkwriteexception; - Lance une exception MongoDB\Driver\Exception\RuntimeException - si une erreur survient. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - Le paramètre options n'accepte désormais plus - d'instance MongoDB\Driver\WriteConcern. - - - - PECL mongodb 1.21.0 - - Passer un objet MongoDB\Driver\WriteConcern en tant - qu'options est obsolète et sera supprimé dans la 2.0. - - - - PECL mongodb 1.4.4 - - MongoDB\Driver\Exception\InvalidArgumentException - sera lancé si l'option "session" est utilisée - conjointement avec un write concern non reconnu. - - - - PECL mongodb 1.4.0 - - Le troisième paramètre est maintenant un tableau - d'options. Pour la compatibilité ascendante, - ce paramètre acceptera toujours un objet MongoDB\Driver\WriteConcern. - - - - PECL mongodb 1.3.0 - - MongoDB\Driver\Exception\InvalidArgumentException est - maintenant levé si bulk ne contient pas - d'opérations d'écriture. Auparavant, une - MongoDB\Driver\Exception\BulkWriteException était levée. - - - - - - - - - &reftitle.notes; - &mongodb.note.server.write; - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWrite - MongoDB\Driver\WriteResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\Manager::executeBulkWrite - - - -     - - diff --git a/reference/mongodb/mongodb/driver/server/executebulkwritecommand.xml b/reference/mongodb/mongodb/driver/server/executebulkwritecommand.xml deleted file mode 100644 index 8cd52848d3..0000000000 --- a/reference/mongodb/mongodb/driver/server/executebulkwritecommand.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - MongoDB\Driver\Server::executeBulkWriteCommand - Exécute des opérations d'écriture sur ce serveur en utilisant la commande bulkWrite - - - - &reftitle.description; - - final public MongoDB\Driver\BulkWriteCommandResultMongoDB\Driver\Server::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandbulk - arraynulloptions&null; - - - Exécute une ou plusieurs opérations d'écriture sur ce serveur en utilisant la - commande bulkWrite - introduite dans MongoDB 8.0. - - - Une MongoDB\Driver\BulkWriteCommand peut être construite - avec une ou plusieurs opérations d'écriture de types variés (par exemple, des insertions, mises à jour - et suppressions). Chaque opération d'écriture peut cibler une différente collection. - - - La valeur par défaut pour l'option "writeConcern" sera - déduite d'une transaction active (indiquée par l'option - "session"), suivie de - l'URI de connexion. - - - - - &reftitle.parameters; - - &mongodb.parameter.bulkwritecommand; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.bulkwritecommandresult; - - - - &reftitle.errors; - - Lance une MongoDB\Driver\Exception\InvalidArgumentException si bulk ne contient pas d'opérations d'écriture valides. - Lance une MongoDB\Driver\Exception\InvalidArgumentException si bulk a déjà été exécutée. Les objets MongoDB\Driver\BulkWriteCommand ne peuvent pas être exécutés plusieurs fois. - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - &mongodb.throws.bulkwritecommandexception; - Lance MongoDB\Driver\Exception\RuntimeException en cas d'autre erreur. - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\Manager::executeBulkWriteCommand - - - -     - - diff --git a/reference/mongodb/mongodb/driver/server/executecommand.xml b/reference/mongodb/mongodb/driver/server/executecommand.xml deleted file mode 100644 index 2288094387..0000000000 --- a/reference/mongodb/mongodb/driver/server/executecommand.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - - MongoDB\Driver\Server::executeCommand - Exécute une commande de base de données sur ce serveur - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Exécute une commande sur ce serveur. - - - Cette méthode n'applique aucune logique spéciale à la commande. Les - valeurs par défaut pour les options "readPreference", - "readConcern", et "writeConcern" - seront déduites d'une transaction active (indiquée par l'option - "session"). S'il n'y a pas de transaction active, une - préférence de lecture primaire sera utilisée pour la sélection du serveur. - - - Les valeurs par défaut ne seront pas déduites de - l'URI de connexion. - Il est donc recommandé aux utilisateurs d'utiliser des méthodes de commande - de lecture et/ou d'écriture spécifiques si possible. - - &mongodb.note.server.readpreference; - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -     - &mongodb.option.transactionReadWriteConcern; -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Lance une exception MongoDB\Driver\Exception\RuntimeException - si une erreur survient (c.-à-d. commande invalide, l'envoi d'une commande en écriture sur - un secondaire). - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - Le paramètre options n'accepte désormais plus - d'instance MongoDB\Driver\WriteConcern. - - - - PECL mongodb 1.21.0 - - Passer un objet MongoDB\Driver\ReadPreference en tant - qu'options est obsolète et sera supprimé dans la 2.0. - - - - PECL mongodb 1.4.4 - - MongoDB\Driver\Exception\InvalidArgumentException - sera lancé si l'option "session" est utilisée - conjointement avec un write concern non reconnu. - - - - PECL mongodb 1.4.0 - - Le troisième paramètre est maintenant un tableau - d'options. Pour la compatibilité ascendante, - ce paramètre acceptera toujours un objet MongoDB\Driver\ReadPreference. - - - - - - - - - &reftitle.notes; - &mongodb.note.server.write; - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Server::executeReadCommand - MongoDB\Driver\Server::executeReadWriteCommand - MongoDB\Driver\Server::executeWriteCommand - MongoDB\Driver\Manager::executeCommand - - - -     - - diff --git a/reference/mongodb/mongodb/driver/server/executequery.xml b/reference/mongodb/mongodb/driver/server/executequery.xml deleted file mode 100644 index 107d26f41b..0000000000 --- a/reference/mongodb/mongodb/driver/server/executequery.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - MongoDB\Driver\Server::executeQuery - Exécute une requête de base de données sur ce serveur - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeQuery - stringnamespace - MongoDB\Driver\Queryquery - arraynulloptions&null; - - - Exécute la requête sur ce serveur. - - - Les valeurs par défaut pour l'option "readPreference" et - l'option "readConcern" de la requête seront déduites d'une transaction active - (indiquée par l'option "session"), puis par l'URI de connexion. - - &mongodb.note.server.readpreference; - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.query; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readPreference; - &mongodb.option.session; - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.std; - Lance une exception MongoDB\Driver\Exception\RuntimeException - si une erreur survient (c.-à-d. opérateurs de requête invalides). - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - Le paramètre options n'accepte désormais plus - d'instance MongoDB\Driver\WriteConcern. - - - - PECL mongodb 1.21.0 - - Passer un objet MongoDB\Driver\ReadPreference en tant - qu'options est obsolète et sera supprimé dans la 2.0. - - - - PECL mongodb 1.4.0 - - Le troisième paramètre est maintenant un tableau - d'options. Pour la compatibilité ascendante, - ce paramètre acceptera toujours un objet MongoDB\Driver\ReadPreference. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor - MongoDB\Driver\Query - MongoDB\Driver\ReadPreference - MongoDB\Driver\Manager::executeQuery - - - -     - - diff --git a/reference/mongodb/mongodb/driver/server/executereadcommand.xml b/reference/mongodb/mongodb/driver/server/executereadcommand.xml deleted file mode 100644 index 97473deed0..0000000000 --- a/reference/mongodb/mongodb/driver/server/executereadcommand.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeReadCommand - Exécute une commande de base de données qui lit sur ce serveur - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeReadCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Exécute la commande sur ce serveur, indépendamment de l'option - "readPreference". - - - Cette méthode appliquera une logique spécifique aux commandes de lecture (par exemple - distinct). - Les valeurs par défaut pour les options "readPreference" et - "readConcern" seront déduites d'une transaction active (indiquée par - l'option "session"), suivie de l' - URI de connexion. - - &mongodb.note.server.readpreference; - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.session; - - -
    -     - &mongodb.option.transactionReadWriteConcern; -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs (par exemple: commande invalide). - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Server::executeCommand - MongoDB\Driver\Server::executeReadWriteCommand - MongoDB\Driver\Server::executeWriteCommand - MongoDB\Driver\Manager::executeReadCommand - - - -     - - diff --git a/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml b/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml deleted file mode 100644 index 2642840858..0000000000 --- a/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeReadWriteCommand - Exécute une commande de base de données qui lit et écrit sur ce serveur - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeReadWriteCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Exécute la commande sur ce serveur. - - - Cette méthode appliquera une logique spécifique aux commandes de lecture et d'écriture - (par exemple aggregate). - Les valeurs par défaut pour les options "readConcern" et - "writeConcern" seront déduites d'une transaction active (indiquée par - l'option "session"), suivie de l' - URI de connexion. - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readConcern; - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -     - &mongodb.option.transactionReadWriteConcern; -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs (par exemple: commande invalide). - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - Une MongoDB\Driver\Exception\InvalidArgumentException - va être lancée si l'option "session" est utilisée en - combinaison avec un writeConcern non reconnu. - - - - - - - - - &reftitle.notes; - &mongodb.note.server.write; - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Server::executeCommand - MongoDB\Driver\Server::executeReadCommand - MongoDB\Driver\Server::executeWriteCommand - MongoDB\Driver\Manager::executeReadWriteCommand - - - -     - - diff --git a/reference/mongodb/mongodb/driver/server/executewritecommand.xml b/reference/mongodb/mongodb/driver/server/executewritecommand.xml deleted file mode 100644 index a39c430cd7..0000000000 --- a/reference/mongodb/mongodb/driver/server/executewritecommand.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeWriteCommand - Exécute une commande de base de données qui écrit sur ce serveur - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeWriteCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Exécute la commande sur ce serveur. - - - Cette méthode appliquera une logique spécifique aux commandes qui écrivent (par exemple - drop). - La valeur par défaut pour l'option "writeConcern" sera déduite d'une transaction active (indiquée par - l'option "session"), suivie de l' - URI de connexion. - - - - Cette méthode n'est pas destinée à être utilisée pour exécuter - insert, - update, - ou delete - commandes. Les utilisateurs sont encouragés à utiliser - MongoDB\Driver\Server::executeBulkWrite pour ces - opérations. - - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -     - &mongodb.option.transactionReadWriteConcern; -     -     -     -     - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs (par exemple: commande invalide). - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - Une MongoDB\Driver\Exception\InvalidArgumentException - va être lancée si l'option "session" est utilisée en - combinaison avec un writeConcern non reconnu. - - - - - - - - - &reftitle.notes; - &mongodb.note.server.write; - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Server::executeCommand - MongoDB\Driver\Server::executeReadCommand - MongoDB\Driver\Server::executeReadWriteCommand - MongoDB\Driver\Manager::executeWriteCommand - - - -     - - diff --git a/reference/mongodb/mongodb/driver/server/gethost.xml b/reference/mongodb/mongodb/driver/server/gethost.xml deleted file mode 100644 index 6679a6d420..0000000000 --- a/reference/mongodb/mongodb/driver/server/gethost.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - MongoDB\Driver\Server::getHost - Retourne le nom d'hôte du serveur - - - - &reftitle.description; - - final public stringMongoDB\Driver\Server::getHost - - - - Retourne le nom d'hôte du serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le nom d'hôte du serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\Server::getHost</function> - -selectServer(); - -var_dump($server->getHost()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - MongoDB\Driver\ServerDescription::getHost - - - - - diff --git a/reference/mongodb/mongodb/driver/server/getinfo.xml b/reference/mongodb/mongodb/driver/server/getinfo.xml deleted file mode 100644 index eb7e82c8a9..0000000000 --- a/reference/mongodb/mongodb/driver/server/getinfo.xml +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - MongoDB\Driver\Server::getInfo - Retourne un tableau d'informations décrivant ce serveur - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Server::getInfo - - - - Retourne un tableau d'informations décrivant le serveur. Ce tableau est dérivé - de la réponse la plus récente à la commande hello - obtenue par la surveillance du serveur. - - - - Lorsque le pilote est connecté à un équilibreur de charge, cette méthode retourne - la réponse à la commande hello - du serveur de backing lors de la poignée de main initiale de la connexion. - Cela contraste avec d'autres méthodes (par exemple, MongoDB\Driver\Server::getType), - qui renverront des informations sur l'équilibreur de charge lui-même. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau d'informations décrivant ce serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\Server::getInfo</function> - -selectServer($rp); - -var_dump($server->getInfo()); - -?> -]]> - - &example.outputs.similar; - - - bool(true) - ["topologyVersion"]=> - array(2) { - ["processId"]=> - object(MongoDB\BSON\ObjectId)#4 (1) { - ["oid"]=> - string(24) "617b6d696a3a89d2f77e6df0" - } - ["counter"]=> - int(6) - } - ["hosts"]=> - array(1) { - [0]=> - string(15) "localhost:27017" - } - ["setName"]=> - string(3) "rs0" - ["setVersion"]=> - int(1) - ["ismaster"]=> - bool(true) - ["secondary"]=> - bool(false) - ["primary"]=> - string(15) "localhost:27017" - ["me"]=> - string(15) "localhost:27017" - ["electionId"]=> - object(MongoDB\BSON\ObjectId)#5 (1) { - ["oid"]=> - string(24) "7fffffff0000000000000001" - } - ["lastWrite"]=> - array(4) { - ["opTime"]=> - array(2) { - ["ts"]=> - object(MongoDB\BSON\Timestamp)#6 (2) { - ["increment"]=> - string(1) "1" - ["timestamp"]=> - string(10) "1635478989" - } - ["t"]=> - int(1) - } - ["lastWriteDate"]=> - object(MongoDB\BSON\UTCDateTime)#7 (1) { - ["milliseconds"]=> - string(13) "1635478989000" - } - ["majorityOpTime"]=> - array(2) { - ["ts"]=> - object(MongoDB\BSON\Timestamp)#8 (2) { - ["increment"]=> - string(1) "1" - ["timestamp"]=> - string(10) "1635478989" - } - ["t"]=> - int(1) - } - ["majorityWriteDate"]=> - object(MongoDB\BSON\UTCDateTime)#9 (1) { - ["milliseconds"]=> - string(13) "1635478989000" - } - } - ["maxBsonObjectSize"]=> - int(16777216) - ["maxMessageSizeBytes"]=> - int(48000000) - ["maxWriteBatchSize"]=> - int(100000) - ["localTime"]=> - object(MongoDB\BSON\UTCDateTime)#10 (1) { - ["milliseconds"]=> - string(13) "1635478992136" - } - ["logicalSessionTimeoutMinutes"]=> - int(30) - ["connectionId"]=> - int(3) - ["minWireVersion"]=> - int(0) - ["maxWireVersion"]=> - int(13) - ["readOnly"]=> - bool(false) - ["ok"]=> - float(1) - ["$clusterTime"]=> - array(2) { - ["clusterTime"]=> - object(MongoDB\BSON\Timestamp)#11 (2) { - ["increment"]=> - string(1) "1" - ["timestamp"]=> - string(10) "1635478989" - } - ["signature"]=> - array(2) { - ["hash"]=> - object(MongoDB\BSON\Binary)#12 (2) { - ["data"]=> - string(20) "" - ["type"]=> - int(0) - } - ["keyId"]=> - int(0) - } - } - ["operationTime"]=> - object(MongoDB\BSON\Timestamp)#13 (2) { - ["increment"]=> - string(1) "1" - ["timestamp"]=> - string(10) "1635478989" - } -} -]]> - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - Lorsque le pilote est connecté à un équilibreur de charge, - cette méthode renvoie la réponse de la commande hello du serveur - de backing à partir de la poignée de main de connexion initiale. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ServerDescription::getHelloResponse - Commande hello dans le manuel de MongoDB - Spécification de la découverte et de la surveillance des serveurs - - - - - diff --git a/reference/mongodb/mongodb/driver/server/getlatency.xml b/reference/mongodb/mongodb/driver/server/getlatency.xml deleted file mode 100644 index 84cf7afcad..0000000000 --- a/reference/mongodb/mongodb/driver/server/getlatency.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - MongoDB\Driver\Server::getLatency - Retourne la latence de ce serveur en millisecondes - - - - &reftitle.description; - - final public integernullMongoDB\Driver\Server::getLatency - - - - Retourne la latence de ce serveur en millisecondes. C'est la mesure cliente du temps d'un - aller/retour - d'une commande hello. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la latence du serveur en millisecondes, - ou &null; si aucune latence n'a été mesurée (par exemple, le client est connecté à un équilibreur de charge). - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - Cette méthode retournera &null; si aucune latence n'a été mesurée. - Dans les versions antérieures, un nombre entier était toujours retourné - et une valeur non définie pouvait être signalée comme -1. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\Server::getLatency</function> - -selectServer(); - -var_dump($server->getLatency()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - MongoDB\Driver\ServerDescription::getRoundTripTime - La spécification sur la découverte et la surveillance d'un serveur - - - - - diff --git a/reference/mongodb/mongodb/driver/server/getport.xml b/reference/mongodb/mongodb/driver/server/getport.xml deleted file mode 100644 index eb83d0d6e6..0000000000 --- a/reference/mongodb/mongodb/driver/server/getport.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - MongoDB\Driver\Server::getPort - Retourne le port sur lequel le serveur écoute - - - - &reftitle.description; - - final public intMongoDB\Driver\Server::getPort - - - - Retourne le port sur lequel le serveur écoute. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le port sur lequel le serveur écoute. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\Server::getPort</function> - -selectServer(); - -var_dump($server->getPort()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - MongoDB\Driver\ServerDescription::getPort - - - - - diff --git a/reference/mongodb/mongodb/driver/server/getserverdescription.xml b/reference/mongodb/mongodb/driver/server/getserverdescription.xml deleted file mode 100644 index e9753518ad..0000000000 --- a/reference/mongodb/mongodb/driver/server/getserverdescription.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - MongoDB\Driver\Server::getServerDescription - Renvoie une ServerDescription pour ce serveur - - - - &reftitle.description; - - final public MongoDB\Driver\ServerDescriptionMongoDB\Driver\Server::getServerDescription - - - - Renvoie une MongoDB\Driver\ServerDescription pour ce - serveur. C'est un objet de valeur immuable qui décrira le serveur au moment - où cette méthode est appelée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une MongoDB\Driver\ServerDescription pour ce - serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/gettags.xml b/reference/mongodb/mongodb/driver/server/gettags.xml deleted file mode 100644 index 6cc3b9e79d..0000000000 --- a/reference/mongodb/mongodb/driver/server/gettags.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Server::getTags - Renvoie un tableau de tags décrivant ce serveur dans un ensemble de réplicas - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Server::getTags - - - - Renvoie un array de - tags utilisés pour - décrire ce serveur dans un ensemble de réplicas. L'array contiendra zéro ou plusieurs - paires clé et valeur de type string. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un array de tags utilisés pour décrire ce serveur dans un - ensemble de réplicas. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/gettype.xml b/reference/mongodb/mongodb/driver/server/gettype.xml deleted file mode 100644 index 5840792762..0000000000 --- a/reference/mongodb/mongodb/driver/server/gettype.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - MongoDB\Driver\Server::getType - Retourne un entier représentant le type du serveur - - - - &reftitle.description; - - final public intMongoDB\Driver\Server::getType - - - - Retourne un &integer; représentant le type du serveur. La valeur - correspondra avec une constante MongoDB\Driver\Server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &integer; représentant le type du serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - MongoDB\Driver\ServerDescription::getType - - - - - diff --git a/reference/mongodb/mongodb/driver/server/isarbiter.xml b/reference/mongodb/mongodb/driver/server/isarbiter.xml deleted file mode 100644 index 929b1f8e82..0000000000 --- a/reference/mongodb/mongodb/driver/server/isarbiter.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Server::isArbiter - Vérifie si ce serveur est un membre arbitre d'un ensemble de réplicas - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isArbiter - - - - Renvoie si ce serveur est un - membre arbitre - d'un ensemble de réplicas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si ce serveur est un membre arbitre d'un ensemble de réplicas, et - &false; sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/ishidden.xml b/reference/mongodb/mongodb/driver/server/ishidden.xml deleted file mode 100644 index 282f1f2620..0000000000 --- a/reference/mongodb/mongodb/driver/server/ishidden.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Server::isHidden - Renvoie si ce serveur est un membre caché d'un ensemble de réplicas - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isHidden - - - - Renvoie si ce serveur est un - membre caché - d'un ensemble de réplicas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si ce serveur est un membre caché d'un ensemble de réplicas, et - &false; sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/ispassive.xml b/reference/mongodb/mongodb/driver/server/ispassive.xml deleted file mode 100644 index ab7f55e473..0000000000 --- a/reference/mongodb/mongodb/driver/server/ispassive.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - MongoDB\Driver\Server::isPassive - Vérifie si le serveur est un membre passif du jeu de réplication - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isPassive - - - - Retourne si le serveur est un - membre passif - d'un jeu de réplication (c.-à-d. sa priorité est 0). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si le serveur est un membre passif d'un jeu de réplication, - et &false; sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/isprimary.xml b/reference/mongodb/mongodb/driver/server/isprimary.xml deleted file mode 100644 index 2a83af111b..0000000000 --- a/reference/mongodb/mongodb/driver/server/isprimary.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Server::isPrimary - Vérifie si ce serveur est un membre principal d'un ensemble de réplicas - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isPrimary - - - - Renvoie si ce serveur est un - membre principal - d'un ensemble de réplicas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si ce serveur est un membre principal d'un ensemble de réplicas, et - &false; sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/issecondary.xml b/reference/mongodb/mongodb/driver/server/issecondary.xml deleted file mode 100644 index 929065f26d..0000000000 --- a/reference/mongodb/mongodb/driver/server/issecondary.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Server::isSecondary - Vérifie si ce serveur est un membre secondaire d'un ensemble de réplicas - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isSecondary - - - - Renvoie si ce serveur est un - membre secondaire - d'un ensemble de réplicas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si ce serveur est un membre secondaire d'un ensemble de réplicas, et - &false; sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverapi.xml b/reference/mongodb/mongodb/driver/serverapi.xml deleted file mode 100644 index 1d4141a1c1..0000000000 --- a/reference/mongodb/mongodb/driver/serverapi.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - La classe MongoDB\Driver\ServerApi - MongoDB\Driver\ServerApi - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\ServerApi - - - - final - - MongoDB\Driver\ServerApi - - - MongoDB\BSON\Serializable - - - - Serializable - - - - &Constants; - - const - string - MongoDB\Driver\ServerAPI::V1 - "1" - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\ServerApi::V1 - - Version 1 de l'API serveur. - - - - -
    - - -
    - &reftitle.examples; - - - Déclarer une version d'API sur un gestionnaire - - $v1]); - -$command = new MongoDB\Driver\Command(['buildInfo' => 1]); - -try { - $cursor = $manager->executeCommand('admin', $command); -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} - -/* La commande buildInfo retourne un document unique, nous devons donc accéder - * au premier résultat du curseur. */ -$buildInfo = $cursor->toArray()[0]; - -echo $buildInfo->version, "\n"; - -?> -]]> - - - &example.outputs; - - - - - - - Déclare une version d'API stricte sur un gestionnaire - - L'exemple suivant définit le drapeau strict, qui - indique au serveur de rejeter toute commande qui ne fait pas partie de la version - d'API déclarée. Cela entraîne une erreur lors de l'exécution de la commande buildInfo. - - - $v1]); - -$command = new MongoDB\Driver\Command(['buildInfo' => 1]); - -try { - $cursor = $manager->executeCommand('admin', $command); -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} - -/* La commande buildInfo retourne un document unique, nous devons donc accéder - * au premier résultat du curseur. */ -$buildInfo = $cursor->toArray()[0]; - -echo $buildInfo->version, "\n"; - -?> -]]> - - - &example.outputs; - - - - -
    - -     - - &reference.mongodb.mongodb.driver.entities.serverapi; - -     - - diff --git a/reference/mongodb/mongodb/driver/serverapi/bsonserialize.xml b/reference/mongodb/mongodb/driver/serverapi/bsonserialize.xml deleted file mode 100644 index 309605cc2b..0000000000 --- a/reference/mongodb/mongodb/driver/serverapi/bsonserialize.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - MongoDB\Driver\ServerApi::bsonSerialize - Renvoie un objet pour la sérialisation BSON - - - - &reftitle.description; - - final public stdClassMongoDB\Driver\ServerApi::bsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un objet pour la sérialisation du ServerApi en BSON. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverapi/construct.xml b/reference/mongodb/mongodb/driver/serverapi/construct.xml deleted file mode 100644 index 709ae7357d..0000000000 --- a/reference/mongodb/mongodb/driver/serverapi/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - MongoDB\Driver\ServerApi::__construct - Créer une nouvelle instance de ServerApi - - - - &reftitle.description; - - final public MongoDB\Driver\ServerApi::__construct - stringversion - boolnullstrict&null; - boolnulldeprecationErrors&null; - - - - Crée une nouvelle instance de MongoDB\Driver\ServerApi utilisée pour - déclarer une version d'API lors de la création d'un - MongoDB\Driver\Manager. - - - - - &reftitle.parameters; - - - version - - - Une version d'API de serveur. - - - Les versions d'API prises en charge sont fournies sous forme de constantes - dans MongoDB\Driver\ServerApi. La seule version d'API - prise en charge est MongoDB\Driver\ServerApi::V1. - - - - - strict - - - Si le paramètre strict est défini sur &true;, le - serveur renverra une erreur pour toute commande qui ne fait pas partie de la - version d'API spécifiée. Si aucune valeur n'est fournie, la valeur par défaut du serveur - (&false;) est utilisée. - - - - - deprecationErrors - - - Si le paramètre deprecationErrors est défini sur &true;, - le serveur renverra une erreur lors de l'utilisation d'une commande qui est obsolète dans - la version d'API spécifiée. Si aucune valeur n'est fournie, la valeur par défaut du serveur - (&false;) est utilisée. - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription.xml b/reference/mongodb/mongodb/driver/serverdescription.xml deleted file mode 100644 index 0e79cbb733..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - - La classe MongoDB\Driver\ServerDescription - MongoDB\Driver\ServerDescription - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\ServerDescription est un objet de valeur - qui représente un serveur auquel le pilote est connecté. Les instances - de cette classe sont retournées par les méthodes - MongoDB\Driver\Server::getServerDescription et - MongoDB\Driver\Monitoring\ServerChangedEvent. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\ServerDescription - - - - final - - MongoDB\Driver\ServerDescription - - - - &Constants; - - const - string - MongoDB\Driver\ServerDescription::TYPE_UNKNOWN - "Unknown" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_STANDALONE - "Standalone" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_MONGOS - "Mongos" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_POSSIBLE_PRIMARY - "PossiblePrimary" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_PRIMARY - "RSPrimary" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_SECONDARY - "RSSecondary" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_ARBITER - "RSArbiter" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_OTHER - "RSOther" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_GHOST - "RSGhost" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_LOAD_BALANCER - "LoadBalancer" - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\ServerDescription::TYPE_UNKNOWN - - Le type de serveur inconnu, retourné par MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_STANDALONE - - Le type de serveur autonome, retourné par MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_MONGOS - - Le type de serveur Mongos, retourné par MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_POSSIBLE_PRIMARY - - Le type de serveur primaire possible d'un ensemble de réplicas, retourné par MongoDB\Driver\ServerDescription::getType. - Un serveur peut être identifié comme un primaire possible s'il n'a pas encore été vérifié mais qu'un autre serveur de la réplique pense qu'il est le primaire. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_PRIMARY - - Le type de serveur primaire d'un ensemble de réplicas, retourné par MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_SECONDARY - - Le type de serveur secondaire d'un ensemble de réplicas, retourné par MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_ARBITER - - Le type de serveur arbitre d'un ensemble de réplicas, retourné par MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_OTHER - - Le type de serveur d'un ensemble de réplicas autre que primaire, secondaire ou arbitre, retourné par MongoDB\Driver\ServerDescription::getType. - Ces serveurs peuvent être cachés, démarrer ou récupérer. Ils ne peuvent pas être interrogés, mais leurs listes d'hôtes sont utiles pour découvrir la configuration actuelle de l'ensemble de réplicas. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_GHOST - - Le type de serveur fantôme d'un ensemble de réplicas, retourné par MongoDB\Driver\ServerDescription::getType. - Les serveurs peuvent être identifiés comme tels dans au moins trois situations : brièvement pendant le démarrage du serveur ; dans un ensemble de réplicas non initialisé ; ou lorsque le serveur est écarté (c'est-à-dire retiré de la configuration de l'ensemble de réplicas). Ils ne peuvent pas être interrogés, ni leur liste d'hôtes utilisée pour découvrir la configuration actuelle de l'ensemble de réplicas ; cependant, le client peut surveiller ce serveur dans l'espoir qu'il passe à un état plus utile. - - - - - MongoDB\Driver\ServerDescription::TYPE_LOAD_BALANCER - - Le type de serveur équilibreur de charge, retourné par MongoDB\Driver\ServerDescription::getType. - - - - -
    - - -     - - &reference.mongodb.mongodb.driver.entities.serverdescription; - -     - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/gethelloresponse.xml b/reference/mongodb/mongodb/driver/serverdescription/gethelloresponse.xml deleted file mode 100644 index 4c92b05a6d..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/gethelloresponse.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getHelloResponse - Renvoie la réponse "hello" la plus récente du serveur - - - - &reftitle.description; - - final public arrayMongoDB\Driver\ServerDescription::getHelloResponse - - - - Renvoie un tableau d'informations décrivant le serveur. Ce tableau est dérivé de la réponse - hello - la plus récente (au moment où la - MongoDB\Driver\ServerDescription a été construite) obtenue via - la surveillance du serveur. - - - - Lorsque le pilote est connecté à un équilibreur de charge, cette méthode renverra - un tableau vide car les équilibreurs de charge ne sont pas surveillés. Cela contraste avec - MongoDB\Driver\Server::getInfo, qui renverrait la réponse du - hello - de la commande de poignée de main de connexion initiale du serveur de base. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un tableau d'informations décrivant ce serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - hello commande dans le manuel MongoDB - Découverte et surveillance des serveurs - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/gethost.xml b/reference/mongodb/mongodb/driver/serverdescription/gethost.xml deleted file mode 100644 index 3d9bf02331..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/gethost.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getHost - Renvoie le nom d'hôte de ce serveur - - - - &reftitle.description; - - final public stringMongoDB\Driver\ServerDescription::getHost - - - - Renvoie le nom d'hôte de ce serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom d'hôte de ce serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getHost - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/getlastupdatetime.xml b/reference/mongodb/mongodb/driver/serverdescription/getlastupdatetime.xml deleted file mode 100644 index f196614e8d..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/getlastupdatetime.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getLastUpdateTime - Renvoie l'heure de la dernière mise à jour du serveur en microsecondes - - - - &reftitle.description; - - final public intMongoDB\Driver\ServerDescription::getLastUpdateTime - - - - Renvoie l'heure de la dernière mise à jour du serveur en microsecondes. - - - - La valeur renvoyée est un horodatage monotone, qui commence à un point arbitraire. - En tant que tel, il est uniquement adapté pour être comparé avec d'autres valeurs de retour de - MongoDB\Driver\ServerDescription::getLastUpdateTime. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'heure de la dernière mise à jour du serveur en microsecondes. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/getport.xml b/reference/mongodb/mongodb/driver/serverdescription/getport.xml deleted file mode 100644 index ccfe1608d4..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/getport.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getPort - Renvoie le port sur lequel ce serveur écoute - - - - &reftitle.description; - - final public intMongoDB\Driver\ServerDescription::getPort - - - - Renvoie le port sur lequel ce serveur écoute. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le port sur lequel ce serveur écoute. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getPort - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/getroundtriptime.xml b/reference/mongodb/mongodb/driver/serverdescription/getroundtriptime.xml deleted file mode 100644 index 1cf9ac6dd1..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/getroundtriptime.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getRoundTripTime - Renvoie le temps de trajet aller-retour du serveur en millisecondes - - - - &reftitle.description; - - final public intnullMongoDB\Driver\ServerDescription::getRoundTripTime - - - - Renvoie le temps de trajet aller-retour du serveur en millisecondes. Il s'agit de - la mesure du client de la durée d'une - commande - hello. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le temps de trajet aller-retour du serveur en millisecondes. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getLatency - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/gettype.xml b/reference/mongodb/mongodb/driver/serverdescription/gettype.xml deleted file mode 100644 index 77897b992f..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/gettype.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getType - Renvoie une chaîne de caractères indiquant le type de ce serveur - - - - &reftitle.description; - - final public stringMongoDB\Driver\ServerDescription::getType - - - - Renvoie une string indiquant le type de ce serveur. La valeur - sera corrélée à une constante - MongoDB\Driver\ServerDescription. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un string indiquant le type de ce serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getType - - - - - - diff --git a/reference/mongodb/mongodb/driver/session.xml b/reference/mongodb/mongodb/driver/session.xml deleted file mode 100644 index a56ba3ceb3..0000000000 --- a/reference/mongodb/mongodb/driver/session.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - La classe MongoDB\Driver\Session - MongoDB\Driver\Session - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\Session représente une - session client et est retournée par - MongoDB\Driver\Manager::startSession. Les commandes, - les requêtes et les opérations d'écriture peuvent ensuite être associées à la session. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Session - - - - final - - MongoDB\Driver\Session - - - - - &Constants; - - const - string - MongoDB\Driver\Session::TRANSACTION_NONE - none - - - const - string - MongoDB\Driver\Session::TRANSACTION_STARTING - starting - - - const - string - MongoDB\Driver\Session::TRANSACTION_IN_PROGRESS - in_progress - - - const - string - MongoDB\Driver\Session::TRANSACTION_COMMITTED - committed - - - const - string - MongoDB\Driver\Session::TRANSACTION_ABORTED - aborted - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\Session::TRANSACTION_NONE - - - Il n'y a pas de transaction en cours. - - - - - - MongoDB\Driver\Session::TRANSACTION_STARTING - - - Une transaction a été démarrée, mais aucune opération n'a été envoyée au serveur. - - - - - - MongoDB\Driver\Session::TRANSACTION_IN_PROGRESS - - - Une transaction est en cours. - - - - - - MongoDB\Driver\Session::TRANSACTION_COMMITTED - - - Une transaction a été validée. - - - - - - MongoDB\Driver\Session::TRANSACTION_ABORTED - - - Une transaction a été annulée. - - - - - -
    - - -     - - &reference.mongodb.mongodb.driver.entities.session; - -     - - diff --git a/reference/mongodb/mongodb/driver/session/aborttransaction.xml b/reference/mongodb/mongodb/driver/session/aborttransaction.xml deleted file mode 100644 index 8ec85fdf14..0000000000 --- a/reference/mongodb/mongodb/driver/session/aborttransaction.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Session::abortTransaction - Annule une transaction - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::abortTransaction - - - - Termine la transaction multi-document et annule toutes les modifications de données - effectuées par les opérations dans la transaction. C'est-à-dire que la transaction se termine - sans enregistrer aucune des modifications apportées par les opérations dans la transaction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\RuntimeException si la transaction ne peut pas être annulée (par exemple, une transaction n'a pas été démarrée). - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - MongoDB\Driver\Session::commitTransaction - MongoDB\Driver\Session::startTransaction - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/advanceclustertime.xml b/reference/mongodb/mongodb/driver/session/advanceclustertime.xml deleted file mode 100644 index dc8b86e758..0000000000 --- a/reference/mongodb/mongodb/driver/session/advanceclustertime.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - MongoDB\Driver\Session::advanceClusterTime - Avance le temps du cluster pour cette session - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::advanceClusterTime - arrayobjectclusterTime - - - Avance le temps du cluster pour cette session. Si le temps du cluster est inférieur ou égal - au temps du cluster actuel de la session, cette fonction ne fait rien. - - - En utilisant cette méthode en conjonction avec - MongoDB\Driver\Session::advanceOperationTime pour copier - les temps du cluster et des opérations d'une autre session - il est possible de s'assurer que les opérations dans cette session sont cohérentes - avec la dernière opération dans l'autre session. - - - - - &reftitle.parameters; - - - clusterTime - - - Le temps du cluster est un document contenant un horodatage logique et une signature de serveur. - Typiquement, cette valeur sera obtenue en appelant - MongoDB\Driver\Session::getClusterTime sur un autre - objet de session. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::advanceOperationTime - MongoDB\Driver\Session::getClusterTime - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/advanceoperationtime.xml b/reference/mongodb/mongodb/driver/session/advanceoperationtime.xml deleted file mode 100644 index d439ed66a3..0000000000 --- a/reference/mongodb/mongodb/driver/session/advanceoperationtime.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - MongoDB\Driver\Session::advanceOperationTime - Avance le temps d'opération pour cette session - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::advanceOperationTime - MongoDB\BSON\TimestampInterfaceoperationTime - - - Avance le temps d'opération pour cette session. Si le temps d'opération est inférieur ou égal - au temps d'opération actuel de la session, cette fonction ne fait rien. - - - En utilisant cette méthode en conjonction avec - MongoDB\Driver\Session::advanceClusterTime pour copier - les temps d'opération et de cluster d'une autre session - il est possible de s'assurer que les opérations dans cette session sont cohérentes - avec la dernière opération dans l'autre session. - - - - - &reftitle.parameters; - - - operationTime - - - Le temps d'opération est un horodatage logique. Typiquement, cette valeur - sera obtenue en appelant - MongoDB\Driver\Session::getOperationTime sur - un autre objet de session. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::advanceClusterTime - MongoDB\Driver\Session::getClusterTime - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/committransaction.xml b/reference/mongodb/mongodb/driver/session/committransaction.xml deleted file mode 100644 index 1269e2daf3..0000000000 --- a/reference/mongodb/mongodb/driver/session/committransaction.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - MongoDB\Driver\Session::commitTransaction - Valide la transaction - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::commitTransaction - - - - Sauvegarde les modifications apportées par les opérations dans la transaction - multi-document et termine la transaction. Jusqu'à la validation, aucune des - modifications de données apportées par les opérations dans la transaction - n'est visible en dehors de la transaction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une - MongoDB\Driver\Exception\CommandException si le - serveur ne peut pas valider la transaction (par exemple, en raison de conflits, - de problèmes de réseau). Si le document retourné par la méthode - MongoDB\Driver\Exception\CommandException::getResultDocument - de l'exception contient un élément "errorLabels", et que ce - tableau contient une valeur - "TransientTransactionError" ou - "UnknownTransactionCommitResult", il est sûr de re-essayer - la totalité de la transaction. Dans les versions plus - récentes de l'extension, - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel - devrait être utilisé pour tester cette situation à la place. - Lance une - MongoDB\Driver\Exception\RuntimeException si la - transaction ne peut pas être validée (par exemple, une transaction n'a pas été - démarrée). - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - MongoDB\Driver\Session::abortTransaction - MongoDB\Driver\Session::startTransaction - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/construct.xml b/reference/mongodb/mongodb/driver/session/construct.xml deleted file mode 100644 index 034d10488b..0000000000 --- a/reference/mongodb/mongodb/driver/session/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - MongoDB\Driver\Session::__construct - Créer une nouvelle session (inutilisée) - - - - &reftitle.description; - - final private MongoDB\Driver\Session::__construct - - - - Les objets MongoDB\Driver\Session sont retournés par - MongoDB\Driver\Manager::startSession et ne peuvent pas être - construits directement. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/endsession.xml b/reference/mongodb/mongodb/driver/session/endsession.xml deleted file mode 100644 index dc94f12fad..0000000000 --- a/reference/mongodb/mongodb/driver/session/endsession.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - MongoDB\Driver\Session::endSession - Termine une session - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::endSession - - - - Cette méthode ferme une session existante. Si une transaction était associée - à cette session, la transaction sera annulée. Après avoir appelé cette - méthode, les applications ne doivent pas invoquer d'autres méthodes sur la session. - - - - Les sessions sont également fermées lors du ramassage de miettes. Il ne devrait pas être - nécessaire d'appeler cette méthode dans des circonstances normales. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - MongoDB\Driver\Session::abortTransaction - MongoDB\Driver\Session::commitTransaction - MongoDB\Driver\Session::startTransaction - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/getclustertime.xml b/reference/mongodb/mongodb/driver/session/getclustertime.xml deleted file mode 100644 index 8b989b3812..0000000000 --- a/reference/mongodb/mongodb/driver/session/getclustertime.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Session::getClusterTime - Renvoie le temps du cluster pour cette session - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\Session::getClusterTime - - - - Renvoie le temps du cluster pour cette session. Si la session n'a pas été utilisée - pour une opération et - MongoDB\Driver\Session::advanceClusterTime n'a pas - été appelé, le temps du cluster sera &null;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le temps du cluster pour cette session, ou &null; si la session n'a pas - de temps du cluster. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::advanceClusterTime - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/getlogicalsessionid.xml b/reference/mongodb/mongodb/driver/session/getlogicalsessionid.xml deleted file mode 100644 index a6beae8f33..0000000000 --- a/reference/mongodb/mongodb/driver/session/getlogicalsessionid.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Session::getLogicalSessionId - Renvoie l'identifiant de session logique pour cette session - - - - &reftitle.description; - - final public objectMongoDB\Driver\Session::getLogicalSessionId - - - - Renvoie l'identifiant de session logique pour cette session, qui peut être utilisé pour - identifier les opérations de cette session sur le serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de session logique pour cette session. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/getoperationtime.xml b/reference/mongodb/mongodb/driver/session/getoperationtime.xml deleted file mode 100644 index c04fbe5e11..0000000000 --- a/reference/mongodb/mongodb/driver/session/getoperationtime.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Session::getOperationTime - Renvoie le temps d'opération pour cette session - - - - &reftitle.description; - - final public MongoDB\BSON\TimestampnullMongoDB\Driver\Session::getOperationTime - - - - Renvoie le temps d'opération pour cette session. Si la session n'a pas été utilisée - pour une opération et - MongoDB\Driver\Session::advanceOperationTime n'a pas - été appelé, le temps d'opération sera &null;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le temps d'opération pour cette session, ou &null; si la session n'a pas - de temps d'opération. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::advanceOperationTime - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/getserver.xml b/reference/mongodb/mongodb/driver/session/getserver.xml deleted file mode 100644 index 09863e0ebf..0000000000 --- a/reference/mongodb/mongodb/driver/session/getserver.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\Session::getServer - Renvoie le serveur auquel cette session est épinglée - - - - &reftitle.description; - - final public MongoDB\Driver\ServernullMongoDB\Driver\Session::getServer - - - - Renvoie le MongoDB\Driver\Server auquel cette session - est épinglée. Si la session n'est pas épinglée à un serveur, &null; - sera renvoyé. - - - La session d'épinglage est principalement utilisée pour les transactions - éclatées, car toutes les commandes dans une transaction éclatée doivent - être envoyées à la même instance mongos. Cette méthode est destinée à être - utilisée par des bibliothèques construites au-dessus de l'extension pour - permettre l'utilisation d'un serveur épinglé au lieu d'invoquer la sélection du serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le MongoDB\Driver\Server auquel cette session - est épinglée, ou &null; si la session n'est pas épinglée à un serveur. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/gettransactionoptions.xml b/reference/mongodb/mongodb/driver/session/gettransactionoptions.xml deleted file mode 100644 index 454f95e0c0..0000000000 --- a/reference/mongodb/mongodb/driver/session/gettransactionoptions.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Session::getTransactionOptions - Renvoie les options pour la transaction en cours - - - - &reftitle.description; - - final public arraynullMongoDB\Driver\Session::getTransactionOptions - - - - Renvoie les options pour la transaction en cours. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un array contenant les options de transaction actuelles, ou - &null; si aucune transaction n'est en cours. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::getTransactionState - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/gettransactionstate.xml b/reference/mongodb/mongodb/driver/session/gettransactionstate.xml deleted file mode 100644 index 83b7468971..0000000000 --- a/reference/mongodb/mongodb/driver/session/gettransactionstate.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Session::getTransactionState - Renvoie l'état de la transaction actuelle pour cette session - - - - &reftitle.description; - - final public stringMongoDB\Driver\Session::getTransactionState - - - - Renvoie l'état de la transaction pour cette session. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'état de la transaction actuelle pour cette session. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::isInTransaction - MongoDB\Driver\Session::getTransactionOptions - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/isdirty.xml b/reference/mongodb/mongodb/driver/session/isdirty.xml deleted file mode 100644 index f3cf0c6987..0000000000 --- a/reference/mongodb/mongodb/driver/session/isdirty.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Session::isDirty - Renvoie si la session a été marquée comme sale - - - - &reftitle.description; - - final public boolMongoDB\Driver\Session::isDirty - - - - Renvoie si la session a été marquée comme sale (c'est-à-dire qu'elle a été utilisée - avec une commande qui a rencontré une erreur réseau). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie si la session a été marquée comme sale. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/isintransaction.xml b/reference/mongodb/mongodb/driver/session/isintransaction.xml deleted file mode 100644 index 6623dc9b9a..0000000000 --- a/reference/mongodb/mongodb/driver/session/isintransaction.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\Session::isInTransaction - Renvoie si une transaction multi-document est en cours - - - - &reftitle.description; - - final public boolMongoDB\Driver\Session::isInTransaction - - - - Renvoie si une transaction multi-document est actuellement en cours pour - cette session. Une transaction est considérée comme "en cours" si elle a été - démarrée mais n'a pas été validée ou annulée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si une transaction est actuellement en cours pour cette session, - et &false; sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::getTransactionState - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/starttransaction.xml b/reference/mongodb/mongodb/driver/session/starttransaction.xml deleted file mode 100644 index c35a58ccf7..0000000000 --- a/reference/mongodb/mongodb/driver/session/starttransaction.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - MongoDB\Driver\Session::startTransaction - Commence une transaction - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::startTransaction - arraynulloptions&null; - - - Commence une transaction multi-document associée à la session. À un moment donné, - on ne peut avoir qu'une seule transaction ouverte pour une session. Après avoir - commencé une transaction, l'objet de session doit être passé à chaque opération via - l'option "session" (par exemple - MongoDB\Driver\Manager::executeBulkWrite) pour associer - cette opération à la transaction. - - - Les transactions peuvent être confirmées via - MongoDB\Driver\Session::commitTransaction, et - annulées avec - MongoDB\Driver\Session::abortTransaction. - Les transactions sont également automatiquement annulées lorsque la session est - fermée par le ramasse-miettes ou en appelant explicitement - MongoDB\Driver\Session::endSession. - - - - - &reftitle.parameters; - - - options - - - Les options peuvent être passées en argument à cette méthode. Chaque élément de ce - tableau d'options remplace l'option correspondante de l'option - "defaultTransactionOptions", si définie lors - du démarrage de la session avec - MongoDB\Driver\Manager::startSession. - - - - options - - - - Option - Type - Description - - - - &mongodb.option.maxCommitTimeMS; - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.writeConcern; - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lance une MongoDB\Driver\Exception\CommandException si la transaction n'a pas pu être démarrée en raison d'un problème côté serveur (par exemple, un verrou n'a pas pu être obtenu). - Lance une MongoDB\Driver\Exception\RuntimeException si la transaction n'a pas pu être démarrée (par exemple, une transaction était déjà en cours). - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.6.0 - - - L'option "maxCommitTimeMS" a été ajoutée. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - MongoDB\Driver\Session::commitTransaction - MongoDB\Driver\Session::abortTransaction - - - -     - - diff --git a/reference/mongodb/mongodb/driver/topologydescription.xml b/reference/mongodb/mongodb/driver/topologydescription.xml deleted file mode 100644 index 32d1543f8b..0000000000 --- a/reference/mongodb/mongodb/driver/topologydescription.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - La classe MongoDB\Driver\TopologyDescription - MongoDB\Driver\TopologyDescription - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\TopologyDescription est un - objet de valeur qui représente une topologie à laquelle le pilote est - connecté. Les instances de cette classe sont retournées par les méthodes de - MongoDB\Driver\Monitoring\TopologyChangedEvent. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\TopologyDescription - - - - final - - MongoDB\Driver\TopologyDescription - - - - &Constants; - - const - string - MongoDB\Driver\TopologyDescription::TYPE_UNKNOWN - "Unknown" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_SINGLE - "Single" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_SHARDED - "Sharded" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_NO_PRIMARY - "ReplicaSetNoPrimary" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_WITH_PRIMARY - "ReplicaSetWithPrimary" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_LOAD_BALANCED - "LoadBalanced" - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\TopologyDescription::TYPE_UNKNOWN - - Topologie inconnue, retournée par MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_SINGLE - - Seul serveur (c'est-à-dire connexion directe), retourné par MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_SHARDED - - Cluster partagé, retourné par MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_NO_PRIMARY - - Ensemble de réplicas sans serveur primaire, retourné par MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_WITH_PRIMARY - - Ensemble de réplicas avec un serveur primaire, retourné par MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_LOAD_BALANCED - - Topologie équilibrée, retournée par MongoDB\Driver\TopologyDescription::getType. - - - - -
    - - -     - - &reference.mongodb.mongodb.driver.entities.topologydescription; - -     - - diff --git a/reference/mongodb/mongodb/driver/topologydescription/getservers.xml b/reference/mongodb/mongodb/driver/topologydescription/getservers.xml deleted file mode 100644 index 5dae7b647a..0000000000 --- a/reference/mongodb/mongodb/driver/topologydescription/getservers.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\TopologyDescription::getServers - Renvoie les serveurs de la topologie - - - - &reftitle.description; - - final public arrayMongoDB\Driver\TopologyDescription::getServers - - - - Renvoie un tableau d'objets MongoDB\Driver\ServerDescription - correspondant aux serveurs connus dans la topologie. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un tableau d'objets MongoDB\Driver\ServerDescription - correspondant aux serveurs connus dans la topologie. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/topologydescription/gettype.xml b/reference/mongodb/mongodb/driver/topologydescription/gettype.xml deleted file mode 100644 index baab38c95c..0000000000 --- a/reference/mongodb/mongodb/driver/topologydescription/gettype.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\TopologyDescription::getType - Renvoie une chaîne de caractères dénotant le type de cette topologie - - - - &reftitle.description; - - final public stringMongoDB\Driver\TopologyDescription::getType - - - - Renvoie un string dénotant le type de cette topologie. La valeur - sera corrélée avec une constante de - MongoDB\Driver\TopologyDescription. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un string dénotant le type de cette topologie. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/topologydescription/hasreadableserver.xml b/reference/mongodb/mongodb/driver/topologydescription/hasreadableserver.xml deleted file mode 100644 index 5edc8f7552..0000000000 --- a/reference/mongodb/mongodb/driver/topologydescription/hasreadableserver.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\TopologyDescription::hasReadableServer - Renvoie si la topologie a un serveur lisible - - - - &reftitle.description; - - final public boolMongoDB\Driver\TopologyDescription::hasReadableServer - MongoDB\Driver\ReadPreferencenullreadPreference&null; - - - Renvoie si la topologie a un serveur lisible ou, si - readPreference est spécifié, un serveur correspondant à - la préférence de lecture spécifiée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie si la topologie a un serveur lisible ou, si - readPreference est spécifié, un serveur correspondant à - la préférence de lecture spécifiée. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/topologydescription/haswritableserver.xml b/reference/mongodb/mongodb/driver/topologydescription/haswritableserver.xml deleted file mode 100644 index 04d0635f91..0000000000 --- a/reference/mongodb/mongodb/driver/topologydescription/haswritableserver.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - MongoDB\Driver\TopologyDescription::hasWritableServer - Retourne si la topologie dispose d'un serveur en écriture - - - - &reftitle.description; - - final public boolMongoDB\Driver\TopologyDescription::hasWritableServer - - - - Retourne si la topologie dispose d'un serveur en écriture. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne si la topologie dispose d'un serveur en écriture. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern.xml b/reference/mongodb/mongodb/driver/writeconcern.xml deleted file mode 100644 index b12dc99f8d..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern.xml +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - La classe MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcern - - - - -
    - &reftitle.intro; - - MongoDB\Driver\WriteConcern décrit le niveau - d'accusé de réception demandé par MongoDB pour les opérations d'écriture - à un mongod autonome ou à des ensembles de réplicas - ou à des clusters fragmentés. Dans les clusters fragmentés, les instances - de mongos transmettent le write concern aux - fragments. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\WriteConcern - - - - final - - MongoDB\Driver\WriteConcern - - - - MongoDB\BSON\Serializable - - - - Serializable - - - - &Constants; - - const - string - MongoDB\Driver\WriteConcern::MAJORITY - "majority" - - - &Properties; - - public - readonly - stringintnull - w - - - public - readonly - boolnull - j - - - public - readonly - int - wtimeout - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - w - - - La valeur du write concern (nombre entier de nœuds, la chaîne - "majority", ou un nom personnalisé d'étiquette de - write concern), ou &null; si non définie. - - - - - j - - - Indique si les opérations d'écriture doivent être validées dans le journal - avant d'être acquittées, ou &null; si non spécifié. - - - - - wtimeout - - - Le délai d'attente en millisecondes pour l'accusé de réception du - write concern. Une valeur de 0 signifie - attendre indéfiniment. - - - - -
    - - - -
    - &reftitle.constants; - - - - MongoDB\Driver\WriteConcern::MAJORITY - - - La majorité de tous les membres du jeu de répliques ; les arbitres, les membres non-votants, - les membres passifs, les membres cachés, et les membres en attente sont - tous inclus dans la définition d'un write concern de la majorité. - - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - PECL mongodb 1.7.0 - - Implémente Serializable. - - - - PECL mongodb 1.2.0 - - Implémente MongoDB\BSON\Serializable. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.entities.writeconcern; - -     - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/bsonserialize.xml b/reference/mongodb/mongodb/driver/writeconcern/bsonserialize.xml deleted file mode 100644 index bc792423bb..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/bsonserialize.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::bsonSerialize - Renvoie un objet pour la sérialisation BSON - - - - &reftitle.description; - - final public stdClassMongoDB\Driver\WriteConcern::bsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un objet pour la sérialisation du WriteConcern en BSON. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteConcern::bsonSerialize</function> avec le write concern majority - -bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($wc)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - string(8) "majority" -} - -{ "w" : "majority" } -]]> - - - <function>MongoDB\Driver\WriteConcern::bsonSerialize</function> avec le wtimeout et le journal - -bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($wc)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - int(2) - ["j"]=> - bool(true) - ["wtimeout"]=> - int(1000) -} - -{ "w" : 2, "j" : true, "wtimeout" : 1000 } -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - Référence de Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/construct.xml b/reference/mongodb/mongodb/driver/writeconcern/construct.xml deleted file mode 100644 index ad04499f40..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/construct.xml +++ /dev/null @@ -1,234 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteConcern::__construct - Construit un WriteConcern - - - - &reftitle.description; - - final public MongoDB\Driver\WriteConcern::__construct - stringintw - intnullwtimeout&null; - boolnulljournal&null; - - - Construit un nouveau MongoDB\Driver\WriteConcern, qui est un objet de valeur immuable. - - - - - &reftitle.parameters; - - - w - - - - Write concern - - - - Valeur - Description - - - - - 1 - - Demande l'accusé de réception que l'opération d'écriture s'est propagée - au mongod autonome ou au principal dans un jeu de - réplicas. Il s'agit du write concern par défaut pour - MongoDB. - - - - 0 - - Ne demande aucun accusé de réception de l'opération d'écriture. - Toutefois, cela peut renvoyer des informations sur les exceptions de - socket et les erreurs de mise en réseau à l'application. - - - - <entier supérieur à 1> - - Les nombres supérieurs à 1 sont valides uniquement pour les jeux de - réplicas pour demander l'accusé de réception à partir du nombre spécifié - de membres, y compris le principal. - - - - MongoDB\Driver\WriteConcern::MAJORITY - - - Demande l'accusé de réception que les opérations d'écriture se sont - propagées à la majorité des nœuds votants, y compris le principal, et - ont été écrites dans le journal sur disque pour ces nœuds. - - - Avant MongoDB 3.0, il s'agit de la majorité des membres du jeu de - réplicas (et pas seulement des nœuds votants). - - - - - string - - Une valeur de chaîne est interprétée comme un jeu de balises. Demande - l'accusé de réception que les opérations d'écriture se sont propagées à - un membre de jeu de réplicas avec la balise spécifiée. - - - - -
    -     -     -     - - wtimeout - - - Délai d'attente maximal (en millisecondes) avant que les secondaires - n'échouent. - - - wtimeout fera que les opérations en écriture vont retourner - une erreur (WriteConcernError) après le - délai spécifié, même si le write concern requis finit par être satisfait. - Lorsque ces opérations en écriture retournent, MongoDB - ne va pas annuler les modifications de données réussies effectuées avant que - le write concern n'ait dépassé le délai limite wtimeout. - - - Si spécifié, wtimeout doit être un entier signé 64 bits - supérieur ou égal à zéro. - - - - Délai d'attente du write concern - - - - Valeur - Description - - - - - 0 - Bloc indéfiniment. C'est le comportement par défaut. - - - <entier supérieur à 0> - - Nombre de millisecondes à attendre avant de retourner. - - - - -
    -     -     -     - - journal - - - Attente avant que mongod n'applique l'écriture au journal. - - - -     -     - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lève une exception MongoDB\Driver\Exception\InvalidArgumentException si w est invalide ou wtimeout est négatif ou supérieure aux limites d'un entier signé 32 bits. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.7.0 - - Le paramètre wTimeout accepte désormais des valeurs 64-bit. - - - - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteConcern::__construct</function> - - -]]> - - - - - - - &reftitle.seealso; - - Write Concern reference - - - -     - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/getjournal.xml b/reference/mongodb/mongodb/driver/writeconcern/getjournal.xml deleted file mode 100644 index 3af94cf83a..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/getjournal.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::getJournal - Renvoie l'option "journal" du WriteConcern - - - - &reftitle.description; - - final public boolnullMongoDB\Driver\WriteConcern::getJournal - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'option "journal" du WriteConcern. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\WriteConcern::getJournal</function> - -getJournal()); - -$wc = new MongoDB\Driver\WriteConcern(1, 0, true); -var_dump($wc->getJournal()); - -$wc = new MongoDB\Driver\WriteConcern(1, 0, false); -var_dump($wc->getJournal()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Référence de Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/getw.xml b/reference/mongodb/mongodb/driver/writeconcern/getw.xml deleted file mode 100644 index 7003fad86b..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/getw.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::getW - Renvoie l'option "w" du WriteConcern - - - - &reftitle.description; - - final public stringintnullMongoDB\Driver\WriteConcern::getW - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'option "w" du WriteConcern. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\WriteConcern::getW</function> - -getW()); - -$wc = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY); -var_dump($wc->getW()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Référence de Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/getwtimeout.xml b/reference/mongodb/mongodb/driver/writeconcern/getwtimeout.xml deleted file mode 100644 index f9fd17c6ae..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/getwtimeout.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::getWtimeout - Renvoie l'option "wtimeout" du WriteConcern - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteConcern::getWtimeout - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'option "wtimeout" du WriteConcern. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.7.0 - - Sur les systèmes 32 bits, cette méthode tronquera toujours la valeur - wTimeout si elle dépasse la plage 32 bits. Dans ce cas, un - avertissement sera émis. - - - - - - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\WriteConcern::getWtimeout</function> - -getWtimeout()); - -$wc = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, 3000); -var_dump($wc->getWtimeout()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Référence de Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/isdefault.xml b/reference/mongodb/mongodb/driver/writeconcern/isdefault.xml deleted file mode 100644 index ca3860e1e1..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/isdefault.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::isDefault - Vérifie si c'est le WriteConcern par défaut - - - - &reftitle.description; - - final public boolMongoDB\Driver\WriteConcern::isDefault - - - - Renvoie si c'est le WriteConcern par défaut (c'est-à-dire sans - options spécifiées). Cette méthode est principalement destinée à être utilisée en conjonction avec - MongoDB\Driver\Manager::getWriteConcern pour déterminer - si le Manager a été construit sans aucune option de WriteConcern. - - - Le pilote n'inclura pas de WriteConcern par défaut dans ses opérations d'écriture - (par exemple MongoDB\Driver\Manager::executeBulkWrite) afin - de permettre au serveur d'appliquer son propre WriteConcern par défaut, qui peut avoir été - modifié. - Les bibliothèques qui accèdent au WriteConcern du Manager pour l'inclure dans leurs propres - commandes d'écriture devraient utiliser cette méthode pour s'assurer que les WriteConcern par défaut - ne sont pas définis. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si c'est le WriteConcern par défaut et &false; sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Exemple de <function>MongoDB\Driver\WriteConcern::isDefault</function> - -isDefault()); - -$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/?w=majority'); -$wc = $manager->getWriteConcern(); -var_dump($wc->isDefault()); - -$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/'); -$wc = $manager->getWriteConcern(); -var_dump($wc->isDefault()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::getWriteConcern - Modifier le Write Concern par défaut dans le manuel MongoDB - Référence de Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcernerror.xml b/reference/mongodb/mongodb/driver/writeconcernerror.xml deleted file mode 100644 index ff8e81a393..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - La classe MongoDB\Driver\WriteConcernError - MongoDB\Driver\WriteConcernError - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\WriteConcernError - contient des informations relatives à une erreur de write concern et peut être retournée par - MongoDB\Driver\WriteResult::getWriteConcernError. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\WriteConcernError - - - - final - - MongoDB\Driver\WriteConcernError - - - - - &Properties; - - public - readonly - string - message - - - public - readonly - int - code - - - public - readonly - objectnull - info - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - message - - Le message d'erreur. - - - - code - - Le code d'erreur. - - - - info - - - Informations supplémentaires sur l'erreur, ou &null; si non disponible. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.entities.writeconcernerror; - -     - - diff --git a/reference/mongodb/mongodb/driver/writeconcernerror/getcode.xml b/reference/mongodb/mongodb/driver/writeconcernerror/getcode.xml deleted file mode 100644 index cbc563cc0d..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror/getcode.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - MongoDB\Driver\WriteConcernError::getCode - Retourne le code d'erreur de WriteConcernError - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteConcernError::getCode - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le code d'erreur de WriteConcernError - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteConcernError::getCode</function> - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(2, 1); - -try { - $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteConcernError()->getCode()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Référence Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcernerror/getinfo.xml b/reference/mongodb/mongodb/driver/writeconcernerror/getinfo.xml deleted file mode 100644 index 9b9e9ebd6f..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror/getinfo.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - MongoDB\Driver\WriteConcernError::getInfo - Retourne le document de métadonnées pour WriteConcernError - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\WriteConcernError::getInfo - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le document de métadonnées pour WriteConcernError, ou &null; - si aucune métadonnée n'est disponible. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteConcernError::getInfo</function> - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(2, 1); - -try { - $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteConcernError()->getInfo()); -} - -?> -]]> - - &example.outputs.similar; - - - bool(true) -} -]]> - - - - - - - &reftitle.seealso; - - Référence Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcernerror/getmessage.xml b/reference/mongodb/mongodb/driver/writeconcernerror/getmessage.xml deleted file mode 100644 index 246a3114bd..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror/getmessage.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - MongoDB\Driver\WriteConcernError::getMessage - Renvoie le message d'erreur du WriteConcernError - - - - &reftitle.description; - - final public stringMongoDB\Driver\WriteConcernError::getMessage - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le message d'erreur du WriteConcernError - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteConcernError::getMessage</function> - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(2, 1); - -try { - $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteConcernError()->getMessage()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Référence Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror.xml b/reference/mongodb/mongodb/driver/writeerror.xml deleted file mode 100644 index 2fe490ec39..0000000000 --- a/reference/mongodb/mongodb/driver/writeerror.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - La classe MongoDB\Driver\WriteError - MongoDB\Driver\WriteError - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\WriteError contient - des informations sur une erreur d'écriture et peut être retournée en tant - qu'élément d'un tableau à partir de MongoDB\Driver\WriteResult::getWriteErrors. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\WriteError - - - - final - - MongoDB\Driver\WriteError - - - - - &Properties; - - public - readonly - string - message - - - public - readonly - int - code - - - public - readonly - int - index - - - public - readonly - objectnull - info - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - message - - Le message d'erreur. - - - - code - - Le code d'erreur. - - - - index - - - L'index de l'opération d'écriture au sein du - MongoDB\Driver\BulkWrite qui a provoqué l'erreur. - - - - - info - - - Informations supplémentaires sur l'erreur, ou &null; si non disponible. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.entities.writeerror; - -     - - diff --git a/reference/mongodb/mongodb/driver/writeerror/getcode.xml b/reference/mongodb/mongodb/driver/writeerror/getcode.xml deleted file mode 100644 index a091065643..0000000000 --- a/reference/mongodb/mongodb/driver/writeerror/getcode.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteError::getCode - Retourne le code d'erreur de WriteError - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteError::getCode - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le code d'erreur de WriteError - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteError::getCode</function> - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()[0]->getCode()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror/getindex.xml b/reference/mongodb/mongodb/driver/writeerror/getindex.xml deleted file mode 100644 index 445b25a6d7..0000000000 --- a/reference/mongodb/mongodb/driver/writeerror/getindex.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteError::getIndex - Retourne l'index de l'opération d'écriture correspondant à ce WriteError - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteError::getIndex - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'index de l'opération d'écriture (à partir de - MongoDB\Driver\BulkWrite) correspondant à ce WriteError. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteError::getIndex</function> - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()[0]->getIndex()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWrite - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror/getinfo.xml b/reference/mongodb/mongodb/driver/writeerror/getinfo.xml deleted file mode 100644 index cc31784bf0..0000000000 --- a/reference/mongodb/mongodb/driver/writeerror/getinfo.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteError::getInfo - Retourne le document de métadonnées pour WriteError - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\WriteError::getInfo - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le document de métadonnées pour WriteError, ou &null; s'il - n'y a pas de métadonnées disponibles. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror/getmessage.xml b/reference/mongodb/mongodb/driver/writeerror/getmessage.xml deleted file mode 100644 index 22fb6de458..0000000000 --- a/reference/mongodb/mongodb/driver/writeerror/getmessage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteError::getMessage - Renvoie le message d'erreur du WriteError - - - - &reftitle.description; - - final public stringMongoDB\Driver\WriteError::getMessage - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le message d'erreur du WriteError. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteError::getMessage</function> - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()[0]->getMessage()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult.xml b/reference/mongodb/mongodb/driver/writeresult.xml deleted file mode 100644 index 8cdc72254a..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult.xml +++ /dev/null @@ -1,270 +0,0 @@ - - - - - - La classe MongoDB\Driver\WriteResult - MongoDB\Driver\WriteResult - - - - -
    - &reftitle.intro; - - La classe MongoDB\Driver\WriteResult contient les - informations sur une exécution MongoDB\Driver\BulkWrite - et peut être retournée par - MongoDB\Driver\Manager::executeBulkWrite. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\WriteResult - - - - final - - MongoDB\Driver\WriteResult - - - - - &Properties; - - public - readonly - intnull - insertedCount - - - public - readonly - intnull - matchedCount - - - public - readonly - intnull - modifiedCount - - - public - readonly - intnull - deletedCount - - - public - readonly - intnull - upsertedCount - - - public - readonly - MongoDB\Driver\Server - server - - - public - readonly - array - upsertedIds - - - public - readonly - array - writeErrors - - - public - readonly - MongoDB\Driver\WriteConcernErrornull - writeConcernError - - - public - readonly - MongoDB\Driver\WriteConcernnull - writeConcern - - - public - readonly - array - errorReplies - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - insertedCount - - - Le nombre de documents insérés (à l'exclusion des upserts), ou &null; si - le write concern n'a pas demandé d'accusé de réception. - - - - - matchedCount - - - Le nombre de documents correspondant aux opérations de mise à jour et de - remplacement, ou &null; si le write concern n'a pas demandé - d'accusé de réception. - - - - - modifiedCount - - - Le nombre de documents modifiés par les opérations de mise à jour et de - remplacement, ou &null; si le write concern n'a pas demandé - d'accusé de réception ou si le serveur n'a pas signalé cette information. - - - - - deletedCount - - - Le nombre de documents supprimés, ou &null; si le write concern - n'a pas demandé d'accusé de réception. - - - - - upsertedCount - - - Le nombre de documents upsertés, ou &null; si le write concern - n'a pas demandé d'accusé de réception. - - - - - server - - - Le serveur qui a exécuté l'écriture groupée. - - - - - upsertedIds - - - Un tableau de valeurs _id pour les documents upsertés. - Les clés du tableau correspondent à l'index de l'opération d'écriture - depuis MongoDB\Driver\BulkWrite. - - - - - writeErrors - - - Un tableau de MongoDB\Driver\WriteError pour - toutes les erreurs d'écriture survenues lors de l'exécution. - - - - - writeConcernError - - - Le MongoDB\Driver\WriteConcernError survenu, ou - &null; si aucune erreur de write concern n'est survenue. - - - - - writeConcern - - - La MongoDB\Driver\WriteConcern utilisée pour - l'écriture groupée, ou &null; si non disponible. - - - - - errorReplies - - - Un tableau de documents de réponse d'erreur du serveur. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Ajout des propriétés publiques readonly. - - - - - -
    - -     - - &reference.mongodb.mongodb.driver.entities.writeresult; - -     - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getdeletedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getdeletedcount.xml deleted file mode 100644 index 0416077f3d..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getdeletedcount.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::getDeletedCount - Renvoie le nombre de documents supprimés - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getDeletedCount - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nombre de documents supprimés. - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteResult::getDeletedCount</function> - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getDeletedCount()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getinsertedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getinsertedcount.xml deleted file mode 100644 index 0b275b97ee..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getinsertedcount.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::getInsertedCount - Renvoie le nombre de documents insérés (à l'exception d'Upserts) - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getInsertedCount - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nombre de documents insérés (à l'exception d'Upserts). - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteResult::getInsertedCount</function> - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getInsertedCount()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getmatchedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getmatchedcount.xml deleted file mode 100644 index 12964cb611..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getmatchedcount.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::getMatchedCount - Renvoie le nombre de documents sélectionnés pour la mise à jour - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getMatchedCount - - - - Si l'opération de mise à jour n'entraîne aucune modification du document - (par exemple, en définissant la valeur d'un champ sur sa valeur actuelle), - le nombre correspondant peut être supérieur à la valeur retournée par - MongoDB\Driver\WriteResult::getModifiedCount. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le nombre de documents sélectionnés pour la mise à jour. - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteResult::getMatchedCount</function> - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getMatchedCount()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::getModifiedCount - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getmodifiedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getmodifiedcount.xml deleted file mode 100644 index 583209a2bd..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getmodifiedcount.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::getModifiedCount - Renvoie le nombre de documents existants mis à jour - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getModifiedCount - - - - Si l'opération de mise à jour n'entraîne aucune modification du document - (par exemple, en définissant la valeur d'un champ sur sa valeur actuelle), - le nombre modifié peut être inférieur à la valeur retournée par - MongoDB\Driver\WriteResult::getMatchedCount. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le nombre de documents existants mis à jour. - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteResult::getModifiedCount</function> - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getModifiedCount()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::getMatchedCount - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getserver.xml b/reference/mongodb/mongodb/driver/writeresult/getserver.xml deleted file mode 100644 index 9312a13adf..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getserver.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteResult::getServer - Retourne le serveur associé à ce résultat d'écriture - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\WriteResult::getServer - - - - Retourne le MongoDB\Driver\Server associé à ce résultat d'écriture. Il s'agit du serveur qui a exécuté le MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le MongoDB\Driver\Server associé à ce résultat d'écriture. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteResult::getServer</function> - -selectServer(); - -$bulk = new MongoDB\Driver\BulkWrite; -$bulk->insert(['x' => 1]); - -$result = $server->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getServer() == $server); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getupsertedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getupsertedcount.xml deleted file mode 100644 index 62de12a4ab..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getupsertedcount.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::getUpsertedCount - Renvoie le nombre de documents insérés par un upsert - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getUpsertedCount - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nombre de documents insérés par un upsert. - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteResult::getUpsertedCount</function> - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getUpsertedCount()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::getUpsertedIds - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getupsertedids.xml b/reference/mongodb/mongodb/driver/writeresult/getupsertedids.xml deleted file mode 100644 index b4100da019..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getupsertedids.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteResult::getUpsertedIds - Retourne un tableau d'identificateurs pour les documents upserted - - - - &reftitle.description; - - final public arrayMongoDB\Driver\WriteResult::getUpsertedIds - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau d'identificateurs (par exemple la valeur du champ "_id") pour les documents upserted. Les clés de tableau correspondent à l'index de l'opération d'écriture (à partir de MongoDB\Driver\BulkWrite) responsable du upsert. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteResult::getUpsertedIds</function> - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getUpsertedIds()); - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\BSON\ObjectId)#4 (1) { - ["oid"]=> - string(24) "580e62a224f2302f191b880b" - } - [3]=> - object(MongoDB\BSON\ObjectId)#5 (1) { - ["oid"]=> - string(24) "580e62a224f2302f191b880c" - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::getUpsertedCount - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml b/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml deleted file mode 100644 index 2f82775d2b..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::getWriteConcernError - Retourne toute erreur de WriteConcern qui s'est produite - - - - &reftitle.description; - - final public MongoDB\Driver\WriteConcernErrornullMongoDB\Driver\WriteResult::getWriteConcernError - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un MongoDB\Driver\WriteConcernError si une erreur de write concern a été rencontrée pendant l'opération d'écriture, et &null; sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - Exemple avec <function>MongoDB\Driver\WriteResult::getWriteConcernError</function> - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(2, 1); - -try { - $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteConcernError()); -} - -?> -]]> - - &example.outputs.similar; - - - string(33) "waiting for replication timed out" - ["code"]=> - int(64) - ["info"]=> - object(stdClass)#7 (1) { - ["wtimeout"]=> - bool(true) - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - Référence Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml b/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml deleted file mode 100644 index 9157fa903c..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteResult::getWriteErrors - Retourne toutes les erreurs d'écriture qui se sont produites - - - - &reftitle.description; - - final public arrayMongoDB\Driver\WriteResult::getWriteErrors - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau d'objets MongoDB\Driver\WriteError - pour toutes les erreurs d'écriture rencontrées pendant l'opération - d'écriture. Le tableau sera vide si aucune erreur d'écriture n'est survenue. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::getWriteErrors</function> avec une seule erreur - -insert(['_id' => 1]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 3]); -$bulk->insert(['_id' => 4]); -$bulk->insert(['_id' => 4]); - -try { - $result = $manager->executeBulkWrite('db.collection', $bulk); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()); -} - - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(81) "E11000 duplicate key error collection: db.collection index: _id_ dup key: { : 2 }" - ["code"]=> - int(11000) - ["index"]=> - int(2) - ["info"]=> - NULL - } -} -]]> - - - - <function>MongoDB\Driver\WriteResult::getWriteErrors</function> avec plusieurs erreurs - - false]); -$bulk->insert(['_id' => 1]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 3]); -$bulk->insert(['_id' => 4]); -$bulk->insert(['_id' => 4]); - -try { - $result = $manager->executeBulkWrite('db.collection', $bulk); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(81) "E11000 duplicate key error collection: db.collection index: _id_ dup key: { : 2 }" - ["code"]=> - int(11000) - ["index"]=> - int(2) - ["info"]=> - NULL - } - [1]=> - object(MongoDB\Driver\WriteError)#6 (4) { - ["message"]=> - string(81) "E11000 duplicate key error collection: db.collection index: _id_ dup key: { : 4 }" - ["code"]=> - int(11000) - ["index"]=> - int(5) - ["info"]=> - NULL - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteError - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/isacknowledged.xml b/reference/mongodb/mongodb/driver/writeresult/isacknowledged.xml deleted file mode 100644 index 71c7728d28..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/isacknowledged.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::isAcknowledged - Retourne si l'écriture a été reconnue - - - - &reftitle.description; - - final public boolMongoDB\Driver\WriteResult::isAcknowledged - - - - Si l'écriture a été reconnue, d'autres champs de comptage seront disponibles - pour l'objet MongoDB\Driver\WriteResult. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si l'écriture a été reconnue, et &false; sinon. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::isAcknowledged</function> avec le write concern reconnu - -insert(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - <function>MongoDB\Driver\WriteResult::isAcknowledged</function> avec le write concern non reconnu - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(0); - -$result = $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - Référence Write Concern - - - - - - diff --git a/reference/mongodb/monitoring.xml b/reference/mongodb/monitoring.xml deleted file mode 100644 index 1fc346ff35..0000000000 --- a/reference/mongodb/monitoring.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Classes de surveillance et fonctions abonnées - MongoDB\Driver\Monitoring - - - &Functions; - &reference.mongodb.functions.driver.entities.monitoring; - - - &reference.mongodb.mongodb.driver.monitoring.commandfailedevent; - &reference.mongodb.mongodb.driver.monitoring.commandstartedevent; - &reference.mongodb.mongodb.driver.monitoring.commandsucceededevent; - - &reference.mongodb.mongodb.driver.monitoring.serverchangedevent; - &reference.mongodb.mongodb.driver.monitoring.serverclosedevent; - &reference.mongodb.mongodb.driver.monitoring.serveropeningevent; - &reference.mongodb.mongodb.driver.monitoring.serverheartbeatfailedevent; - &reference.mongodb.mongodb.driver.monitoring.serverheartbeatstartedevent; - &reference.mongodb.mongodb.driver.monitoring.serverheartbeatsucceededevent; - &reference.mongodb.mongodb.driver.monitoring.topologychangedevent; - &reference.mongodb.mongodb.driver.monitoring.topologyclosedevent; - &reference.mongodb.mongodb.driver.monitoring.topologyopeningevent; - - &reference.mongodb.mongodb.driver.monitoring.commandsubscriber; - &reference.mongodb.mongodb.driver.monitoring.logsubscriber; - &reference.mongodb.mongodb.driver.monitoring.sdamsubscriber; - &reference.mongodb.mongodb.driver.monitoring.subscriber; - diff --git a/reference/mongodb/security.xml b/reference/mongodb/security.xml deleted file mode 100644 index 18b1ec189c..0000000000 --- a/reference/mongodb/security.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - Sécurité - -
    - Attaques par injection de requêtes - - Si on passe des paramètres $_GET (ou $_POST) - aux requêtes, il faut s'assurer de convertir en chaînes de caractères avant. - Les utilisateurs peuvent insérer des tableaux associatifs dans les requêtes - GET et POST, qui pourraient alors devenir des requêtes $ indésirables. - - - - Un exemple assez anodin : supposez qu'on cherche les informations d'un - utilisateur avec la requête http://www.example.com?username=bob. - L'application crée la requête - $q = new \MongoDB\Driver\Query( [ 'username' => $_GET['username'] ]). - - - - Cela fonctionne bien, mais quelqu'un pourrait subvertir cela en passant - http://www.example.com?username[$ne]=foo, que PHP - transformera magiquement en un tableau associatif, transformant la requête en - $q = new \MongoDB\Driver\Query( [ 'username' => [ '$ne' => 'foo' ] ] ), - qui renverra tous les utilisateurs dont le nom n'est pas "foo" (tous les utilisateurs, probablement). - - - - C'est une attaque assez facile à contrer : il faut s'assurer que les paramètres - $_GET et $_POST sont du type attendu - avant d'envoyer à la base de données. PHP dispose de la fonction - filter_var pour aider. - - - - À noter que ce type d'attaque peut être utilisé avec n'importe quelle interaction - avec la base de données qui localise un document, y compris les mises à jour, - les upserts, les suppressions et les commandes findAndModify. - - - - Voir la documentation principale - pour plus d'informations sur les problèmes de type injection SQL avec MongoDB. - -
    - -
    - Attaque par injection de scripts - - Lors de l'utilisation de JavaScript, il faut s'assurer que toutes les variables qui - traversent la frontière PHP-JavaScript sont passées dans le champ - scope de MongoDB\BSON\Javascript, - et non interpolées dans la chaîne JavaScript. Cela peut se produire lorsque - on utilise des clauses $where dans les requêtes, les - commandes mapReduce et group, et à tout autre moment où il est possible de passer - du JavaScript à la base de données. - - - Par exemple, supposons que nous avons un JavaScript pour saluer un utilisateur - dans les logs de la base de données. Nous pourrions faire : - - - "print('Hello, $username!');" -] ); - -$r = $m->executeCommand( 'dramio', $cmd ); -?> -]]> - - - Cependant, que se passe-t-il si un utilisateur malveillant passe du JavaScript ? - - - "print('Hello, $username!');" -] ); - -$r = $m->executeCommand( 'dramio', $cmd ); -?> -]]> - - - Maintenant MongoDB exécute la chaîne JavaScript - "print('Hello, '); db.users.drop(); print('!');". - Cette attaque est facile à éviter : utiliser args pour passer - des variables de PHP à JavaScript : - - - "function greet(username) { print('Hello, ' + username + '!'); }", - 'args' => $args, -] ); - -$r = $m->executeCommand( 'dramio', $cmd ); -?> -]]> - - - Cela ajoute un argument à la portée JavaScript, qui est utilisé comme argument - pour la fonction greet. Maintenant si - quelqu'un essaie d'envoyer du code malveillant, MongoDB imprimera inoffensivement - Hello, '); db.dropDatabase(); print('!. - - - - Utiliser des arguments aide à empêcher l'exécution d'entrées malveillantes par - la base de données. Cependant, il faut s'assurer que le code ne - retourne pas et n'exécute pas l'entrée de toute façon ! Il est préférable - d'éviter d'exécuter quelconque JavaScript sur le serveur - en premier lieu. - - - - Il est recommandé de rester à l'écart de la clause $where - dans les requêtes, car elle impacte significativement les performances. Dans - la mesure du possible, utiliser soit des opérateurs de requête normaux, soit - le Framework - d'agrégation. - - - - Une alternative à MapReduce, qui utilise - JavaScript, est le Framework - d'agrégation. Contrairement à Map/Reduce, il utilise un langage - idiomatique pour construire des requêtes, sans avoir à écrire et utiliser - l'approche JavaScript plus lente que Map/Reduce nécessite. - - - - La commande eval - a été dépréciée depuis MongoDB 3.0, et devrait également être évitée. - -
    -     - - diff --git a/reference/mongodb/setup.xml b/reference/mongodb/setup.xml deleted file mode 100644 index f1c8d9e777..0000000000 --- a/reference/mongodb/setup.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Depuis la version 1.21.0, l'extension nécessite PHP 8.1 ou supérieur. Les - versions précédentes de l'extension permettent la compatibilité avec les anciennes versions de PHP. - - - L'extension nécessite - libbson et - libmongoc, et utilisera - les versions incluses par défaut. Les bibliothèques système peuvent également - être utilisées, comme discuté dans la documentation - d'installation manuelle. - - - L'extension, via libmongoc, dépend optionnellement d'une bibliothèque TLS - (par exemple OpenSSL) et l'utilisera si elle est disponible. Si le processus - de construction ne parvient pas à trouver une bibliothèque TLS, les - utilisateurs doivent vérifier que le paquet de développement approprié - (par exemple libssl-dev) et - pkg-config sont - tous deux installés. Le processus de détection et de configuration des - bibliothèques TLS est discuté plus en détail dans la documentation - d'installation manuelle. - - - Cyrus SASL est une dépendance optionnelle - pour prendre en charge l'authentification Kerberos et sera utilisée si elle est disponible. - - - - À cause de problèmes potentiels de représentation des entiers 64 bits sur des - plateformes 32 bits, il est conseillé aux utilisateurs d'utiliser des - environnements 64 bits. Lors de l'utilisation d'une plateforme 32 bits, il faut - être conscient que tout entier 64 bits lu depuis la base de données sera retourné - sous la forme d'une instance MongoDB\BSON\Int64 au - lieu d'un type entier PHP. - - -
    - - &reference.mongodb.configure; - &reference.mongodb.ini; - - -     - - diff --git a/reference/mongodb/tutorial.xml b/reference/mongodb/tutorial.xml deleted file mode 100644 index 31c4dc163e..0000000000 --- a/reference/mongodb/tutorial.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - Tutoriels - Tutoriels - - - - - Dans cette section, on trouvera plusieurs tutoriels sur l'utilisation du - pilote MongoDB pour PHP. - - - - - &reference.mongodb.tutorial.library; - &reference.mongodb.tutorial.apm; - - - - diff --git a/reference/mongodb/tutorial/apm.xml b/reference/mongodb/tutorial/apm.xml deleted file mode 100644 index 8cd0761eca..0000000000 --- a/reference/mongodb/tutorial/apm.xml +++ /dev/null @@ -1,208 +0,0 @@ - - -
    - Surveillance de la performance de l'application (Application Performance Monitoring - APM) - - - L'extension contient une API d'observations événements, qui permet aux applications de - surveiller les commandes et les activités internes liées à la - Spécification de découverte et de surveillance du serveur. - Ce tutoriel démontrera la surveillance des commandes en utilisant l'interface - MongoDB\Driver\Monitoring\CommandSubscriber. - - - - L'interface - MongoDB\Driver\Monitoring\CommandSubscriber - définit trois méthodes: commandStarted, - commandSucceeded, et commandFailed. - Chacune de ces trois méthodes accepte un seul argument event - d'une classe spécifique pour l'événement respectif. Par exemple, l'argument - event de commandSucceeded - est un objet MongoDB\Driver\Monitoring\CommandSucceededEvent. - - - - Dans ce tutoriel, nous allons implémenter un observateur qui crée une liste de tous - les profils de requête et le temps moyen qu'ils ont pris. - - -
    - Structure des classes d'observations - - - Nous commençons par le cadre de notre observateur: - - - - -]]> - -
    - -
    - Enregistrement de l'observateur - - - Une fois qu'un objet observateur est instancié, il doit être enregistré avec le - système de surveillance de l'extension. Cela se fait en appelant - MongoDB\Driver\Monitoring\addSubscriber ou - MongoDB\Driver\Manager::addSubscriber pour enregistrer - l'observateur globalement ou avec un Manager spécifique, respectivement. - - - - -]]> - -
    - -
    - Implémenter la logique - - - Avec l'objet enregistré, la seule chose qui reste est d'implémenter la logique - dans la classe observatrice. Pour corréler les deux événements qui composent une - commande exécutée avec succès (commandStarted et commandSucceeded), chaque - objet d'événement expose un champ requestId. - - - Pour enregistrer le temps moyen par forme de requête, nous allons commencer par vérifier - une commande find dans l'événement commandStarted. Nous allons ensuite - ajouter un élément à la propriété pendingCommands indexé par son - requestId et avec sa valeur représentant la forme de requête. - - - Si nous recevons un événement commandSucceeded correspondant avec le même - requestId, nous ajoutons la durée de l'événement (depuis - durationMicros) au temps total et incrémentons le - compteur d'opérations. - - - Si un événement commandFailed correspondant est rencontré, nous supprimons - simplement l'entrée de la propriété pendingCommands. - - - -getCommandName() ) - { - $queryShape = $this->createQueryShape( (array) $event->getCommand()->filter ); - $this->pendingCommands[$event->getRequestId()] = $queryShape; - } - } - - public function commandSucceeded( \MongoDB\Driver\Monitoring\CommandSucceededEvent $event ): void - { - $requestId = $event->getRequestId(); - if ( array_key_exists( $requestId, $this->pendingCommands ) ) - { - $this->queryShapeStats[$this->pendingCommands[$requestId]]['count']++; - $this->queryShapeStats[$this->pendingCommands[$requestId]]['duration'] += $event->getDurationMicros(); - unset( $this->pendingCommands[$requestId] ); - } - } - - public function commandFailed( \MongoDB\Driver\Monitoring\CommandFailedEvent $event ): void - { - if ( array_key_exists( $event->getRequestId(), $this->pendingCommands ) ) - { - unset( $this->pendingCommands[$event->getRequestId()] ); - } - } - - public function __destruct() - { - foreach( $this->queryShapeStats as $shape => $stats ) - { - echo "Shape: ", $shape, " (", $stats['count'], ")\n ", - $stats['duration'] / $stats['count'], "µs\n\n"; - } - } -} - -$m = new \MongoDB\Driver\Manager( 'mongodb://localhost:27016' ); - -/* Ajouter l'observateur */ -\MongoDB\Driver\Monitoring\addSubscriber( new QueryTimeCollector() ); - -/* Faire une série de requêtes */ -$query = new \MongoDB\Driver\Query( [ - 'region_slug' => 'scotland-highlands', 'age' => [ '$gte' => 20 ] -] ); -$cursor = $m->executeQuery( 'dramio.whisky', $query ); - -$query = new \MongoDB\Driver\Query( [ - 'region_slug' => 'scotland-lowlands', 'age' => [ '$gte' => 15 ] -] ); -$cursor = $m->executeQuery( 'dramio.whisky', $query ); - -$query = new \MongoDB\Driver\Query( [ 'region_slug' => 'scotland-lowlands' ] ); -$cursor = $m->executeQuery( 'dramio.whisky', $query ); - -?> -]]> - -
    - -
    - - diff --git a/reference/mongodb/tutorial/library.xml b/reference/mongodb/tutorial/library.xml deleted file mode 100644 index f426d6f0c2..0000000000 --- a/reference/mongodb/tutorial/library.xml +++ /dev/null @@ -1,176 +0,0 @@ - - -
    - Utiliser la bibliothèque PHP pour MongoDB (PHPLIB) - - - Après la configuration initiale de l'extension, nous allons continuer à expliquer comment démarrer - avec la bibliothèque utilisateur correspondante pour écrire notre premier projet. - - -
    - Installer la bibliothèque PHP avec Composer - - - La dernière chose que nous devons installer pour commencer l'application - elle-même est la bibliothèque PHP. - - - - La bibliothèque doit être installée avec - Composer, un gestionnaire de - paquets pour PHP. Les instructions pour installer Composer sur différentes - plateformes peuvent être trouvées sur son site web. - - - - Installer la bibliothèque en exécutant: - - - - - - - Cela produira une sortie similaire à: - - - - - - - - Composer va créer plusieurs fichiers: composer.json, - composer.lock, et un répertoire vendor qui - contiendra la bibliothèque et toutes les autres dépendances que le projet pourrait nécessiter. - -
    - -
    - Utiliser la bibliothèque PHP - - - En plus de gérer les dépendances, Composer fournira également un - autochargement (pour les classes de ces dépendances). Il faut s'assurer - qu'il est inclus au début du script ou dans le code d'amorçage de - l'application : - - - - - - - Avec cela fait, il est maintenant possible d'utiliser n'importe quelle - fonctionnalité comme décrit dans la - documentation de la bibliothèque. - - - - Si on a utilisé des pilotes MongoDB dans d'autres langages, l'API de la - bibliothèque devrait sembler familière. Elle contient une classe - Client - pour se connecter à MongoDB, une classe - Database - pour les opérations au niveau de la base de données (par exemple, les commandes, la gestion des collections), - et une classe - Collection - pour les opérations au niveau de la collection (par exemple, les méthodes - CRUD, la gestion des index). - - - - En tant qu'exemple, voici comment on insère un document dans la collection - beers de la base de données demo: - -demo->beers; - -$result = $collection->insertOne( [ 'name' => 'Hinterland', 'brewery' => 'BrewDog' ] ); - -echo "Inserted with Object ID '{$result->getInsertedId()}'"; -?> -]]> - - - - - Comme le document inséré ne contenait pas de champ _id, l'extension - va générer un MongoDB\BSON\ObjectId pour que le serveur - l'utilise comme _id. Cette valeur est également disponible pour - l'appelant via l'objet de résultat retourné par la méthode insertOne. - - - - Après l'insertion, il est possible d'interroger les données qu'on vient d'insérer. - Pour cela, on utilise la méthode find, qui retourne un curseur - itérable: - -demo->beers; - -$result = $collection->find( [ 'name' => 'Hinterland', 'brewery' => 'BrewDog' ] ); - -foreach ($result as $entry) { - echo $entry['_id'], ': ', $entry['name'], "\n"; -} -?> -]]> - - - - - Tandis que les exemples ne le montrent pas, les documents BSON et les tableaux - sont désérialisés en tant que classes spéciales dans la bibliothèque par défaut. - Ces classes étendent ArrayObject pour la facilité d'utilisation - et implémentent les interfaces MongoDB\BSON\Serializable - et MongoDB\BSON\Unserializable de l'extension pour - garantir que les valeurs conservent leur type lorsqu'elles sont sérialisées de - nouveau en BSON. Cela évite un inconvénient de l'ancienne extension mongo - où les tableaux pourraient se transformer en documents, et vice versa. Voir la - spécification pour plus d'informations sur - la façon dont les valeurs sont converties entre PHP et BSON. - -
    -
    - diff --git a/reference/mqseries/book.xml b/reference/mqseries/book.xml deleted file mode 100644 index 2e20a393c8..0000000000 --- a/reference/mqseries/book.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - mqseries - - - - &reftitle.intro; - &warn.experimental; - - Cette extension fournit une interface de communication avec les gestionnaires - de file d'attente IBM WebSphere MQ. - - - L'interface imite l'API du client C de WebSphere MQ Series autant que possible, - en utilisant les mêmes conventions de noms et fonctionnalités. Afin de comprendre - le fonctionnement de cette extension, un minimum de connaissance de l'interface - C est nécessaire. - - - Pour les MQ-options, MQ-structures, MQ-results etc., se reporter au "WebSphere MQ - Application Programming Guide" et "WebSphere MQ Application Programming - Reference". - - - - - &reference.mqseries.setup; - &reference.mqseries.constants; - &reference.mqseries.reference; - - - diff --git a/reference/mqseries/configure.xml b/reference/mqseries/configure.xml deleted file mode 100644 index 2792e83cac..0000000000 --- a/reference/mqseries/configure.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; &url.pecl.package;mqseries. - - - - Le nom officiel de cette extension est mqseries. - - - - Il y a deux moyens de se connecter au gestionnaire de queue. Ils dépendent de comment - l'extension a été compilée. - - - - Premièrement, et aussi par défaut, il y a la bibliothèque mqic. En compilant et liant - l'extension avec les bibliothèques IBM WebSphere MQSeries, on peut se connecter à la - Queue manager avec l'interface client. Les connexions distantes sont aussi possibles de - cette manière. - - - - - L'autre moyen est de compiler et lier les bibliothèques mqm. En utilisant ces bibliothèques, - il est possible d'utiliser le gestionnaire de transaction du serveur de queue. - - - - Actuellement, la sélection de ces bibliothèques se fait en modifiant le fichier - config.m4. -
    - diff --git a/reference/mqseries/constants.xml b/reference/mqseries/constants.xml deleted file mode 100644 index 5f9e789055..0000000000 --- a/reference/mqseries/constants.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - &reftitle.constants; - - Pour chaque constante WebSphere MQ Constant, il y a un équivalent mqseries. - - Pour les définitions et utilisation, se reporter au - "WebSphere MQ Application Programming Guide" et "WebSphere MQ - Application Programming Reference red books". - - Le nom des constantes mqseries est fait en préfixant le nom de la constante - WebSphere MQ avec MQSERIES_. Par exemple, les constantes - de CompletionCode sont : - - - mqseries constants - - - - Constante PHP - Constante MQ - - - - - MQSERIES_MQCC_OK - MQCC_OK - - - MQSERIES_MQCC_WARNING - MQCC_WARNING - - - MQSERIES_MQCC_FAILED - MQCC_FAILED - - - MQSERIES_MQCC_UNKNOWN - MQCC_UNKNOWN - - - -
    - -     - diff --git a/reference/mqseries/functions/mqseries-back.xml b/reference/mqseries/functions/mqseries-back.xml deleted file mode 100644 index 7e750acdf0..0000000000 --- a/reference/mqseries/functions/mqseries-back.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - mqseries_back - MQSeries MQBACK - - - - &reftitle.description; - - voidmqseries_back - resourcehconn - resourcecompCode - resourcereason - - - mqseries_back indique au gestionnaire de queue que - tous les messages lus et écrits depuis le dernier point de synchronisation - doivent être annulés. Les messages qui font partie d'une unité de travail - seront effacés. Les messages lus comme unité de travail seront réinsérés dans - la queue. - - - mqseries_back fonctionne aussi en conjonction avec - mqseries_begin et uniquement lorsqu'on se connecte - directement au gestionnaire de queues : cela ne fonctionne pas via - l'interface mqclient. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - Cette ressource représente la connexion au manager de queues. - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Exemple avec <function>mqseries_back</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } -?> -]]> - - - - - - &reftitle.notes; - - - mqseries_back ne fonctionne pas lorsqu'un - client MQSeries Client se connecte au Queue Manager. - - - - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_begin - - - - diff --git a/reference/mqseries/functions/mqseries-begin.xml b/reference/mqseries/functions/mqseries-begin.xml deleted file mode 100644 index 42f38a75e6..0000000000 --- a/reference/mqseries/functions/mqseries-begin.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - mqseries_begin - MQseries MQBEGIN - - - - &reftitle.description; - - voidmqseries_begin - resourcehconn - arraybeginOptions - resourcecompCode - resourcereason - - - mqseries_begin commence une unité de travail, coordonnée - par le gestionnaire de queue, et impliquant éventuellement des gestionnaires - de ressources externes. - - - mqseries_begin commence une unité de travail. - Soit mqseries_back, soit mqseries_cmit - termineront l'unité de travail. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - Cette ressource représente la connexion au manager de queues. - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Exemple avec <function>mqseries_begin</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } - } -?> -]]> - - - - - - &reftitle.notes; - - - mqseries_begin ne fonctionne pas lorsqu'un - client MQSeries Client se connecte au Queue Manager. - - - - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_back - mqseries_cmit - - - - diff --git a/reference/mqseries/functions/mqseries-close.xml b/reference/mqseries/functions/mqseries-close.xml deleted file mode 100644 index 9d315ea82c..0000000000 --- a/reference/mqseries/functions/mqseries-close.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - mqseries_close - MQSeries MQCLOSE - - - - &reftitle.description; - - voidmqseries_close - resourcehconn - resourcehobj - intoptions - resourcecompCode - resourcereason - - - mqseries_close relâche l'accès à un objet, et est l'inverse - de la fonction mqseries_open. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - Cette ressource représente la connexion au manager de queues. - - - - - hObj - - - Object handle. - Cette ressource représente l'objet à utiliser. - - - - - options - - - - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Exemple avec <function>mqseries_close</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } -?> -]]> - - - - - - &reftitle.seealso; - - mqseries_open - mqseries_conn - mqseries_connx - - - - diff --git a/reference/mqseries/functions/mqseries-cmit.xml b/reference/mqseries/functions/mqseries-cmit.xml deleted file mode 100644 index ac5436f63f..0000000000 --- a/reference/mqseries/functions/mqseries-cmit.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - mqseries_cmit - MQSeries MQCMIT - - - - &reftitle.description; - - voidmqseries_cmit - resourcehconn - resourcecompCode - resourcereason - - - mqseries_cmit indique au gestionnaire de queue que l'application - a atteint un point de synchronisation, et que tous les messages qui ont été - lus et écrits depuis le dernier point de synchronisation ont été rendus permanents. - Les messages placés dans la queue comme unité de travail sont maintenant - accessibles aux autres applications. Les messages lus comme unité de travail sont - maintenant détruits. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - Cette ressource représente la connexion au manager de queues. - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Exemple avec <function>mqseries_cmit</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } -?> -]]> - - - - - - &reftitle.notes; - - - mqseries_back ne fonctionne pas lorsqu'un - client MQSeries Client se connecte au Queue Manager. - - - - - - &reftitle.seealso; - - mqseries_begin - mqseries_back - mqseries_conn - mqseries_connx - - - - diff --git a/reference/mqseries/functions/mqseries-conn.xml b/reference/mqseries/functions/mqseries-conn.xml deleted file mode 100644 index 0e8208b92d..0000000000 --- a/reference/mqseries/functions/mqseries-conn.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - mqseries_conn - MQSeries MQCONN - - - - &reftitle.description; - - voidmqseries_conn - stringqManagerName - resourcehconn - resourcecompCode - resourcereason - - - mqseries_conn établit la connexion avec le gestionnaire de queues. - Il fournit une ressource de connexion, qui est utilisée par les autres fonctions - de l'extension. - - - - - &reftitle.parameters; - - - - qManagerName - - - Nom du gestionnaire de queues. - Nom du gestionnaire de queues avec qui l'application veut se connecter. - - - - - hConn - - - Gestionnaire de connexion. - Cette ressource représente la connexion au manager de queues. - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Exemple avec <function>mqseries_conn</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } -?> -]]> - - - - - - &reftitle.seealso; - - mqseries_disc - - - - diff --git a/reference/mqseries/functions/mqseries-connx.xml b/reference/mqseries/functions/mqseries-connx.xml deleted file mode 100644 index 575c1e4387..0000000000 --- a/reference/mqseries/functions/mqseries-connx.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - - mqseries_connx - MQSeries MQCONNX - - - - &reftitle.description; - - voidmqseries_connx - stringqManagerName - arrayconnOptions - resourcehconn - resourcecompCode - resourcereason - - - L'appel de - mqseries_connx - (MQCONNX) connecte un programme d'application à un gestionnaire de files d'attente. - Il fournit un descripteur de connexion du gestionnaire de files d'attente, - qui est utilisé par l'application lors d'appels MQ ultérieurs. - - - L'appel de mqseries_connx est comme l'appel de - mqseries_conn (MQCONN), à l'exception que MQCONNX - permet de spécifier des options pour contrôler le fonctionnement de l'appel. - - - - - &reftitle.parameters; - - - - qManagerName - - - Nom du gestionnaire de files d'attente. - Nom du gestionnaire de files d'attente avec qui l'application veut se connecter. - - - - - connOps - - - Options qui contrôlent les actions de la fonction - Voir aussi la structure MQCNO. - - - - - - hConn - - - Gestionnaire de connexion. - Ce gestionnaire représente la connexion au gestionnaire de files d'attente. - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - - Exemple avec <function>mqseries_connx</function> - - - MQSERIES_MQCNO_VERSION_2, - 'Options' => MQSERIES_MQCNO_STANDARD_BINDING, - 'MQCD' => array('ChannelName' => 'MQNX9420.CLIENT', - 'ConnectionName' => 'localhost', - 'TransportType' => MQSERIES_MQXPT_TCP) - ); - - mqseries_connx('MQNX9420', $mqcno, $conn, $comp_code,$reason); - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("Connx CompCode:%d Reason:%d Text:%s
    \n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } - -?> -]]> -     -     - - - Exemple avec <function>mqseries_connx</function> en utilisant une - connexion SSL et une URL OCSP Responder - - - 4, //MQCNO_VERSION_4 - 'Options' => MQSERIES_MQCNO_STANDARD_BINDING, - 'MQCD' => array( - 'Version' => 7, //MQCD_VERSION_7 - 'ConnectionName' => 'localhost', - 'TransportType' => MQSERIES_MQXPT_TCP, - 'ChannelName' => 'CONNECTIONCHANNEL', - 'SSLCipherSpec' => 'NULL_SHA' - ), - 'MQSCO' => array( - 'KeyRepository' => '/var/mqm/qmgrs/QUEUEMGR/ssl/key', //Chemin local où le dossier contenant la clé SSL peut être trouvé - 'MQAIR' => array( - 'Version' => 2, //MQAIR_VERSION_2 - 'AuthInfoType' => 2, //MQAIT_OCSP - 'OCSPResponderURL' => 'http://dummy.OCSP.responder' - ) - ) - ); - - mqseries_connx('QUEUEMGR', $mqcno, $conn, $comp_code,$reason); - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("Connx CompCode:%d Reason:%d Text:%s
    \n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } - -?> -]]> -     -     -     -     - - - &reftitle.seealso; - - mqseries_disc - - -     - diff --git a/reference/mqseries/functions/mqseries-disc.xml b/reference/mqseries/functions/mqseries-disc.xml deleted file mode 100644 index d3bddc5cfa..0000000000 --- a/reference/mqseries/functions/mqseries-disc.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - mqseries_disc - MQSeries MQDISC - - - - &reftitle.description; - - voidmqseries_disc - resourcehconn - resourcecompCode - resourcereason - - - mqseries_disc ferme la connexion entre le gestionnaire - de queues et l'application. C'est l'inverse de mqseries_conn - et mqseries_connx. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - Cette ressource représente la connexion au manager de queues. - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Exemple avec <function>mqseries_disc</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } -?> -]]> - - - - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - - - - diff --git a/reference/mqseries/functions/mqseries-get.xml b/reference/mqseries/functions/mqseries-get.xml deleted file mode 100644 index e44ea07c49..0000000000 --- a/reference/mqseries/functions/mqseries-get.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - mqseries_get - MQSeries MQGET - - - - &reftitle.description; - - voidmqseries_get - resourcehConn - resourcehObj - arraymd - arraygmo - intbufferLength - stringmsg - intdata_length - resourcecompCode - resourcereason - - - mqseries_get lit un message dans une queue locale, - qui a été ouverte avec la fonction mqseries_open. - - - - - &reftitle.parameters; - - - - hConn - - - Gestionnaire de connexion. - Cette ressource représente la connexion au manager de queues. - - - - - hObj - - - Gestionnaire d'objet. - Cette ressource représente l'objet à utiliser. - - - - - md - - - Descripteur de message (MQMD). - - - - - gmo - - - Options de récupération de message (MQGMO). - - - - - bufferLength - - - Taille attendue du buffer de résultat - - - - - msg - - - - Buffer contenant le message lu depuis l'objet. - - - - - - data_length - - - Taille réelle du buffer - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Exemple avec <function>mqseries_get</function> - - 'TESTQ'), - MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT, - $obj, - $comp_code, - $reason); -// $obj contient maintenant la référence vers l'objet (TESTQ) - -// Définit un message de descripteur vide. - $mdg = array(); -// Définit les options de récupération des messages - $gmo = array('Options' => MQSERIES_MQGMO_FAIL_IF_QUIESCING | MQSERIES_MQGMO_WAIT, 'WaitInterval' => 3000); - -// Récupère les messages depuis la file d'attente - mqseries_get($conn, $obj, $mdg, $gmo, 255, $msg, $data_length, $comp_code, $reason); - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("GET CompCode:%d Reason:%d Text:%s
    ", $comp_code, $reason, mqseries_strerror($reason)); - } - -// Ferme la référence vers l'objet $obj - mqseries_close($conn, $obj, MQSERIES_MQCO_NONE, $comp_code, $reason); - -// Déconnecte du gestionnaire de file d'attente - mqseries_disc($conn, $comp_code, $reason); - -?> -]]> -     -     -     - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_open - mqseries_put - - -     - diff --git a/reference/mqseries/functions/mqseries-inq.xml b/reference/mqseries/functions/mqseries-inq.xml deleted file mode 100644 index a48fc6a01f..0000000000 --- a/reference/mqseries/functions/mqseries-inq.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - mqseries_inq - MQSeries MQINQ - - - - &reftitle.description; - - voidmqseries_inq - resourcehconn - resourcehobj - intselectorCount - arrayselectors - intintAttrCount - resourceintAttr - intcharAttrLength - resourcecharAttr - resourcecompCode - resourcereason - - - mqseries_inq retourne un tableau d'entiers et un - jeu de chaînes de caractères contenant les attributs d'un objet. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - Cette ressource représente la connexion au manager de queues. - - - - - hObj - - - Object handle. - Cette ressource représente l'objet à utiliser. - - - - - selectorCount - - - Nombre de sélecteurs. - - - - - selectors - - - Tableau d'attributs de sélecteurs. - - - - - intAttrLength - - - Nombre d'attributs entiers. - - - - - intAttr - - - Tableau d'attributs entiers. - - - - - charAttrLength - - - Taille du buffer d'attributs de caractère. - - - - - charAttr - - - Attribut de caractère. - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Exemple avec <function>mqseries_inq</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } else { - echo "INQ QManager name result ".$char_attr."
    \n"; - } -?> -]]> -     -     -     - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_open - - -     - diff --git a/reference/mqseries/functions/mqseries-open.xml b/reference/mqseries/functions/mqseries-open.xml deleted file mode 100644 index 74fd3a15ab..0000000000 --- a/reference/mqseries/functions/mqseries-open.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - mqseries_open - MQSeries MQOPEN - - - - &reftitle.description; - - voidmqseries_open - resourcehconn - arrayobjDesc - intoption - resourcehobj - resourcecompCode - resourcereason - - - mqseries_open établit un accès à un objet. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - Cette ressource représente la connexion au manager de queues. - - - - - objDesc - - - Descripteur d'objet (MQOD). - - - - - options - - - Options qui contrôlent les actions de la fonction. - - - - - hObj - - - Object handle. - Cette ressource représente l'objet à utiliser. - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Exemple avec <function>mqseries_open</function> - - 'TESTQ'); - mqseries_open( - $conn, - $mqods, - MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT, - $obj, - $comp_code, - $reason); - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("open CompCode:%d Reason:%d Text:%s
    \n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } -?> -]]> -     -     -     - - - &reftitle.seealso; - - mqseries_close - - -     - diff --git a/reference/mqseries/functions/mqseries-put.xml b/reference/mqseries/functions/mqseries-put.xml deleted file mode 100644 index d16c516b6d..0000000000 --- a/reference/mqseries/functions/mqseries-put.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - - mqseries_put - MQSeries MQPUT - - - - &reftitle.description; - - voidmqseries_put - resourcehConn - resourcehObj - arraymd - arraypmo - stringmessage - resourcecompCode - resourcereason - - - mqseries_put ajoute un message dans une queue, ou - une liste de distribution. La queue ou la liste de distribution doivent - être ouvertes. - - - - - &reftitle.parameters; - - - - hConn - - - Gestionnaire de connexion. - Cette ressource représente la connexion au manager de queues. - - - - - hObj - - - Object handle. - Cette ressource représente l'objet à utiliser. - - - - - md - - - Descripteur de message (MQMD). - - - - - pmo - - - Options d'ajout de message (MQPMO). - - - - - message - - - Le message à mettre dans la queue. - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Exemple avec <function>mqseries_put</function> - - 'TESTQ'), - MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT, - $obj, - $comp_code, - $reason); -// $obj contient maintenant la référence vers l'objet (TESTQ) - -// Définit le tableau de description du message. Vérifie manuellement les références à MQSeries. - $md = array( - 'Version' => MQSERIES_MQMD_VERSION_1, - 'Expiry' => MQSERIES_MQEI_UNLIMITED, - 'Report' => MQSERIES_MQRO_NONE, - 'MsgType' => MQSERIES_MQMT_DATAGRAM, - 'Format' => MQSERIES_MQFMT_STRING, - 'Priority' => 1, - 'Persistence' => MQSERIES_MQPER_PERSISTENT); - -// Définit les options de transmission des messages. - $pmo = array('Options' => MQSERIES_MQPMO_NEW_MSG_ID|MQSERIES_MQPMO_SYNCPOINT); - -// Place le message 'Ping' dans la file d'attente. - mqseries_put($conn, $obj, $md, $pmo, 'Ping', $comp_code, $reason); - - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("put CompCode:%d Reason:%d Text:%s
    \n", $comp_code, $reason, mqseries_strerror($reason)); - } - -// Ferme la référence à l'objet $obj - mqseries_close($conn, $obj, MQSERIES_MQCO_NONE, $comp_code, $reason); - -// Se déconnecte du gestionnaire de file d'attente. - mqseries_disc($conn, $comp_code, $reason); - -?> -]]> -     -     -     - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_open - mqseries_get - - -     - diff --git a/reference/mqseries/functions/mqseries-put1.xml b/reference/mqseries/functions/mqseries-put1.xml deleted file mode 100644 index 472ce25481..0000000000 --- a/reference/mqseries/functions/mqseries-put1.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - mqseries_put1 - MQSeries MQPUT1 - - - - &reftitle.description; - - voidmqseries_put1 - resourcehconn - resourceobjDesc - resourcemsgDesc - resourcepmo - stringbuffer - resourcecompCode - resourcereason - - - L'appel de mqseries_put1 - (MQPUT1) ajoute un message à une file d'attente. - La file d'attente n'a pas besoin d'être ouverte. - - - Il est possible d'utiliser à la fois des appels à mqseries_put - ainsi qu'à mqseries_put1 pour ajouter des messages - à une file d'attente ; quel appel à utiliser dépend des circonstances. - Utiliser l'appel à mqseries_put (MQPUT) pour ajouter plusieurs - messages à la même file d'attente. - Utiliser l'appel à mqseries_put1 (MQPUT1) pour ajouter un - seul message à une file d'attente. - Cet appel englobe les appels à MQOPEN, MQPUT, et MQCLOSE dans un seul appel, - minimisant le nombre d'appels à émettre. - - - - - &reftitle.parameters; - - - - hConn - - - Gestionnaire de connexion. - Ce gestionnaire représente la connexion au gestionnaire de files d'attente. - - - - - objDesc - - - Descripteur de l'objet. (MQOD) - - Cette structure identifie la file d'attente dans laquelle le message sera ajouté. - - - - - - msgDesc - - - Descripteur du message (MQMD). - - - - - pmo - - - Options d'ajout du message (MQPMO). - - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_open - mqseries_get - - - - diff --git a/reference/mqseries/functions/mqseries-set.xml b/reference/mqseries/functions/mqseries-set.xml deleted file mode 100644 index 4fd059aafb..0000000000 --- a/reference/mqseries/functions/mqseries-set.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - mqseries_set - MQSeries MQSET - - - - &reftitle.description; - - voidmqseries_set - resourcehConn - resourcehObj - intselectorCount - arrayselectors - intintAttrCount - arrayintAttrs - intcharAttrLength - arraycharAttrs - resourcecompCode - resourcereason - - - L'appel de mqseries_set - (MQSET) est utilisé pour modifier les attributs d'un objet représenté - par un gestionnaire. L'objet doit être une file d'attente. - - - - - &reftitle.parameters; - - - - hConn - - - Gestionnaire de connexion. - Ce gestionnaire représente la connexion au gestionnaire de files d'attente. - - - - - hObj - - - Gestionnaire d'objet. - Ce gestionnaire représente l'objet à utiliser. - - - - - selectorCount - - - Compte des sélecteurs. - - - - - selectors - - - Tableau d'attributs des sélecteurs. - - - - - intAttrCount - - - Compte d'attributs entiers. - - - - - intAttrs - - - Tableau d'attributs entiers. - - - - - charAttrLength - - - Longueur du tampon d'attributs de caractères. - - - - - charAttrs - - - Attributs de caractère. - - - - - compCode - - - Code de complétion. - - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.seealso; - - mqseries_inq - - - - diff --git a/reference/mqseries/functions/mqseries-strerror.xml b/reference/mqseries/functions/mqseries-strerror.xml deleted file mode 100644 index fcb48f2213..0000000000 --- a/reference/mqseries/functions/mqseries-strerror.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - mqseries_strerror - Retourne le message d'erreur correspondant au code de résultat - - - - &reftitle.description; - - stringmqseries_strerror - intreason - - - mqseries_strerror - retourne le message d'erreur correspondant au code de résultat. - - - - - &reftitle.parameters; - - - - reason - - - La raison qui qualifie le compCode. - - - - - - - &reftitle.returnvalues; - La chaîne de représentation de la raison du message d'erreur. - - - - &reftitle.examples; - - Exemple avec <function>mqseries_strerror</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mqseries/ini.xml b/reference/mqseries/ini.xml deleted file mode 100644 index 3f919664c8..0000000000 --- a/reference/mqseries/ini.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - &no.config; -
    - - diff --git a/reference/mqseries/reference.xml b/reference/mqseries/reference.xml deleted file mode 100644 index f8b3169131..0000000000 --- a/reference/mqseries/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - mqseries &Functions; - &reference.mqseries.entities.functions; - - - - diff --git a/reference/mqseries/resources.xml b/reference/mqseries/resources.xml deleted file mode 100644 index d52211af5f..0000000000 --- a/reference/mqseries/resources.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - -
    - &reftitle.resources; - - Cette extension définit une ressource de connexion et d'object_handle. - - - Les fonctions mqseries_conn et mqseries_connx définissent - des ressources de connexion. - - - La fonction mqseries_open définit une ressource d'object_handle. - -
    - diff --git a/reference/mqseries/setup.xml b/reference/mqseries/setup.xml deleted file mode 100644 index 5386309528..0000000000 --- a/reference/mqseries/setup.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Une installation fonctionnelle IBM WebSphere MQ. Pour la compilation de l'extension, - le SDK d'IBM WebSphere MQ est aussi nécessaire. - - - - Il faut savoir que lorsqu'on fonctionne avec le client IBM WebSphere MQ, - certaines méthodes ne sont pas disponibles. Ce n'est pas un problème avec - l'extension, mais simplement la manière de fonctionner de - WebSphere MQ Client Interface. - - - -
    - - - - &reference.mqseries.configure; - - - - &reference.mqseries.ini; - - - - &reference.mqseries.resources; - - -     - - - diff --git a/reference/mysql/book.xml b/reference/mysql/book.xml deleted file mode 100644 index 1f5bc08217..0000000000 --- a/reference/mysql/book.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - API MySQL originale - MySQL (Original) - - - - &reftitle.intro; - - Cette extension est obsolète à partir de PHP 5.5.0 et a été supprimée - à partir de PHP 7.0.0. À la place, soit l'extension - mysqli ou - PDO_MySQL devrait être utilisée. Voir aussi la vue d'ensemble de l'API MySQL pour plus d'aide dans le choix d'une API MySQL. - - - Ces fonctions permettent d'accéder aux bases de données - MySQL. Le site officiel de cette base est - &url.mysql;. - - - La documentation de MySQL est disponible à - &url.mysql.docs;. - - - - - &reference.mysql.setup; - &reference.mysql.changelog; - &reference.mysql.constants; - &reference.mysql.examples; - &reference.mysql.reference; - - - diff --git a/reference/mysql/changelog.xml b/reference/mysql/changelog.xml deleted file mode 100644 index 088d38f160..0000000000 --- a/reference/mysql/changelog.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - &ChangelogListingTitle; - &ChangelogListingDescription; - - - Historique des modifications général pour l'extension ext/mysql - - Cet historique des modifications fait référence à l'extension ext/mysql. - - - - - Modifications globales sur ext/mysql - - La liste suivante présente les modifications sur l'extension entière - ext/mysql. - - - - - - &Version; - &Description; - - - - - 7.0.0 - - - Cette extension a été supprimée de PHP. Pour plus de détails, - voir . - - - - - - - - - - Modification sur les fonctions existantes - - La liste suivante est une compilation des modifications effectuées - sur les fonctions de l'extension ext/mysql. - - - - - - diff --git a/reference/mysql/configure.xml b/reference/mysql/configure.xml deleted file mode 100644 index c1140a7601..0000000000 --- a/reference/mysql/configure.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - -
    - &reftitle.install; - - - &mysql.alternative.note; - - - - Pour compiler, utiliser tout simplement l'option de configuration - - où le paramètre optionnel [DIR] pointe vers - le dossier d'installation de MySQL. - - - Bien que cette extension MySQL soit compatible avec MySQL 4.1.0 et supérieur, - elle ne supporte pas les fonctionnalités supplémentaires que cette version fournit. - Pour cela, utiliser plutôt l'extension MySQLi. - - - Pour installer l'extension mysqli en même temps que l'extension - mysql, il faut utiliser la même bibliothèque client afin d'éviter les - conflits. - - -
    - Installation sur les systèmes Linux - - Note : [DIR] est le chemin vers la bibliothèque cliente - MySQL (en-têtes et bibliothèques), qui peut être - téléchargée depuis le site de MySQL. - - - Matrice du support d'ext/mysql - - - - PHP &Version; - &Default; - &ConfigureOptions; : mysqlnd - &ConfigureOptions; : libmysqlclient - &Changelog; - - - - - 4.x.x - libmysqlclient - &NotAvailable; - pour désactiver - MySQL est actif par défaut, les bibliothèques clientes MySQL sont incluses en interne - - - 5.0.x, 5.1.x, 5.2.x - libmysqlclient - &NotAvailable; - - - MySQL n'est pas actif par défaut, et les bibliothèques clientes MySQL - ne sont plus incluses en interne - - - - 5.3.x - libmysqlclient - - - mysqlnd est maintenant disponible - - - 5.4.x - mysqlnd - - - mysqlnd est maintenant incluse par défaut - - - -
    -
    - -
    - Installation sur les systèmes Windows -
    - PHP 5.0.x, 5.1.x, 5.2.x - - MySQL n'est plus activé par défaut, ainsi, la bibliothèque - php_mysql.dll doit être activée dans le &php.ini;. - De plus, PHP doit avoir accès à la bibliothèque cliente MySQL. - Un fichier nommé libmysql.dll est inclus dans - la distribution de PHP pour Windows et pour que PHP puisse discuter - avec MySQL, ce fichier doit être disponible dans le PATH - du système Windows. Consulter la FAQ intitulée - "Où dois-je ajouter mon répertoire PHP à la variable - PATH sous Windows ?" pour plus d'informations sur - la réalisation de cela. Néanmoins, le fait de copier le fichier - libmysql.dll dans le répertoire système de Windows fonctionne - (car le dossier système est par défaut dans le PATH système), - mais cela n'est pas du tout recommandé. - - - Pour activer n'importe quelle extension PHP (comme - php_mysql.dll), la directive PHP - extension_dir doit être définie - et doit pointer vers le dossier où sont stockées les extensions PHP. - Consulter également le - manuel d'installation sous Windows. - Par exemple, voici une valeur possible pour la directive - extension_dir en PHP 5 : - c:\php\ext - - - - Si lorsqu'on démarre le serveur web une erreur similaire à ceci apparaît : - "Unable to load dynamic library './php_mysql.dll'", - c'est parce que php_mysql.dll et/ou - libmysql.dll n'ont pu être trouvés par le système. - - -
    -
    - PHP 5.3.0+ - - Le driver MySQL natif est activé par défaut. - Incluez php_mysql.dll, mais libmysql.dll - n'est plus nécessaire, ni utilisé. - -
    -
    - -
    - Notes sur l'installation de MySQL - - - Des crashes et des problèmes de démarrage de PHP peuvent - être rencontrés lorsqu'on charge cette fonction en même temps que - l'extension recode. Voir l'extension recode - pour plus de détails. - - - - - Si on a besoin d'autres jeux de caractères que celui par - défaut (latin), il faut installer la - bibliothèque externe libmysqlclient (non fournie), compilée avec ce - jeu de caractères. - - -
    -
    - diff --git a/reference/mysql/constants.xml b/reference/mysql/constants.xml deleted file mode 100644 index e9c020348d..0000000000 --- a/reference/mysql/constants.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Il est possible de spécifier des options de client - supplémentaires pour les fonctions mysql_connect et - mysql_pconnect. Ces constantes sont les suivantes : - - Constantes client MySQL - - - - Constante - Description - - - - - MYSQL_CLIENT_COMPRESS - Utilise le protocole avec compression - - - MYSQL_CLIENT_IGNORE_SPACE - Autorise les espaces après les noms de fonction - - - MYSQL_CLIENT_INTERACTIVE - Autorise secondes - d'inactivité sur la connexion (au lieu de ). - - - MYSQL_CLIENT_SSL - Utilisation du chiffrement SSL. Cette constante n'est disponible - qu'à partir de la version 4.x et plus récente de la bibliothèque cliente MySQL. - La version 3.23.x est fournie avec PHP 4 ainsi qu'avec les binaires - pour windows de PHP 5. - - - -
    -     - - - La fonction mysql_fetch_array utilise une constante - pour spécifier les différents types de formats de réponse. Les constantes - suivantes sont utilisées : - - Constantes de <function>mysql_fetch_array</function> - - - - Constante - Description - - - - - MYSQL_ASSOC - - Les colonnes sont retournées dans un tableau, dont les index - sont les noms de colonnes. - - - - MYSQL_BOTH - - Les colonnes sont retournées dans un tableau ayant une indexation - numérique et un système d'index correspondant au nom des colonnes. - - - - MYSQL_NUM - - Les colonnes sont retournées dans un tableau avec un index numérique. - Les colonnes sont numérotées dans leur ordre d'apparition. L'index - commence à zéro. - - - - -
    -     -     - - - diff --git a/reference/mysql/examples.xml b/reference/mysql/examples.xml deleted file mode 100644 index d66e32f614..0000000000 --- a/reference/mysql/examples.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - &reftitle.examples; -
    - Exemple avec l'extension MySQL - - Cet exemple simple montre comment se connecter, exécuter une - requête, lire les informations obtenues et se déconnecter d'une - base de données MySQL. - - Exemple de présentation de l'extension MySQL - -\n"; -while ($line = mysql_fetch_array($result, MYSQL_ASSOC)) { - echo "\t\n"; - foreach ($line as $col_value) { - echo "\t\t$col_value\n"; - } - echo "\t\n"; -} -echo "\n"; - -// Libération des résultats -mysql_free_result($result); - -// Fermeture de la connexion -mysql_close($link); -?> -]]> - - - -
    -     - - - diff --git a/reference/mysql/functions/mysql-affected-rows.xml b/reference/mysql/functions/mysql-affected-rows.xml deleted file mode 100644 index bb08a6539a..0000000000 --- a/reference/mysql/functions/mysql-affected-rows.xml +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - - mysql_affected_rows - - Retourne le nombre de lignes affectées lors de la dernière opération MySQL - - - - - - &mysql.alternative.note; - - mysqli_affected_rows - PDOStatement::rowCount - - - - - - &reftitle.description; - - intmysql_affected_rows - resourcelink_identifierNULL - - - Retourne le nombre de lignes affectées lors de la dernière - requête INSERT, UPDATE, REPLACE ou DELETE avec - link_identifier. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne le nombre de lignes affectées en cas de succès et -1 si la - dernière requête a échoué. - - - Si la dernière requête était un DELETE sans clause WHERE, tous - les enregistrements ont été effacés, mais cette fonction va - retourner 0 avec les versions de MySQL antérieures à 4.1.2. - - - Lorsqu'on utilise UPDATE, MySQL ne mettra pas à jour les colonnes si - la nouvelle valeur est identique à l'ancienne. Il est donc possible que - mysql_affected_rows ne représente pas forcément - le nombre de lignes correspondantes mais plutôt le nombre de lignes - qui ont été réellement affectées par la requête. - - - La requête REPLACE commence par effacer les enregistrements possédant la même - clé primaire et ensuite, insère les nouveaux enregistrements. Cette fonction retourne le - nombre d'enregistrements effacés ainsi que le nombre d'enregistrements insérés. - - - Dans le cas d'une requête "INSERT ... ON DUPLICATE KEY UPDATE", la valeur - retournée sera 1 si une insertion a été effectuée, - ou 2 si une mise à jour d'une ligne existante a été réalisée. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_affected_rows</function> - - -]]> - - &example.outputs.similar; - - - - - - Exemple avec <function>mysql_affected_rows</function> en utilisant - les transactions - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - Transactions - - Lors de l'utilisation des transactions, il faut appeler - mysql_affected_rows après la requête INSERT, - UPDATE ou DELETE et non après le COMMIT. - - - - Requêtes SELECT - - Pour obtenir le nombre de lignes retournées par un SELECT, il est possible - d'utiliser mysql_num_rows. - - - - Clés étrangères en cascade - - mysql_affected_rows ne compte pas les enregistrements affectés - implicitement par un ON DELETE CASCADE et/ou un ON UPDATE CASCADE, concernant les - clés étrangères. - - - - - - &reftitle.seealso; - - mysql_num_rows - mysql_info - - - - diff --git a/reference/mysql/functions/mysql-client-encoding.xml b/reference/mysql/functions/mysql-client-encoding.xml deleted file mode 100644 index fa8babcf41..0000000000 --- a/reference/mysql/functions/mysql-client-encoding.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - mysql_client_encoding - - Retourne le nom du jeu de caractères utilisé par le client MySQL - - - - - - &mysql.alternative.note; - - mysqli_character_set_name - - - - - - &reftitle.description; - - stringmysql_client_encoding - resourcelink_identifierNULL - - - Retourne la variable character_set de MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne le nom du jeu de caractères par défaut pour la connexion courante. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_client_encoding</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - mysql_set_charset - mysql_real_escape_string - - - - diff --git a/reference/mysql/functions/mysql-close.xml b/reference/mysql/functions/mysql-close.xml deleted file mode 100644 index beece73d6b..0000000000 --- a/reference/mysql/functions/mysql-close.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - mysql_close - Ferme la connexion MySQL - - - - - &mysql.alternative.note; - - mysqli_close - PDO : Assigne la valeur &null; à l'objet PDO - - - - - - &reftitle.description; - - boolmysql_close - resourcelink_identifierNULL - - - mysql_close ferme la connexion non persistante au - serveur MySQL associée à l'identifiant spécifié. Si - link_identifier n'est pas spécifié, cette commande - s'applique à la dernière connexion ouverte. - - &mysql.close.connections.result.sets; - - - - &reftitle.parameters; - - &mysql.linkid-noreopen.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>mysql_close</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - mysql_close ne fermera pas les connexions - persistantes créées par mysql_pconnect. - Pour plus de détails, voir la page du manuel sur les - connexions persistantes. - - - - - - &reftitle.seealso; - - mysql_connect - mysql_free_result - - - - diff --git a/reference/mysql/functions/mysql-connect.xml b/reference/mysql/functions/mysql-connect.xml deleted file mode 100644 index 2ac1ff257c..0000000000 --- a/reference/mysql/functions/mysql-connect.xml +++ /dev/null @@ -1,244 +0,0 @@ - - - - - - - mysql_connect - Ouvre une connexion à un serveur MySQL - - - - - &mysql.alternative.note; - - mysqli_connect - PDO::__construct - - - - - - &reftitle.description; - - resourcefalsemysql_connect - stringserverini_get("mysql.default_host") - stringusernameini_get("mysql.default_user") - stringpasswordini_get("mysql.default_password") - boolnew_link&false; - intclient_flags0 - - - Ouvre ou réutilise une connexion à un serveur MySQL. - - - - - &reftitle.parameters; - - - server - - - Le serveur MySQL. Il peut aussi inclure le numéro de port. C'est-à-dire - "hostname:port" ou le chemin vers le socket local, c'est-à-dire - ":/path/to/socket" pour localhost. - - - Si la directive PHP - mysql.default_host n'est pas définie (défaut), alors la valeur - par défaut est "localhost:3306". En &sqlsafemode;, ce paramètre est ignoré - et la valeur "localhost:3306" est toujours utilisée. - - - - - username - - - Le nom d'utilisateur. La valeur par défaut est définie par l'option mysql.default_user. En - &sqlsafemode;, ce paramètre est ignoré et le nom de l'utilisateur propriétaire - du processus serveur est utilisé. - - - - - password - - - Le mot de passe. La valeur par défaut est définie par l'option mysql.default_password. En - &sqlsafemode;, ce paramètre est ignoré et un mot de passe vide est utilisé. - - - - - new_link - - - Si un deuxième appel est fait à mysql_connect - avec les mêmes arguments, aucune nouvelle connexion ne sera établie, - mais plutôt, l'identifiant de la connexion déjà ouverte - sera retourné. Le paramètre new_link modifie ce - comportement et permet à mysql_connect de toujours - ouvrir une nouvelle connexion, même si - mysql_connect a été appelée avant avec les mêmes - paramètres. - En &sqlsafemode;, ce paramètre est ignoré. - - - - - client_flags - - - Le paramètre client_flags peut être une - combinaison des constantes suivantes : - 128 (active le gestionnaire LOAD DATA LOCAL), - MYSQL_CLIENT_SSL, - MYSQL_CLIENT_COMPRESS, - MYSQL_CLIENT_IGNORE_SPACE ou - MYSQL_CLIENT_INTERACTIVE. - Consulter la section à propos de - pour plus d'informations. - En &sqlsafemode;, ce paramètre est ignoré. - - - - - - - - &reftitle.returnvalues; - - Retourne l'identifiant de connexion MySQL en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_connect</function> - - -]]> - - - - Exemple avec <function>mysql_connect</function> en utilisant la syntaxe <literal>hostname:port</literal> - - -]]> - - - - Exemple avec <function>mysql_connect</function> en utilisant la syntaxe ":/path/to/socket" - - -]]> - - - - - - &reftitle.notes; - - - Toutes les fois qu'on spécifie "localhost" ou - "localhost:port" en tant que serveur, la bibliothèque client - MySQL surchargera cela et essaiera de se connecter à un socket local - (nommé pipe sous Windows). Pour utiliser TCP/IP, utiliser - "127.0.0.1" au lieu de "localhost". Si la bibliothèque - client MySQL essaie de se connecter au mauvais socket local, - le chemin correct doit être défini comme mysql.default_host - dans &php.ini; et le champ serveur laissé vide. - - - - - La connexion au serveur sera fermée aussitôt que l'exécution du script - se termine, à moins qu'elle soit fermée avant en appelant explicitement - mysql_close. - - - - - L'erreur "Can't create TCP/IP socket (10106)" signifie habituellement que - la directive de configuration variables_order ne contient pas le - caractère E. Sous Windows, si la variable d'environnement - n'est pas copiée, la variable d'environnement SYSTEMROOT - ne sera pas disponible et PHP aura des problèmes pour charger Winsock. - - - - - - &reftitle.seealso; - - mysql_pconnect - mysql_close - - - - diff --git a/reference/mysql/functions/mysql-create-db.xml b/reference/mysql/functions/mysql-create-db.xml deleted file mode 100644 index 2d714b1397..0000000000 --- a/reference/mysql/functions/mysql-create-db.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - mysql_create_db - Crée une base de données MySQL - - - - - &mysql.alternative.note.4-3-0; - - mysqli_query - PDO::query - - - - - - &reftitle.description; - - boolmysql_create_db - stringdatabase_name - resourcelink_identifierNULL - - - mysql_create_db tente de créer une nouvelle - base de données sur le serveur associé avec l'identifiant de connexion - spécifié. - - - - - &reftitle.parameters; - - - database_name - - - Le nom de la base de données à être créée. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple alternatif avec <function>mysql_create_db</function> - - La fonction mysql_create_db est obsolète. Il - est préférable d'utiliser la fonction mysql_query, - avec une commande SQL "CREATE DATABASE". - - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_createdb - - - - - Cette fonction n'est pas disponible si l'extension MySQL a été compilée - avec une bibliothèque client MySQL 4.x. - - - - - - &reftitle.seealso; - - mysql_query - mysql_select_db - - - - diff --git a/reference/mysql/functions/mysql-data-seek.xml b/reference/mysql/functions/mysql-data-seek.xml deleted file mode 100644 index b69388f99c..0000000000 --- a/reference/mysql/functions/mysql-data-seek.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - mysql_data_seek - Déplace le pointeur interne de résultat MySQL - - - - - &mysql.alternative.note; - - mysqli_data_seek - PDO::FETCH_ORI_ABS - - - - - - &reftitle.description; - - boolmysql_data_seek - resourceresult - introw_number - - - mysql_data_seek déplace le pointeur - interne de résultat, dans le résultat associé à - l'identifiant de résultat result_identifier. - Il le fait pointer à la ligne row_number. - Le prochain appel à une fonction MySQL de récupération de données, - comme la fonction mysql_fetch_assoc - retournera cette ligne. - - - row_number commence à 0. - row_number doit être une valeur qui - va de 0 à mysql_num_rows - 1. - Cependant, si le résultat est vide, un row_number - de 0 échouera avec une erreur E_WARNING et - mysql_data_seek retournera &false;. - - - - - &reftitle.parameters; - - &mysql.result.description; - - row_number - - - La position de la ligne désirée pour le nouveau pointeur de résultats. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>mysql_data_seek</function> - -= 0; $i--) { - if (!mysql_data_seek($result, $i)) { - echo "Ne peut pointer vers la ligne $i : " . mysql_error() . "\n"; - continue; - } - - if (!($row = mysql_fetch_assoc($result))) { - continue; - } - - echo $row['nom_famille'] . ' ' . $row['prenom'] . "
    \n"; -} - -mysql_free_result($result); -?> -]]> -     -     -     - - - &reftitle.notes; - - - La fonction mysql_data_seek peut être utilisée - en conjonction avec mysql_query, mais pas - avec la fonction mysql_unbuffered_query. - - - - - - &reftitle.seealso; - - mysql_query - mysql_num_rows - mysql_fetch_row - mysql_fetch_assoc - mysql_fetch_array - mysql_fetch_object - - -     - diff --git a/reference/mysql/functions/mysql-db-name.xml b/reference/mysql/functions/mysql-db-name.xml deleted file mode 100644 index 3393cb02f2..0000000000 --- a/reference/mysql/functions/mysql-db-name.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - mysql_db_name - Récupère le nom de base de données à l'appel de mysql_list_dbs - - - - - &mysql.alternative.note; - - Requête : SELECT DATABASE() - - - - - - &reftitle.description; - - stringmysql_db_name - resourceresult - introw - mixedfieldNULL - - - Récupère le nom de base de données à l'appel de - mysql_list_dbs. - - - - - &reftitle.parameters; - - - result - - - Le pointeur de résultat d'un appel de mysql_list_dbs. - - - - - row - - - L'index à l'intérieur du jeu de résultats. - - - - - field - - - Le nom du champ. - - - - - - - - &reftitle.returnvalues; - - Retourne le nom de base de données en cas de succès et &false; en cas - d'échec. Si &false; est retourné, utiliser mysql_error - pour déterminer la nature de l'erreur. - - - - - &reftitle.examples; - - Exemple <function>mysql_db_name</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_dbname - - - - - - &reftitle.seealso; - - mysql_list_dbs - mysql_tablename - - - - diff --git a/reference/mysql/functions/mysql-db-query.xml b/reference/mysql/functions/mysql-db-query.xml deleted file mode 100644 index 4b875a19ff..0000000000 --- a/reference/mysql/functions/mysql-db-query.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - mysql_db_query - Sélectionne une base de données et y exécute une requête - - - - - &mysql.alternative.note.5-3-0; - - mysqli_select_db puis la requête - PDO::__construct - - - - - - &reftitle.description; - - resourceboolmysql_db_query - stringdatabase - stringquery - resourcelink_identifierNULL - - - mysql_db_query sélectionne une base de données et - exécute une requête sur celle-ci. - - - - - &reftitle.parameters; - - - database - - - Le nom de la base de données qui sera sélectionnée. - - - - - query - - - La requête MySQL. - - - Les données contenues dans la requête doivent être proprement échappées. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne une ressource de résultat positive MySQL à partir de la requête ou - &false; en cas d'erreur. Cette fonction retourne aussi &true;/&false; pour - les requêtes - INSERT/UPDATE/DELETE - pour indiquer une réussite ou un échec. - - - - - &reftitle.examples; - - Exemple alternatif avec <function>mysql_db_query</function> - - -]]> - - - - - - &reftitle.notes; - - - Soyez avertis que cette fonction ne restaure pas - la base de données qui était utilisée initialement. En d'autres termes, - on ne peut utiliser cette fonction pour exécuter - temporairement une requête SQL dans une autre - base de données, il faudra sélectionner manuellement la bonne - base à nouveau. Il est fortement recommandé d'utiliser la syntaxe SQL - database.table ou mysql_select_db - au lieu de cette fonction. - - - - - - &reftitle.seealso; - - mysql_query - mysql_select_db - - - - diff --git a/reference/mysql/functions/mysql-drop-db.xml b/reference/mysql/functions/mysql-drop-db.xml deleted file mode 100644 index 942b3ec706..0000000000 --- a/reference/mysql/functions/mysql-drop-db.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - mysql_drop_db - Efface une base de données MySQL - - - - - &mysql.alternative.note.4-3-0; - - Exécute une requête DROP DATABASE - - - - - - &reftitle.description; - - boolmysql_drop_db - stringdatabase_name - resourcelink_identifierNULL - - - mysql_drop_db essaie d'effacer la base - de données database_name complète - sur le serveur associé à la ressource de connexion - link_identifier. - La fonction mysql_drop_db est obsolète. Il est - préférable d'utiliser mysql_query avec la requête - DROP DATABASE à la place. - - - - - &reftitle.parameters; - - - database_name - - - Le nom de la base de données à effacer. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>mysql_drop_db</function> - - -]]> - - - - - - &reftitle.notes; - - - Cette fonction ne sera pas disponible si on a compilé MySQL - avec la bibliothèque cliente MySQL 4.x. - - - - - &info.deprecated.alias; - mysql_dropdb - - - - - - &reftitle.seealso; - - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-errno.xml b/reference/mysql/functions/mysql-errno.xml deleted file mode 100644 index c7ac0f231c..0000000000 --- a/reference/mysql/functions/mysql-errno.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - mysql_errno - Retourne le numéro d'erreur de la dernière commande MySQL - - - - - &mysql.alternative.note; - - mysqli_errno - PDO::errorCode - - - - - - &reftitle.description; - - intmysql_errno - resourcelink_identifierNULL - - - Retourne le numéro d'erreur de la dernière commande MySQL. - - - Les erreurs qui - sont remontées depuis le serveur MySQL ne sont plus des alertes. - À la place, il faut utiliser mysql_errno pour - obtenir le numéro d'erreur. À noter que cette fonction retourne uniquement - le code erreur depuis la dernière fonction MySQL exécutée - (n'incluant pas les fonctions mysql_error et - mysql_errno), donc, pour l'utiliser, - il faut s'assurer de récupérer la valeur avant d'appeler une autre fonction - MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne le numéro de l'erreur depuis la dernière fonction MySQL, ou - &zero; (zéro) si aucune erreur ne survient. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_errno</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_error - les codes erreurs MySQL - - - - diff --git a/reference/mysql/functions/mysql-error.xml b/reference/mysql/functions/mysql-error.xml deleted file mode 100644 index 1936054d79..0000000000 --- a/reference/mysql/functions/mysql-error.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - mysql_error - Retourne le texte associé avec l'erreur générée - lors de la dernière requête - - - - - &mysql.alternative.note; - - mysqli_error - PDO::errorInfo - - - - - - &reftitle.description; - - stringmysql_error - resourcelink_identifierNULL - - - mysql_error retourne le message d'erreur - généré par la dernière commande MySQL. - Les erreurs retournées par le serveur MySQL ne génèrent plus - de message d'alerte. À la place, il faut utiliser la fonction - mysql_error pour lire le contenu du message. - À noter que cette fonction ne retourne que le texte de l'erreur la - plus récente (n'incluant pas mysql_error et - mysql_errno), ce qui fait que si on souhaite - l'utiliser, il faut s'assurer de sa valeur avant de lancer une autre - requête. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne le texte de l'erreur de la dernière fonction MySQL, ou - '' (chaîne vide) si aucune erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_error</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_errno - les codes erreurs MySQL - - - - diff --git a/reference/mysql/functions/mysql-escape-string.xml b/reference/mysql/functions/mysql-escape-string.xml deleted file mode 100644 index 1d697ebd7a..0000000000 --- a/reference/mysql/functions/mysql-escape-string.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - mysql_escape_string - Protège les caractères spéciaux SQL - - - - - &mysql.alternative.note.4-3-0; - - mysqli_escape_string - PDO::quote - - - - - - &reftitle.description; - - stringmysql_escape_string - stringunescaped_string - - - mysql_escape_string va protéger tous les caractères de - la chaîne unescaped_string, pour pouvoir l'utiliser - directement dans une requête mysql_query. - Cette fonction est obsolète. - - - mysql_escape_string est identique à la fonction - mysql_real_escape_string hormis le fait que - mysql_real_escape_string requiert une ressource - de connexion et protège la chaîne en fonction du jeu de caractères - courant. mysql_escape_string ne demande pas de - connexion comme argument, et ne respecte pas le jeu de caractères - courant. - - - - - &reftitle.parameters; - - - unescaped_string - - - La chaîne qui doit être protégée. - - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne protégée. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_escape_string</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - mysql_escape_string ne protège pas les caractères - % et _. - - - - - - &reftitle.seealso; - - mysql_real_escape_string - - - - diff --git a/reference/mysql/functions/mysql-fetch-array.xml b/reference/mysql/functions/mysql-fetch-array.xml deleted file mode 100644 index 09b71f7f6b..0000000000 --- a/reference/mysql/functions/mysql-fetch-array.xml +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - - mysql_fetch_array - - Retourne une ligne de résultat MySQL sous la forme d'un tableau - associatif, d'un tableau indexé, ou les deux - - - - - - &mysql.alternative.note; - - mysqli_fetch_array - PDOStatement::fetch - - - - - - &reftitle.description; - - arraymysql_fetch_array - resourceresult - intresult_typeMYSQL_BOTH - - - mysql_fetch_array retourne un tableau qui - contient la ligne demandée dans le résultat result - et déplace le pointeur de données interne d'un cran. - - - - - &reftitle.parameters; - - &mysql.result.description; - - result_type - - - Le type de tableau à récupérer. C'est une constante qui peut prendre - les valeurs suivantes : MYSQL_ASSOC, - MYSQL_NUM, et - MYSQL_BOTH. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau de chaînes qui correspond à la ligne récupérée ou &false; - s'il n'y a plus de lignes. Le type de tableau retourné dépend de la - définition du paramètre result_type. - En utilisant MYSQL_BOTH (défaut), l'on - récupérera un tableau contenant des indices associatifs et numériques. - En utilisant MYSQL_ASSOC, on ne récupérera que - les indices associatifs (comme le fonctionnement de la fonction - mysql_fetch_assoc), en utilisant MYSQL_NUM, - on ne récupérera que les indices numériques (comme le fonctionnement - de la fonction mysql_fetch_row). - - - Si plusieurs colonnes portent le même nom, la dernière colonne - aura la priorité. Pour accéder aux autres colonnes du - même nom, il faut utiliser l'index numérique, ou - faire un alias pour chaque colonne. Pour les alias de colonnes, - il ne sera pas possible d'accéder aux contenus avec les noms originaux - des colonnes. - - - - - &reftitle.examples; - - Requête avec duplication de nom de colonnes - - - - - - <function>mysql_fetch_array</function> avec <constant>MYSQL_NUM</constant> - - -]]> - - - - <function>mysql_fetch_array</function> avec <constant>MYSQL_ASSOC</constant> - - -]]> - - - - <function>mysql_fetch_array</function> avec <constant>MYSQL_BOTH</constant> - - -]]> - - - - - - &reftitle.notes; - - Performance - - Une chose importante à noter est que l'utilisation de - mysql_fetch_array n'est pas - significativement plus lente que l'utilisation de - mysql_fetch_row, alors qu'elle fournit - une valeur ajoutée significative. - - - &database.field-case; - &database.fetch-null; - - - - &reftitle.seealso; - - mysql_fetch_row - mysql_fetch_assoc - mysql_data_seek - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-fetch-assoc.xml b/reference/mysql/functions/mysql-fetch-assoc.xml deleted file mode 100644 index 0ef2f91b55..0000000000 --- a/reference/mysql/functions/mysql-fetch-assoc.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - mysql_fetch_assoc - Lit une ligne de résultat MySQL dans un tableau associatif - - - - - &mysql.alternative.note; - - mysqli_fetch_assoc - - PDOStatement::fetch - avec mode en tant que PDO::FETCH_ASSOC - - - - - - - &reftitle.description; - - arraymysql_fetch_assoc - resourceresult - - - mysql_fetch_assoc retourne un tableau associatif - qui contient la ligne lue dans le résultat result et - déplace le pointeur interne de données. - mysql_fetch_assoc revient à appeler la fonction - mysql_fetch_array avec MYSQL_ASSOC - en tant que second paramètre. Cette fonction retourne uniquement - un tableau associatif. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif de chaînes - qui contient la ligne lue dans le résultat result, - ou bien &false; s'il ne reste plus de lignes à lire. - - - Si plusieurs colonnes portent le même nom, la dernière aura la priorité. - Pour accéder aux autres colonnes du même nom, il faut utiliser - la fonction mysql_fetch_row avec les indices numériques - ou utiliser les alias sur les noms. - Regardez la documentation sur la fonction mysql_fetch_array - pour plus d'informations sur les alias. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_fetch_assoc</function> - - -]]> - - - - - - &reftitle.notes; - - Performance - - Une chose importante à noter est que l'utilisation de - mysql_fetch_assoc n'est pas - significativement plus lente que l'utilisation de - mysql_fetch_row, alors qu'il fournit - des valeurs significatives ajoutées. - - - &database.field-case; - &database.fetch-null; - - - - &reftitle.seealso; - - mysql_fetch_row - mysql_fetch_array - mysql_data_seek - mysql_query - mysql_error - - - - diff --git a/reference/mysql/functions/mysql-fetch-field.xml b/reference/mysql/functions/mysql-fetch-field.xml deleted file mode 100644 index c6888c5760..0000000000 --- a/reference/mysql/functions/mysql-fetch-field.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - - mysql_fetch_field - - Retourne les données enregistrées dans une colonne MySQL - sous forme d'objet - - - - - - &mysql.alternative.note; - - mysqli_fetch_field - PDOStatement::getColumnMeta - - - - - - &reftitle.description; - - objectmysql_fetch_field - resourceresult - intfield_offset0 - - - Retourne un objet contenant les informations sur les champs. - Cette fonction peut être utilisée pour obtenir des informations sur les - champs de la requête fournie result. - - - - - &reftitle.parameters; - - &mysql.result.description; - - field_offset - - - La position numérique du champ. Si la position du champ n'est pas spécifiée, - le champ suivant qui n'a pas encore été récupéré par cette fonction est alors - récupéré. field_offset commence à 0. - - - - - - - - &reftitle.returnvalues; - - Retourne un &object; contenant les informations sur les champs. - Les propriétés de l'objet sont les suivantes : - - - - - "name" : nom de la colonne - - - - - "table" : nom de la table pour la colonne, qui pourra - être l'alias si un alias a été défini. - - - - - "max_length" : taille maximale de la colonne - - - - - "not_null" : 1 si la colonne ne peut pas être &null; - - - - - "primary_key" : 1 si la colonne est une clé primaire - - - - - "unique_key" : 1 si la colonne est une clé unique - - - - - "multiple_key" : 1 si la colonne est une clé non unique - - - - - "numeric" : 1 si la colonne est numérique - - - - - "blob" : 1 si la colonne est BLOB - - - - - "type" : le type de la colonne - - - - - "unsigned" : 1 si la colonne est non signée - - - - - "zerofill" : 1 si la colonne est complétée par des zéros - - - - - - - &reftitle.examples; - - Exemple avec <function>mysql_fetch_field</function> - -\n"; - $meta = mysql_fetch_field($result, $i); - if (!$meta) { - echo "Aucun détail disponible
    \n"; - } - echo "
    -    blob:         $meta->blob
-    max_length:   $meta->max_length
-    multiple_key: $meta->multiple_key
-    name:         $meta->name
-    not_null:     $meta->not_null
-    numeric:      $meta->numeric
-    primary_key:  $meta->primary_key
-    table:        $meta->table
-    type:         $meta->type
-    unique_key:   $meta->unique_key
-    unsigned:     $meta->unsigned
-    zerofill:     $meta->zerofill
-
    "; - $i++; -} -mysql_free_result($result); -?> -]]> -     -     -     - - - &reftitle.notes; - &database.field-case; - - - Si les champs ou les noms de table utilisent un alias dans - la requête SQL, le nom utilisé dans l'alias sera retourné. - Le nom original peut être récupéré en utilisant la méthode - mysqli_result::fetch_field. - - - - - - &reftitle.seealso; - - mysql_field_seek - - -     - diff --git a/reference/mysql/functions/mysql-fetch-lengths.xml b/reference/mysql/functions/mysql-fetch-lengths.xml deleted file mode 100644 index 82131d92a9..0000000000 --- a/reference/mysql/functions/mysql-fetch-lengths.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - mysql_fetch_lengths - - Retourne la taille de chaque colonne d'une ligne de résultat MySQL - - - - - - &mysql.alternative.note; - - mysqli_fetch_lengths - PDOStatement::getColumnMeta - - - - - - &reftitle.description; - - arrayfalsemysql_fetch_lengths - resourceresult - - - mysql_fetch_lengths retourne un tableau avec - la taille de chaque colonne de la dernière ligne retournée - par mysql_fetch_row. - - - mysql_fetch_lengths stocke les tailles de chaque colonne - de la dernière ligne retournée par - mysql_fetch_row, - mysql_fetch_assoc, - mysql_fetch_array et - mysql_fetch_object dans un tableau, en commençant à la - position 0. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - Un array de taille, en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_fetch_lengths</function> - - -]]> - - &example.outputs.similar; - - 42 - [email] => user@example.com -) -Array -( - [0] => 2 - [1] => 16 -) -]]> - - - - - - &reftitle.seealso; - - mysql_field_len - mysql_fetch_row - strlen - - - - diff --git a/reference/mysql/functions/mysql-fetch-object.xml b/reference/mysql/functions/mysql-fetch-object.xml deleted file mode 100644 index 5c19e85601..0000000000 --- a/reference/mysql/functions/mysql-fetch-object.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - mysql_fetch_object - Retourne une ligne de résultat MySQL sous la forme d'un objet - - - - - &mysql.alternative.note; - - mysqli_fetch_object - - PDOStatement::fetch - avec mode en tant que PDO::FETCH_OBJ - - - - - - - &reftitle.description; - - objectmysql_fetch_object - resourceresult - stringclass_name - arrayparams - - - mysql_fetch_object retourne un objet dont les - propriétés correspondent à la ligne demandée dans le résultat result - et déplace le pointeur de données interne d'un cran. - - - - - &reftitle.parameters; - - &mysql.result.description; - - class_name - - - Le nom de la classe à instancier, dont les propriétés sont définies, et qui sera retourné. - Si ce paramètre n'est pas spécifié, un objet stdClass - sera retourné. - - - - - params - - - Un &array; de paramètres à passer au constructeur pour les objets - class_name. - - - - - - - - &reftitle.returnvalues; - - Retourne un &object; avec les propriétés qui correspondent à la ligne - récupérée, ou &false; s'il n'y a plus de lignes. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_fetch_object</function> - -user_id; - echo $row->fullname; -} -mysql_free_result($result); -?> -]]> - - - - Exemple avec <function>mysql_fetch_object</function> - - -]]> - - - - - - &reftitle.notes; - - Performance - - Concernant la vitesse, mysql_fetch_object est - aussi rapide que mysql_fetch_array et presque - aussi rapide que mysql_fetch_row (la - différence est insignifiante). - - - - - mysql_fetch_object est identique à - mysql_fetch_array, à la - différence qu'elle retourne un objet à la place - d'un tableau. On pourra ainsi accéder aux valeurs - des champs par leur nom, mais plus par leur offset (les - nombres ne sont pas des noms MySQL). - - - &database.field-case; - &database.fetch-null; - - - - &reftitle.seealso; - - mysql_fetch_array - mysql_fetch_assoc - mysql_fetch_row - mysql_data_seek - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-fetch-row.xml b/reference/mysql/functions/mysql-fetch-row.xml deleted file mode 100644 index e5e8e5c70f..0000000000 --- a/reference/mysql/functions/mysql-fetch-row.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - mysql_fetch_row - Retourne une ligne de résultat MySQL sous la forme d'un tableau - - - - - &mysql.alternative.note; - - mysqli_fetch_row - - PDOStatement::fetch - avec mode en tant que PDO::FETCH_NUM - - - - - - - &reftitle.description; - - arraymysql_fetch_row - resourceresult - - - mysql_fetch_row retourne un tableau - indexé numériquement, qui correspond à la prochaine ligne - du résultat MySQL result et - déplace le pointeur interne de données d'un cran. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - Retourne un tableau numérique de chaînes qui correspond à la ligne récupérée, ou - &false; s'il n'y a plus de lignes. - - - mysql_fetch_row va rechercher une ligne dans le - résultat associé à l'identifiant de résultat - spécifié. La ligne est retournée sous la forme d'un - tableau. Chaque colonne est stockée à une position du tableau, - commençant à la position &zero;. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_fetch_row</function> - - -]]> - - - - - - &reftitle.notes; - &database.fetch-null; - - - - &reftitle.seealso; - - mysql_fetch_array - mysql_fetch_assoc - mysql_fetch_object - mysql_data_seek - mysql_fetch_lengths - mysql_result - - - - diff --git a/reference/mysql/functions/mysql-field-flags.xml b/reference/mysql/functions/mysql-field-flags.xml deleted file mode 100644 index 0f31bd20dc..0000000000 --- a/reference/mysql/functions/mysql-field-flags.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - mysql_field_flags - Retourne des détails sur une colonne MySQL - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [flags] - PDOStatement::getColumnMeta [flags] - - - - - - &reftitle.description; - - stringfalsemysql_field_flags - resourceresult - intfield_offset - - - mysql_field_flags retourne les drapeaux - associés au champ spécifié par field_offset, - dans le résultat result. Les drapeaux sont retournés - comme des mots, séparés par des espaces, ce qui les - rend faciles à séparer, avec la commande explode. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - Retourne les drapeaux sous la forme d'une chaîne associés avec le résultat&return.falseforfailure;. - - - Les valeurs suivantes (pour une version suffisamment récente de MySQL) sont - disponibles : "not_null", "primary_key", - "unique_key", "multiple_key", - "blob", "unsigned", "zerofill", - "binary", "enum", - "auto_increment" et "timestamp". - - - - - &reftitle.examples; - - Exemple avec <function>mysql_field_flags</function> - - -]]> - - &example.outputs.similar; - - not_null - [1] => primary_key - [2] => auto_increment -) -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_fieldflags - - - - - - &reftitle.seealso; - - mysql_field_type - mysql_field_len - - - - - diff --git a/reference/mysql/functions/mysql-field-len.xml b/reference/mysql/functions/mysql-field-len.xml deleted file mode 100644 index 007ad554fd..0000000000 --- a/reference/mysql/functions/mysql-field-len.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - mysql_field_len - Retourne la taille d'un champ de résultat MySQL - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [length] - PDOStatement::getColumnMeta [len] - - - - - - &reftitle.description; - - intfalsemysql_field_len - resourceresult - intfield_offset - - - mysql_field_len retourne la taille du champ spécifié. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - La taille de l'index du champ spécifié en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_field_len</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_fieldlen - - - - - - &reftitle.seealso; - - mysql_fetch_lengths - strlen - - - - diff --git a/reference/mysql/functions/mysql-field-name.xml b/reference/mysql/functions/mysql-field-name.xml deleted file mode 100644 index b41d893b37..0000000000 --- a/reference/mysql/functions/mysql-field-name.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - mysql_field_name - Retourne le nom d'une colonne dans un résultat MySQL - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [name] ou [orgname] - PDOStatement::getColumnMeta [name] - - - - - - &reftitle.description; - - stringfalsemysql_field_name - resourceresult - intfield_offset - - - mysql_field_name retourne le nom du champ - de l'index spécifié. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - Le nom du champ de l'index spécifié en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_field_name</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - &database.field-case; - - - &info.deprecated.alias; - mysql_fieldname - - - - - - &reftitle.seealso; - - mysql_field_type - mysql_field_len - - - - - diff --git a/reference/mysql/functions/mysql-field-seek.xml b/reference/mysql/functions/mysql-field-seek.xml deleted file mode 100644 index 9944e7c138..0000000000 --- a/reference/mysql/functions/mysql-field-seek.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - mysql_field_seek - Déplace le pointeur de résultat vers une position donnée - - - - - &mysql.alternative.note; - - mysqli_field_seek - - PDOStatement::fetch utilisant le paramètre - cursor_orientation et le paramètre - offset - - - - - - - &reftitle.description; - - boolmysql_field_seek - resourceresult - intfield_offset - - - mysql_field_seek place le pointeur de résultat - result sur le champ spécifié par sa - position field_offset. - Lors du prochain appel à mysql_fetch_field - qui n'aura pas d'argument d'index de champ, le champ désormais - pointé sera retourné. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - mysql_fetch_field - - - - - diff --git a/reference/mysql/functions/mysql-field-table.xml b/reference/mysql/functions/mysql-field-table.xml deleted file mode 100644 index 1f445c30a5..0000000000 --- a/reference/mysql/functions/mysql-field-table.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - mysql_field_table - Retourne le nom de la table MySQL où se trouve une colonne - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [table] ou [orgtable] - PDOStatement::getColumnMeta [table] - - - - - - &reftitle.description; - - stringmysql_field_table - resourceresult - intfield_offset - - - mysql_field_table retourne le nom de la table - où se trouve la colonne d'offset field_offset, - dans le résultat MySQL result. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - Le nom de la table en cas de succès. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_field_table</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_fieldtable - - - - - - &reftitle.seealso; - - mysql_list_tables - - - - diff --git a/reference/mysql/functions/mysql-field-type.xml b/reference/mysql/functions/mysql-field-type.xml deleted file mode 100644 index f4958365f3..0000000000 --- a/reference/mysql/functions/mysql-field-type.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - mysql_field_type - Retourne le type d'une colonne MySQL spécifique - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [type] - PDOStatement::getColumnMeta [driver:decl_type] ou [pdo_type] - - - - - - &reftitle.description; - - stringmysql_field_type - resourceresult - intfield_offset - - - mysql_field_type est similaire à la fonction - mysql_field_name. Les arguments sont identiques - mais c'est le type de la colonne qui est retourné. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - Le type du champ retourné peut être : - "int", "real", "string", - "blob" ou d'autres, comme détaillé - dans la documentation MySQL. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_field_type</function> - - - ]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_fieldtype - - - - - - &reftitle.seealso; - - mysql_field_name - mysql_field_len - - - - - diff --git a/reference/mysql/functions/mysql-free-result.xml b/reference/mysql/functions/mysql-free-result.xml deleted file mode 100644 index 81eab0122c..0000000000 --- a/reference/mysql/functions/mysql-free-result.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - mysql_free_result - Libère le résultat de la mémoire - - - - - &mysql.alternative.note; - - mysqli_free_result - Assignez la valeur &null; à l'objet PDO, ou PDOStatement::closeCursor - - - - - - &reftitle.description; - - boolmysql_free_result - resourceresult - - - mysql_free_result libère toute la mémoire et - les ressources utilisées par la ressource de résultat result. - - - mysql_free_result n'est à appeler que si - on a peur d'utiliser trop de mémoire durant l'exécution - du script. Toute la mémoire associée à - l'identifiant de résultat sera automatiquement libérée. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - Si la valeur passée à l'argument result n'est - pas une ressource, une erreur de niveau E_WARNING - sera émise. Il est important de noter que la fonction - mysql_query retourne uniquement une - &resource; pour les requêtes SELECT, - SHOW, EXPLAIN et DESCRIBE. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_free_result</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_freeresult - - - - - - &reftitle.seealso; - - mysql_query - is_resource - - - - diff --git a/reference/mysql/functions/mysql-get-client-info.xml b/reference/mysql/functions/mysql-get-client-info.xml deleted file mode 100644 index d908c74af0..0000000000 --- a/reference/mysql/functions/mysql-get-client-info.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - mysql_get_client_info - Lit les informations sur le client MySQL - - - - - &mysql.alternative.note; - - mysqli_get_client_info - - PDO::getAttribute - avec attribute en tant que PDO::ATTR_CLIENT_VERSION - - - - - - - &reftitle.description; - - stringmysql_get_client_info - - - - mysql_get_client_info retourne une chaîne - qui représente le numéro de version du client utilisé par PHP. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La version du client MySQL. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_get_client_info</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_host_info - mysql_get_proto_info - mysql_get_server_info - - - - diff --git a/reference/mysql/functions/mysql-get-host-info.xml b/reference/mysql/functions/mysql-get-host-info.xml deleted file mode 100644 index 33b5679e2c..0000000000 --- a/reference/mysql/functions/mysql-get-host-info.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - mysql_get_host_info - Lit les informations sur l'hôte MySQL - - - - - &mysql.alternative.note; - - mysqli_get_host_info - - PDO::getAttribute - avec attribute en tant que PDO::ATTR_CONNECTION_STATUS - - - - - - - &reftitle.description; - - stringfalsemysql_get_host_info - resourcelink_identifierNULL - - - mysql_get_host_info retourne une chaîne - qui représente le type de connexion utilisé avec la connexion - link_identifier, y compris le nom du serveur hôte. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne une chaîne décrivant le type de connexion MySQL utilisé - pour la connexion&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_get_host_info</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_client_info - mysql_get_proto_info - mysql_get_server_info - - - - diff --git a/reference/mysql/functions/mysql-get-proto-info.xml b/reference/mysql/functions/mysql-get-proto-info.xml deleted file mode 100644 index bd30cef0af..0000000000 --- a/reference/mysql/functions/mysql-get-proto-info.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - mysql_get_proto_info - Lit les informations sur le protocole MySQL - - - - - &mysql.alternative.note; - - mysqli_get_proto_info - - - - - - &reftitle.description; - - intfalsemysql_get_proto_info - resourcelink_identifierNULL - - - Lit les informations sur le protocole MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne le protocole MySQL en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_get_proto_info</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_client_info - mysql_get_host_info - mysql_get_server_info - - - - diff --git a/reference/mysql/functions/mysql-get-server-info.xml b/reference/mysql/functions/mysql-get-server-info.xml deleted file mode 100644 index 4eeed14420..0000000000 --- a/reference/mysql/functions/mysql-get-server-info.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - mysql_get_server_info - Lit les informations sur le serveur MySQL - - - - - &mysql.alternative.note; - - mysqli_get_server_info - - PDO::getAttribute - avec attribute en tant que PDO::ATTR_SERVER_VERSION - - - - - - - &reftitle.description; - - stringfalsemysql_get_server_info - resourcelink_identifierNULL - - - Lit les informations sur le serveur MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne la version du serveur MySQL en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_get_server_info</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_client_info - mysql_get_host_info - mysql_get_proto_info - phpversion - - - - diff --git a/reference/mysql/functions/mysql-info.xml b/reference/mysql/functions/mysql-info.xml deleted file mode 100644 index 9b10572f08..0000000000 --- a/reference/mysql/functions/mysql-info.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - mysql_info - Lit des informations à propos de la dernière requête MySQL - - - - - &mysql.alternative.note; - - mysqli_info - - - - - - &reftitle.description; - - stringmysql_info - resourcelink_identifierNULL - - - Lit des informations à propos de la dernière requête MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne des informations sur une requête en cas de succès, ou &false; - si une erreur survient. Regardez l'exemple ci-dessous pour savoir - quelles sortes de requêtes fournissent des informations - et avoir un aperçu des informations retournées. Les sortes de requêtes - qui ne sont pas listées retournent &false;. - - - - - &reftitle.examples; - - Requêtes MySQL - - Requêtes qui retournent des valeurs. Les nombres ne sont là - que pour illustrer l'exemple ; ces valeurs correspondent à la requête. - - - - - - - - - &reftitle.notes; - - - mysql_info retourne une valeur différente de &false; - pour les commandes INSERT ... VALUES uniquement si plusieurs jeux de valeurs - à insérer ont été spécifiés dans la commande. - - - - - - &reftitle.seealso; - - mysql_affected_rows - mysql_insert_id - mysql_stat - - - - diff --git a/reference/mysql/functions/mysql-insert-id.xml b/reference/mysql/functions/mysql-insert-id.xml deleted file mode 100644 index ffdb32cd71..0000000000 --- a/reference/mysql/functions/mysql-insert-id.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - mysql_insert_id - - Retourne l'identifiant généré par la dernière requête - - - - - - &mysql.alternative.note; - - mysqli_insert_id - PDO::lastInsertId - - - - - - &reftitle.description; - - intmysql_insert_id - resourcelink_identifierNULL - - - Retourne le dernier identifiant généré par un champ de type AUTO_INCREMENT, - sur la connexion MySQL courante ou sur la connexion - spécifiée par link_identifier (habituellement, une - requête de type INSERT). - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - L'ID généré pour une colonne AUTO_INCREMENT par la dernière - requête en cas de succès, &zero; si la dernière requête n'a pas - généré de valeur AUTO_INCREMENT, ou &false; si aucune connexion - MySQL n'a été établie. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_insert_id</function> - - -]]> - - - - - - &reftitle.notes; - - - mysql_insert_id convertira le type retourné - de la fonction native MySQL C API mysql_insert_id() - en un type long (nommé int en PHP). - Si la colonne AUTO_INCREMENT a une colonne de type BIGINT (64 bits), - la conversion peut résulter en une valeur incorrecte. À la place, utiliser - la fonction SQL interne à MySQL LAST_INSERT_ID() dans une requête SQL. - Pour plus d'informations sur les valeurs entières maximales en PHP, - se reporter à la documentation sur les - entiers. - - - - - Parce que mysql_insert_id agit sur la dernière requête - exécutée, il faut s'assurer d'appeler la fonction mysql_insert_id - immédiatement après l'exécution de la requête qui a généré la valeur. - - - - - La fonction MySQL LAST_INSERT_ID() contient toujours - la valeur AUTO_INCREMENT la plus récente, et n'est pas remise à zéro entre - deux requêtes. - - - - - - &reftitle.seealso; - - mysql_query - mysql_info - - - - diff --git a/reference/mysql/functions/mysql-list-dbs.xml b/reference/mysql/functions/mysql-list-dbs.xml deleted file mode 100644 index ce3614c412..0000000000 --- a/reference/mysql/functions/mysql-list-dbs.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - mysql_list_dbs - - Liste les bases de données disponibles sur le serveur MySQL - - - - - - &mysql.alternative.note.5-4-0; - - Requête SQL : SHOW DATABASES - - - - - - &reftitle.description; - - resourcemysql_list_dbs - resourcelink_identifierNULL - - - mysql_list_dbs retournera un identifiant de - résultat, qui contiendra les noms des bases de données - disponibles sur la connexion MySQL courante ou sur la connexion - spécifiée par link_identifier. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne une ressource de pointeurs de résultats en cas de succès, ou &false; si une - erreur survient. Utiliser la fonction mysql_tablename - pour parcourir ce résultat ou tout autre fonction pour les résultats de table, comme - la fonction mysql_fetch_array. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_list_dbs</function> - -Database . "\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_listdbs - - - - - - &reftitle.seealso; - - mysql_db_name - mysql_select_db - - - - diff --git a/reference/mysql/functions/mysql-list-fields.xml b/reference/mysql/functions/mysql-list-fields.xml deleted file mode 100644 index eb8a86771d..0000000000 --- a/reference/mysql/functions/mysql-list-fields.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - mysql_list_fields - Liste les champs d'une table MySQL - - - - - &mysql.alternative.note.5-4-0; - - Requête SQL : SHOW COLUMNS FROM sometable - - - - - - &reftitle.description; - - resourcemysql_list_fields - stringdatabase_name - stringtable_name - resourcelink_identifierNULL - - - Liste les champs de la table MySQL spécifiée. - - - La fonction mysql_list_fields est obsolète. - Il est préférable d'utiliser la fonction mysql_query - avec comme requête SHOW COLUMNS FROM table [LIKE 'name'] - à la place. - - - - - &reftitle.parameters; - - - database_name - - - Le nom de la base de données qui va être interrogée. - - - - - table_name - - - Le nom de la table qui va être interrogée. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Une ressource de pointeurs de résultats en cas de succès, ou &false; si une - erreur survient. - - - Le résultat retourné peut être utilisé avec les fonctions - mysql_field_flags, - mysql_field_len, - mysql_field_name&listendand; - mysql_field_type. - - - - - &reftitle.examples; - - Exemple d'alternative à <function>mysql_list_fields</function> - - 0) { - while ($row = mysql_fetch_assoc($result)) { - print_r($row); - } -} -?> -]]> - - &example.outputs.similar; - - id - [Type] => int(7) - [Null] => - [Key] => PRI - [Default] => - [Extra] => auto_increment -) -Array -( - [Field] => email - [Type] => varchar(100) - [Null] => - [Key] => - [Default] => - [Extra] => -) -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_listfields - - - - - - &reftitle.seealso; - - mysql_field_flags - mysql_info - - - - diff --git a/reference/mysql/functions/mysql-list-processes.xml b/reference/mysql/functions/mysql-list-processes.xml deleted file mode 100644 index 0bf27df4c7..0000000000 --- a/reference/mysql/functions/mysql-list-processes.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - mysql_list_processes - Liste les processus MySQL - - - - - &mysql.alternative.note; - - mysqli_thread_id - - - - - - &reftitle.description; - - resourcefalsemysql_list_processes - resourcelink_identifierNULL - - - Récupère les threads actuels du serveur MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Une ressource de pointeurs de résultats en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_list_processes</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_thread_id - mysql_stat - - - - diff --git a/reference/mysql/functions/mysql-list-tables.xml b/reference/mysql/functions/mysql-list-tables.xml deleted file mode 100644 index 7c0714b614..0000000000 --- a/reference/mysql/functions/mysql-list-tables.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - mysql_list_tables - Liste les tables d'une base de données MySQL - - - - - &mysql.alternative.note.4-3-0; - - Requête SQL : SHOW TABLES FROM dbname - - - - - - &reftitle.description; - - resourcefalsemysql_list_tables - stringdatabase - resourcelink_identifierNULL - - - Liste les tables d'une base de données MySQL spécifiée. - - - Cette fonction est obsolète. Il est préférable d'utiliser la fonction - mysql_query pour effectuer la requête SQL SHOW TABLES - [FROM db_name] [LIKE 'pattern'] à la place. - - - - - &reftitle.parameters; - - - database - - - Le nom de la base de données - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Une ressource de pointeurs de résultats en cas de succès&return.falseforfailure;. - - - Utiliser la fonction mysql_tablename - pour parcourir ce pointeur de résultats ou tout autre fonction - pour les résultats de tables, comme la fonction - mysql_fetch_array. - - - - - &reftitle.examples; - - Exemple d'alternative à <function>mysql_list_tables</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_listtables - - - - - - &reftitle.seealso; - - mysql_list_dbs - mysql_tablename - - - - diff --git a/reference/mysql/functions/mysql-num-fields.xml b/reference/mysql/functions/mysql-num-fields.xml deleted file mode 100644 index 34cd68fb22..0000000000 --- a/reference/mysql/functions/mysql-num-fields.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - mysql_num_fields - Retourne le nombre de champs d'un résultat MySQL - - - - - &mysql.alternative.note; - - mysqli_num_fields - PDOStatement::columnCount - - - - - - &reftitle.description; - - intfalsemysql_num_fields - resourceresult - - - Retourne le nombre de champs d'une requête. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - Retourne le nombre de champs d'un jeu de résultat en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_num_fields</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_numfields - - - - - - &reftitle.seealso; - - mysql_select_db - mysql_query - mysql_fetch_field - mysql_num_rows - - - - diff --git a/reference/mysql/functions/mysql-num-rows.xml b/reference/mysql/functions/mysql-num-rows.xml deleted file mode 100644 index 9476bf160c..0000000000 --- a/reference/mysql/functions/mysql-num-rows.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - mysql_num_rows - Retourne le nombre de lignes d'un résultat MySQL - - - - - &mysql.alternative.note; - - mysqli_num_rows - mysqli_stmt_num_rows - PDOStatement::rowCount - - - - - - &reftitle.description; - - intfalsemysql_num_rows - resourceresult - - - Récupère le nombre de lignes d'un jeu de résultat. Cette commande n'est - disponible que pour les requêtes comme SELECT ou SHOW qui retournent - un jeu de résultats. Pour récupérer le nombre de lignes - affectées par une requête INSERT, UPDATE, REPLACE ou DELETE, utiliser la - fonction mysql_affected_rows. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - Le nombre de lignes dans un jeu de résultats en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_num_rows</function> - - -]]> - - - - - - &reftitle.notes; - - - Lors de l'utilisation de mysql_unbuffered_query, - mysql_num_rows ne retournera pas - une valeur correcte tant que toutes les lignes du jeu de résultats - n'auront pas été récupérées. - - - - - &info.deprecated.alias; - mysql_numrows - - - - - - &reftitle.seealso; - - mysql_affected_rows - mysql_connect - mysql_data_seek - mysql_select_db - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-pconnect.xml b/reference/mysql/functions/mysql-pconnect.xml deleted file mode 100644 index 454320f57b..0000000000 --- a/reference/mysql/functions/mysql-pconnect.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - mysql_pconnect - Ouvre une connexion persistante à un serveur MySQL - - - - - &mysql.alternative.note; - - mysqli_connect avec le préfixe d'hôte p: - PDO::__construct avec PDO::ATTR_PERSISTENT comme option du driver - - - - - - &reftitle.description; - - resourcemysql_pconnect - stringserverini_get("mysql.default_host") - stringusernameini_get("mysql.default_user") - stringpasswordini_get("mysql.default_password") - intclient_flags0 - - - - Ouvre une connexion persistante à un serveur MySQL. - - - - mysql_pconnect se comporte exactement comme - mysql_connect, mais avec deux différences majeures : - - - Premièrement, lors de la connexion, la fonction essaie de trouver une - connexion persistante déjà ouverte sur cet hôte, avec le - même nom d'utilisateur et de mot de passe. Si une telle connexion - est trouvée, son identifiant est retourné, sans ouvrir de - nouvelle connexion. - - - Deuxièmement, la connexion au serveur MySQL ne sera pas terminée avec la fin - du script. Au lieu de cela, le lien sera conservé pour un prochain accès - (mysql_close ne terminera pas une connexion persistante - établie par mysql_pconnect). - - - C'est pourquoi ce type de connexion est dite persistante. - - - - - &reftitle.parameters; - - - server - - - Le serveur MySQL. Il peut également comprendre un numéro de port, e.g. - "hostname:port" ou un chemin vers un socket local e.g. ":/path/to/socket". - - - Si la directive PHP - mysql.default_host n'est pas définie (défaut), alors, - la valeur par défaut est "localhost:3306". - - - - - username - - - Le nom de l'utilisateur. La valeur par défaut est l'utilisateur - faisant fonctionner le processus serveur courant. - - - - - password - - - Le mot de passe. La valeur par défaut est un mot de passe vide. - - - - - client_flags - - - Le paramètre client_flags peut être une - combinaison des constantes suivantes : - 128 (active le gestionnaire LOAD DATA LOCAL), - MYSQL_CLIENT_SSL, - MYSQL_CLIENT_COMPRESS, - MYSQL_CLIENT_IGNORE_SPACE ou - MYSQL_CLIENT_INTERACTIVE. - - - - - - - - &reftitle.returnvalues; - - Retourne un identifiant de lien persistant MySQL en cas de succès, ou &false; - si une erreur survient. - - - - - &reftitle.notes; - - - À noter que les connexions persistantes ne fonctionnent que si on utilise - PHP en version module. Consulter la section sur les - connexions persistantes - aux bases de données pour plus d'informations. - - - - - L'utilisation des connexions persistantes requiert des paramétrages - d'Apache et de MySQL pour s'assurer que l'on n'atteindra pas - la limite maximale de nombre de connexions simultanées autorisée - par MySQL. - - - - - - &reftitle.seealso; - - mysql_connect - Les connexions - persistantes aux bases de données - - - - diff --git a/reference/mysql/functions/mysql-ping.xml b/reference/mysql/functions/mysql-ping.xml deleted file mode 100644 index 07218a8b31..0000000000 --- a/reference/mysql/functions/mysql-ping.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - mysql_ping - Vérifie la connexion au serveur MySQL, et s'y reconnecte au besoin - - - - - &mysql.alternative.note; - - mysqli_ping - - - - - - &reftitle.description; - - boolmysql_ping - resourcelink_identifierNULL - - - mysql_ping vérifie si la connexion au serveur - link_identifier fonctionne. Si elle est tombée, - une reconnexion automatique est effectuée. Cette fonction est utile pour les - scripts qui restent inactifs durant un long moment. Ils peuvent ainsi vérifier si - le serveur a fermé la connexion, pour cause d'inactivité. - - - - La reconnexion automatique est désactivée par défaut - depuis la version 5.0.3 et suivants de MySQL. - - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne &true; si la connexion au serveur MySQL fonctionne, &false; sinon. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_ping</function> - - -]]> - - - - - - &reftitle.seealso; - - mysql_thread_id - mysql_list_processes - - - - diff --git a/reference/mysql/functions/mysql-query.xml b/reference/mysql/functions/mysql-query.xml deleted file mode 100644 index fd95d47b44..0000000000 --- a/reference/mysql/functions/mysql-query.xml +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - - mysql_query - Envoie une requête à un serveur MySQL - - - - - &mysql.alternative.note; - - mysqli_query - PDO::query - - - - - - &reftitle.description; - - mixedmysql_query - stringquery - resourcelink_identifierNULL - - - mysql_query envoie une seule requête (les - requêtes multiples ne sont pas prises en charge) à la base de données - courante sur le serveur associé avec le link_identifier - spécifié. - - - - - &reftitle.parameters; - - - query - - - Une requête SQL - - - La chaîne de requête ne doit pas se terminer par un point-virgule. - Les données contenues dans la requête doivent être échappées proprement. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Pour les requêtes du type SELECT, SHOW, - DESCRIBE, EXPLAIN et les autres requêtes retournant un - jeu de résultats, mysql_query retourne une &resource; en cas de succès, - ou &false; en cas d'erreur. - - - Pour les autres types de requêtes, INSERT, UPDATE, - DELETE, DROP, etc., - mysql_query retourne &true; en cas de succès - ou &false; en cas d'erreur. - - - La ressource de résultat retournée doit être passée à la fonction - mysql_fetch_array, et les autres fonctions - permettant d'explorer le résultat des tables, pour accéder aux - données retournées. - - - Utiliser mysql_num_rows pour trouver le nombre - de lignes retournées pour une requête du type SELECT ou - mysql_affected_rows pour trouver le nombre - de lignes affectées par les requêtes du type DELETE, - INSERT, REPLACE, ou UPDATE. - - - mysql_query échoue et retourne &false; - si l'utilisateur n'a pas les autorisations nécessaires pour accéder à la (aux) table(s) - référencée(s) par la requête. - - - - - &reftitle.examples; - - Requête invalide - - La requête suivante est syntaxiquement invalide, donc - mysql_query va échouer et retourner &false;. - - - -]]> - - - - Requête valide - - La requête suivante est valide, donc mysql_query - va retourner une &resource;. - - - -]]> - - - - - - &reftitle.seealso; - - mysql_connect - mysql_error - mysql_real_escape_string - mysql_result - mysql_fetch_assoc - mysql_unbuffered_query - - - - diff --git a/reference/mysql/functions/mysql-real-escape-string.xml b/reference/mysql/functions/mysql-real-escape-string.xml deleted file mode 100644 index 0cf968e5bf..0000000000 --- a/reference/mysql/functions/mysql-real-escape-string.xml +++ /dev/null @@ -1,233 +0,0 @@ - - - - - - - mysql_real_escape_string - Protège une commande SQL de la présence de caractères spéciaux - - - - - &mysql.alternative.note; - - mysqli_real_escape_string - PDO::quote - - - - - - &reftitle.description; - - stringmysql_real_escape_string - stringunescaped_string - resourcelink_identifierNULL - - - mysql_real_escape_string protège une commande SQL - de la chaîne unescaped_string, en "échappant" les caractères - spéciaux tout en prenant en compte le jeu de caractères courant de la connexion link_identifier. - Le résultat peut être utilisé sans problème avec la fonction mysql_query. - Si des données binaires doivent être insérées, cette fonction doit être utilisée. - - - mysql_real_escape_string appelle la fonction - mysql_real_escape_string - de la bibliothèque MySQL qui ajoute un antislash aux caractères suivants : - NULL, \x00, \n, - \r, \, ', - " et \x1a. - - - Cette fonction doit toujours (avec quelques exceptions) être utilisée - avant d'envoyer la requête à MySQL afin de protéger les données d'injection - de caractères pouvant dévoyer cette requête. - - - - Sécurité : le jeu de caractères par défaut - - Le jeu de caractères doit être défini soit au niveau - serveur, soit avec la fonction API mysql_set_charset - pour qu'il ait un effet sur la fonction - mysql_real_escape_string. Voir - la section sur les concepts - des jeux de caractères - pour plus d'informations. - - - - - - &reftitle.parameters; - - - unescaped_string - - - La chaîne à échapper. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne la chaîne échappée, ou &false; si une erreur survient. - - - - - &reftitle.errors; - - Exécuter cette fonction sans qu'une connexion MySQL ne soit présente - va également émettre une erreur PHP de niveau E_WARNING. - N'exécuter cette fonction qu'avec une connexion MySQL valide. - - - - - &reftitle.examples; - - Exemple simple avec <function>mysql_real_escape_string</function> - - -]]> - - - - Exemple avec <function>mysql_real_escape_string</function> et la nécessité - de la présence d'une connexion - - Cet exemple démontre ce qui survient si une connexion MySQL n'est pas présente - lors de l'appel à la fonction. - - - -]]> - - &example.outputs.similar; - - - - - - Un exemple d'attaque par injection SQL - - -]]> - - - La requête envoyée à MySQL : - - - - - - Cela permet à n'importe qui de s'identifier sans mot de passe valide. - - - - - - &reftitle.notes; - - - Une connexion MySQL est nécessaire avant d'utiliser la fonction - mysql_real_escape_string, sinon, une erreur - de niveau E_WARNING sera générée, et &false; sera - retourné. Si link_identifier n'est pas défini, - la dernière connexion MySQL est utilisée. - - - - - Si cette fonction n'est pas utilisée pour protéger les données, la requête - sera vulnérable aux attaques - par injection SQL. - - - - - mysql_real_escape_string n'échappe ni - %, ni _. Ce sont des jokers en MySQL si - combinés avec LIKE, GRANT, - ou REVOKE. - - - - - - &reftitle.seealso; - - mysql_set_charset - mysql_client_encoding - - - - diff --git a/reference/mysql/functions/mysql-result.xml b/reference/mysql/functions/mysql-result.xml deleted file mode 100644 index 4a1adb3593..0000000000 --- a/reference/mysql/functions/mysql-result.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - - mysql_result - Retourne un champ d'un résultat MySQL - - - - - &mysql.alternative.note; - - - mysqli_data_seek en conjonction de - mysqli_field_seek et - mysqli_fetch_field - - PDOStatement::fetchColumn - - - - - - &reftitle.description; - - stringmysql_result - resourceresult - introw - mixedfield0 - - - Retourne le contenu d'une cellule d'un jeu de résultats MySQL. - - - Lorsqu'on travaille sur des résultats de grande taille, - il est conseillé d'utiliser une des fonctions qui vont rechercher une ligne - entière dans un tableau. Ces fonctions sont NETTEMENT plus - rapides. De plus, utiliser un offset numérique est - aussi beaucoup plus rapide que spécifier un nom littéral. - - - - - &reftitle.parameters; - - &mysql.result.description; - - row - - - Le numéro de la ligne à récupérer. Les numéros de lignes commencent à - &zero;. - - - - - field - - - Le nom ou la position du champ à récupérer. - - - Il peut être la position du champ, le nom du champ ou le nom de - la table suivi d'un point, suivi du nom du champ - (tablename.fieldname). - Si un alias a été utilisé pour le nom de la colonne - ("selected foo as bar from..."), - utiliser plutôt l'alias. Si ce paramètre n'est pas défini, le premier champ - sera récupéré. - - - - - - - - &reftitle.returnvalues; - - Le contenu d'un champ depuis un jeu de résultats MySQL en cas - de succès, ou &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_result</function> - - -]]> - - - - - - &reftitle.notes; - - - Les appels mysql_result ne devraient pas être - mélangés avec d'autres fonctions qui travaillent aussi sur - le résultat. - - - - - - &reftitle.seealso; - - mysql_fetch_row - mysql_fetch_array - mysql_fetch_assoc - mysql_fetch_object - - - - diff --git a/reference/mysql/functions/mysql-select-db.xml b/reference/mysql/functions/mysql-select-db.xml deleted file mode 100644 index 5b9b3dd4ec..0000000000 --- a/reference/mysql/functions/mysql-select-db.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - mysql_select_db - Sélectionne une base de données MySQL - - - - - &mysql.alternative.note; - - mysqli_select_db - PDO::__construct (fait partie du dsn) - - - - - - &reftitle.description; - - boolmysql_select_db - stringdatabase_name - resourcelink_identifierNULL - - - Sélectionne une base de données MySQL sur le serveur associé avec le paramètre - link_identifier. Chaque appel à la fonction - mysql_query sera exécuté sur la base de données active. - - - - - &reftitle.parameters; - - - database_name - - - Le nom de la base de données à sélectionner. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>mysql_select_db</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_selectdb - - - - - - &reftitle.seealso; - - mysql_connect - mysql_pconnect - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-set-charset.xml b/reference/mysql/functions/mysql-set-charset.xml deleted file mode 100644 index 4c8b1a75de..0000000000 --- a/reference/mysql/functions/mysql-set-charset.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - mysql_set_charset - Définit le jeu de caractères du client MySQL - - - - - &mysql.alternative.note; - - mysqli_set_charset - PDO: Ajoute le charset à la chaîne de connexion, par exemple charset=utf8 - - - - - - &reftitle.description; - - boolmysql_set_charset - stringcharset - resourcelink_identifierNULL - - - Définit le jeu de caractères par défaut pour la connexion courante. - - - - - &reftitle.parameters; - - - charset - - - Un nom de jeu de caractères valide. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - - - Cette fonction requiert MySQL version 5.0.7 ou supérieure. - - - - - C'est la meilleure façon de changer le jeu de caractères. - L'utilisation de la fonction mysql_query - pour le définir (avec par exemple SET NAMES utf8) - n'est pas recommandée. Voir la section - Concept sur les jeux de caractères - en MySQL pour plus d'informations. - - - - - - &reftitle.seealso; - - Définir un jeu de caractères dans MySQL - La liste des jeux de caractères supportés par MySQL - mysql_client_encoding - - - - - diff --git a/reference/mysql/functions/mysql-stat.xml b/reference/mysql/functions/mysql-stat.xml deleted file mode 100644 index 400fef3e1d..0000000000 --- a/reference/mysql/functions/mysql-stat.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - mysql_stat - Retourne le statut courant du serveur MySQL - - - - - &mysql.alternative.note; - - mysqli_stat - - PDO::getAttribute - avec attribute en tant que PDO::ATTR_SERVER_INFO - - - - - - - &reftitle.description; - - stringmysql_stat - resourcelink_identifierNULL - - - mysql_stat retourne le statut courant du serveur MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant le statut de durée de fonctionnement, - les threads, les requêtes, les tables ouvertes et sur disque, - et le nombre de requêtes par seconde. Pour une liste complète - des autres variables de statuts, - il faut utiliser la commande SQL SHOW STATUS. - Si link_identifier est invalide, &null; est retourné. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_stat</function> - - -]]> - - &example.outputs.similar; - - Uptime: 5380 -[1] => Threads: 2 -[2] => Questions: 1321299 -[3] => Slow queries: 0 -[4] => Opens: 26 -[5] => Flush tables: 1 -[6] => Open tables: 17 -[7] => Queries per second avg: 245.595 -) -]]> - - - - Exemple alternatif pour <function>mysql_stat</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_server_info - mysql_list_processes - - - - diff --git a/reference/mysql/functions/mysql-tablename.xml b/reference/mysql/functions/mysql-tablename.xml deleted file mode 100644 index f99f61aecd..0000000000 --- a/reference/mysql/functions/mysql-tablename.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - mysql_tablename - Lit le nom de la table qui contient un champ - - - - - &mysql.alternative.note; - - Requête SQL : SHOW TABLES - - - - - - &reftitle.description; - - stringfalsemysql_tablename - resourceresult - inti - - - Lit le nom de la table depuis le jeu de résultats result. - - - Cette fonction est obsolète. Il est préférable d'utiliser la fonction - mysql_query avec une requête SQL SHOW TABLES - [FROM db_name] [LIKE 'pattern'] à la place. - - - - - &reftitle.parameters; - - - result - - - Un pointeur de résultats retourné par la fonction - mysql_list_tables. - - - - - i - - - L'index (numéro ligne/table) - - - - - - - - &reftitle.returnvalues; - - Le nom de la table en cas de succès&return.falseforfailure;. - - - Utiliser la fonction mysql_tablename - pour parcourir ce pointeur de résultats, ou n'importe quelle fonction - pour les résultats de tables comme la fonction - mysql_fetch_array. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_tablename</function> - - - ]]> - - - - - - &reftitle.notes; - - - La fonction mysql_num_rows peut être utilisée - pour déterminer le nombre de tables dans le pointeur de résultats. - - - - - - &reftitle.seealso; - - mysql_list_tables - mysql_field_table - mysql_db_name - - - - diff --git a/reference/mysql/functions/mysql-thread-id.xml b/reference/mysql/functions/mysql-thread-id.xml deleted file mode 100644 index be562ec8a4..0000000000 --- a/reference/mysql/functions/mysql-thread-id.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - mysql_thread_id - Retourne l'identifiant du thread MySQL courant - - - - - &mysql.alternative.note; - - mysqli_thread_id - - - - - - &reftitle.description; - - intfalsemysql_thread_id - resourcelink_identifierNULL - - - mysql_thread_id retourne l'identifiant du thread courant. - Si la connexion link_identifier est perdue - et que l'on se reconnecte (avec mysql_ping, - par exemple), alors l'identifiant de thread va changer. Cela signifie - qu'il faut le récupérer lorsqu'on en a besoin. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - L'identifiant du thread en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>mysql_thread_id</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_ping - mysql_list_processes - - - - diff --git a/reference/mysql/functions/mysql-unbuffered-query.xml b/reference/mysql/functions/mysql-unbuffered-query.xml deleted file mode 100644 index caa3954e67..0000000000 --- a/reference/mysql/functions/mysql-unbuffered-query.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - mysql_unbuffered_query - - Exécute une requête SQL sans mobiliser les résultats MySQL - - - - - - &mysql.alternative.note; - - Voir : les requêtes mises ou non en mémoire tampon - - - - - - &reftitle.description; - - resourcemysql_unbuffered_query - stringquery - resourcelink_identifierNULL - - - mysql_unbuffered_query envoie la requête SQL - query à MySQL sans automatiquement récupérer - et mettre en mémoire les lignes du résultat, comme pourrait le faire - la fonction mysql_query. Ce comportement permet - d'épargner une grande quantité de mémoire lorsque les requêtes SQL - produisent un gros jeu de résultats, et il est possible de commencer à travailler - sur le jeu de résultats immédiatement après que la première ligne ait été - récupérée : l'on n'a pas à attendre la fin du traitement de la requête SQL. - Pour utiliser la fonction mysql_unbuffered_query lorsque - plusieurs connexions à des bases de données sont ouvertes, il faut spécifier - le paramètre optionnel link_identifier pour identifier - la connexion à utiliser. - - - - - &reftitle.parameters; - - - query - - - La requête SQL à exécuter - - - Les données de la requête doivent être proprement échappées. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Pour les requêtes SELECT, SHOW, DESCRIBE ou EXPLAIN, - mysql_unbuffered_query - retourne une &resource; en cas de succès, ou &false; si une erreur - survient. - - - Pour les autres types de requêtes, UPDATE, DELETE, DROP, etc, - mysql_unbuffered_query retourne &true; en cas de succès - ou &false; si une erreur survient. - - - - - &reftitle.notes; - - - L'intérêt de mysql_unbuffered_query - est tempéré par une limitation : mysql_num_rows - et mysql_data_seek ne fonctionnent pas sur une - ressource retournée par mysql_unbuffered_query, jusqu'à ce - que toutes les lignes soient récupérées. - Il faut aussi lire tous les résultats d'une première requête exécutée - avec mysql_unbuffered_query, avant de pouvoir en - exécuter une autre en utilisant le même link_identifier. - - - - - - &reftitle.seealso; - - mysql_query - - - - diff --git a/reference/mysql/ini.xml b/reference/mysql/ini.xml deleted file mode 100644 index ccc192b041..0000000000 --- a/reference/mysql/ini.xml +++ /dev/null @@ -1,272 +0,0 @@ - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; MySQL - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mysql.allow_local_infile - "1" - INI_SYSTEM - - - - mysql.allow_persistent - "1" - INI_SYSTEM - - - - mysql.max_persistent - "-1" - INI_SYSTEM - - - - mysql.max_links - "-1" - INI_SYSTEM - - - - mysql.trace_mode - "Off" - INI_ALL - - - - mysql.default_port - NULL - INI_ALL - - - - mysql.default_socket - NULL - INI_ALL - - - - mysql.default_host - NULL - INI_ALL - - - - mysql.default_user - NULL - INI_ALL - - - - mysql.default_password - NULL - INI_ALL - - - - mysql.connect_timeout - "60" - INI_ALL - - - - -
    - &ini.php.constants; -     - -&ini.descriptions.title; - - - - - - mysql.allow_local_infile - int - - - - Autorise l'accès, d'un point de vue de PHP, des fichiers locaux, - avec les requêtes LOAD DATA. - - - - - - - mysql.allow_persistent - bool - - - - Active ou désactive les - connexions persistantes - à la base de données MySQL. - - - - - - - mysql.max_persistent - int - - - - Le nombre maximum de connexions persistantes aux bases de données - MySQL, par processus. - - - - - - - mysql.max_links - int - - - - Le nombre maximum de connexions aux bases de données MySQL, - y compris les connexions persistantes, par processus. - - - - - - - mysql.trace_mode - bool - - - - Mode trace. Lorsque mysql.trace_mode est activée, - des alertes pour scans de table ou d'index, pour oubli de libération - des ressources ou erreurs SQL seront affichées. Cette option - a été introduite en PHP 4.3.0. - - - - - - - mysql.default_port - string - - - - Le numéro de port TCP par défaut, utilisé pour se connecter - à la base de données, lorsque aucun port n'est spécifié. Si aucun - port par défaut n'est spécifié, le port sera alors obtenu en - lisant la variable d'environnement MYSQL_TCP_PORT, - l'entrée mysql-tcp dans le fichier - /etc/services ou encore la constante - de compilation MYSQL_PORT, dans cet ordre. Windows - n'utilisera aussi que la constante MYSQL_PORT. - - - - - - - mysql.default_socket - string - - - - Le nom par défaut du socket lorsque l'on se connecte - au serveur local, si aucun autre socket n'est spécifié. - - - - - - mysql.default_host - string - - - - Adresse par défaut du serveur, à utiliser lors de la connexion à - un serveur MySQL, si aucun hôte n'est spécifié. - Ne s'applique pas lorsque le &sqlsafemode; est activé. - - - - - - - mysql.default_user - string - - - - Utilisateur par défaut, à utiliser lors de la connexion à un serveur - MySQL, si aucun utilisateur n'est spécifié. - Ne s'applique pas lorsque le &sqlsafemode; est activé. - - - - - - - mysql.default_password - string - - - - Mot de passe par défaut, à utiliser lors de la connexion à un serveur - MySQL, si aucun mot de passe n'est spécifié. - Ne s'applique pas lorsque le &sqlsafemode; est activé. - - - - - - mysql.connect_timeout - int - - - - Durée maximale d'attente de la réponse d'un serveur, en secondes. - Sous Linux, cette durée sert aussi lors du premier échange avec - le serveur. - - - - - -
    - diff --git a/reference/mysql/reference.xml b/reference/mysql/reference.xml deleted file mode 100644 index 920cc43228..0000000000 --- a/reference/mysql/reference.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - &Functions; MySQL - - -
    - &reftitle.notes; - - - La plupart des fonctions MySQL acceptent - link_identifier comme le dernier paramètre - optionnel. S'il n'est pas fourni, la dernière connexion ouverte est - utilisée. Si elle n'existe pas, une connexion est essayée d'être établie - avec les paramètres par défaut définis dans &php.ini;. Si les fonctions ne - réussissent pas, elles retournent &false;. - - -
    -     - -&reference.mysql.entities.functions; - -     - diff --git a/reference/mysql/setup.xml b/reference/mysql/setup.xml deleted file mode 100644 index 16fec4639b..0000000000 --- a/reference/mysql/setup.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Afin de pouvoir les utiliser, il faut compiler PHP avec le support - MySQL. - - - &mysql.alternative.note; - -
    - - - - &reference.mysql.configure; - - - - &reference.mysql.ini; - - - -
    - &reftitle.resources; - - Il y a deux types de ressources utilisées par le module MySQL. - Le premier est un identifiant de connexion au serveur, appelé - mysql link, - et le second est un identifiant de résultat de requête, appelé - mysql result. - -
    - - -     - diff --git a/reference/mysql_xdevapi/book.xml b/reference/mysql_xdevapi/book.xml deleted file mode 100644 index 6162c12dff..0000000000 --- a/reference/mysql_xdevapi/book.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Mysql_xdevapi - Mysql_xdevapi - - - &reftitle.intro; - - Cette extension fournit un accès au Document Store de MySQL à travers la DevAPI X. - La DevAPI X est une API commune fournie par plusieurs connecteurs MySQL fournissant un - accès facile aux tables relationnelles aussi bien qu'aux collections de documents, - qui sont représentés en JSON, depuis une API avec des opérations de style CRUD. - - - La DevAPI de X utilise le protocole X, le protocole nouvelle génération client-serveur - du serveur MySQL 8.0. - - - Pour des informations générales sur MySQL Document Store, se référer au chapitre - MySQL Document Store - du manuel MySQL. - - - - &reference.mysql-xdevapi.setup; - &reference.mysql-xdevapi.constants; - &reference.mysql-xdevapi.changelog; - &reference.mysql-xdevapi.examples; - &reference.mysql-xdevapi.reference; - - &reference.mysql-xdevapi.mysql-xdevapi.baseresult; - &reference.mysql-xdevapi.mysql-xdevapi.client; - &reference.mysql-xdevapi.mysql-xdevapi.collection; - &reference.mysql-xdevapi.mysql-xdevapi.collectionadd; - &reference.mysql-xdevapi.mysql-xdevapi.collectionfind; - &reference.mysql-xdevapi.mysql-xdevapi.collectionmodify; - &reference.mysql-xdevapi.mysql-xdevapi.collectionremove; - &reference.mysql-xdevapi.mysql-xdevapi.columnresult; - &reference.mysql-xdevapi.mysql-xdevapi.crudoperationbindable; - &reference.mysql-xdevapi.mysql-xdevapi.crudoperationlimitable; - &reference.mysql-xdevapi.mysql-xdevapi.crudoperationskippable; - &reference.mysql-xdevapi.mysql-xdevapi.crudoperationsortable; - &reference.mysql-xdevapi.mysql-xdevapi.databaseobject; - &reference.mysql-xdevapi.mysql-xdevapi.docresult; - &reference.mysql-xdevapi.mysql-xdevapi.driver; - &reference.mysql-xdevapi.mysql-xdevapi.exception; - &reference.mysql-xdevapi.mysql-xdevapi.executable; - &reference.mysql-xdevapi.mysql-xdevapi.executionstatus; - &reference.mysql-xdevapi.mysql-xdevapi.expression; - &reference.mysql-xdevapi.mysql-xdevapi.fieldmetadata; - &reference.mysql-xdevapi.mysql-xdevapi.result; - &reference.mysql-xdevapi.mysql-xdevapi.rowresult; - &reference.mysql-xdevapi.mysql-xdevapi.schema; - &reference.mysql-xdevapi.mysql-xdevapi.schemaobject; - &reference.mysql-xdevapi.mysql-xdevapi.session; - &reference.mysql-xdevapi.mysql-xdevapi.sqlstatement; - &reference.mysql-xdevapi.mysql-xdevapi.sqlstatementresult; - &reference.mysql-xdevapi.mysql-xdevapi.statement; - &reference.mysql-xdevapi.mysql-xdevapi.table; - &reference.mysql-xdevapi.mysql-xdevapi.tabledelete; - &reference.mysql-xdevapi.mysql-xdevapi.tableinsert; - &reference.mysql-xdevapi.mysql-xdevapi.tableselect; - &reference.mysql-xdevapi.mysql-xdevapi.tableupdate; - &reference.mysql-xdevapi.mysql-xdevapi.warning; - - - - diff --git a/reference/mysql_xdevapi/changelog.xml b/reference/mysql_xdevapi/changelog.xml deleted file mode 100644 index 3ae3e780c6..0000000000 --- a/reference/mysql_xdevapi/changelog.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - &ChangelogListingTitle; - &ChangelogListingDescription; - - - Historique de changement général de l'extension ext/mysql_xdevapi - - Cet historique de changement référence l'extension ext/mysql_xdevapi. - - - - - Changement global de l'extension ext/mysql_xdevapi - - - - - - &Version; - &Description; - - - - - 8.0.28 - - - Suppression du support de TLSv1 et TLSv1.1. Les valeurs "TLSv1", - "TLSv1.0" et "TLSv1.1" sont désormais considérées comme invalides - pour l'attribut de connexion "tls-versions". - - - - - 8.0.26 - - - Dépréciation du support de TLSv1 et TLSv1.1. - - - - - - - - - - - - diff --git a/reference/mysql_xdevapi/constants.xml b/reference/mysql_xdevapi/constants.xml deleted file mode 100644 index f8da41f0d3..0000000000 --- a/reference/mysql_xdevapi/constants.xml +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - - MYSQLX_CLIENT_SSL - (int) - - - - - - - - - MYSQLX_TYPE_DECIMAL - (int) - - - - - - - - - MYSQLX_TYPE_TINY - (int) - - - - - - - - - MYSQLX_TYPE_SHORT - (int) - - - - - - - - - MYSQLX_TYPE_SMALLINT - (int) - - - - - - - - - MYSQLX_TYPE_MEDIUMINT - (int) - - - - - - - - - MYSQLX_TYPE_INT - (int) - - - - - - - - - MYSQLX_TYPE_BIGINT - (int) - - - - - - - - - MYSQLX_TYPE_LONG - (int) - - - - - - - - - MYSQLX_TYPE_FLOAT - (int) - - - - - - - - - MYSQLX_TYPE_DOUBLE - (int) - - - - - - - - - MYSQLX_TYPE_NULL - (int) - - - - - - - - - MYSQLX_TYPE_TIMESTAMP - (int) - - - - - - - - - MYSQLX_TYPE_LONGLONG - (int) - - - - - - - - - MYSQLX_TYPE_INT24 - (int) - - - - - - - - - MYSQLX_TYPE_DATE - (int) - - - - - - - - - MYSQLX_TYPE_TIME - (int) - - - - - - - - - MYSQLX_TYPE_DATETIME - (int) - - - - - - - - - MYSQLX_TYPE_YEAR - (int) - - - - - - - - - MYSQLX_TYPE_NEWDATE - (int) - - - - - - - - - MYSQLX_TYPE_ENUM - (int) - - - - - - - - - MYSQLX_TYPE_SET - (int) - - - - - - - - - MYSQLX_TYPE_TINY_BLOB - (int) - - - - - - - - - MYSQLX_TYPE_MEDIUM_BLOB - (int) - - - - - - - - - MYSQLX_TYPE_LONG_BLOB - (int) - - - - - - - - - MYSQLX_TYPE_BLOB - (int) - - - - - - - - - MYSQLX_TYPE_VAR_STRING - (int) - - - - - - - - - MYSQLX_TYPE_STRING - (int) - - - - - - - - - MYSQLX_TYPE_CHAR - (int) - - - - - - - - - MYSQLX_TYPE_BYTES - (int) - - - - - - - - - MYSQLX_TYPE_INTERVAL - (int) - - - - - - - - - MYSQLX_TYPE_GEOMETRY - (int) - - - - - - - - - MYSQLX_TYPE_JSON - (int) - - - - - - - - - MYSQLX_TYPE_NEWDECIMAL - (int) - - - - - - - - - MYSQLX_TYPE_BIT - (int) - - - - - - - - - MYSQLX_LOCK_DEFAULT - (int) - - - - - - - - - MYSQLX_LOCK_NOWAIT - (int) - - - - - - - - - MYSQLX_LOCK_SKIP_LOCKED - (int) - - - - - - - - - - - diff --git a/reference/mysql_xdevapi/examples.xml b/reference/mysql_xdevapi/examples.xml deleted file mode 100644 index 8eef0724ab..0000000000 --- a/reference/mysql_xdevapi/examples.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - &reftitle.examples; - - Le point d'entrée central de l'API X est la fonction mysql_xdevapi\getSession, - qui reçoit une URI vers un serveur MySQL 8.0 et renvoie un objet - mysql_xdevapi\Session. - - - Connexion à un serveur MySQL - -getMessage()); -} - -// ... use $session -?> -]]> - - - - La session fournit un accès complet à l'API. Pour une nouvelle installation de serveur MySQL, - la première étape consiste à créer un schéma de base de données avec une collection - pour stocker des données : - - - Création d'un schéma et d'une collection sur le serveur MySQL - -createSchema("test"); -$collection = $schema->createCollection("example"); -?> -]]> - - - - Lorsqu'on stocke des données, généralement json_encode est utilisé pour encoder - les données en JSON, qui peuvent ensuite être stockées dans une collection. - - - Les exemples suivants stockent des données dans la collection que nous avons créée précédemment, - puis récupèrent à nouveau des parties de ces données. - - - Stocker et Récupérer des Données - - "Marco", - "age" => 19, - "job" => "Programmer" -]; -$mike = [ - "name" => "Mike", - "age" => 39, - "job" => "Manager" -]; - -$schema = $session->getSchema("test"); -$collection = $schema->getCollection("example"); - -$collection->add($marco, $mike)->execute(); - -var_dump($collection->find("name = 'Mike'")->execute()->fetchOne()); -?> -]]> - - &example.outputs.similar; - - - string(28) "00005ad66aaf0000000000000003" - ["age"]=> - int(39) - ["job"]=> - string(7) "Manager" - ["name"]=> - string(4) "Mike" -} -]]> - - - - Cet exemple démontre que le serveur MySQL ajoute un champ supplémentaire nommé - _id, qui sert de clé primaire au document. - - - Cet exemple démontre également que les données récupérées sont triées par ordre alphabétique. - Cet ordre spécifique provient du stockage binaire efficace à l'intérieur du serveur MySQL, mais - il ne faut pas s'y fier. Se référer à la documentation du type de données JSON de MySQL pour plus de détails. - - - Optionnellement, utiliser les itérateurs de PHP pour récupérer plusieurs documents : - - - Récupérer et Itérer sur Plusieurs Documents - -find()->execute(); -foreach ($result as $doc) { - echo "{$doc["name"]} is a {$doc["job"]}.\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - diff --git a/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml b/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml deleted file mode 100644 index 481ac7996d..0000000000 --- a/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - expression - Lie une expression à une variable de requête préparée - - - - &reftitle.description; - - objectmysql_xdevapi\expression - stringexpression - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - expression - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Expression</function> - -find("age > 30")->fields($expression)->limit(3)->execute(); -$data = $res->fetchAll(); - -print_r($data); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml b/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml deleted file mode 100644 index f669db0124..0000000000 --- a/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml +++ /dev/null @@ -1,252 +0,0 @@ - - - - - - getSession - Connecte à un serveur MySQL - - - - &reftitle.description; - - mysql_xdevapi\Sessionmysql_xdevapi\getSession - stringuri - - - Connecte au serveur MySQL. - - - - - &reftitle.parameters; - - - uri - - - L'uri du serveur MySQL, tel que mysqlx://user:password@host. - - - Format d'URI: - - - scheme://[user[:[password]]@]target[:port][?attribute1=value1&attribute2=value2... - - - - scheme: requis, le protocole de connexion - Dans mysql_xdevapi c'est toujours 'mysqlx' (pour le protocole X) - - - user: optionnel, le compte utilisateur MySQL pour l'authentification - - - password: optionnel, le mot de passe de l'utilisateur MySQL pour l'authentification - - - target: requis, l'instance serveur à laquelle la connexion se réfère: - * Connexion TCP (nom d'hôte, adresse IPv4 ou adresse IPv6) - * Chemin de socket Unix (chemin de fichier local) - * Pipe nommé Windows (chemin de fichier local) - - - port: optionnel, le port réseau du serveur MySQL. - par défaut le port pour le protocole X est 33060 - - - - ?attribute=value: cet élément est optionnel et spécifie un dictionnaire de données - qui contient différentes options, y compris: - - - - - L'auth (mécanisme d'authentification) attribut tel qu'il se rapporte aux connexions chiffrées. - Pour plus d'informations, voir Options de commande pour les connexions chiffrées. - Les valeurs 'auth' suivantes sont supportées: plain, - mysql41, external, et sha256_mem. - - - - - L'attribut connect-timeout affecte la connexion et - non les opérations suivantes. Il est défini par connexion, que ce soit sur - un seul hôte ou plusieurs. - - - Passer un entier positif pour définir le délai de connexion en secondes, - ou passer 0 (zéro) pour désactiver le délai (infini). Ne pas définir - connect-timeout utilise la valeur par défaut de 10. - - - En relation, les variables d'environnement MYSQLX_CONNECTION_TIMEOUT (délai en secondes) et MYSQLX_TEST_CONNECTION_TIMEOUT (utilisé lors de l'exécution des tests) - peuvent être définies et utilisées à la place de connect-timeout dans l'URI. L'option - connect-timeout de l'URI a la priorité sur ces variables d'environnement. - - - - - L'attribut optionnel compression accepte ces valeurs: - preferred (le client négocie avec le serveur pour trouver un algorithme supporté; la connexion est non compressée si un algorithme supporté mutuellement n'est pas trouvé), - required (comme "preferred", mais la connexion est terminée si un algorithme supporté mutuellement n'est pas trouvé), ou - disabled (la connexion est non compressée). Par défaut à preferred. - - - Cette option a été ajoutée dans la version 8.0.20. - - - - - L'attribut optionnel compression-algorithms définit les algorithmes - de compression désirés (et leur ordre d'utilisation préféré): - zstd_stream (alias: zstd), - lz4_message (alias: lz4), ou - deflate_stream (alias: deflate ou zlib). - Par défaut, l'ordre utilisé (selon la disponibilité du système) est lz4_message, zstd_stream, puis deflate_stream. - Par exemple, passer compression-algorithms=[lz4,zstd_stream] utilise lz4 s'il est disponible, sinon - zstd_stream est utilisé. Si les deux ne sont pas disponibles alors le comportement dépend de la valeur de compression - par exemple, si compression=required alors il échouera avec une erreur. - - - Cette option a été ajoutée dans la version 8.0.22. - - - - - - - - Exemple d'URI - -mysqlx://foobar -mysqlx://root@localhost?socket=%2Ftmp%2Fmysqld.sock%2F -mysqlx://foo:bar@localhost:33060 -mysqlx://foo:bar@localhost:33160?ssl-mode=disabled -mysqlx://foo:bar@localhost:33260?ssl-mode=required -mysqlx://foo:bar@localhost:33360?ssl-mode=required&auth=mysql41 -mysqlx://foo:bar@(/path/to/socket) -mysqlx://foo:bar@(/path/to/socket)?auth=sha256_mem -mysqlx://foo:bar@[localhost:33060, 127.0.0.1:33061] -mysqlx://foobar?ssl-ca=(/path/to/ca.pem)&ssl-crl=(/path/to/crl.pem) -mysqlx://foo:bar@[localhost:33060, 127.0.0.1:33061]?ssl-mode=disabled -mysqlx://foo:bar@localhost:33160/?connect-timeout=0 -mysqlx://foo:bar@localhost:33160/?connect-timeout=10&compression=required -mysqlx://foo:bar@localhost:33160/?connect-timeout=10&compression=required&compression-algorithms=[lz4,zstd_stream] - - - - - Pour plus d'informations, voir connexion à MySQL Shell - en utilisant une chaîne d'URI. - - - - - - - - - &reftitle.returnvalues; - - Un objet Session. - - - - - &reftitle.errors; - - Une erreur de connexion lance une exception Exception. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\getSession</function> - -getMessage()); -} - -$schemas = $session->getSchemas(); -print_r($schemas); - -$mysql_version = $session->getServerVersion(); -print_r($mysql_version); - -var_dump($collection->find("name = 'Alfred'")->execute()->fetchOne()); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Schema Object - ( - [name] => helloworld - ) - [1] => mysql_xdevapi\Schema Object - ( - [name] => information_schema - ) - [2] => mysql_xdevapi\Schema Object - ( - [name] => mysql - ) - [3] => mysql_xdevapi\Schema Object - ( - [name] => performance_schema - ) - [4] => mysql_xdevapi\Schema Object - ( - [name] => sys - ) -) - -80012 - -array(4) { - ["_id"]=> - string(28) "00005ad66abf0001000400000003" - ["age"]=> - int(42) - ["job"]=> - string(7) "Butler" - ["name"]=> - string(4) "Alfred" -} -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/ini.xml b/reference/mysql_xdevapi/ini.xml deleted file mode 100644 index 85d8a88f4a..0000000000 --- a/reference/mysql_xdevapi/ini.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; Mysql_xdevapi - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - xmysqlnd.collect_memory_statistics - 0 - INI_SYSTEM - - - - xmysqlnd.collect_statistics - 1 - INI_ALL - - - - xmysqlnd.debug - - INI_SYSTEM - - - - xmysqlnd.mempool_default_size - 16000 - INI_ALL - - - - xmysqlnd.net_read_timeout - 31536000 - INI_SYSTEM - - - - xmysqlnd.trace_alloc - - INI_SYSTEM - - - - -
    -     - - &ini.descriptions.title; - - - - - - xmysqlnd.collect_memory_statistics - int - - - - - - - - - - xmysqlnd.collect_statistics - int - - - - - - - - - - xmysqlnd.debug - string - - - - - - - - - - xmysqlnd.mempool_default_size - int - - - - - - - - - - xmysqlnd.net_read_timeout - int - - - - - - - - - - xmysqlnd.trace_alloc - string - - - - - - - - - - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml deleted file mode 100644 index f083145d76..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interface BaseResult - mysql_xdevapi\BaseResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\BaseResult - - - - - mysql_xdevapi\BaseResult - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.baseresult; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.client.xml b/reference/mysql_xdevapi/mysql-xdevapi.client.xml deleted file mode 100644 index a80a2986c6..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.client.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Client - mysql_xdevapi\Client - - - - -
    - &reftitle.intro; - - Apporte un accès au pool de connexions. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Client - - - - - mysql_xdevapi\Client - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.client; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collection.xml b/reference/mysql_xdevapi/mysql-xdevapi.collection.xml deleted file mode 100644 index c6d340318d..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collection.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - Classe Collection - mysql_xdevapi\Collection - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Collection - - - - - mysql_xdevapi\Collection - - - - mysql_xdevapi\SchemaObject - - - - &Properties; - - public - name - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - name - - - - - -
    - - - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collection; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml deleted file mode 100644 index a616eefa73..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Classe CollectionAdd - mysql_xdevapi\CollectionAdd - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CollectionAdd - - - - - mysql_xdevapi\CollectionAdd - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collectionadd; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml deleted file mode 100644 index 11e1925c49..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - Classe CollectionFind - mysql_xdevapi\CollectionFind - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CollectionFind - - - - - mysql_xdevapi\CollectionFind - - - - mysql_xdevapi\Executable - - - - mysql_xdevapi\CrudOperationBindable - - - - mysql_xdevapi\CrudOperationLimitable - - - - mysql_xdevapi\CrudOperationSortable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collectionfind; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml deleted file mode 100644 index f11f690df5..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - Classe CollectionModify - mysql_xdevapi\CollectionModify - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CollectionModify - - - - - mysql_xdevapi\CollectionModify - - - - mysql_xdevapi\Executable - - - - mysql_xdevapi\CrudOperationBindable - - - - mysql_xdevapi\CrudOperationLimitable - - - - mysql_xdevapi\CrudOperationSkippable - - - - mysql_xdevapi\CrudOperationSortable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collectionmodify; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml deleted file mode 100644 index fbe7e9b3d2..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - Classe CollectionRemove - mysql_xdevapi\CollectionRemove - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CollectionRemove - - - - - mysql_xdevapi\CollectionRemove - - - - mysql_xdevapi\Executable - - - - mysql_xdevapi\CrudOperationBindable - - - - mysql_xdevapi\CrudOperationLimitable - - - - mysql_xdevapi\CrudOperationSortable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collectionremove; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml deleted file mode 100644 index 6cd94139a6..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Classe ColumnResult - mysql_xdevapi\ColumnResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\ColumnResult - - - - - mysql_xdevapi\ColumnResult - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.columnresult; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml deleted file mode 100644 index 3b70e3b7fb..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interface CrudOperationBindable - mysql_xdevapi\CrudOperationBindable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CrudOperationBindable - - - - - mysql_xdevapi\CrudOperationBindable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.crudoperationbindable; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml deleted file mode 100644 index d84e587681..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interface CrudOperationLimitable - mysql_xdevapi\CrudOperationLimitable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CrudOperationLimitable - - - - - mysql_xdevapi\CrudOperationLimitable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.crudoperationlimitable; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml deleted file mode 100644 index f8e283c317..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interface CrudOperationSkippable - mysql_xdevapi\CrudOperationSkippable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CrudOperationSkippable - - - - - mysql_xdevapi\CrudOperationSkippable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.crudoperationskippable; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml deleted file mode 100644 index c945bceb45..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interface CrudOperationSortable - mysql_xdevapi\CrudOperationSortable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CrudOperationSortable - - - - - mysql_xdevapi\CrudOperationSortable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.crudoperationsortable; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml b/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml deleted file mode 100644 index aabceeeed4..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interface DatabaseObject - mysql_xdevapi\DatabaseObject - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\DatabaseObject - - - - - mysql_xdevapi\DatabaseObject - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.databaseobject; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml deleted file mode 100644 index 78484b17d2..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - Classe DocResult - mysql_xdevapi\DocResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\DocResult - - - - - mysql_xdevapi\DocResult - - - - mysql_xdevapi\BaseResult - - - - Traversable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.docresult; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.driver.xml b/reference/mysql_xdevapi/mysql-xdevapi.driver.xml deleted file mode 100644 index b7f6106b96..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.driver.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Classe Driver - mysql_xdevapi\Driver - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Driver - - - - - mysql_xdevapi\Driver - - - - &Constants; - - const - string - mysql_xdevapi\Driver::version - 8.0.3 - - - - - -
    - - -
    - &reftitle.constants; - - - - mysql_xdevapi\Driver::version - - - - - - -
    - - - -     - - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.exception.xml b/reference/mysql_xdevapi/mysql-xdevapi.exception.xml deleted file mode 100644 index 1313627356..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.exception.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - Classe Exception - mysql_xdevapi\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Exception - - - - - mysql_xdevapi\Exception - - - - extends - RuntimeException - - - - Throwable - - - - - - - - -
    - -     - - - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.executable.xml b/reference/mysql_xdevapi/mysql-xdevapi.executable.xml deleted file mode 100644 index 2fde295568..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.executable.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interface Executable - mysql_xdevapi\Executable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Executable - - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.executable; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml b/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml deleted file mode 100644 index 5ba87c1af0..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - Classe ExecutionStatus - mysql_xdevapi\ExecutionStatus - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\ExecutionStatus - - - - - mysql_xdevapi\ExecutionStatus - - - - &Properties; - - public - affectedItems - - - public - matchedItems - - - public - foundItems - - - public - lastInsertId - - - public - lastDocumentId - - - - Constructor - - - - -
    - - - -
    - &reftitle.properties; - - - affectedItems - - - - - - matchedItems - - - - - - foundItems - - - - - - lastInsertId - - - - - - lastDocumentId - - - - - -
    - - - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.executionstatus; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.expression.xml b/reference/mysql_xdevapi/mysql-xdevapi.expression.xml deleted file mode 100644 index 193934a263..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.expression.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - Classe Expression - mysql_xdevapi\Expression - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Expression - - - - - mysql_xdevapi\Expression - - - - &Properties; - - public - name - - - - Constructor - - - - -
    - - - -
    - &reftitle.properties; - - - name - - - - - -
    - - - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.expression; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml b/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml deleted file mode 100644 index 67db161b20..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml +++ /dev/null @@ -1,206 +0,0 @@ - - - - - - Classe FieldMetadata - mysql_xdevapi\FieldMetadata - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\FieldMetadata - - - - - mysql_xdevapi\FieldMetadata - - - - &Properties; - - public - type - - - public - type_name - - - public - name - - - public - original_name - - - public - table - - - public - original_table - - - public - schema - - - public - catalog - - - public - collation - - - public - fractional_digits - - - public - length - - - public - flags - - - public - content_type - - - - - - -
    - - - -
    - &reftitle.properties; - - - type - - - - - - type_name - - - - - - name - - - - - - original_name - - - - - - table - - - - - - original_table - - - - - - schema - - - - - - catalog - - - - - - collation - - - - - - fractional_digits - - - - - - length - - - - - - flags - - - - - - content_type - - - - - -
    - - - -     - - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.result.xml b/reference/mysql_xdevapi/mysql-xdevapi.result.xml deleted file mode 100644 index 9b16e4c6bf..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.result.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - Classe Result - mysql_xdevapi\Result - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Result - - - - - mysql_xdevapi\Result - - - - mysql_xdevapi\BaseResult - - - - Traversable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.result; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml deleted file mode 100644 index d3e2c2e447..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - Classe RowResult - mysql_xdevapi\RowResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\RowResult - - - - - mysql_xdevapi\RowResult - - - - mysql_xdevapi\BaseResult - - - - Traversable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.rowresult; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.schema.xml b/reference/mysql_xdevapi/mysql-xdevapi.schema.xml deleted file mode 100644 index 45f34ed009..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.schema.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - Classe Schema - mysql_xdevapi\Schema - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Schema - - - - - mysql_xdevapi\Schema - - - - mysql_xdevapi\DatabaseObject - - - - &Properties; - - public - name - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - name - - - - - -
    - - - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.schema; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml b/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml deleted file mode 100644 index 283cbeff42..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Interface SchemaObject - mysql_xdevapi\SchemaObject - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\SchemaObject - - - - - mysql_xdevapi\SchemaObject - - - - mysql_xdevapi\DatabaseObject - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.schemaobject; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.session.xml b/reference/mysql_xdevapi/mysql-xdevapi.session.xml deleted file mode 100644 index be1288a0f8..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.session.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Classe Session - mysql_xdevapi\Session - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Session - - - - - mysql_xdevapi\Session - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.session; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml b/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml deleted file mode 100644 index 2cdef3fe55..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - - Classe SqlStatement - mysql_xdevapi\SqlStatement - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\SqlStatement - - - - - mysql_xdevapi\SqlStatement - - - - &Constants; - - const - int - mysql_xdevapi\SqlStatement::EXECUTE_ASYNC - 1 - - - const - int - mysql_xdevapi\SqlStatement::BUFFERED - 2 - - - &Properties; - - public - statement - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - statement - - - - - -
    - - - - -
    - &reftitle.constants; - - - - mysql_xdevapi\SqlStatement::EXECUTE_ASYNC - - - - - - - mysql_xdevapi\SqlStatement::BUFFERED - - - - - - -
    - - - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.sqlstatement; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml deleted file mode 100644 index edc428cf95..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - Classe SqlStatementResult - mysql_xdevapi\SqlStatementResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\SqlStatementResult - - - - - mysql_xdevapi\SqlStatementResult - - - - mysql_xdevapi\BaseResult - - - - Traversable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.sqlstatementresult; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.statement.xml b/reference/mysql_xdevapi/mysql-xdevapi.statement.xml deleted file mode 100644 index 971ec4a0f6..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.statement.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - - Classe Statement - mysql_xdevapi\Statement - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Statement - - - - - mysql_xdevapi\Statement - - - - &Constants; - - const - int - mysql_xdevapi\Statement::EXECUTE_ASYNC - 1 - - - const - int - mysql_xdevapi\Statement::BUFFERED - 2 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - mysql_xdevapi\Statement::EXECUTE_ASYNC - - - - - - - mysql_xdevapi\Statement::BUFFERED - - - - - - -
    - - - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.statement; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.table.xml b/reference/mysql_xdevapi/mysql-xdevapi.table.xml deleted file mode 100644 index 39f3d560a7..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.table.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - Classe Table - mysql_xdevapi\Table - - - - -
    - &reftitle.intro; - - Fournit un accès à la table à travers des déclarations INSERT/SELECT/UPDATE/DELETE. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Table - - - - - mysql_xdevapi\Table - - - - mysql_xdevapi\SchemaObject - - - - &Properties; - - public - name - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - name - - - - - -
    - - - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.table; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml b/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml deleted file mode 100644 index b856eeea34..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Classe TableDelete - mysql_xdevapi\TableDelete - - - - -
    - &reftitle.intro; - - Une déclaration pour des opérations de suppression sur une Table. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\TableDelete - - - - - mysql_xdevapi\TableDelete - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.tabledelete; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml b/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml deleted file mode 100644 index 02bcfd7fce..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Classe TableInsert - mysql_xdevapi\TableInsert - - - - -
    - &reftitle.intro; - - Une déclaration pour des opérations d'insertion sur une Table. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\TableInsert - - - - - mysql_xdevapi\TableInsert - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.tableinsert; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml b/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml deleted file mode 100644 index 6de7aeb2b5..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Classe TableSelect - mysql_xdevapi\TableSelect - - - - -
    - &reftitle.intro; - - Une déclaration pour des opérations de récupération d'entrées sur une Table. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\TableSelect - - - - - mysql_xdevapi\TableSelect - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.tableselect; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml b/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml deleted file mode 100644 index 7976fbefbd..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Classe TableUpdate - mysql_xdevapi\TableUpdate - - - - -
    - &reftitle.intro; - - Une déclaration pour des opérations de mises à jour sur une Table. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\TableUpdate - - - - - mysql_xdevapi\TableUpdate - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.tableupdate; - -     - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.warning.xml b/reference/mysql_xdevapi/mysql-xdevapi.warning.xml deleted file mode 100644 index 85ef019320..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.warning.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - Classe Warning - mysql_xdevapi\Warning - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Warning - - - - - mysql_xdevapi\Warning - - - - &Properties; - - public - message - - - public - level - - - public - code - - - - Constructeur - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - level - - - - - - code - - - - - -
    - - - -     - - &reference.mysql-xdevapi.mysql-xdevapi.entities.warning; - -     - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml deleted file mode 100644 index 8f0e06d1df..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - BaseResult::getWarnings - Récupère les avertissements de la dernière opération - - - - &reftitle.description; - - abstract public arraymysql_xdevapi\BaseResult::getWarnings - - - - Récupère les avertissements générés par la dernière opération du serveur MySQL. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau d'objets Warning de la dernière opération. Chaque objet - définit un 'message' d'erreur, un 'niveau' d'erreur et un 'code' d'erreur. Un tableau - vide est retourné s'il n'y a pas d'erreurs. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\RowResult::getWarnings</function> - -sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); -$warnings = $res->getWarnings(); - -print_r($warnings); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) - [1] => mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml deleted file mode 100644 index 258e882c67..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - BaseResult::getWarningsCount - Récupère le nombre d'avertissements de la dernière opération - - - - &reftitle.description; - - abstract public intmysql_xdevapi\BaseResult::getWarningsCount - - - - Renvoie le nombre d'avertissements générés par la dernière opération. Plus précisément, - ces avertissements sont générés par le serveur MySQL. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre d'avertissements de la dernière opération. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\RowResult::getWarningsCount</function> - -sql("DROP DATABASE IF EXISTS foo")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); - -echo $res->getWarningsCount(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml b/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml deleted file mode 100644 index 4757fbbf5c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - mysql_xdevapi\Client::close - Ferme le client - - - - &reftitle.description; - - public boolmysql_xdevapi\Client::close - - - - Ferme toutes les connexions client avec le serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si les connexions sont fermées. - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml deleted file mode 100644 index f2639cb7a4..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Client::__construct - Constructeur du client - - - - &reftitle.description; - - private mysql_xdevapi\Client::__construct - - - - Construit un objet client. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Client::__construct</function> - -getSession(); -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml deleted file mode 100644 index 4680d430c3..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Client::getClient - Renvoie la session client - - - - &reftitle.description; - - public mysql_xdevapi\Sessionmysql_xdevapi\Client::getSession - - - - Renvoie la session associée au client. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet Session. - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml deleted file mode 100644 index 4e8185e292..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - Collection::add - Ajoute un document à la collection - - - - &reftitle.description; - - public mysql_xdevapi\CollectionAddmysql_xdevapi\Collection::add - mixeddocument - - - Déclenche l'insertion du ou des documents donnés dans la collection, et - plusieurs variantes de cette méthode sont prises en charge. Les options incluent : - - - - - Ajouter un seul document sous forme de chaîne JSON. - - - - - Ajouter un seul document sous forme de tableau comme : - [ 'field' => 'value', 'field2' => 'value2' ... ] - - - - - Un mélange des deux, et plusieurs documents peuvent être ajoutés dans la même opération. - - - - - - - &reftitle.parameters; - - - document - - - Un ou plusieurs documents, et cela peut être soit du JSON ou un tableau de champs avec - leurs valeurs associées. Cela ne peut pas être un tableau vide. - - - Le serveur MySQL génère automatiquement des valeurs _id uniques pour - chaque document (recommandé), bien que cela puisse également être ajouté manuellement. Cette - valeur doit être unique, sinon l'opération d'ajout échouera. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionAdd. Utiliser execute() pour retourner un résultat qui peut être utilisé pour - interroger le nombre d'éléments affectés, le nombre d'avertissements générés par l'opération, ou pour - récupérer une liste d'identifiants générés pour les documents insérés. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::add</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -// Ajoute deux documents -$collection->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute(); -$collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -// Ajoute deux documents en utilisant un seul objet JSON -$result = $collection->add( - '{"name": "Bernie", - "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}')->execute(); - -// Récupère une liste d'identifiants générés à partir du dernier add() -$ids = $result->getGeneratedIds(); -print_r($ids); -?> -]]> - - &example.outputs.similar; - - 00005b6b53610000000000000056 - [1] => 00005b6b53610000000000000057 -) -]]> - - - - - - &reftitle.notes; - - - Un identifiant unique _id est généré par MySQL Server 8.0 ou supérieur, comme démontré - dans l'exemple. Le champ _id doit être défini manuellement si on utilise - MySQL Server 5.7. - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml deleted file mode 100644 index da9f6a93b6..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - Collection::addOrReplaceOne - Ajoute ou remplace un document de la collection - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Collection::addOrReplaceOne - stringid - stringdoc - - - Ajoute un nouveau document, ou remplace un document s'il existe déjà. - - - Il existe plusieurs scénarios pour cette méthode : - - - - - Ni l'id ni aucune valeur de clé unique ne sont en conflit avec un document de la collection, - alors le document est ajouté. - - - - - Si l'id ne correspond à aucun document, mais qu'une ou plusieurs valeurs de clé unique - entrent en conflit avec un document de la collection, alors une erreur est lancée. - - - - - Si l'id correspond à un document existant et qu'aucune clé unique n'est définie pour la collection, - alors le document est remplacé. - - - - - Si l'id correspond à un document existant, et que toutes les clés uniques du document de remplacement - correspondent à ce même document ou ne sont en conflit avec aucun autre document de la collection, - alors le document est remplacé. - - - - - Si l'id correspond à un document existant, et qu'une ou plusieurs clés uniques correspondent à un autre - document de la collection, alors une erreur est lancée. - - - - - - - - &reftitle.parameters; - - - id - - - Ceci est l'identifiant du filtre. Si cet identifiant ou tout autre champ qui a un index unique existe déjà - dans la collection, alors il mettra à jour le document correspondant. - - - Par défaut, cet identifiant est généré automatiquement par le serveur MySQL lorsque le document a été ajouté, - et est référencé en tant que champ nommé '_id'. - - - - - doc - - - Ceci est le document à ajouter ou remplacer, qui est une chaîne JSON. - - - - - - - - &reftitle.returnvalues; - - Un objet Result. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::addOrReplaceOne</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -// Utiliser add() -$result = $collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -// Utiliser addOrReplaceOne() -// Note: nous passons ici une valeur _id connue -$result = $collection->addOrReplaceOne('00005b6b53610000000000000056', '{"name": "Fred", "age": 21, "job": "Construction"}'); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml deleted file mode 100644 index ac38ee1597..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Collection::__construct - Constructeur de Collection - - - - &reftitle.description; - - private mysql_xdevapi\Collection::__construct - - - - Construit un objet Collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::getOne</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection->add('{"name": "Alfred", "age": 42, "job": "Butler"}')->execute(); - -// Un identifiant unique _id est généré par MySQL Server -// Ceci récupère les _id générés; un seul dans cet exemple, donc $ids[0] -$ids = $result->getGeneratedIds(); -$alfreds_id = $ids[0]; - -// ... - -print_r($alfreds_id); -print_r($collection->getOne($alfreds_id)); -?> -]]> - - &example.outputs.similar; - - 00005b6b536100000000000000b1 - [age] => 42 - [job] => Butler - [name] => Alfred -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml deleted file mode 100644 index a3b949d2a1..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Collection::count - Renvoie le nombre de documents - - - - &reftitle.description; - - public intmysql_xdevapi\Collection::count - - - - Cette fonctionnalité est similaire à une opération SQL SELECT COUNT(*) - sur le serveur MySQL pour le schéma et la collection actuels. - En d'autres termes, elle compte le nombre de documents dans la collection. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre de documents dans la collection. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::count</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "jobs": [ - {"title":"Cat Herder","Salary":42000}, - {"title":"Father","Salary":0} - ], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [ - {"title":"Scientist","Salary":18000}, - {"title":"Mother","Salary":0} - ], - "hobbies": ["Walking","Making pies"]}') - ->execute(); - -var_dump($collection->count()); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml deleted file mode 100644 index f1b7681ac4..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - Collection::createIndex - Créer un index de collection - - - - &reftitle.description; - - public voidmysql_xdevapi\Collection::createIndex - stringindex_name - stringindex_desc_json - - - Créer un index sur la collection. - - - Une exception est lancée si un index portant le même nom existe déjà, - ou si la définition de l'index n'est pas correctement formée. - - - - - &reftitle.parameters; - - - index_name - - - Le nom de l'index à créer. Ce nom doit être un nom d'index valide tel que - accepté par la requête SQL CREATE INDEX. - - - - - index_desc_json - - - La définition de l'index à créer. Elle contient un tableau d'objets IndexField, - et chaque objet décrit un seul membre de document à inclure dans l'index, - et une chaîne facultative pour le type d'index qui pourrait être INDEX (par défaut) ou SPATIAL. - - - Une description IndexField unique se compose des champs suivants : - - - - - field: chaîne, le chemin complet du document vers le membre du document ou le champ à indexer. - - - - - type: chaîne, l'un des types de colonnes SQL pris en charge pour mapper le champ. - Pour les types numériques, le mot-clé facultatif UNSIGNED peut suivre. - Pour le type TEXT, la longueur à considérer pour l'indexation peut être ajoutée. - - - - - required: booléen, (facultatif) true si le champ doit exister dans le document. - Par défaut à &false;, sauf pour GEOJSON où il est par défaut à &true;. - - - - - options: entier, (facultatif) drapeaux d'options spéciaux à utiliser - lors du décodage de données GEOJSON. - - - - - srid: entier, (facultatif) valeur srid à utiliser lors - du décodage de données GEOJSON. - - - - - - C'est une erreur d'inclure d'autres champs non décrits ci-dessus dans - les documents IndexDefinition ou IndexField. - - - - - - - - &reftitle.returnvalues; - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::createIndex</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -// Créer un index de texte -$collection->createIndex( - 'myindex1', - '{"fields": [{ - "field": "$.name", - "type": "TEXT(25)", - "required": true}], - "unique": false}' -); - -// Un index spatial -$collection->createIndex( - 'myindex2', - '{"fields": [{ - "field": "$.home", - "type": "GEOJSON", - "required": true}], - "type": "SPATIAL"}' -); - -// Index avec plusieurs champs -$collection->createIndex( - 'myindex3', - '{"fields": [ - { - "field": "$.name", - "type": "TEXT(20)", - "required": true - }, - { - "field": "$.age", - "type": "INTEGER" - }, - { - "field": "$.job", - "type": "TEXT(30)", - "required": false - } - ], - "unique": true - }' -); -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml deleted file mode 100644 index 4d93efef1a..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Collection::dropIndex - Supprime un index de collection - - - - &reftitle.description; - - public boolmysql_xdevapi\Collection::dropIndex - stringindex_name - - - Supprime un index de collection. - - - Cette opération ne lance pas d'erreur si l'index n'existe pas, mais - &false; est retourné dans ce cas. - - - - - &reftitle.parameters; - - - index_name - - - Le nom de l'index de collection à supprimer. - - - - - - - - &reftitle.returnvalues; - - &true; si l'opération DROP INDEX a réussi, sinon &false;. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::dropIndex</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -// ... - -$collection = $schema->getCollection("people"); - -$collection->createIndex( - 'myindex', - '{"fields": [{"field": "$.name", "type": "TEXT(25)", "required": true}], "unique": false}' -); - -// ... - -if ($collection->dropIndex('myindex')) { - echo "An index named 'myindex' was found, and dropped."; -} -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml deleted file mode 100644 index 6df8a1d0a1..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Collection::existsInDatabase - Vérifie si la collection existe dans la base de données - - - - &reftitle.description; - - public boolmysql_xdevapi\Collection::existsInDatabase - - - - Vérifie si l'objet Collection fait référence à une collection dans la base de données (schéma). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si la collection existe dans la base de données, sinon &false; si elle n'existe pas. - - - Une table définie avec deux colonnes (doc et _id) est considérée comme une collection, - et une troisième colonne _json_schema à partir de MySQL 8.0.21. - Ajouter une colonne supplémentaire signifie que existsInDatabase() ne la verra plus comme une collection. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::existsInDatabase</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -// ... - -$collection = $schema->getCollection("people"); - -// ... - -if (!$collection->existsInDatabase()) { - echo "The collection no longer exists in the database named addressbook. What happened?"; -} -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml deleted file mode 100644 index 06246eadbe..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Collection::find - Recherche de document - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\Collection::find - stringsearch_condition - - - Recherche une collection de base de données pour un document ou un ensemble de documents. Les - documents trouvés sont retournés sous forme d'un objet CollectionFind pour - les modifier ou récupérer des résultats supplémentaires. - - - - - &reftitle.parameters; - - - search_condition - - - Bien que facultative, normalement une condition est définie pour limiter les résultats - à un sous-ensemble de documents. - - - Plusieurs éléments peuvent construire la condition et la syntaxe supporte la liaison de paramètres. - L'expression utilisée comme condition de recherche doit être une expression SQL valide. - Si aucune condition de recherche n'est fournie (champ vide) alors find('true') est supposé. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionFind pour vérifier l'opération, - ou récupérer les documents trouvés. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::find</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$collection->add('{"name": "Bob", "age": 19, "job": "Swimmer"}')->execute(); -$collection->add('{"name": "Fred", "age": 20, "job": "Construction"}')->execute(); -$collection->add('{"name": "Wilma", "age": 21, "job": "Teacher"}')->execute(); -$collection->add('{"name": "Suki", "age": 22, "job": "Teacher"}')->execute(); - -$find = $collection->find('job LIKE :job AND age > :age'); -$result = $find - ->bind(['job' => 'Teacher', 'age' => 20]) - ->sort('age DESC') - ->limit(2) - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs; - - Array - ( - [_id] => 00005b6b536100000000000000a8 - [age] => 22 - [job] => Teacher - [name] => Suki - ) - [1] => Array - ( - [_id] => 00005b6b536100000000000000a7 - [age] => 21 - [job] => Teacher - [name] => Wilma - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml deleted file mode 100644 index e449ce4e84..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Collection::getName - Renvoie le nom de la collection - - - - &reftitle.description; - - public stringmysql_xdevapi\Collection::getName - - - - Renvoie le nom de la collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom de la collection, sous forme de chaîne de caractères. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::getName</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - - -// ... - -var_dump($collection->getName()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getone.xml deleted file mode 100644 index e23d5b7e9e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getone.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Collection::getOne - Renvoie un document - - - - &reftitle.description; - - public Documentmysql_xdevapi\Collection::getOne - stringid - - - Récupère un document de la collection. - - - Ceci est un raccourci pour : - Collection.find("_id = :id").bind("id", id).execute().fetchOne(); - - - - - &reftitle.parameters; - - - id - - - Le _id du document dans la collection. - - - - - - - - &reftitle.returnvalues; - - L'objet collection, ou &null; si l'_id ne correspond pas à un document. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::getOne</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection->add('{"name": "Alfred", "age": 42, "job": "Butler"}')->execute(); - -// Un identifiant unique _id (par défaut, et recommandé) est généré par MySQL Server -// Ceci récupère les _id générés; un seul dans cet exemple, donc $ids[0] -$ids = $result->getGeneratedIds(); -$alfreds_id = $ids[0]; - -// ... - -print_r($alfreds_id); -print_r($collection->getOne($alfreds_id)); -?> -]]> - - &example.outputs.similar; - - 00005b6b536100000000000000b1 - [age] => 42 - [job] => Butler - [name] => Alfred -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml deleted file mode 100644 index a33df5b41b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Collection::getSchema - Renvoie l'objet schéma - - - - &reftitle.description; - - public Schema Objectmysql_xdevapi\Collection::getSchema - - - - Renvoie l'objet schéma qui contient la collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet schéma en cas de succès, ou &null; si l'objet ne peut pas être récupéré - pour la collection donnée. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::getSchema</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -var_dump($collection->getSchema()); -?> -]]> - - &example.outputs.similar; - - - string(11) "addressbook" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml deleted file mode 100644 index 5ecbb5e356..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Collection::getSession - Renvoie l'objet session - - - - &reftitle.description; - - public Sessionmysql_xdevapi\Collection::getSession - - - - Renvoie un nouvel objet Session à partir de l'objet Collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet Session. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::getSession</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -// ... - -$newsession = $collection->getSession(); - -var_dump($session); -var_dump($newsession); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/modify.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/modify.xml deleted file mode 100644 index ba98294337..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/modify.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Collection::modify - Modifie les documents de la collection - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\Collection::modify - stringsearch_condition - - - Modifie les documents d'une collection qui répondent à des conditions de recherche spécifiques. - Plusieurs opérations sont autorisées, et la liaison de paramètres - est supportée. - - - - - &reftitle.parameters; - - - search_condition - - - Doit être une expression SQL valide utilisée pour faire correspondre les documents à modifier. - Cette expression peut être aussi simple que &true;, qui correspond à tous les - documents, ou elle peut utiliser des fonctions et des opérateurs tels que - 'CAST(_id AS SIGNED) >= 10', - 'age MOD 2 = 0 OR age MOD 3 = 0', ou - '_id IN ["2","5","7","10"]'. - - - - - - - - &reftitle.returnvalues; - - Si l'opération n'est pas exécutée, alors la fonction retournera - un objet Modify qui peut être utilisé pour ajouter des opérations - de modification supplémentaires. - - - Si l'opération de modification est exécutée, alors l'objet retourné contiendra le - résultat de l'opération. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::modify</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$collection->add('{"name": "Bob", "age": 19, "job": "Painter"}')->execute(); - -// Ajoute deux nouveaux jobs pour tous les Painters: Artist et Crafter -$collection - ->modify("job in ('Butler', 'Painter')") - ->arrayAppend('job', 'Artist') - ->arrayAppend('job', 'Crafter') - ->execute(); - -// Enlève le champ 'beer' de tous les documents avec l'âge 21 -$collection - ->modify('age < 21') - ->unset(['beer']) - ->execute(); -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/remove.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/remove.xml deleted file mode 100644 index a06f69fba2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/remove.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Collection::remove - Enlève des documents de la collection - - - - &reftitle.description; - - public mysql_xdevapi\CollectionRemovemysql_xdevapi\Collection::remove - stringsearch_condition - - - Enlève des documents d'une collection qui répondent à des conditions de recherche spécifiques. - Plusieurs opérations sont autorisées, et la liaison de paramètres est supportée. - - - - - &reftitle.parameters; - - - search_condition - - - Doit être une expression SQL valide utilisée pour faire correspondre les documents à modifier. - Cette expression peut être aussi simple que &true;, qui correspond à tous les - documents, ou elle peut utiliser des fonctions et des opérateurs tels que - 'CAST(_id AS SIGNED) >= 10', - 'age MOD 2 = 0 OR age MOD 3 = 0', ou - '_id IN ["2","5","7","10"]'. - - - - - - - - &reftitle.returnvalues; - - Si l'opération n'est pas exécutée, alors la fonction retournera - un objet Remove qui peut être utilisé pour ajouter des opérations - de suppression supplémentaires. - - - Si l'opération de suppression est exécutée, alors l'objet retourné contiendra le - résultat de l'opération. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::remove</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$collection->add('{"name": "Bob", "age": 19, "job": "Painter"}')->execute(); - -// Enlève tous les painters -$collection - ->remove("job in ('Painter')") - ->execute(); - -// Enlève le plus vieux butler -$collection - ->remove("job in ('Butler')") - ->sort('age desc') - ->limit(1) - ->execute(); - -// Enlève le record avec l'âge le plus élevé -$collection - ->remove('true') - ->sort('age desc') - ->limit(1) - ->execute(); -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/removeone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/removeone.xml deleted file mode 100644 index 920e0bc451..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/removeone.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Collection::removeOne - Enlève un document de la collection - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Collection::removeOne - stringid - - - Enlève un document de la collection avec l'ID correspondant. - Ceci est un raccourci pour Collection.remove("_id = :id").bind("id", id).execute(). - - - - - - &reftitle.parameters; - - - id - - - L'identifiant du document de la collection à enlever. Typiquement c'est - le _id généré par le serveur MySQL lors de l'ajout de l'enregistrement. - - - - - - - - &reftitle.returnvalues; - - Un objet Result qui peut être utilisé pour interroger le nombre d'éléments affectés - ou le nombre d'avertissements générés par l'opération. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::removeOne</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); - -// Normalement l'_id est connu par d'autres moyens, -// mais pour cet exemple, récupérons l'identifiant généré et utilisons-le -$ids = $result->getGeneratedIds(); -$alfred_id = $ids[0]; - -$result = $collection->removeOne($alfred_id); - -if(!$result->getAffectedItemsCount()) { - echo "Alfred with id $alfred_id was not removed."; -} else { - echo "Goodbye, Alfred, you can take _id $alfred_id with you."; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/replaceone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/replaceone.xml deleted file mode 100644 index 0ee37b3e1e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/replaceone.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Collection::replaceOne - Remplace un document de la collection - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Collection::replaceOne - stringid - stringdoc - - - Modifie (ou remplace) le document identifié par ID, s'il existe. - - - - - - &reftitle.parameters; - - - id - - - L'identifiant du document à remplacer ou mettre à jour. Typiquement c'est - le _id généré par le serveur MySQL lors de l'ajout de l'enregistrement. - - - - - doc - - - Le document de la collection à mettre à jour ou remplacer correspondant - au paramètre . - - - Ce document peut être soit un objet document, soit une chaîne JSON valide - décrivant le nouveau document. - - - - - - - - &reftitle.returnvalues; - - Un objet Result qui peut être utilisé pour interroger le nombre d'éléments affectés - et le nombre d'avertissements générés par l'opération. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::replaceOne</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); - -// Normalement l'_id est connu par d'autres moyens, -// mais pour cet exemple, récupérons l'identifiant généré et utilisons-le -$ids = $result->getGeneratedIds(); -$alfred_id = $ids[0]; - -// ... - -$alfred = $collection->getOne($alfred_id); -$alfred['age'] = 81; -$alfred['job'] = 'Guru'; - -$collection->replaceOne($alfred_id, $alfred); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/construct.xml deleted file mode 100644 index 03aecb7f94..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/construct.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - CollectionAdd::__construct - Constructeur de CollectionAdd - - - - &reftitle.description; - - private mysql_xdevapi\CollectionAdd::__construct - - - - Utiliser pour ajouter un document à une collection; appelé depuis un objet Collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionAdd::__construct</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -// Ajoute deux documents -$collection - ->add('{"name": "Fred", "age": 21, "job": "Construction"}') - ->execute(); - -$collection - ->add('{"name": "Wilma", "age": 23, "job": "Teacher"}') - ->execute(); - -// Ajoute deux documents en utilisant un seul objet JSON -$result = $collection - ->add( - '{"name": "Bernie", - "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}') - ->execute(); - -// Récupère une liste d'ID générés par le dernier add() -$ids = $result->getGeneratedIds(); -print_r($ids); - -?> -]]> - - &example.outputs.similar; - - 00005b6b53610000000000000056 - [1] => 00005b6b53610000000000000057 -) -]]> - - - - - - &reftitle.notes; - - - Un identifiant unique _id est généré par MySQL Server 8.0 ou supérieur, comme démontré - dans l'exemple. Le champ _id doit être défini manuellement si on utilise - MySQL Server 5.7. - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/execute.xml deleted file mode 100644 index 9f78fbf783..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/execute.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - CollectionAdd::execute - Exécute la déclaration - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\CollectionAdd::execute - - - - La méthode execute est requise pour envoyer la demande d'opération CRUD - au serveur MySQL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet Result qui peut être utilisé pour vérifier l'état de l'opération, - tel que le nombre de lignes affectées. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionAdd::execute</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -// Ajoute deux documents -$collection - ->add('{"name": "Fred", "age": 21, "job": "Construction"}') - ->execute(); - -$collection - ->add('{"name": "Wilma", "age": 23, "job": "Teacher"}') - ->execute(); - -// Ajoute deux documents en utilisant un seul objet JSON -$result = $collection - ->add( - '{"name": "Bernie", - "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}') - ->execute(); - -// Récupère une liste d'ID générés par le dernier add() -$ids = $result->getGeneratedIds(); -print_r($ids); -?> -]]> - - &example.outputs.similar; - - 00005b6b53610000000000000056 - [1] => 00005b6b53610000000000000057 -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/bind.xml deleted file mode 100644 index 34caa46411..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/bind.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - CollectionFind::bind - Lie une valeur à un paramètre de requête - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::bind - arrayplaceholder_values - - - Cela permet à l'utilisateur de lier un paramètre à l'espace réservé dans la condition de recherche de l'opération find. - L'espace réservé a la forme de :NOM où ':' est un préfixe commun qui doit toujours exister avant tout NOM, - Nom est le nom réel de l'espace réservé. La fonction bind accepte une liste d'espaces reservés si plusieurs - entités doivent être substituées dans la condition de recherche. - - - - - - - &reftitle.parameters; - - - placeholder_values - - - Les valeurs à substituer dans la condition de recherche; plusieurs valeurs sont autorisées - et sont passées sous forme de tableau où "NOM_ESPACE_RESERVE => VALEUR_ESPACE_RESERVE". - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionFind, - ou chaîné avec execute() pour retourner un objet Result. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionFind::bind</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$result = $create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000cf" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/construct.xml deleted file mode 100644 index 7f875e29e6..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/construct.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - CollectionFind::__construct - Constructeur de CollectionFind - - - - &reftitle.description; - - private mysql_xdevapi\CollectionFind::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de CollectionFind - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$result = $create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000cf" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml deleted file mode 100644 index af6cd96310..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - CollectionFind::execute - Exécute la déclaration - - - - &reftitle.description; - - public mysql_xdevapi\DocResultmysql_xdevapi\CollectionFind::execute - - - - Exécute l'opération de recherche; - cette fonctionnalité permet le chaînage des méthodes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet mysql_xdevapi\DocResult, qui peut être utilisé - pour récupérer les résultats, ou pour interroger l'état de l'opération. - - - - - &reftitle.examples; - - Exemple de CollectionFind - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000cf" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } -} -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/fields.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/fields.xml deleted file mode 100644 index a276db04fc..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/fields.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - CollectionFind::fields - Définit le filtre de champ de document - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::fields - stringprojection - - - Définit les colonnes pour la requête à retourner. Si non défini, - toutes les colonnes sont utilisées. - - - - - - &reftitle.parameters; - - - projection - - - Peut être une chaîne unique ou un tableau de chaînes identifiant les - colonnes à retourner pour chaque document correspondant à la condition de recherche. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionFind qui peut être utilisé pour un traitement ultérieur. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionFind::fields</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->fields('name') - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(1) { - ["name"]=> - string(6) "Alfred" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/groupby.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/groupby.xml deleted file mode 100644 index bd2258b5fe..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/groupby.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - CollectionFind::groupBy - Définit les critères de regroupement - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::groupBy - stringsort_expr - - - Cette fonction peut être utilisée pour regrouper le jeu de résultats par une ou plusieurs colonnes. - Elle est souvent utilisée avec des fonctions d'agrégation telles que COUNT, - MAX, MIN, SUM etc. - - - - - &reftitle.parameters; - - - sort_expr - - - La ou les colonnes qui doivent être utilisées pour l'opération de regroupement, cela peut être soit une chaîne unique - soit un tableau d'arguments de chaîne, un pour chaque colonne. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionFind qui peut être utilisé pour un traitement ultérieur. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionFind::groupBy</function> - -find()->groupBy('name')->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/having.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/having.xml deleted file mode 100644 index fc3f3914f9..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/having.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - CollectionFind::having - Définit la condition pour les fonctions d'agrégation - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::having - stringsort_expr - - - Cette fonction peut être utilisée après l'opération 'field' afin de faire une sélection sur les documents à extraire. - - - - - - &reftitle.parameters; - - - sort_expr - - - Cela doit être une expression SQL valide, l'utilisation de fonctions d'agrégation est autorisée - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionFind qui peut être utilisé pour un traitement ultérieur. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionFind::having</function> - -find()->fields(['name','age'])->having('age > 40')->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/limit.xml deleted file mode 100644 index aa89c08fa7..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/limit.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - CollectionFind::limit - Limite le nombre de documents retournés - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::limit - introws - - - Définit le nombre maximum de documents à retourner. - - - - - &reftitle.parameters; - - - rows - - - Le nombre maximum de documents. - - - - - - - - &reftitle.returnvalues; - - Un objet mysql_xdevapi\CollectionFind qui peut être utilisé pour un traitement ultérieur; - chaînez avec la méthode execute() pour retourner un objet DocResult. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionFind::limit</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); -$create - ->add('{"name": "Reginald", "age": 42, "job": "Butler"}') - ->execute(); - - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->limit(1) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000f3" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockexclusive.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockexclusive.xml deleted file mode 100644 index cc1bf81427..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockexclusive.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - CollectionFind::lockExclusive - Exécute l'opération avec un VERROU EXCLUSIF - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::lockExclusive - intlock_waiting_option - - - Verrouille le document de manière exclusive. - Tant que le document est verrouillé, - d'autres transactions ne peuvent pas mettre à jour le document, - utiliser SELECT ... LOCK IN SHARE MODE, - ou lire les données dans certains niveaux d'isolation de transaction. - Les lectures cohérentes ignorent les verrous définis sur les enregistrements qui existent dans la vue de lecture. - - - Pour éviter les problèmes de concurrence, il est logique d'utiliser cette fonction avec la méthode - mysql_xdevapi\Collection::modify. Essentiellement, cette fonction utilise des verrous de ligne pour sérialiser - l'accès aux lignes. - - - - - &reftitle.parameters; - - - lock_waiting_option - - - Une option d'attente facultative. Par défaut, c'est MYSQLX_LOCK_DEFAULT. Les valeurs valides sont ces constantes : - - - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED - - - - - - - - &reftitle.returnvalues; - - Renvoie un objet CollectionFind qui peut être utilisé pour un traitement ultérieur. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionFind::lockExclusive</function> - -getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$session->startTransaction(); - -$result = $collection - ->find("age > 50") - ->lockExclusive() - ->execute(); - -// ... faire une opération sur l'objet - -// Valider la transaction et déverrouiller le document -$session->commit(); -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockshared.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockshared.xml deleted file mode 100644 index a52f08fdee..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockshared.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - CollectionFind::lockShared - Exécute l'opération avec un VERROU PARTAGE - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::lockShared - intlock_waiting_option - - - Autorise le partage des documents entre plusieurs transactions qui sont verrouillées en mode partagé. - - - D'autres sessions peuvent lire les lignes, mais ne peuvent pas les modifier tant que la transaction n'a pas validé. - - - Si l'une de ces lignes a été modifiée par une autre transaction qui n'a pas été validée, - la requête attendra que cette transaction soit terminée pour pouvoir utiliser les dernières valeurs. - - - - - &reftitle.parameters; - - - lock_waiting_option - - - Une option d'attente facultative. Par défaut, c'est MYSQLX_LOCK_DEFAULT. Les valeurs valides sont ces constantes : - - - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionFind qui peut être utilisé pour un traitement ultérieur. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionFind::lockShared</function> - -getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$session->startTransaction(); - -$result = $collection - ->find("age > 50") - ->lockShared() - ->execute(); - -// ... lire l'objet en mode partagé - -// Valider la transaction et déverrouiller le document -$session->commit(); -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/offset.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/offset.xml deleted file mode 100644 index 69296ff2dd..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/offset.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - CollectionFind::offset - Ignore un nombre donné d'éléments à retourner - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::offset - intposition - - - Ignore (décale) un nombre donné d'éléments qui autrement seraient retournés - par l'opération find. Utiliser avec la méthode limit(). - - - Définir un décalage plus grand que la taille de l'ensemble de résultats donne un ensemble vide. - - - - - &reftitle.parameters; - - - position - - - Le nombre d'éléments à ignorer pour l'opération limit(). - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionFind qui peut être utilisé pour un traitement ultérieur. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionFind::offset</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); -$create - ->add('{"name": "Reginald", "age": 42, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find() - ->sort('age asc') - ->offset(1) - ->limit(1) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000f3" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/sort.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/sort.xml deleted file mode 100644 index 018b5f3bab..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/sort.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CollectionFind::sort - Définit les critères de tri - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::sort - stringsort_expr - - - Trie le jeu de résultats par le champ sélectionné dans l'argument sort_expr. Les ordres - autorisés sont ASC (Ascendant) ou DESC (Descendant). Cette opération est équivalente à l'opération 'ORDER BY' SQL - et suit le même ensemble de règles. - - - - - - &reftitle.parameters; - - - sort_expr - - - Une ou plusieurs expressions de tri peuvent être fournies. L'évaluation se fait de gauche à droite, - et chaque expression est séparée par une virgule. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionFind qui peut être utilisé pour exécuter la commande, ou pour ajouter des opérations supplémentaires. - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionFind::sort</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); -$create - ->add('{"name": "Reginald", "age": 42, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find() - ->sort('job desc', 'age asc') - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b53610000000000000106" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } - [1]=> - array(4) { - ["_id"]=> - string(28) "00005b6b53610000000000000107" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayappend.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayappend.xml deleted file mode 100644 index dd8f92bc7d..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayappend.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - CollectionModify::arrayAppend - Ajoute un élément à un champ de tableau - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::arrayAppend - stringcollection_field - stringexpression_or_literal - - - Ajoute un élément à un champ d'un document, car plusieurs éléments d'un champ sont représentés sous forme de tableau. - Contrairement à arrayInsert(), arrayAppend() ajoute toujours le nouvel élément - à la fin du tableau, alors que arrayInsert() peut définir l'emplacement. - - - - - &reftitle.parameters; - - - collection_field - - - L'identifiant du champ où le nouvel élément est inséré. - - - - - expression_or_literal - - - Le nouvel élément à insérer à la fin du tableau du champ du document. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionModify qui peut être utilisé pour exécuter la commande, ou pour ajouter des opérations supplémentaires. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionModify::arrayAppend</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name in ('Bernie', 'Jane')") - ->arrayAppend('traits', 'Happy') - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b5361000000000000010c - [name] => Bernie - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - [3] => Happy - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayinsert.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayinsert.xml deleted file mode 100644 index 0589b13332..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayinsert.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - CollectionModify::arrayInsert - Insère un élément dans un champ de tableau - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::arrayInsert - stringcollection_field - stringexpression_or_literal - - - Ajoute un élément à un champ d'un document, car plusieurs éléments d'un champ sont - représentés sous forme de tableau. Contrairement à - mysql_xdevapi\CollectionModify::arrayAppend cette méthode - permet de spécifier où le nouvel élément est inséré en définissant après quel élément, - alors que - mysql_xdevapi\CollectionModify::arrayAppend ajoute toujours - le nouvel élément à la fin du tableau. - - - - - &reftitle.parameters; - - - collection_field - - - Identifie l'élément du tableau après lequel le nouvel élément sera inséré. - Le format de ce paramètre est - FIELD_NAME[ INDEX ] où - FIELD_NAME est le nom du champ du document - où ajouter l'élément, et INDEX - est l'INDEX de l'élément dans le champ. - - - L'INDEX est basé sur zéro, donc le premier élément du tableau a un index de 0. - - - - - expression_or_literal - - - Le nouvel élément à insérer après FIELD_NAME[ INDEX ] - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionModify qui peut être utilisé pour exécuter la commande, ou pour ajouter des opérations supplémentaires. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionModify::arrayInsert</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name in ('Bernie', 'Jane')") - ->arrayInsert('traits[1]', 'Happy') - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b5361000000000000010d - [name] => Bernie - [traits] => Array - ( - [0] => Friend - [1] => Happy - [2] => Brother - [3] => Human - ) - ) -) -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/bind.xml deleted file mode 100644 index ae305415fe..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/bind.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - CollectionModify::bind - Lie une valeur à un paramètre de requête - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::bind - arrayplaceholder_values - - - Lie un paramètre à un espace réservé dans la condition de recherche de l'opération de modification. - - - L'espace réservé a la forme de :NOM où ':' est un préfixe commun qui doit toujours exister avant tout NOM - où NOM est le nom de l'espace réservé. La méthode bind accepte une liste d'espaces réservés si plusieurs - entités doivent être substituées dans la condition de recherche de l'opération de modification. - - - - - - &reftitle.parameters; - - - placeholder_values - - - Les valeurs d'espace réservé à substituer dans la condition de recherche. Plusieurs valeurs sont autorisées - et doivent être passées sous forme de tableau de mappages NOM_ESPACE_RESERVE->VALEUR_ESPACE_RESERVE. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionModify qui peut être utilisé pour exécuter la commande, ou pour ajouter des opérations supplémentaires. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionModify::bind</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name = :name") - ->bind(['name' => 'Bernie']) - ->arrayAppend('traits', 'Happy') - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b53610000000000000110 - [name] => Bernie - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - [3] => Happy - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/construct.xml deleted file mode 100644 index a18a35a1c6..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - CollectionModify::__construct - Constructeur de CollectionModify - - - - &reftitle.description; - - private mysql_xdevapi\CollectionModify::__construct - - - - Modifie (met à jour) une collection et est instancié par la méthode - mysql_xdevapi\Collection::modify. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionModify::__construct</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name in ('Bernie', 'Jane')") - ->arrayAppend('traits', 'Happy') - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b5361000000000000010c - [name] => Bernie - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - [3] => Happy - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/execute.xml deleted file mode 100644 index 9e418947c6..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/execute.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - CollectionModify::execute - Exécute l'opération de modification - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\CollectionModify::execute - - - - La méthode execute est requise pour envoyer la requête d'opération CRUD - au serveur MySQL. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet Result qui peut être utilisé pour vérifier le statut de l'opération, - tel que le nombre de lignes affectées. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionModify::execute</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/limit.xml deleted file mode 100644 index d74a1e659f..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/limit.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - CollectionModify::limit - Limite le nombre de documents modifiés - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::limit - introws - - - Limite le nombre de documents modifiés par cette opération. - Combine éventuellement avec skip() pour définir une valeur de décalage. - - - - - &reftitle.parameters; - - - rows - - - Le nombre maximum de documents à modifier. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionModify. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionModify::limit</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute(); -$collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); -$collection->add('{"name": "Betty", "age": 24, "job": "Teacher"}')->execute(); - -$collection - ->modify("job = :job") - ->bind(['job' => 'Teacher']) - ->set('job', 'Principal') - ->limit(1) - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b53610000000000000118 - [age] => 21 - [job] => Construction - [name] => Fred - ) - [1] => Array - ( - [_id] => 00005b6b53610000000000000119 - [age] => 23 - [job] => Principal - [name] => Wilma - ) - [2] => Array - ( - [_id] => 00005b6b5361000000000000011a - [age] => 24 - [job] => Teacher - [name] => Betty - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/patch.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/patch.xml deleted file mode 100644 index b13569672e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/patch.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - CollectionModify::patch - Corrige un document - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::patch - stringdocument - - - Prend un objet patch et l'applique sur un ou plusieurs documents, et - peut mettre à jour plusieurs propriétés de document. - - - - - &reftitle.parameters; - - - document - - - Un document avec les propriétés à appliquer aux documents correspondants. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionModify. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionModify::patch</function> - -modify('"Programmatore" IN job')->patch('{"Hobby" : "Programmare"}')->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml deleted file mode 100644 index 1fe10cdbba..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - CollectionModify::replace - Remplace un champ de document - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::replace - stringcollection_field - stringexpression_or_literal - - - Remplace (met à jour) une valeur de champ donnée par une nouvelle. - - - - - &reftitle.parameters; - - - collection_field - - - Le chemin du document de l'élément à définir. - - - - - expression_or_literal - - - La valeur à définir sur l'attribut spécifié. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionModify. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionModify::replace</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name = :name") - ->bind(['name' => 'Bernie']) - ->replace("name", "Bern") - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b5361000000000000011b - [name] => Bern - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/set.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/set.xml deleted file mode 100644 index 48ad82423e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/set.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - CollectionModify::set - Définit un attribut de document - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::set - stringcollection_field - stringexpression_or_literal - - - Définit ou met à jour des attributs sur des documents dans une collection. - - - - - &reftitle.parameters; - - - collection_field - - - Le chemin (nom) du document de l'élément à définir. - - - - - expression_or_literal - - - La valeur à définir sur l'attribut spécifié. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionModify. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionModify::set</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name = :name") - ->bind(['name' => 'Bernie']) - ->set("name", "Bern") - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b53610000000000000111 - [name] => Bern - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/skip.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/skip.xml deleted file mode 100644 index 6f0464f812..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/skip.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - CollectionModify::skip - Ignore les éléments - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::skip - intposition - - - Ignore les N premiers éléments qui seraient autrement retournés par une opération de recherche. - Si le nombre d'éléments ignorés est supérieur à la taille de l'ensemble de résultats, - alors l'opération de recherche renvoie un ensemble vide. - - - - - &reftitle.parameters; - - - position - - - Le nombre d'éléments à ignorer. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionModify à utiliser pour un traitement ultérieur. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionModify::skip</function> - -modify('age > :age')->sort('age desc')->unset(['age'])->bind(['age' => 20])->limit(4)->skip(1)->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/sort.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/sort.xml deleted file mode 100644 index f51ce7172a..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/sort.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - CollectionModify::sort - Définit les critères de tri - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::sort - stringsort_expr - - - Trie le jeu de résultats par le champ sélectionné dans l'argument sort_expr. Les ordres autorisés - sont ASC (Ascendant) ou DESC (Descendant). Cette opération est équivalente à l'opération SQL 'ORDER BY' - et suit le même ensemble de règles. - - - - - &reftitle.parameters; - - - sort_expr - - - Une ou plusieurs expressions de tri peuvent être fournies. L'évaluation se fait de - gauche à droite et chaque expression doit être séparée par une virgule. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionModify qui peut être utilisé pour un traitement ultérieur. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionModify::sort</function> - -modify('true')->sort('name desc', 'age asc')->limit(4)->set('Married', 'NO')->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml deleted file mode 100644 index d4f6d64157..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - CollectionModify::unset - Supprime la valeur des champs de document - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::unset - arrayfields - - - Supprime les attributs des documents dans une collection. - - - - - &reftitle.parameters; - - - fields - - - Les attributs à supprimer des documents dans une collection. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionModify qui peut être utilisé pour un traitement ultérieur. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionModify::unset</function> - -modify('job like :job_name')->unset(["age", "name"])->bind(['job_name' => 'Plumber'])->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/bind.xml deleted file mode 100644 index aa3af830e6..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/bind.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - CollectionRemove::bind - Lie une valeur à un paramètre - - - - &reftitle.description; - - public mysql_xdevapi\CollectionRemovemysql_xdevapi\CollectionRemove::bind - arrayplaceholder_values - - - Lie un paramètre à l'espace réservé dans la condition de recherche de l'opération de suppression. - - - L'espace réservé a la forme de :NAME où ':' est un préfixe commun qui doit toujours exister avant tout NAME - où NAME est le nom de l'espace réservé. La méthode bind accepte une liste d'espaces réservés si plusieurs - entités doivent être substituées dans la condition de recherche de l'opération de suppression. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - placeholder_values - - - La valeur de l'espace réservé à substituer dans la condition de recherche. Plusieurs valeurs sont autorisées - et doivent être passées sous la forme d'un tableau de mappages NOM_ESPACE_RESERVE->VALEUR_ESPACE_RESERVE. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionRemove qui peut être utilisé pour exécuter la commande, ou pour ajouter des opérations supplémentaires. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionRemove::bind</function> - -remove('age > :age_from and age < :age_to')->bind(['age_from' => 20, 'age_to' => 50])->limit(7)->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/construct.xml deleted file mode 100644 index e096c4ef20..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/construct.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - CollectionRemove::__construct - Constructeur de CollectionRemove - - - - &reftitle.description; - - private mysql_xdevapi\CollectionRemove::__construct - - - - Supprime les documents de la collection et est instancié par la méthode - mysql_xdevapi\Collection::remove. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Collection::remove</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$collection->add('{"name": "Bob", "age": 19, "job": "Painter"}')->execute(); - -// Supprime tous les peintres -$collection - ->remove("job in ('Painter')") - ->execute(); - -// Supprime le butler le plus âgé -$collection - ->remove("job in ('Butler')") - ->sort('age desc') - ->limit(1) - ->execute(); - -// Supprime l'enregistrement avec l'âge le plus bas -$collection - ->remove('true') - ->sort('age desc') - ->limit(1) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/execute.xml deleted file mode 100644 index 46d060ff60..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/execute.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - CollectionRemove::execute - Exécute l'opération de suppression - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\CollectionRemove::execute - - - - La fonction execute doit être invoquée pour déclencher le client à envoyer la requête d'opération CRUD au serveur. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Result object. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionRemove::execute</function> - -remove('true')->sort('age desc')->limit(2)->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/limit.xml deleted file mode 100644 index 9a29b9d108..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/limit.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - CollectionRemove::limit - Limite le nombre de documents à supprimer - - - - &reftitle.description; - - public mysql_xdevapi\CollectionRemovemysql_xdevapi\CollectionRemove::limit - introws - - - Définit le nombre maximum de documents à supprimer. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - rows - - - Le nombre maximum de documents à supprimer. - - - - - - - - &reftitle.returnvalues; - - Renvoie un objet CollectionRemove qui peut être utilisé pour exécuter la commande, - ou pour ajouter des opérations supplémentaires. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionRemove::limit</function> - -remove('job in (\'Barista\', \'Programmatore\', \'Ballerino\', \'Programmatrice\')')->limit(5)->sort(['age desc', 'name asc'])->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/sort.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/sort.xml deleted file mode 100644 index 54b242dd51..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/sort.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - CollectionRemove::sort - Définit le critère de tri - - - - &reftitle.description; - - public mysql_xdevapi\CollectionRemovemysql_xdevapi\CollectionRemove::sort - stringsort_expr - - - Trie le jeu de résultats par le champ sélectionné dans l'argument sort_expr. Les ordres autorisés - sont ASC (Ascending) ou DESC (Descending). Cette opération est équivalente à l'opération SQL 'ORDER BY' - et suit le même ensemble de règles. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - sort_expr - - - Une ou plusieurs expressions de tri peuvent être fournies. L'évaluation se fait de gauche à droite, - et chaque expression est séparée par une virgule. - - - - - - - - &reftitle.returnvalues; - - Un objet CollectionRemove qui peut être utilisé pour exécuter la commande, ou pour ajouter des opérations supplémentaires. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CollectionRemove::sort</function> - -remove('true')->sort('age desc')->limit(2)->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/construct.xml deleted file mode 100644 index acb263b990..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/construct.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - ColumnResult::__construct - Constructeur de ColumnResult - - - - &reftitle.description; - - private mysql_xdevapi\ColumnResult::__construct - - - - Renvoie les métadonnées de colonne, telles que son jeu de caractères ; cela est instancié - par la méthode mysql_xdevapi\RowResult::getColumns. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::__construct</function> - -sql("DROP DATABASE IF EXISTS nonsense")->execute(); -$session->sql("CREATE DATABASE nonsense")->execute(); -$session->sql("CREATE TABLE nonsense.numbers (hello int, world float unsigned)")->execute(); -$session->sql("INSERT INTO nonsense.numbers values (42, 42)")->execute(); - -$schema = $session->getSchema("nonsense"); -$table = $schema->getTable("numbers"); - -$result1 = $table->select('hello','world')->execute(); - -// Renvoie un tableau d'objets ColumnResult -$columns = $result1->getColumns(); - -foreach ($columns as $column) { - echo "\nColumn label " , $column->getColumnLabel(); - echo " is type " , $column->getType(); - echo " and is ", ($column->isNumberSigned() === 0) ? "unsigned." : "signed."; -} - -// Ou bien -$result2 = $session->sql("SELECT * FROM nonsense.numbers")->execute(); - -// Renvoie un tableau d'objets FieldMetadata -print_r($result2->getColumns()); -]]> - - &example.outputs.similar; - - mysql_xdevapi\FieldMetadata Object - ( - [type] => 1 - [type_name] => SINT - [name] => hello - [original_name] => hello - [table] => numbers - [original_table] => numbers - [schema] => nonsense - [catalog] => def - [collation] => 0 - [fractional_digits] => 0 - [length] => 11 - [flags] => 0 - [content_type] => 0 - ) - [1] => mysql_xdevapi\FieldMetadata Object - ( - [type] => 6 - [type_name] => FLOAT - [name] => world - [original_name] => world - [table] => numbers - [original_table] => numbers - [schema] => nonsense - [catalog] => def - [collation] => 0 - [fractional_digits] => 31 - [length] => 12 - [flags] => 1 - [content_type] => 0 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcharactersetname.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcharactersetname.xml deleted file mode 100644 index bfc4bcdf50..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcharactersetname.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getCharacterSetName - Renvoie le jeu de caractères - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getCharacterSetName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::getCharacterSetName</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcollationname.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcollationname.xml deleted file mode 100644 index 6124643649..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcollationname.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getCollationName - Renvoie le nom de la collation - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getCollationName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::getCollationName</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnlabel.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnlabel.xml deleted file mode 100644 index 6f7148c5b5..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnlabel.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getColumnLabel - Renvoie l'étiquette de colonne - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getColumnLabel - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::getColumnLabel</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnname.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnname.xml deleted file mode 100644 index 5014cbfd65..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnname.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getColumnName - Renvoie le nom de la colonne - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getColumnName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::getColumnName</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getfractionaldigits.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getfractionaldigits.xml deleted file mode 100644 index ec1d96ad22..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getfractionaldigits.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getFractionalDigits - Renvoie la longueur des chiffres fractionnels - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::getFractionalDigits - - - - Récupère le nombre de chiffres fractionnels pour la colonne. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::getFractionalDigits</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getlength.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getlength.xml deleted file mode 100644 index a91e162534..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getlength.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getLength - Renvoie la longueur du champ - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::getLength - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::getLength</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getschemaname.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getschemaname.xml deleted file mode 100644 index 2ffceb4360..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getschemaname.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getSchemaName - Renvoie le nom du schéma - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getSchemaName - - - - Récupère le nom du schéma où la colonne est stockée. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::getSchemaName</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablelabel.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablelabel.xml deleted file mode 100644 index acb07266c5..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablelabel.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getTableLabel - Renvoie l'étiquette de table - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getTableLabel - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::getTableLabel</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablename.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablename.xml deleted file mode 100644 index 60960e5d28..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablename.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getTableName - Renvoie le nom de la table - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getTableName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom de la table pour la colonne. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::getTableName</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettype.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettype.xml deleted file mode 100644 index bf2df9a0cb..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettype.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getType - Renvoie le type de colonne - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::getType - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::getType</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/isnumbersigned.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/isnumbersigned.xml deleted file mode 100644 index 655c0930eb..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/isnumbersigned.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::isNumberSigned - Renvoie si le type est signé - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::isNumberSigned - - - - Récupère les informations de colonne d'une table et est instancié par la méthode - mysql_xdevapi\RowResult::getColumns. - - - &warn.undocumented.func; - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si une colonne donnée est de type signé. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::isNumberSigned</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/ispadded.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/ispadded.xml deleted file mode 100644 index 723836c207..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/ispadded.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::isPadded - Vérifie si le champ a un remplissage - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::isPadded - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si une colonne donnée a un remplissage. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ColumnResult::isPadded</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationbindable/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/crudoperationbindable/bind.xml deleted file mode 100644 index c9dd2a3825..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationbindable/bind.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - CrudOperationBindable::bind - Lie une valeur à un espace réservé - - - - &reftitle.description; - - abstract public mysql_xdevapi\CrudOperationBindablemysql_xdevapi\CrudOperationBindable::bind - arrayplaceholder_values - - - Lie une valeur à un espace réservé spécifique. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - placeholder_values - - - Le nom des espaces réservés et les valeurs à lier. - - - - - - - - &reftitle.returnvalues; - - Un objet CrudOperationBindable - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CrudOperationBindable::bind</function> - -modify('name like :name')->arrayInsert('job[0]', 'Calciatore')->bind(['name' => 'ENTITY'])->execute(); -$res = $table->delete()->orderby('age desc')->where('age < 20 and age > 12 and name != :name')->bind(['name' => 'Tierney'])->limit(2)->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationlimitable/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/crudoperationlimitable/limit.xml deleted file mode 100644 index e38325fc86..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationlimitable/limit.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - CrudOperationLimitable::limit - Définit la limite de résultats - - - - &reftitle.description; - - abstract public mysql_xdevapi\CrudOperationLimitablemysql_xdevapi\CrudOperationLimitable::limit - introws - - - Définit le nombre maximum de résultats ou de documents à retourner. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - rows - - - Le nombre maximum de résultats ou de documents. - - - - - - - - &reftitle.returnvalues; - - Un objet CrudOperationLimitable. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CrudOperationLimitable::limit</function> - -find()->fields(['name as n','age as a','job as j'])->groupBy('j')->limit(11)->execute(); -$res = $table->update()->set('age',69)->where('age > 15 and age < 22')->limit(4)->orderby(['age asc','name desc'])->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationskippable/skip.xml b/reference/mysql_xdevapi/mysql_xdevapi/crudoperationskippable/skip.xml deleted file mode 100644 index 19fee13f7b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationskippable/skip.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - CrudOperationSkippable::skip - Le nombre d'opérations à ignorer - - - - &reftitle.description; - - abstract public mysql_xdevapi\CrudOperationSkippablemysql_xdevapi\CrudOperationSkippable::skip - intskip - - - Ignore ce nombre d'enregistrements dans l'opération retournée. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - skip - - - Le nombre d'éléments à ignorer. - - - - - - - - &reftitle.returnvalues; - - Un objet CrudOperationSkippable. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CrudOperationSkippable::skip</function> - -find('job like \'Programmatore\'')->limit(1)->skip(3)->sort('age asc')->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationsortable/sort.xml b/reference/mysql_xdevapi/mysql_xdevapi/crudoperationsortable/sort.xml deleted file mode 100644 index a7472e86fe..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationsortable/sort.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - CrudOperationSortable::sort - Trie les résultats - - - - &reftitle.description; - - abstract public mysql_xdevapi\CrudOperationSortable - mysql_xdevapi\CrudOperationSortable::sort - stringsort_expr - - - Trie le jeu de résultats par le champ sélectionné dans l'argument sort_expr. Les ordres autorisés - sont ASC (Ascendant) ou DESC (Descendant). Cette opération est équivalente à l'opération SQL 'ORDER BY' - et suit le même ensemble de règles. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - sort_expr - - - Une ou plusieurs expressions de tri peuvent être fournies. L'évaluation se fait de gauche à droite, - et chaque expression est séparée par une virgule. - - - - - - - - &reftitle.returnvalues; - - Un objet CrudOperationSortable. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\CrudOperationSortable::sort</function> - -find('job like \'Cavia\'')->sort('age desc', '_id desc')->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/existsindatabase.xml deleted file mode 100644 index 7abe4651b1..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/existsindatabase.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - DatabaseObject::existsInDatabase - Vérifie si l'objet existe dans la base de données - - - - &reftitle.description; - - abstract public boolmysql_xdevapi\DatabaseObject::existsInDatabase - - - - Vérifie si l'objet de base de données fait référence à un objet qui existe dans la base de données. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si l'objet existe dans la base de données, sinon &false; s'il n'existe pas. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\DatabaseObject::existsInDatabase</function> - -existsInDatabase(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getname.xml deleted file mode 100644 index ea6f49fdb7..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getname.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - DatabaseObject::getName - Renvoie le nom de l'objet - - - - &reftitle.description; - - abstract public stringmysql_xdevapi\DatabaseObject::getName - - - - Récupère le nom de cet objet de base de données. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom de cet objet de base de données. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\DatabaseObject::getName</function> - -getName(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getsession.xml deleted file mode 100644 index 997311ec73..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getsession.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - DatabaseObject::getSession - Renvoie le nom de la session - - - - &reftitle.description; - - abstract public mysql_xdevapi\Sessionmysql_xdevapi\DatabaseObject::getSession - - - - Récupère la session associée à l'objet de base de données. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Session. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\DatabaseObject::getSession</function> - -getSession(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/construct.xml deleted file mode 100644 index 6465541041..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - DocResult::__construct - Constructeur de DocResult - - - - &reftitle.description; - - private mysql_xdevapi\DocResult::__construct - - - - Récupère les résultats et les avertissements du document, - et est instancié par CollectionFind. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de DocResult - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Rend un objet DocResult -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->limit(1) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000f3" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchall.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchall.xml deleted file mode 100644 index d20f70aaf4..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchall.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - DocResult::fetchAll - Renvoie toutes les lignes - - - - &reftitle.description; - - public arraymysql_xdevapi\DocResult::fetchAll - - - - Renvoie toutes les lignes d'un jeu de résultats. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau numérique avec tous les résultats de la requête ; chaque résultat est - un tableau associatif. Un tableau vide est renvoyé si aucune - ligne n'est présente. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\DocResult::fetchAll</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Rend un objet DocResult -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b53610000000000000123" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } - - [1]=> - array(4) { - ["_id"]=> - string(28) "00005b6b53610000000000000122" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } - -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchone.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchone.xml deleted file mode 100644 index 907333284d..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchone.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - DocResult::fetchOne - Renvoie une ligne - - - - &reftitle.description; - - public arraymysql_xdevapi\DocResult::fetchOne - - - - Récupère un résultat d'un jeu de résultats. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le résultat, sous forme de tableau associatif - ou &null; si aucun résultat n'est présent. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\DocResult::fetchOne</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Rend un objet DocResult -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->execute(); - -var_dump($result->fetchOne()); -?> -]]> - - &example.outputs.similar; - - - string(28) "00005b6b53610000000000000125" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarnings.xml deleted file mode 100644 index 1957ed518c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarnings.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - DocResult::getWarnings - Renvoie les avertissements de la dernière opération - - - - &reftitle.description; - - public Arraymysql_xdevapi\DocResult::getWarnings - - - - Récupère les avertissements générés par la dernière opération du serveur MySQL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau d'objets Warning de la dernière opération. Chaque objet - définit un 'message' d'erreur, un 'niveau' d'erreur et un 'code' d'erreur. Un tableau - vide est renvoyé si aucune erreur n'est présente. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\DocResult::getWarnings</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Rend un objet DocResult -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->execute(); - -if (!$result->getWarningsCount()) { - echo "There was an error:\n"; - print_r($result->getWarnings()); - exit; -} - -var_dump($result->fetchOne()); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Warning Object - ( - [message] => Something bad and so on - [level] => 2 - [code] => 1365 - ) - [1] => mysql_xdevapi\Warning Object - ( - [message] => Something bad and so on - [level] => 2 - [code] => 1365 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarningscount.xml deleted file mode 100644 index fcf01dc7eb..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarningscount.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - DocResult::getWarningsCount - Renvoie le nombre d'avertissements de la dernière opération - - - - &reftitle.description; - - public intmysql_xdevapi\DocResult::getWarningsCount - - - - Renvoie le nombre d'avertissements générés par la dernière opération. Plus - précisément, ces avertissements sont générés par le serveur MySQL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre d'avertissements de la dernière opération. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\DocResult::getWarningsCount</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Rend un objet DocResult -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->execute(); - -if (!$result->getWarningsCount()) { - echo "There was an error:\n"; - print_r($result->getWarnings()); - exit; -} - -var_dump($result->fetchOne()); -?> -]]> - - &example.outputs.similar; - - - string(28) "00005b6b53610000000000000135" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/executable/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/executable/execute.xml deleted file mode 100644 index 387e629ab7..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/executable/execute.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Executable::execute - Exécute une déclaration - - - - &reftitle.description; - - abstract public mysql_xdevapi\Resultmysql_xdevapi\Executable::execute - - - - Exécute la déclaration à partir d'une opération de collection ou d'une requête de table; - cette fonctionnalité permet le chaînage de méthodes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un des objets Result, tels que Result ou SqlStatementResult. - - - - - &reftitle.examples; - - execute() examples - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$result_sql = $session->sql("CREATE DATABASE addressbook")->execute(); - -var_dump($result_sql); - - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("humans"); - -$result_collection = $collection->add( - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}'); - -$result_collection_executed = $result_collection->execute(); - -var_dump($result_collection); -var_dump($result_collection_executed); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/executionstatus/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/executionstatus/construct.xml deleted file mode 100644 index c6ede05211..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/executionstatus/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - ExecutionStatus::__construct - Constructeur d'ExecutionStatus - - - - &reftitle.description; - - private mysql_xdevapi\ExecutionStatus::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\ExecutionStatus::__construct</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml deleted file mode 100644 index f070a5435a..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Expression::__construct - Constructeur d'Expression - - - - &reftitle.description; - - public mysql_xdevapi\Expression::__construct - stringexpression - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - expression - - - - - - - - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Expression::__construct</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml deleted file mode 100644 index a881f400c0..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Result::__construct - Constructeur de Result - - - - &reftitle.description; - - private mysql_xdevapi\Result::__construct - - - - Un objet qui récupère les ID générés, les valeurs AUTO_INCREMENT et les avertissements, - pour un jeu de résultats. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Result::__construct</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql(" - CREATE TABLE addressbook.names - (id INT NOT NULL AUTO_INCREMENT, name VARCHAR(30), age INT, PRIMARY KEY (id)) - ")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->insert("name", "age")->values(["Suzanne", 31],["Julie", 43])->execute(); -$result = $table->insert("name", "age")->values(["Suki", 34])->execute(); - -$ai = $result->getAutoIncrementValue(); -var_dump($ai); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml deleted file mode 100644 index 46388e4e85..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Result::getAffectedItemsCount - Renvoie le nombre de lignes affectées - - - - &reftitle.description; - - public intmysql_xdevapi\Result::getAffectedItemsCount - - - - Renvoie le nombre de lignes affectées par l'opération précédente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre (en tant qu'entier) de lignes affectées. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Result::getAffectedItemsCount</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -$result = $collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -var_dump( $res->getAffectedItemsCount() ); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml deleted file mode 100644 index a228f926aa..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Result::getAutoIncrementValue - Renvoie la valeur auto-incrémentée - - - - &reftitle.description; - - public intmysql_xdevapi\Result::getAutoIncrementValue - - - - Renvoie la dernière valeur AUTO_INCREMENT (dernier identifiant inséré). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La dernière valeur AUTO_INCREMENT. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Result::getAutoIncrementValue</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql(" - CREATE TABLE addressbook.names - (id INT NOT NULL AUTO_INCREMENT, name VARCHAR(30), age INT, PRIMARY KEY (id)) - ")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->insert("name", "age")->values(["Suzanne", 31],["Julie", 43])->execute(); -$result = $table->insert("name", "age")->values(["Suki", 34])->execute(); - -$ai = $result->getAutoIncrementValue(); -var_dump($ai); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml deleted file mode 100644 index 6ce05a5f2d..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Result::getGeneratedIds - Renvoie les ID générés - - - - &reftitle.description; - - public arraymysql_xdevapi\Result::getGeneratedIds - - - - Récupère les valeurs _id générées par la dernière opération. - Le champ _id unique est généré par le serveur MySQL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau d'_id générés par la dernière opération, - ou un tableau vide s'il n'y en a pas. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Result::getGeneratedIds</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -$result = $collection->add( - '{"name": "Bernie", - "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}')->execute(); - -$ids = $result->getGeneratedIds(); -var_dump($ids); -?> -]]> - - &example.outputs.similar; - - - string(28) "00005b6b53610000000000000064" - [1]=> - string(28) "00005b6b53610000000000000065" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml deleted file mode 100644 index 0e755724e3..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Result::getWarnings - Renvoie les avertissements de la dernière opération - - - - &reftitle.description; - - public arraymysql_xdevapi\Result::getWarnings - - - - Renvoie les avertissements de la dernière opération Result. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau d'objets Warning de la dernière opération. Chaque objet - définit un message d'erreur, un niveau d'erreur et un code d'erreur. - Un tableau vide est renvoyé s'il n'y a pas d'erreurs. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\RowResult::getWarnings</function> - -sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); -$warnings = $res->getWarnings(); - -print_r($warnings); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) - [1] => mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml deleted file mode 100644 index fc9d518aaf..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Result::getWarningsCount - Renvoie le nombre d'avertissements de la dernière opération - - - - &reftitle.description; - - public intmysql_xdevapi\Result::getWarningsCount - - - - Renvoie le nombre d'avertissements générés par la dernière opération. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre d'avertissements générés par la dernière opération. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\RowResult::getWarningsCount</function> - -sql("DROP DATABASE IF EXISTS foo")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); - -echo $res->getWarningsCount(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml deleted file mode 100644 index 00469a317a..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - RowResult::__construct - Constructeur de RowResult - - - - &reftitle.description; - - private mysql_xdevapi\RowResult::__construct - - - - Représente l'ensemble de résultats obtenus à partir de la requête de la base de données. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\RowResult::__construct</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->where('age > 18')->execute()->fetchAll(); - -print_r($row); -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml deleted file mode 100644 index f4e7b7f0ce..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - RowResult::fetchAll - Renvoie toutes les lignes du résultat - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::fetchAll - - - - Récupère toutes les lignes du jeu de résultats. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau numérique avec tous les résultats de la requête; chaque résultat est - un tableau associatif. Un tableau vide est renvoyé si aucune - ligne n'est présente. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::fetchAll</function> example - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->execute()->fetchAll(); - -print_r($row); -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml deleted file mode 100644 index 8391ccc27c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - RowResult::fetchOne - Renvoie une ligne du résultat - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::fetchOne - - - - Récupère une ligne du jeu de résultats. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le résultat, sous forme de tableau associatif - ou &null; si aucun résultat n'est présent. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\RowResult::fetchOne</function> - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->where('age < 40')->execute()->fetchOne(); - -print_r($row); -]]> - - &example.outputs.similar; - - Sam - [age] => 33 -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml deleted file mode 100644 index e72015e6f3..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - RowResult::getColumnsCount - Renvoie le nombre de colonnes - - - - &reftitle.description; - - public intmysql_xdevapi\RowResult::getColumnsCount - - - - Renvoie le nombre de colonnes présentes dans le jeu de résultats. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre de colonnes; 0 s'il n'y en a pas. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.14 - - La méthode a été renommée de getColumnCount() à getColumnsCount(). - - - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\RowResult::getColumnsCount</function> - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$sql = $session->sql("SELECT * from addressbook.names")->execute(); - -echo $sql->getColumnsCount(); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml deleted file mode 100644 index 55e5cadf41..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - RowResult::getColumnNames - Renvoie le nom de toutes les colonnes - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::getColumnNames - - - - Renvoie le nom des colonnes présentes dans le jeu de résultats. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau numérique de noms de colonnes de table, - ou un tableau vide si le jeu de résultats est vide. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\RowResult::getColumnNames</function> - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$sql = $session->sql("SELECT * from addressbook.names")->execute(); - -$colnames = $sql->getColumnNames(); - -print_r($colnames); -]]> - - &example.outputs.similar; - - name - [1] => age -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml deleted file mode 100644 index da20d685fa..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - RowResult::getColumns - Renvoie les métadonnées des colonnes - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::getColumns - - - - Renvoie les métadonnées des colonnes présentes dans le jeu de résultats. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau de FieldMetadata représentant les colonnes du résultat, - ou un tableau vide si le jeu de résultats est vide. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\RowResult::getColumns</function> - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$sql = $session->sql("SELECT * from addressbook.names")->execute(); - -$cols = $sql->getColumns(); - -print_r($cols); -]]> - - &example.outputs.similar; - - mysql_xdevapi\FieldMetadata Object - ( - [type] => 7 - [type_name] => BYTES - [name] => name - [original_name] => name - [table] => names - [original_table] => names - [schema] => addressbook - [catalog] => def - [collation] => 255 - [fractional_digits] => 0 - [length] => 65535 - [flags] => 0 - [content_type] => 0 - ) - [1] => mysql_xdevapi\FieldMetadata Object - ( - [type] => 1 - [type_name] => SINT - [name] => age - [original_name] => age - [table] => names - [original_table] => names - [schema] => addressbook - [catalog] => def - [collation] => 0 - [fractional_digits] => 0 - [length] => 11 - [flags] => 0 - [content_type] => 0 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml deleted file mode 100644 index c6eb479ab2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - RowResult::getWarnings - Renvoie les avertissements de la dernière opération - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::getWarnings - - - - Renvoie les avertissements de la dernière opération RowResult. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau d'objets Warning de la dernière opération. Chaque objet - définit un message d'erreur 'message', un niveau d'erreur 'level', et un code d'erreur 'code'. Un tableau - vide est renvoyé si aucune erreur n'est présente. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\RowResult::getWarnings</function> - -sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); -$warnings = $res->getWarnings(); - -print_r($warnings); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) - [1] => mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml deleted file mode 100644 index 91cd3c03c7..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - RowResult::getWarningsCount - Renvoie le nombre d'avertissements de la dernière opération - - - - &reftitle.description; - - public intmysql_xdevapi\RowResult::getWarningsCount - - - - Renvoie le nombre d'avertissements générés par la dernière opération. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre d'avertissements générés par la dernière opération. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\RowResult::getWarningsCount</function> - -sql("DROP DATABASE IF EXISTS foo")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); - -echo $res->getWarningsCount(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml deleted file mode 100644 index b862107a97..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Schema::__construct - Constructeur de schema - - - - &reftitle.description; - - private mysql_xdevapi\Schema::__construct - - - - L'objet Schema fournit un accès complet au schéma (base de données). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <methodname>mysql_xdevapi\Schema::__construct</methodname> - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); -$session->sql("CREATE TABLE food.fruit(name text, rating text)")->execute(); - -$schema = $session->getSchema("food"); -$schema->createCollection("trees"); - -print_r($schema->gettables()); -print_r($schema->getcollections()); -]]> - - &example.outputs.similar; - - mysql_xdevapi\Table Object - ( - [name] => fruit - ) -) -Array -( - [trees] => mysql_xdevapi\Collection Object - ( - [name] => trees - ) -) -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml deleted file mode 100644 index 4e2f976674..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - Schema::createCollection - Ajoute une collection au schéma - - - - &reftitle.description; - - public mysql_xdevapi\Collectionmysql_xdevapi\Schema::createCollection - stringname - stringvalidate - - - Créer une collection dans le schéma. - - - - - &reftitle.parameters; - - - name - - - Le nom de la collection. - - - - - validate - - - La définition de validation, en tant qu'objet JSON. - - - - - - - - &reftitle.returnvalues; - - L'objet Collection. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.20 - - Ajout du paramètre facultatif validate. - - - - - - - - - &reftitle.examples; - - Exemple de <methodname>mysql_xdevapi\Schema::createCollection</methodname> - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); -$session->sql("CREATE TABLE food.fruit(name text, rating text)")->execute(); - -$schema = $session->getSchema("food"); -$schema->createCollection("trees"); - -print_r($schema->gettables()); -print_r($schema->getcollections()); -]]> - - &example.outputs.similar; - - mysql_xdevapi\Table Object - ( - [name] => fruit - ) -) -Array -( - [trees] => mysql_xdevapi\Collection Object - ( - [name] => trees - ) -) -]]> - - - - Exemple de <methodname>mysql_xdevapi\Schema::createCollection</methodname> - - createCollection("mycollection", '{ - "validation": { - "level": "strict", - "schema": { - "id": "http://json-schema.org/geo", - "description": "A geographical coordinate", - "type": "object", - "properties": { - "latitude": { - "type": "number" - }, - "longitude": { - "type": "number" - } - }, - "required": ["latitude", "longitude"] - } - } -}'); -// Succès -$collection->add('{"latitude": 10, "longitude": 20}')->execute(); - -// Échec, types invalides (pas des nombres) -$collection->add('{"latitude": "lat", "longitude": "long"}')->execute(); -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml deleted file mode 100644 index 2eafad054f..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Schema::dropCollection - Supprime une collection du schéma - - - - &reftitle.description; - - public boolmysql_xdevapi\Schema::dropCollection - stringcollection_name - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - collection_name - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <methodname>mysql_xdevapi\Schema::dropCollection</methodname> - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); -$session->sql("CREATE TABLE food.fruit(name text, rating text)")->execute(); - -$schema = $session->getSchema("food"); - -$schema->createCollection("trees"); -$schema->dropCollection("trees"); -$schema->createCollection("buildings"); - -print_r($schema->gettables()); -print_r($schema->getcollections()); -]]> - - &example.outputs.similar; - - mysql_xdevapi\Table Object - ( - [name] => fruit - ) -) -Array -( - [buildings] => mysql_xdevapi\Collection Object - ( - [name] => buildings - ) -) -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml deleted file mode 100644 index 6596345b94..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Schema::existsInDatabase - Vérifie si l'objet existe dans la base de données - - - - &reftitle.description; - - public boolmysql_xdevapi\Schema::existsInDatabase - - - - Vérifie si l'objet actuel (schéma, table, collection ou vue) existe - dans l'objet schéma. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si le schéma, la table, la collection ou la vue existe toujours dans le schéma, sinon &false;. - - - - - &reftitle.examples; - - Exemple de <methodname>mysql_xdevapi\Schema::existsInDatabase</methodname> - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); -$session->sql("CREATE TABLE food.fruit(name text, rating text)")->execute(); - -$schema = $session->getSchema("food"); -$schema->createCollection("trees"); - -// ... - -$trees = $schema->getCollection("trees"); - -// ... - -// Cette collection est-elle toujours dans la base de données (schéma) ? -if ($trees->existsInDatabase()) { - echo "Yes, the 'trees' collection is still present."; -} -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml deleted file mode 100644 index b4d83fc7a9..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Schema::getCollection - Renvoie une collection du schéma - - - - &reftitle.description; - - public mysql_xdevapi\Collectionmysql_xdevapi\Schema::getCollection - stringname - - - Renvoie une collection du schéma. - - - - - &reftitle.parameters; - - - name - - - Le nom de la collection à récupérer. - - - - - - - - &reftitle.returnvalues; - - L'objet Collection pour la collection sélectionnée. - - - - - &reftitle.examples; - - Exemple de <methodname>mysql_xdevapi\Schema::getCollection</methodname> - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); - -$schema = $session->getSchema("food"); -$schema->createCollection("trees"); - -// ... - -$trees = $schema->getCollection("trees"); - -var_dump($trees); -]]> - - &example.outputs.similar; - - - string(5) "trees" -} -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml deleted file mode 100644 index 295e84c7d1..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Schema::getCollectionAsTable - Renvoie une collection en tant qu'objet Table - - - - &reftitle.description; - - public mysql_xdevapi\Tablemysql_xdevapi\Schema::getCollectionAsTable - stringname - - - Renvoie une collection, mais en tant qu'objet Table au lieu d'un objet Collection. - - - - - &reftitle.parameters; - - - name - - - Le nom de la collection à partir de laquelle instancier un objet Table. - - - - - - - - &reftitle.returnvalues; - - Un objet mysql_xdevapi\Table pour la collection. - - - - - &reftitle.examples; - - Exemple de <methodname>mysql_xdevapi\Schema::getCollectionAsTable</methodname> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collect = $schema->createCollection("people"); -$collect->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute(); -$collect->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -$table = $schema->getCollectionAsTable("people"); -$collection = $schema->getCollection("people"); - -var_dump($table); -var_dump($collection); -]]> - - &example.outputs.similar; - - - string(6) "people" -} - -object(mysql_xdevapi\Collection)#5 (1) { - ["name"]=> - string(6) "people" -} -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml deleted file mode 100644 index 9f84160dad..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Schema::getCollections - Renvoie toutes les collections du schéma - - - - &reftitle.description; - - public arraymysql_xdevapi\Schema::getCollections - - - - Récupère une liste de collections pour ce schéma. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau de toutes les collections de ce schéma, où chaque élément de tableau - est une Collection avec le nom de la collection comme clé. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Schema::getCollections</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collect = $schema->createCollection("people"); -$collect->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute(); -$collect->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -$collections = $schema->getCollections(); -var_dump($collections); -?> -]]> - - &example.outputs.similar; - - - object(mysql_xdevapi\Collection)#4 (1) { - ["name"]=> - string(6) "people" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml deleted file mode 100644 index 26e367461f..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Schema::getName - Renvoie le nom du schéma - - - - &reftitle.description; - - public stringmysql_xdevapi\Schema::getName - - - - Renvoie le nom du schéma. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom du schéma connecté à l'objet schéma, sous forme de chaîne de caractères. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Schema::getName</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); - -// ... - -var_dump($schema->getName()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml deleted file mode 100644 index e929d32385..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Schema::getSession - Renvoie la session du schéma - - - - &reftitle.description; - - public mysql_xdevapi\Sessionmysql_xdevapi\Schema::getSession - - - - Renvoie un nouvel objet Session à partir de l'objet Schema. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet Session. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Schema::getSession</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); - -// ... - -$newsession = $schema->getSession(); - -var_dump($session); -var_dump($newsession); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml deleted file mode 100644 index 70e6572362..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Schema::getTable - Renvoie la table du schéma - - - - &reftitle.description; - - public mysql_xdevapi\Tablemysql_xdevapi\Schema::getTable - stringname - - - Récupère un objet Table pour la table fournie dans le schéma. - - - - - &reftitle.parameters; - - - name - - - Le nom de la table. - - - - - - - - &reftitle.returnvalues; - - Un objet table. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Schema::getTable</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->execute()->fetchAll(); - -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml deleted file mode 100644 index 07f31920a5..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Schema::getTables - Renvoie les tables du schéma - - - - &reftitle.description; - - public arraymysql_xdevapi\Schema::getTables - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau de toutes les tables de ce schéma, où chaque élément de tableau - est un objet Table avec le nom de la table comme clé. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Schema::getTables</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$session->sql("CREATE TABLE addressbook.cities(name text, population int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('Portland', 639863), ('Seattle', 704352)")->execute(); - -$schema = $session->getSchema("addressbook"); -$tables = $schema->getTables(); - -var_dump($tables); -?> -]]> - - &example.outputs.similar; - - - object(mysql_xdevapi\Table)#3 (1) { - ["name"]=> - string(6) "cities" - } - - ["names"]=> - object(mysql_xdevapi\Table)#4 (1) { - ["name"]=> - string(5) "names" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml deleted file mode 100644 index 1ff79870dd..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - SchemaObject::getSchema - Renvoie l'objet schéma - - - - &reftitle.description; - - abstract mysql_xdevapi\Schemamysql_xdevapi\SchemaObject::getSchema - - - - Utiliser par d'autres objets pour récupérer un objet schéma. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet schéma actuel. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::getSchema</function> - -getSchema("addressbook"); - -print_r($schema); -]]> - - &example.outputs.similar; - - addressbook -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml deleted file mode 100644 index 9341ceb0f5..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Session::close - Ferme la session - - - - &reftitle.description; - - public boolmysql_xdevapi\Session::close - - - - Ferme la session avec le serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si la session a été fermée. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::close</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$session->close(); -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml deleted file mode 100644 index 3a82fcaa41..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Session::commit - Valide la transaction - - - - &reftitle.description; - - public Objectmysql_xdevapi\Session::commit - - - - Valide la transaction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet SqlStatementResult. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::commit</function> - -getSchema("addressbook")->getCollection("friends"); - -$session->startTransaction(); - -$collection->add('{"John":42, "Sam":33}')->execute(); -$savepoint = $session->setSavepoint(); - -$session->commit(); -$session->close(); -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml deleted file mode 100644 index ae571b58d7..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Session::__construct - Description du constructeur - - - - &reftitle.description; - - private mysql_xdevapi\Session::__construct - - - - Un objet Session, tel qu'initié par getSession(). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::__construct</function> - -close(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml deleted file mode 100644 index ba4f600f15..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Session::createSchema - Créer un nouveau schéma - - - - &reftitle.description; - - public mysql_xdevapi\Schemamysql_xdevapi\Session::createSchema - stringschema_name - - - Créer un nouveau schéma. - - - - - &reftitle.parameters; - - - schema_name - - - Le nom du schéma à créer. - - - - - - - - - &reftitle.returnvalues; - - Un objet Schema en cas de succès, et émet une exception en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::createSchema</function> - -createSchema('fruit')) { - echo "Info: I created a schema named 'fruit'\n"; - } - -} catch (Exception $e) { - - echo $e->getMessage(); - -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml deleted file mode 100644 index bbdfaca17c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Session::dropSchema - Supprime un schéma - - - - &reftitle.description; - - public boolmysql_xdevapi\Session::dropSchema - stringschema_name - - - Supprime un schéma (base de données). - - - - - &reftitle.parameters; - - - schema_name - - - Le nom du schéma à supprimer. - - - - - - - - &reftitle.returnvalues; - - &true; si le schéma est supprimé, ou &false; s'il n'existe pas - ou ne peut pas être supprimé. - - - Un niveau d'erreur E_WARNING est généré si le - schéma n'existe pas. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::dropSchema</function> - -dropSchema("addressbook"); - -$session->close(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml deleted file mode 100644 index 544229d4ff..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Session::generateUUID - Renvoie un nouvel UUID - - - - &reftitle.description; - - public stringmysql_xdevapi\Session::generateUUID - - - - Génère un identifiant unique universel (Universal Unique IDentifier - UUID) généré selon la - RFC 4122. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'UUID; une chaîne de 32 caractères. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::generateUuid</function> - -generateUuid(); - -var_dump($uuid); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml deleted file mode 100644 index 895ccb9a74..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Session::getDefaultSchema - Renvoie le nom du schéma par défaut - - - - &reftitle.description; - - public mysql_xdevapi\Schemanullmysql_xdevapi\Session::getDefaultSchema - - - - Renvoie le nom du schéma par défaut tel qu'il est généralement défini dans l'URI de connexion. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom du schéma par défaut défini par la connexion, ou &null; si aucun n'a été défini. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::getSchema</function> - -getDefaultSchema(); -echo $schema->getName(); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml deleted file mode 100644 index 0810d3a168..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Session::getSchema - Renvoie un nouvel objet schéma - - - - &reftitle.description; - - public mysql_xdevapi\Schemamysql_xdevapi\Session::getSchema - stringschema_name - - - Un nouvel objet Schema pour le nom de schéma fourni. - - - - - &reftitle.parameters; - - - schema_name - - - Le nom du schéma (base de données) pour lequel obtenir un objet Schema. - - - - - - - - &reftitle.returnvalues; - - Un objet Schema. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::getSchema</function> - -getSchema("addressbook"); - -print_r($schema); -]]> - - &example.outputs.similar; - - addressbook -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml deleted file mode 100644 index 2059a90d85..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Session::getSchemas - Renvoie les schémas - - - - &reftitle.description; - - public arraymysql_xdevapi\Session::getSchemas - - - - Obtient les objets schémas pour tous les schémas disponibles pour la session. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau contenant des objets qui représentent tous les schémas - disponibles pour la session. - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::getSchemas</function> - -getSchemas(); - -print_r($schemas); -]]> - - &example.outputs.similar; - - mysql_xdevapi\Schema Object - ( - [name] => addressbook - ) - [1] => mysql_xdevapi\Schema Object - ( - [name] => information_schema - ) - ... -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml deleted file mode 100644 index 9e30fd2177..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Session::getServerVersion - Renvoie la version du serveur - - - - &reftitle.description; - - public intmysql_xdevapi\Session::getServerVersion - - - - Renvoie la version du serveur MySQL pour la session. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La version du serveur MySQL pour la session, sous forme d'entier tel que "80012". - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::getServerVersion</function> - -getServerVersion(); - -var_dump($version); -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml deleted file mode 100644 index 6e8bbeee6b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Session::listClients - Renvoie la liste des clients - - - - &reftitle.description; - - public arraymysql_xdevapi\Session::listClients - - - - Renvoie la liste des connexions client au serveur MySQL de la session. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau contenant les clients actuellement connectés. Les éléments - du tableau sont "client_id", "user", "host" et "sql_session". - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::listClients</function> - -listClients(); - -var_dump($ids); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["client_id"]=> - int(61) - ["user"]=> - string(4) "root" - ["host"]=> - string(9) "localhost" - ["sql_session"]=> - int(72) - } -} -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml deleted file mode 100644 index 02e0384879..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Session::quoteName - Ajoute des guillemets - - - - &reftitle.description; - - public stringmysql_xdevapi\Session::quoteName - stringname - - - Une fonction qui met entre guillemets pour échapper les noms et identifiants SQL. Elle échappe - l'identifiant donné conformément aux paramètres de la connexion actuelle. Cette fonction - d'échappement ne doit pas être utilisée pour échapper des valeurs. - - - - - &reftitle.parameters; - - - name - - - La chaîne à mettre entre guillemets. - - - - - - - - &reftitle.returnvalues; - - La chaîne mise entre guillemets. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::quoteName</function> - -quoteName($first)); - -$second = 'Another `test` "like" `this`'; -var_dump($second); -var_dump($session->quoteName($second)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml deleted file mode 100644 index 18e85aa3c7..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Session::releaseSavepoint - Libère le point de sauvegarde - - - - &reftitle.description; - - public voidmysql_xdevapi\Session::releaseSavepoint - stringname - - - Libère un point de sauvegarde précédemment défini. - - - - - &reftitle.parameters; - - - name - - - Le nom du point de sauvegarde à libérer. - - - - - - - - - &reftitle.returnvalues; - - Un objet SqlStatementResult. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::releaseSavepoint</function> - -getSchema("addressbook")->getCollection("friends"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$session->releaseSavepoint($savepoint); -$session->rollback(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml deleted file mode 100644 index 93f594b872..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Session::rollback - Annule la transaction - - - - &reftitle.description; - - public voidmysql_xdevapi\Session::rollback - - - - Annule la transaction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet SqlStatementResult. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::rollback</function> - -getSchema("addressbook")->getCollection("names"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$session->releaseSavepoint($savepoint); -$session->rollback(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml deleted file mode 100644 index 77ad934ccc..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Session::rollbackTo - Annule la transaction jusqu'au point de sauvegarde - - - - &reftitle.description; - - public voidmysql_xdevapi\Session::rollbackTo - stringname - - - Annule la transaction jusqu'au point de sauvegarde. - - - - - &reftitle.parameters; - - - name - - - Le nom du point de sauvegarde jusqu'auquel annuler; insensible à la casse. - - - - - - - - &reftitle.returnvalues; - - Un objet SqlStatementResult. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::rollbackTo</function> - -getSchema("addressbook")->getCollection("names"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint1 = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$savepoint2 = $session->setSavepoint(); - -$session->rollbackTo($savepoint1); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml deleted file mode 100644 index 391b988c70..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Session::setSavepoint - Créer un point de sauvegarde - - - - &reftitle.description; - - public stringmysql_xdevapi\Session::setSavepoint - stringname - - - Créer un nouveau point de sauvegarde pour la transaction. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - name - - - Le nom du point de sauvegarde. Le nom est généré automatiquement si le paramètre optionnel name - n'est pas défini comme 'SAVEPOINT1', 'SAVEPOINT2', etc. - - - - - - - - &reftitle.returnvalues; - - Le nom du point de sauvegarde. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::setSavepoint</function> - -getSchema("addressbook")->getCollection("names"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$session->releaseSavepoint($savepoint); -$session->rollback(); -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml deleted file mode 100644 index ca8ab28146..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Session::sql - Créer une requête SQL - - - - &reftitle.description; - - public mysql_xdevapi\SqlStatementmysql_xdevapi\Session::sql - stringquery - - - Créer une déclaration SQL native. Les espaces réservés sont pris en charge en utilisant la syntaxe native "?". - Utiliser la méthode execute pour exécuter la déclaration SQL. - - - - - &reftitle.parameters; - - - query - - - La déclaration SQL à exécuter. - - - - - - - - &reftitle.returnvalues; - - Un objet SqlStatement. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::sql</function> - -sql("CREATE DATABASE addressbook")->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml deleted file mode 100644 index e8dcc1476b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Session::startTransaction - Démarre une transaction - - - - &reftitle.description; - - public voidmysql_xdevapi\Session::startTransaction - - - - Démarre une nouvelle transaction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet SqlStatementResult. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Session::startTransaction</function> - -getSchema("addressbook")->getCollection("friends"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$session->releaseSavepoint($savepoint); -$session->rollback(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml deleted file mode 100644 index b5e3337d46..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - SqlStatement::bind - Lie les paramètres de l'instruction - - - - &reftitle.description; - - public mysql_xdevapi\SqlStatementmysql_xdevapi\SqlStatement::bind - stringparam - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - param - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatement::bind</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml deleted file mode 100644 index db1dc2b1bb..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - SqlStatement::__construct - Description de constructeur - - - - &reftitle.description; - - private mysql_xdevapi\SqlStatement::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatement::__construct</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml deleted file mode 100644 index 9f9fa2a6f1..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatement::execute - Exécute l'opération - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\SqlStatement::execute - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatement::execute</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml deleted file mode 100644 index ea92e00eb0..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatement::getNextResult - Renvoie le résultat suivant - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\SqlStatement::getNextResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatement::getNextResult</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml deleted file mode 100644 index 6f50a8a652..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatement::getResult - Renvoie le résultat - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\SqlStatement::getResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatement::getResult</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml deleted file mode 100644 index ac4f739e3e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatement::hasMoreResults - Vérifie s'il y a plus de résultats - - - - &reftitle.description; - - public boolmysql_xdevapi\SqlStatement::hasMoreResults - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; s'il reste des objets à récupérer dans le jeu de résultats. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatement::hasMoreResults</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml deleted file mode 100644 index 5f9b43c63f..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - SqlStatementResult::__construct - Description de constructeur - - - - &reftitle.description; - - private mysql_xdevapi\SqlStatementResult::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::__construct</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml deleted file mode 100644 index c9f246dce4..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - SqlStatementResult::fetchAll - Renvoie toutes les lignes du résultat - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::fetchAll - - - - Récupère toutes les lignes du jeu de résultats. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau numérique avec tous les résultats de la requête; chaque résultat est - un tableau associatif. Un tableau vide est renvoyé si aucune - ligne n'est présente. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::fetchAll</function> - -sql("DROP DATABASE IF EXISTS dbtest")->execute(); -$session->sql("CREATE DATABASE dbtest")->execute(); -$session->sql("CREATE TABLE dbtest.workers(name text, age int, job text)")->execute(); -$session->sql("INSERT INTO dbtest.workers values ('John', 42, 'bricklayer'), ('Sam', 33, 'carpenter')")->execute(); - -$schema = $session->getSchema("dbtest"); -$table = $schema->getTable("workers"); - -$rows = $session->sql("SELECT * FROM dbtest.workers")->execute()->fetchAll(); - -print_r($rows); -?> -]]> - - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml deleted file mode 100644 index 48c8c95a52..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - SqlStatementResult::fetchOne - Renvoie une seule ligne - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::fetchOne - - - - Récupère une seule ligne du jeu de résultats. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le résultat, sous forme de tableau associatif. En cas d'absence de - résultat, null sera renvoyé. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::fetchOne</function> - -sql("DROP DATABASE IF EXISTS dbtest")->execute(); -$session->sql("CREATE DATABASE dbtest")->execute(); -$session->sql("CREATE TABLE dbtest.workers(name text, age int, job text)")->execute(); -$session->sql("INSERT INTO dbtest.workers values ('John', 42, 'bricklayer'), ('Sam', 33, 'carpenter')")->execute(); - -$schema = $session->getSchema("dbtest"); -$table = $schema->getTable("workers"); - -$rows = $session->sql("SELECT * FROM dbtest.workers")->execute()->fetchOne(); - -print_r($rows); -?> -]]> - - &example.outputs.similar; - - John - [age] => 42 - [job] => bricklayer -) -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml deleted file mode 100644 index 9b0031a04e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::getAffectedItemsCount - Renvoie le nombre de lignes affectées - - - - &reftitle.description; - - public intmysql_xdevapi\SqlStatementResult::getAffectedItemsCount - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::getAffectedItemsCount</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml deleted file mode 100644 index a842870f91..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - SqlStatementResult::getColumnsCount - Renvoie le nombre de colonnes - - - - &reftitle.description; - - public intmysql_xdevapi\SqlStatementResult::getColumnsCount - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre de colonnes; 0 s'il n'y en a pas. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.14 - - La méthode a été renommée de getColumnCount() en getColumnsCount(). - - - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::getColumnsCount</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml deleted file mode 100644 index db6d170226..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::getColumnNames - Renvoie le nom des colonnes - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::getColumnNames - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::getColumnNames</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml deleted file mode 100644 index 3823341f13..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::getColumns - Renvoie les colonnes - - - - &reftitle.description; - - public Arraymysql_xdevapi\SqlStatementResult::getColumns - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::getColumns</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml deleted file mode 100644 index 93e324b4ec..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SqlStatementResult::getGeneratedIds - Renvoie les identifiants générés - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::getGeneratedIds - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau d'identifiants générés à partir de la dernière opération, - ou un tableau vide s'il n'y en a pas. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::getGeneratedIds</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml deleted file mode 100644 index b628be556e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::getLastInsertId - Renvoie l'ID de la dernière insertion - - - - &reftitle.description; - - public Stringmysql_xdevapi\SqlStatementResult::getLastInsertId - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'ID de la dernière opération d'insertion. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::getLastInsertId</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml deleted file mode 100644 index 8d5a10bf64..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - SqlStatementResult::getWarnings - Renvoie les avertissements de la dernière opération - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::getWarnings - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau d'objets Warning de la dernière opération. Chaque objet - définit un 'message' d'erreur, un 'niveau' d'erreur et un - 'code' d'erreur. Un tableau vide est renvoyé s'il n'y a pas d'erreurs. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::getWarnings</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml deleted file mode 100644 index aff1f8d8e4..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::getWarningsCount - Renvoie le nombre d'avertissements de la dernière opération - - - - &reftitle.description; - - public intmysql_xdevapi\SqlStatementResult::getWarningCounts - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre d'avertissements générés lors de la dernière opération CRUD. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::getWarningsCount</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml deleted file mode 100644 index 4ed49df99b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::hasData - Vérifie si le résultat contient des données - - - - &reftitle.description; - - public boolmysql_xdevapi\SqlStatementResult::hasData - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si le résultat contient des données. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::hasData</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml deleted file mode 100644 index 833d58fc9e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::nextResult - Renvoie le résultat suivant - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\SqlStatementResult::nextResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'objet Result suivant du jeu de résultats. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\SqlStatementResult::nextResult</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml deleted file mode 100644 index 964d17fd01..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Statement::__construct - Description de constructeur - - - - &reftitle.description; - - private mysql_xdevapi\Statement::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Statement::__construct</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml deleted file mode 100644 index 3d33365fb4..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Statement::getNextResult - Renvoie le résultat suivant - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Statement::getNextResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Statement::getNextResult</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml deleted file mode 100644 index e36a702f90..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Statement::getResult - Renvoie le résultat - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Statement::getResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Statement::getResult</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml deleted file mode 100644 index a65dbade23..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Statement::hasMoreResults - Vérifie s'il y a d'autres résultats - - - - &reftitle.description; - - public boolmysql_xdevapi\Statement::hasMoreResults - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Statement::hasMoreResults</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml deleted file mode 100644 index 5423eda97d..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Table::__construct - Constructeur de Table - - - - &reftitle.description; - - private mysql_xdevapi\Table::__construct - - - - Construit un objet table. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Table::__construct</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml deleted file mode 100644 index cda0cc3ce3..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Table::count - Renvoie le nombre de lignes - - - - &reftitle.description; - - public intmysql_xdevapi\Table::count - - - - Récupère le nombre de lignes dans la table. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre total de lignes dans la table. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Table::count</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -var_dump($table->count()); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml deleted file mode 100644 index 7d61f5971d..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Table::delete - Supprime des lignes de la table - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\Table::delete - - - - Supprime des lignes d'une table. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet TableDelete; utiliser la méthode execute() pour exécuter la requête de suppression. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Table::delete</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete()->where("name = :name")->orderby("age DESC")->limit(1)->bind(['name' => 'John'])->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml deleted file mode 100644 index 8129d95c44..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Table::existsInDatabase - Vérifie si la table existe dans la base de données - - - - &reftitle.description; - - public boolmysql_xdevapi\Table::existsInDatabase - - - - Vérifie si cette table existe dans la base de données. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si la table existe dans la base de données, sinon &false; si elle n'existe pas. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Table::existsInDatabase</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -if ($table->existsInDatabase()) { - echo "Yes, this table still exists in the session's schema."; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml deleted file mode 100644 index f9e9ac774d..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Table::getName - Renvoie le nom de la table - - - - &reftitle.description; - - public stringmysql_xdevapi\Table::getName - - - - Renvoie le nom de cet objet base de données. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom de cet objet base de données. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Table::getName</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -var_dump($table->getName()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml deleted file mode 100644 index 7b0f3e62f7..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Table::getSchema - Renvoie le schéma de la table - - - - &reftitle.description; - - public mysql_xdevapi\Schemamysql_xdevapi\Table::getSchema - - - - Récupère le schéma associé à la table. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet Schema. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Table::getSchema</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -var_dump($table->getSchema()); -?> -]]> - - &example.outputs.similar; - - - string(11) "addressbook" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml deleted file mode 100644 index aacd3bf4ee..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Table::getSession - Renvoie la session de la table - - - - &reftitle.description; - - public mysql_xdevapi\Sessionmysql_xdevapi\Table::getSession - - - - Obtient la session associée à la table. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet Session. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Table::getSession</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -var_dump($table->getSession()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml deleted file mode 100644 index 949c2b57b7..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Table::insert - Insère des lignes dans une table - - - - &reftitle.description; - - public mysql_xdevapi\TableInsertmysql_xdevapi\Table::insert - mixedcolumns - mixedmore_columns - - - Insère des lignes dans une table. - - - - - - &reftitle.parameters; - - - columns - - - Les colonnes dans lesquelles insérer les données. Peut être un tableau - avec une ou plusieurs valeurs, ou une chaîne de caractères. - - - - - more_columns - - - Des définitions de colonnes supplémentaires. - - - - - - - - &reftitle.returnvalues; - - Un objet TableInsert; utiliser la méthode execute() pour exécuter l'instruction d'insertion. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Table::insert</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table ->insert("name", "age") - ->values(["Suzanne", 31],["Julie", 43]) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml deleted file mode 100644 index 730e103050..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Table::isView - Renvoie si la table est une vue - - - - &reftitle.description; - - public boolmysql_xdevapi\Table::isView - - - - Détermine si l'objet sous-jacent est une vue ou non. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si l'objet sous-jacent est une vue, sinon &false;. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Table::isView</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -if ($table->isView()) { - echo "This is a view."; -} else { - echo "This is not a view."; -} -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml deleted file mode 100644 index fc898b9f05..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Table::select - Sélectionne des lignes dans une table - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\Table::select - mixedcolumns - mixedmore_columns - - - Récupère des données dans une table. - - - - - - &reftitle.parameters; - - - columns - - - Les colonnes à partir desquelles récupérer les données. Peut être un tableau - avec une ou plusieurs valeurs, ou une chaîne de caractères. - - - - - more_columns - - - Des définitions de colonnes supplémentaires. - - - - - - - - &reftitle.returnvalues; - - Un objet TableSelect; utiliser la méthode execute() pour exécuter la - sélection et retourner un objet RowResult. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Table::count</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->execute()->fetchAll(); - -print_r($row); -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml deleted file mode 100644 index 96b050430a..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Table::update - Met à jour les lignes de la table - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\Table::update - - - - Met à jour les colonnes d'une table. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet TableUpdate; utiliser la méthode execute() pour exécuter l'instruction de mise à jour. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Table::update</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->update()->set('age',34)->where('name = "Sam"')->limit(1)->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml deleted file mode 100644 index b96d98b9a1..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - TableDelete::bind - Lie les paramètres de la requête de suppression - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::bind - arrayplaceholder_values - - - Lie une valeur à un espace réservé. - - - - - - &reftitle.parameters; - - - placeholder_values - - - Le nom de l'espace réservé et la valeur à lier. - - - - - - - - &reftitle.returnvalues; - - Un objet TableDelete - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableDelete::bind</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("name = :name") - ->bind(['name' => 'John']) - ->orderby("age DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml deleted file mode 100644 index fe19d633ae..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - TableDelete::__construct - Constructeur de TableDelete - - - - &reftitle.description; - - private mysql_xdevapi\TableDelete::__construct - - - - Initialisé en utilisant la méthode delete(). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableDelete::__construct</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("name = :name") - ->bind(['name' => 'John']) - ->orderby("age DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml deleted file mode 100644 index ba536086a8..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - TableDelete::execute - Exécute la requête de suppression - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\TableDelete::execute - - - - Exécute la requête de suppression. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet Result. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableDelete::execute</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("name = :name") - ->bind(['name' => 'John']) - ->orderby("age DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml deleted file mode 100644 index 5283588bd1..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - TableDelete::limit - Limite les lignes supprimées - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::limit - introws - - - Définit le nombre maximum d'enregistrements ou de documents à supprimer. - - - - - - &reftitle.parameters; - - - rows - - - Le maximum d'enregistrements ou de documents à supprimer. - - - - - - - - &reftitle.returnvalues; - - Un objet TableDelete. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableDelete::limit</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("name = :name") - ->bind(['name' => 'John']) - ->orderby("age DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml deleted file mode 100644 index 2f16adb503..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - TableDelete::orderby - Définit les critères de tri de la suppression - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::orderby - stringorderby_expr - - - Définit les options de tri pour un ensemble de résultats. - - - - - - &reftitle.parameters; - - - orderby_expr - - - La définition du tri. - - - - - - - - &reftitle.returnvalues; - - Un objet TableDelete. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableDelete::orderBy</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("age = :age") - ->bind(['age' => 42]) - ->orderby("name DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml deleted file mode 100644 index a620201654..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - TableDelete::where - Définit la condition de recherche de suppression - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::where - stringwhere_expr - - - Définit la condition de recherche pour filtrer. - - - - - - &reftitle.parameters; - - - where_expr - - - Définit la condition de recherche pour filtrer les documents ou les enregistrements. - - - - - - - - &reftitle.returnvalues; - - Un objet TableDelete. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableDelete::where</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("id = :id") - ->bind(['id' => 42]) - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml deleted file mode 100644 index 0da23a40e0..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - TableInsert::__construct - Constructeur de TableInsert - - - - &reftitle.description; - - private mysql_xdevapi\TableInsert::__construct - - - - Initialisé par la méthode insert(). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableInsert::__construct</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table - ->insert("name", "age") - ->values(["Suzanne", 31],["Julie", 43]) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml deleted file mode 100644 index 5217aef8ef..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - TableInsert::execute - Exécute une requête d'insertion - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\TableInsert::execute - - - - Exécute la déclaration. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet Result. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableInsert::execute</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table - ->insert("name", "age") - ->values(["Suzanne", 31],["Julie", 43]) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml deleted file mode 100644 index 5f1506c839..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - TableInsert::values - Ajoute des valeurs de ligne - - - - &reftitle.description; - - public mysql_xdevapi\TableInsertmysql_xdevapi\TableInsert::values - arrayrow_values - - - Définit les valeurs à insérer. - - - - - - &reftitle.parameters; - - - row_values - - - Les valeurs (un tableau) des colonnes à insérer. - - - - - - - - &reftitle.returnvalues; - - Un objet TableInsert. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableInsert::values</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table - ->insert("name", "age") - ->values(["Suzanne", 31],["Julie", 43]) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml deleted file mode 100644 index be18334816..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - TableSelect::bind - Lie les paramètres de la requête select - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::bind - arrayplaceholder_values - - - Lie une valeur à un espace réservé spécifique. - - - - - - &reftitle.parameters; - - - placeholder_values - - - Le nom de l'espace réservé, et la valeur à lier. - - - - - - - - &reftitle.returnvalues; - - Un objet TableSelect. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableSelect::bind</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name','age') - ->where('name like :name and age > :age') - ->bind(['name' => 'John', 'age' => 42]) - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml deleted file mode 100644 index 12b2f615b6..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - TableSelect::__construct - Constructeur de TableSelect - - - - &reftitle.description; - - private mysql_xdevapi\TableSelect::__construct - - - - Un objet retourné par la méthode select(); utiliser execute() pour - exécuter la requête. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableSelect::__construct</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name','age') - ->where('name like :name and age > :age') - ->bind(['name' => 'John', 'age' => 42]) - ->orderBy('age desc') - ->execute(); - -$row = $result->fetchAll(); -print_r($row); - -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml deleted file mode 100644 index 88e958bf5a..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - TableSelect::execute - Exécute une déclaration select - - - - &reftitle.description; - - public mysql_xdevapi\RowResultmysql_xdevapi\TableSelect::execute - - - - Exécute la déclaration select en la chaînant avec la méthode execute(). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet RowResult. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableSelect::execute</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name','age') - ->where('name like :name and age > :age') - ->bind(['name' => 'John', 'age' => 42]) - ->orderBy('age desc') - ->execute(); - -$row = $result->fetchAll(); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml deleted file mode 100644 index 4f1855f0b6..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - TableSelect::groupBy - Définit les critères de regroupement de la sélection - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::groupBy - mixedsort_expr - - - Définit un critère de regroupement pour le jeu de résultats. - - - - - - &reftitle.parameters; - - - sort_expr - - - Le critère de regroupement. - - - - - - - - &reftitle.returnvalues; - - Un objet TableSelect. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableSelect::groupBy</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 42)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('Suki', 31)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('count(*) as count', 'age') - ->groupBy('age')->orderBy('age asc') - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [count] => 1 - [age] => 31 - ) - [1] => Array - ( - [count] => 2 - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml deleted file mode 100644 index bb75c48811..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - TableSelect::having - Définit la condition de regroupement - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::having - stringsort_expr - - - Définit une condition pour les enregistrements à considérer dans les opérations de fonction d'agrégation. - - - - - &reftitle.parameters; - - - sort_expr - - - Une condition sur les fonctions d'agrégation utilisées sur les critères de regroupement. - - - - - - - - &reftitle.returnvalues; - - Un objet TableSelect. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableSelect::having</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 42)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('Suki', 31)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('count(*) as count', 'age') - ->groupBy('age')->orderBy('age asc') - ->having('count > 1') - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [count] => 2 - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml deleted file mode 100644 index 6ce6c50bf1..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - TableSelect::limit - Limite les lignes sélectionnées - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::limit - introws - - - Définit le nombre maximum d'enregistrements ou de documents à retourner. - - - - - - &reftitle.parameters; - - - rows - - - Le nombre maximum d'enregistrements ou de documents. - - - - - - - - &reftitle.returnvalues; - - Un objet TableSelect. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableSelect::limit</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name', 'age') - ->limit(1) - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml deleted file mode 100644 index c09d01110a..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - TableSelect::lockExclusive - Exécute EXCLUSIVE LOCK - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::lockExclusive - intlock_waiting_option - - - Exécute une opération de lecture avec EXCLUSIVE LOCK. Un seul verrou peut être actif à la fois. - - - - - - &reftitle.parameters; - - - lock_waiting_option - - - Une option d'attente facultative qui est définie par défaut sur MYSQLX_LOCK_DEFAULT. - Les valeurs valides sont : - - - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED - - - - - - - - &reftitle.returnvalues; - - Un objet TableSelect. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableSelect::lockExclusive</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$session->startTransaction(); - -$result = $table->select('name', 'age') - ->lockExclusive(MYSQLX_LOCK_NOWAIT) - ->execute(); - -$session->commit(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml deleted file mode 100644 index ffb75932bd..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - TableSelect::lockShared - Exécute SHARED LOCK - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::lockShared - intlock_waiting_option - - - Exécute une opération de lecture avec SHARED LOCK. Un seul verrou peut être actif à la fois. - - - - - - &reftitle.parameters; - - - lock_waiting_option - - - Une option d'attente facultative qui est définie par défaut sur MYSQLX_LOCK_DEFAULT. - Les valeurs valides sont : - - - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED - - - - - - - - &reftitle.returnvalues; - - Un objet TableSelect. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableSelect::lockShared</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$session->startTransaction(); - -$result = $table->select('name', 'age') - ->lockShared(MYSQLX_LOCK_NOWAIT) - ->execute(); - -$session->commit(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml deleted file mode 100644 index 07c22165f2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - TableSelect::offset - Définit le décalage de la limite - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::offset - intposition - - - Ignore un nombre donné de lignes dans le résultat. - - - - - - &reftitle.parameters; - - - position - - - Le décalage de la limite. - - - - - - - - &reftitle.returnvalues; - - Un objet TableSelect. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableSelect::offset</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 42)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name', 'age') - ->limit(1) - ->offset(1) - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => Sam - [age] => 42 - ) -) -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml deleted file mode 100644 index f20216a1b6..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - TableSelect::orderby - Définit les critères de tri de la sélection - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::orderby - mixedsort_expr - mixedsort_exprs - - - Définit les critères de tri. - - - - - - &reftitle.parameters; - - - sort_expr - - - L'expression qui définit les critères de tri. Peut être un tableau - avec une ou plusieurs expressions, ou une chaîne de caractères. - - - - - sort_exprs - - - Des paramètres supplémentaires pour sort_expr. - - - - - - - - &reftitle.returnvalues; - - Un objet TableSelect. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableSelect::orderBy</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name', 'age') - ->orderBy('name desc') - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => Sam - [age] => 42 - ) - [1] => Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml deleted file mode 100644 index 0a8fb5d8a3..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - TableSelect::where - Définit les critères de recherche de la sélection - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::where - stringwhere_expr - - - Définit les conditions de recherche pour filtrer. - - - - - - &reftitle.parameters; - - - where_expr - - - Définit la condition de recherche pour filtrer les documents ou les enregistrements. - - - - - - - - &reftitle.returnvalues; - - Un objet TableSelect. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableSelect::where</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name','age') - ->where('name like :name and age > :age') - ->bind(['name' => 'John', 'age' => 42]) - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml deleted file mode 100644 index dbc68a955b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - TableUpdate::bind - Lie les paramètres de la requête de mise à jour - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::bind - arrayplaceholder_values - - - Lie une valeur à un emplacement spécifique. - - - - - - &reftitle.parameters; - - - placeholder_values - - - Le nom de l'emplacement réservé, et la valeur à lier, définis - comme un tableau JSON. - - - - - - - - &reftitle.returnvalues; - - Un objet TableUpdate. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableUpdate::bind</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->update() - ->set('status', 'admin') - ->where('name = :name and age > :age') - ->bind(['name' => 'Bernie', 'age' => 2000]) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml deleted file mode 100644 index fc0a857195..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - TableUpdate::__construct - Constructeur de TableUpdate - - - - &reftitle.description; - - private mysql_xdevapi\TableUpdate::__construct - - - - Initialisé par la méthode update(). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableUpdate::__construct</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml deleted file mode 100644 index 0880d958be..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - TableUpdate::execute - Exécute la requête de mise à jour - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::execute - - - - Exécute la déclaration de mise à jour. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet TableUpdate. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableUpdate::execute</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml deleted file mode 100644 index ac00f5de3c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - TableUpdate::limit - Limite le nombre de lignes mises à jour - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::limit - introws - - - Définit le nombre maximum de lignes ou de documents à mettre à jour. - - - - - - &reftitle.parameters; - - - rows - - - Le nombre maximum de lignes ou de documents à mettre à jour. - - - - - - - - &reftitle.returnvalues; - - Un objet TableUpdate. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableUpdate::limit</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml deleted file mode 100644 index 5ac73f688c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - TableUpdate::orderby - Définit les critères de tri - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::orderby - mixedorderby_expr - mixedorderby_exprs - - - Définit les critères de tri. - - - - - - &reftitle.parameters; - - - orderby_expr - - - L'expression qui définit les critères de tri. Peut être un tableau - avec une ou plusieurs expressions, ou une chaîne de caractères. - - - - - orderby_exprs - - - Des paramètres supplémentaires pour les expressions de tri. - - - - - - - - &reftitle.returnvalues; - - Un objet TableUpdate. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableUpdate::orderby</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml deleted file mode 100644 index b7b32611cc..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - TableUpdate::set - Ajoute un champ à mettre à jour - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::set - stringtable_field - stringexpression_or_literal - - - Met à jour la valeur de la colonne sur les enregistrements d'une table. - - - - - - &reftitle.parameters; - - - table_field - - - Le nom de la colonne à mettre à jour. - - - - - expression_or_literal - - - La valeur à définir sur la colonne spécifiée. - - - - - - - - &reftitle.returnvalues; - - Un objet TableUpdate. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableUpdate::set</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml deleted file mode 100644 index a4c716e2e3..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - TableUpdate::where - Définit le filtre de recherche - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::where - stringwhere_expr - - - Définit la condition de recherche pour filtrer. - - - - - - &reftitle.parameters; - - - where_expr - - - La condition de recherche pour filtrer les documents ou les enregistrements. - - - - - - - - &reftitle.returnvalues; - - Un objet TableUpdate. - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\TableUpdate::where</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml deleted file mode 100644 index b34ba72e49..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Warning::__construct - Constructeur de Warning - - - - &reftitle.description; - - private mysql_xdevapi\Warning::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - &reftitle.examples; - - Exemple de <function>mysql_xdevapi\Warning::__construct</function> - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/reference.xml b/reference/mysql_xdevapi/reference.xml deleted file mode 100644 index 16ef3b8b40..0000000000 --- a/reference/mysql_xdevapi/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; Mysql_xdevapi - - &reference.mysql-xdevapi.entities.functions; - - - - diff --git a/reference/mysql_xdevapi/setup.xml b/reference/mysql_xdevapi/setup.xml deleted file mode 100644 index 038d17038b..0000000000 --- a/reference/mysql_xdevapi/setup.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Cette extension nécessite un serveur MySQL 8+ avec le plugin X - activé (par défaut). - - - Les bibliothèques prérequises pour compiler cette extension sont : - Boost (1.53.0 ou supérieur), OpenSSL et Protobuf. - - -
    - -
    - &reftitle.install; - - - &pecl.moved; - - - - Un exemple de procédure d'installation sur Ubuntu 18.04 avec PHP 7.2 : - - - - - - - La commande pecl install n'active pas les extensions PHP (par défaut) - et activer les extensions PHP peut se faire de plusieurs manières. - Un autre exemple avec PHP 7.2 sur Ubuntu 18.04 : - - - - /etc/php/7.2/mods-available/mysql_xdevapi.ini - -// Utiliser la commande 'phpenmod' (note: spécifique à Debian/Ubuntu) -$ phpenmod -v 7.2 -s ALL mysql_xdevapi - -// Une alternative à 'phpenmod' est de créer un lien symbolique manuellement -// $ ln -s /etc/php/7.2/mods-available/mysql_xdevapi.ini /etc/php/7.2/cli/conf.d/20-mysql_xdevapi.ini - -// Voyons quelles extensions MySQL sont activées maintenant -$ php -m |grep mysql - -mysql_xdevapi -mysqli -mysqlnd -pdo_mysql -]]> - - - - &pecl.info; - &url.pecl.package;mysql_xdevapi. - -
    - - - &reference.mysql-xdevapi.ini; - - -
    - Compiler à partir des sources - - Considérations pour compiler cette extension à partir des sources. - - - - - - Le nom de l'extension est 'mysql_xdevapi', donc utiliser --enable-mysql-xdevapi. - - - - - Boost; requis, utiliser optionnellement l'option de configuration --with-boost=DIR - ou définir la variable d'environnement MYSQL_XDEVAPI_BOOST_ROOT. Seuls les - fichiers d'en-tête boost sont requis; pas les binaires. - - - - - Google Protocol Buffers (protobuf): requis, utiliser optionnellement l'option de configuration - --with-protobuf=DIR ou définir la variable d'environnement MYSQL_XDEVAPI_PROTOBUF_ROOT. - - - Optionnellement utiliser make protobufs pour générer les fichiers protobuf (*.pb.cc/.h), - et make clean-protobufs pour supprimer les fichiers protobuf générés. - - - Note spécifique à Windows : selon l'environnement, la bibliothèque statique avec - un runtime DLL multi-thread peut être nécessaire. - Pour préparer, utiliser les options suivantes : - -Dprotobuf_MSVC_STATIC_RUNTIME=OFF -Dprotobuf_BUILD_SHARED_LIBS=OFF - - - - - Google Protocol Buffers / protoc: requis, il faut s'assurer que le bon - 'protoc' est disponible dans le PATH lors de la compilation. C'est particulièrement - important car les scripts batch du SDK PHP Windows peuvent écraser l'environnement. - - - - - Bison: requis, et disponible dans le PATH. - - - Note spécifique à bison Windows: nous recommandons fortement d'utiliser bison - fourni avec le SDK PHP choisi, sinon une erreur similaire à "zend_globals_macros.h(39): - error C2375: 'zendparse': redefinition; different linkage - Zend/zend_language_parser.h(214): note: see declaration of 'zendparse'" peut - être le résultat. De plus, les scripts batch du SDK PHP Windows peuvent écraser l'environnement. - - - - - Note spécifique à Windows: pour préparer l'environnement, voir la documentation officielle - de construction Windows pour - le SDK actuel. - - - Nous recommandons d'utiliser les antislash '\\' au lieu d'un slash '/' pour tous les chemins. - - - -
    -     - - diff --git a/reference/oauth/book.xml b/reference/oauth/book.xml deleted file mode 100644 index ae341a9972..0000000000 --- a/reference/oauth/book.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - OAuth - - - &reftitle.intro; - - Cette extension fournit un client et un prestataire de service OAuth 1.0a. OAuth est un protocole d'autorisation - qui est construit sur HTTP, et qui permet aux applications de sécuriser - l'accès aux données sans avoir à stocker de noms d'utilisateurs et de mots - de passe. - - - - &reference.oauth.setup; - &reference.oauth.constants; - &reference.oauth.examples; - &reference.oauth.reference; - &reference.oauth.oauth; - &reference.oauth.oauthprovider; - &reference.oauth.oauthexception; - - - diff --git a/reference/oauth/configure.xml b/reference/oauth/configure.xml deleted file mode 100644 index 8705344c9a..0000000000 --- a/reference/oauth/configure.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - -
    - &reftitle.install; - - &pecl.info; - &url.pear.package;oauth - -
    - diff --git a/reference/oauth/constants.xml b/reference/oauth/constants.xml deleted file mode 100644 index 852952069e..0000000000 --- a/reference/oauth/constants.xml +++ /dev/null @@ -1,352 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - La plupart de ces constantes impliquent des problèmes décrits dans la documentation - officielle de rapport de problèmes - d'OAuth. Il est à noter cependant que les noms des constantes sont spécifiques à PHP, malgré - le fait que le schéma de nommage soit similaire. - - - - - OAUTH_SIG_METHOD_RSASHA1 - (string) - - - - Méthode de signature OAuth RSA-SHA1. - - - - - - OAUTH_SIG_METHOD_HMACSHA1 - (string) - - - - Méthode de signature OAuth HMAC-SHA1. - - - - - - OAUTH_SIG_METHOD_HMACSHA256 - (string) - - - - Méthode de signature OAuth HMAC-SHA256. - - - - - - OAUTH_AUTH_TYPE_AUTHORIZATION - (string) - - - - Cette constante représente les paramètres OAuth dans l'en-tête Authorization. - - - - - - OAUTH_AUTH_TYPE_NONE - (string) - - - - Cette constante indique une requête NoAuth OAuth. - - - - - - OAUTH_AUTH_TYPE_URI - (string) - - - - Cette constante représente les paramètres OAuth dans l'URI de requête. - - - - - - OAUTH_AUTH_TYPE_FORM - (string) - - - - Cette constante représente les paramètres OAuth comme une partie - du corps HTTP POST. - - - - - - OAUTH_HTTP_METHOD_GET - (string) - - - - Utilise la méthode GET pour la requête OAuth. - - - - - - OAUTH_HTTP_METHOD_POST - (string) - - - - Utilise la méthode POST pour la requête OAuth. - - - - - - OAUTH_HTTP_METHOD_PUT - (string) - - - - Utilise la méthode PUT pour la requête OAuth. - - - - - - OAUTH_HTTP_METHOD_HEAD - (string) - - - - Utilise la méthode HEAD pour la requête OAuth. - - - - - - OAUTH_HTTP_METHOD_DELETE - (string) - - - - Utilise la méthode DELETE pour la requête OAuth. - - - - - - OAUTH_REQENGINE_STREAMS - (int) - - - - Utilisé par la méthode Oauth::setRequestEngine - pour définir le moteur de flux PHP, - à l'opposé de OAUTH_REQENGINE_CURL pour - Curl. - - - - - - OAUTH_REQENGINE_CURL - (int) - - - - Utilisé par la méthode Oauth::setRequestEngine - pour définir le moteur de Curl, - à l'opposé de OAUTH_REQENGINE_STREAMS pour - les flux PHP. - - - - - - OAUTH_OK - (int) - - - - La vie est belle. - - - - - - OAUTH_BAD_NONCE - (int) - - - - La valeur oauth_nonce a été utilisée pour une - précédente requête, et ne peut être utilisée maintenant. - - - - - - OAUTH_BAD_TIMESTAMP - (int) - - - - La valeur oauth_timestamp n'est pas acceptée - par le prestataire de service. Dans ce cas, la réponse devra aussi contenir - le paramètre oauth_acceptable_timestamps. - - - - - - OAUTH_CONSUMER_KEY_UNKNOWN - (int) - - - - oauth_consumer_key est temporairement inacceptable - par le prestataire de service. Par exemple, le prestataire de service - limite le débit du consommateur. - - - - - - OAUTH_CONSUMER_KEY_REFUSED - (int) - - - - La clé du consommateur a été refusée. - - - - - - OAUTH_INVALID_SIGNATURE - (int) - - - - oauth_signature est invalide car elle ne correspond - pas à la signature calculée par le prestataire de service. - - - - - - OAUTH_TOKEN_USED - (int) - - - - oauth_token a été consommé. Il ne peut plus être utilisé - car il a déjà été utilisé dans une ou plusieurs précédentes requêtes. - - - - - - OAUTH_TOKEN_EXPIRED - (int) - - - - oauth_token a expiré. - - - - - - OAUTH_TOKEN_REVOKED - (int) - - - - oauth_token a été révoqué et ne pourra plus être accepté. - - - - - - OAUTH_TOKEN_REJECTED - (int) - - - - oauth_token n'a pas été acceptée par le prestataire de - service. La raison est inconnue, mais il se peut que le jeton n'ait jamais - été utilisé, ait déjà été consommé, ait expiré et/ou ait été oublié par le - prestataire de service. - - - - - - OAUTH_VERIFIER_INVALID - (int) - - - - oauth_verifier est incorrect. - - - - - - OAUTH_PARAMETER_ABSENT - (int) - - - - Un paramètre requis n'a pas été reçu. Dans ce cas, la réponse devra également - contenir le paramètre oauth_parameters_absent. - - - - - - OAUTH_SIGNATURE_METHOD_REJECTED - (int) - - - - oauth_signature_method n'a pas été accepté par le prestataire - de service. - - - - - - diff --git a/reference/oauth/examples.xml b/reference/oauth/examples.xml deleted file mode 100644 index c48056ea36..0000000000 --- a/reference/oauth/examples.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - &reftitle.examples; - -
    - FireEagle - - - <programlisting role="php" xml:id="oauth.examples.fireeagle.location"> -<![CDATA[ -<?php -$req_url = 'https://fireeagle.yahooapis.com/oauth/request_token'; -$authurl = 'https://fireeagle.yahoo.net/oauth/authorize'; -$acc_url = 'https://fireeagle.yahooapis.com/oauth/access_token'; -$api_url = 'https://fireeagle.yahooapis.com/api/0.1'; -$conskey = 'your_consumer_key'; -$conssec = 'your_consumer_secret'; - -session_start(); - -// En état state=1 la prochaine requête doit inclure le oauth_token. -// Si ce n'est pas le cas, retour à 0 -if(!isset($_GET['oauth_token']) && $_SESSION['state']==1) $_SESSION['state'] = 0; -try { - $oauth = new OAuth($conskey,$conssec,OAUTH_SIG_METHOD_HMACSHA1,OAUTH_AUTH_TYPE_URI); - $oauth->enableDebug(); - if(!isset($_GET['oauth_token']) && !$_SESSION['state']) { - $request_token_info = $oauth->getRequestToken($req_url); - $_SESSION['secret'] = $request_token_info['oauth_token_secret']; - $_SESSION['state'] = 1; - header('Location: '.$authurl.'?oauth_token='.$request_token_info['oauth_token']); - exit; - } else if($_SESSION['state']==1) { - $oauth->setToken($_GET['oauth_token'],$_SESSION['secret']); - $access_token_info = $oauth->getAccessToken($acc_url); - $_SESSION['state'] = 2; - $_SESSION['token'] = $access_token_info['oauth_token']; - $_SESSION['secret'] = $access_token_info['oauth_token_secret']; - } - $oauth->setToken($_SESSION['token'],$_SESSION['secret']); - $oauth->fetch("$api_url/user.json"); - $json = json_decode($oauth->getLastResponse()); - print_r($json); -} catch(OAuthException $E) { - print_r($E); -} -?> -]]> - </programlisting> - </example> - </section> - -</chapter> -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/oauth/functions/oauth-get-sbs.xml b/reference/oauth/functions/oauth-get-sbs.xml deleted file mode 100644 index 9c79465148..0000000000 --- a/reference/oauth/functions/oauth-get-sbs.xml +++ /dev/null @@ -1,81 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: yannick Status: ready --> -<!-- Reviewed: no --> -<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.oauth-get-sbs"> - <refnamediv> - <refname>oauth_get_sbs</refname> - <refpurpose>Génère une chaîne de base de signature</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>oauth_get_sbs</methodname> - <methodparam><type>string</type><parameter>http_method</parameter></methodparam> - <methodparam><type>string</type><parameter>uri</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>request_parameters</parameter></methodparam> - </methodsynopsis> - <simpara> - Génère une chaîne de base de signature pour pecl/oauth. - </simpara> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <variablelist> - <varlistentry> - <term><parameter>http_method</parameter></term> - <listitem> - <simpara> - La méthode HTTP. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>uri</parameter></term> - <listitem> - <simpara> - L'URI à encoder. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>request_parameters</parameter></term> - <listitem> - <simpara> - Tableau de paramètres de requêtes. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <simpara> - Retourne une chaîne, la <literal>Signature Base String</literal>. - </simpara> - </refsect1> - -</refentry> -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/oauth/functions/oauth-urlencode.xml b/reference/oauth/functions/oauth-urlencode.xml deleted file mode 100644 index 9787a8ef74..0000000000 --- a/reference/oauth/functions/oauth-urlencode.xml +++ /dev/null @@ -1,63 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: dams Status: ready --> -<!-- Reviewed: no --> -<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.oauth-urlencode"> - <refnamediv> - <refname>oauth_urlencode</refname> - <refpurpose>Encode une URI conformément à RFC 3986</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>oauth_urlencode</methodname> - <methodparam><type>string</type><parameter>uri</parameter></methodparam> - </methodsynopsis> - <simpara> - Encode une URI conformément à <link xlink:href="&url.rfc;3986">RFC 3986</link>. - </simpara> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <variablelist> - <varlistentry> - <term><parameter>uri</parameter></term> - <listitem> - <simpara> - L'URI à encoder. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <simpara> - Retourne une chaîne encodée conformément à <link xlink:href="&url.rfc;3986">RFC 3986</link>. - </simpara> - </refsect1> - -</refentry> -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/oauth/oauth.xml b/reference/oauth/oauth.xml deleted file mode 100644 index e4dcc35bdf..0000000000 --- a/reference/oauth/oauth.xml +++ /dev/null @@ -1,111 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: yannick Status: ready --> -<!-- Reviewed: yes --> -<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.oauth" role="class"> - <title>&class.theclass; <classname>OAuth</classname> - OAuth - - - - -
    - &reftitle.intro; - - L'extension OAuth fournit une interface simple pour interagir avec - des fournisseurs de données, en utilisant les spécifications OAuth HTTP - pour protéger les ressources. - -
    - - -
    - &reftitle.classsynopsis; - - - - OAuth - - - - - OAuth - - - - - &Properties; - - public - debug - - - public - sslChecks - - - public - debugInfo - - - &Methods; - - - - - - - - - -
    - -
    - &reftitle.properties; - - - debug - - - - - - sslChecks - - - - - - debugInfo - - - - - -
    - -     - - &reference.oauth.entities.oauth; - - - diff --git a/reference/oauth/oauth/construct.xml b/reference/oauth/oauth/construct.xml deleted file mode 100644 index 34a21a17fe..0000000000 --- a/reference/oauth/oauth/construct.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - OAuth::__construct - Crée un nouvel objet OAuth - - - - &reftitle.description; - - public OAuth::__construct - stringconsumer_key - stringconsumer_secret - stringsignature_methodOAUTH_SIG_METHOD_HMACSHA1 - intauth_type0 - - - Crée un nouvel objet OAuth. - - - - - &reftitle.parameters; - - - consumer_key - - - La clé du consommateur fournie par le fournisseur de services. - - - - - consumer_secret - - - Le secret du consommateur fourni par le fournisseur de services. - - - - - signature_method - - - Ce paramètre optionnel définit la méthode de signature utilisée. - Par défaut, c'est OAUTH_SIG_METHOD_HMACSHA1 (HMAC-SHA1). - - - - - auth_type - - - Ce paramètre optionnel définit la méthode de passage des - paramètres OAuth au consommateur. Par défaut, c'est - OAUTH_AUTH_TYPE_AUTHORIZATION (dans l'en-tête - Authorization). - - - - - - - - diff --git a/reference/oauth/oauth/destruct.xml b/reference/oauth/oauth/destruct.xml deleted file mode 100644 index ad9a06b34c..0000000000 --- a/reference/oauth/oauth/destruct.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - OAuth::__destruct - Le destructeur - - - - &reftitle.description; - - public voidOAuth::__destruct - - - - Le destructeur. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - OAuth::__construct - - - - - diff --git a/reference/oauth/oauth/disabledebug.xml b/reference/oauth/oauth/disabledebug.xml deleted file mode 100644 index 9eda304853..0000000000 --- a/reference/oauth/oauth/disabledebug.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - OAuth::disableDebug - Désactive les messages de débogage - - - - &reftitle.description; - - public boolOAuth::disableDebug - - - - Désactive les messages de débogage. Il est désactivé par défaut. - Il est possible de définir la propriété debug - à &false; pour désactiver le débogage. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 0.99.8 - - La propriété debug a été ajoutée - - - - - - - - - &reftitle.seealso; - - OAuth::enableDebug - - - - - diff --git a/reference/oauth/oauth/disableredirects.xml b/reference/oauth/oauth/disableredirects.xml deleted file mode 100644 index 628a8b1cf1..0000000000 --- a/reference/oauth/oauth/disableredirects.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - OAuth::disableRedirects - Désactive les redirections - - - - &reftitle.description; - - public boolOAuth::disableRedirects - - - - Désactive les redirections, permettant ainsi aux requêtes - d'être redirigées manuellement. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.seealso; - - OAuth::enableRedirects - - - - - diff --git a/reference/oauth/oauth/disablesslchecks.xml b/reference/oauth/oauth/disablesslchecks.xml deleted file mode 100644 index 98394bc769..0000000000 --- a/reference/oauth/oauth/disablesslchecks.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - OAuth::disableSSLChecks - Désactive la vérification SSL - - - - &reftitle.description; - - public boolOAuth::disableSSLChecks - - - - Désactive les vérifications de certificats et d'hôtes SSL (activé par défaut). - Il est recommandé de ne pas utiliser cette fonction en production. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 0.99.8 - - La propriété sslChecks a été ajoutée - - - - - - - - - &reftitle.seealso; - - OAuth::enableSSLChecks - - - - - diff --git a/reference/oauth/oauth/enabledebug.xml b/reference/oauth/oauth/enabledebug.xml deleted file mode 100644 index 346e1708ac..0000000000 --- a/reference/oauth/oauth/enabledebug.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - OAuth::enableDebug - Active les messages de débogage - - - - &reftitle.description; - - public boolOAuth::enableDebug - - - - Active les messages de débogage, pratiques en développement, mais - inutiles en production. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 0.99.8 - - La propriété debug a été ajoutée - - - - - - - - - &reftitle.seealso; - - OAuth::disableDebug - - - - - diff --git a/reference/oauth/oauth/enableredirects.xml b/reference/oauth/oauth/enableredirects.xml deleted file mode 100644 index 301be3ac16..0000000000 --- a/reference/oauth/oauth/enableredirects.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - OAuth::enableRedirects - Active les redirections - - - - &reftitle.description; - - public boolOAuth::enableRedirects - - - - Suit les redirections automatiquement ; c'est le comportement - par défaut. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.seealso; - - OAuth::disableRedirects - - - - - diff --git a/reference/oauth/oauth/enablesslchecks.xml b/reference/oauth/oauth/enablesslchecks.xml deleted file mode 100644 index bd548c1458..0000000000 --- a/reference/oauth/oauth/enablesslchecks.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - OAuth::enableSSLChecks - Active la vérification SSL - - - - &reftitle.description; - - public boolOAuth::enableSSLChecks - - - - Active les vérifications de certificats et d'hôtes SSL (activé par défaut). - Alternativement, la propriété sslChecks peut être définie sur une - valeur différente de &false; pour activer les vérifications SSL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 0.99.8 - - La propriété sslChecks a été ajoutée - - - - - - - - - &reftitle.seealso; - - OAuth::disableSSLChecks - - - - - diff --git a/reference/oauth/oauth/fetch.xml b/reference/oauth/oauth/fetch.xml deleted file mode 100644 index 5ec4e676b5..0000000000 --- a/reference/oauth/oauth/fetch.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - OAuth::fetch - Lit une ressource protégée par OAuth - - - - &reftitle.description; - - public mixedOAuth::fetch - stringprotected_resource_url - arrayextra_parameters - stringhttp_method - arrayhttp_headers - - - Lit une ressource protégée par OAuth. - - - - - &reftitle.parameters; - - - protected_resource_url - - - URL de la ressource protégée par OAuth. - - - - - extra_parameters - - - Paramètres supplémentaires à envoyer avec la requête, à la ressource. - - - - - http_method - - - Une des constantes constantes OAUTH - OAUTH_HTTP_METHOD_*, incluant - GET, POST, PUT, HEAD, ou DELETE. - - - HEAD (OAUTH_HTTP_METHOD_HEAD) peut être utile - pour découvrir des informations avant la demande (si les autorisations - OAuth sont dans l'en-tête Authorization). - - - - - http_headers - - - Les en-têtes client HTTP (tels que User-Agent, - Accept, etc.) - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - PECL oauth 0.99.5 - - Ajout du paramètre http_method - - - - PECL oauth 0.99.8 - - Ajout du paramètre http_headers - - - - - - - - - &reftitle.examples; - - Exemple avec <function>OAuth::fetch</function> - -setToken("access_token","access_token_secret"); - - $oauth->fetch("http://photos.example.net/photo?file=vacation.jpg"); - - $response_info = $oauth->getLastResponseInfo(); - header("Content-Type: {$response_info["content_type"]}"); - echo $oauth->getLastResponse(); -} catch(OAuthException $E) { - echo "Exception caught!\n"; - echo "Response: ". $E->lastResponse . "\n"; -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuth::getLastResponse - OAuth::getLastResponseInfo - OAuth::setToken - - - - - diff --git a/reference/oauth/oauth/generatesignature.xml b/reference/oauth/oauth/generatesignature.xml deleted file mode 100644 index c3c0bf3261..0000000000 --- a/reference/oauth/oauth/generatesignature.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - OAuth::generateSignature - Génère une signature - - - - &reftitle.description; - - public stringfalseOAuth::generateSignature - stringhttp_method - stringurl - mixedextra_parameters - - - Génère une signature basée sur la méthode HTTP finale, - l'URL et une chaîne/tableau de paramètres. - - - - - - &reftitle.parameters; - - - http_method - - - Méthode HTTP pour la requête. - - - - - url - - - URL de la requête. - - - - - extra_parameters - - - Chaîne ou tableau de paramètres additionnels. - - - - - - - - &reftitle.returnvalues; - - Une chaîne contenant la signature générée&return.falseforfailure; - - - - - - diff --git a/reference/oauth/oauth/getaccesstoken.xml b/reference/oauth/oauth/getaccesstoken.xml deleted file mode 100644 index 1719c40e68..0000000000 --- a/reference/oauth/oauth/getaccesstoken.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - OAuth::getAccessToken - Récupère un token d'accès - - - - &reftitle.description; - - public arrayOAuth::getAccessToken - stringaccess_token_url - stringauth_session_handle - stringverifier_token - stringhttp_method - - - Lit un token d'accès, un secret et toute information supplémentaire chez - un fournisseur de services. - - - - - &reftitle.parameters; - - - access_token_url - - - L'URL à utiliser. - - - - - auth_session_handle - - - L'identifiant de session. Ce paramètre n'a pas d'existence - dans les spécifications OAuth 1.0, mais peut être mis en - place par de grosses implémentations. Voir - ScalableOAuth - pour plus de détails. - - - - - verifier_token - - - Pour les fournisseurs de service qui supportent 1.0a, - le paramètre verifier_token doit être - fourni, lors de l'échange de token de requête pour obtenir le token - d'accès. Si verifier_token est présent dans - $_GET ou $_POST, il est - automatiquement passé et l'appelant n'a pas besoin de préciser - de paramètre verifier_token (généralement, le token - d'accès est échangé via l'URL de rappel callback_url.). - Voir ScalableOAuth - pour plus d'informations. - - - - - http_method - - - Méthode HTTP à utiliser, par exemple - GET ou POST. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant la réponse OAuth analysée, en cas de succès, - et &false; sinon. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - PECL oauth 0.99.9 - - Le paramètre verifier_token a été ajouté - - - - - - - - - &reftitle.examples; - - Exemple avec <function>OAuth::getAccessToken</function> - -setToken($request_token,$request_token_secret); - $access_token_info = $oauth->getAccessToken("https://example.com/oauth/access_token"); - if(!empty($access_token_info)) { - print_r($access_token_info); - } else { - print "Failed fetching access token, response was: " . $oauth->getLastResponse(); - } -} catch(OAuthException $E) { - echo "Response: ". $E->lastResponse . "\n"; -} -?> -]]> - - &example.outputs.similar; - - some_token - [oauth_token_secret] => some_token_secret -) -]]> - - - - - - &reftitle.seealso; - - OAuth::getLastResponse - OAuth::getLastResponseInfo - OAuth::setToken - - - - - diff --git a/reference/oauth/oauth/getcapath.xml b/reference/oauth/oauth/getcapath.xml deleted file mode 100644 index 03a32d0c3c..0000000000 --- a/reference/oauth/oauth/getcapath.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - OAuth::getCAPath - Récupère l'information CA - - - - &reftitle.description; - - public arrayOAuth::getCAPath - - - - Récupère les informations du certificat de l'autorité, - incluant les valeurs de ca_path et ca_info définies - par la méthode OAuth::setCaPath. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; d'informations sur le certificat de l'autorité, - contenant entre autres, les clés ca_path - et ca_info. - - - - - &reftitle.seealso; - - OAuth::setCAPath - OAuth::getLastResponseInfo - - - - - diff --git a/reference/oauth/oauth/getlastresponse.xml b/reference/oauth/oauth/getlastresponse.xml deleted file mode 100644 index 8a8ee21782..0000000000 --- a/reference/oauth/oauth/getlastresponse.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - OAuth::getLastResponse - Lit la dernière réponse - - - - &reftitle.description; - - public stringOAuth::getLastResponse - - - - Lit la réponse brute de la dernière requête. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne avec la dernière réponse. - - - - - &reftitle.seealso; - - OAuth::getLastResponseInfo - OAuth::fetch - - - - - diff --git a/reference/oauth/oauth/getlastresponseheaders.xml b/reference/oauth/oauth/getlastresponseheaders.xml deleted file mode 100644 index 7ace5e8f47..0000000000 --- a/reference/oauth/oauth/getlastresponseheaders.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - OAuth::getLastResponseHeaders - Récupère les en-têtes de la dernière réponse - - - - &reftitle.description; - - public stringfalseOAuth::getLastResponseHeaders - - - - Récupère les en-têtes de la dernière réponse. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une &string; contenant les en-têtes de la dernière - réponse&return.falseforfailure; - - - - - - diff --git a/reference/oauth/oauth/getlastresponseinfo.xml b/reference/oauth/oauth/getlastresponseinfo.xml deleted file mode 100644 index 5a2fd99d36..0000000000 --- a/reference/oauth/oauth/getlastresponseinfo.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - OAuth::getLastResponseInfo - Lit les informations HTTP de la dernière réponse - - - - &reftitle.description; - - public arrayOAuth::getLastResponseInfo - - - - Lit les informations HTTP de la dernière réponse. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les informations de réponse de - la dernière requête. Les constantes de curl_getinfo - sont aussi utilisables. - - - - - &reftitle.seealso; - - OAuth::fetch - OAuth::getLastResponse - - - - - diff --git a/reference/oauth/oauth/getrequestheader.xml b/reference/oauth/oauth/getrequestheader.xml deleted file mode 100644 index 081479cfca..0000000000 --- a/reference/oauth/oauth/getrequestheader.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - OAuth::getRequestHeader - Génère une signature d'en-tête OAuth - - - - &reftitle.description; - - public stringfalseOAuth::getRequestHeader - stringhttp_method - stringurl - mixedextra_parameters - - - Génère une signature d'en-tête OAuth basée sur la méthode HTTP - finale, ainsi que sur l'URL et ses paramètres. - - - - - &reftitle.parameters; - - - http_method - - - Méthode HTTP pour la demande. - - - - - url - - - URL de la demande. - - - - - extra_parameters - - - Paramètres additionnels (&string; ou tableau). - - - - - - - - &reftitle.returnvalues; - - Une &string; contenant l'en-tête généré de la demande - &return.falseforfailure; - - - - - - diff --git a/reference/oauth/oauth/getrequesttoken.xml b/reference/oauth/oauth/getrequesttoken.xml deleted file mode 100644 index b88057a1a7..0000000000 --- a/reference/oauth/oauth/getrequesttoken.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - OAuth::getRequestToken - Lit le token de requête - - - - &reftitle.description; - - public arrayOAuth::getRequestToken - stringrequest_token_url - stringcallback_url - stringhttp_method - - - Lit le token de requête, le secret et toute information supplémentaire - du fournisseur de services. - - - - - &reftitle.parameters; - - - request_token_url - - - l'URL dont il faut obtenir le token. - - - - - callback_url - - - URL de rappel OAuth. Si callback_url est passé - et que sa valeur est vide, il prend alors la valeur de - "oob" pour satisfaire aux exigences de - OAuth 2009.1 advisory. - - - - - http_method - - - Méthode HTTP à utiliser, par exemple - GET ou POST. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant la réponse OAuth analysée, en cas de succès, - ou &false; en cas d'échec. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - PECL oauth 0.99.9 - - Le paramètre callback_url a été ajouté - - - - - - - - - &reftitle.examples; - - Exemple avec <function>OAuth::getRequestToken</function> - -getRequestToken("https://example.com/oauth/request_token"); - if(!empty($request_token_info)) { - print_r($request_token_info); - } else { - print "Failed fetching request token, response was: " . $oauth->getLastResponse(); - } -} catch(OAuthException $E) { - echo "Response: ". $E->lastResponse . "\n"; -} -?> -]]> - - &example.outputs.similar; - - some_token - [oauth_token_secret] => some_token_secret -) -]]> - - - - - - &reftitle.seealso; - - OAuth::getLastResponse - OAuth::getLastResponseInfo - - - - - diff --git a/reference/oauth/oauth/setauthtype.xml b/reference/oauth/oauth/setauthtype.xml deleted file mode 100644 index 5f4232321a..0000000000 --- a/reference/oauth/oauth/setauthtype.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - OAuth::setAuthType - Définit le type d'autorisation - - - - &reftitle.description; - - public boolOAuth::setAuthType - intauth_type - - - Configure les paramètres OAuth. - - - - - &reftitle.parameters; - - - auth_type - - - auth_type peut être un des options suivantes - (elles sont classées par ordre décroissant de préférence, - tel que précisé dans OAuth 1.0 section 5.2) : - - - OAUTH_AUTH_TYPE_AUTHORIZATION - - - Passe les paramètres OAuth dans l'en-tête HTTP Authorization. - - - - - OAUTH_AUTH_TYPE_FORM - - - Ajoute les paramètres OAuth au corps de la requête HTTP POST. - - - - - OAUTH_AUTH_TYPE_URI - - - Ajoute les paramètres OAuth à l'URI. - - - - - OAUTH_AUTH_TYPE_NONE - - - Aucun. - - - - - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si un paramètre est correctement défini, - &false; dans les autres cas. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - diff --git a/reference/oauth/oauth/setcapath.xml b/reference/oauth/oauth/setcapath.xml deleted file mode 100644 index 24d48c6429..0000000000 --- a/reference/oauth/oauth/setcapath.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - OAuth::setCAPath - Définit le chemin et les informations du CA - - - - &reftitle.description; - - public mixedOAuth::setCAPath - stringca_path - stringca_info - - - Définit le certificat d'autorité (CA), pour - à la fois le chemin et les informations. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - ca_path - - - Le chemin du CA à définir. - - - - - ca_info - - - Les informations du CA à définir. - - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, ou &false; si ca_path - ou ca_info sont considérés comme invalides. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - &reftitle.seealso; - - OAuth::getCaPath - - - - - diff --git a/reference/oauth/oauth/setnonce.xml b/reference/oauth/oauth/setnonce.xml deleted file mode 100644 index 50c11d6a68..0000000000 --- a/reference/oauth/oauth/setnonce.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - OAuth::setNonce - Configure le nonce OAuth - - - - &reftitle.description; - - public mixedOAuth::setNonce - stringnonce - - - Configure le nonce OAuth pour les appels suivants. - - - - - &reftitle.parameters; - - - nonce - - - La valeur d'oauth_nonce. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, ou &false; si le - paramètre nonce est considéré comme - invalide. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - &reftitle.seealso; - - OAuth::setToken - OAuth::setAuthType - OAuth::setVersion - - - - - diff --git a/reference/oauth/oauth/setrequestengine.xml b/reference/oauth/oauth/setrequestengine.xml deleted file mode 100644 index 7bf33f93af..0000000000 --- a/reference/oauth/oauth/setrequestengine.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - OAuth::setRequestEngine - Le but de setRequestEngine - - - - &reftitle.description; - - public voidOAuth::setRequestEngine - intreqengine - - - Définit le moteur de requête, utilisé pour envoyer les requêtes HTTP. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - reqengine - - - Le moteur de requêtes désiré. Définir à OAUTH_REQENGINE_STREAMS - pour utiliser les flux PHP, ou OAUTH_REQENGINE_CURL pour utiliser - Curl. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Émet une exception OAuthException si un moteur - de requêtes invalide est choisi. - - - - - &reftitle.examples; - - Exemple avec <function>OAuth::setRequestEngine</function> - -setRequestEngine(OAUTH_REQENGINE_STREAMS); -?> -]]> - - - - - - &reftitle.seealso; - - Curl - Les flux PHP - OAuthException - - - - diff --git a/reference/oauth/oauth/setrsacertificate.xml b/reference/oauth/oauth/setrsacertificate.xml deleted file mode 100644 index 67743e37d9..0000000000 --- a/reference/oauth/oauth/setrsacertificate.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - OAuth::setRSACertificate - Définit le certificat RSA - - - - &reftitle.description; - - public mixedOAuth::setRSACertificate - stringcert - - - Définit le certificat RSA. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - cert - - - Le certificat RSA. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, ou &false; si une erreur survient - (c.-à-d., le certificat RSA ne peut être analysé.) - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - &reftitle.examples; - - Exemple avec <methodname>OAuth::setRsaCertificate</methodname> - -setRSACertificate(file_get_contents('test.pem')); -?> -]]> - - - - - - &reftitle.seealso; - - OAuth::setCaPath - - - - - diff --git a/reference/oauth/oauth/setsslchecks.xml b/reference/oauth/oauth/setsslchecks.xml deleted file mode 100644 index 204addab25..0000000000 --- a/reference/oauth/oauth/setsslchecks.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - OAuth::setSSLChecks - Définit des vérifications spécifiques à SSL pour les requêtes - - - - &reftitle.description; - - public boolOAuth::setSSLChecks - intsslcheck - - - Définit des vérifications spécifiques à SSL pour les requêtes. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - sslcheck - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/oauth/oauth/settimestamp.xml b/reference/oauth/oauth/settimestamp.xml deleted file mode 100644 index a490528f8c..0000000000 --- a/reference/oauth/oauth/settimestamp.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - OAuth::setTimestamp - Définit le timestamp - - - - &reftitle.description; - - public mixedOAuth::setTimestamp - stringtimestamp - - - Définit le timestamp OAuth pour les prochaines requêtes. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - timestamp - - - Le timestamp. - - - - - - - - &reftitle.returnvalues; - - Retourne &true;, ou &false; si timestamp est invalide. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - &reftitle.seealso; - - OAuth::setNonce - - - - - diff --git a/reference/oauth/oauth/settoken.xml b/reference/oauth/oauth/settoken.xml deleted file mode 100644 index 7fd53d88f2..0000000000 --- a/reference/oauth/oauth/settoken.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - OAuth::setToken - Configure le token et le secret - - - - &reftitle.description; - - public boolOAuth::setToken - stringtoken - stringtoken_secret - - - Configure le token et le secret pour les prochains appels. - - - - - &reftitle.parameters; - - - token - - - Le token OAuth. - - - - - token_secret - - - Le secret OAuth. - - - - - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.examples; - - L'exemple <function>OAuth::setToken</function> - -setToken("token","token-secret"); -?> -]]> - - - - - - diff --git a/reference/oauth/oauth/setversion.xml b/reference/oauth/oauth/setversion.xml deleted file mode 100644 index 6069f3a407..0000000000 --- a/reference/oauth/oauth/setversion.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - OAuth::setVersion - Configure la version OAuth - - - - &reftitle.description; - - public boolOAuth::setVersion - stringversion - - - Configure la version d'OAuth pour les prochains appels. - - - - - &reftitle.parameters; - - - version - - - La version OAuth, et par défaut, c'est toujours "1.0" - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/oauth/oauthexception.xml b/reference/oauth/oauthexception.xml deleted file mode 100644 index 13d8942a62..0000000000 --- a/reference/oauth/oauthexception.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - &class.theclass; <classname>OAuthException</classname> - OAuthException - - - - -
    - &reftitle.intro; - - Cette exception est émise quand des erreurs exceptionnelles - surviennent durant l'utilisation de l'extension OAuth, et - contient des informations pratiques pour déboguer. - -
    - - -
    - &reftitle.classsynopsis; - - - - OAuthException - - - - - OAuthException - - - - extends - Exception - - - - &Properties; - - public - lastResponse - - - public - debugInfo - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - lastResponse - - - La réponse à l'exception survenue, s'il y en a - - - - - debugInfo - - - - - -
    - - -     - -     - diff --git a/reference/oauth/oauthprovider.xml b/reference/oauth/oauthprovider.xml deleted file mode 100644 index 76f095766d..0000000000 --- a/reference/oauth/oauthprovider.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - La classe OAuthProvider - OAuthProvider - - - - -
    - &reftitle.intro; - - Gère une classe OAuthProvider. - - - Voir aussi un tutoriel externe nommé - Écrire un service OAuth Provider, - qui fournit une bonne approche pour proposer ce service. Il y a également des - exemples OAuth provider directement - dans les sources de l'extension OAuth. - -
    - - -
    - &reftitle.classsynopsis; - - - - OAuthProvider - - - - - OAuthProvider - - - - - &Methods; - - - - -
    - -     - - &reference.oauth.entities.oauthprovider; - -     - diff --git a/reference/oauth/oauthprovider/addrequiredparameter.xml b/reference/oauth/oauthprovider/addrequiredparameter.xml deleted file mode 100644 index 84ad04da77..0000000000 --- a/reference/oauth/oauthprovider/addrequiredparameter.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - OAuthProvider::addRequiredParameter - Ajoute des paramètres requis - - - - &reftitle.description; - - final public boolOAuthProvider::addRequiredParameter - stringreq_params - - - Ajoute des paramètres requis oauth provider. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - req_params - - - Les paramètres requis. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - OAuthProvider::removeRequiredParameter - - - - - diff --git a/reference/oauth/oauthprovider/callconsumerhandler.xml b/reference/oauth/oauthprovider/callconsumerhandler.xml deleted file mode 100644 index 3b600838f3..0000000000 --- a/reference/oauth/oauthprovider/callconsumerhandler.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - OAuthProvider::callconsumerHandler - Appelle la fonction de rappel consumerNonceHandler - - - - &reftitle.description; - - public voidOAuthProvider::callconsumerHandler - - - - Appelle la fonction de rappel consumer handler, qui a été définie par la méthode - OAuthProvider::consumerHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &oauth.callback.error; - - - - - &reftitle.seealso; - - OAuthProvider::consumerHandler - - - - - diff --git a/reference/oauth/oauthprovider/calltimestampnoncehandler.xml b/reference/oauth/oauthprovider/calltimestampnoncehandler.xml deleted file mode 100644 index 6b47dbef4f..0000000000 --- a/reference/oauth/oauthprovider/calltimestampnoncehandler.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - OAuthProvider::callTimestampNonceHandler - Appelle la fonction de rappel timestampNonceHandler - - - - &reftitle.description; - - public voidOAuthProvider::callTimestampNonceHandler - - - - Appelle la fonction de rappel timestamp handler, qui a été définie par la méthode - OAuthProvider::timestampNonceHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &oauth.callback.error; - - - - - &reftitle.seealso; - - OAuthProvider::timestampNonceHandler - - - - - diff --git a/reference/oauth/oauthprovider/calltokenhandler.xml b/reference/oauth/oauthprovider/calltokenhandler.xml deleted file mode 100644 index 4076dc039b..0000000000 --- a/reference/oauth/oauthprovider/calltokenhandler.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - OAuthProvider::calltokenHandler - Appelle la fonction de rappel tokenNonceHandler - - - - &reftitle.description; - - public voidOAuthProvider::calltokenHandler - - - - Appelle la fonction de rappel token handler, qui a été définie par la méthode - OAuthProvider::tokenHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &oauth.callback.error; - - - - - &reftitle.seealso; - - OAuthProvider::tokenHandler - - - - - diff --git a/reference/oauth/oauthprovider/checkoauthrequest.xml b/reference/oauth/oauthprovider/checkoauthrequest.xml deleted file mode 100644 index 2e5f469284..0000000000 --- a/reference/oauth/oauthprovider/checkoauthrequest.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - OAuthProvider::checkOAuthRequest - Vérifie une requête OAuth - - - - &reftitle.description; - - public voidOAuthProvider::checkOAuthRequest - stringuri - stringmethod - - - Vérifie une requête OAuth. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - uri - - - L'URI, optionnel, ou un point final. - - - - - method - - - La méthode HTTP. Optionnel ; il est possible d'y passer une constante parmi les - constantes OAuth OAUTH_HTTP_METHOD_* . - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Émet une erreur de niveau E_ERROR si la méthode - HTTP ne peut être détectée. - - - - - &reftitle.seealso; - - OAuthProvider::reportProblem - - - - - diff --git a/reference/oauth/oauthprovider/construct.xml b/reference/oauth/oauthprovider/construct.xml deleted file mode 100644 index a56cbc7103..0000000000 --- a/reference/oauth/oauthprovider/construct.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - OAuthProvider::__construct - Construit un nouvel objet OAuthProvider - - - - &reftitle.description; - - public OAuthProvider::__construct - arrayparams_array - - - Initie un nouvel objet OAuthProvider. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - params_array - - - Le fait de définir des paramètres optionnels est limité au - SAPI CLI. - - - - - - - - &reftitle.returnvalues; - - Un objet OAuthProvider. - - - - - &reftitle.examples; - - Exemple avec <function>OAuthProvider::__construct</function> - -consumerHandler(array($this, 'lookupConsumer')); - $op->timestampNonceHandler(array($this, 'timestampNonceChecker')); - $op->tokenHandler(array($this, 'myTokenHandler')); - - // Ignore le paramètre foo_uri - $op->setParam('foo_uri', NULL); - - // Aucun jeton nécessaire pour ce point final - $op->setRequestTokenPath('/v1/oauth/request_token'); - - $op->checkOAuthRequest(); - -} catch (OAuthException $e) { - - echo OAuthProvider::reportProblem($e); -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::setParam - - - - - diff --git a/reference/oauth/oauthprovider/consumerhandler.xml b/reference/oauth/oauthprovider/consumerhandler.xml deleted file mode 100644 index 8067db57b3..0000000000 --- a/reference/oauth/oauthprovider/consumerhandler.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - OAuthProvider::consumerHandler - Définit la fonction de rappel consumerHandler - - - - &reftitle.description; - - public voidOAuthProvider::consumerHandler - callablecallback_function - - - Définit la fonction de rappel consumer handler, qui pourra ensuite être appelée avec la méthode - OAuthProvider::callConsumerHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - callback_function - - - Le nom de la fonction de rappel de type callable. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple avec <methodname>OAuthProvider::consumerHandler</methodname> - -consumer_key === 'unknown') { - return OAUTH_CONSUMER_KEY_UNKNOWN; - } else if($provider->consumer_key == 'blacklisted' || $provider->consumer_key === 'throttled') { - return OAUTH_CONSUMER_KEY_REFUSED; - } - - $provider->consumer_secret = "the_consumers_secret"; - - return OAUTH_OK; -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::callConsumerHandler - - - - - diff --git a/reference/oauth/oauthprovider/generatetoken.xml b/reference/oauth/oauthprovider/generatetoken.xml deleted file mode 100644 index 3c7bc2b7ac..0000000000 --- a/reference/oauth/oauthprovider/generatetoken.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - OAuthProvider::generateToken - Génère un jeton aléatoire - - - - &reftitle.description; - - final public static stringOAuthProvider::generateToken - intsize - boolstrong&false; - - - Génère une &string; d'octets pseudo-aléatoires. - - - - - &reftitle.parameters; - - - size - - - La longueur désirée du jeton, en octets. - - - - - strong - - - Définit à &true;, signifie que /dev/random sera utilisé, - sinon, ce sera /dev/urandom. Ce paramètre est ignoré sous Windows. - - - - - - - - &reftitle.returnvalues; - - Le jeton généré, sous la forme d'une &string; d'octets. - - - - - &reftitle.errors; - - Si le paramètre strong vaut &true;, alors, une - alerte de niveau E_WARNING sera émise lorsque - l'implémentation de repli rand est utilisée pour compléter - les octets aléatoires manquants (c.-à-d., lorsqu'il n'y a pas assez de données - aléatoires initialement). - - - - - &reftitle.examples; - - Exemple avec <function>OAuthProvider::generateToken</function> - -generateToken(4); - -echo strlen($t), PHP_EOL; -echo bin2hex($t), PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - Lorsqu'il n'y a pas assez de données aléatoires de disponibles sur le système, - cette fonction complètera les octets manquants en utilisant la fonction - PHP interne rand. - - - - - - &reftitle.seealso; - - openssl_random_pseudo_bytes - mcrypt_create_iv - - - - - diff --git a/reference/oauth/oauthprovider/is2leggedendpoint.xml b/reference/oauth/oauthprovider/is2leggedendpoint.xml deleted file mode 100644 index 961589e2dc..0000000000 --- a/reference/oauth/oauthprovider/is2leggedendpoint.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - OAuthProvider::is2LeggedEndpoint - is2LeggedEndpoint - - - - &reftitle.description; - - public voidOAuthProvider::is2LeggedEndpoint - mixedparams_array - - - Le flux 2-legged, ou la demande de signature. - Il ne requiert pas de jeton. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - params_array - - - - - - - - - - - &reftitle.returnvalues; - - Un objet OAuthProvider . - - - - - &reftitle.examples; - - Exemple avec <function>OAuthProvider::is2LeggedEndpoint</function> - -is2LeggedEndpoint(true); - -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::__construct - - - - - diff --git a/reference/oauth/oauthprovider/isrequesttokenendpoint.xml b/reference/oauth/oauthprovider/isrequesttokenendpoint.xml deleted file mode 100644 index fc332142da..0000000000 --- a/reference/oauth/oauthprovider/isrequesttokenendpoint.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - OAuthProvider::isRequestTokenEndpoint - Définit isRequestTokenEndpoint - - - - &reftitle.description; - - public voidOAuthProvider::isRequestTokenEndpoint - boolwill_issue_request_token - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - will_issue_request_token - - - Définit s'il émettra une demande de jeton ou non, ceci déterminant si - la méthode OAuthProvider::tokenHandler doit être appelée. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - OAuthProvider::setRequestTokenPath - OAuthProvider::reportProblem - - - - - diff --git a/reference/oauth/oauthprovider/removerequiredparameter.xml b/reference/oauth/oauthprovider/removerequiredparameter.xml deleted file mode 100644 index 7d6789bd94..0000000000 --- a/reference/oauth/oauthprovider/removerequiredparameter.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - OAuthProvider::removeRequiredParameter - Supprime un paramètre - - - - &reftitle.description; - - final public boolOAuthProvider::removeRequiredParameter - stringreq_params - - - Supprime un paramètre. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - req_params - - - Le paramètre à supprimer. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - OAuthProvider::setParam - OAuthProvider::addRequiredParameter - - - - - diff --git a/reference/oauth/oauthprovider/reportproblem.xml b/reference/oauth/oauthprovider/reportproblem.xml deleted file mode 100644 index b12f00d7b2..0000000000 --- a/reference/oauth/oauthprovider/reportproblem.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - OAuthProvider::reportProblem - Rapporte un problème - - - - &reftitle.description; - - final public static stringOAuthProvider::reportProblem - stringoauthexception - boolsend_headers&true; - - - Rapporte un problème sous la forme d'une exception - OAuthException ; les problèmes possibles sont listés - dans la section des constantes OAuth. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - oauthexception - - - L'exception OAuthException. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - OAuthProvider::checkOAuthRequest - OAuthProvider::isRequestTokenEndpoint - - - - - diff --git a/reference/oauth/oauthprovider/setparam.xml b/reference/oauth/oauthprovider/setparam.xml deleted file mode 100644 index 746d1077c5..0000000000 --- a/reference/oauth/oauthprovider/setparam.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - OAuthProvider::setParam - Définit un paramètre - - - - &reftitle.description; - - final public boolOAuthProvider::setParam - stringparam_key - mixedparam_val - - - Définit un paramètre. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - param_key - - - La clé du paramètre. - - - - - param_val - - - La valeur du paramètre ; optionnelle. - - - Pour exclure un paramètre de la vérification de signature, définir cette - valeur à &null;. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - OAuthProvider::addRequiredParameter - - - - - diff --git a/reference/oauth/oauthprovider/setrequesttokenpath.xml b/reference/oauth/oauthprovider/setrequesttokenpath.xml deleted file mode 100644 index 2765f75214..0000000000 --- a/reference/oauth/oauthprovider/setrequesttokenpath.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - OAuthProvider::setRequestTokenPath - Définit le chemin du jeton demandé - - - - &reftitle.description; - - final public boolOAuthProvider::setRequestTokenPath - stringpath - - - Définit le chemin du jeton demandé. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - Le chemin. - - - - - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.seealso; - - OAuthProvider::tokenHandler - - - - - diff --git a/reference/oauth/oauthprovider/timestampnoncehandler.xml b/reference/oauth/oauthprovider/timestampnoncehandler.xml deleted file mode 100644 index c0ca7871b8..0000000000 --- a/reference/oauth/oauthprovider/timestampnoncehandler.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - OAuthProvider::timestampNonceHandler - Définit le gestionnaire de rappel timestampNonceHandler - - - - &reftitle.description; - - public voidOAuthProvider::timestampNonceHandler - callablecallback_function - - - Définit le gestionnaire de rappel timestampNonceHandler, qui sera appelé - plus tard avec la méthode OAuthProvider::callTimestampNonceHandler. - Les erreurs en rapport avec timestamp/nonce seront émises via ce gestionnaire de rappel. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - callback_function - - - Le nom de la fonction callback. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple avec <methodname>OAuthProvider::timestampNonceHandler</methodname> - -nonce === 'bad') { - return OAUTH_BAD_NONCE; - } elseif ($provider->timestamp == '0') { - return OAUTH_BAD_TIMESTAMP; - } - - return OAUTH_OK; -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::callTimestampNonceHandler - - - - - diff --git a/reference/oauth/oauthprovider/tokenhandler.xml b/reference/oauth/oauthprovider/tokenhandler.xml deleted file mode 100644 index 10375b25df..0000000000 --- a/reference/oauth/oauthprovider/tokenhandler.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - OAuthProvider::tokenHandler - Définit le gestionnaire de rappel tokenHandler - - - - &reftitle.description; - - public voidOAuthProvider::tokenHandler - callablecallback_function - - - Définit le gestionnaire de rappel tokenHandler, qui sera appelé plus tard - avec la méthode OAuthProvider::callTokenHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - callback_function - - - Le nom de la fonction callable. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple avec <methodname>OAuthProvider::tokenHandler</methodname> - -token === 'rejected') { - return OAUTH_TOKEN_REJECTED; - } elseif ($provider->token === 'revoked') { - return OAUTH_TOKEN_REVOKED; - } - - $provider->token_secret = "the_tokens_secret"; - return OAUTH_OK; -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::callTokenHandler - - - - - diff --git a/reference/oauth/reference.xml b/reference/oauth/reference.xml deleted file mode 100644 index 5003824c21..0000000000 --- a/reference/oauth/reference.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - &Functions; OAuth - - &reference.oauth.entities.functions; - - - - - diff --git a/reference/oauth/setup.xml b/reference/oauth/setup.xml deleted file mode 100644 index 30c774b267..0000000000 --- a/reference/oauth/setup.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - PECL/oauth requiert PHP 5.1 ou plus récent, les extensions - ext/hash et ext/pcre. - - - PECL/oauth peut aussi nécessiter la bibliothèque libcurl - si elle a été sélectionnée au moment de la compilation. - Si c'est le cas, PECL/oauth doit aussi être compilé avec le - support HTTPS. - -
    - - - &reference.oauth.configure; - - -     - diff --git a/reference/openal/book.xml b/reference/openal/book.xml deleted file mode 100644 index 9a48046257..0000000000 --- a/reference/openal/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - Gestion Audio OpenAL - OpenAL - - - - &reftitle.intro; - - Plate-forme indépendante pour la gestion de l'audio. - Requiert la bibliothèque OpenAL. - - - - - &reference.openal.setup; - &reference.openal.constants; - &reference.openal.reference; - - - diff --git a/reference/openal/configure.xml b/reference/openal/configure.xml deleted file mode 100644 index d0d9e5d40b..0000000000 --- a/reference/openal/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;openal. - - - &pecl.windows.download; - -
    - diff --git a/reference/openal/constants.xml b/reference/openal/constants.xml deleted file mode 100644 index aeaf6dd7fa..0000000000 --- a/reference/openal/constants.xml +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - ALC_FREQUENCY - (int) - - - - Attribut de contexte - - - - - - ALC_REFRESH - (int) - - - - Attribut de contexte - - - - - - ALC_SYNC - (int) - - - - Attribut de contexte - - - - - - AL_FREQUENCY - (int) - - - - Configuration du buffer - - - - - - AL_BITS - (int) - - - - Configuration du buffer - - - - - - AL_CHANNELS - (int) - - - - Configuration du buffer - - - - - - AL_SIZE - (int) - - - - Configuration du buffer - - - - - - AL_BUFFER - (int) - - - - Configuration de la source/de l'écoute (Entier) - - - - - - AL_SOURCE_RELATIVE - (int) - - - - Configuration de la source/de l'écoute (Entier) - - - - - - AL_SOURCE_STATE - (int) - - - - Configuration de la source/de l'écoute (Entier) - - - - - - AL_PITCH - (int) - - - - Configuration de la source/de l'écoute (Nombre à virgule flottante) - - - - - - AL_GAIN - (int) - - - - Configuration de la source/de l'écoute (Nombre à virgule flottante) - - - - - - AL_MIN_GAIN - (int) - - - - Configuration de la source/de l'écoute (Nombre à virgule flottante) - - - - - - AL_MAX_GAIN - (int) - - - - Configuration de la source/de l'écoute (Nombre à virgule flottante) - - - - - - AL_MAX_DISTANCE - (int) - - - - Configuration de la source/de l'écoute (Nombre à virgule flottante) - - - - - - AL_ROLLOFF_FACTOR - (int) - - - - Configuration de la source/de l'écoute (Nombre à virgule flottante) - - - - - - AL_CONE_OUTER_GAIN - (int) - - - - Configuration de la source/de l'écoute (Nombre à virgule flottante) - - - - - - AL_CONE_INNER_ANGLE - (int) - - - - Configuration de la source/de l'écoute (Nombre à virgule flottante) - - - - - - AL_CONE_OUTER_ANGLE - (int) - - - - Configuration de la source/de l'écoute (Nombre à virgule flottante) - - - - - - AL_REFERENCE_DISTANCE - (int) - - - - Configuration de la source/de l'écoute (Nombre à virgule flottante) - - - - - - AL_POSITION - (int) - - - - Configuration de la source/de l'écoute (Nombre vectoriel à virgule flottante) - - - - - - AL_VELOCITY - (int) - - - - Configuration de la source/de l'écoute (Nombre vectoriel à virgule flottante) - - - - - - AL_DIRECTION - (int) - - - - Configuration de la source/de l'écoute (Nombre vectoriel à virgule flottante) - - - - - - AL_ORIENTATION - (int) - - - - Configuration de la source/de l'écoute (Nombre vectoriel à virgule flottante) - - - - - - AL_FORMAT_MONO8 - (int) - - - - Format PCM - - - - - - AL_FORMAT_MONO16 - (int) - - - - Format PCM - - - - - - AL_FORMAT_STEREO8 - (int) - - - - Format PCM - - - - - - AL_FORMAT_STEREO16 - (int) - - - - Format PCM - - - - - - AL_INITIAL - (int) - - - - État de la Source - - - - - - AL_PLAYING - (int) - - - - État de la Source - - - - - - AL_PAUSED - (int) - - - - État de la Source - - - - - - AL_STOPPED - (int) - - - - État de la Source - - - - - - AL_LOOPING - (int) - - - - État de la Source - - - - - - AL_TRUE - (int) - - - - Valeur booléenne reconnue par OpenAL - - - - - - AL_FALSE - (int) - - - - Valeur booléenne reconnue par OpenAL - - - - - - diff --git a/reference/openal/functions/openal-buffer-create.xml b/reference/openal/functions/openal-buffer-create.xml deleted file mode 100644 index e768a1c84e..0000000000 --- a/reference/openal/functions/openal-buffer-create.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - openal_buffer_create - Génère un buffer OpenAL - - - &reftitle.description; - - resourceopenal_buffer_create - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - openal_buffer_create retourne une ressource - Open AL(Buffer) ou &false; en cas d'erreur. - - - - &reftitle.seealso; - - openal_buffer_loadwav - openal_buffer_data - - - - diff --git a/reference/openal/functions/openal-buffer-data.xml b/reference/openal/functions/openal-buffer-data.xml deleted file mode 100644 index e8943dbb99..0000000000 --- a/reference/openal/functions/openal-buffer-data.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - openal_buffer_data - Charge un buffer avec des données - - - &reftitle.description; - - boolopenal_buffer_data - resourcebuffer - intformat - stringdata - intfreq - - - - &reftitle.parameters; - - - buffer - - - Une ressource Open AL(Buffer) - (précédemment créée par openal_buffer_create). - - - - - format - - - Format du paramètre data, un parmi ceux-là : - AL_FORMAT_MONO8, - AL_FORMAT_MONO16, - AL_FORMAT_STEREO8&listendand; - AL_FORMAT_STEREO16. - - - - - data - - - Bloc de données binaires audio dans le format spécifié - format et - freq. - - - - - freq - - - Fréquence des données data, en Hz. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_buffer_loadwav - openal_stream - - - - diff --git a/reference/openal/functions/openal-buffer-destroy.xml b/reference/openal/functions/openal-buffer-destroy.xml deleted file mode 100644 index 0847e9f780..0000000000 --- a/reference/openal/functions/openal-buffer-destroy.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - openal_buffer_destroy - Détruit un buffer OpenAL - - - &reftitle.description; - - boolopenal_buffer_destroy - resourcebuffer - - - - &reftitle.parameters; - - - buffer - - - Une ressource Open AL(Buffer) - (précédemment créée par openal_buffer_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_buffer_create - - - - diff --git a/reference/openal/functions/openal-buffer-get.xml b/reference/openal/functions/openal-buffer-get.xml deleted file mode 100644 index 44b621835b..0000000000 --- a/reference/openal/functions/openal-buffer-get.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - openal_buffer_get - Récupère les propriétés du buffer OpenAL - - - - &reftitle.description; - - intfalseopenal_buffer_get - resourcebuffer - intproperty - - - - - &reftitle.parameters; - - - buffer - - - Une ressource Open AL(Buffer) - (précédemment créée par openal_buffer_create). - - - - - property - - - Une propriété spécifique, une parmi celles-ci : - AL_FREQUENCY, - AL_BITS, - AL_CHANNELS&listendand; - AL_SIZE. - - - - - - - - &reftitle.returnvalues; - - Retourne une valeur entière appropriée à la demande - property&return.falseforfailure;. - - - - - &reftitle.seealso; - - openal_buffer_create - - - - - diff --git a/reference/openal/functions/openal-buffer-loadwav.xml b/reference/openal/functions/openal-buffer-loadwav.xml deleted file mode 100644 index c3b77db4a2..0000000000 --- a/reference/openal/functions/openal-buffer-loadwav.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - openal_buffer_loadwav - Charge un fichier .wav dans le buffer - - - &reftitle.description; - - boolopenal_buffer_loadwav - resourcebuffer - stringwavfile - - - - &reftitle.parameters; - - - buffer - - - Une ressource Open AL(Buffer) - (précédemment créée par openal_buffer_create). - - - - - wavfile - - - Chemin vers le fichier .wav sur le système de fichiers - local. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_buffer_data - openal_stream - - - - diff --git a/reference/openal/functions/openal-context-create.xml b/reference/openal/functions/openal-context-create.xml deleted file mode 100644 index 32967b2f90..0000000000 --- a/reference/openal/functions/openal-context-create.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - openal_context_create - Crée un contexte de traitement audio - - - &reftitle.description; - - resourceopenal_context_create - resourcedevice - - - - &reftitle.parameters; - - - device - - - Une ressource Open AL(Device) - (précédemment créée par openal_device_open). - - - - - - - &reftitle.returnvalues; - - Retourne une ressource Open AL(Context) - ou &false; en cas d'erreur. - - - - &reftitle.seealso; - - openal_device_open - openal_context_destroy - - - - diff --git a/reference/openal/functions/openal-context-current.xml b/reference/openal/functions/openal-context-current.xml deleted file mode 100644 index 4ad3ceb72a..0000000000 --- a/reference/openal/functions/openal-context-current.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - openal_context_current - Rend courant le contexte spécifié - - - - &reftitle.description; - - boolopenal_context_current - resourcecontext - - - - - &reftitle.parameters; - - - context - - - Une ressource Open AL(Context) - (précédemment créée par openal_context_create). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - openal_context_create - - - - - diff --git a/reference/openal/functions/openal-context-destroy.xml b/reference/openal/functions/openal-context-destroy.xml deleted file mode 100644 index 8482bb9d08..0000000000 --- a/reference/openal/functions/openal-context-destroy.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - openal_context_destroy - Détruit un contexte - - - &reftitle.description; - - boolopenal_context_destroy - resourcecontext - - - - &reftitle.parameters; - - - context - - - Une ressource Open AL(Context) - (précédemment créée par openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_context_create - - - - diff --git a/reference/openal/functions/openal-context-process.xml b/reference/openal/functions/openal-context-process.xml deleted file mode 100644 index 1fcfa36000..0000000000 --- a/reference/openal/functions/openal-context-process.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - openal_context_process - Traite le contexte spécifié - - - &reftitle.description; - - boolopenal_context_process - resourcecontext - - - - &reftitle.parameters; - - - context - - - Une ressource Open AL(Context) - (précédemment créée par openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_context_create - openal_context_current - openal_context_suspend - - - - diff --git a/reference/openal/functions/openal-context-suspend.xml b/reference/openal/functions/openal-context-suspend.xml deleted file mode 100644 index 6c9b43979b..0000000000 --- a/reference/openal/functions/openal-context-suspend.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - openal_context_suspend - Suspend le contexte spécifié - - - &reftitle.description; - - boolopenal_context_suspend - resourcecontext - - - - &reftitle.parameters; - - - context - - - Une ressource Open AL(Context) - (précédemment créée par openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_context_create - openal_context_current - openal_context_process - - - - diff --git a/reference/openal/functions/openal-device-close.xml b/reference/openal/functions/openal-device-close.xml deleted file mode 100644 index ef0256a61d..0000000000 --- a/reference/openal/functions/openal-device-close.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - openal_device_close - Ferme un périphérique OpenAL - - - &reftitle.description; - - boolopenal_device_close - resourcedevice - - - - &reftitle.parameters; - - - device - - - Une ressource Open AL(Device) - (précédemment créée par openal_device_open) à fermer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_device_open - - - - diff --git a/reference/openal/functions/openal-device-open.xml b/reference/openal/functions/openal-device-open.xml deleted file mode 100644 index 4906337624..0000000000 --- a/reference/openal/functions/openal-device-open.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - openal_device_open - Initialise une interface audio OpenAL - - - &reftitle.description; - - resourceopenal_device_open - stringdevice_desc - - - - &reftitle.parameters; - - - device_desc - - - openal_device_open ouvre un périphérique audio - optionnellement spécifié par le paramètre device_desc. - Si le paramètre device_desc n'est pas spécifié, le - premier périphérique audio disponible sera utilisé. - - - - - - - &reftitle.returnvalues; - - Retourne une ressource Open AL(Device) - ou &false; en cas d'erreur. - - - - &reftitle.seealso; - - openal_device_close - openal_context_create - - - - diff --git a/reference/openal/functions/openal-listener-get.xml b/reference/openal/functions/openal-listener-get.xml deleted file mode 100644 index bc6eeb2fa2..0000000000 --- a/reference/openal/functions/openal-listener-get.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - openal_listener_get - Récupère une propriété d'auditeur - - - &reftitle.description; - - mixedopenal_listener_get - intproperty - - - - &reftitle.parameters; - - - property - - - La propriété à récupérer, une parmi celles-ci : - AL_GAIN (&float;), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float))&listendand; - AL_ORIENTATION (array(float,float,float)). - - - - - - - &reftitle.returnvalues; - - Retourne un &float; ou un tableau de nombres à virgule flottante&return.falseforfailure;. - - - - &reftitle.seealso; - - openal_listener_set - - - - diff --git a/reference/openal/functions/openal-listener-set.xml b/reference/openal/functions/openal-listener-set.xml deleted file mode 100644 index 276ac9c960..0000000000 --- a/reference/openal/functions/openal-listener-set.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - openal_listener_set - Définit une propriété d'auditeur - - - &reftitle.description; - - boolopenal_listener_set - intproperty - mixedsetting - - - - &reftitle.parameters; - - - property - - - La propriété à définir, une parmi celles-ci : - AL_GAIN (&float;), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float))&listendand; - AL_ORIENTATION (array(float,float,float)). - - - - - setting - - - La valeur à définir, soit un &float;, soit un tableau de nombres à virgule flottante - appropriés. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_listener_get - - - - diff --git a/reference/openal/functions/openal-source-create.xml b/reference/openal/functions/openal-source-create.xml deleted file mode 100644 index d868e33574..0000000000 --- a/reference/openal/functions/openal-source-create.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - openal_source_create - Génère une ressource de source - - - &reftitle.description; - - resourceopenal_source_create - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une ressource Open AL(Source) - ou &false; en cas d'erreur. - - - - &reftitle.seealso; - - openal_source_set - openal_source_play - openal_source_destroy - - - - diff --git a/reference/openal/functions/openal-source-destroy.xml b/reference/openal/functions/openal-source-destroy.xml deleted file mode 100644 index deabde4ba2..0000000000 --- a/reference/openal/functions/openal-source-destroy.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - openal_source_destroy - Détruit une ressource de source - - - &reftitle.description; - - boolopenal_source_destroy - resourcesource - - - - &reftitle.parameters; - - - source - - - Une ressource Open AL(Source) - (précédemment créée par openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_create - - - - diff --git a/reference/openal/functions/openal-source-get.xml b/reference/openal/functions/openal-source-get.xml deleted file mode 100644 index 619fd38085..0000000000 --- a/reference/openal/functions/openal-source-get.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - openal_source_get - Récupère une propriété de source OpenAL - - - &reftitle.description; - - mixedopenal_source_get - resourcesource - intproperty - - - - &reftitle.parameters; - - - source - - - Une ressource Open AL(Source) - (précédemment créée par openal_source_create). - - - - - property - - - Propriété à récupérer, une parmi celles-ci : - AL_SOURCE_RELATIVE (&integer;), - AL_SOURCE_STATE (&integer;), - AL_PITCH (&float;), - AL_GAIN (&float;), - AL_MIN_GAIN (&float;), - AL_MAX_GAIN (&float;), - AL_MAX_DISTANCE (&float;), - AL_ROLLOFF_FACTOR (&float;), - AL_CONE_OUTER_GAIN (&float;), - AL_CONE_INNER_ANGLE (&float;), - AL_CONE_OUTER_ANGLE (&float;), - AL_REFERENCE_DISTANCE (&float;), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float)), - AL_DIRECTION (array(float,float,float)). - - - - - - - &reftitle.returnvalues; - - Retourne le type associé avec la propriété récupérée&return.falseforfailure;. - - - - &reftitle.seealso; - - openal_source_create - openal_source_set - openal_source_play - - - - diff --git a/reference/openal/functions/openal-source-pause.xml b/reference/openal/functions/openal-source-pause.xml deleted file mode 100644 index ab259c8988..0000000000 --- a/reference/openal/functions/openal-source-pause.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - openal_source_pause - Marque une pause dans la source - - - &reftitle.description; - - boolopenal_source_pause - resourcesource - - - - &reftitle.parameters; - - - source - - - Une ressource Open AL(Source) - (précédemment créée avec openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_stop - openal_source_play - openal_source_rewind - - - - diff --git a/reference/openal/functions/openal-source-play.xml b/reference/openal/functions/openal-source-play.xml deleted file mode 100644 index e39ecdc905..0000000000 --- a/reference/openal/functions/openal-source-play.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - openal_source_play - Démarre la lecture de la source - - - &reftitle.description; - - boolopenal_source_play - resourcesource - - - - &reftitle.parameters; - - - source - - - Une ressource Open AL(Source) - (précédemment créée par openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_stop - openal_source_pause - openal_source_rewind - - - - diff --git a/reference/openal/functions/openal-source-rewind.xml b/reference/openal/functions/openal-source-rewind.xml deleted file mode 100644 index fd2be86a89..0000000000 --- a/reference/openal/functions/openal-source-rewind.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - openal_source_rewind - Revient en arrière dans la source - - - &reftitle.description; - - boolopenal_source_rewind - resourcesource - - - - &reftitle.parameters; - - - source - - - Une ressource Open AL(Source) - (précédemment créée par openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_stop - openal_source_pause - openal_source_play - - - - diff --git a/reference/openal/functions/openal-source-set.xml b/reference/openal/functions/openal-source-set.xml deleted file mode 100644 index d84ee9b16f..0000000000 --- a/reference/openal/functions/openal-source-set.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - openal_source_set - Définit une propriété de la source - - - &reftitle.description; - - boolopenal_source_set - resourcesource - intproperty - mixedsetting - - - - &reftitle.parameters; - - - source - - - Une ressource Open AL(Source) - (précédemment créée par openal_source_create). - - - - - property - - - La propriété à définir, une parmi celles-ci : - AL_BUFFER (OpenAL(Source)), - AL_LOOPING (&boolean;), - AL_SOURCE_RELATIVE (&integer;), - AL_SOURCE_STATE (&integer;), - AL_PITCH (&float;), - AL_GAIN (&float;), - AL_MIN_GAIN (&float;), - AL_MAX_GAIN (&float;), - AL_MAX_DISTANCE (&float;), - AL_ROLLOFF_FACTOR (&float;), - AL_CONE_OUTER_GAIN (&float;), - AL_CONE_INNER_ANGLE (&float;), - AL_CONE_OUTER_ANGLE (&float;), - AL_REFERENCE_DISTANCE (&float;), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float)), - AL_DIRECTION (array(float,float,float)). - - - - - setting - - - La valeur à assigner à la propriété spécifiée par le paramètre - property. - Se référer à la description de la propriété - property pour une - description des valeurs attendues. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_create - openal_source_get - openal_source_play - - - - diff --git a/reference/openal/functions/openal-source-stop.xml b/reference/openal/functions/openal-source-stop.xml deleted file mode 100644 index 6c97cb00db..0000000000 --- a/reference/openal/functions/openal-source-stop.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - openal_source_stop - Arrête la lecture de la source - - - &reftitle.description; - - boolopenal_source_stop - resourcesource - - - - &reftitle.parameters; - - - source - - - Une ressource Open AL(Source) - (précédemment créée par openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_play - openal_source_pause - openal_source_rewind - - - - diff --git a/reference/openal/functions/openal-stream.xml b/reference/openal/functions/openal-stream.xml deleted file mode 100644 index 415f155998..0000000000 --- a/reference/openal/functions/openal-stream.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - openal_stream - Démarre le streaming d'une source - - - &reftitle.description; - - resourcefalseopenal_stream - resourcesource - intformat - intrate - - - - &reftitle.parameters; - - - source - - - Une ressource Open AL(Source) - (précédemment créée par openal_source_create). - - - - - format - - - Le format du paramètre data, un parmi ceux-là : - AL_FORMAT_MONO8, - AL_FORMAT_MONO16, - AL_FORMAT_STEREO8&listendand; - AL_FORMAT_STEREO16. - - - - - rate - - - La fréquence des données à streamer, en Hz. - - - - - - - &reftitle.returnvalues; - - Retourne une ressource de streaming&return.falseforfailure;. - - - - &reftitle.seealso; - - openal_source_create - fwrite - - - - diff --git a/reference/openal/reference.xml b/reference/openal/reference.xml deleted file mode 100644 index 7313f86bb4..0000000000 --- a/reference/openal/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; OpenAL - - &reference.openal.entities.functions; - - - - diff --git a/reference/openal/resources.xml b/reference/openal/resources.xml deleted file mode 100644 index 58e5c8e0cb..0000000000 --- a/reference/openal/resources.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - -
    - &reftitle.resources; - - - Cette extension définit quatre types de ressource : - Open AL(Device) - Retournée par openal_device_open, - Open AL(Context) - Retournée par openal_context_create, - Open AL(Buffer) - Retournée par openal_buffer_create, - et Open AL(Source) - Retournée par openal_source_create. - - -
    - diff --git a/reference/openal/setup.xml b/reference/openal/setup.xml deleted file mode 100644 index 973127ea5b..0000000000 --- a/reference/openal/setup.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.openal.configure; - - - - &reference.openal.resources; - - - - - - diff --git a/reference/operator/book.xml b/reference/operator/book.xml deleted file mode 100644 index b091e17801..0000000000 --- a/reference/operator/book.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - Surcharge d'opérateurs pour les objets - Surcharge d'opérateurs - - - - &reftitle.intro; - - Cette extension définit et implémente la surcharge d'opérateurs pour les objets. - Elle permet de définir comment un objet réagit lorsqu'un opérateur lui est appliqué. - - - Un exemple est la création d'un objet de type collection dont l'opérateur - d'addition est surchargé pour permettre d'ajouter des éléments à la collection - ou d'additionner deux collections ensemble. - - - Un autre exemple est la création d'une classe de chaîne améliorée dont l'opérateur - de multiplication est surchargé pour permettre de répéter la chaîne un certain - nombre de fois. - - - - &reference.operator.setup; - &reference.operator.overloading; - diff --git a/reference/operator/overloading.xml b/reference/operator/overloading.xml deleted file mode 100644 index c72f1e09b3..0000000000 --- a/reference/operator/overloading.xml +++ /dev/null @@ -1,340 +0,0 @@ - - - - - Méthodes magiques de surcharge d'opérateurs - - L'extension de surcharge d'opérateurs permet de définir comment un objet réagit aux opérateurs. Cela se fait en implémentant les méthodes magiques suivantes : - - - Opérateurs arithmétiques : - - $a::__add($b) - $a::__sub($b) - $a::__mul($b) - $a::__div($b) - $a::__mod($b) - $a::__pow($b) - - - - Opérateurs d'affectation : - - $a::__assign($b) - $a::__assign_add($b) - $a::__assign_sub($b) - $a::__assign_mul($b) - $a::__assign_div($b) - $a::__assign_mod($b) - $a::__assign_pow($b) - $a::__assign_bw_and($b) - $a::__assign_bw_or($b) - $a::__assign_bw_xor($b) - $a::__assign_sl($b) - $a::__assign_sr($b) - $a::__assign_concat($b) - - - - Opérateurs sur les bits : - - $a::__bw_and($b) - $a::__bw_or($b) - $a::__bw_xor($b) - $a::__bw_not() - $a::__sl($b) - $a::__sr($b) - - - - Opérateurs de comparaison : - - $a::__is_equal($b) - $a::__is_not_equal($b) - $a::__is_identical($b) - $a::__is_not_identical($b) - $a::__is_smaller($b) - $a::__is_smaller_or_equal($b) - $a::__is_greater($b) - $a::__is_greater_or_equal($b) - $a::__spaceship($b) - - - - Opérateurs d'incrémentation et de décrémentation : - - $a::__pre_inc() - $a::__post_inc() - $a::__pre_dec() - $a::__post_dec() - - - - Opérateurs de chaînes : - - $a::__concat($b) - - -
    - Exemples de surcharge d'opérateurs - - Ce qui suit est la classe utilisée pour les tests de l'extension de surcharge d'opérateurs. - Elle surcharge tous les opérateurs qu'il est possible de surcharger à des fins de test. - - - Classe complète pour la surcharge d'opérateurs - -value; - } - - public function __set(string $name, mixed $value) - { - $this->value = $value; - } - - public function __construct(mixed $init = null) - { - $this->value = $init; - } - //endregion - - //region Opérateurs arithmétiques - public function __add(mixed $val): int|float - { - return $this->value + $val; - } - - public function __div(mixed $val): int|float - { - return $this->value / $val; - } - - public function __mod(mixed $val): int - { - return $this->value % $val; - } - - public function __mul(mixed $val): int|float - { - return $this->value * $val; - } - - public function __pow(mixed $val): int|float - { - return $this->value ** $val; - } - - public function __sub(mixed $val): int|float - { - return $this->value - $val; - } - //endregion - - //region Opérateurs d'affectation - public function __assign(mixed $val): mixed - { - return $this->value = $val; - } - - public function __assign_add(mixed $val): mixed - { - return $this->value += $val; - } - - public function __assign_bw_and(mixed $val): mixed - { - return $this->value &= $val; - } - - public function __assign_bw_or(mixed $val): mixed - { - return $this->value |= $val; - } - - public function __assign_concat(mixed $val): string - { - return $this->value .= $val; - } - - public function __assign_div(mixed $val): mixed - { - return $this->value /= $val; - } - - public function __assign_mod(mixed $val): mixed - { - return $this->value %= $val; - } - - public function __assign_mul(mixed $val): mixed - { - return $this->value *= $val; - } - - public function __assign_pow(mixed $val): mixed - { - return $this->value **= $val; - } - - public function __assign_sl(mixed $val): mixed - { - return $this->value <<= $val; - } - - public function __assign_sr(mixed $val): mixed - { - return $this->value >>= $val; - } - - public function __assign_sub(mixed $val): mixed - { - return $this->value -= $val; - } - //endregion - - //region Opérateurs sur les bits - public function __bw_and(mixed $val): int - { - return $this->value & $val; - } - - public function __bw_not(): int|string - { - return ~$this->value; - } - - public function __bw_or(mixed $val): int - { - return $this->value | $val; - } - - public function __bw_xor(mixed $val): int - { - return $this->value ^ $val; - } - - public function __sl(mixed $val): int - { - return $this->value << $val; - } - - public function __sr(mixed $val): int - { - return $this->value >> $val; - } - //endregion - - //region Opérateurs de comparaison - public function __is_equal(mixed $val): bool - { - return $this->value == $val; - } - - public function __is_greater(mixed $val): bool - { - return $this->value > $val; - } - - public function __is_greater_or_equal(mixed $val): bool - { - return $this->value >= $val; - } - - public function __is_identical(mixed $val): bool - { - return $this->value === $val; - } - - public function __is_not_equal(mixed $val): bool - { - return $this->value != $val; - } - - public function __is_not_identical(mixed $val): bool - { - return $this->value !== $val; - } - - public function __is_smaller(mixed $val): bool - { - return $this->value < $val; - } - - public function __is_smaller_or_equal(mixed $val): bool - { - return $this->value <= $val; - } - - public function __spaceship(mixed $val): int - { - return $this->value <=> $val; - } - //endregion - - //region Opérateurs d'incrémentation/décrémentation - public function __post_dec(): mixed - { - return $this->value--; - } - - public function __post_inc(): mixed - { - return $this->value++; - } - - public function __pre_dec(): mixed - { - return --$this->value; - } - - public function __pre_inc(): mixed - { - return ++$this->value; - } - //endregion - - //region Opérateurs de chaînes - public function __concat(mixed $val): string - { - return $this->value . $val; - } - //endregion - -} - -]]> - - - En utilisant la classe ci-dessus, il est possible de surcharger les opérateurs comme suit : - - - - - - L'exemple ci-dessus va afficher : - - - - - -
    -     diff --git a/reference/operator/setup.xml b/reference/operator/setup.xml deleted file mode 100644 index 302410f78c..0000000000 --- a/reference/operator/setup.xml +++ /dev/null @@ -1,21 +0,0 @@ - - - - - &reftitle.setup; -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;operator. - - - Les utilisateurs Windows peuvent télécharger les binaires précompilés depuis le site - PECL. - - - Les versions d'operator sont hébergées par PECL et le code source par - github. - -
    -     diff --git a/reference/parallel/book.xml b/reference/parallel/book.xml deleted file mode 100644 index b525632c5a..0000000000 --- a/reference/parallel/book.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - parallel - parallel - - - &reftitle.intro; - - parallel est une extension de concurrence parallèle pour PHP ≥ 7.2.0. - À partir de parallel 1.2.0, PHP ≥ 8.0.0 est requis. - - - Une brève description des concepts de base de parallel suit, des informations plus détaillées peuvent être trouvées dans cette section du manuel. - - - Exécution - - Un parallel\Runtime représente un thread d'interpréteur PHP. Un parallel\Runtime est configuré avec un fichier d'amorçage optionnel passé à parallel\Runtime::__construct, il s'agit généralement d'un chargeur automatique, - ou d'une autre routine de préchargement: le fichier d'amorçage sera inclus avant l'exécution de toute tâche. - - - Après la construction, le parallel\Runtime reste disponible jusqu'à ce qu'il soit fermé, tué, ou détruit par les règles de portée normales des objets PHP. - parallel\Runtime::run permet au développeur de planifier des tâches pour une exécution parallèle. - Un parallel\Runtime a un ordre de planification FIFO, les tâches seront exécutées dans l'ordre où elles sont planifiées. - - - - API Fonctionnelle - - Parallel implémente une API fonctionnelle, de haut niveau sur parallel\Runtime qui fournit un seul point d'entrée pour exécuter du code parallèle - avec une planification automatique: parallel\run. - - - - Tâches - - Une tâche (Task) est simplement une Closure destinée à une exécution parallèle. La Closure peut contenir presque n'importe quelle instruction, y compris des fermetures imbriquées. - Cependant, certaines instructions sont interdites dans les tâches: - - - yield - - - use by-reference - - - declare class - - - declare named function - - - - - - Les fermetures imbriquées peuvent utiliser yield ou use by-reference, mais ne doivent pas contenir de déclarations de classe ou de fonctions nommées. - - - - - Aucune instruction n'est interdite dans les fichiers que la tâche peut inclure. - - - - - Future - - Le parallel\Future est utilisé pour accéder à la valeur de retour de la tâche, et expose une API pour l'annulation de la tâche. - - - - Canaux - - Une tâche peut être planifiée avec des arguments, utiliser des variables de portée lexicale (par valeur), et retourner une valeur (via un parallel\Future), mais celles-ci ne permettent que la communication unidirectionnelle: - Elles permettent au développeur d'envoyer des données dans une tâche et de récupérer des données à partir d'une tâche, mais ne permettent pas la communication bidirectionnelle entre les tâches. - L'API parallel\Channel permet la communication bidirectionnelle entre les tâches, un parallel\Channel est un lien de type socket entre les tâches que le développeur peut utiliser pour envoyer et recevoir des données. - - - - Événements - - L'API parallel\Events implémente une boucle d'événements (Traversable) native, et la méthode parallel\Events::poll. - Cela permet au développeur de travailler avec des ensembles de canaux et/ou de futurs. - Le développeur ajoute simplement des canaux et des futurs à la boucle d'événements, en définissant éventuellement l'entrée pour les écritures avec parallel\Events::setInput, - et entre dans une boucle foreach: parallel lira et écrira dans les objets au fur et à mesure qu'ils deviennent disponibles, renvoyant des objets parallel\Events\Event - décrivant les opérations qui se sont produites. - - - - &reftitle.seealso; - - - - - - - &reference.parallel.setup; - &reference.parallel.philosophy; - &reference.parallel.functional; - &reference.parallel.parallel.runtime; - &reference.parallel.parallel.future; - &reference.parallel.parallel.channel; - &reference.parallel.parallel.events; - &reference.parallel.parallel.events.input; - &reference.parallel.parallel.events.event; - &reference.parallel.parallel.events.event.type; - - &reference.parallel.parallel.sync; - - - - diff --git a/reference/parallel/configure.xml b/reference/parallel/configure.xml deleted file mode 100644 index 3b5ce4a565..0000000000 --- a/reference/parallel/configure.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - -
    - &reftitle.install; - - - utiliser l'option - lors de la compilation de PHP. - - - - Les utilisateurs de Windows doivent inclure le fichier - php_parallel.dll dans &php.ini; - - -
    - diff --git a/reference/parallel/functional.xml b/reference/parallel/functional.xml deleted file mode 100644 index 9b9de0dcb2..0000000000 --- a/reference/parallel/functional.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - Functional API - - - L'API parallel\Runtime fournit un grand degré de contrôle au développeur PHP expérimenté, et à ceux qui sont intimement familiers avec l'écriture d'applications qui utilisent - la concurrence parallèle. - - - L'API fonctionnelle fournit moins de contrôle en échange de la capacité de prendre des décisions pour le développeur: - - - tous les runtimes en cours d'exécution sont amorcés de manière identique - - - l'ordonnancement est déterminé par l'API, et non par le développeur - - - parallel\run fournit la garantie que la tâche commencera à s'exécuter en parallèle dès que les contraintes matérielles et du système d'exploitation le permettront, sans - créer inutilement des espaces d'exécutions. Pour la plupart des applications, l'API fonctionnelle devrait être préférée. - - - - &reference.parallel.functions.parallel.bootstrap; - &reference.parallel.functions.parallel.run; - - diff --git a/reference/parallel/functions/parallel.bootstrap.xml b/reference/parallel/functions/parallel.bootstrap.xml deleted file mode 100644 index 523d425fcd..0000000000 --- a/reference/parallel/functions/parallel.bootstrap.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - parallel\bootstrap - Amorçage - - - - &reftitle.description; - - voidparallel\bootstrap - stringfile - - - Utilise le file fourni pour amorcer toutes les exécutions créées pour la planification automatique via parallel\run. - - - - - &reftitle.parameters; - - - file - - - Le chemin du fichier pour amorcer toutes les exécutions. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - - Lance une exception parallel\Runtime\Error\Bootstrap si déjà appelé pour ce processus. - - - - - Lance une exception parallel\Runtime\Error\Bootstrap si appelé après parallel\run. - - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/parallel/functions/parallel.run.xml b/reference/parallel/functions/parallel.run.xml deleted file mode 100644 index 7f6324d712..0000000000 --- a/reference/parallel/functions/parallel.run.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - parallel\run - Exécution - - - - &reftitle.description; - - Futurenullparallel\run - Closuretask - - - Planifie task pour exécution en parallèle. - - - Futurenullparallel\run - Closuretask - arrayargv - - - Planifie task pour exécution en parallèle, passant argv à l'exécution. - - - - - Planification automatique - - Si un \parallel\Runtime créé et mis en cache par un appel précédent à parallel\run est inactif, - il sera utilisé pour exécuter la tâche. Si aucun \parallel\Runtime n'est inactif, parallel créera et mettra en cache un - \parallel\Runtime. - - - - Les objets \parallel\Runtime créés par le développeur ne sont pas utilisés pour la planification automatique. - - - - - - - - - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/parallel/parallel.channel.xml b/reference/parallel/parallel.channel.xml deleted file mode 100644 index d88018de14..0000000000 --- a/reference/parallel/parallel.channel.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - La classe parallel\Channel - parallel\Channel - - -
    - canaux non tamponnés - - Un canal non tamponné bloquera les appels à parallel\Channel::send jusqu'à ce qu'il y ait un récepteur, et bloquera les appels à - parallel\Channel::recv jusqu'à ce qu'il y ait un émetteur. Cela signifie qu'un canal non tamponné n'est pas seulement un moyen de partager des données entre les tâches - mais aussi une méthode simple de synchronisation. - - - Un canal non tamponné est le moyen le plus rapide de partager des données entre les tâches, nécessitant le moins de copie. - -
    - -
    - canaux tamponnés - - Un canal tamponné ne bloquera pas les appels à parallel\Channel::send jusqu'à ce que la capacité soit atteinte, les appels à - parallel\Channel::recv bloqueront jusqu'à ce qu'il y ait des données dans le tampon. - -
    - -
    - Fermetures sur les canaux - - Une fonctionnalité puissante des canaux parallèles est qu'ils permettent l'échange de fermetures entre les tâches (et les runtimes). - - - Lorsqu'une fermeture est envoyée sur un canal, la fermeture est tamponnée, cela ne change pas le tampon du canal transmettant la fermeture, - mais cela affecte la portée statique à l'intérieur de la fermeture: la même fermeture envoyée à différentes exécutions, ou à la même exécution, - ne partagera pas leur portée statique. - - - Cela signifie que chaque fois qu'une fermeture est exécutée qui a été transmise par un canal, l'état statique sera tel qu'il était lorsque la fermeture a été tamponnée. - -
    - -
    - canaux anonymes - - La construction de canaux anonymes permet au développeur d'éviter d'attribuer des noms à chaque canal: parallel générera un nom unique pour les canaux anonymes. - -
    - -
    - &reftitle.classsynopsis; - - - - parallel\Channel - - - - - final - parallel\Channel - - - - - Constructeur anonyme - - - - - Accès - - - - - Partage - - - - - Fermer - - - - - Constantes pour le tamponnement infini - - const - Infinite - - - - - -
    - -     - - &reference.parallel.parallel.channel.construct; - &reference.parallel.parallel.channel.make; - &reference.parallel.parallel.channel.open; - &reference.parallel.parallel.channel.recv; - &reference.parallel.parallel.channel.send; - &reference.parallel.parallel.channel.close; - -     - diff --git a/reference/parallel/parallel.events.event.type.xml b/reference/parallel/parallel.events.event.type.xml deleted file mode 100644 index 851209e4a0..0000000000 --- a/reference/parallel/parallel.events.event.type.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - La classe parallel\Events\Event\Type - parallel\Events\Event\Type - - - -
    - &reftitle.classsynopsis; - - - - parallel\Events\Event\Type - - - - - final - parallel\Events\Event\Type - - - - - Event::$object a été lu dans Event::$value - - const - Read - - - L'entrée pour Event::$source a été écrite dans Event::$object - - const - Write - - - Event::$object (Channel) a été fermé - - const - Close - - - Event::$object (Future) a été annulé - - const - Cancel - - - Le runtime exécutant Event::$object (Future) a été tué - - const - Kill - - - Event::$object (Future) a levé une erreur - - const - Error - - - - - -
    - -     - -     - - diff --git a/reference/parallel/parallel.events.event.xml b/reference/parallel/parallel.events.event.xml deleted file mode 100644 index 1b0fc0d93c..0000000000 --- a/reference/parallel/parallel.events.event.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - La classe parallel\Events\Event - parallel\Events\Event - - - -
    - Objet d'événement - - Lorsqu'un événement est retourné, Event::$object doit être retiré de la boucle qui l'a retourné, si l'événement est un événement d'écriture - l'Input pour Event::$source doit également être retiré. - -
    -
    - &reftitle.classsynopsis; - - - - parallel\Events\Event - - - - - final - parallel\Events\Event - - - - - Doit être une des constantes Event\Type - - public - int - type - - - Doit être la source de l'événement (nom de la cible) - - public - string - source - - - Doit être soit un Future ou un Channel - - public - object - object - - - Doit être défini pour les événements de lecture/Erreur - - public - value - - - - - -
    - -     - -     - diff --git a/reference/parallel/parallel.events.input.xml b/reference/parallel/parallel.events.input.xml deleted file mode 100644 index e2062cd775..0000000000 --- a/reference/parallel/parallel.events.input.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - La classe parallel\Events\Input - parallel\Events\Input - - - -
    - Événements d'entrée - - Un objet d'entrée est un conteneur pour les données que l'objet parallel\Events écrira dans - les objets parallel\Channel au fur et à mesure qu'elles deviendront disponibles. Plusieurs boucles d'événements peuvent partager un conteneur d'entrée - parallel ne vérifie pas - le contenu du conteneur lorsqu'il est défini comme entrée pour un objet parallel\Events. - - - - Lorsqu'un objet parallel\Events effectue une écriture, la cible est retirée de l'objet d'entrée comme si - parallel\Events\Input::remove était appelé. - - -
    - -
    - &reftitle.classsynopsis; - - - - parallel\Events\Input - - - - - final - parallel\Events\Input - - - - - - - - - - - - - - - - - -
    - -     - -&reference.parallel.parallel.entities.input; - -     - diff --git a/reference/parallel/parallel.events.xml b/reference/parallel/parallel.events.xml deleted file mode 100644 index 1325958f89..0000000000 --- a/reference/parallel/parallel.events.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - La classe parallel\Events - parallel\Events - - -
    - La boucle d'événements - - La boucle d'événements surveille l'état des ensembles de futurs et/ou de canaux (cibles) afin d'effectuer des opérations de lecture (parallel\Future::value, parallel\Channel::recv) et d'écriture (parallel\Channel::send) lorsque les cibles deviennent disponibles et que les opérations peuvent être effectuées sans bloquer la boucle d'événements. - -
    -
    - &reftitle.classsynopsis; - - - - parallel\Events - - - - - final - parallel\Events - - - Countable - - - Traversable - - - - - Input - - - - - Targets - - - - - Behaviour - - - - - Polling - - - - - - -
    - -     - - &reference.parallel.parallel.events.setblocking; - &reference.parallel.parallel.events.settimeout; - &reference.parallel.parallel.events.setinput; - &reference.parallel.parallel.events.addchannel; - &reference.parallel.parallel.events.addfuture; - &reference.parallel.parallel.events.remove; - &reference.parallel.parallel.events.poll; - -     - diff --git a/reference/parallel/parallel.future.xml b/reference/parallel/parallel.future.xml deleted file mode 100644 index 7c51ba2ce7..0000000000 --- a/reference/parallel/parallel.future.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - La classe parallel\Future - parallel\Future - - - -
    - Futures - - Un Future représente la valeur de retour ou l'exception non attrapée d'une tâche, et expose une API pour l'annulation. - - - Exemple montrant Future comme valeur de retour - -run(function(){ - return "World"; -}); -printf("Hello %s\n", $future->value()); -?> -]]> - - &example.outputs.similar; - - - - - - Le comportement d'un Future permet également de l'utiliser comme un simple point de synchronisation même si la tâche ne retourne pas explicitement de valeur. - - - Exemple montrant Future comme point de synchronisation - -run(function(){ - echo "dans l'enfant "; - for ($i = 0; $i < 500; $i++) { - if ($i % 10 == 0) { - echo "."; - } - } - echo " sortie de l'enfant"; -}); - -$future->value(); -echo "\nle parent continue\n"; -?> -]]> - - &example.outputs.similar; - - - - -
    - -
    - &reftitle.classsynopsis; - - - - parallel\Future - - - - - final - parallel\Future - - - - - Résolution - - - - - États - - - - - Annulation - - - - - - - -
    - -     - - &reference.parallel.parallel.entities.future; - -     - diff --git a/reference/parallel/parallel.runtime.xml b/reference/parallel/parallel.runtime.xml deleted file mode 100644 index 4f0d24d161..0000000000 --- a/reference/parallel/parallel.runtime.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - La classe parallel\Runtime - parallel\Runtime - - - -
    - Objets d'exécution - - Chaque exécution représente un seul thread PHP, le thread est créé (et initialisé) lors de la construction. - Le thread attend ensuite que des tâches soient planifiées : les tâches planifiées seront exécutées FIFO puis le thread reprendra - l'attente jusqu'à ce que d'autres tâches soient planifiées, ou qu'il soit fermé, tué ou détruit par les règles de portée normales des objets PHP. - - - - Lorsque qu'une exécution est détruite par les règles de portée normales des objets PHP, elle exécutera d'abord toutes les tâches qui ont été planifiées, - et bloquera pendant ce temps. - - -
    - -
    - Amorçage d'exécution - - Lorsqu'une nouvelle exécution est créée, elle ne partage pas de code avec le thread (ou le processus) qui l'a créée. Cela signifie qu'elle n'a pas les mêmes - classes et fonctions chargées, ni le même chargeur automatique défini. Dans certains cas, une exécution très légère est souhaitable car les tâches qui - seront planifiées n'ont pas besoin d'accéder au code du thread parent. Dans les cas où les tâches ont besoin d'accéder au même code, il suffit de définir - un chargeur automatique comme amorçage. - - - - Le préchargement peut être utilisé en conjonction avec parallel, dans ce cas le code préchargé est disponible sans amorçage - - -
    - -
    - &reftitle.classsynopsis; - - - - parallel\Runtime - - - - - final - parallel\Runtime - - - - - Créer - - - - - Exécuter - - - - - Joindre - - - - - - -
    - -     - - &reference.parallel.parallel.runtime.construct; - &reference.parallel.parallel.runtime.run; - &reference.parallel.parallel.runtime.close; - &reference.parallel.parallel.runtime.kill; - -     - diff --git a/reference/parallel/parallel.sync.xml b/reference/parallel/parallel.sync.xml deleted file mode 100644 index 183f55cc27..0000000000 --- a/reference/parallel/parallel.sync.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - La classe parallel\Sync - parallel\Sync - - -
    - Synchronisation de bas niveau - - La classe parallel\Sync fournit un accès aux primitives de synchronisation de bas niveau, mutex, variables de condition, et permet la mise en œuvre de sémaphores. - - - - La synchronisation pour la plupart des applications est beaucoup mieux implémentée en utilisant des canaux, cependant, dans certains cas les auteurs de code de bas niveau peuvent trouver utile de pouvoir accéder à ces mécanismes de plus bas niveau. - - -
    - -
    - &reftitle.classsynopsis; - - - - parallel\Sync - - - - - final - parallel\Sync - - - - - Constructeur - - - - - Accès - - - - - Synchronisation - - - - - - - -
    - -     - - &reference.parallel.parallel.sync.construct; - &reference.parallel.parallel.sync.get; - &reference.parallel.parallel.sync.set; - &reference.parallel.parallel.sync.wait; - &reference.parallel.parallel.sync.notify; - &reference.parallel.parallel.sync.invoke; - -     - diff --git a/reference/parallel/parallel/channel/close.xml b/reference/parallel/parallel/channel/close.xml deleted file mode 100644 index f6ab09676b..0000000000 --- a/reference/parallel/parallel/channel/close.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Channel::close - Ferme - - - - &reftitle.description; - - public voidparallel\Channel::close - - - - Ferme ce canal. - - - - - - Exceptions - - - Lance une parallel\Channel\Error\Closed si le canal est fermé. - - - - - - diff --git a/reference/parallel/parallel/channel/construct.xml b/reference/parallel/parallel/channel/construct.xml deleted file mode 100644 index d16c2e5141..0000000000 --- a/reference/parallel/parallel/channel/construct.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - parallel\Channel::__construct - Construction de canal - - - - &reftitle.description; - - public parallel\Channel::__construct - - - - Crée un canal anonyme non tamponné. - - - public parallel\Channel::__construct - intcapacity - - - Crée un canal anonyme tamponné avec la capacité donnée. - - - - - - &reftitle.parameters; - - - capacity - - - Peut être Channel::Infinite ou un entier positif - - - - - - - - diff --git a/reference/parallel/parallel/channel/make.xml b/reference/parallel/parallel/channel/make.xml deleted file mode 100644 index 70975f9119..0000000000 --- a/reference/parallel/parallel/channel/make.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - parallel\Channel::make - Accès - - - - &reftitle.description; - - public Channelparallel\Channel::make - stringname - - - Crée un canal non tamponné avec le nom donné. - - - public Channelparallel\Channel::make - stringname - intcapacity - - - Crée un canal tamponné avec le nom et la capacité donnés. - - - - - - &reftitle.parameters; - - - name - - - Le nom du canal. - - - - - capacity - - - Peut être Channel::Infinite ou un entier positif - - - - - - - - Exceptions - - - Lance une parallel\Channel\Error\Existence si le canal existe déjà. - - - - - - diff --git a/reference/parallel/parallel/channel/open.xml b/reference/parallel/parallel/channel/open.xml deleted file mode 100644 index 5a4f52b52f..0000000000 --- a/reference/parallel/parallel/channel/open.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Channel::open - Accès - - - - &reftitle.description; - - public Channelparallel\Channel::open - stringname - - - Ouvre le canal avec le nom donné. - - - - - - Exceptions - - - Lance une parallel\Channel\Error\Existence si le canal n'existe pas. - - - - - - diff --git a/reference/parallel/parallel/channel/recv.xml b/reference/parallel/parallel/channel/recv.xml deleted file mode 100644 index c995ee8dce..0000000000 --- a/reference/parallel/parallel/channel/recv.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Channel::recv - Partage - - - - &reftitle.description; - - public mixedparallel\Channel::recv - - - - Reçoit une valeur de ce canal. - - - - - - Exceptions - - - Lance une parallel\Channel\Error\Closed si le canal est fermé. - - - - - - diff --git a/reference/parallel/parallel/channel/send.xml b/reference/parallel/parallel/channel/send.xml deleted file mode 100644 index 155a9f86d9..0000000000 --- a/reference/parallel/parallel/channel/send.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - parallel\Channel::send - Partage - - - - &reftitle.description; - - public voidparallel\Channel::send - mixedvalue - - - Envoie la valeur donnée sur ce canal. - - - - - - Exceptions - - - Lance une parallel\Channel\Error\Closed si le canal est fermé. - - - - - Lance une parallel\Channel\Error\IllegalValue si la valeur est illégale. - - - - - - diff --git a/reference/parallel/parallel/events/addchannel.xml b/reference/parallel/parallel/events/addchannel.xml deleted file mode 100644 index 918e822461..0000000000 --- a/reference/parallel/parallel/events/addchannel.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - parallel\Events::addChannel - Cible - - - - &reftitle.description; - - public voidparallel\Events::addChannel - parallel\Channelchannel - - - Observe les événements sur le channel donné. - - - - - Exceptions - - - Lance une parallel\Events\Error\Existence si le canal a déjà été ajouté. - - - - - - diff --git a/reference/parallel/parallel/events/addfuture.xml b/reference/parallel/parallel/events/addfuture.xml deleted file mode 100644 index 8cebb022a9..0000000000 --- a/reference/parallel/parallel/events/addfuture.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Events::addFuture - Cible - - - - &reftitle.description; - - public voidparallel\Events::addFuture - stringname - parallel\Futurefuture - - - Observe les événements sur le future donné. - - - - - Exceptions - - - Lance une parallel\Events\Error\Existence si la cible avec le nom donné a déjà été ajoutée. - - - - - - diff --git a/reference/parallel/parallel/events/poll.xml b/reference/parallel/parallel/events/poll.xml deleted file mode 100644 index c486e042f6..0000000000 --- a/reference/parallel/parallel/events/poll.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - parallel\Events::poll - Interroge - - - - &reftitle.description; - - public parallel\Events\Eventnullparallel\Events::poll - - - - Interroge pour le prochain événement. - - - - - &reftitle.returnvalues; - - S'il ne reste plus de cibles, &null; sera retourné - - - Ceci est une boucle non-bloquante, et si un blocage se produit, &null; sera retourné - - - Sinon l'parallel\Events\Event retourné décrit l'événement. - - - - - Exceptions - - - Lance une parallel\Events\Error\Timeout si un délai d'attente est utilisé et atteint. - - - - - - diff --git a/reference/parallel/parallel/events/remove.xml b/reference/parallel/parallel/events/remove.xml deleted file mode 100644 index 0146bf637a..0000000000 --- a/reference/parallel/parallel/events/remove.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - parallel\Events::remove - Cible - - - - &reftitle.description; - - public voidparallel\Events::remove - stringtarget - - - Supprime le target donné. - - - - - Exceptions - - - Lance une parallel\Events\Error\Existence si la cible avec le nom donné n'a pas été trouvée. - - - - - - diff --git a/reference/parallel/parallel/events/setblocking.xml b/reference/parallel/parallel/events/setblocking.xml deleted file mode 100644 index 49bc178a25..0000000000 --- a/reference/parallel/parallel/events/setblocking.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - parallel\Events::setBlocking - Comportement - - - - &reftitle.description; - - Par défaut lorsqu'un événement est interrogé, un blocage se produit (au niveau de PHP) jusqu'à ce que le premier événement puisse être retourné: Définir le mode de blocage à &false; fera - en sorte que l'interrogation retourne le contrôle si la première cible interrogée n'est pas prête. - - - Ceci diffère de définir un délai d'attente de 0 avec parallel\Events::setTimeout, puisqu'un délai d'attente de 0, bien que permis, provoquera une exception - d'être lancée, ce qui peut être extrêmement lent ou gaspilleur si ce qui est vraiment désiré est un comportement non-bloquant. - - - Une boucle non-bloquante affecte la valeur de retour de parallel\Events::poll, de sorte qu'il peut être &null; avant que tous les événements aient été traités. - - - public voidparallel\Events::setBlocking - boolblocking - - - Définit le mode de blocage. - - - - - Exceptions - - - Lance une parallel\Events\Error si la boucle a un délai d'attente défini. - - - - - - diff --git a/reference/parallel/parallel/events/setinput.xml b/reference/parallel/parallel/events/setinput.xml deleted file mode 100644 index 050ef8c97e..0000000000 --- a/reference/parallel/parallel/events/setinput.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - parallel\Events::setInput - Entrée - - - - &reftitle.description; - - public voidparallel\Events::setInput - Inputinput - - - Définit l'input pour cette boucle d'événements - - - - - diff --git a/reference/parallel/parallel/events/settimeout.xml b/reference/parallel/parallel/events/settimeout.xml deleted file mode 100644 index a40197871d..0000000000 --- a/reference/parallel/parallel/events/settimeout.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - parallel\Events::setTimeout - Comportement - - - - &reftitle.description; - - Par défaut lorsque les événements sont interrogés, un blocage se produit (au niveau de PHP) jusqu'à ce que le premier événement puisse être retourné : Définir le délai d'attente provoque le lancement d'une exception - lorsque le délai d'attente est atteint. - - - Ceci diffère de définir le mode de blocage à &false; avec parallel\Events::setBlocking, qui ne provoquera pas le lancement d'une exception. - - - public voidparallel\Events::setTimeout - inttimeout - - - Définit le délai d'attente en microsecondes. - - - - - Exceptions - - - Lance une parallel\Events\Error si la boucle est non-bloquante. - - - - - - diff --git a/reference/parallel/parallel/future/cancel.xml b/reference/parallel/parallel/future/cancel.xml deleted file mode 100644 index 28265897ab..0000000000 --- a/reference/parallel/parallel/future/cancel.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - parallel\Future::cancel - Annulation - - - - &reftitle.description; - - public boolparallel\Future::cancel - - - - Essaie d'annuler la tâche. - - - - Si la tâche est en cours d'exécution, elle sera interrompue. - - - - - Les appels de fonctions internes en cours ne peuvent pas être interrompus. - - - - - - Exceptions - - - Lance une parallel\Future\Error\Killed si la tâche exécutée par parallel\Runtime a été interrompue. - - - - - Lance une parallel\Future\Error\Cancelled si la tâche a déjà été annulée. - - - - - - diff --git a/reference/parallel/parallel/future/cancelled.xml b/reference/parallel/parallel/future/cancelled.xml deleted file mode 100644 index 636c71bb2b..0000000000 --- a/reference/parallel/parallel/future/cancelled.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Future::cancelled - Détection d'état - - - - &reftitle.description; - - public boolparallel\Future::cancelled - - - - Indique si la tâche a été annulée. - - - - - - diff --git a/reference/parallel/parallel/future/done.xml b/reference/parallel/parallel/future/done.xml deleted file mode 100644 index 9bc15cffa8..0000000000 --- a/reference/parallel/parallel/future/done.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Future::done - Détection d'état - - - - &reftitle.description; - - public boolparallel\Future::done - - - - Indique si la tâche est terminée. - - - - - - diff --git a/reference/parallel/parallel/future/value.xml b/reference/parallel/parallel/future/value.xml deleted file mode 100644 index 74124e63c0..0000000000 --- a/reference/parallel/parallel/future/value.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - parallel\Future::value - Résolution - - - - &reftitle.description; - - public mixedparallel\Future::value - - - - Renvoie (et attend si nécessaire) le retour de la tâche. - - - - - Exceptions - - - Lance une parallel\Future\Error si l'attente a échoué (erreur interne). - - - - - Lance une parallel\Future\Error\Killed si la tâche exécutée par parallel\Runtime a été interrompue. - - - - - Lance une parallel\Future\Error\Cancelled si la tâche a été annulée. - - - - - Lance une parallel\Future\Error\Foreign si la tâche a levé une exception non reconnue. - - - - - Relance une Throwable non attrapée dans la tâche. - - - - - - - diff --git a/reference/parallel/parallel/input/add.xml b/reference/parallel/parallel/input/add.xml deleted file mode 100644 index 255afb5b6e..0000000000 --- a/reference/parallel/parallel/input/add.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - parallel\Events\Input::add - Entrées - - - - &reftitle.description; - - public voidparallel\Events\Input::add - stringtarget - mixedvalue - - - Définit une entrée pour la cible donnée. - - - - - Exceptions - - - Lance une parallel\Events\Input\Error\Existence si l'entrée pour la cible existe déjà. - - - - - Lance une parallel\Events\Input\Error\IllegalValue si la valeur est illégale (&object;, &null;). - - - - - - diff --git a/reference/parallel/parallel/input/clear.xml b/reference/parallel/parallel/input/clear.xml deleted file mode 100644 index 08b99c8a15..0000000000 --- a/reference/parallel/parallel/input/clear.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - parallel\Events\Input::clear - Entrées - - - - &reftitle.description; - - public voidparallel\Events\Input::clear - - - - Supprime l'entrée pour toutes les cibles. - - - - - diff --git a/reference/parallel/parallel/input/remove.xml b/reference/parallel/parallel/input/remove.xml deleted file mode 100644 index 61b32def83..0000000000 --- a/reference/parallel/parallel/input/remove.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - parallel\Events\Input::remove - Entrées - - - - &reftitle.description; - - public voidparallel\Events\Input::remove - stringtarget - - - Supprime l'entrée pour la cible donnée. - - - - - Exceptions - - - Lance une parallel\Events\Input\Error\Existence si l'entrée pour la cible n'existe pas. - - - - - - diff --git a/reference/parallel/parallel/runtime/close.xml b/reference/parallel/parallel/runtime/close.xml deleted file mode 100644 index 4af419e5d9..0000000000 --- a/reference/parallel/parallel/runtime/close.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - parallel\Runtime::close - Rejoint gracieusement à l'exécution - - - - &reftitle.description; - - public voidparallel\Runtime::close - - - - Demande que l'exécution s'arrête. - - - - Les tâches planifiées pour l'exécution seront exécutées avant que l'arrêt ne se produise. - - - - - - Exceptions - - - Lance une parallel\Runtime\Error\Closed si Runtime était déjà fermé. - - - - - - - diff --git a/reference/parallel/parallel/runtime/construct.xml b/reference/parallel/parallel/runtime/construct.xml deleted file mode 100644 index c3c64937ac..0000000000 --- a/reference/parallel/parallel/runtime/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - parallel\Runtime::__construct - Construction de l'exécution - - - - &reftitle.description; - - public parallel\Runtime::__construct - - - - Construit une nouvelle exécution sans amorçage. - - - public parallel\Runtime::__construct - stringbootstrap - - - Construit une exécution amorcée. - - - - - - &reftitle.parameters; - - - bootstrap - - - La localisation d'un fichier d'amorçage, généralement un chargeur automatique. - - - - - - - - Exceptions - - - Lance une parallel\Runtime\Error si le thread n'a pas pu être créé - - - - - Lance une parallel\Runtime\Bootstrap si l'amorçage a échoué - - - - - - diff --git a/reference/parallel/parallel/runtime/kill.xml b/reference/parallel/parallel/runtime/kill.xml deleted file mode 100644 index 261c740b91..0000000000 --- a/reference/parallel/parallel/runtime/kill.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - parallel\Runtime::kill - Rejoint l'exécution - - - - &reftitle.description; - - public voidparallel\Runtime::kill - - - - Essaie de forcer l'arrêt de l'exécution. - - - - Les tâches planifiées pour l'exécution ne seront pas exécutées, la tâche en cours sera interrompue. - - - - - Les appels de fonctions internes en cours ne peuvent pas être interrompus. - - - - - - Exceptions - - - Lance une parallel\Runtime\Error\Closed si Runtime était déjà fermé. - - - - - - - diff --git a/reference/parallel/parallel/runtime/run.xml b/reference/parallel/parallel/runtime/run.xml deleted file mode 100644 index 76a6334739..0000000000 --- a/reference/parallel/parallel/runtime/run.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - parallel\Runtime::run - Exécution - - - - &reftitle.description; - - public Futurenullparallel\Runtime::run - Closuretask - - - Planifie task pour l'exécution en parallèle. - - - public Futurenullparallel\Runtime::run - Closuretask - arrayargv - - - Planifie task pour l'exécution en parallèle, en passant argv au moment de l'exécution. - - - - - - &reftitle.parameters; - - - task - - - Une Closure avec des caractéristiques spécifiques. - - - - - argv - - - Un array d'arguments avec des caractéristiques spécifiques à passer à task au moment de l'exécution. - - - - - - - - Caractéristiques de la tâche - - Les fermetures planifiées pour l'exécution en parallèle ne doivent pas : - - accepter ou retourner par référence - accepter ou retourner des objets internes (voir notes) - exécuter un ensemble limité d'instructions - - - - Les instructions interdites dans les fermetures destinées à l'exécution en parallèle sont : - - yield - utiliser by-reference - déclarer des classes - déclarer des fonctions nommées - - - - - Les fermetures imbriquées peuvent yield ou utiliser by-reference, mais ne doivent pas contenir de déclarations de classes ou de fonctions nommées. - - - - - Aucune instruction n'est interdite dans les fichiers que la tâche peut inclure. - - - - - - Caractéristiques des arguments - - Les arguments ne doivent pas: - - contenir des références - contenir des ressources - contenir des objets internes (voir notes) - - - - Dans le cas des ressources de flux de fichiers, la ressource sera convertie en descripteur de fichier et passée en int si possible, ceci n'est pas supporté sur Windows. - - - - - - - Notes sur les objets internes - - Les objets internes utilisent généralement une structure personnalisée qui ne peut pas être copiée en toute sécurité par valeur, PHP manque actuellement des mécanismes pour le faire (sans sérialisation) - et donc seuls les objets qui n'utilisent pas une structure personnalisée peuvent être partagés. - - - Certains objets internes n'utilisent pas de structure personnalisée, par exemple parallel\Events\Event et peuvent donc être partagés. - - - Les fermetures sont un type spécial d'objet interne et peuvent être copiées par valeur, et peuvent donc être partagées. - - - Les canaux sont centraux pour l'écriture de code parallèle et supportent l'accès et l'exécution concurrents par nécessité, et peuvent donc être partagés. - - - - Une classe utilisateur qui étend une classe interne peut utiliser une structure personnalisée telle que définie par la classe interne, auquel cas elle ne peut pas être copiée en toute sécurité par valeur, - et ne peut donc pas être partagée. - - - - - - &reftitle.returnvalues; - - - La Future retournée ne doit pas être ignorée lorsque la tâche contient une déclaration de retour ou de lancer. - - - - - - Exceptions - - - Lance une parallel\Runtime\Error\Closed si parallel\Runtime était fermé. - - - - - Lance une parallel\Runtime\Error\IllegalFunction si task est une fermeture créée à partir d'une fonction interne. - - - - - Lance une parallel\Runtime\Error\IllegalInstruction si task contient des instructions illégales. - - - - - Lance une parallel\Runtime\Error\IllegalParameter si task accepte ou argv contient des variables illégales. - - - - - Lance une parallel\Runtime\Error\IllegalReturn si task retourne illégalement. - - - - - - diff --git a/reference/parallel/parallel/sync/construct.xml b/reference/parallel/parallel/sync/construct.xml deleted file mode 100644 index 4fc450560f..0000000000 --- a/reference/parallel/parallel/sync/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - parallel\Sync::__construct - Construction - - - - &reftitle.description; - - public parallel\Sync::__construct - - - - Construit un nouvel objet de synchronisation sans valeur. - - - - public parallel\Sync::__construct - scalarvalue - - - Construit un nouvel objet de synchronisation contenant la valeur scalaire donnée. - - - - - - Exceptions - - - Lance une parallel\Sync\Error\IllegalValue si value n'est pas scalaire. - - - - - - diff --git a/reference/parallel/parallel/sync/get.xml b/reference/parallel/parallel/sync/get.xml deleted file mode 100644 index 5661d5a32c..0000000000 --- a/reference/parallel/parallel/sync/get.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Sync::get - Accès - - - - &reftitle.description; - - public scalarparallel\Sync::get - - - - Renvoie atomiquement la valeur de l'objet de synchronisation. - - - - - - diff --git a/reference/parallel/parallel/sync/invoke.xml b/reference/parallel/parallel/sync/invoke.xml deleted file mode 100644 index 8a6dc606a5..0000000000 --- a/reference/parallel/parallel/sync/invoke.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Sync::__invoke - Synchronisation - - - - &reftitle.description; - - public parallel\Sync::__invoke - callablecritical - - - Entre exclusivement dans le code critique - - - - - - diff --git a/reference/parallel/parallel/sync/notify.xml b/reference/parallel/parallel/sync/notify.xml deleted file mode 100644 index abef00d88b..0000000000 --- a/reference/parallel/parallel/sync/notify.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Sync::notify - Synchronisation - - - - &reftitle.description; - - public parallel\Sync::notify - boolall - - - Notifie un (par défaut) ou tous les threads en attente sur l'objet de synchronisation - - - - - - diff --git a/reference/parallel/parallel/sync/set.xml b/reference/parallel/parallel/sync/set.xml deleted file mode 100644 index 1dde902ca9..0000000000 --- a/reference/parallel/parallel/sync/set.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Sync::set - Accès - - - - &reftitle.description; - - public parallel\Sync::set - scalarvalue - - - Définit atomiquement la valeur de l'objet de synchronisation - - - - - - Exceptions - - - Lance une parallel\Sync\Error\IllegalValue si value n'est pas scalaire. - - - - - - diff --git a/reference/parallel/parallel/sync/wait.xml b/reference/parallel/parallel/sync/wait.xml deleted file mode 100644 index 6b1fb8adda..0000000000 --- a/reference/parallel/parallel/sync/wait.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Sync::wait - Synchronisation - - - - &reftitle.description; - - public parallel\Sync::wait - - - - Attend la notification sur cet objet de synchronisation - - - - - - diff --git a/reference/parallel/philosophy.xml b/reference/parallel/philosophy.xml deleted file mode 100644 index 3c45423e0b..0000000000 --- a/reference/parallel/philosophy.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Philosophie - - Cette section contient des philosophies importantes pour écrire du code parallèle et quelques détails sur l'implémentation interne de parallel. - - - Ne pas communiquer en partageant de la mémoire ; partager plutôt la mémoire en communiquant. - - Cette philosophie, qui est adoptée par parallel, a ses origines dans Go, l'une des plateformes les plus largement admirées, si ce n'est utilisées, pour écrire du code parallèle pour le moment. - Les développeurs Go doivent travailler dur pour être à la hauteur de cet idéal: PHP et parallel font tout le travail difficile pour le programmeur, et par défaut. - - - Dans les modèles de threading conventionnels trouvés dans d'autres langages, généralement les threads communiquent les uns avec les autres par le simple fait - qu'ils opèrent dans le même espace d'adressage. - Le développeur doit déployer des exclusions mutuelles, des variables de condition et d'autres primitives de bas niveau de threading ou de synchronisation pour garantir - une communication appropriée de l'état et de la cohérence. - - - Lorsque le modèle conventionnel est inversé, cela signifie que les threads ne partagent de la mémoire que par la communication (une variable est passée sur un canal par exemple). - - - Lorsque parallel passe une variable d'un thread à un autre par n'importe quel moyen - arguments de tâche, retour via Future et Channels - elle est passée par valeur. - Dans tous les cas, sauf dans le cas des canaux non tamponnés, la variable est également mise en mémoire tampon de sorte qu'elle ne puisse pas changer (ou être détruite) avant d'être utilisée dans le thread - à qui la variable est transmise. Une lecture non tamponnée sur un canal est le seul cas où un thread lit directement la mémoire allouée par un autre thread, il peut le faire en toute sécurité car - le thread qui possède la mémoire attend que la lecture soit terminée avant de pouvoir continuer à la manipuler, et le thread qui ne possède pas la mémoire lit par valeur. Lorsque - les deux threads continuent, ils ne partagent plus de mémoire. - - - Cela rend l'écriture et le raisonnement sur le code parallèle beaucoup plus faciles que le modèle conventionnel de threading. Cela signifie que le programmeur n'a pas besoin de considérer que les threads - peuvent manipuler des données simultanément, car cela n'est pas possible. - - - Cela rend également PHP la plateforme parfaite pour implémenter une API de concurrence parallèle basée sur CSP (passage de messages sur des canaux), car PHP lui-même est partagé rien - - les threads PHP fonctionnent dans leur propre espace d'adressage virtuel par défaut, et ne peuvent donc partager de mémoire qu'en communiquant. - - - - Les données doivent avoir un propriétaire unique et définitif - - Lorsque l'on aborde le modèle CSP pour la première fois, un programmeur versé dans le modèle traditionnel de threading peut se retrouver à la recherche de structures de données concurrentes, - car c'est ce à quoi il est habitué: il passe des objets partagés pour les manipuler. - - - Lorsque l'on aborde le modèle CSP, il n'est pas nécessaire que les structures de données soient partagées par de nombreuses tâches, et en fait, il est plus simple si elles ne le sont pas. Les données doivent être possédées - par une seule tâche, les modifications (ou opérations) de cette structure de données doivent être communiquées via des canaux et effectuées par le propriétaire des données, le succès, l'échec, - ou le résultat (état) du changement (ou de l'opération) étant communiqué en retour. - - - Une fois encore la nature de PHP et la nature de copie par valeur de parallel aide le développeur à atteindre cet objectif, aucune donnée ne sera partagée par accident, - seulement jamais comme résultat de la communication. - - - - diff --git a/reference/parallel/setup.xml b/reference/parallel/setup.xml deleted file mode 100644 index faf83b26e3..0000000000 --- a/reference/parallel/setup.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Installation - - - &reftitle.required; - - parallel requiert une compilation de PHP avec ZTS (Zend Thread Safety) activé - (, ou sur les systèmes non-Windows avant PHP 8.0.0, - ) - - - - Zend Thread Safety ne peut pas être activé après la compilation; c'est une option de configuration de compilation. - - - - parallel devrait se compiler partout où il y a un en-tête Posix Threads fonctionnel (pthread.h) et une compilation ZTS de PHP, y compris Windows (en utilisant le projet pthread-w32 de redhat). - - - - - &reftitle.install; - - Les versions de parallel sont hébergées par PECL et le code source par - github, - la méthode d'installation la plus simple est la route PECL normale: - &url.pecl.package;parallel. - - - Les utilisateurs de Windows peuvent télécharger des binaires de version précompilés depuis le site PECL. - - - - Les utilisateurs de Windows doivent prendre la mesure supplémentaire d'ajouter pthreadVC?.dll (distribué avec les versions Windows) à leur PATH. - - - - - diff --git a/reference/parle/book.xml b/reference/parle/book.xml deleted file mode 100644 index 09997dd9c1..0000000000 --- a/reference/parle/book.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - Analyse lexicale et syntaxique - Parle - - - &reftitle.intro; - &warn.experimental; - - L'extension parle apporte des facilités de lexing et de parsing à usage général. L'implémentation est basée sur ces bibliothèques et nécessite un compilateur compatible avec C++14. L'analyse lexicale est basée sur la correspondance regex, l'analyse syntaxique est LALR(1). Les analyseurs sont générés à la volée et peuvent être utilisés immédiatement après avoir été finalisés. Parle traite l'analyse lexicale et syntaxique, la représentation et le traitement des structures de données appropriées sont la tâche de l'implémenteur. La sérialisation et la génération de code ne sont pas prises en charge par l'extension, pour l'instant. - - - L'analyse lexicale est un processus de division d'une séquence de caractères en une liste de lexèmes. La liste de lexèmes peut ensuite être utilisée pour l'analyse syntaxique par rapport à une grammaire formelle. Ces opérations sont également connues sous le nom d'analyse lexicale (lexing) et d'analyse syntaxique (parsing). Cette documentation n'a pas pour but de fournir une information exhaustive sur le lexing et le parsing. De bonnes informations à ce sujet sont disponibles sur les nombreuses ressources sur le net. Plusieurs exemples d'utilisation sont inclus, pour montrer la fonctionnalité. L'extension est utile pour les développeurs PHP désireux d'apprendre ou d'utiliser l'analyse lexicale et syntaxique. Les machines à états et l'analyse de grammaire n'ont pas à être implémentées manuellement, ces tâches complexes sont prises en charge par parle. Grâce à cela, le développement peut se concentrer sur la résolution de problèmes réels. - - - Les cas d'utilisation courants pour parle sont, quand un format de données est trop complexe pour être géré par la correspondance regex avec PCRE. L'application pratique est donc large. Que ce soit un format de données spécifique, une modification du comportement des fonctions existantes, voire un langage de programmation et au-delà. Les méthodes d'aide telles que Parle\Lexer::dump pour inspecter la machine à états générée, ou Parle\Parser::dump pour inspecter la grammaire générée, sont utiles. La méthode Parle\Parser::trace peut également être utilisée pour suivre l'opération d'analyse. - - - - &reference.parle.setup; - &reference.parle.constants; - &reference.parle.pattern.matching; - &reference.parle.examples; - &reference.parle.parle.lexer; - &reference.parle.parle.rlexer; - &reference.parle.parle.parser; - &reference.parle.parle.rparser; - &reference.parle.parle.stack; - &reference.parle.parle.token; - &reference.parle.parle.errorinfo; - &reference.parle.parle.lexerexception; - &reference.parle.parle.parserexception; - - - - diff --git a/reference/parle/configure.xml b/reference/parle/configure.xml deleted file mode 100644 index 4a1e7268ca..0000000000 --- a/reference/parle/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;parle - - - -
    - - - diff --git a/reference/parle/constants.xml b/reference/parle/constants.xml deleted file mode 100644 index 24dde3379f..0000000000 --- a/reference/parle/constants.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - Parle\INTERNAL_UTF32 - bool - - - - Drapeau permettant de savoir si le support interne UTF-32 a - bien été compilé. Disponible depuis parle 0.7.2. - - - - - - - diff --git a/reference/parle/examples.xml b/reference/parle/examples.xml deleted file mode 100644 index a65d969f4b..0000000000 --- a/reference/parle/examples.xml +++ /dev/null @@ -1,234 +0,0 @@ - - - - - &reftitle.examples; -
    - Exemples d'analyse lexicale (Lexer) - - Tokeniser une liste d'entiers séparés par des virgules - - id */ -$token = array( - "COMMA" => 1, - "CRLF" => 2, - "DECIMAL" => 3, -); -/* id => name */ -$tokenIdToName = array_flip($token); - -$lex = new Lexer; -$lex->push("[\x2c]", $token["COMMA"]); -$lex->push("[\r][\n]", $token["CRLF"]); -$lex->push("[\d]+", $token["DECIMAL"]); -$lex->build(); - -$in = "0,1,2\r\n3,42,5\r\n6,77,8\r\n"; - -$lex->consume($in); - -do { - $lex->advance(); - $tok = $lex->getToken(); - - if (Token::UNKNOWN == $tok->id) { - throw new LexerException("Unknown token '{$tok->value}' at offset {$lex->marker}."); - } - - echo "TOKEN: ", $tokenIdToName[$tok->id], PHP_EOL; -} while (Token::EOI != $tok->id); -]]> - - - - Tokeniser une instruction d'assignation - -push("\$[a-zA-Z_][a-zA-Z0-9_]*", 1); -$lex->push("=", 2); -$lex->push("\d+", 3); -$lex->push(";", 4); - -$lex->build(); - -$lex->consume('$x = 42; $y = 24;'); - - -do { - $lex->advance(); - $tok = $lex->getToken(); - var_dump($tok); -} while (Token::EOI != $tok->id); -]]> - - -
    -
    - Exemples d'analyse syntaxique (Parser) - - Simple calculatrice - -token("INTEGER"); -$p->left("'+' '-' '*' '/'"); - -$p->push("start", "exp"); -$prod_add = $p->push("exp", "exp '+' exp"); -$prod_sub = $p->push("exp", "exp '-' exp"); -$prod_mul = $p->push("exp", "exp '*' exp"); -$prod_div = $p->push("exp", "exp '/' exp"); -$p->push("exp", "INTEGER"); /* Production index unused. */ - -$p->build(); - -$lex = new Lexer; -$lex->push("[+]", $p->tokenId("'+'")); -$lex->push("[-]", $p->tokenId("'-'")); -$lex->push("[*]", $p->tokenId("'*'")); -$lex->push("[/]", $p->tokenId("'/'")); -$lex->push("\\d+", $p->tokenId("INTEGER")); -$lex->push("\\s+", Token::SKIP); - -$lex->build(); - -$exp = array( - "1 + 1", - "33 / 10", - "100 * 45", - "17 - 45", -); - -foreach ($exp as $in) { - if (!$p->validate($in, $lex)) { - throw new ParserException("Failed to validate input"); - } - - $p->consume($in, $lex); - - while (Parser::ACTION_ERROR != $p->action && Parser::ACTION_ACCEPT != $p->action) { - switch ($p->action) { - case Parser::ACTION_ERROR: - throw new ParserException("Parser error"); - break; - case Parser::ACTION_SHIFT: - case Parser::ACTION_GOTO: - case Parser::ACTION_ACCEPT: - break; - case Parser::ACTION_REDUCE: - switch ($p->reduceId) { - case $prod_add: - $l = $p->sigil(0); - $r = $p->sigil(2); - echo "$l + $r = " . ($l + $r) . "\n"; - break; - case $prod_sub: - $l = $p->sigil(0); - $r = $p->sigil(2); - echo "$l - $r = " . ($l - $r) . "\n"; - break; - case $prod_mul: - $l = $p->sigil(0); - $r = $p->sigil(2); - echo "$l * $r = " . ($l * $r) . "\n"; - break; - case $prod_div: - $l = $p->sigil(0); - $r = $p->sigil(2); - echo "$l / $r = " . ($l / $r) . "\n"; - break; - } - break; - } - $p->advance(); - } -} -]]> - - - - Analyser une phrase pour en extraire les mots - -token("WORD"); -$p->push("START", "SENTENCE"); -$p->push("SENTENCE", "WORDS"); -$prod_word_0 = $p->push("WORDS", "WORDS WORD"); -$prod_word_1 = $p->push("WORDS", "WORD"); -$p->build(); - -$lex = new Lexer; -$lex->push("[^\s]{-}[\.,\:\;\?]+", $p->tokenId("WORD")); -$lex->push("[\s\.,\:\;\?]+", Token::SKIP); -$lex->build(); - -$in = "Dis-moi où est ton papa?"; -$p->consume($in, $lex); -do { - switch ($p->action) { - case Parser::ACTION_ERROR: - throw new ParserException("Error"); - break; - case Parser::ACTION_SHIFT: - case Parser::ACTION_GOTO: - /* var_dump($p->trace());*/ - break; - case Parser::ACTION_REDUCE: - $rid = $p->reduceId(); - if ($rid == $prod_word_1) { - var_dump($p->sigil(0)); - } if ($rid == $prod_word_0) { - var_dump($p->sigil(1)); - } - break; - } - $p->advance(); -} while (Parser::ACTION_ACCEPT != $p->action); -]]> - - -
    -     - - diff --git a/reference/parle/parle.errorinfo.xml b/reference/parle/parle.errorinfo.xml deleted file mode 100644 index a2be340822..0000000000 --- a/reference/parle/parle.errorinfo.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - La classe Parle\ErrorInfo - Parle\ErrorInfo - - - - -
    - &reftitle.intro; - - La classe représente les informations d'erreurs détaillées, telles que fournies - par la méthode Parle\Parser::errorInfo - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\ErrorInfo - - - - - Parle\ErrorInfo - - - - &Properties; - - public - int - id - - - public - int - position - - - public - mixed - token - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - id - - Identifiant de l'erreur. - - - - position - - Position dans l'entrée où l'erreur s'est produite. - - - - token - - - Si applicable, la classe Parle\Token relative à l'erreur, - sinon &null;. - - - -
    - - - -     - - - -     - - diff --git a/reference/parle/parle.lexer.xml b/reference/parle/parle.lexer.xml deleted file mode 100644 index 155c991b85..0000000000 --- a/reference/parle/parle.lexer.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - La classe Parle\Lexer - Parle\Lexer - - - - -
    - &reftitle.intro; - - Classe d'analyse lexicale à état unique. Les lexèmes peuvent être définis à la volée. Si l'instance de lexer particulière est destinée à être utilisée avec Parle\Parser, les identifiants de jetons doivent être pris à partir de là. Sinon, des identifiants de jetons arbitraires peuvent être fournis. Ce lexer peut offrir un certain avantage de performance par rapport à Parle\RLexer, s'il n'y a pas besoin de plusieurs états. Il est à noter que Parle\RParser n'est pas compatible avec ce lexer. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\Lexer - - - - - Parle\Lexer - - - - &Constants; - - const - int - Parle\Lexer::ICASE - 1 - - - const - int - Parle\Lexer::DOT_NOT_LF - 2 - - - const - int - Parle\Lexer::DOT_NOT_CRLF - 4 - - - const - int - Parle\Lexer::SKIP_WS - 8 - - - const - int - Parle\Lexer::MATCH_ZERO_LEN - 16 - - - &Properties; - - public - bool - bol - &false; - - - public - int - flags - 0 - - - public - int - state - 0 - - - public - int - marker - 0 - - - public - int - cursor - 0 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Parle\Lexer::ICASE - - - - - - - Parle\Lexer::DOT_NOT_LF - - - - - - - Parle\Lexer::DOT_NOT_CRLF - - - - - - - Parle\Lexer::SKIP_WS - - - - - - - Parle\Lexer::MATCH_ZERO_LEN - - - - - - -
    - - - -
    - &reftitle.properties; - - - bol - - Indicateur de début d'entrée. - - - - flags - - Drapeaux du lexer. - - - - state - - État actuel du lexer, en lecture seule. - - - - marker - - Position de la dernière correspondance de jeton, en lecture seule. - - - - cursor - - Décalage d'entrée actuel, en lecture seule. - - - -
    - - -     - - - &reference.parle.parle.entities.lexer; - -     - - diff --git a/reference/parle/parle.lexerexception.xml b/reference/parle/parle.lexerexception.xml deleted file mode 100644 index d712a1fb28..0000000000 --- a/reference/parle/parle.lexerexception.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - La classe Parle\LexerException - Parle\LexerException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\LexerException - - - - - Parle\LexerException - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - -     - - - -     - - diff --git a/reference/parle/parle.parser.xml b/reference/parle/parle.parser.xml deleted file mode 100644 index 4b6d10a9ec..0000000000 --- a/reference/parle/parle.parser.xml +++ /dev/null @@ -1,215 +0,0 @@ - - - - - La classe Parle\Parser - Parle\Parser - - - - -
    - &reftitle.intro; - - Classe d'analyse syntaxique. Les règles peuvent être définies à la volée. Une fois finalisée, une instance de Parle\Lexer est requise pour fournir le flux de jetons. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\Parser - - - - - Parle\Parser - - - - &Constants; - - const - int - Parle\Parser::ACTION_ERROR - 0 - - - const - int - Parle\Parser::ACTION_SHIFT - 1 - - - const - int - Parle\Parser::ACTION_REDUCE - 2 - - - const - int - Parle\Parser::ACTION_GOTO - 3 - - - const - int - Parle\Parser::ACTION_ACCEPT - 4 - - - const - int - Parle\Parser::ERROR_SYNTAX - 0 - - - const - int - Parle\Parser::ERROR_NON_ASSOCIATIVE - 1 - - - const - int - Parle\Parser::ERROR_UNKNOWN_TOKEN - 2 - - - &Properties; - - public - int - action - 0 - - - public - int - reduceId - 0 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Parle\Parser::ACTION_ERROR - - - - - - - Parle\Parser::ACTION_SHIFT - - - - - - - Parle\Parser::ACTION_REDUCE - - - - - - - Parle\Parser::ACTION_GOTO - - - - - - - Parle\Parser::ACTION_ACCEPT - - - - - - - Parle\Parser::ERROR_SYNTAX - - - - - - - Parle\Parser::ERROR_NON_ASSOCIATIVE - - - - - - - Parle\Parser::ERROR_UNKNOWN_TOKEN - - - - - - -
    - - - -
    - &reftitle.properties; - - - action - - Les actions du parseur actuel qui correspondent à l'une des constantes de classe d'action, en lecture seule. - - - - reduceId - - Identifiant de la règle de grammaire qui vient d'être traitée dans l'action de réduction. La valeur correspond soit à un jeton, soit à un identifiant de production. En lecture seule. - - - -
    - - -     - - - &reference.parle.parle.entities.parser; - -     - - diff --git a/reference/parle/parle.parserexception.xml b/reference/parle/parle.parserexception.xml deleted file mode 100644 index 473441141b..0000000000 --- a/reference/parle/parle.parserexception.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - La classe Parle\ParserException - Parle\ParserException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\ParserException - - - - - Parle\ParserException - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - -     - - - -     - - diff --git a/reference/parle/parle.rlexer.xml b/reference/parle/parle.rlexer.xml deleted file mode 100644 index 41bcb5cb11..0000000000 --- a/reference/parle/parle.rlexer.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - La classe Parle\RLexer - Parle\RLexer - - - - -
    - &reftitle.intro; - - Classe d'analyse lexicale à états multiples. Les lexèmes peuvent être définis à la volée. Si l'instance de lexer particulière est destinée à être utilisée avec Parle\RParser, les identifiants de jetons doivent être pris à partir de là. Sinon, des identifiants de jetons arbitraires peuvent être fournis. Il convient de noter que Parle\Parser n'est pas compatible avec ce lexer. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\RLexer - - - - - Parle\RLexer - - - - &Constants; - - const - int - Parle\RLexer::ICASE - 1 - - - const - int - Parle\RLexer::DOT_NOT_LF - 2 - - - const - int - Parle\RLexer::DOT_NOT_CRLF - 4 - - - const - int - Parle\RLexer::SKIP_WS - 8 - - - const - int - Parle\RLexer::MATCH_ZERO_LEN - 16 - - - &Properties; - - public - bool - bol - &false; - - - public - int - flags - 0 - - - public - int - state - 0 - - - public - int - marker - 0 - - - public - int - cursor - 0 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Parle\RLexer::ICASE - - - - - - - Parle\RLexer::DOT_NOT_LF - - - - - - - Parle\RLexer::DOT_NOT_CRLF - - - - - - - Parle\RLexer::SKIP_WS - - - - - - - Parle\RLexer::MATCH_ZERO_LEN - - - - - - -
    - - - -
    - &reftitle.properties; - - - bol - - Indicateur de début d'entrée. - - - - flags - - Drapeaux du lexer. - - - - state - - État actuel du lexer, en lecture seule. - - - - marker - - Position de la dernière correspondance de jeton, en lecture seule. - - - - cursor - - Décalage d'entrée actuel, en lecture seule. - - - -
    - - -     - - - &reference.parle.parle.entities.rlexer; - -     - - diff --git a/reference/parle/parle.rparser.xml b/reference/parle/parle.rparser.xml deleted file mode 100644 index 5c2f2cdcf2..0000000000 --- a/reference/parle/parle.rparser.xml +++ /dev/null @@ -1,215 +0,0 @@ - - - - - La classe Parle\RParser - Parle\RParser - - - - -
    - &reftitle.intro; - - Classe d'analyse syntaxique. Les règles peuvent être définies à la volée. Une fois finalisée, une instance de Parle\RLexer est requise pour fournir le flux de jetons. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\RParser - - - - - Parle\RParser - - - - &Constants; - - const - int - Parle\RParser::ACTION_ERROR - 0 - - - const - int - Parle\RParser::ACTION_SHIFT - 1 - - - const - int - Parle\RParser::ACTION_REDUCE - 2 - - - const - int - Parle\RParser::ACTION_GOTO - 3 - - - const - int - Parle\RParser::ACTION_ACCEPT - 4 - - - const - int - Parle\RParser::ERROR_SYNTAX - 0 - - - const - int - Parle\RParser::ERROR_NON_ASSOCIATIVE - 1 - - - const - int - Parle\RParser::ERROR_UNKNOWN_TOKEN - 2 - - - &Properties; - - public - int - action - 0 - - - public - int - reduceId - 0 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Parle\RParser::ACTION_ERROR - - - - - - - Parle\RParser::ACTION_SHIFT - - - - - - - Parle\RParser::ACTION_REDUCE - - - - - - - Parle\RParser::ACTION_GOTO - - - - - - - Parle\RParser::ACTION_ACCEPT - - - - - - - Parle\RParser::ERROR_SYNTAX - - - - - - - Parle\RParser::ERROR_NON_ASSOCIATIVE - - - - - - - Parle\RParser::ERROR_UNKNOWN_TOKEN - - - - - - -
    - - - -
    - &reftitle.properties; - - - action - - Les actions du parseur actuel qui correspondent à l'une des constantes de classe d'action, en lecture seule. - - - - reduceId - - Identifiant de la règle de grammaire qui vient d'être traitée dans l'action de réduction. La valeur correspond soit à un jeton, soit à un identifiant de production. En lecture seule. - - - -
    - - -     - - - &reference.parle.parle.entities.rparser; - -     - - diff --git a/reference/parle/parle.stack.xml b/reference/parle/parle.stack.xml deleted file mode 100644 index b52b031d08..0000000000 --- a/reference/parle/parle.stack.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - La classe Parle\Stack - Parle\Stack - - - - -
    - &reftitle.intro; - - Parle\Stack est une pile LIFO. Les éléments sont insérés et retirés uniquement d'une extrémité. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\Stack - - - - - Parle\Stack - - - - - &Properties; - - public - bool - empty - &true; - - - public - int - size - 0 - - - public - mixed - top - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - empty - - Si la pile est vide, en lecture seule. - - - - size - - Taille de la pile, en lecture seule. - - - - top - - Élément au sommet de la pile. - - - -
    - - -     - - - &reference.parle.parle.entities.stack; - -     - - diff --git a/reference/parle/parle.token.xml b/reference/parle/parle.token.xml deleted file mode 100644 index ab82920a18..0000000000 --- a/reference/parle/parle.token.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - La classe Parle\Token - Parle\Token - - - - -
    - &reftitle.intro; - - Cette classe représente un jeton. L'analyseur lexical retourne des instances de cette classe. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\Token - - - - - Parle\Token - - - - &Constants; - - const - int - Parle\Token::EOI - 0 - - - const - int - Parle\Token::UNKNOWN - -1 - - - const - int - Parle\Token::SKIP - -2 - - - &Properties; - - public - int - id - - - public - string - value - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - id - - L'identifiant du jeton. - - - - value - - La valeur du jeton. - - - -
    - - - - -
    - &reftitle.constants; - - - - Parle\Token::EOI - - L'identifiant de jeton de fin d'entrée. - - - - - Parle\Token::UNKNOWN - - L'identifiant de jeton inconnu. - - - - - Parle\Token::SKIP - - L'identifiant de jeton à ignorer. - - - - -
    - - - -     - - - -     - - diff --git a/reference/parle/parle/lexer/advance.xml b/reference/parle/parle/lexer/advance.xml deleted file mode 100644 index 44637868a5..0000000000 --- a/reference/parle/parle/lexer/advance.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Parle\Lexer::advance - Avance à la règle suivante du lexer - - - - &reftitle.description; - - public voidParle\Lexer::advance - - - - Avance à la règle suivante et prépare les données du jeton résultant. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/build.xml b/reference/parle/parle/lexer/build.xml deleted file mode 100644 index 87567c4799..0000000000 --- a/reference/parle/parle/lexer/build.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Lexer::build - Finalise l'ensemble de règles du lexer - - - - &reftitle.description; - - public voidParle\Lexer::build - - - - Les règles, précédemment ajoutées avec Parle\Lexer::push sont finalisées. Cet appel de méthode doit être fait après que toutes les règles nécessaires aient été ajoutées. L'ensemble de règles devient en lecture seule. L'analyse lexicale peut commencer. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/callout.xml b/reference/parle/parle/lexer/callout.xml deleted file mode 100644 index f27ec9f5c2..0000000000 --- a/reference/parle/parle/lexer/callout.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\Lexer::callout - Définit une fonction de rappel de jeton - - - - &reftitle.description; - - public voidParle\Lexer::callout - intid - callablecallback - - - Définit une fonction de rappel à invoquer une fois que le lexer rencontre un jeton particulier. - - - - - &reftitle.parameters; - - - id - - - L'identifiant du jeton. - - - - - callback - - - La fonction de rappel à invoquer. La fonction de rappel ne reçoit aucun argument et sa valeur de retour est ignorée. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/consume.xml b/reference/parle/parle/lexer/consume.xml deleted file mode 100644 index 388ee5d21e..0000000000 --- a/reference/parle/parle/lexer/consume.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Lexer::consume - Passe les données pour le traitement - - - - &reftitle.description; - - public voidParle\Lexer::consume - stringdata - - - Consomme les données pour l'analyse lexicale. - - - - - &reftitle.parameters; - - - data - - - Les données à analyser. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/dump.xml b/reference/parle/parle/lexer/dump.xml deleted file mode 100644 index 5de4b88a27..0000000000 --- a/reference/parle/parle/lexer/dump.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Lexer::dump - Affiche la machine d'état - - - - &reftitle.description; - - public voidParle\Lexer::dump - - - - Affiche la machine d'état actuelle sur la sortie standard. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/gettoken.xml b/reference/parle/parle/lexer/gettoken.xml deleted file mode 100644 index 12e8b144ae..0000000000 --- a/reference/parle/parle/lexer/gettoken.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Lexer::getToken - Renvoie le jeton actuel - - - - &reftitle.description; - - public Parle\TokenParle\Lexer::getToken - - - - Renvoie le jeton actuel. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une instance de Parle\Token. - - - - - - - diff --git a/reference/parle/parle/lexer/insertmacro.xml b/reference/parle/parle/lexer/insertmacro.xml deleted file mode 100644 index 0fc237446f..0000000000 --- a/reference/parle/parle/lexer/insertmacro.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\Lexer::insertMacro - Insère une macro regex - - - - &reftitle.description; - - public voidParle\Lexer::insertMacro - stringname - stringregex - - - Insère une macro regex, qui peut être utilisée plus tard comme un raccourci et incluse dans d'autres expressions régulières. - - - - - &reftitle.parameters; - - - name - - - Le nom de la macro. - - - - - regex - - - L'expression régulière. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/push.xml b/reference/parle/parle/lexer/push.xml deleted file mode 100644 index 36d75a509c..0000000000 --- a/reference/parle/parle/lexer/push.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Parle\Lexer::push - Ajoute une règle d'analyse - - - - &reftitle.description; - - public voidParle\Lexer::push - stringregex - intid - - - - Ajoute un modèle pour la reconnaissance des lexèmes. - - - - - &reftitle.parameters; - - - regex - - - Expression régulière utilisée pour la reconnaissance des lexèmes. - - - - - id - - - L'identifiant du jeton. Si l'instance de l'analyseur lexical est destinée à être utilisée seule, il peut s'agir d'un nombre arbitraire. Si l'instance de l'analyseur lexical doit être passée à l'analyseur, il doit s'agir d'un identifiant retourné par Parle\Parser::tokenid. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/reset.xml b/reference/parle/parle/lexer/reset.xml deleted file mode 100644 index 32761bd812..0000000000 --- a/reference/parle/parle/lexer/reset.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Lexer::reset - Réinitialise l'analyseur lexical - - - - &reftitle.description; - - public voidParle\Lexer::reset - intpos - - - Réinitialise l'analyseur lexical en passant optionnellement la position désirée. - - - - - &reftitle.parameters; - - - pos - - - La position pour réinitialiser. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/advance.xml b/reference/parle/parle/parser/advance.xml deleted file mode 100644 index 610492924c..0000000000 --- a/reference/parle/parle/parser/advance.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Parser::advance - Traite la règle suivante de l'analyseur - - - - &reftitle.description; - - public voidParle\Parser::advance - - - - Traite la règle suivante de l'analyseur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/build.xml b/reference/parle/parle/parser/build.xml deleted file mode 100644 index c635d1aca4..0000000000 --- a/reference/parle/parle/parser/build.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Parser::build - Finalise les règles de grammaire - - - - &reftitle.description; - - public voidParle\Parser::build - - - - Chaque jeton et règle de grammaire précédemment ajoutés sont finalisés. L'ensemble de règles devient en lecture seule et l'analyseur est prêt à démarrer. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/consume.xml b/reference/parle/parle/parser/consume.xml deleted file mode 100644 index d66a47d0ff..0000000000 --- a/reference/parle/parle/parser/consume.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\Parser::consume - Consomme les données pour le traitement - - - - &reftitle.description; - - public voidParle\Parser::consume - stringdata - Parle\Lexerlexer - - - Consomme les données pour le traitement. - - - - - &reftitle.parameters; - - - data - - - Les données à analyser. - - - - - lexer - - - Un objet lexer contenant les règles d'analyses lexicales préparées pour la grammaire particulière. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/dump.xml b/reference/parle/parle/parser/dump.xml deleted file mode 100644 index bdc58996f0..0000000000 --- a/reference/parle/parle/parser/dump.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Parser::dump - Affiche la grammaire - - - - &reftitle.description; - - public voidParle\Parser::dump - - - - Affiche la grammaire actuelle sur la sortie standard. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/errorinfo.xml b/reference/parle/parle/parser/errorinfo.xml deleted file mode 100644 index e377a14e56..0000000000 --- a/reference/parle/parle/parser/errorinfo.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Parser::errorInfo - Récupère les informations d'erreur - - - - &reftitle.description; - - public Parle\ErrorInfoParle\Parser::errorInfo - - - - Récupère les informations d'erreur dans le cas où Parle\Parser::action aurait retourné l'action d'erreur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une instance de Parle\ErrorInfo. - - - - - - - diff --git a/reference/parle/parle/parser/left.xml b/reference/parle/parle/parser/left.xml deleted file mode 100644 index b3287210a7..0000000000 --- a/reference/parle/parle/parser/left.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::left - Déclare un jeton avec une associativité à gauche - - - - &reftitle.description; - - public voidParle\Parser::left - stringtok - - - Déclare un jeton avec une associativité à gauche. - - - - - &reftitle.parameters; - - - tok - - - Le nom du jeton. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/nonassoc.xml b/reference/parle/parle/parser/nonassoc.xml deleted file mode 100644 index 157a99d34d..0000000000 --- a/reference/parle/parle/parser/nonassoc.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::nonassoc - Déclare un jeton sans associativité - - - - &reftitle.description; - - public voidParle\Parser::nonassoc - stringtok - - - Déclare un jeton, qui ne peut apparaître qu'une seule fois dans la ligne. - - - - - &reftitle.parameters; - - - tok - - - Le nom du jeton. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/precedence.xml b/reference/parle/parle/parser/precedence.xml deleted file mode 100644 index 1220654011..0000000000 --- a/reference/parle/parle/parser/precedence.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::precedence - Déclare une règle de précédence - - - - &reftitle.description; - - public voidParle\Parser::precedence - stringtok - - - Déclare une règle de précédence pour un jeton fictif. Cette règle peut être utilisée plus tard dans les règles de grammaire spécifiques. - - - - - &reftitle.parameters; - - - tok - - - Le nom du jeton. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/push.xml b/reference/parle/parle/parser/push.xml deleted file mode 100644 index 9a317dddc3..0000000000 --- a/reference/parle/parle/parser/push.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\Parser::push - Ajoute une règle de grammaire - - - - &reftitle.description; - - public intParle\Parser::push - stringname - stringrule - - - Ajoute une règle de grammaire. L'identifiant de production retourné peut être utilisé plus tard dans le processus d'analyse pour identifier la règle correspondante. - - - - - &reftitle.parameters; - - - name - - - Le nom de la règle. - - - - - rule - - - La règle à ajouter. La syntaxe est compatible avec Bison. - - - - - - - - &reftitle.returnvalues; - - Renvoie un &integer; représentant l'index de la règle. - - - - - - - diff --git a/reference/parle/parle/parser/reset.xml b/reference/parle/parle/parser/reset.xml deleted file mode 100644 index 7e00c05dea..0000000000 --- a/reference/parle/parle/parser/reset.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::reset - Réinitialise l'état de l'analyseur - - - - &reftitle.description; - - public voidParle\Parser::reset - inttokenId - - - Réinitialise l'état de l'analyseur en utilisant l'identifiant de jeton donné. - - - - - &reftitle.parameters; - - - tokenId - - - L'identifiant du jeton. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/right.xml b/reference/parle/parle/parser/right.xml deleted file mode 100644 index fe2509ce92..0000000000 --- a/reference/parle/parle/parser/right.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::right - Déclare un jeton avec une associativité à droite - - - - &reftitle.description; - - public voidParle\Parser::right - stringtok - - - Déclare un jeton avec une associativité à droite. - - - - - &reftitle.parameters; - - - tok - - - Le nom du jeton. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/sigil.xml b/reference/parle/parle/parser/sigil.xml deleted file mode 100644 index 7322c48b3e..0000000000 --- a/reference/parle/parle/parser/sigil.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::sigil - Récupère une partie correspondante d'une règle - - - - &reftitle.description; - - public stringParle\Parser::sigil - intidx - - - Récupère une partie correspondante d'une règle. Cette méthode est équivalente à la fonctionnalité de pseudo-variable dans Bison. - - - - - &reftitle.parameters; - - - idx - - - L'identifiant de correspondance, basé sur zéro. - - - - - - - - &reftitle.returnvalues; - - Renvoie une &string; avec la partie correspondante. - - - - - - - diff --git a/reference/parle/parle/parser/sigilcount.xml b/reference/parle/parle/parser/sigilcount.xml deleted file mode 100644 index 3f69c26a5f..0000000000 --- a/reference/parle/parle/parser/sigilcount.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Parser::sigilCount - Nombre d'éléments dans la règle correspondante - - - - &reftitle.description; - - public intParle\Parser::sigilCount - - - - Renvoie le nombre d'éléments dans la règle correspondante. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un &integer; - - - - - - - diff --git a/reference/parle/parle/parser/sigilname.xml b/reference/parle/parle/parser/sigilname.xml deleted file mode 100644 index 1dd8c87693..0000000000 --- a/reference/parle/parle/parser/sigilname.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::sigilName - Récupère un nom de règle ou de jeton - - - - &reftitle.description; - - public stringParle\Parser::sigilName - intidx - - - Récupère un nom de règle partiel ou de jeton correspondant à l'index de sigil. - - - - - &reftitle.parameters; - - - idx - - - L'identifiant de correspondance, basé sur zéro. - - - - - - - - &reftitle.returnvalues; - - Renvoie un &string; avec la partie correspondante. - - - - - - - diff --git a/reference/parle/parle/parser/token.xml b/reference/parle/parle/parser/token.xml deleted file mode 100644 index 50768d25ad..0000000000 --- a/reference/parle/parle/parser/token.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::token - Déclare un jeton - - - - &reftitle.description; - - public voidParle\Parser::token - stringtok - - - Déclare un jeton à utiliser dans la grammaire. - - - - - &reftitle.parameters; - - - tok - - - Le nom du jeton. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/tokenid.xml b/reference/parle/parle/parser/tokenid.xml deleted file mode 100644 index 21a2478d52..0000000000 --- a/reference/parle/parle/parser/tokenid.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::tokenId - Renvoie l'identifiant du jeton - - - - &reftitle.description; - - public intParle\Parser::tokenId - stringtok - - - Renvoie l'identifiant du jeton nommé. - - - - - &reftitle.parameters; - - - tok - - - Le nom utilisé dans Parle\Parser::token. - - - - - - - - &reftitle.returnvalues; - - Renvoie un &integer; représentant l'identifiant du jeton. - - - - - - - diff --git a/reference/parle/parle/parser/trace.xml b/reference/parle/parle/parser/trace.xml deleted file mode 100644 index 3636c214ba..0000000000 --- a/reference/parle/parle/parser/trace.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Parser::trace - Trace l'opération de l'analyseur - - - - &reftitle.description; - - public stringParle\Parser::trace - - - - Récupère la description de l'opération de l'analyseur en cours. Cela peut être particulièrement utile pour étudier l'analyseur et optimiser la grammaire. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un &string; avec les informations de trace. - - - - - - - diff --git a/reference/parle/parle/parser/validate.xml b/reference/parle/parle/parser/validate.xml deleted file mode 100644 index 9b32933af6..0000000000 --- a/reference/parle/parle/parser/validate.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\Parser::validate - Valide une entrée - - - - &reftitle.description; - - public boolParle\Parser::validate - stringdata - Parle\Lexerlexer - - - Valide une chaîne d'entrée. La chaîne est analysée en interne, donc cette méthode est utile pour la validation rapide de l'entrée. - - - - - &reftitle.parameters; - - - data - - - La chaîne à valider. - - - - - lexer - - - Un objet lexer contenant les règles d'analyses lexicales préparées pour la grammaire particulière. - - - - - - - - &reftitle.returnvalues; - - Renvoie un &boolean; indiquant si l'entrée respecte ou non les règles définies. - - - - - - - diff --git a/reference/parle/parle/rlexer/advance.xml b/reference/parle/parle/rlexer/advance.xml deleted file mode 100644 index c280f13021..0000000000 --- a/reference/parle/parle/rlexer/advance.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Parle\RLexer::advance - Traite la règle suivante de l'analyseur - - - - &reftitle.description; - - public voidParle\RLexer::advance - - - - Traite la règle suivante de l'analyseur et prépare les données du jeton résultant. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/build.xml b/reference/parle/parle/rlexer/build.xml deleted file mode 100644 index 274a04f07b..0000000000 --- a/reference/parle/parle/rlexer/build.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RLexer::build - Finalise le jeu de règles du lexer - - - - &reftitle.description; - - public voidParle\RLexer::build - - - - Les règles précédemment ajoutées avec Parle\RLexer::push sont finalisées. Cet appel de méthode doit être fait après que toutes les règles nécessaires aient été ajoutées. Le jeu de règles devient en lecture seule. L'analyse lexicale peut commencer. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/callout.xml b/reference/parle/parle/rlexer/callout.xml deleted file mode 100644 index f4f072c297..0000000000 --- a/reference/parle/parle/rlexer/callout.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\RLexer::callout - Définit une fonction de rappel de jeton - - - - &reftitle.description; - - public voidParle\RLexer::callout - intid - callablecallback - - - Définit une fonction de rappel à invoquer une fois que le lexer rencontre un jeton particulier. - - - - - &reftitle.parameters; - - - id - - - L'identifiant du jeton. - - - - - callback - - - La fonction de rappel à invoquer. La fonction de rappel ne reçoit aucun argument et sa valeur de retour est ignorée. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/consume.xml b/reference/parle/parle/rlexer/consume.xml deleted file mode 100644 index d5b408fa9d..0000000000 --- a/reference/parle/parle/rlexer/consume.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RLexer::consume - Passe les données pour traitement - - - - &reftitle.description; - - public voidParle\RLexer::consume - stringdata - - - Consomme les données pour l'analyse lexicale. - - - - - &reftitle.parameters; - - - data - - - Les données à analyser. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/dump.xml b/reference/parle/parle/rlexer/dump.xml deleted file mode 100644 index dd40d537cf..0000000000 --- a/reference/parle/parle/rlexer/dump.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RLexer::dump - Affiche la machine d'état - - - - &reftitle.description; - - public voidParle\RLexer::dump - - - - Affiche la machine d'état actuelle sur la sortie standard. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/gettoken.xml b/reference/parle/parle/rlexer/gettoken.xml deleted file mode 100644 index 3575b7cdfc..0000000000 --- a/reference/parle/parle/rlexer/gettoken.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RLexer::getToken - Renvoie le jeton actuel - - - - &reftitle.description; - - public Parle\TokenParle\RLexer::getToken - - - - Renvoie le jeton actuel. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une instance de Parle\Token. - - - - - - - diff --git a/reference/parle/parle/rlexer/insertmacro.xml b/reference/parle/parle/rlexer/insertmacro.xml deleted file mode 100644 index 53920e05af..0000000000 --- a/reference/parle/parle/rlexer/insertmacro.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\RLexer::insertMacro - Insère une macro regex - - - - &reftitle.description; - - public voidParle\RLexer::insertMacro - stringname - stringregex - - - Insère une macro regex, qui peut être utilisée plus tard comme un raccourci et incluse dans d'autres expressions régulières. - - - - - &reftitle.parameters; - - - name - - - Le nom de la macro. - - - - - regex - - - L'expression régulière. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/push.xml b/reference/parle/parle/rlexer/push.xml deleted file mode 100644 index fc08d7d008..0000000000 --- a/reference/parle/parle/rlexer/push.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Parle\RLexer::push - Ajoute une règle d'analyse - - - - &reftitle.description; - - public voidParle\RLexer::push - stringregex - intid - - - - public voidParle\RLexer::push - stringstate - stringregex - intid - stringnewState - - - - public voidParle\RLexer::push - stringstate - stringregex - stringnewState - - - Ajoute un modèle pour la reconnaissance des lexèmes. - - - Un 'état de début' (start state) et un 'état de sortie' (exit state) peuvent être spécifiés en utilisant une signature appropriée. - - - - - &reftitle.parameters; - - - regex - - - Expression régulière utilisée pour la reconnaissance des lexèmes. - - - - - id - - - L'identifiant du jeton. Si l'instance de l'analyseur lexical est destinée à être utilisée seule, il peut s'agir d'un nombre arbitraire. Si l'instance de l'analyseur lexical doit être passée à l'analyseur, il doit s'agir d'un identifiant retourné par Parle\RParser::tokenid. - - - - - state - - - Nom de l'état. Si '*' est utilisé comme état de départ, alors la règle est appliquée à tous les états de l'analyseur lexical. - - - - - newState - - - Le nouveau nom de l'état, après l'application de la règle. - - - Si '.' est spécifié comme état de sortie, alors l'état du lexer n'est pas modifié lorsque cette règle correspond. Un état de sortie avec '>' avant le nom signifie pousser. Utiliser la signature sans id pour soit la continuation ou pour commencer la correspondance, quand une continuation ou une récursion est requise. - - - Si '<' est spécifié comme état de sortie, cela signifie pop. Dans ce cas, la signature contenant l'id peut être utilisée pour identifier la correspondance. Il est à noter que même dans le cas où un id est spécifié, la règle se terminera d'abord lorsque tous les poussées précédentes auront été enlevées. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/pushstate.xml b/reference/parle/parle/rlexer/pushstate.xml deleted file mode 100644 index eaa9682312..0000000000 --- a/reference/parle/parle/rlexer/pushstate.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RLexer::pushState - Pousse un nouvel état de départ - - - - &reftitle.description; - - public intParle\RLexer::pushState - stringstate - - - Cet analyseur lexical peut avoir plus d'une machine à états. Cela permet d'analyser des jetons différents en fonction du contexte, permettant ainsi de réaliser une analyse syntaxique simple. Une fois un état poussé, il peut être utilisé avec une variante de signature Parle\RLexer::push appropriée. - - - - - &reftitle.parameters; - - - state - - - Le nom de l'état. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/parle/parle/rlexer/reset.xml b/reference/parle/parle/rlexer/reset.xml deleted file mode 100644 index b77aa85f88..0000000000 --- a/reference/parle/parle/rlexer/reset.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RLexer::reset - Réinitialise l'analyseur lexical - - - - &reftitle.description; - - public voidParle\RLexer::reset - intpos - - - Réinitialise l'analyseur lexical en passant optionnellement la position désirée. - - - - - &reftitle.parameters; - - - pos - - - La position pour réinitialiser. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/advance.xml b/reference/parle/parle/rparser/advance.xml deleted file mode 100644 index 62c5fcc285..0000000000 --- a/reference/parle/parle/rparser/advance.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RParser::advance - Traite la règle suivante de l'analyseur - - - - &reftitle.description; - - public voidParle\RParser::advance - - - - Traite la règle suivante de l'analyseur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/build.xml b/reference/parle/parle/rparser/build.xml deleted file mode 100644 index fd4185dbfd..0000000000 --- a/reference/parle/parle/rparser/build.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RParser::build - Finalise les règles de grammaire - - - - &reftitle.description; - - public voidParle\RParser::build - - - - Chaque jeton et règle de grammaire précédemment ajoutés sont finalisés. L'ensemble de règles devient en lecture seule et l'analyseur est prêt à démarrer. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/consume.xml b/reference/parle/parle/rparser/consume.xml deleted file mode 100644 index 5bc9641fc6..0000000000 --- a/reference/parle/parle/rparser/consume.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\RParser::consume - Consomme les données pour le traitement - - - - &reftitle.description; - - public voidParle\RParser::consume - stringdata - Parle\RLexerrlexer - - - Consomme les données pour le traitement. - - - - - &reftitle.parameters; - - - data - - - Les données à analyser. - - - - - lexer - - - Un objet lexer contenant les règles d'analyses lexicales préparées pour la grammaire particulière. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/dump.xml b/reference/parle/parle/rparser/dump.xml deleted file mode 100644 index 7fd27bbef6..0000000000 --- a/reference/parle/parle/rparser/dump.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RParser::dump - Affiche la grammaire - - - - &reftitle.description; - - public voidParle\RParser::dump - - - - Affiche la grammaire actuelle sur la sortie standard. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/errorinfo.xml b/reference/parle/parle/rparser/errorinfo.xml deleted file mode 100644 index 77909236c0..0000000000 --- a/reference/parle/parle/rparser/errorinfo.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RParser::errorInfo - Récupère les informations d'erreur - - - - &reftitle.description; - - public Parle\ErrorInfoParle\RParser::errorInfo - - - - Récupère les informations d'erreur dans le cas où Parle\RParser::action aurait retourné l'action d'erreur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une instance de Parle\ErrorInfo. - - - - - - - diff --git a/reference/parle/parle/rparser/left.xml b/reference/parle/parle/rparser/left.xml deleted file mode 100644 index 6414ca4391..0000000000 --- a/reference/parle/parle/rparser/left.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::left - Déclare un jeton avec une associativité à gauche - - - - &reftitle.description; - - public voidParle\RParser::left - stringtok - - - Déclare un jeton avec une associativité à gauche. - - - - - &reftitle.parameters; - - - tok - - - Le nom du jeton. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/nonassoc.xml b/reference/parle/parle/rparser/nonassoc.xml deleted file mode 100644 index 34a666f23b..0000000000 --- a/reference/parle/parle/rparser/nonassoc.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::nonassoc - Déclare un jeton sans associativité - - - - &reftitle.description; - - public voidParle\RParser::nonassoc - stringtok - - - Déclare un jeton, qui ne peut apparaître qu'une seule fois dans la ligne. - - - - - &reftitle.parameters; - - - tok - - - Le nom du jeton. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/precedence.xml b/reference/parle/parle/rparser/precedence.xml deleted file mode 100644 index a70b753858..0000000000 --- a/reference/parle/parle/rparser/precedence.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::precedence - Déclare une règle de précédence - - - - &reftitle.description; - - public voidParle\RParser::precedence - stringtok - - - Déclare une règle de précédence pour un jeton fictif. Cette règle peut être utilisée plus tard dans les règles de grammaire spécifiques. - - - - - &reftitle.parameters; - - - tok - - - Le jeton fictif. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/push.xml b/reference/parle/parle/rparser/push.xml deleted file mode 100644 index 6e0a3f1789..0000000000 --- a/reference/parle/parle/rparser/push.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\RParser::push - Ajoute une règle de grammaire - - - - &reftitle.description; - - public intParle\RParser::push - stringname - stringrule - - - Ajoute une règle de grammaire. L'identifiant de production retourné peut être utilisé plus tard dans le processus d'analyse pour identifier la règle correspondante. - - - - - &reftitle.parameters; - - - name - - - Le nom de la règle. - - - - - rule - - - La règle à ajouter. La syntaxe est compatible avec Bison. - - - - - - - - &reftitle.returnvalues; - - Renvoie un &integer; représentant l'index de la règle. - - - - - - - diff --git a/reference/parle/parle/rparser/reset.xml b/reference/parle/parle/rparser/reset.xml deleted file mode 100644 index 1bb5cf1906..0000000000 --- a/reference/parle/parle/rparser/reset.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::reset - Réinitialise l'état de l'analyseur - - - - &reftitle.description; - - public voidParle\RParser::reset - inttokenId - - - Réinitialise l'état de l'analyseur en utilisant l'identifiant de jeton donné. - - - - - &reftitle.parameters; - - - tokenId - - - L'identifiant du jeton. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/right.xml b/reference/parle/parle/rparser/right.xml deleted file mode 100644 index 18b5fde142..0000000000 --- a/reference/parle/parle/rparser/right.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::right - Déclare un jeton avec une associativité à droite - - - - &reftitle.description; - - public voidParle\RParser::right - stringtok - - - Déclare un jeton avec une associativité à droite. - - - - - &reftitle.parameters; - - - tok - - - Le nom du jeton. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/sigil.xml b/reference/parle/parle/rparser/sigil.xml deleted file mode 100644 index e4200e4b4a..0000000000 --- a/reference/parle/parle/rparser/sigil.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::sigil - Récupère une partie correspondante d'une règle - - - - &reftitle.description; - - public stringParle\RParser::sigil - intidx - - - Récupère une partie correspondante d'une règle. Cette méthode est équivalente à la fonctionnalité de pseudo-variable dans Bison. - - - - - &reftitle.parameters; - - - idx - - - L'identifiant de correspondance, basé sur zéro. - - - - - - - - &reftitle.returnvalues; - - Renvoie une &string; avec la partie correspondante. - - - - - - - diff --git a/reference/parle/parle/rparser/sigilcount.xml b/reference/parle/parle/rparser/sigilcount.xml deleted file mode 100644 index 91bb083fdc..0000000000 --- a/reference/parle/parle/rparser/sigilcount.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RParser::sigilCount - Nombre d'éléments dans la règle correspondante - - - - &reftitle.description; - - public intParle\RParser::sigilCount - - - - Renvoie le nombre d'éléments dans la règle correspondante. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un &integer; - - - - - - - diff --git a/reference/parle/parle/rparser/sigilname.xml b/reference/parle/parle/rparser/sigilname.xml deleted file mode 100644 index 8d2f8ccbcc..0000000000 --- a/reference/parle/parle/rparser/sigilname.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::sigilName - Récupère un nom de règle ou de jeton - - - - &reftitle.description; - - public stringParle\RParser::sigilName - intidx - - - Récupère un nom de règle partiel ou de jeton correspondant à l'index de sigil. - - - - - &reftitle.parameters; - - - idx - - - L'identifiant de correspondance, basé sur zéro. - - - - - - - - &reftitle.returnvalues; - - Renvoie une &string; avec la partie correspondante. - - - - - - - diff --git a/reference/parle/parle/rparser/token.xml b/reference/parle/parle/rparser/token.xml deleted file mode 100644 index c01c283bb8..0000000000 --- a/reference/parle/parle/rparser/token.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::token - Déclare un jeton - - - - &reftitle.description; - - public voidParle\RParser::token - stringtok - - - Déclare un jeton à utiliser dans la grammaire. - - - - - &reftitle.parameters; - - - tok - - - Le nom du jeton. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/tokenid.xml b/reference/parle/parle/rparser/tokenid.xml deleted file mode 100644 index 6130cdc83f..0000000000 --- a/reference/parle/parle/rparser/tokenid.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::tokenId - Renvoie l'identifiant du jeton - - - - &reftitle.description; - - public intParle\RParser::tokenId - stringtok - - - Renvoie l'identifiant du jeton nommé. - - - - - &reftitle.parameters; - - - tok - - - Le nom utilisé dans Parle\RParser::token. - - - - - - - - &reftitle.returnvalues; - - Renvoie un &integer; représentant l'identifiant du jeton. - - - - - - - diff --git a/reference/parle/parle/rparser/trace.xml b/reference/parle/parle/rparser/trace.xml deleted file mode 100644 index 0d9d664c16..0000000000 --- a/reference/parle/parle/rparser/trace.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RParser::trace - Trace l'opération de l'analyseur - - - - &reftitle.description; - - public stringParle\RParser::trace - - - - Récupère la description de l'opération de l'analyseur en cours. Cela peut être particulièrement utile pour étudier l'analyseur et optimiser la grammaire. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un &string; avec les informations de trace. - - - - - - - diff --git a/reference/parle/parle/rparser/validate.xml b/reference/parle/parle/rparser/validate.xml deleted file mode 100644 index e331329a8c..0000000000 --- a/reference/parle/parle/rparser/validate.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\RParser::validate - Valide une entrée - - - - &reftitle.description; - - public boolParle\RParser::validate - stringdata - Parle\RLexerlexer - - - Valide une chaîne d'entrée. La chaîne est analysée en interne, donc cette méthode est utile pour la validation rapide de l'entrée. - - - - - &reftitle.parameters; - - - data - - - La chaîne à valider. - - - - - lexer - - - Un objet lexer contenant les règles d'analyses lexicales préparées pour la grammaire particulière. - - - - - - - - &reftitle.returnvalues; - - Renvoie un &boolean; indiquant si l'entrée respecte ou non les règles définies. - - - - - - - diff --git a/reference/parle/parle/stack/pop.xml b/reference/parle/parle/stack/pop.xml deleted file mode 100644 index 31b44b7079..0000000000 --- a/reference/parle/parle/stack/pop.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Stack::pop - Sort un élément de la pile - - - - &reftitle.description; - - public voidParle\Stack::pop - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/stack/push.xml b/reference/parle/parle/stack/push.xml deleted file mode 100644 index 7d90b0b75e..0000000000 --- a/reference/parle/parle/stack/push.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Stack::push - Ajoute un élément à la pile - - - - &reftitle.description; - - public voidParle\Stack::push - mixeditem - - - - - - - - &reftitle.parameters; - - - item - - - La variable à ajouter. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/pattern.matching.xml b/reference/parle/pattern.matching.xml deleted file mode 100644 index 438bab5744..0000000000 --- a/reference/parle/pattern.matching.xml +++ /dev/null @@ -1,412 +0,0 @@ - - - - - Correspondance de motif Parle - Correspondance de motif - - Parle supporte la correspondance de motif avec des expressions régulières similaires à flex. - Les ensembles de caractères POSIX suivants sont également supportés : - - [:alnum:] - [:alpha:] - [:blank:] - [:cntrl:] - [:digit:] - [:graph:] - [:lower:] - [:print:] - [:punct:] - [:space:] - [:upper:] - [:xdigit:] - . - - - Les classes de caractères Unicode ne sont actuellement pas activées par défaut, passer --enable-parle-utf32 pour les rendre disponibles. - Un encodage particulier peut être mappé avec une regex correctement construite. - Par exemple, pour correspondre au symbole EURO encodé en UTF-8, l'expression régulière [\xe2][\x82][\xac] peut être utilisée. - Le motif pour une chaîne encodée en UTF-8 pourrait être [ -\x7f]{+}[\x80-\xbf]{+}[\xc2-\xdf]{+}[\xe0-\xef]{+}[\xf0-\xff]+. - - -
    - Représentation des caractères - - - Représentation des caractères - - - - SéquenceDescription - - - - - \aAlerte (cloche). - - - \bRetour arrière (Backspace). - - - \eCaractère ESC, \x1b. - - - \nNouvelle ligne. - - - \rRetour chariot. - - - \fSaut de page, \x0c. - - - \tTabulation horizontale, \x09. - - - \vTabulation verticale, \x0b. - - - \octCaractère spécifié par un code octal à trois chiffres. - - - \xhexCaractère spécifié par un code hexadécimal. - - - \ccharCaractère de contrôle nommé. - - - -
    -     -
    -
    - Classes de caractères - - - Classes de caractères - - - - SequenceDescription - - - - - [...]Un seul caractère listé ou contenu dans une plage listée. Les plages peuvent être combinées avec les opérateurs {+} et {-}. Par exemple [a-z]{+}[0-9] est la même chose que [0-9a-z] et [a-z]{-}[aeiou] est la même chose que [b-df-hj-np-tv-z]. - - - [^...]Un seul caractère non listé et non contenu dans une plage listée. - - - .N'importe quel caractère, par défaut [^\n]. - - - \dCaractère numérique, [0-9]. - - - \DCaractère non numérique, [^0-9]. - - - \sCaractère d'espace blanc, [ \t\n\r\f\v]. - - - \SCaractère non d'espace blanc, [^ \t\n\r\f\v]. - - - \wCaractère de mot, [a-zA-Z0-9_]. - - - \WCaractère de non mot, [^a-zA-Z0-9_]. - - - -
    -     -
    -
    - Classes de caractères Unicode - - - Classes de caractères Unicode - - - - SequenceDescription - - - - - \p{C}Autre. - - - \p{Cc}Autre, contrôle. - - - \p{Cf}Autre, format. - - - \p{Co}Autre, utilisation privée. - - - \p{Cs}Autre, substitut. - - - \p{L}Lettre. - - - \p{LC}Lettre, casée. - - - \p{Ll}Lettre, minuscule. - - - \p{Lm}Lettre, modifiée. - - - \p{Lo}Lettre, autre. - - - \p{Lt}Lettre, de titre. - - - \p{Lu}Lettre, majuscule. - - - \p{M}Marque. - - - \p{Mc}Marque, espace combiné. - - - \p{Me}Marque, encadrant. - - - \p{Mn}Marque, non espacé. - - - \p{N}Nombre. - - - \p{Nd}Nombre, chiffre décimal. - - - \p{Nl}Nombre, lettre. - - - \p{No}Nombre, autre. - - - \p{P}Ponctuation. - - - \p{Pc}Ponctuation, connecteur. - - - \p{Pd}Ponctuation, tiret. - - - \p{Pe}Ponctuation, fermeture. - - - \p{Pf}Ponctuation, guillemet final. - - - \p{Pi}Ponctuation, guillemet initial. - - - \p{Po}Ponctuation, autre. - - - \p{Ps}Ponctuation, ouverture. - - - \p{S}Symbole. - - - \p{Sc}Symbole, devise. - - - \p{Sk}Symbole, modifié. - - - \p{Sm}Symbole, math. - - - \p{So}Symbole, autre. - - - \p{Z}Séparateur. - - - \p{Zl}Séparateur, ligne. - - - \p{Zp}Séparateur, paragraphe. - - - \p{Zs}Séparateur, espace. - - - -
    -     - - Ces classes de caractères ne sont disponibles que si l'option --enable-parle-utf32 a été passée lors de la compilation. - -
    -
    - Alternance et répétition - - - Alternance et répétition - - - - SequenceGreedyDescription - - - - - ...|...-Essayer les sous-motifs en alternance. - - - *yesCorrespond 0 ou plusieurs fois. - - - +yesCorrespond 1 ou plusieurs fois. - - - ?yesCorrespond 0 ou 1 fois. - - - {n}noCorrespond exactement n fois. - - - {n,}noCorrespond au moins n fois. - - - {n,m}yesCorrespond au moins n fois mais pas plus de m fois. - - - *?noCorrespond 0 ou plusieurs fois. - - - +?noCorrespond 1 ou plusieurs fois. - - - ??noCorrespond 0 ou 1 fois. - - - {n,}?noCorrespond au moins n fois. - - - {n,m}?noCorrespond au moins n fois mais pas plus de m fois. - - - {MACRO}-Inclut la regex MACRO dans la regex courante. - - - -
    -     -
    -
    - Ancre - - - Ancre - - - - SequenceDescription - - - - - ^Commence par une chaîne ou après un retour à la ligne. - - - $Finit par une chaîne ou avant un retour à la ligne. - - - -
    -     -
    -
    - Regroupement - - - Regroupement - - - - Sequence - Description - - - - - (...) - Regroupe une expression régulière pour modifier l'ordre d'évaluation. - - - (?r-s:pattern) - - - Applique l'option r et omet l'option s lors de l'interprétation du motif. - Les options peuvent être zéro ou plusieurs des caractères i, s ou x. - - - i signifie insensible à la casse. - - - -i signifie sensible à la casse. - - - s modifie le sens de . pour correspondre à n'importe quel caractère. - - - -s modifie le sens de . pour correspondre à n'importe quel caractère sauf \n. - - - x ignore les commentaires et les espaces dans les motifs. - Les espaces sont ignorés sauf s'ils sont échappés par un backslash, contenus dans des ""s, - ou apparaissent à l'intérieur d'une plage de caractères. - - - Ces options peuvent être appliquées globalement au niveau des règles en passant une combinaison des indicateurs de bits à l'analyseur lexical. - - - - - (?# comment ) - Omet tout ce qui est dans (). Le premier caractère ) rencontré termine le motif. Il n'est pas possible pour le commentaire de contenir un caractère ). Le commentaire peut s'étendre sur plusieurs lignes. - - - -
    -     -
    -     - - diff --git a/reference/parle/setup.xml b/reference/parle/setup.xml deleted file mode 100644 index e8236f38b5..0000000000 --- a/reference/parle/setup.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - PHP 7.4 ou supérieur est supporté. - Un compilateur C++14 est nécessaire. Une compilation avec succès de l'extension - a été réalisée avec, au moins clang 5.0, GCC 5.0 et Visual Studio 2015. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;parle. - - - - Options de configuration disponibles - - - - OptionDescription - - - - - --enable-parleActivation de l'extension parle. - - - --enable-parle-utf32Activation du support interne UTF-32. Disponible depuis parle 0.7.2. - - - -
    -     -
    - - - -     - - diff --git a/reference/pdo_cubrid/configure.xml b/reference/pdo_cubrid/configure.xml deleted file mode 100644 index dc888234ce..0000000000 --- a/reference/pdo_cubrid/configure.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - -
    - &reftitle.install; - - Pour construire l'extension PDO_CUBRID, CUBRID DBMS doit être installé - sur le même système que PHP. - - PDO_CUBRID est une extension &link.pecl;, - aussi, il faut suivre les instructions de pour - installer l'extension PDO_CUBRID. Lancez la commande configure - pour localiser le dossier de base de CUBRID comme ceci : - - - - La commande configure prendra par défaut la valeur de la - variable d'environnement CUBRID. - - - &pecl.windows.download; - Des informations sur l'installation manuelle sous Linux et Windows peuvent - être trouvées dans le fichier build-guide.html du paquet CUBRID de PECL. - -
    - diff --git a/reference/pdo_cubrid/constants.xml b/reference/pdo_cubrid/constants.xml deleted file mode 100644 index 848ca41db4..0000000000 --- a/reference/pdo_cubrid/constants.xml +++ /dev/null @@ -1,223 +0,0 @@ - - - - - -
    - &reftitle.constants; - &pdo.driver-constants; - - Les constantes suivantes peuvent être utilisées pour configurer les attributs - de la base de données. Elles peuvent être passées à la méthode - PDO::getAttribute ou à la méthode - PDO::setAttribute. - - Drapeaux pour les attributs PDO::CUBRID - - - - Constante - Description - - - - - PDO::CUBRID_ATTR_ISOLATION_LEVEL - Le niveau d'isolation de la transaction pour la connexion à la base de données. - - - PDO::CUBRID_ATTR_LOCK_TIMEOUT - Délai d'expiration de la transaction en secondes. - - - PDO::CUBRID_ATTR_MAX_STRING_LENGTH - Lecture seule. La longueur maximale de la chaîne pour les - types de données bit, varbit, char, varchar, nchar, nchar - lors de l'utilisation de l'API CUBRID PDO. - - - -
    -     - - - Les constantes suivantes peuvent être utilisées lors de la configuration - du niveau d'isolation de la transaction. Elles peuvent être passées à la - méthode PDO::getAttribute ou à la méthode - PDO::setAttribute. - - Drapeaux pour le niveau d'isolation PDO::CUBRID - - - - Constante - Description - - - - - PDO::TRAN_COMMIT_CLASS_UNCOMMIT_INSTANCE - Le niveau d'isolation le moins élevé (1). Une lecture - sale, non reproductible ou fantôme peut survenir sur - le tuple, mais aussi une lecture non reproductible peut - survenir pour la table. - - - PDO::TRAN_COMMIT_CLASS_COMMIT_INSTANCE - Un niveau d'isolation relativement bas (2). Une lecture - sale ne peut pas survenir, par contre, une lecture - non reproductible ou fantôme peut survenir. - - - PDO::TRAN_REP_CLASS_UNCOMMIT_INSTANCE - Le niveau d'isolation par défaut pour CUBRID (3). - Une lecture sale ou fantôme peut survenir sur le tuple, - mais la reproductibilité de la lecture est assurée sur la table. - - - PDO::TRAN_REP_CLASS_COMMIT_INSTANCE - Un niveau d'isolation relativement bas (4). Une lecture - sale ne peut survenir, mais les lectures non reproductibles - ou fantôme le peuvent. - - - PDO::TRAN_REP_CLASS_REP_INSTANCE - Un niveau d'isolation relativement haut (5). Les - lectures sales ou non reproductibles ne peuvent pas - survenir, mais une lecture fantôme est possible. - - - PDO::TRAN_SERIALIZABLE - Le plus haut niveau d'isolation (6). Les problèmes - relatifs à la concurrence (c.-à-d. lecture sale, lecture - non reproductible, lecture fantôme, etc.) ne peuvent survenir. - - - -
    -     - - - Les constantes suivantes peuvent être utilisées pour récupérer - les informations sur le schéma. Elles peuvent être passées - à la fonction PDO::cubrid_schema. - - Drapeaux pour le schéma CUBRID - - - - Constante - Description - - - - - PDO::CUBRID_SCH_TABLE - Récupère le nom et le type de table CUBRID. - - - PDO::CUBRID_SCH_VIEW - Récupère le nom et le type de vue dans CUBRID. - - - PDO::CUBRID_SCH_QUERY_SPEC - Récupère la définition de la requête de la vue. - - - PDO::CUBRID_SCH_ATTRIBUTE - Récupère les attributs de la colonne de la table. - - - PDO::CUBRID_SCH_TABLE_ATTRIBUTE - Récupère les attributs de la table. - - - PDO::CUBRID_SCH_METHOD - Récupère la méthode de l'instance. C'est une méthode appelée - par l'instance de la classe. Elle est utilisée plus souvent que la - méthode de la classe car la plupart des opérations sont exécutées - dans l'instance. - - - PDO::CUBRID_SCH_TABLE_METHOD - Récupère la méthode de la classe. C'est une méthode appelée - par un objet de la classe. Elle est habituellement utilisée - pour créer une nouvelle instance de la classe ou pour l'initialiser. - Elle est également utilisée pour accéder ou mettre à jour les attributs - de la classe. - - - PDO::CUBRID_SCH_METHOD_FILE - Récupère les informations sur le fichier où la méthode de la table - est définie. - - - PDO::CUBRID_SCH_SUPER_TABLE - Récupère le nom et le type de la table dont les attributs héritent. - - - PDO::CUBRID_SCH_SUB_TABLE - Récupère le nom et le type de la table qui hérite des attributs de cette table. - - - PDO::CUBRID_SCH_CONSTRAINT - Récupère les contraintes de la table. - - - PDO::CUBRID_SCH_TRIGGER - Récupère les triggers de la table. - - - PDO::CUBRID_SCH_TABLE_PRIVILEGE - Récupère les informations sur les privilèges de la table. - - - PDO::CUBRID_SCH_COL_PRIVILEGE - Récupère les informations sur les privilèges d'une colonne. - - - PDO::CUBRID_SCH_DIRECT_SUPER_TABLE - Récupère la table directement supérieure à la table. - - - PDO::CUBRID_SCH_PRIMARY_KEY - Récupère la clé primaire de la table. - - - PDO::CUBRID_SCH_IMPORTED_KEYS - Récupère les clés importées d'une table. - - - PDO::CUBRID_SCH_EXPORTED_KEYS - Récupère les clés exportées d'une table. - - - PDO::CUBRID_SCH_CROSS_REFERENCE - Récupère les relations de référence entre 2 tables. - - - -
    -     -
    - - diff --git a/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml b/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml deleted file mode 100644 index 6d05ee2637..0000000000 --- a/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml +++ /dev/null @@ -1,550 +0,0 @@ - - - - - - - PDO::cubrid_schema - Récupère le schéma d'informations demandé - - - &reftitle.description; - - public arrayPDO::cubrid_schema - intschema_type - stringtable_name - stringcol_name - - - Cette fonction est utilisée pour récupérer le schéma d'informations demandé depuis - la base de données. - Il faut désigner le paramètre table_name, - pour récupérer les informations d'une certaine table, le - paramètre col_name, pour récupérer les informations - d'une certaine colonne (ne peut être utilisé qu'avec - PDO::CUBRID_SCH_COL_PRIVILEGE). - - - - Le résultat de cette fonction est retourné sous la forme d'un tableau - à 2 dimensions (colonne(tableau associatif) * ligne (tableau numérique)). - Les tables suivantes montrent les types de schéma et la structure de la colonne - du tableau résultant. - - - - Composition du résultat pour chaque type - - - - Schéma - Numéro de la colonne - Nom de la colonne - Valeur - - - - - PDO::CUBRID_SCH_TABLE - 1 - NAME - - - - - 2 - TYPE - 0:system table 1:view 2:table - - - - PDO::CUBRID_SCH_VIEW - 1 - NAME - - - - - 2 - TYPE - 1:view - - - - PDO::CUBRID_SCH_QUERY_SPEC - 1 - QUERY_SPEC - - - - - PDO::CUBRID_SCH_ATTRIBUTE / PDO::CUBRID_SCH_TABLE_ATTRIBUTE - 1 - ATTR_NAME - - - - - 2 - DOMAIN - - - - - 3 - SCALE - - - - - 4 - PRECISION - - - - - 5 - INDEXED - 1:indexed - - - - 6 - NOT NULL - 1:not null - - - - 7 - SHARED - 1:shared - - - - 8 - UNIQUE - 1:unique - - - - 9 - DEFAULT - - - - - 10 - ATTR_ORDER - base:1 - - - - 11 - CLASS_NAME - - - - - 12 - SOURCE_CLASS - - - - - 13 - IS_KEY - 1:key - - - - PDO::CUBRID_SCH_METHOD / PDO::CUBRID_SCH_TABLE_METHOD - 1 - NAME - - - - - 2 - RET_DOMAIN - - - - - 3 - ARG_DOMAIN - - - - - PDO::CUBRID_SCH_METHOD_FILE - 1 - METHOD_FILE - - - - - PDO::CUBRID_SCH_SUPER_TABLE / PDO::CUBRID_SCH_DIRECT_SUPER_TABLE / PDO::CUBRID_SCH_SUB_TABLE - 1 - CLASS_NAME - - - - - 2 - TYPE - 0:system table 1:view 2:table - - - - PDO::CUBRID_SCH_CONSTRAINT - 1 - TYPE - 0:unique 1:index 2:reverse unique 3:reverse index - - - - 2 - NAME - - - - - 3 - ATTR_NAME - - - - - 4 - NUM_PAGES - - - - - 5 - NUM_KEYS - - - - - 6 - PRIMARY_KEY - 1:primary key - - - - 7 - KEY_ORDER - base:1 - - - - PDO::CUBRID_SCH_TRIGGER - 1 - NAME - - - - - 2 - STATUS - - - - - 3 - EVENT - - - - - 4 - TARGET_CLASS - - - - - 5 - TARGET_ATTR - - - - - 6 - ACTION_TIME - - - - - 7 - ACTION - - - - - 8 - PRIORITY - - - - - 9 - CONDITION_TIME - - - - - 10 - CONDITION - - - - - PDO::CUBRID_SCH_TABLE_PRIVILEGE / PDO::CUBRID_SCH_COL_PRIVILEGE - 1 - CLASS_NAME / ATTR_NAME - - - - - 2 - PRIVILEGE - - - - - 3 - GRANTABLE - - - - - PDO::CUBRID_SCH_PRIMARY_KEY - 1 - CLASS_NAME - - - - - 2 - ATTR_NAME - - - - - 3 - KEY_SEQ - base:1 - - - - 4 - KEY_NAME - - - - - PDO::CUBRID_SCH_IMPORTED_KEYS / PDO::CUBRID_SCH_EXPORTED_KEYS / PDO::CUBRID_SCH_CROSS_REFERENCE - 1 - PKTABLE_NAME - - - - - 2 - PKCOLUMN_NAME - - - - - 3 - FKTABLE_NAME - base:1 - - - - 4 - FKCOLUMN_NAME - - - - - 5 - KEY_SEQ - base:1 - - - - 6 - UPDATE_ACTION - 0:cascade 1:restrict 2:no action 3:set null - - - - 7 - DELETE_ACTION - 0:cascade 1:restrict 2:no action 3:set null - - - - 8 - FK_NAME - - - - - 9 - PK_NAME - - - - -
    - -     - - &reftitle.parameters; - - - schema_type - - - Le type du schéma que l'on souhaite récupérer. - - - - - table_name - - - La table dont on souhaite récupérer le schéma. - - - - - col_name - - - La colonne dont on souhaite récupérer le schéma. - - - - - - - - &reftitle.returnvalues; - - Un tableau contenant les informations relatives au schéma, lorsque le - processus s'est exécuté avec succès. - - - &false; sera retourné si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>PDO::cubrid_schema</function> - - Cet exemple montre la façon dont on récupère les clés primaires et étrangères - de la table "game". - - -cubrid_schema(PDO::CUBRID_SCH_PRIMARY_KEY, "game"); -print_r($pk_list); - -$fk_list = $dbh->cubrid_schema(PDO::CUBRID_SCH_IMPORTED_KEYS, "game"); -print_r($fk_list); -?> -]]> - - &example.outputs; - - Array - ( - [CLASS_NAME] => game - [ATTR_NAME] => athlete_code - [KEY_SEQ] => 3 - [KEY_NAME] => pk_game_host_year_event_code_athlete_code - ) - - [1] => Array - ( - [CLASS_NAME] => game - [ATTR_NAME] => event_code - [KEY_SEQ] => 2 - [KEY_NAME] => pk_game_host_year_event_code_athlete_code - ) - - [2] => Array - ( - [CLASS_NAME] => game - [ATTR_NAME] => host_year - [KEY_SEQ] => 1 - [KEY_NAME] => pk_game_host_year_event_code_athlete_code - ) - -) -Array -( - [0] => Array - ( - [PKTABLE_NAME] => athlete - [PKCOLUMN_NAME] => code - [FKTABLE_NAME] => game - [FKCOLUMN_NAME] => athlete_code - [KEY_SEQ] => 1 - [UPDATE_RULE] => 1 - [DELETE_RULE] => 1 - [FK_NAME] => fk_game_athlete_code - [PK_NAME] => pk_athlete_code - ) - - [1] => Array - ( - [PKTABLE_NAME] => event - [PKCOLUMN_NAME] => code - [FKTABLE_NAME] => game - [FKCOLUMN_NAME] => event_code - [KEY_SEQ] => 1 - [UPDATE_RULE] => 1 - [DELETE_RULE] => 1 - [FK_NAME] => fk_game_event_code - [PK_NAME] => pk_event_code - ) - -) -]]> - - - - -     - diff --git a/reference/pdo_cubrid/reference.xml b/reference/pdo_cubrid/reference.xml deleted file mode 100644 index bdee82a03d..0000000000 --- a/reference/pdo_cubrid/reference.xml +++ /dev/null @@ -1,335 +0,0 @@ - - - - - Fonctions du pilote PDO CUBRID (PDO_CUBRID) - Pilote PDO CUBRID - - -
    &reftitle.intro; - - PDO_CUBRID est un pilote qui implémente l' - interface PHP Data Objects (PDO) - pour permettre l'accès à partir de PHP aux bases de données CUBRID. - - - La version actuelle de PDO_CUBRID ne prend pas en charge la connexion persistante pour le moment. - -
    - - - &reference.pdo-cubrid.configure; - -
    - Fonctionnalités de PDO_CUBRID - -
    - Curseurs défilables - - PDO_CUBRID prend en charge les curseurs défilables. Le type de curseur par défaut est - forward only, et il est possible d'utiliser le paramètre driver_options dans - PDO::prepare pour changer le type de curseur. - -
    - -
    - Délai d'expiration - - PDO_CUBRID prend en charge le paramétrage du délai d'exécution de l'instruction SQL ; - Il est possible d'utiliser PDO::setAttribute pour définir la valeur du délai d'expiration. - -
    - -
    - Mode autocommit et transaction - - - PDO_CUBRID prend en charge à la fois le mode autocommit et la transaction, et - le mode autocommit est activé par défaut. Il est possible d'utiliser - PDO::setAttribute pour changer son état. - - - - Lors de l'utilisation de PDO::beginTransaction pour commencer une - transaction, cela désactivera automatiquement le mode autocommit et - le restaurera après PDO::commit ou - PDO::rollBack. - - - - - Avant de désactiver le mode autocommit, - tout travail en attente est automatiquement validé. - - -
    - -
    - Instructions SQL multiples - - - PDO_CUBRID prend en charge les instructions SQL multiples. - Les instructions SQL multiples sont séparées par des points-virgules (;). - -
    - -
    - Informations sur le schéma - - - PDO_CUBRID implémente PDO::cubrid_schema - pour obtenir des informations sur le schéma. - -
    - -
    - LOBs - - - PDO_CUBRID prend en charge les types de données BLOB/CLOB. Le LOB dans PDO est - représenté comme un flux, il est possible de donc insérer des LOBs en liant un flux, - et obtenir des LOBs en lisant un flux retourné par CUBRID PDO. - Par exemple : - - - - Insérer des LOBs dans CUBRID PDO - -prepare($sql_stmt); -$ret = $stmt->bindParam(1, $fp, PDO::PARAM_LOB); -$ret = $stmt->execute(); -?> -]]> - - - - - Récupérer des LOBs dans CUBRID PDO - -prepare($sql_stmt); -$stmt->execute(); -$result = $stmt->fetch(PDO::FETCH_NUM); - -header("Content-Type: image/png"); -fpassthru($result[0]); -?> -]]> - - -
    - -
    - Méta-colonne - - - La méthode PDOStatement::getColumnMeta dans CUBRID PDO - renverra un tableau associatif contenant les valeurs suivantes : - - type - name - table - def - precision - scale - not_null - auto_increment - unique_key - multiple_key - primary_key - foreign_key - reverse_index - reverse_unique - - -
    -
    - Type de données Collection - - - PDO_CUBRID prend en charge les types de données SET/MULTISET/SEQUENCE. - Si on ne spécifie pas le type de données, le type de données par défaut est char. - Par exemple : - - - - Insérer un ensemble dans CUBRID PDO avec le type de données par défaut. - -exec("DROP TABLE if exists test_tbl"); -$cubrid_pdo->exec("CREATE TABLE test_tbl (col_1 SET(VARCHAR))"); - -$sql_stmt_insert = "INSERT INTO test_tbl VALUES (?);"; -$stmt = $cubrid_pdo->prepare($sql_stmt_insert); -$data = array("abc","def","ghi"); -$ret = $stmt->bindParam(1, $data, PDO::PARAM_NULL); -$ret = $stmt->execute(); -var_Dump($ret); -?> -]]> - - - - - Spécifier le type de données lors de l'insertion d'un ensemble dans CUBRID PDO - -exec("DROP TABLE if exists test_tbl"); -$cubrid_pdo->exec("CREATE TABLE test_tbl (col_1 SET(int))"); - -$sql_stmt_insert = "INSERT INTO test_tbl VALUES (?);"; -$stmt = $cubrid_pdo->prepare($sql_stmt_insert); -$data = array(1,2,3,4); -$ret = $stmt->bindParam(1, $data, 0,0,"int"); -$ret = $stmt->execute(); -var_Dump($ret); -?> -]]> - - - - - Types de données CUBRID Bind pour le cinquième paramètre de - PDOStatement::bindParam : - - CHAR - STRING - NCHAR - VARNCHAR - BIT - VARBIT - NUMERIC - NUMBER - INT - SHORT - BIGINT - MONETARY - FLOAT - DOUBLE - DATE - TIME - DATETIME - TIMESTAMP - - -
    -
    - - - &reference.pdo-cubrid.constants; - -     - - - - DSN PDO_CUBRID - Connexion aux bases de données CUBRID - - - - &reftitle.description; - - Le DSN PDO_CUBRID est composé des éléments suivants, délimités par un point virgule : - - - préfixe DSN - - - Le préfixe DSN est cubrid:. - - - - - host - - - Le nom d'hôte sur lequel se trouve le serveur de base de données. - - - - - port - - - Le port sur lequel le serveur de base de données fonctionne. - - - - - dbname - - - Le nom de la base de données. - - - - - - - - - &reftitle.notes; - - - Lorsque l'on établit la connexion à CUBRID, il faut fournir le nom de - l'utilisateur et le mot de passe, mais pas le DSN. - - - - - - &reftitle.examples; - - Exemples de DSN PDO_CUBRID - - L'exemple suivant montre un DSN PDO_CUBRID pour une connexion à une base de données CUBRID : - - - - - - - - - &reference.pdo-cubrid.entities.pdo-overloaded; - -     - diff --git a/reference/pdo_ibm/configure.xml b/reference/pdo_ibm/configure.xml deleted file mode 100644 index a5713849b1..0000000000 --- a/reference/pdo_ibm/configure.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - -
    - &reftitle.install; - - Pour compiler l'extension PDO_IBM, le client DB2 v9.1 ou supérieur doit être - installé sur le même système que PHP. Le client DB2 peut être téléchargé - depuis le site d'IBM de développement - d'applications. - - - Note - - Le client DB2 v9.1 ou supérieur supporte les accès directs à DB2 - pour les systèmes Linux, UNIX et les serveurs Windows v8 et v9.1. - - - Le client DB2 v9.1 supporte également les accès à DB2 UDB pour i5 - et DB2 UDB pour les serveurs z/OS en utilisant le - produit de connexion DB2 payant. - - - - PDO_IBM est une extension &link.pecl;; - il faut donc suivre les instructions de - pour installer l'extension PDO_IBM. Exécutez la commande - configure afin qu'elle pointe vers le dossier - contenant les fichiers d'en-têtes et les bibliothèques du - client DB2 comme ceci : - - - - La commande configure utilise par défaut - la valeur de la variable d'environnement DB2DIR. - -
    - - diff --git a/reference/pdo_ibm/ini.xml b/reference/pdo_ibm/ini.xml deleted file mode 100644 index 6315661346..0000000000 --- a/reference/pdo_ibm/ini.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Options de configuration PDO_IBM - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - pdo_ibm.i5_dbcs_alloc - "0" - INI_SYSTEM - Ajouté dans PDO_IBM 1.5.0 - - - pdo_ibm.i5_override_ccsid - "0" - INI_SYSTEM - Ajouté dans PDO_IBM 1.5.0 - - - -
    - &ini.php.constants; -     - -&ini.descriptions.title; - - - - - - pdo_ibm.i5_dbcs_alloc - int - - - - Cette option affecte la stratégie d'allocation de mémoire interne sur IBM i. - Par défaut, cette option est 0. Lorsque cette option est définie, des - tampons sont alloués avec une taille beaucoup plus grande, au cas où la - base de données serait trompeuse sur la taille des caractères lors de la - conversion entre les encodages. Cette option utilise six fois plus de - mémoire pour les tampons (pour tenir compte des séquences UTF-8 les plus - longues), mais peut être nécessaire si des données tronquées sont renvoyées. - - - - 0 - La taille minimale des tampons est allouée. - - - - - 1 - Une plus grande taille des tampons est allouée. - - - - - - - - - pdo_ibm.i5_override_ccsid - int - - - - Le CCSID ASCII à utiliser pour la conversion de l'EBCDIC sur IBM i. En - définissant ceci à 1208, l'on utilisera l'UTF-8. Par défaut, c'est 0, ce qui sélectionnera - le CCSID de travail ASCII par défaut. - - - Pour en savoir plus sur les CCSID sur IBM i, consulter la - documentation IBM. - - - - - -
    - - diff --git a/reference/pdo_ibm/reference.xml b/reference/pdo_ibm/reference.xml deleted file mode 100644 index b7f7e51a08..0000000000 --- a/reference/pdo_ibm/reference.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - - - Fonctions du pilote PDO IBM (PDO_IBM) - Pilote PDO IBM - - -
    - &reftitle.intro; - - PDO_IBM est un driver qui implémente l'interface - PHP Data Objects (PDO) afin d'activer l'accès - à partir de PHP aux bases de données IBM. - -
    - - - &reference.pdo-ibm.configure; - - &reference.pdo-ibm.ini; - -     - - - - PDO_IBM DSN - Connexion aux bases de données IBM - - - - &reftitle.description; - - Le nom de la source de données PDO_IBM (DSN) est basé sur le IBM CLI DSN. - Les principaux composants de PDO_IBM DSN sont : - - - DSN prefix - - - Le préfixe DSN est ibm:. - - - - - DSN - - - Le DSN peut être une valeur parmi celles-ci : - - - - a) Configuration de la source des données en utilisant le fichier - db2cli.ini - ou odbc.ini - - - - - b) Nom de base de données catalogué, c.-à-d. alias de base de données contenus dans - le catalogue du client DB2 - - - - - c) Chaîne de connexion complète dans le format suivant : - DRIVER={IBM DB2 ODBC DRIVER};DATABASE=database;HOSTNAME=hostname;PORT=port;PROTOCOL=TCPIP;UID=username;PWD=password; - où les paramètres représentent les valeurs suivantes : - - - database - - - Le nom de la base de données. - - - - - hostname - - - Le nom de l'hôte ou l'adresse IP du serveur de base de données. - - - - - port - - - Le port TCP/IP sur lequel la base de données écoute les requêtes. - - - - - username - - - Le nom d'utilisateur utilisé pour la connexion à la base de données. - - - - - password - - - Le mot de passe utilisé pour la connexion à la base de données. - - - - - - - - - - - - - - - &reftitle.examples; - - - Exemple avec PDO_IBM DSN en utilisant <filename>db2cli.ini</filename> - - L'exemple suivant montre l'utilisation de PDO_IBM DSN pour la connexion à une - base de données DB2 cataloguée comme DB2_9 dans le fichier - db2cli.ini : - - - - - - - Exemple avec PDO_IBM DSN en utilisant une chaîne complète de connexion - - L'exemple suivant montre l'utilisation de PDO_IBM DSN pour la connexion à une - base de données DB2 nommée testdb en utilisant - la chaîne complète de connexion DB2 CLI : - - - - - - - - -     - - diff --git a/reference/pdo_informix/configure.xml b/reference/pdo_informix/configure.xml deleted file mode 100644 index 5236aaf399..0000000000 --- a/reference/pdo_informix/configure.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - -
    - &reftitle.install; - - Pour compiler l'extension PDO_INFORMIX, le SDK Client Informix 2.81 UC1 ou - supérieur doit être installé sur le même système que PHP. Le SDK Client - Informix est disponible sur le Site de - Support IBM Informix. - - - PDO_INFORMIX est une extension &link.pecl;, alors - suivez les instructions dans pour installer - l'extension PDO_INFORMIX. Écrivez la commande configure - pour pointer au chemin des fichiers d'en-têtes SDK Client Informix ainsi - que les bibliothèques comme suit : - - - - La commande configure utilise par défaut la variable - d'environnement INFORMIXDIR. - -
    - - diff --git a/reference/pdo_informix/reference.xml b/reference/pdo_informix/reference.xml deleted file mode 100644 index 552b3a29a8..0000000000 --- a/reference/pdo_informix/reference.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - - Fonctions du pilote PDO Informix (PDO_INFORMIX) - Pilote PDO Informix - - -
    - &reftitle.intro; - - PDO_INFORMIX est un pilote qui implémente l'interface de PHP Data Objects (PDO) - pour autoriser l'accès à PHP aux bases de données Informix. - -
    - - - &reference.pdo-informix.configure; - -
    - Curseurs défilables - - PDO_INFORMIX supporte les curseurs défilables; cependant, ils ne sont pas - activés par défaut. Pour activer le support des curseurs défilables, il faut - soit fixer ENABLESCROLLABLECURSORS=1 dans - les configurations de la connexion ODBC correspondante dans - odbc.ini ou passer la clause - EnableScrollableCursors=1 dans la chaîne de - caractères de connexion DSN. - -
    - -     - - - - PDO_INFORMIX DSN - Connexion aux bases de données Informix - - - - &reftitle.description; - - Le Data Source Name (DSN) de PDO_INFORMIX est basé sur la chaîne de - caractères DSN d'Informix ODBC. Les détails sur la configuration d'un DSN - Informix ODBC sont disponibles sur - Informix Dynamic Server Information Center. - Les composants majeurs de DSN de PDO_INFORMIX sont : - - - DSN prefix - - - Le préfixe DSN est informix:. - - - - - DSN - - - Le DSN peut soit être une source de données de configuration en - utilisant odbc.ini ou une chaîne de caractères de - connexion complète. - - - - - - - - &reftitle.examples; - - - Exemple DSN de PDO_INFORMIX avec <filename>odbc.ini</filename> - - L'exemple suivant montre PDO_INFORMIX DSN pour se connecter à une base - de données Informix cataloguée comme Infdrv33 dans - odbc.ini : - - - - - - Exemple DSN de PDO_INFORMIX avec une chaîne de caractères de connexion - - L'exemple suivant montre PDO_INFORMIX DSN pour se connecter à une base - de données Informix nommée common_db en - utilisant la syntaxe de chaîne de caractères de connexion Informix. - - - - - - - - - -     - diff --git a/reference/pdo_sqlsrv/configure.xml b/reference/pdo_sqlsrv/configure.xml deleted file mode 100644 index a42b66b200..0000000000 --- a/reference/pdo_sqlsrv/configure.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - -
    - &reftitle.install; - - La version la plus récente du pilote est disponible au téléchargement ici : - téléchargement SQLSRV. - Les sources du pilote sont hébergées dans un dépôt public. - - - Pour plus d'information à propos des exigences système, consulter le - chapitre sur les - exigences systèmes SQLSRV. - - - Sur Windows, l'extension PDO_SQLSRV est activée en téléchargeant et en ajoutant - les fichiers DLL appropriés dans le répertoire d'extension PHP - et l'entrée correspondante dans le fichier &php.ini;. - - - Sur Linux et macOS, l'extension PDO_SQLSRV peut être installée en utilisant &link.pecl;. - Voir le tutoriel d'installation pour plus de détails. - driver ODBC du serveur SQL Microsoft pour Linux. - -
    - diff --git a/reference/pdo_sqlsrv/constants.xml b/reference/pdo_sqlsrv/constants.xml deleted file mode 100644 index 4b929ee79f..0000000000 --- a/reference/pdo_sqlsrv/constants.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - -
    - &reftitle.constants; - &pdo.driver-constants; - - - - PDO::SQLSRV_TXN_READ_UNCOMMITTED - (int) - - - - Cette constante est une valeur possible pour la clé "TransactionIsolation" du DSN pour SQLSRV. - Cette constante positionne le niveau d'isolation de la transaction à "Read Uncommitted". - - - - - - PDO::SQLSRV_TXN_READ_COMMITTED - (int) - - - - Cette constante est une valeur possible pour la clé "TransactionIsolation" du DSN pour SQLSRV. - Cette constante positionne le niveau d'isolation de la transaction à "Read Committed". - - - - - - PDO::SQLSRV_TXN_REPEATABLE_READ - (int) - - - - Cette constante est une valeur possible pour la clé "TransactionIsolation" du DSN pour SQLSRV. - Cette constante positionne le niveau d'isolation de la transaction à "Repeateable Read". - - - - - - PDO::SQLSRV_TXN_SNAPSHOT - (int) - - - - Cette constante est une valeur possible pour la clé "TransactionIsolation" du DSN pour SQLSRV. - Cette constante positionne le niveau d'isolation de la transaction à "Snapshot". - - - - - - PDO::SQLSRV_TXN_SERIALIZABLE - (int) - - - - Cette constante est une valeur possible pour la clé "TransactionIsolation" du DSN pour SQLSRV. - Cette constante positionne le niveau d'isolation de la transaction à "Serializable". - - - - - - PDO::SQLSRV_ENCODING_BINARY - (int) - - - - Spécifie que cette donnée est envoyée vers le (ou reçue du) serveur comme un flux d'octets, - sans opérer d'encodage ou de traduction. Cette constante peut être utilisée dans les appels à - PDOStatement::setAttribute, PDO::prepare, PDOStatement::bindColumn, et - PDOStatement::bindParam. - - - - - - PDO::SQLSRV_ENCODING_SYSTEM - (int) - - - - Spécifie que cette donnée est envoyée vers le (ou reçue du) serveur comme un flux de caractères 8 bits, - comme spécifié dans la page de code de la locale Windows active sur le système. - Tout caractère multioctet, ou caractère qui n'existe pas dans cette page de code, - est substitué par un simple point d'interrogation (?). Cette constante peut être utilisée - dans les appels à PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, - PDOStatement::bindColumn, et PDOStatement::bindParam. - - - - - - PDO::SQLSRV_ENCODING_UTF8 - (int) - - - - Spécifie que cette donnée est envoyée vers le (ou reçue du) serveur comme un flux de caractères UTF-8. - Il s'agit de l'encodage par défaut. Cette constante peut être utilisée - dans les appels à PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, - PDOStatement::bindColumn, et PDOStatement::bindParam. - - - - - - PDO::SQLSRV_ENCODING_DEFAULT - (int) - - - - Spécifie que cette donnée est envoyée vers le (ou reçue du) serveur en utilisant l'encodage - PDO::SQLSRV_ENCODING_SYSTEM si elle est spécifiée pendant la connexion. Si elle est spécifiée - dans une instruction "prepare", c'est l'encodage de la connexion qui est utilisé. - Cette constante peut être utilisée dans les appels à PDOStatement::setAttribute, - PDO::setAttribute, PDO::prepare, PDOStatement::bindColumn, et PDOStatement::bindParam. - - - - - - PDO::SQLSRV_ATTR_QUERY_TIMEOUT - (int) - - - - Un entier positif ou nul représentant la durée de timeout, en secondes. Zéro (0) - est la valeur par défaut et signifie qu'il n'y a pas de timeout. - Cette constante peut être utilisée dans les appels à - PDOStatement::setAttribute, PDO::setAttribute, et PDO::prepare. - - - - - - PDO::SQLSRV_ATTR_DIRECT_QUERY - (int) - - - - Indique une requête qui doit être exécutée directement, sans être préparée. - Cette constante peut être utilisée dans les appels à PDO::setAttribute, et PDO::prepare. - Pour plus d'informations, voir (en anglais) - Direct and Prepared Statement Execution. - - - - -
    - - diff --git a/reference/pdo_sqlsrv/reference.xml b/reference/pdo_sqlsrv/reference.xml deleted file mode 100644 index 40830f0eaa..0000000000 --- a/reference/pdo_sqlsrv/reference.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - - Fonctions Microsoft du pilote PDO SQL Server (PDO_SQLSRV) - Pilote PDO MS SQL Server - - -
    - &reftitle.intro; - - PDO_SQLSRV est un pilote qui implémente l'interface - PDO (PHP Data Objects) pour permettre l'accès à partir de PHP aux bases de - données MS SQL Server (version SQL Server 2005 et supérieures) et SQL Azure. - -
    - &reference.pdo-sqlsrv.configure; - &reference.pdo-sqlsrv.constants; -     - - - - PDO_SQLSRV DSN - Connexion à des bases de données MS SQL Server et SQL Azure - - - - &reftitle.description; - - Le fichier DSN (Data Source Name) PDO_SQLSRV est composé des éléments suivants : - - - préfixe DSN - - - Le préfixe DSN est sqlsrv:. - - - - - APP - - - Le nom de l'application, utilisé pour les traces. - - - - - ConnectionPooling - - - Spécifie si la connexion est assignée à un pool de connexions - (1 ou &true;) ou non (0 ou &false;). - - - - - Database - - - Le nom de la base de données. - - - - - Encrypt - - - Spécifie si la communication avec le serveur SQL Server est chiffrée - (1 ou &true;) ou non chiffrée (0 ou &false;). - - - - - Failover_Partner - - - Spécifie le serveur et l'instance de la base de données miroir (si elle - est activée et configurée) à utiliser quand le serveur principal est - inaccessible. - - - - - LoginTimeout - - - Spécifie le nombre de secondes d'attente avant de stopper et mettre en - erreur la tentative de connexion. - - - - - MultipleActiveResultSets - - - Désactive, ou active explicitement, le support pour des jeux de résultats - multiples (Multiple Active Result Sets, MARS). - - - - - QuotedId - - - Spécifie s'il faut utiliser les règles SQL-92 pour les identifiants entre guillemets - (1 ou &true;) ou s'il faut utiliser les règles Transact-SQL standard (0 ou &false;). - - - - - Server - - - Le nom du serveur de base de données. - - - - - TraceFile - - - Le chemin du fichier utilisé pour les traces. - - - - - TraceOn - - - Spécifie si les traces ODBC sont activées (1 ou &true;) ou désactivées - (0 ou &false;) à l'activation de la connexion. - - - - - TransactionIsolation - - - Spécifie le niveau d'isolation de la transaction. Les valeurs possibles - pour cette option sont - PDO::SQLSRV_TXN_READ_UNCOMMITTED, PDO::SQLSRV_TXN_READ_COMMITTED, - PDO::SQLSRV_TXN_REPEATABLE_READ, PDO::SQLSRV_TXN_SNAPSHOT, et - PDO::SQLSRV_TXN_SERIALIZABLE. - - - - - TrustServerCertificate - - - Spécifie si le client doit faire confiance (1 ou &true;) ou rejeter - (0 ou &false;) un certificat serveur autosigné. - - - - - WSID - - - Spécifie le nom de l'ordinateur pour les traces. - - - - - - - - - &reftitle.examples; - - Exemples de DSN PDO_SQLSRV - - L'exemple suivant montre comment se connecter à la base de données MS SQL Server spécifiée : - - - - - - L'exemple suivant montre comment se connecter à la base de données MS SQL Server spécifiée - sur un port spécifique : - - - - - - L'exemple suivant montre comment se connecter à une base de données SQL Azure avec - l'ID serveur 12345abcde. À noter que, quand on l'on se connecte à Azure avec PDO, - le nom d'utilisateur sera Utilisateur@12345abcde (Utilisateur@IdServeur). - - - - - - - - -     - diff --git a/reference/ps/book.xml b/reference/ps/book.xml deleted file mode 100644 index aa5b7ef45f..0000000000 --- a/reference/ps/book.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - - Création de document PostScript - PS - - - - &reftitle.intro; - - Ce module permet de créer des documents PostScript. Il a beaucoup de - similarités avec l'extension pdf. Actuellement, cette API est pratiquement - identique et dans la plupart des cas, seuls les préfixes de chaque - fonction sont remplacés de pdf_ par ps_. Cela fonctionne aussi pour les - fonctions qui n'ont pas de signification dans le document PostScript - (par exemple, l'ajout d'hyperliens) mais aura un effet si le document est - converti en PDF. - - Les documents créés par cette extension sont parfois même supérieurs - aux documents créés avec l'extension pdf, parce que les fonctions de - rendu de texte de pslib peuvent gérer le crénage, la coupure de mot et - les ligatures qui résultent en un bien meilleur affichage de boîtes de texte. - - - - - &reference.ps.setup; - &reference.ps.constants; - &reference.ps.reference; - - - - - diff --git a/reference/ps/configure.xml b/reference/ps/configure.xml deleted file mode 100644 index 80c108158e..0000000000 --- a/reference/ps/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;ps. - -
    - - - diff --git a/reference/ps/constants.xml b/reference/ps/constants.xml deleted file mode 100644 index 2de0736c78..0000000000 --- a/reference/ps/constants.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Les deux tables suivantes listent toutes les constantes définies par - l'extension ps. - - Constantes pour line caps - - - - &Name; - &Description; - - - - - ps_LINECAP_BUTT - - - - ps_LINECAP_ROUND - - - - ps_LINECAP_SQUARED - - - - -
    - - - Constantes pour line joins - - - - &Name; - &Description; - - - - - ps_LINEJOIN_MITER - - - - ps_LINEJOIN_ROUND - - - - ps_LINEJOIN_BEVEL - - - - -
    -     -     - - diff --git a/reference/ps/functions/ps-add-bookmark.xml b/reference/ps/functions/ps-add-bookmark.xml deleted file mode 100644 index c66944d107..0000000000 --- a/reference/ps/functions/ps-add-bookmark.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - - ps_add_bookmark - Ajoute un signet à la page courante - - - - &reftitle.description; - - intps_add_bookmark - resourcepsdoc - stringtext - intparent0 - intopen0 - - - Ajoute un signet pour la page courante. Les signets apparaissent - normalement dans les lecteurs PDF sur la gauche de la page dans un arbre - hiérarchique. Cliquer sur un signet sautera à la page donnée. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - text - - - Le texte utilisé pour afficher le signet. - - - - - parent - - - Un signet précédemment créé par cette fonction qui est - utilisé comme parent du nouveau signet. - - - - - open - - - Si open n'est pas égal à zéro, le signet sera - montré ouvert dans le lecteur PDF. - - - - - - - - - &reftitle.returnvalues; - - La valeur retournée est une référence pour le signet. Cela est utilisé - seulement si le signet doit être utilisé en tant que parent. La valeur est - supérieure à zéro si la fonction réussit. En cas d'erreur, &zero; sera - retourné. - - - - - &reftitle.seealso; - - - ps_add_launchlink - ps_add_pdflink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-launchlink.xml b/reference/ps/functions/ps-add-launchlink.xml deleted file mode 100644 index 6fb311ec85..0000000000 --- a/reference/ps/functions/ps-add-launchlink.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - ps_add_launchlink - Ajoute un lien qui démarre un fichier - - - - &reftitle.description; - - boolps_add_launchlink - resourcepsdoc - floatllx - floatlly - floaturx - floatury - stringfilename - - - ps_add_launchlink place un hyperlien à la position donnée - pointant vers un programme qui sera démarré lors du clic sur celui-ci. - La position source de l'hyperlien est un rectangle avec son coin inférieur - gauche à (llx, lly) et son coin haut droit à - (urx, ury). - Le rectangle a par défaut une mince bordure bleue. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - llx - - - La position x du coin inférieur gauche. - - - - - lly - - - La position y du coin inférieur gauche. - - - - - urx - - - La position x du coin supérieur droit. - - - - - ury - - - La position y du coin supérieur droit. - - - - - filename - - - Le chemin où le programme sera démarré, lorsque le lien sera cliqué. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_locallink - ps_add_pdflink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-locallink.xml b/reference/ps/functions/ps-add-locallink.xml deleted file mode 100644 index 2102569bfe..0000000000 --- a/reference/ps/functions/ps-add-locallink.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - - ps_add_locallink - Ajoute un lien à une page dans le même document - - - - &reftitle.description; - - boolps_add_locallink - resourcepsdoc - floatllx - floatlly - floaturx - floatury - intpage - stringdest - - - ps_add_locallink place un hyperlien à une position - donnée pointant à une page dans le même document. Cliquer sur le lien - sautera à la page donnée. La première page dans un document a le numéro 1. - - - La position source de l'hyperlien est un rectangle avec son coin inférieur gauche à - (llx, lly) et son coin - supérieur droit à (urx, ury). Le - rectangle a par défaut une mince bordure bleue. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - llx - - - La position x du coin inférieur gauche. - - - - - lly - - - La position y du coin inférieur gauche. - - - - - urx - - - La position x du coin supérieur droit. - - - - - ury - - - La position y du coin supérieur droit. - - - - - page - - - Le nombre de page affichée lors du clic sur le lien. - - - - - dest - - - Le paramètre dest détermine comment le document - sera vu. Il peut être fitpage, - fitwidth, fitheight ou - fitbbox. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_launchlink - ps_add_pdflink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-note.xml b/reference/ps/functions/ps-add-note.xml deleted file mode 100644 index 32cb750745..0000000000 --- a/reference/ps/functions/ps-add-note.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - ps_add_note - Ajoute une note à la page courante - - - - &reftitle.description; - - boolps_add_note - resourcepsdoc - floatllx - floatlly - floaturx - floatury - stringcontents - stringtitle - stringicon - intopen - - - ps_add_note ajoute une note à une certaine position sur - la page. Les notes sont comme de petites feuilles rectangulaires avec du texte - par dessus, qui peuvent être placées n'importe où sur une page. Elles sont - affichées, soit pliées ou dépliées. Si elles sont pliées, l'icône spécifiée - est utilisée comme un marqueur. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - llx - - - La position x du coin inférieur gauche. - - - - - lly - - - La position y du coin inférieur gauche. - - - - - urx - - - La position x du coin supérieur droit. - - - - - ury - - - La position y du coin supérieur droit. - - - - - contents - - - Le texte de la note. - - - - - title - - - Le titre de la note affiché en tant qu'en-tête de la note. - - - - - icon - - - L'icône montrée si la note est pliée. Le paramètre peut être fixé à - comment, insert, - note, paragraph, - newparagraph, key ou - help. - - - - - open - - - Si open n'est pas égal à zéro, la note sera - affichée dépliée après l'ouverture du document dans un visualisateur PDF. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_pdflink - ps_add_launchlink - ps_add_locallink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-pdflink.xml b/reference/ps/functions/ps-add-pdflink.xml deleted file mode 100644 index daef5f419e..0000000000 --- a/reference/ps/functions/ps-add-pdflink.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - - ps_add_pdflink - Ajoute un lien à une page à un second document PDF - - - - &reftitle.description; - - boolps_add_pdflink - resourcepsdoc - floatllx - floatlly - floaturx - floatury - stringfilename - intpage - stringdest - - - ps_add_pdflink place un hyperlien à une position donnée - à un second document PDF. Cliquer sur le lien branchera au document à la page - donnée. La première page dans un document a le numéro 1. - - - La position source de l'hyperlien est un rectangle avec son coin inférieur gauche à - (llx, lly) et son coin - supérieur droit à (urx, ury). Le - rectangle a par défaut une mince bordure bleue. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - llx - - - La position x du coin inférieur gauche. - - - - - lly - - - La position y du coin inférieur gauche. - - - - - urx - - - La position x du coin supérieur droit. - - - - - ury - - - La position y du coin supérieur droit. - - - - - filename - - - Le nom du document PDF qui sera ouvert lors du clic sur ce lien. - - - - - page - - - Le numéro de page de la destination du document PDF. - - - - - dest - - - Le paramètre dest détermine comment le document - sera vu. Il peut être fitpage, - fitwidth, fitheight ou - fitbbox. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_launchlink - ps_add_locallink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-weblink.xml b/reference/ps/functions/ps-add-weblink.xml deleted file mode 100644 index 70de83037a..0000000000 --- a/reference/ps/functions/ps-add-weblink.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - ps_add_weblink - Ajoute un lien à un emplacement web - - - - &reftitle.description; - - boolps_add_weblink - resourcepsdoc - floatllx - floatlly - floaturx - floatury - stringurl - - - Place un hyperlien à la position donnée à une page web. La position source de - l'hyperlien est un rectangle avec son coin inférieur gauche à - (llx, lly) et son coin - supérieur droit à (urx, ury). - Le rectangle a par défaut une mince bordure bleue. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - llx - - - La position x du coin inférieur gauche. - - - - - lly - - - La position y du coin inférieur gauche. - - - - - urx - - - La position x du coin supérieur droit. - - - - - ury - - - La position y du coin supérieur droit. - - - - - url - - - L'adresse url du lien hypertexte à ouvrir lors du clic sur ce - lien, par exemple http://www.php.net. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_launchlink - ps_add_locallink - ps_add_pdflink - - - - - - - diff --git a/reference/ps/functions/ps-arc.xml b/reference/ps/functions/ps-arc.xml deleted file mode 100644 index 21761a2ede..0000000000 --- a/reference/ps/functions/ps-arc.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - - ps_arc - Dessine un arc dans le sens contraire des aiguilles d'une montre - - - - &reftitle.description; - - boolps_arc - resourcepsdoc - floatx - floaty - floatradius - floatalpha - floatbeta - - - Dessine une portion d'un cercle avec un point milieu à - (x, y). L'arc débute à un - angle de alpha et termine avec un angle de - beta. Il est tracé dans le sens contraire des - aiguilles d'une montre (utiliser ps_arcn pour dessiner - dans le sens des aiguilles d'une montre). La sous trajectoire ajoutée à la trajectoire - courante débute sur l'arc à l'angle alpha et termine - sur l'arc à l'angle beta. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - x - - - La position x du centre du cercle. - - - - - y - - - La position y du centre du cercle. - - - - - radius - - - Le rayon du cercle. - - - - - alpha - - - L'angle de départ donné en degrés. - - - - - beta - - - L'angle de fin donné en degrés. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_arcn - - - - - - diff --git a/reference/ps/functions/ps-arcn.xml b/reference/ps/functions/ps-arcn.xml deleted file mode 100644 index e4783cb649..0000000000 --- a/reference/ps/functions/ps-arcn.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - - ps_arcn - Dessine un arc dans le sens des aiguilles d'une montre - - - - &reftitle.description; - - boolps_arcn - resourcepsdoc - floatx - floaty - floatradius - floatalpha - floatbeta - - - Dessine une portion d'un cercle avec un point milieu à - (x, y). L'arc débute à un - angle de alpha et termine avec un angle de - beta. Il est tracé dans le sens des aiguilles d'une - montre (utiliser ps_arc pour dessiner dans le sens - contraire des aiguilles d'une montre). La sous trajectoire ajoutée à la - trajectoire courante débute sur l'arc à l'angle beta - et termine sur l'arc à l'angle alpha. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - x - - - La position x du centre du cercle. - - - - - y - - - La position y du centre du cercle. - - - - - radius - - - Le rayon du cercle. - - - - - alpha - - - L'angle de départ donné en degrés. - - - - - beta - - - L'angle de fin donné en degrés. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_arc - - - - - - diff --git a/reference/ps/functions/ps-begin-page.xml b/reference/ps/functions/ps-begin-page.xml deleted file mode 100644 index 8d11f194a3..0000000000 --- a/reference/ps/functions/ps-begin-page.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - - ps_begin_page - Démarre une nouvelle page - - - - &reftitle.description; - - boolps_begin_page - resourcepsdoc - floatwidth - floatheight - - - Démarre une nouvelle page. Bien que les paramètres - width et height impliquent une - taille différente des feuilles pour chaque page, cela n'est pas possible - dans PostScript. Le premier appel de ps_begin_page - fixera la taille des pages pour le document entier. Des appels consécutifs - n'auront aucun effet, à l'exception pour créer une nouvelle page. La - situation est différente si l'on tente de convertir le document PostScript - en PDF. Cette fonction place des marques pdf à l'intérieur du document qui - peuvent fixer la taille pour chaque page individuellement. Le document PDF - résultant aura différentes tailles de pages. - - - Bien que le PostScript ne sait pas les tailles des différentes pages, pslib - place une boîte de contour pour chaque page dans le document. La taille est - évaluée par quelques lecteurs PostScript et aura précédence sur la - BoundingBox dans l'en-tête du document. Ceci peut mener à des résultats non - attendus lorsque l'on fixe une BoundingBox dont le coin inférieur gauche n'est pas - (0, 0), parce que la boîte de contour de la page aura toujours le coin - inférieur gauche à (0, 0) et écrasera les configurations globales. - - - Chaque page est encapsulée en sauvegarde/restauration. Cela signifie, que la - plupart des configurations effectuées sur une page ne seront pas retenues sur - la page suivante. - - - S'il n'y a aucun appel de ps_findfont jusqu'au premier - appel de ps_begin_page, alors l'en-tête du document - PostScript sera affichée et le rectangle englobant sera fixé à la taille de - la première page. Le coin inférieur gauche de la boîte de contour est fixée à - (0, 0). Si ps_findfont était appelée avant - que l'en-tête ne soit déjà affichée, le document n'aura pas un rectangle - englobant valide. Afin de prévenir cela, il est recommandé d'appeler - ps_set_info pour fixer le champ d'information - BoundingBox et possiblement - Orientation avant d'appeler - ps_findfont ou ps_begin_page. - - - - Jusqu'à la version 0.2.6 de pslib, cette fonction écrasera toujours la - BoundingBox et l'Orientation, si elle n'a pas été fixée avant avec la - fonction ps_set_info et que la fonction - ps_findfont n'ait jamais été appelée. - - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - width - - - La largeur de la page en pixel, par exemple 596 pour le format A4. - - - - - height - - - La hauteur de la page en pixel, par exemple 842 pour le format A4. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_end_page - ps_findfont - ps_set_info - - - - - - - diff --git a/reference/ps/functions/ps-begin-pattern.xml b/reference/ps/functions/ps-begin-pattern.xml deleted file mode 100644 index 41ed80e068..0000000000 --- a/reference/ps/functions/ps-begin-pattern.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - - ps_begin_pattern - Démarre un nouveau motif - - - - &reftitle.description; - - intfalseps_begin_pattern - resourcepsdoc - floatwidth - floatheight - floatxstep - floatystep - intpainttype - - - Démarre un nouveau motif. Un motif est comme une page contenant par exemple - un dessin qui peut être utilisé pour remplir des secteurs. Il est utilisé - comme une couleur en appelant ps_setcolor et en - configurant l'espace de couleur à pattern. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - width - - - La largeur du motif en pixel. - - - - - height - - - La hauteur du motif en pixel. - - - - - xstep - - - La distance en pixel de l'emplacement du motif dans la direction - horizontale. - - - - - ystep - - - La distance en pixel de l'emplacement du motif dans la direction - verticale. - - - - - painttype - - - Doit être 1 ou 2. - - - - - - - - - &reftitle.returnvalues; - - L'identifiant du motif &return.falseforfailure;. - - - - - &reftitle.examples; - - - Création et utilisation d'un motif - - -]]> - - - - - - - &reftitle.seealso; - - - ps_end_pattern - ps_setcolor - ps_shading_pattern - - - - - - - diff --git a/reference/ps/functions/ps-begin-template.xml b/reference/ps/functions/ps-begin-template.xml deleted file mode 100644 index a8a93b4fce..0000000000 --- a/reference/ps/functions/ps-begin-template.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - - ps_begin_template - Démarre un nouveau modèle - - - - &reftitle.description; - - intps_begin_template - resourcepsdoc - floatwidth - floatheight - - - ps_begin_template démarre un nouveau modèle. - Un modèle s'appelle un formulaire dans le langage PostScript. - Il est créé de la même manière qu'un motif, mais est - utilisé comme une image. Les modèles sont souvent utilisés pour les dessins - qui sont placés plusieurs fois dans le document, par exemple un logo de - compagnie. Toutes les fonctions de dessin peuvent être utilisées dans un - modèle. Le modèle ne sera pas dessiné tant qu'il n'est pas placé par - ps_place_image. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - width - - - La largeur du modèle en pixels. - - - - - height - - - La hauteur du modèle en pixels. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Création et utilisation d'un modèle PostScript - - -]]> - - - - - - - &reftitle.seealso; - - - ps_end_template - - - - - - - diff --git a/reference/ps/functions/ps-circle.xml b/reference/ps/functions/ps-circle.xml deleted file mode 100644 index b5533a8a87..0000000000 --- a/reference/ps/functions/ps-circle.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - ps_circle - Dessine un cercle - - - - &reftitle.description; - - boolps_circle - resourcepsdoc - floatx - floaty - floatradius - - - Dessine un cercle avec son point milieu à (x, - y). Le cercle débute et termine à la position - (x+radius, - y). Si cette fonction est appelée à l'extérieur - d'un chemin, elle démarrera un nouveau chemin. Si elle est appelée à - l'intérieur d'un chemin, elle ajoutera le cercle comme étant un sous - chemin. Si la dernière opération de dessin ne se termine pas au point - (x+radius, - y) alors il y aura un trou dans le chemin. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - x - - - La position x du centre du cercle. - - - - - y - - - La position y du centre du cercle. - - - - - radius - - - Le rayon du cercle. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_arc - ps_arcn - - - - - - diff --git a/reference/ps/functions/ps-clip.xml b/reference/ps/functions/ps-clip.xml deleted file mode 100644 index bad3e3722d..0000000000 --- a/reference/ps/functions/ps-clip.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - ps_clip - Découpe le dessin selon le chemin courant - - - - &reftitle.description; - - boolps_clip - resourcepsdoc - - - Prend le chemin courant et l'utilise pour définir la bordure du secteur de - découpe. Tout ce qui est dessiné à l'extérieur de ce secteur ne sera pas - visible. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_closepath - - - - - - - diff --git a/reference/ps/functions/ps-close-image.xml b/reference/ps/functions/ps-close-image.xml deleted file mode 100644 index 33f6cc0bd8..0000000000 --- a/reference/ps/functions/ps-close-image.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - ps_close_image - Ferme l'image et libère la mémoire - - - - &reftitle.description; - - voidfalseps_close_image - resourcepsdoc - intimageid - - - Ferme une image et libère ses ressources. Une fois l'image fermée, elle ne - peut plus être utilisée. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - imageid - - - Identifiant d'une image retourné par - ps_open_image ou - ps_open_image_file. - - - - - - - - - &reftitle.returnvalues; - - Retourne &null; en cas de succès&return.falseforfailure;. - - - - - &reftitle.seealso; - - - ps_open_image - ps_open_image_file - - - - - - - diff --git a/reference/ps/functions/ps-close.xml b/reference/ps/functions/ps-close.xml deleted file mode 100644 index a67f7872da..0000000000 --- a/reference/ps/functions/ps-close.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - ps_close - Ferme le document PostScript - - - - &reftitle.description; - - boolps_close - resourcepsdoc - - - Ferme le document PostScript. - - - Cette fonction écrit les dernières informations dans le document - PostScript. Elle écrit aussi l'arbre des signets. - ps_close ne libère aucune ressource, ceci peut être - fait par ps_delete. - - - Cette fonction est aussi appelée par ps_delete si elle - n'avait pas été appelée avant. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_open_file - ps_delete - - - - - - diff --git a/reference/ps/functions/ps-closepath-stroke.xml b/reference/ps/functions/ps-closepath-stroke.xml deleted file mode 100644 index 14bbf59760..0000000000 --- a/reference/ps/functions/ps-closepath-stroke.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - ps_closepath_stroke - Ferme et trace un chemin - - - - &reftitle.description; - - boolps_closepath_stroke - resourcepsdoc - - - Connecte le dernier point avec le premier point du chemin et dessine le - résultat de la ligne fermée. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_closepath - - - - - - - diff --git a/reference/ps/functions/ps-closepath.xml b/reference/ps/functions/ps-closepath.xml deleted file mode 100644 index 8a4fda025f..0000000000 --- a/reference/ps/functions/ps-closepath.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ps_closepath - Ferme un chemin - - - - &reftitle.description; - - boolps_closepath - resourcepsdoc - - - Connecte le dernier point avec le premier point du chemin. Le chemin - résultant peut être utilisé comme ligne, remplissage, coupure, etc. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_clip - ps_closepath_stroke - - - - - - - diff --git a/reference/ps/functions/ps-continue-text.xml b/reference/ps/functions/ps-continue-text.xml deleted file mode 100644 index b8c94b6edc..0000000000 --- a/reference/ps/functions/ps-continue-text.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - ps_continue_text - Continue un texte à la ligne suivante - - - - &reftitle.description; - - boolps_continue_text - resourcepsdoc - stringtext - - - Écrit un texte une ligne en dessous de la dernière ligne. L'espace - entre les lignes est pris avec la valeur "leading" qui doit être fixée avec - ps_set_value. La position actuelle du texte - est déterminée par les valeurs "textx" et "texty" qui peuvent être - récupérées par ps_get_value. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - text - - - Le texte à afficher. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_show - ps_show_xy - ps_show_boxed - - - - - - - diff --git a/reference/ps/functions/ps-curveto.xml b/reference/ps/functions/ps-curveto.xml deleted file mode 100644 index f29b0cbea3..0000000000 --- a/reference/ps/functions/ps-curveto.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - ps_curveto - Dessine une courbe - - - - &reftitle.description; - - boolps_curveto - resourcepsdoc - floatx1 - floaty1 - floatx2 - floaty2 - floatx3 - floaty3 - - - ps_curveto ajoute une section d'une courbe Bézier - cubique décrite par les trois points de contrôle donnés au chemin courant. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - x1 - - - Position x du premier point de contrôle. - - - - - y1 - - - Position y du premier point de contrôle. - - - - - x2 - - - Position x du deuxième point de contrôle. - - - - - y2 - - - Position y du deuxième point de contrôle. - - - - - x3 - - - Position x du troisième point de contrôle. - - - - - y3 - - - Position y du troisième point de contrôle. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_lineto - - - - - - - diff --git a/reference/ps/functions/ps-delete.xml b/reference/ps/functions/ps-delete.xml deleted file mode 100644 index 18c568d521..0000000000 --- a/reference/ps/functions/ps-delete.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - ps_delete - Supprime toutes les ressources d'un document PostScript - - - - &reftitle.description; - - boolps_delete - resourcepsdoc - - - Libère principalement la mémoire utilisée par le document. Ferme aussi un - fichier, s'il n'était pas fermé auparavant avec la fonction - ps_close. Il est recommandé dans tous les cas de fermer le - fichier avec ps_close avant, car - ps_close ne ferme pas simplement le fichier mais écrit - aussi les dernières informations contenant le commentaire PostScript avec le nombre - de pages dans le document et ajoute la hiérarchie des signets. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_close - - - - - - - diff --git a/reference/ps/functions/ps-end-page.xml b/reference/ps/functions/ps-end-page.xml deleted file mode 100644 index b24079c870..0000000000 --- a/reference/ps/functions/ps-end-page.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - ps_end_page - Termine une page - - - - &reftitle.description; - - boolps_end_page - resourcepsdoc - - - Termine une page qui a été débutée avec ps_begin_page. - Terminer une page laissera le contexte courant de dessin, qui par exemple - requiert de recharger les polices si elles ont été chargées avec la page et - fixe plusieurs autres paramètres de dessin comme la largeur des lignes, la - couleur. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_begin_page - - - - - - - diff --git a/reference/ps/functions/ps-end-pattern.xml b/reference/ps/functions/ps-end-pattern.xml deleted file mode 100644 index 763d62aadd..0000000000 --- a/reference/ps/functions/ps-end-pattern.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ps_end_pattern - Termine un motif - - - - &reftitle.description; - - boolps_end_pattern - resourcepsdoc - - - Termine un motif qui a été débuté avec ps_begin_pattern. - Une fois qu'un motif est terminé, il peut être utilisé en tant que couleur - pour remplir des secteurs. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_begin_pattern - - - - - - - diff --git a/reference/ps/functions/ps-end-template.xml b/reference/ps/functions/ps-end-template.xml deleted file mode 100644 index a619386918..0000000000 --- a/reference/ps/functions/ps-end-template.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - ps_end_template - Termine un modèle - - - - &reftitle.description; - - boolps_end_template - resourcepsdoc - - - Termine un modèle qui a été débuté avec ps_begin_template. - Une fois un modèle terminé, il peut être utilisé comme une image. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_begin_template - - - - - - - diff --git a/reference/ps/functions/ps-fill-stroke.xml b/reference/ps/functions/ps-fill-stroke.xml deleted file mode 100644 index 991b9957f0..0000000000 --- a/reference/ps/functions/ps-fill-stroke.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ps_fill_stroke - Remplit et trace le chemin courant - - - - &reftitle.description; - - boolps_fill_stroke - resourcepsdoc - - - Remplit et dessine le chemin construit avec des fonctions de dessin comme - ps_lineto précédemment appelées. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_fill - ps_stroke - - - - - - - diff --git a/reference/ps/functions/ps-fill.xml b/reference/ps/functions/ps-fill.xml deleted file mode 100644 index 423f118bcc..0000000000 --- a/reference/ps/functions/ps-fill.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ps_fill - Remplit le chemin courant - - - - &reftitle.description; - - boolps_fill - resourcepsdoc - - - Remplit le chemin construit avec des fonctions de dessin comme - ps_lineto précédemment appelées. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_fill_stroke - ps_stroke - - - - - - - diff --git a/reference/ps/functions/ps-findfont.xml b/reference/ps/functions/ps-findfont.xml deleted file mode 100644 index 629428028f..0000000000 --- a/reference/ps/functions/ps-findfont.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - - ps_findfont - Charge une police - - - - &reftitle.description; - - intps_findfont - resourcepsdoc - stringfontname - stringencoding - boolembed&false; - - - ps_findfont charge une police pour utilisation ultérieure. - Avant que le texte soit écrit avec la police chargée, il doit être fixé avec - ps_setfont. Cette fonction doit avoir le fichier de - police métrique "adobe" afin de calculer l'espace utilisé par les - caractères. Une police qui est chargée dans une page sera seulement - disponible sur cette page. Les polices qui seront utilisées dans le - document complet doivent être chargées avant le premier appel de - ps_begin_page. L'appel de - ps_findfont entre les pages rendra cette police - disponible pour toutes les pages qui suivent. - - - Le nom du fichier afm doit être - fontname.afm. Si la police doit - être incorporée, le fichier - fontname.pfb contenant le dessin - de la police doit être présent aussi. - - - L'appel de ps_findfont avant la première page requiert - l'affichage de l'en-tête du postscript qui inclut le BoundingBox pour le - document entier. Normalement, le BoundingBox est fixé avec le premier appel - de ps_begin_page qui vient maintenant après - ps_findfont. En conséquence, le BoundingBox n'a pas - été fixé et un avertissement sera émis lorsque - ps_findfont sera appelée. Afin de prévenir cette - situation, il est recommandé d'appeler la fonction - ps_set_parameter pour fixer le BoundingBox avant que - ps_findfont soit appelée. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - fontname - - - Le nom de la police. - - - - - encoding - - - ps_findfont essaiera de charger le fichier passé - dans le paramètre encoding. Les fichiers - d'encodage sont de même syntaxe que ceux utilisés par - dvips(1). Ils contiennent un vecteur de police - d'encodage (qui n'est actuellement pas utilisé, mais qui doit être - présent) et une liste de ligatures en extra pour prolonger la liste des - ligatures dérivées du fichier AFM. - - - encoding peut être &null; ou une &string; vide - si l'encodage par défaut (TeXBase1) désire être utilisé. - - - Si l'encodage est fixé à builtin alors il n'y aura - pas de réencodage et l'encodage spécifique de police sera - utilisé. Cela est très utile pour les polices avec symboles. - - - - - embed - - - Si fixé à une valeur >0, la police sera incorporée dans le document. - Ceci requiert la présence du fichier dessin (.pfb). - - - - - - - - - &reftitle.returnvalues; - - Retourne un identifiant de la police ou zéro en cas d'erreur. L'identifiant - est un nombre positif. - - - - - &reftitle.seealso; - - - ps_begin_page - ps_setfont - - - - - - - diff --git a/reference/ps/functions/ps-get-buffer.xml b/reference/ps/functions/ps-get-buffer.xml deleted file mode 100644 index 837a11fa29..0000000000 --- a/reference/ps/functions/ps-get-buffer.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - ps_get_buffer - Récupère le tampon complet contenant les données PS générées - - - - &reftitle.description; - - stringps_get_buffer - resourcepsdoc - - - Cette fonction n'est pas encore implémentée. Elle retournera toujours une - chaîne de caractères vide. L'idée pour une future implémentation est - d'écrire le contenu du fichier postscript dans un tampon interne si - création en mémoire est demandée et de retourner le contenu du tampon avec - la fonction. - Présentement, les documents créés en mémoire sont envoyés au navigateur - sans utilisation de tampon. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.seealso; - - - ps_open_file - - - - - - - diff --git a/reference/ps/functions/ps-get-parameter.xml b/reference/ps/functions/ps-get-parameter.xml deleted file mode 100644 index 8f6729f5aa..0000000000 --- a/reference/ps/functions/ps-get-parameter.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - - - ps_get_parameter - Récupère certains paramètres - - - - &reftitle.description; - - stringfalseps_get_parameter - resourcepsdoc - stringname - floatmodifier - - - Récupère plusieurs paramètres qui ont été fixés directement par - ps_set_parameter ou indirectement par une ou d'autres - fonctions. Les paramètres sont, par définition, - des valeurs de &string;. Cette fonction ne peut être utilisée pour - récupérer les ressources qui ont été aussi fixées par - ps_set_parameter. - - - Le paramètre name peut avoir une des valeurs - suivantes. - - - - - fontname - - - Le nom de la police présentement active ou la police dont l'identifiant - est passé dans le paramètre modifier. - - - - - fontencoding - - - L'encodage de la police présentement active. - - - - - dottedversion - - - La version de la bibliothèque sous-jacente pslib dans le format - <majeur>.<mineur>.<sousmineur> - - - - - scope - - - La portée courante du dessin. Peut être un objet, un document, &null;, - une page, un motif, un chemin, un modèle, un prolog, une police, un - glyphe. - - - - - ligaturedisolvechar - - - Le caractère qui détache une ligature. Lors de l'utilisation d'une police qui - contient une ligature `ff' et `|` est le caractère à détacher la - ligature, alors `f|f' donnera deux `f' au lieu de la ligature `ff'. - - - - - imageencoding - - - L'encodage utilisé pour encoder les images. Peut être soit - hex ou 85. L'encodage hex utilise - deux octets dans le fichier PostScript, chaque octet dans une image. - 85 représente l'encodage Ascii85. - - - - - linenumbermode - - - Fixe à paragraph si des lignes sont numérotées à - l'intérieur d'un paragraphe ou box si elles sont - numérotées dans une boîte qui l'entoure. - - - - - linebreak - - - Seulement utilisé si le texte est affiché avec - ps_show_boxed. Si fixé à &true;, un retour au - chariot ajoutera un saut de ligne. - - - - - parbreak - - - Seulement utilisé si le texte est affiché avec - ps_show_boxed. Si fixé à &true;, un retour au - chariot démarrera un nouveau paragraphe. - - - - - hyphenation - - - Seulement utilisé si le texte est affiché avec - ps_show_boxed. Si fixé à &true;, le paragraphe - sera divisé si un dictionnaire de trait d'union est fixé et existe. - - - - - hyphendict - - - Nom du fichier du dictionnaire utilisé pour le motif de trait d'union. - - - - - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - name - - - Nom du paramètre. - - - - - modifier - - - Un identifiant requis si le paramètre d'une ressource est requis, - par exemple, la taille d'une image. Dans ce cas, l'identifiant de la - ressource est passé. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur du paramètre &return.falseforfailure;. - - - - - &reftitle.seealso; - - - ps_set_parameter - - - - - - diff --git a/reference/ps/functions/ps-get-value.xml b/reference/ps/functions/ps-get-value.xml deleted file mode 100644 index f02f34223c..0000000000 --- a/reference/ps/functions/ps-get-value.xml +++ /dev/null @@ -1,333 +0,0 @@ - - - - - - - - ps_get_value - Récupère certaines valeurs - - - - &reftitle.description; - - floatps_get_value - resourcepsdoc - stringname - floatmodifier - - - Récupère plusieurs valeurs qui ont été fixées par - ps_set_value. Les valeurs sont par définition des - valeurs de &float;. - - - Le paramètre name peut avoir une des valeurs - suivantes. - - - - - fontsize - - - La taille de la police présentement active ou la police dont - l'identifiant est passé dans le paramètre - modifier. - - - - - font - - - La police présentement active en elle-même. - - - - - imagewidth - - - La largeur de l'image dont l'identifiant est passé dans le paramètre - modifier. - - - - - imageheight - - - La hauteur de l'image dont l'identifiant est passé dans le paramètre - modifier. - - - - - capheight - - - La hauteur d'une capitale M dans la police présentement active ou la - police dont l'identifiant est passé dans le paramètre - modifier. - - - - - ascender - - - La hampe de la police présentement active ou la police dont - l'identifiant est passé dans le paramètre - modifier. - - - - - descender - - - Le jambage de la police présentement active ou la police dont - l'identifiant est passé dans le paramètre - modifier. - - - - - italicangle - - - Le paramètre italicangle de la police présentement active ou la police - dont l'identifiant est passé dans le paramètre - modifier. - - - - - underlineposition - - - Le paramètre underlineposition de la police présentement active ou la - police dont l'identifiant est passé dans le paramètre - modifier. - - - - - underlinethickness - - - Le paramètre underlinethickness de la police présentement active ou la - police dont l'identifiant est passé dans le paramètre - modifier. - - - - - textx - - - La position x courante d'affichage du texte. - - - - - texty - - - La position y courante d'affichage du texte. - - - - - textrendering - - - Le mode courant pour le rendu du texte. - - - - - textrise - - - L'espace par lequel le texte est augmenté au-dessus de la ligne de - base. - - - - - leading - - - La distance entre les lignes de texte en points. - - - - - wordspacing - - - L'espace entre les mots en tant que multiple de la largeur d'un - caractère d'espace. - - - - - charspacing - - - L'espace entre les caractères. Si charspacing est != 0.0, les ligatures - seront toujours détachées. - - - - - hyphenminchars - - - Nombre minimal de caractères avant un trait d'union à la fin d'un mot. - - - - - parindent - - - L'indentation des premières n lignes dans un paragraphe. - - - - - numindentlines - - - Nombre de ligne dans un paragraphe à indenter si paraindent != 0.0. - - - - - parskip - - - Distance entre les paragraphes. - - - - - linenumberspace - - - Espace général en face de chaque ligne pour le numéro de ligne. - - - - - linenumbersep - - - Espace entre les lignes et les numéros de lignes. - - - - - major - - - Le numéro de version majeur de pslib. - - - - - minor - - - Le numéro de version mineur de pslib. - - - - - subminor, revision - - - Le numéro de version sous mineur de pslib. - - - - - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - name - - - Nom de la valeur. - - - - - modifier - - - Le paramètre modifier spécifie la ressource pour - laquelle la valeur sera récupérée. Cela peut être l'ID de la police ou - une image. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur du paramètre ou &false;. - - - - - &reftitle.seealso; - - - ps_set_value - - - - - - diff --git a/reference/ps/functions/ps-hyphenate.xml b/reference/ps/functions/ps-hyphenate.xml deleted file mode 100644 index 0c36f1b6c5..0000000000 --- a/reference/ps/functions/ps-hyphenate.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - ps_hyphenate - Effectue la césure d'un mot - - - - &reftitle.description; - - arrayfalseps_hyphenate - resourcepsdoc - stringtext - - - Effectue la césure du mot passé. ps_hyphenate évalue la valeur - hyphenminchars (fixé par ps_set_value) et le paramètre - hyphendict (fixé par ps_set_parameter). hyphendict doit - être fixé avant d'appeler cette fonction. - - - Cette fonction requiert que la configuration locale LC_CTYPE soit - correctement faite. Cela est fait lorsque l'extension est initialisée en - utilisant les variables d'environnement. Sur les systèmes Unix, lisez les - pages de manuel de locale pour plus d'informations. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - text - - - text ne devrait pas contenir de caractères non - alpha. Les positions possibles pour les coupures sont retournées dans un - tableau de nombre entier. Chaque nombre est la position du caractère - dans text après lequel une césure peut avoir lieu. - - - - - - - - - &reftitle.returnvalues; - - Un tableau d'entiers indiquant la position des coupures possibles dans le - texte &return.falseforfailure;. - - - - - &reftitle.examples; - - - Coupe un texte - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - - ps_show_boxed - locale(1) - - - - - - - diff --git a/reference/ps/functions/ps-include-file.xml b/reference/ps/functions/ps-include-file.xml deleted file mode 100644 index f65752c7b6..0000000000 --- a/reference/ps/functions/ps-include-file.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - ps_include_file - Lit un fichier externe avec du code PostScript brut - - - - &reftitle.description; - - boolps_include_file - resourcepsdoc - stringfile - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant de ressource du fichier postscript, - tel que retourné par la fonction - ps_new. - - - - - file - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ps/functions/ps-lineto.xml b/reference/ps/functions/ps-lineto.xml deleted file mode 100644 index 83c1a21140..0000000000 --- a/reference/ps/functions/ps-lineto.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - ps_lineto - Dessine une ligne - - - - &reftitle.description; - - boolps_lineto - resourcepsdoc - floatx - floaty - - - Ajoute une ligne droite à partir du point courant aux coordonnées données au - chemin courant. Utiliser ps_moveto pour fixer le point - de départ de la ligne. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - x - - - La position x du dernier point de la ligne. - - - - - y - - - La position y du dernier point de la ligne. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Dessin d'un rectangle - - -]]> - - - - - - - &reftitle.seealso; - - - ps_moveto - - - - - - - diff --git a/reference/ps/functions/ps-makespotcolor.xml b/reference/ps/functions/ps-makespotcolor.xml deleted file mode 100644 index 92b3a7ef56..0000000000 --- a/reference/ps/functions/ps-makespotcolor.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - - ps_makespotcolor - Crée une tache de couleur - - - - &reftitle.description; - - intps_makespotcolor - resourcepsdoc - stringname - intreserved0 - - - Crée une tache de couleur à partir de la couleur de remplissage courante. - La couleur de remplissage doit être définie en espace colorimétrique rgb, - cmyk ou gris. Le nom de la tache de couleur peut être un nom arbitraire. - Une tache de couleur peut être fixée à n'importe quelle couleur avec - ps_setcolor. Lorsque le document n'est pas imprimé, - mais est affiché par un visualisateur PostScript, la couleur donnée dans - l'espace de couleur spécifié est utilisée. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - name - - - Nom de la tache de couleur, par exemple Pantone 5565. - - - - - - - - - &reftitle.returnvalues; - - L'ID de la nouvelle tache de couleur ou &zero; en cas d'erreur. - - - - - &reftitle.examples; - - - Création et utilisation d'une tache de couleur - - -]]> - - - Cet exemple crée une tache de couleur "PANTONE 5565 C" qui est un vert - foncé (olive) et remplit un rectangle avec une intensité de 50%. - - - - - - - &reftitle.seealso; - - - ps_setcolor - - - - - - - diff --git a/reference/ps/functions/ps-moveto.xml b/reference/ps/functions/ps-moveto.xml deleted file mode 100644 index 4a17563f03..0000000000 --- a/reference/ps/functions/ps-moveto.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - ps_moveto - Fixe le point courant - - - - &reftitle.description; - - boolps_moveto - resourcepsdoc - floatx - floaty - - - Fixe le point courant à de nouvelles coordonnées. Si cela est le premier - appel de ps_moveto après qu'un chemin précédent ait - été terminé alors il démarrera un nouveau chemin. Si cette fonction est - appelée au milieu d'un chemin, elle fixera simplement le point courant et - débutera un sous chemin. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - x - - - La position x du point où se déplacer. - - - - - y - - - La position y du point où se déplacer. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_lineto - - - - - - - diff --git a/reference/ps/functions/ps-new.xml b/reference/ps/functions/ps-new.xml deleted file mode 100644 index 9a56006504..0000000000 --- a/reference/ps/functions/ps-new.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ps_new - Crée un nouvel objet document PostScript - - - - &reftitle.description; - - resourcefalseps_new - - - - Crée une nouvelle instance de document. Elle ne crée pas le fichier sur le - disque ou dans la mémoire. Elle prépare simplement tout. - ps_new est normalement suivie par un appel de - ps_open_file pour créer le document PostScript. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Ressource d'un document PostScript&return.falseforfailure;. La valeur de - retour est passée à toutes les autres fonctions en tant que premier - argument. - - - - - &reftitle.seealso; - - - ps_delete - - - - - - - diff --git a/reference/ps/functions/ps-open-file.xml b/reference/ps/functions/ps-open-file.xml deleted file mode 100644 index 5e285331d0..0000000000 --- a/reference/ps/functions/ps-open-file.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - ps_open_file - Ouvre un fichier pour écriture - - - - &reftitle.description; - - boolps_open_file - resourcepsdoc - stringfilename - - - Crée un nouveau fichier sur le disque et écrit le document PostScript à - l'intérieur. Le fichier sera fermé lorsque ps_close - sera appelée. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - filename - - - Le nom du fichier PostScript. - Si filename n'est pas passé, le document sera - créé en mémoire et toutes les écritures iront directement au navigateur. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_close - - - - - - - diff --git a/reference/ps/functions/ps-open-image-file.xml b/reference/ps/functions/ps-open-image-file.xml deleted file mode 100644 index 146715f16f..0000000000 --- a/reference/ps/functions/ps-open-image-file.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - ps_open_image_file - Ouvre une image à partir d'un fichier - - - - &reftitle.description; - - intps_open_image_file - resourcepsdoc - stringtype - stringfilename - stringstringparam - intintparam0 - - - Charge une image pour une utilisation ultérieure. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - type - - - Type de l'image. Les valeurs possibles sont png, - jpeg ou eps. - - - - - filename - - - Le nom du fichier contenant les données de l'image. - - - - - stringparam - - - Non utilisé. - - - - - intparam - - - Non utilisé. - - - - - - - - - &reftitle.returnvalues; - - Retourne un identifiant de l'image ou zéro en cas d'erreur. L'identifiant - est un nombre positif plus grand que &zero;. - - - - - &reftitle.seealso; - - - ps_open_image - ps_place_image - ps_close_image - - - - - - - diff --git a/reference/ps/functions/ps-open-image.xml b/reference/ps/functions/ps-open-image.xml deleted file mode 100644 index 63fa70f277..0000000000 --- a/reference/ps/functions/ps-open-image.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - - ps_open_image - Lit une image pour placement futur - - - - &reftitle.description; - - intps_open_image - resourcepsdoc - stringtype - stringsource - stringdata - intlength - intwidth - intheight - intcomponents - intbpc - stringparams - - - Lit une image qui est déjà disponible en mémoire. Le paramètre - source n'est présentement pas évalué et est supposé - être memory. Les données de l'image sont une séquence - de pixels démarrant avec le coin supérieur gauche et se terminant avec le coin - inférieur droit. Chaque pixel consiste de composants de couleur - components et chaque composant a - bpc bits. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - type - - - Type de l'image. Les valeurs possibles sont png, - jpeg ou eps. - - - - - source - - - Non utilisé. - - - - - data - - - Les données de l'image. - - - - - length - - - La taille des données de l'image. - - - - - width - - - La largeur de l'image. - - - - - height - - - La hauteur de l'image. - - - - - components - - - Le nombre de composant pour chaque pixel. Cela peut être 1 (images à - échelle de gris), 3 (images rgb) ou 4 (images cmyk, rgba). - - - - - bpc - - - Nombre de bits par composant (très souvent 8). - - - - - params - - - - - - - - - - - &reftitle.returnvalues; - - Retourne l'identifiant de l'image ou zéro en cas d'erreur. L'identifiant - est un nombre positif supérieur à &zero;. - - - - - &reftitle.seealso; - - - ps_open_image_file - ps_place_image - ps_close_image - - - - - - - - diff --git a/reference/ps/functions/ps-open-memory-image.xml b/reference/ps/functions/ps-open-memory-image.xml deleted file mode 100644 index 4ef61dc0f5..0000000000 --- a/reference/ps/functions/ps-open-memory-image.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - ps_open_memory_image - Prend une image GD et retourne une image à placer dans un document PS - - - - &reftitle.description; - - intps_open_memory_image - resourcepsdoc - intgd - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant de ressource du fichier postscript, - tel que retourné par la fonction - ps_new. - - - - - gd - - - - - - - - - - - - diff --git a/reference/ps/functions/ps-place-image.xml b/reference/ps/functions/ps-place-image.xml deleted file mode 100644 index acacbdc83a..0000000000 --- a/reference/ps/functions/ps-place-image.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - ps_place_image - Place une image sur la page - - - - &reftitle.description; - - boolps_place_image - resourcepsdoc - intimageid - floatx - floaty - floatscale - - - Place une image précédemment chargée sur la page. L'image peut être - redimensionnée. - Si l'image est tournée, il faudra tourner le système de coordonnées avant - avec ps_rotate. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant de ressource PostScript, tel que - retourné par ps_new. - - - - - imageid - - - Identifiant d'un fichier postscript retourné par - ps_open_image ou - ps_open_image_file. - - - - - x - - - La position x du coin inférieur gauche de l'image. - - - - - y - - - La position y du coin inférieur gauche de l'image. - - - - - scale - - - Le facteur de redimensionnement pour l'image. Un redimensionnement de - 1.0 donnera une résolution de 72 dpi, parce que chaque pixel est - équivalent à 1 point. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_open_image - ps_open_image_file - - - - - - - diff --git a/reference/ps/functions/ps-rect.xml b/reference/ps/functions/ps-rect.xml deleted file mode 100644 index c96a92da07..0000000000 --- a/reference/ps/functions/ps-rect.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - ps_rect - Dessine un rectangle - - - - &reftitle.description; - - boolps_rect - resourcepsdoc - floatx - floaty - floatwidth - floatheight - - - Dessine un rectangle avec son coin inférieur gauche à (x, - y). Le rectangle débute et termine sur son coin - inférieur gauche. Si cette fonction est appelée à l'extérieur d'un chemin, elle - démarrera un nouveau chemin. Si elle est appelée à l'intérieur d'un chemin, - elle ajoutera le rectangle comme étant un sous chemin. Si la dernière - opération de dessin ne se termine pas au coin inférieur gauche alors il y aura - un trou dans le chemin. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - x - - - La position x du coin inférieur gauche du rectangle. - - - - - y - - - La position y du coin inférieur gauche du rectangle. - - - - - width - - - La largeur de l'image. - - - - - height - - - La hauteur de l'image. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_arc - ps_circle - ps_lineto - - - - - - - diff --git a/reference/ps/functions/ps-restore.xml b/reference/ps/functions/ps-restore.xml deleted file mode 100644 index 8f3748776f..0000000000 --- a/reference/ps/functions/ps-restore.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - ps_restore - Restaure un contexte précédemment sauvegardé - - - - &reftitle.description; - - boolps_restore - resourcepsdoc - - - Restaure un contexte graphique précédemment sauvegardé. Tout appel de - ps_save doit être accompagné par un appel à - ps_restore. Toutes les transformations de coordonnée, - de configurations de style de ligne, de couleur, etc. sont restaurées à - l'état avant l'appel de la fonction ps_save. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_save - - - - - - - diff --git a/reference/ps/functions/ps-rotate.xml b/reference/ps/functions/ps-rotate.xml deleted file mode 100644 index 6306f7383d..0000000000 --- a/reference/ps/functions/ps-rotate.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - - - ps_rotate - Fixe le facteur de rotation - - - - &reftitle.description; - - boolps_rotate - resourcepsdoc - floatrot - - - Fixe la rotation d'un système de coordonnées. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - rot - - - Angle de rotation en degrés. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Rotation d'un système de coordonnées - - -]]> - - - L'exemple ci-dessus illustre un moyen commun d'effectuer une rotation - d'un graphique (dans ce cas, simplement un rectangle) simplement en - effectuant la rotation du système de coordonnées. Puisque le système de - coordonnées du graphique assume que l'origine est à (0, 0), le système de - coordonnées de la page est aussi translaté pour ne pas placer le graphique - sur les bord de la page. Portez attention à l'ordre de - ps_translate et ps_rotate. Dans - l'exemple ci-dessus, le rectangle subit une rotation au point (100, 100) - dans le système de coordonnées non translaté. Inverser les deux requêtes - aura un effet complètement différent. - - - Afin d'afficher le texte suivant dans sa position originale, toutes les - modifications du système de coordonnées sont encapsulées dans - ps_save et ps_restore. - - - - - - - &reftitle.seealso; - - - ps_scale - ps_translate - - - - - - - diff --git a/reference/ps/functions/ps-save.xml b/reference/ps/functions/ps-save.xml deleted file mode 100644 index 0fe85fa826..0000000000 --- a/reference/ps/functions/ps-save.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ps_save - Sauvegarde le contexte courant - - - - &reftitle.description; - - boolps_save - resourcepsdoc - - - Sauvegarde le contexte graphique courant, contenant les configurations des couleurs, - des translations et rotations et quelques autres. Un contexte sauvegardé - peut être restauré avec ps_restore. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_restore - - - - - - - diff --git a/reference/ps/functions/ps-scale.xml b/reference/ps/functions/ps-scale.xml deleted file mode 100644 index b5fdf6bddb..0000000000 --- a/reference/ps/functions/ps-scale.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - ps_scale - Fixe le facteur de redimensionnement - - - - &reftitle.description; - - boolps_scale - resourcepsdoc - floatx - floaty - - - Fixe le redimensionnement horizontal et vertical d'un système de - coordonnées. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - x - - - Facteur de redimensionnement en direction horizontale. - - - - - y - - - Facteur de redimensionnement en direction verticale. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_rotate - ps_translate - - - - - - - diff --git a/reference/ps/functions/ps-set-border-color.xml b/reference/ps/functions/ps-set-border-color.xml deleted file mode 100644 index af1acfc59f..0000000000 --- a/reference/ps/functions/ps-set-border-color.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - ps_set_border_color - Fixe la couleur des bordures pour les commentaires - - - - &reftitle.description; - - boolps_set_border_color - resourcepsdoc - floatred - floatgreen - floatblue - - - Les liens ajoutés avec une des fonctions telles que - ps_add_weblink, ps_add_pdflink, - etc. seront affichées avec un rectangle entouré lorsque le document - postscript est converti en PDF et vu dans un visualisateur PDF. Ce - rectangle n'est pas visible dans le document postscript. - Cette fonction fixe la couleur de la bordure de la ligne du rectangle. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - red - - - Le composant rouge de la couleur de la bordure. - - - - - green - - - Le composant vert de la couleur de la bordure. - - - - - blue - - - Le composant bleu de la couleur de la bordure. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_set_border_dash - ps_set_border_style - - - - - - - diff --git a/reference/ps/functions/ps-set-border-dash.xml b/reference/ps/functions/ps-set-border-dash.xml deleted file mode 100644 index 8f9e91865a..0000000000 --- a/reference/ps/functions/ps-set-border-dash.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - ps_set_border_dash - Fixe la grandeur des tirets pour les bordures des commentaires - - - - &reftitle.description; - - boolps_set_border_dash - resourcepsdoc - floatblack - floatwhite - - - Les liens ajoutés avec une des fonctions telles que - ps_add_weblink, ps_add_pdflink, - etc. seront affichées avec un rectangle entouré lorsque le document - postscript est converti en pdf et vu dans un visualisateur pdf. Ce - rectangle n'est pas visible dans le document postscript. - Cette fonction fixe la grandeur de la portion de noir et blanc de la ligne de - bordure pointillée. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - black - - - La grandeur des pointillés. - - - - - white - - - La grandeur de l'espace entre les pointillés. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_set_border_color - ps_set_border_style - - - - - - - diff --git a/reference/ps/functions/ps-set-border-style.xml b/reference/ps/functions/ps-set-border-style.xml deleted file mode 100644 index a800b8d9d7..0000000000 --- a/reference/ps/functions/ps-set-border-style.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - ps_set_border_style - Fixe le style de bordure des commentaires - - - - &reftitle.description; - - boolps_set_border_style - resourcepsdoc - stringstyle - floatwidth - - - Les liens ajoutés avec une des fonctions telles que - ps_add_weblink, ps_add_pdflink, - etc. seront affichées avec un rectangle entouré lorsque le document - postscript est converti en PDF et vu dans un visualisateur PDF. Ce - rectangle n'est pas visible dans le document postscript. - Cette fonction fixe l'apparence et la largeur de la ligne de bordure. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - style - - - style peut être solid ou - dashed. - - - - - width - - - La largeur de la bordure. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_set_border_color - ps_set_border_dash - - - - - - - diff --git a/reference/ps/functions/ps-set-info.xml b/reference/ps/functions/ps-set-info.xml deleted file mode 100644 index 32db44c3bd..0000000000 --- a/reference/ps/functions/ps-set-info.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - - ps_set_info - Assigne les champs d'informations d'un document - - - - &reftitle.description; - - boolps_set_info - resourcepsdoc - stringkey - stringvalue - - - ps_set_info fixe certains champs d'informations du document. - Les champs seront montrés en tant que commentaire dans l'en-tête du fichier - PostScript. Si le document est converti en PDF, ces champs seront aussi - utilisés pour les informations du document. - - - Le BoundingBox est normalement fixé à la valeur donnée - par la première page. Cela fonctionne seulement si - ps_findfont n'a pas été appelée auparavant. Dans ces - cas, le BoundingBox sera laissé non fixé à moins que l'on le fixe - explicitement avec cette fonction. - - - Cette fonction n'aura plus d'effet lorsque l'en-tête du fichier PostScript - a déjà été écrit. Elle doit être appelée avant la première page ou le - premier appel de ps_findfont. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant de ressource PostScript, - retourné par ps_new. - - - - - key - - - Le nom du champ d'information à configurer. Les valeurs de noms - possibles sont Keywords, Subject, - Title, Creator, - Author, BoundingBox et - Orientation. Soyez attentifs, car certains champs - ont des significations spéciales pour les lecteurs PostScript. - - - - - value - - - Les valeurs du champ d'information. Le champ - Orientation peut être fixé à soit - Portrait ou Landscape. Le - BoundingBox est une &string; contenant quatre - nombres. Les deux premiers sont les coordonnées du coin inférieur - gauche de la page. Les deux derniers sont les coordonnées du coin - supérieur droit. - - - - Jusqu'à la version 0.2.6 de pslib, le BoundingBox et Orientation - seront toujours écrasés par ps_begin_page, à - moins que ps_findfont ait été appelée avant. - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_findfont - ps_begin_page - - - - - - - diff --git a/reference/ps/functions/ps-set-parameter.xml b/reference/ps/functions/ps-set-parameter.xml deleted file mode 100644 index 78351f3892..0000000000 --- a/reference/ps/functions/ps-set-parameter.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - ps_set_parameter - Fixe certains paramètres - - - - &reftitle.description; - - boolps_set_parameter - resourcepsdoc - stringname - stringvalue - - - Fixe plusieurs paramètres qui sont utilisés par beaucoup de fonctions. Les - paramètres sont par définition des valeurs de &string;. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - name - - - Pour une liste des noms possibles, voir - ps_get_parameter. - - - - - value - - - La valeur du paramètre. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_get_parameters - ps_set_value - - - - - - - diff --git a/reference/ps/functions/ps-set-text-pos.xml b/reference/ps/functions/ps-set-text-pos.xml deleted file mode 100644 index 0d046568e7..0000000000 --- a/reference/ps/functions/ps-set-text-pos.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - - ps_set_text_pos - Fixe la position de l'écriture du texte - - - - &reftitle.description; - - boolps_set_text_pos - resourcepsdoc - floatx - floaty - - - Fixe la position pour la prochaine écriture de texte. Il est recommandé - d'alternativement fixer la valeur x et y séparément en appelant - ps_set_value et choisir textx - respectivement texty comme nom de valeur. - - - Pour afficher le texte à une certaine position, il est plus - facile d'utiliser ps_show_xy au lieu de configurer la - position du texte et d'appeler ps_show. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - x - - - La position x de la nouvelle position du texte. - - - - - y - - - La position y de la nouvelle position du texte. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Placement de texte à une position donnée - - -]]> - - - - - - - &reftitle.seealso; - - - ps_set_value - ps_show - - - - - - - diff --git a/reference/ps/functions/ps-set-value.xml b/reference/ps/functions/ps-set-value.xml deleted file mode 100644 index ce575c1bae..0000000000 --- a/reference/ps/functions/ps-set-value.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - - ps_set_value - Fixe certaines valeurs - - - - &reftitle.description; - - boolps_set_value - resourcepsdoc - stringname - floatvalue - - - Fixe plusieurs valeurs qui sont utilisées par beaucoup de fonctions. Les - paramètres sont par définition des valeurs de &float;. - - - - - &reftitle.parameters; - - Le nom name peut être un des paramètres suivants : - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - name - - - Le paramètre name peut être une des valeurs suivantes : - - - textrendering - - - Le moyen comme est montré le texte. - - - - - textx - - - La position de coordonnées x pour afficher le texte. - - - - - texty - - - La position de coordonnées y pour afficher le texte. - - - - - wordspacing - - - La distance entre les mots relativement à la largeur des espaces. - - - - - leading - - - La distance entre les lignes en pixels. - - - - - - - - - value - - - La valeur du paramètre. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_get_value - ps_set_parameter - - - - - - - diff --git a/reference/ps/functions/ps-setcolor.xml b/reference/ps/functions/ps-setcolor.xml deleted file mode 100644 index d75f54ab06..0000000000 --- a/reference/ps/functions/ps-setcolor.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - - ps_setcolor - Fixe la couleur courante - - - - &reftitle.description; - - boolps_setcolor - resourcepsdoc - stringtype - stringcolorspace - floatc1 - floatc2 - floatc3 - floatc4 - - - Fixe la couleur pour le dessin, remplissage ou les deux. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - type - - - Le paramètre type peut être - both, fill ou - fillstroke. - - - - - colorspace - - - L'espace colorimétrique peut être soit gray, - rgb, cmyk, - spot, pattern. Dépendamment de - l'espace colorimétrique soit le premier, les trois premiers ou tous les - paramètres peuvent être utilisés. - - - - - c1 - - - Dépendamment de l'espace colorimétrique, cette valeur peut être le - composant rouge (rgb), le composant cyan (cmyk), la valeur de gris - (gris), l'identifiant de la tache de couleur ou l'identifiant du motif. - - - - - c2 - - - Dépendamment de l'espace colorimétrique, cette valeur peut être le - composant vert (rgb) ou le composant magenta (cmyk). - - - - - c3 - - - Dépendamment de l'espace colorimétrique, cette valeur peut être le - composant bleu (rgb) ou le composant jaune (cmyk). - - - - - c4 - - - Ce paramètre doit être fixé seulement dans l'espace colorimétrique cmyk - et spécifie le composant noir. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - - - Le second paramètre n'est actuellement pas toujours évalué. La couleur est - parfois fixée pour remplir et dessiner juste comme - fillstroke était passée. - - - - - - - diff --git a/reference/ps/functions/ps-setdash.xml b/reference/ps/functions/ps-setdash.xml deleted file mode 100644 index f5430b9b6e..0000000000 --- a/reference/ps/functions/ps-setdash.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - ps_setdash - Fixe l'apparence d'une ligne pointillée - - - - &reftitle.description; - - boolps_setdash - resourcepsdoc - floaton - floatoff - - - Fixe la longueur des portions de noir et blanc d'une ligne pointillée. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - on - - - La grandeur des pointillés. - - - - - off - - - La grandeur des espaces entres les pointillés. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setpolydash - - - - - - - diff --git a/reference/ps/functions/ps-setflat.xml b/reference/ps/functions/ps-setflat.xml deleted file mode 100644 index 3b73345736..0000000000 --- a/reference/ps/functions/ps-setflat.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - ps_setflat - Fixe la planéité - - - - &reftitle.description; - - boolps_setflat - resourcepsdoc - floatvalue - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - value - - - La valeur value doit être entre 0.2 et 1. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ps/functions/ps-setfont.xml b/reference/ps/functions/ps-setfont.xml deleted file mode 100644 index d2f2c6499f..0000000000 --- a/reference/ps/functions/ps-setfont.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - ps_setfont - Fixe la police à utiliser pour la prochaine écriture - - - - &reftitle.description; - - boolps_setfont - resourcepsdoc - intfontid - floatsize - - - Fixe une police, qui doit être chargée avant avec - ps_findfont. L'écriture de texte sans configurer - une police provoquera une erreur. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - fontid - - - L'identifiant de la police retourné par - ps_findfont. - - - - - size - - - La taille de la police. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_findfont - ps_set_text_pos pour un exemple. - - - - - - - diff --git a/reference/ps/functions/ps-setgray.xml b/reference/ps/functions/ps-setgray.xml deleted file mode 100644 index 4862362d25..0000000000 --- a/reference/ps/functions/ps-setgray.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - ps_setgray - Fixe la valeur de gris - - - - &reftitle.description; - - boolps_setgray - resourcepsdoc - floatgray - - - Fixe la valeur de gris pour toutes les opérations de dessin suivantes. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - gray - - - La valeur doit être entre 0 (blanc) et 1 (noir). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setcolor - - - - - - - diff --git a/reference/ps/functions/ps-setlinecap.xml b/reference/ps/functions/ps-setlinecap.xml deleted file mode 100644 index 74cbab43b7..0000000000 --- a/reference/ps/functions/ps-setlinecap.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - ps_setlinecap - Fixe l'apparence des fins de ligne - - - - &reftitle.description; - - boolps_setlinecap - resourcepsdoc - inttype - - - Fixe comment les fins de ligne ressemblent. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - type - - - Le type de fin de ligne. Les valeurs possibles sont - PS_LINECAP_BUTT, - PS_LINECAP_ROUND ou - PS_LINECAP_SQUARED. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setlinejoin - ps_setlinewidth - ps_setmiterlimit - - - - - - - diff --git a/reference/ps/functions/ps-setlinejoin.xml b/reference/ps/functions/ps-setlinejoin.xml deleted file mode 100644 index effbbecf8b..0000000000 --- a/reference/ps/functions/ps-setlinejoin.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - ps_setlinejoin - Fixe comment les lignes connectées sont jointes - - - - &reftitle.description; - - boolps_setlinejoin - resourcepsdoc - inttype - - - Fixe comment les lignes sont jointes. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - type - - - Le moyen comment les lignes sont jointes. Les valeurs possibles sont - PS_LINEJOIN_MITER, - PS_LINEJOIN_ROUND ou - PS_LINEJOIN_BEVEL. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setlinecap - ps_setlinewidth - ps_setmiterlimit - - - - - - - diff --git a/reference/ps/functions/ps-setlinewidth.xml b/reference/ps/functions/ps-setlinewidth.xml deleted file mode 100644 index df2eb31b47..0000000000 --- a/reference/ps/functions/ps-setlinewidth.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - ps_setlinewidth - Fixe la largeur d'une ligne - - - - &reftitle.description; - - boolps_setlinewidth - resourcepsdoc - floatwidth - - - Fixe la largeur d'une ligne pour toutes les opérations de dessin suivantes. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - width - - - La largeur des lignes en points. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setlinecap - ps_setlinejoin - ps_setmiterlimit - - - - - - - diff --git a/reference/ps/functions/ps-setmiterlimit.xml b/reference/ps/functions/ps-setmiterlimit.xml deleted file mode 100644 index a95ac12f92..0000000000 --- a/reference/ps/functions/ps-setmiterlimit.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - ps_setmiterlimit - Fixe les limites de l'anglet - - - - &reftitle.description; - - boolps_setmiterlimit - resourcepsdoc - floatvalue - - - Si deux lignes se joignent dans un petit angle et le joint des lignes est - fixé à l'anglet PS_LINEJOIN_MITER, alors la mèche - résultante sera vraiment longue. La limite de l'anglet est le ratio maximal - de la longueur de l'anglet (la longueur de la mèche) et la largeur de la ligne. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - value - - - Le ratio maximal entre la grandeur de l'anglet et la largeur de la - ligne. De grandes valeurs (> 10) auront pour effet l'affichage de - très longues mèches lorsque deux lignes se joignent dans un petit - angle. Gardez le par défaut à moins que l'on sache ce que l'on fait. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setlinecap - ps_setlinejoin - ps_setlinewidth - - - - - - - diff --git a/reference/ps/functions/ps-setoverprintmode.xml b/reference/ps/functions/ps-setoverprintmode.xml deleted file mode 100644 index 210b53eca0..0000000000 --- a/reference/ps/functions/ps-setoverprintmode.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - ps_setoverprintmode - Définit le mode "overprint" - - - - &reftitle.description; - - boolps_setoverprintmode - resourcepsdoc - intmode - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant de ressource du fichier postscript, - tel que retourné par la fonction - ps_new. - - - - - mode - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ps/functions/ps-setpolydash.xml b/reference/ps/functions/ps-setpolydash.xml deleted file mode 100644 index 5356190e70..0000000000 --- a/reference/ps/functions/ps-setpolydash.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - ps_setpolydash - Fixe l'apparence d'une ligne pointillée - - - - &reftitle.description; - - boolps_setpolydash - resourcepsdoc - floatarr - - - Fixe la longueur des portions de noir et blanc d'une ligne pointillée. - ps_setpolydash est utilisée pour fixer des motifs - pointillés plus compliqués. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - arr - - - arr est une liste des grandeurs des éléments - alternativement pour la portion de noir et de blanc. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Dessin d'une ligne pointillée - - -]]> - - - Cet exemple dessine une ligne avec un point de 10 et de 2 en ligne et - des espaces de 5 points entre chacun des points. - - - - - - - &reftitle.seealso; - - - ps_setdash - - - - - - - diff --git a/reference/ps/functions/ps-shading-pattern.xml b/reference/ps/functions/ps-shading-pattern.xml deleted file mode 100644 index b58e4f40d5..0000000000 --- a/reference/ps/functions/ps-shading-pattern.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - ps_shading_pattern - Crée un motif basé sur le ton - - - - &reftitle.description; - - intfalseps_shading_pattern - resourcepsdoc - intshadingid - stringoptlist - - - Crée un motif basé sur le ton, qui doit avoir été créé avant avec - ps_shading. Les motifs de ton peuvent être utilisés - comme des motifs réguliers. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - shadingid - - - L'identifiant de ton créé précédemment avec - ps_shading. - - - - - optlist - - - Cet argument n'est pas utilisé présentement. - - - - - - - - - &reftitle.returnvalues; - - L'identifiant du motif &return.falseforfailure;. - - - - - &reftitle.seealso; - - - ps_shading - ps_shfill - - - - - - - diff --git a/reference/ps/functions/ps-shading.xml b/reference/ps/functions/ps-shading.xml deleted file mode 100644 index a9da086538..0000000000 --- a/reference/ps/functions/ps-shading.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - - ps_shading - Crée un ton pour usage futur - - - - &reftitle.description; - - intfalseps_shading - resourcepsdoc - stringtype - floatx0 - floaty0 - floatx1 - floaty1 - floatc1 - floatc2 - floatc3 - floatc4 - stringoptlist - - - Crée un ton, qui peut être utilisé par ps_shfill ou - ps_shading_pattern. - - - La couleur du ton peut être dans n'importe quel espace de couleur excepté pour - pattern. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - type - - - Le type de ton peut être soit radial ou - axial. Chaque ton débute avec la couleur courante de - remplissage et termine avec la valeur de couleur donnée passée dans les - paramètres c1 à c4 - (voir ps_setcolor pour leur signification). - - - - - x0, x1, y0, y1 - - - Les coordonnées x0, y0, - x1, y1 sont le point de début et - de fin du ton. Si le type de ton est radial, les - deux points sont les points milieux du début et de la fin du cercle. - - - - - c1, c2, c3, c4 - - - Voir ps_setcolor pour leur signification. - - - - - optlist - - - Si le ton est de type radial, le - optlist doit aussi contenir les paramètres - r0 et r1 avec le radius du début - et de fin du cercle. - - - - - - - - - &reftitle.returnvalues; - - Retourne un identifiant du motif &return.falseforfailure;. - - - - - &reftitle.seealso; - - - ps_shading_pattern - ps_shfill - - - - - - - diff --git a/reference/ps/functions/ps-shfill.xml b/reference/ps/functions/ps-shfill.xml deleted file mode 100644 index a74a6e32cc..0000000000 --- a/reference/ps/functions/ps-shfill.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - ps_shfill - Remplit un espace avec un ton - - - - &reftitle.description; - - boolps_shfill - resourcepsdoc - intshadingid - - - Remplit un espace avec un ton, qui doit être créé avant avec - ps_shading. Ceci est un moyen alternatif pour créer un - motif à partir d'un ton venant de ps_shading_pattern - et d'utiliser le motif comme couleur de remplissage. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - shadingid - - - L'identifiant de ton créé précédemment avec - ps_shading. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_shading - ps_shading_pattern - - - - - - - diff --git a/reference/ps/functions/ps-show-boxed.xml b/reference/ps/functions/ps-show-boxed.xml deleted file mode 100644 index 1dcc0a73b4..0000000000 --- a/reference/ps/functions/ps-show-boxed.xml +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - - - ps_show_boxed - Écriture de texte dans une boîte - - - - &reftitle.description; - - intps_show_boxed - resourcepsdoc - stringtext - floatleft - floatbottom - floatwidth - floatheight - stringhmode - stringfeature - - - ps_show_boxed écrit du texte dans une boîte donnée. - Le coin inférieur gauche de la boîte est à (left, - bottom). Les coupures de ligne seront insérées où - nécessaire. Les espaces multiples sont traités comme un seul. Les - tabulations sont traitées comme des espaces. - - - Le texte sera coupé si le paramètre hyphenation est - fixé à &true; et le paramètre hyphendict contient - un fichier valide de dictionnaire de césure. L'espacement des lignes est pris - à partir de la valeur leading. Les paragraphes - peuvent être séparés par une ligne vide comme dans TeX. Si la valeur - parindent est fixée à une valeur > 0.0, alors - les premières n lignes seront indentées. Le nombre n de lignes est fixé - par le paramètre numindentlines. Afin de prévenir - l'indentation des premiers m paragraphes, fixez la valeur - parindentskip à un nombre positif. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier PostScript retourné par - ps_new. - - - - - text - - - Le texte à afficher dans la boîte donnée. - - - - - left - - - La position x du coin inférieur gauche de la boîte. - - - - - bottom - - - La position y du coin inférieur gauche de la boîte. - - - - - width - - - Largeur de la boîte. - - - - - height - - - Hauteur de la boîte. - - - - - hmode - - - Le paramètre hmode peut être - justify, fulljustify, - right, left, - ou center. La différence entre - justify et fulljustify affecte - simplement la dernière ligne de la boîte. - Dans le mode fulljustify, la dernière ligne sera - justifiée de gauche à droite à moins que ce soit aussi la dernière - ligne du paragraphe. Dans le mode "justify", - le texte sera toujours justifié à gauche. - - - - - feature - - - - - - - - - - - Paramètres utilisés - - L'écriture de ps_show_boxed peut être configurée avec - plusieurs paramètres et valeurs qui peuvent être fixés par - ps_set_parameter ou ps_set_value. - En plus des paramètres et des valeurs qui affectent l'écriture du texte, les - paramètres et les valeurs suivants sont évalués. - - - leading (valeur) - - - Distance entre les lignes de bases de deux lignes consécutives. - - - - - linebreak (paramètre) - - - Fixé à &true; pour un retour au chariot pour démarrer une - nouvelle ligne plutôt que de traiter cela comme un espace. Par défaut, - ce paramètre vaut &false;. - - - - - parbreak (paramètre) - - - Fixé à &true; pour un retour au chariot d'une seule ligne - pour débuter un nouveau paragraphe plutôt que de traiter cela comme un - espace. Par défaut, ce paramètre vaut &true;. - - - - - hyphenation (paramètre) - - - Fixé à &true; afin d'activer la césure. Cela requiert un - dictionnaire fixé par le paramètre hyphendict. Par défaut, ce - paramètre vaut &false;. - - - - - hyphendict (paramètre) - - - Fichier du dictionnaire utilisé pour les motifs de césure (voir plus - bas). - - - - - hyphenminchar (valeur) - - - Le nombre de caractères qui doivent au moins rester avant ou - après le tiret. Cela implique que seuls les mots d'au moins deux fois - cette valeur peuvent être coupés. La valeur par défaut est trois. Fixer - une valeur de zéro résultera en la valeur par défaut. - - - - - parindent (valeur) - - - Fixe le nombre d'espaces en pixels pour l'indentation des premières m - lignes d'un paragraphe. m peut être configuré avec la valeur - numindentlines. - - - - - parskip (valeur) - - - Fixe le nombre d'espace supplémentaire en pixels entre les paragraphes. Par - défaut, 0, ce qui résulte en une distance normale - entre les lignes. - - - - - numindentlines (valeur) - - - Nombre de lignes à partir du début du paragraphe qui seront indentées. - Par défaut, cette valeur vaut 1. - - - - - parindentskip (valeur) - - - Nombre de paragraphes dans la boîte dont les premières lignes ne - seront pas indentées. Par défaut, cette valeur vaut 0. Cela est utile - pour les paragraphes immédiatement après une section d'en-tête ou du - texte qui commence dans une seconde boîte. Dans les deux cas, cette valeur devrait - être fixée à 1. - - - - - linenumbermode (paramètre) - - - Fixe comment les lignes sont numérotées. Les valeurs possibles sont - box pour numéroter les lignes dans la boîte au - complet ou paragraph pour numéroter les lignes - dans chaque paragraphe. - - - - - linenumberspace (valeur) - - - L'espace pour la colonne à gauche des lignes numérotées contenant le - numéro de ligne. Le numéro de ligne sera justifié à droite dans cette - colonne. Par défaut, cette valeur vaut 20. - - - - - linenumbersep (valeur) - - - L'espace entre la colonne avec le nombre de lignes et la ligne - elle-même. Par défaut, cette valeur vaut 5. - - - - - - - - - Césure - - Le texte est coupé si le paramètre hyphenation est fixé à - &true; et un dictionnaire de césure valide est fixé. pslib ne fournit pas - son propre dictionnaire de césure, mais utilise un d'openoffice, scribus - ou koffice. Il est possible de trouver ces dictionnaires pour différentes langues - dans un des dossiers suivants si le programme est installé : - - - /usr/share/apps/koffice/hyphdicts/ - - - /usr/lib/scribus/dicts/ - - - /usr/lib/openoffice/share/dict/ooo/ - - - Présentement, Scribus semble avoir les dictionnaires de - césure les plus complets. - - - - - - &reftitle.returnvalues; - - Nombre de caractères qui ne peuvent être écrits. - - - - - &reftitle.seealso; - - - ps_continue_text - - - - - - - diff --git a/reference/ps/functions/ps-show-xy.xml b/reference/ps/functions/ps-show-xy.xml deleted file mode 100644 index 230e7c88f6..0000000000 --- a/reference/ps/functions/ps-show-xy.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - ps_show_xy - Écrit du texte à la position donnée - - - - &reftitle.description; - - boolps_show_xy - resourcepsdoc - stringtext - floatx - floaty - - - Écrit du texte à la position de texte donnée. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - text - - - Le texte à afficher. - - - - - x - - - La position x du coin inférieur gauche de la boîte entourant le texte. - - - - - y - - - La position y du coin inférieur gauche de la boîte entourant le texte. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_continue_text - ps_show - - - - - - diff --git a/reference/ps/functions/ps-show-xy2.xml b/reference/ps/functions/ps-show-xy2.xml deleted file mode 100644 index 001ff1eac6..0000000000 --- a/reference/ps/functions/ps-show-xy2.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - ps_show_xy2 - Affiche un texte à la position - - - - &reftitle.description; - - boolps_show_xy2 - resourcepsdoc - stringtext - intlen - floatxcoor - floatycoor - - &warn.undocumented.func; - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ps/functions/ps-show.xml b/reference/ps/functions/ps-show.xml deleted file mode 100644 index 8d874e2782..0000000000 --- a/reference/ps/functions/ps-show.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - - ps_show - Écrit du texte - - - - &reftitle.description; - - boolps_show - resourcepsdoc - stringtext - - - Écrit du texte à la position courante du texte. La position du texte peut - être fixée en mettant les positions des coordonnées x et y dans les valeurs - textx et texty avec la fonction - ps_set_value. Cette fonction émet une erreur si une - police n'a été fixée auparavant avec ps_setfont. - - - ps_show évalue les paramètres et les variables - suivantes fixés par ps_set_parameter et - ps_set_value. - - - - charspacing (valeur) - - - Distance entre deux glyphes consécutifs. Si cette valeur n'est pas égale - à zéro, alors toutes les ligatures seront résolues. Les valeurs - inférieures à zéro sont autorisées. - - - - - kerning (paramètre) - - - Fixer ce paramètre à &false; désactivera le crénage. Le crénage est - activé par défaut. - - - - - ligatures (paramètre) - - - Fixer ce paramètre à &false; désactivera l'utilisation des ligatures. - Les ligatures sont activées par défaut. - - - - - underline (paramètre) - - - Fixer ce paramètre à &true; activera le soulignement. Le soulignement - est désactivé par défaut. - - - - - overline (paramètre) - - - Fixer ce paramètre à &true; activera le surlignement. Le surlignement est - désactivé par défaut. - - - - - strikeout (paramètre) - - - Fixer ce paramètre à &true; activera le texte barré. Le texte barré est - désactivé par défaut. - - - - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - text - - - Le texte à afficher. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_continue_text - ps_show_xy - ps_setfont - - - - - - - diff --git a/reference/ps/functions/ps-show2.xml b/reference/ps/functions/ps-show2.xml deleted file mode 100644 index 794966cca3..0000000000 --- a/reference/ps/functions/ps-show2.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - ps_show2 - Affiche un texte à la position courante - - - - &reftitle.description; - - boolps_show2 - resourcepsdoc - stringtext - intlen - - - Affiche le texte à la position courante. N'affiche pas plus de - len caractères. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant de ressource d'un fichier postscript, - tel que retourné par la fonction - ps_new. - - - - - text - - - Le texte à afficher. - - - - - len - - - Le nombre maximal de caractères à afficher. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ps/functions/ps-string-geometry.xml b/reference/ps/functions/ps-string-geometry.xml deleted file mode 100644 index 51a0dbe8f3..0000000000 --- a/reference/ps/functions/ps-string-geometry.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - ps_string_geometry - Récupère les géométries d'une chaîne de caractères - - - - &reftitle.description; - - arrayps_string_geometry - resourcepsdoc - stringtext - intfontid0 - floatsize0.0 - - - ps_string_geometry est similaire à - ps_stringwidth, mais retourne un tableau - des dimensions contenant la largeur, la hampe et le - jambage du texte. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - text - - - Le texte pour lequel la géométrie sera calculée. - - - - - fontid - - - L'identifiant de la police à être utilisée. Si aucune police n'est - spécifiée, la police courante sera utilisée. - - - - - size - - - La taille de la police. Si aucune taille n'est spécifiée, la taille - courante est utilisée. - - - - - - - - - &reftitle.returnvalues; - - Un tableau des dimensions de la &string;. L'élément width contient la - largeur de la chaîne comme retournée par - ps_stringwidth. L'élément descender contient le - maximum de jambage et ascender le maximum de la hampe de la &string;. - - - - - &reftitle.seealso; - - - ps_continue_text - ps_stringwidth - - - - - - - diff --git a/reference/ps/functions/ps-stringwidth.xml b/reference/ps/functions/ps-stringwidth.xml deleted file mode 100644 index 1458f699d7..0000000000 --- a/reference/ps/functions/ps-stringwidth.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - ps_stringwidth - Récupère la largeur d'une chaîne de caractères - - - - &reftitle.description; - - floatps_stringwidth - resourcepsdoc - stringtext - intfontid0 - floatsize0.0 - - - Calcule la largeur d'une &string; en points si elle a été écrite dans la - police et la taille donnée. Cette fonction requiert le fichier de police - métrique "adobe" pour calculer la largeur précise. Si le crénage est - activé, il sera pris en compte. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - text - - - Le texte pour lequel la largeur sera calculée. - - - - - fontid - - - L'identifiant de la police à être utilisée. Si aucune police n'est - spécifiée, la police courante sera utilisée. - - - - - size - - - La taille de la police. Si aucune taille n'est spécifiée, la taille - courante est utilisée. - - - - - - - - - &reftitle.returnvalues; - - Largeur de la &string; en points. - - - - - &reftitle.seealso; - - - ps_string_geometry - - - - - - - diff --git a/reference/ps/functions/ps-stroke.xml b/reference/ps/functions/ps-stroke.xml deleted file mode 100644 index 3f776e8afe..0000000000 --- a/reference/ps/functions/ps-stroke.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - ps_stroke - Dessine le chemin courant - - - - &reftitle.description; - - boolps_stroke - resourcepsdoc - - - Dessine le chemin construit avec des fonctions de dessin comme - ps_lineto précédemment appelées. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_closepath_stroke - ps_fill - ps_fill_stroke - - - - - - - diff --git a/reference/ps/functions/ps-symbol-name.xml b/reference/ps/functions/ps-symbol-name.xml deleted file mode 100644 index d65170665e..0000000000 --- a/reference/ps/functions/ps-symbol-name.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - ps_symbol_name - Récupère le nom d'un glyphe - - - - &reftitle.description; - - stringps_symbol_name - resourcepsdoc - intord - intfontid0 - - - Cette fonction nécessite le fichier de police métrique "adobe" pour savoir - quels glyphes sont disponibles. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - ord - - - Le paramètre ord est la position du glyphe dans - le vecteur d'encodage de la police. - - - - - fontid - - - L'identifiant de la police à être utilisée. Si aucune police n'est - spécifiée, la police courante sera utilisée. - - - - - - - - - &reftitle.returnvalues; - - Le nom d'un glyphe dans la police donnée. - - - - - &reftitle.seealso; - - - ps_symbol - ps_symbol_width - - - - - - - diff --git a/reference/ps/functions/ps-symbol-width.xml b/reference/ps/functions/ps-symbol-width.xml deleted file mode 100644 index 2b813bc006..0000000000 --- a/reference/ps/functions/ps-symbol-width.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - ps_symbol_width - Récupère la largeur d'un glyphe - - - - &reftitle.description; - - floatps_symbol_width - resourcepsdoc - intord - intfontid0 - floatsize0.0 - - - Calcule la largeur d'un glyphe en points s'il a été écrit dans la police et - la taille donnée. Cette fonction nécessite le fichier de police métrique - "adobe" pour calculer la largeur précise. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - ord - - - La position du glyphe dans le vecteur d'encodage de la police. - - - - - fontid - - - L'identifiant de la police à être utilisée. Si aucune police n'est - spécifiée, la police courante sera utilisée. - - - - - size - - - La taille de la police. Si aucune taille n'est spécifiée, la taille - courante est utilisée. - - - - - - - - - &reftitle.returnvalues; - - La largeur d'un glyphe en points. - - - - - &reftitle.seealso; - - - ps_symbol - ps_symbol_name - - - - - - - diff --git a/reference/ps/functions/ps-symbol.xml b/reference/ps/functions/ps-symbol.xml deleted file mode 100644 index 6db9779664..0000000000 --- a/reference/ps/functions/ps-symbol.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - ps_symbol - Écrit un glyphe - - - - &reftitle.description; - - boolps_symbol - resourcepsdoc - intord - - - Écrit un glyphe à la position ord dans le vecteur - d'encodage de la police de la police courante. L'encodage de la police pour - une police peut être fixé lors du chargement de la police avec - ps_findfont. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - ord - - - La position du glyphe dans le vecteur d'encodage de la police. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_symbol_name - ps_symbol_width - - - - - - - diff --git a/reference/ps/functions/ps-translate.xml b/reference/ps/functions/ps-translate.xml deleted file mode 100644 index dc0d454c4d..0000000000 --- a/reference/ps/functions/ps-translate.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - - ps_translate - Fixe une translation - - - - &reftitle.description; - - boolps_translate - resourcepsdoc - floatx - floaty - - - Fixe un nouveau point initial d'un système de coordonnées. - - - - - &reftitle.parameters; - - - - psdoc - - - Identifiant d'un fichier postscript retourné par - ps_new. - - - - - x - - - La position x de l'origine du système de coordonnées translaté. - - - - - y - - - La position y de l'origine du système de coordonnées translaté. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Translation du système de coordonnées - - - -]]> - - - L'exemple ci-dessus démontre deux moyens possibles pour placer un - graphique (dans ce cas, simplement un rectangle) à n'importe quelle - position sur la page, tandis que le graphique en lui-même utilise son - propre système de coordonnées. Le truc est de changer l'origine du système - de coordonnées courant avant de dessiner le rectangle. La translation doit - être défaite après que le graphique ait été dessiné. - - - Sur la seconde page, une approche plus élégante et légèrement différente - est appliquée. Au lieu de défaire la translation avec le deuxième appel - de ps_translate, le contexte graphique est - sauvegardé avant les modifications du système de coordonnées et restauré - après le dessin du rectangle. - - - - - - - &reftitle.seealso; - - - ps_scale - ps_rotate - - - - - - - diff --git a/reference/ps/reference.xml b/reference/ps/reference.xml deleted file mode 100644 index 3f677922b3..0000000000 --- a/reference/ps/reference.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - &Functions; PS - - -
    - Contact Information - - Si l'on a des commentaires, résolutions de bogues, améliorations pour - soit cette extension ou pslib alors laissez-moi un message à - steinm@php.net. Toute aide est - la bienvenue. - -
    - -     - - &reference.ps.entities.functions; - -     - - diff --git a/reference/ps/setup.xml b/reference/ps/setup.xml deleted file mode 100644 index af20cae540..0000000000 --- a/reference/ps/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Il faut au moins pslib >= 0.1.12. La bibliothèque ps - (pslib) est disponible à &url.pslib;. - -
    - - - - &reference.ps.configure; - - - -
    - &reftitle.resources; - - Cette extension définit une ressource de document PostScript, retournée - par la fonction ps_new. - -
    - - -     - - - diff --git a/reference/pthreads/book.xml b/reference/pthreads/book.xml deleted file mode 100644 index d37302c788..0000000000 --- a/reference/pthreads/book.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - - pthreads - pthreads - - - &reftitle.intro; - - pthreads est une API orientée objet qui apporte tous les outils nécessaires pour - le multithreading en PHP. - Les applications PHP peuvent créer, lire, écrire, exécuter - et synchroniser des Threads, des Workers, et des objets Threaded. - - - - Cette extension est considérée non maintenue et morte. - - - - - Envisager d'utiliser parallel à la place. - - - - - L'extension pthreads ne peut pas être utilisée dans un environnement de - serveur Web. Le Threading en PHP est donc limité aux applications basées - sur CLI uniquement. - - - - - pthreads (v3) peut être utilisé uniquement avec PHP 7.2+ à cause d'un - mode ZTS dangereux en PHP 7.0 et 7.1. - - - - La classe Threaded constitue la base de la - fonctionnalité qui permet à pthreads de fonctionner. Elle expose les méthodes - de synchronisation et quelques interfaces utiles pour le programmeur. - - - La classe Thread permet de créer des threads en - l'étendant simplement et en implémentant une méthode run. - Tous les membres peuvent être écrits et lus par n'importe quel contexte avec - une référence au thread. Tout contexte peut également exécuter toutes les - méthodes publiques et protégées. Le corps de la méthode run sera exécuté - dans un thread séparé lorsque la méthode Thread::start - de l'implémentation est appelée à partir du contexte qui l'a créé. Seul le - contexte qui crée un thread peut le démarrer et le rejoindre. - - - La classe Worker a un état persistant et sera - disponible à partir de l'appel à Thread::start (une - méthode héritée) jusqu'à ce que l'objet soit hors de portée, ou soit - explicitement arrêté (via Worker::shutdown). Tout - contexte avec une référence à l'objet Worker peut empiler des tâches sur le - Worker (via Worker::stack), où ces tâches seront - exécutées par le Worker dans un thread séparé. La méthode - run d'un objet worker est exécutée avant tout objet de la - pile du worker, ce qui permet aux ressources d'être initialisées pour que - les objets à exécuter puissent les utiliser. - - - La classe Pool est utilisée pour créer un groupe de - worker pour distribuer des objets Threaded parmi eux. - Il est le moyen le plus facile et le plus efficace d'utiliser plusieurs - threads dans les applications PHP. - - - - La classe Pool n'étend pas la classe - Threaded, et donc les objets basés sur pool sont - considérés comme des objets PHP normaux. En tant que tel, ses instances ne - doivent pas être partagées entre des contextes différents. - - - - La classe Volatile est nouvelle pour pthreads v3. - Elle est utilisée pour désigner les propriétés Threaded - mutable des classes Threaded (car celles-ci sont - désormais immuables par défaut). Elle est également utilisée pour stocker - des tableaux PHP dans des contextes Threaded. - - - La synchronisation est une capacité importante lors du Threading. Tous les - objets créés par pthreads ont été construits en synchronisation dans la - forme (qui sera familière aux programmeurs Java) de - Threaded::wait et - Threaded::notify. L'appel de - Threaded::wait sur un objet entraînera le contexte - à attendre qu'un autre contexte appelle - Threaded::notify sur le même objet. Ce mécanisme - permet une synchronisation puissante entre les objets - Threaded en PHP. - - - - Tout objet prévu pour être utilisé dans une partie multithreadée de - l'application doit étendre Threaded. - - - - Stockage des données : En règle générale, tous les types de données pouvant être sérialisés peuvent - être utilisés comme membre d'un objet Threadé, ils peuvent être lus, et écrits depuis n'importe quel - contexte avec une référence vers l'objet Threadé. Tous les types de données ne sont pas stockés - après sérialisation ; les types simples sont stockés sous leur forme initiale. Les types complexes, - les tableaux et les objets qui ne sont pas Threadés, sont stockés sérialisés ; ils peuvent être lus - et écrits dans l'objet Threadé depuis n'importe quel contexte avec une référence. - À l'exception des objets Threadés, toute référence utilisée pour définir un membre d'un objet Threadé - est séparée de la référence dans l'objet Threadé ; les mêmes données peuvent être lues directement - depuis l'objet Threadé à tout moment par n'importe quel contexte avec une référence vers l'objet Threadé. - - - Membres statiques : Lorsqu'un nouveau contexte est créé (Thread ou Worker), - ils sont généralement copiés, mais les ressources et objets avec un état - interne sont nullifiés (pour des raisons de sécurité). Ceci permet alors à la fonction une sorte de stockage local - au niveau du thread. Par exemple, lors du démarrage du contexte, une classe dont les membres statiques - incluent des informations de connexion vers un serveur de base de données, seules les informations - seront copiées, et non la connexion en tant que telle. Ceci permet au nouveau contexte d'initialiser - une connexion de la même façon que le contexte qui l'a créé, stockant la connexion au même endroit - sans pour autant affecter le contexte original. - - - - Lorsque print_r, var_dump et d'autres fonctions de débogage sont exécutées, elles n'incluent pas - de protection contre la récursion. - - - - - Ressources : Les extensions et les fonctionnalités qui définissent des ressources en PHP ne sont pas préparées - pour ce type d'environnement ; pthreads prend des dispositions en matière de ressource à partager entre - les contextes, cependant, pour la plupart des ressources, elles devront être considérées comme dangereuses. - Un soin et une extrême prudence devront être de mise pour partager les ressources entre les contextes. - - - - - Dans l'environnement d'exécution de pthreads, des restrictions et des limitations sont nécessaires afin de - fournir un environnement stable. - - - - - &reference.pthreads.setup; - &reference.pthreads.constants; - &reference.pthreads.threaded; - &reference.pthreads.thread; - &reference.pthreads.worker; - &reference.pthreads.collectable; - &reference.pthreads.pool; - &reference.pthreads.volatile; - - - diff --git a/reference/pthreads/collectable.xml b/reference/pthreads/collectable.xml deleted file mode 100644 index a04cb344f0..0000000000 --- a/reference/pthreads/collectable.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - L'interface Collectable - Collectable - - - -
    - &reftitle.intro; - - Représente un objet de collecte de données obsolètes. - -
    - - -
    - &reftitle.classsynopsis; - - - - Collectable - - - - - Collectable - - - - - &Methods; - - - - - -
    - -     - - &reference.pthreads.entities.collectable; - -     - diff --git a/reference/pthreads/collectable/isgarbage.xml b/reference/pthreads/collectable/isgarbage.xml deleted file mode 100644 index 443e3b9213..0000000000 --- a/reference/pthreads/collectable/isgarbage.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Collectable::isGarbage - Détermine si un objet a été marqué comme obsolète - - - - &reftitle.description; - - public trueCollectable::isGarbage - - - - Peut être appelé dans Pool::collect - pour déterminer si cet objet est obsolète. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &return.type.true; - - - - - - - &reftitle.seealso; - - Pool::collect - - - - - diff --git a/reference/pthreads/configure.xml b/reference/pthreads/configure.xml deleted file mode 100644 index 11194125b8..0000000000 --- a/reference/pthreads/configure.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - -
    - &reftitle.install; - - - Utiliser lors de la - compilation de PHP. - - - - Les utilisateurs Windows doivent inclure php_pthreads.dll - dans le &php.ini; - - - - - Les utilisateurs de Windows doivent également s'assurer que - pthreadVC2.dll (inclus dans la distribution) - est présent dans un des dossiers spécifiés dans la variable d'environnement - PATH. - - - -
    - diff --git a/reference/pthreads/constants.xml b/reference/pthreads/constants.xml deleted file mode 100644 index f3482cdb37..0000000000 --- a/reference/pthreads/constants.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - PTHREADS_INHERIT_ALL - (int) - - - - Les options par défaut pour tous les threads, - faisant que les pthreads copient les environnements - lorsque les nouveaux threads sont démarrés - - - - - - PTHREADS_INHERIT_NONE - (int) - - - - N'hérite de rien lorsque les nouveaux threads sont démarrés - - - - - - PTHREADS_INHERIT_INI - (int) - - - - Hérite des entrées INI lorsque les nouveaux threads sont démarrés - - - - - - PTHREADS_INHERIT_CONSTANTS - (int) - - - - Hérite des constantes déclarées par l'utilisateur lorsque les - nouveaux threads sont démarrés - - - - - - PTHREADS_INHERIT_CLASSES - (int) - - - - Hérite des classes déclarées par l'utilisateur lorsque les nouveaux - threads sont démarrés - - - - - - PTHREADS_INHERIT_FUNCTIONS - (int) - - - - Hérite des fonctions déclarées par l'utilisateur lorsque les nouveaux - threads sont démarrés - - - - - - PTHREADS_INHERIT_INCLUDES - (int) - - - - L'héritage inclut l'information de fichier lorsque les nouveaux - threads sont démarrés - - - - - - PTHREADS_INHERIT_COMMENTS - (int) - - - - Hérite de tous les commentaires lorsque les nouveaux threads sont - démarrés - - - - - - PTHREADS_ALLOW_HEADERS - (int) - - - - Autorise les nouveaux threads à envoyer les en-têtes à la sortie - standard (normalement non autorisé) - - - - - - diff --git a/reference/pthreads/pool.xml b/reference/pthreads/pool.xml deleted file mode 100644 index 9cfe803606..0000000000 --- a/reference/pthreads/pool.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - La classe Pool - Pool - - - - -
    - &reftitle.intro; - - Un Pool est un conteneur pour, et contrôlé par, un nombre ajustable de Workers. - - - Le pooling fournit un niveau élevé d'abstraction sur la fonctionnalité Worker, en incluant la gestion des références dans le sens requis par pthreads. - -
    - - -
    - &reftitle.classsynopsis; - - - - Pool - - - - - Pool - - - - &Properties; - - protected - size - - - protected - class - - - protected - workers - - - protected - ctor - - - protected - last - - - - &Methods; - - - - - - - - - -
    - - - -
    - &reftitle.properties; - - - size - - Nombre maximum de Workers que ce pool peut utiliser - - - - class - - La classe du Worker - - - - workers - - références vers les Workers - - - - ctor - - Les arguments pour le constructeur des nouveaux Workers - - - - last - - offset dans les workers du dernier Worker utilisé - - - -
    - - - -     - - &reference.pthreads.entities.pool; - -     - diff --git a/reference/pthreads/pool/collect.xml b/reference/pthreads/pool/collect.xml deleted file mode 100644 index 008fb1c7d9..0000000000 --- a/reference/pthreads/pool/collect.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Pool::collect - Collecte les références des tâches achevées - - - - &reftitle.description; - - public intPool::collect - Callablecollector - - - Permet au pool de collecter des références déterminées pour être collectées - par le collecteur donné optionnellement. - - - - - &reftitle.parameters; - - - collector - - - Un collecteur pouvant être appelé retournant une valeur booléenne pour - déterminer si la tâche peut être collectée ou non. Ce n'est que dans de - rares cas qu'un collecteur personnalisé doit être utilisé. - - - - - - - - &reftitle.returnvalues; - - Nombre de tâches restantes dans le pool à collecter. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL pthreads 3.0.0 - - Un entier est maintenant retourné, et le paramètre - collector est maintenant facultatif. - - - - - - - - - &reftitle.examples; - - Un exemple de base de <methodname>Pool::collect</methodname> - -submit(new class extends Threaded {}); -} - -while ($pool->collect()); // bloque jusqu'à ce que toutes les tâches aient fini de s'exécuter - -$pool->shutdown(); -]]> - - - - - - diff --git a/reference/pthreads/pool/construct.xml b/reference/pthreads/pool/construct.xml deleted file mode 100644 index 11e9334b45..0000000000 --- a/reference/pthreads/pool/construct.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - Pool::__construct - Crée un nouveau Pool de Workers - - - - &reftitle.description; - - public Pool::__construct - intsize - stringclass - arrayctor - - - Construit un nouveau pool de workers. Les pools créent paresseusement leurs - threads, ce qui signifie que les nouveaux threads ne seront générés que - lorsqu'ils sont requis pour exécuter des tâches. - - - - - &reftitle.parameters; - - - size - - - Le nombre maximal de Workers que ce Pool peut créer - - - - - class - - - La classe pour les nouveaux Workers. Si aucune classe n'est donnée, la classe par défaut est Worker. - - - - - ctor - - - Un tableau d'arguments à passer au constructeur des nouveaux Workers - - - - - - - - &reftitle.examples; - - Création d'un Pool - -something = $something; - } - - public function run() { - /** ... **/ - } -} - -$pool = new Pool(8, \MyWorker::class, [new Something()]); - -var_dump($pool); -?> -]]> - - &example.outputs; - - - int(8) - ["class":protected]=> - string(8) "MyWorker" - ["workers":protected]=> - NULL - ["work":protected]=> - NULL - ["ctor":protected]=> - array(1) { - [0]=> - object(Something)#2 (0) { - } - } - ["last":protected]=> - int(0) -} -]]> - - - - - - diff --git a/reference/pthreads/pool/resize.xml b/reference/pthreads/pool/resize.xml deleted file mode 100644 index 10d3f28faf..0000000000 --- a/reference/pthreads/pool/resize.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Pool::resize - Redimensionne le Pool - - - - &reftitle.description; - - public voidPool::resize - intsize - - - Redimensionne le Pool. - - - - - &reftitle.parameters; - - - size - - - Le nombre maximal de Workers que ce Pool peut créer - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/pthreads/pool/shutdown.xml b/reference/pthreads/pool/shutdown.xml deleted file mode 100644 index 7a8777ad7b..0000000000 --- a/reference/pthreads/pool/shutdown.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - Pool::shutdown - Arrête tous les workers - - - - &reftitle.description; - - public voidPool::shutdown - - - - Arrête tous les workers de ce Pool. Cela se bloquera jusqu'à ce que toutes - les tâches soumises aient été exécutées. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Arrêt d'un pool - -submit(new Task()); -} - -$pool->shutdown(); // bloque jusqu'à ce que toutes les tâches soumises aient terminé l'exécution -]]> - - - - - diff --git a/reference/pthreads/pool/submit.xml b/reference/pthreads/pool/submit.xml deleted file mode 100644 index 7c7a6f507c..0000000000 --- a/reference/pthreads/pool/submit.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - Pool::submit - Soumet un objet pour exécution - - - - &reftitle.description; - - public intPool::submit - Threadedtask - - - Soumet la tâche au prochain Worker du Pool - - - - - &reftitle.parameters; - - - task - - - La tâche pour exécution - - - - - - - - &reftitle.returnvalues; - - L'identifiant du Worker exécutant l'objet - - - - - &reftitle.examples; - - Soumission de tâches - -something = $something; - } - - public function run() { - /** ... **/ - } -} - -$pool = new Pool(8, \MyWorker::class, [new Something()]); -$pool->submit(new MyWork()); -var_dump($pool); -?> -]]> - - &example.outputs; - - - int(8) - ["class":protected]=> - string(8) "MyWorker" - ["workers":protected]=> - array(1) { - [0]=> - object(MyWorker)#4 (1) { - ["something"]=> - object(Something)#5 (0) { - } - } - } - ["work":protected]=> - array(1) { - [0]=> - object(MyWork)#3 (1) { - ["worker"]=> - object(MyWorker)#5 (1) { - ["something"]=> - object(Something)#6 (0) { - } - } - } - } - ["ctor":protected]=> - array(1) { - [0]=> - object(Something)#2 (0) { - } - } - ["last":protected]=> - int(1) -} -]]> - - - - - - diff --git a/reference/pthreads/pool/submitTo.xml b/reference/pthreads/pool/submitTo.xml deleted file mode 100644 index e0d7b3ac8f..0000000000 --- a/reference/pthreads/pool/submitTo.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - Pool::submitTo - Soumet une tâche à un worker spécifique pour exécution - - - - &reftitle.description; - - public intPool::submitTo - intworker - Threadedtask - - - Soumet la tâche au worker spécifié dans le Pool. Les travailleurs sont - indexés à partir de 0, et n'existeront que si le pool a besoin de les créer - (puisque les threads sont générés paresseusement). - - - - - &reftitle.parameters; - - - worker - - - Le worker où empiler la tâche, indexé à partir de 0. - - - - - task - - - La tâche, pour exécution - - - - - - - - &reftitle.returnvalues; - - L'identifiant du Worker qui a accepté la tâche. - - - - - &reftitle.examples; - - Soumission d'une tâche à un worker spécifique - -submit(new Task()); - -for ($i = 0; $i < 5; ++$i) { - $pool->submitTo(0, new Task()); // empilez toutes les tâches sur le premier worker -} - -$pool->submitTo(1, new Task()); // Impossible d'empiler la tâche sur le deuxième worker car il n'existe pas encore - -$pool->shutdown(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/setup.xml b/reference/pthreads/setup.xml deleted file mode 100644 index a1b88b8e47..0000000000 --- a/reference/pthreads/setup.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Pthreads requiert une construction de PHP avec ZTS activé - (, ou sur les systèmes non-Windows antérieurs à PHP 8.0.0, - ). - - - - La sécurité des Threads Zend (Zend Thread Safety - ZTS) ne peut pas être activée - après construction; c'est une option de compilation. - - - - pthreads devrait compiler tant qu'il y a un entête Posix Threads fonctionnel - (pthread.h) ainsi qu'une construction ZTS de PHP, ceci inclut Windows (en - utilisant le projet pthread-w32 de redhat). - -
    - -
    - &reftitle.install; - - Les versions de pthreads sont hébergées par PECL et les sources sur - github. - La procédure d'installation la plus simple est la procédure PECL standard : - &url.pecl.package;pthreads. - - - Les utilisateurs Windows peuvent télécharger des binaires préconstruits depuis - le site de PECL. - - - - Les utilisateurs Windows doivent également ajouter pthreadVC2.dll (distribué - avec Windows) à leur PATH. - - -
    - -     - diff --git a/reference/pthreads/thread.xml b/reference/pthreads/thread.xml deleted file mode 100644 index 6ecf4c52ad..0000000000 --- a/reference/pthreads/thread.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - La classe Thread - Thread - - - - -
    - &reftitle.intro; - - Quand la méthode start d'un Thread est appelée, le code de la méthode run sera - exécuté de façon parallèle dans un Thread séparé. - - - Après l'exécution de la méthode run, le Thread se terminera immédiatement, il - sera rattaché au Thread d'origine par la suite. - - - - S'appuyer sur le moteur pour déterminer quand un Thread sera rattaché peut - provoquer un comportement non désiré. Le développeur doit être explicite - tant que possible. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Thread - - - - - Thread - - - - extends - Threaded - - - - Countable - - - - Traversable - - - - ArrayAccess - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.pthreads.entities.thread; - -     - diff --git a/reference/pthreads/thread/getcreatorid.xml b/reference/pthreads/thread/getcreatorid.xml deleted file mode 100644 index af4d87c72e..0000000000 --- a/reference/pthreads/thread/getcreatorid.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Thread::getCreatorId - Identification - - - - &reftitle.description; - - public intThread::getCreatorId - - - - Retourne l'identité du Thread qui a créé le Thread référencé. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une identité numérique. - - - - - &reftitle.examples; - - Retourne l'identité du Thread ou du processus qui a créé le Thread référencé - -getCreatorId()); - } -} -$my = new My(); -$my->start(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/getcurrentthread.xml b/reference/pthreads/thread/getcurrentthread.xml deleted file mode 100644 index 7fc147faac..0000000000 --- a/reference/pthreads/thread/getcurrentthread.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Thread::getCurrentThread - Identification - - - - &reftitle.description; - - public static ThreadThread::getCurrentThread - - - - Retourne une référence du thread actuellement en cours d'exécution - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet représentant le thread actuellement en cours d'exécution. - - - - - &reftitle.examples; - - Retourne le thread actuellement en cours d'exécution - -start(); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/pthreads/thread/getcurrentthreadid.xml b/reference/pthreads/thread/getcurrentthreadid.xml deleted file mode 100644 index 41005fb739..0000000000 --- a/reference/pthreads/thread/getcurrentthreadid.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Thread::getCurrentThreadId - Identification - - - - &reftitle.description; - - public static intThread::getCurrentThreadId - - - - Retourne l'identité du thread actuellement en cours d'exécution - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une identité numérique - - - - - &reftitle.examples; - - Retourne l'identité du thread actuellement en cours d'exécution - -start(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/getthreadid.xml b/reference/pthreads/thread/getthreadid.xml deleted file mode 100644 index 4b8cd05114..0000000000 --- a/reference/pthreads/thread/getthreadid.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Thread::getThreadId - Identification - - - - &reftitle.description; - - public intThread::getThreadId - - - - Retourne l'identité du Thread référencé. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une identité numérique. - - - - - &reftitle.examples; - - Retourne l'identité du Thread référencé - -getThreadId()); - } -} -$my = new My(); -$my->start(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/isjoined.xml b/reference/pthreads/thread/isjoined.xml deleted file mode 100644 index 39757d928f..0000000000 --- a/reference/pthreads/thread/isjoined.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - Thread::isJoined - Détection de statut - - - - &reftitle.description; - - public boolThread::isJoined - - - - Indique si le Thread référencé a été joint. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Détecte le statut du Thread référencé - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -var_dump($my->isJoined()); -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/isstarted.xml b/reference/pthreads/thread/isstarted.xml deleted file mode 100644 index 3406b0840d..0000000000 --- a/reference/pthreads/thread/isstarted.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - Thread::isStarted - Détection de statut - - - - &reftitle.description; - - public boolThread::isStarted - - - - Indique si le Thread référencé a été démarré. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Indique si le Thread référencé a été démarré - -start(); -var_dump($worker->isStarted()); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/join.xml b/reference/pthreads/thread/join.xml deleted file mode 100644 index d8da1dfd89..0000000000 --- a/reference/pthreads/thread/join.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - Thread::join - Synchronisation - - - - &reftitle.description; - - public boolThread::join - - - - Fait attendre le contexte appelant du Thread référencé - la fin de l'exécution. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Rejoint le Thread référencé - -start(); -/* ... */ -var_dump($my->join()); -/* ... */ -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/start.xml b/reference/pthreads/thread/start.xml deleted file mode 100644 index db160000a3..0000000000 --- a/reference/pthreads/thread/start.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - Thread::start - Exécution - - - - &reftitle.description; - - public boolThread::start - intoptions - - - Démarre un nouveau Thread et exécute la méthode run implémentée. - - - - - &reftitle.parameters; - - - options - - - Un masque optionnel de constantes héritées ; par défaut, - PTHREADS_INHERIT_ALL - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Démarre les Threads - -start()); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/threaded.xml b/reference/pthreads/threaded.xml deleted file mode 100644 index e84b27df67..0000000000 --- a/reference/pthreads/threaded.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - La classe Threaded - Threaded - - - - -
    - &reftitle.intro; - - Les objets Threaded sont la base de pthreads pour exécuter du code de façon parallèle ; - ils exposent et incluent des méthodes de synchronisation ainsi que diverses interfaces utiles. - - - Les objets Threaded fournissent une sécurité native pour le développeur; toutes les opérations sont thread-safe dans le scope de l'objet. - -
    - - -
    - &reftitle.classsynopsis; - - - - Threaded - - - - - Threaded - - - - Collectable - - - - Traversable - - - - Countable - - - - ArrayAccess - - - - - &Methods; - - - - -
    - -     - - &reference.pthreads.entities.threaded; - -     - diff --git a/reference/pthreads/threaded/chunk.xml b/reference/pthreads/threaded/chunk.xml deleted file mode 100644 index 88ff9448df..0000000000 --- a/reference/pthreads/threaded/chunk.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Threaded::chunk - Manipulation - - - - &reftitle.description; - - public arrayThreaded::chunk - intsize - boolpreserve - - - Parcours une partie de la table des propriétés des objets en - préservant, optionnellement, les clés. - - - - - &reftitle.parameters; - - - size - - - Le nombre d'éléments à parcourir - - - - - preserve - - - Préserve les clés des membres ; par défaut, vaut &false; - - - - - - - - &reftitle.returnvalues; - - Un tableau d'éléments depuis la table de propriétés des objets. - - - - - &reftitle.examples; - - Parcours une partie de la table des propriétés - -chunk(5)); -?> -]]> - - &example.outputs; - - - int(0) - [1]=> - int(1) - [2]=> - int(2) - [3]=> - int(3) - [4]=> - int(4) -} -]]> - - - - - - diff --git a/reference/pthreads/threaded/count.xml b/reference/pthreads/threaded/count.xml deleted file mode 100644 index ccd3c003e7..0000000000 --- a/reference/pthreads/threaded/count.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - Threaded::count - Manipulation - - - - &reftitle.description; - - public intThreaded::count - - - - Retourne le nombre de propriétés pour cet objet. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Compte les propriétés d'un objet - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/threaded/extend.xml b/reference/pthreads/threaded/extend.xml deleted file mode 100644 index 0f74704508..0000000000 --- a/reference/pthreads/threaded/extend.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - Threaded::extend - Manipulation pendant l'exécution - - - - &reftitle.description; - - public boolThreaded::extend - stringclass - - - Rend la classe standard sécurisée au niveau du thread pendant l'exécution. - - - - - &reftitle.parameters; - - - class - - - La classe à étendre. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Héritage à l'exécution - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/threaded/isrunning.xml b/reference/pthreads/threaded/isrunning.xml deleted file mode 100644 index fbe58668c3..0000000000 --- a/reference/pthreads/threaded/isrunning.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - Threaded::isRunning - Détection de statut - - - - &reftitle.description; - - public boolThreaded::isRunning - - - - Demande si l'objet référencé est en cours d'exécution. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un booléen indiquant le statut. - - - Un objet est considéré comme étant en cours d'exécution lorsqu'il - exécute la méthode run. - - - - - - - &reftitle.examples; - - Détecte le statut de l'objet référencé - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -var_dump($my->isRunning()); -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/isterminated.xml b/reference/pthreads/threaded/isterminated.xml deleted file mode 100644 index 1f42bb7f23..0000000000 --- a/reference/pthreads/threaded/isterminated.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Threaded::isTerminated - Détection de statut - - - - &reftitle.description; - - public boolThreaded::isTerminated - - - - Demande si l'objet référencé s'est terminé durant l'exécution ; - s'il a subi une erreur fatale ou émis des exceptions qui n'ont pu - être attrapées. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un booléen indiquant le statut. - - - - - &reftitle.examples; - - Détecte le statut de l'objet référencé - -start(); -$my->join(); -var_dump($my->isTerminated()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/merge.xml b/reference/pthreads/threaded/merge.xml deleted file mode 100644 index a16f4c125e..0000000000 --- a/reference/pthreads/threaded/merge.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - Threaded::merge - Manipulation - - - - &reftitle.description; - - public boolThreaded::merge - mixedfrom - booloverwrite - - - Fusionne les données dans l'objet courant - - - - - &reftitle.parameters; - - - from - - - Les données à fusionner - - - - - overwrite - - - Ecrase les clés existantes ; par défaut vaut &true; - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Fusionne l'objet threadé dans la table des propriétés - -foo = "foo"; -$stdClass->bar = "bar"; -$stdClass->baz = "baz"; - -$safe = new Threaded(); -$safe->merge($array); -$safe->merge($stdClass); - -var_dump($safe); -?> -]]> - - &example.outputs; - - - int(0) - ["1"]=> - int(1) - ["2"]=> - int(2) - ["3"]=> - int(3) - ["4"]=> - int(4) - ["5"]=> - int(5) - ["6"]=> - int(6) - ["7"]=> - int(7) - ["8"]=> - int(8) - ["9"]=> - int(9) - ["foo"]=> - string(3) "foo" - ["bar"]=> - string(3) "bar" - ["baz"]=> - string(3) "baz" -} -]]> - - - - - diff --git a/reference/pthreads/threaded/notify.xml b/reference/pthreads/threaded/notify.xml deleted file mode 100644 index 16b7392c0b..0000000000 --- a/reference/pthreads/threaded/notify.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - Threaded::notify - Synchronisation - - - - &reftitle.description; - - public boolThreaded::notify - - - - Envoie une notification à l'objet référencé - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Notifications et attente - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -/** envoie la notification au thread qui attend **/ -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -var_dump($my->join()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/notifyone.xml b/reference/pthreads/threaded/notifyone.xml deleted file mode 100644 index 8337bed752..0000000000 --- a/reference/pthreads/threaded/notifyone.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Threaded::notifyOne - Synchronise - - - - &reftitle.description; - - public boolThreaded::notifyOne - - - - Envoie une notification à l'objet référencé. Cela débloque au moins un des - threads bloqués (par opposition à les débloquer tous, comme on le voit avec - Threaded::notify). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Notifications et attente - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -/** envoie une notification au thread en attente **/ -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notifyOne(); -}, $my); -var_dump($my->join()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/pop.xml b/reference/pthreads/threaded/pop.xml deleted file mode 100644 index 5cdaaaec69..0000000000 --- a/reference/pthreads/threaded/pop.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - Threaded::pop - Manipulation - - - - &reftitle.description; - - public boolThreaded::pop - - - - Enlève le dernier élément depuis la table des propriétés de l'objet. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le dernier élément de la table des propriétés de l'objet. - - - - - &reftitle.examples; - - Enlève le dernier élément depuis la table des propriétés d'un objet threadé - -pop()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/run.xml b/reference/pthreads/threaded/run.xml deleted file mode 100644 index 61f74e2f2d..0000000000 --- a/reference/pthreads/threaded/run.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - Threaded::run - Exécution - - - - &reftitle.description; - - public voidThreaded::run - - - - Le développeur devrait toujours implémenter la méthode run pour les objets - qui doivent être exécutés. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/pthreads/threaded/shift.xml b/reference/pthreads/threaded/shift.xml deleted file mode 100644 index 4892037c52..0000000000 --- a/reference/pthreads/threaded/shift.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Threaded::shift - Manipulation - - - - &reftitle.description; - - public mixedThreaded::shift - - - - Enlève le premier élément depuis la table de propriétés de l'objet. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le premier élément depuis la table de propriétés de l'objet. - - - - - &reftitle.examples; - - - Enlève le premier élément depuis la table de propriétés de l'objet threadé - -shift()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/synchronized.xml b/reference/pthreads/threaded/synchronized.xml deleted file mode 100644 index 1a317e2e9a..0000000000 --- a/reference/pthreads/threaded/synchronized.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - Threaded::synchronized - Synchronisation - - - - &reftitle.description; - - public mixedThreaded::synchronized - Closureblock - mixedargs - - - Exécute le bloc tout en retenant les verrous de synchronisation - des objets référencés pour le contexte appelant. - - - - - &reftitle.parameters; - - - block - - - Le bloc de code à exécuter - - - - - args - - - Liste variable d'arguments à utiliser comme argument de la fonction - - - - - - - - &reftitle.returnvalues; - - La valeur retournée du bloc - - - - - &reftitle.examples; - - Synchronisation - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -var_dump($my->join()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/wait.xml b/reference/pthreads/threaded/wait.xml deleted file mode 100644 index 56ada5a627..0000000000 --- a/reference/pthreads/threaded/wait.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - Threaded::wait - Synchronisation - - - - &reftitle.description; - - public boolThreaded::wait - inttimeout - - - Fera attendre le contexte appelant une notification depuis l'objet référencé. - - - - - &reftitle.parameters; - - - timeout - - - Un délai d'attente maximal optionnel, en microsecondes. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Notifications et attente - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -/** Envoie la notification au threadé qui attend **/ -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -var_dump($my->join()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/volatile.xml b/reference/pthreads/volatile.xml deleted file mode 100644 index 15c1f6d0a4..0000000000 --- a/reference/pthreads/volatile.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - La classe Volatile - Volatile - - - - -
    - &reftitle.intro; - - La classe Volatile est nouvelle dans pthreads v3. Son - introduction est une conséquence des nouvelles sémantiques d'immutabilité - des membres Threaded des classes Threaded. - La classe Volatile permet la mutabilité de ses membres - Threaded, et est également utilisée pour stocker des - tableaux PHP dans des contextes Threaded. - -
    - - -
    - &reftitle.classsynopsis; - - - - Volatile - - - - - Volatile - - - - extends - Threaded - - - - Collectable - - - - Traversable - - - - &InheritedMethods; - - - - - - -
    - -
    - &reftitle.examples; - - Nouvelles sémantiques d'immutabilité de Threaded - -data = new Threaded(); - - // essaie de remplacer une propriété Threaded d'une classe Threaded (invalide) - $this->data = new stdClass(); - } -} - -var_dump((new Task())->data); -]]> - - &example.outputs.similar; - - - - - - Cas d'utilisation de Volatile - -data = new Threaded(); - - // essaie de remplacer une propriété Threaded d'une classe Volatile (valide) - $this->data = new stdClass(); - } -} - -var_dump((new Task())->data); -]]> - - &example.outputs.similar; - - - - -
    - -     - -     - diff --git a/reference/pthreads/worker.xml b/reference/pthreads/worker.xml deleted file mode 100644 index 7e643b9204..0000000000 --- a/reference/pthreads/worker.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - La classe Worker - Worker - - - - -
    - &reftitle.intro; - - Les Threads Worker ont un contexte persistant, aussi, - ils devraient être utilisés de préférence aux Threads dans la plupart des cas. - - - Quand un Worker est démarré, la méthode run sera - exécutée, mais le Thread ne - s'arrêtera pas tant qu'une des conditions suivantes n'est pas atteinte : - - - - le Worker est hors de portée (aucune référence restante) ; - - - le développeur appelle shutdown ; - - - le script meurt. - - - - Ce qui signifie que le développeur peut réutiliser le contexte tout au long - de l'exécution ; placer des objets sur la pile du - Worker va entrainer le Worker - à exécuter la méthode run sur les objets empilés. - -
    - - -
    - &reftitle.classsynopsis; - - - - Worker - - - - - Worker - - - - extends - Thread - - - - Traversable - - - - Countable - - - - ArrayAccess - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.pthreads.entities.worker; - -     - diff --git a/reference/pthreads/worker/collect.xml b/reference/pthreads/worker/collect.xml deleted file mode 100644 index 05af5c3ac3..0000000000 --- a/reference/pthreads/worker/collect.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Worker::collect - Collecte les références des tâches terminées - - - - &reftitle.description; - - public intWorker::collect - Callablecollector - - - Permet au worker de collecter les références déterminées comme étant - des miettes par le collector éventuellement donné. - - - - - &reftitle.parameters; - - - collector - - - Une fonction de rappel qui retourne un booléen sur la possibilité de - collecter la tâche ou non. Seuls dans des cas rares un collecteur - personnalisé devrait être utilisé. - - - - - - - - &reftitle.returnvalues; - - Le nombre de tâches restantes sur la pile du worker à collecter. - - - - - &reftitle.examples; - - Un exemple basique de <methodname>Worker::collect</methodname> - -collect()} tâches sur la pile à collecter\n"; - -for ($i = 0; $i < 15; ++$i) { - $worker->stack(new class extends Threaded {}); -} - -echo "Il reste {$worker->collect()} tâches sur la pile à collecter\n"; - -$worker->start(); - -while ($worker->collect()); // bloque jusqu'à ce que toutes les tâches soient terminées - -echo "Il y a maintenant {$worker->collect()} tâches sur la pile à collecter\n"; - -$worker->shutdown(); -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/worker/getstacked.xml b/reference/pthreads/worker/getstacked.xml deleted file mode 100644 index a4af6a4aaf..0000000000 --- a/reference/pthreads/worker/getstacked.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - Worker::getStacked - Obtient la taille de pile restante - - - - &reftitle.description; - - public intWorker::getStacked - - - - Retourne le nombre de tâches laissées sur la pile - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le nombre de tâches actuellement en attente d'être exécutées par le worker - - - - - &reftitle.examples; - - Un exemple de base de <classname>Worker::getStacked</classname> - -stack(new class extends Threaded {}); -} - -echo "Il y a {$worker->getStacked()} tâches empilées\n"; -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/worker/isshutdown.xml b/reference/pthreads/worker/isshutdown.xml deleted file mode 100644 index 22294c121b..0000000000 --- a/reference/pthreads/worker/isshutdown.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - Worker::isShutdown - Détection de statut - - - - &reftitle.description; - - public boolWorker::isShutdown - - - - Indique si le Worker a été arrêté ou non. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne si le Worker a été arrêté ou non. - - - - - &reftitle.examples; - - Détecte le statut d'un worker - -start(); - -var_dump($worker->isShutdown()); - -$worker->shutdown(); - -var_dump($worker->isShutdown()); -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/worker/shutdown.xml b/reference/pthreads/worker/shutdown.xml deleted file mode 100644 index 4310e184a9..0000000000 --- a/reference/pthreads/worker/shutdown.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - Worker::shutdown - Arrêter le worker - - - - &reftitle.description; - - public boolWorker::shutdown - - - - Arrête le Worker après l'exécution de toutes les tâches empilées. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Éteint le worker référencé - -start(); -/* empiler/exécuter des tâches */ -var_dump($my->shutdown()); -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/worker/stack.xml b/reference/pthreads/worker/stack.xml deleted file mode 100644 index 505d5b7580..0000000000 --- a/reference/pthreads/worker/stack.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - Worker::stack - Empile la tâche - - - - &reftitle.description; - - public intWorker::stack - Threadedwork - - - Ajoute la nouvelle tâche à la pile du worker référencé. - - - - - &reftitle.parameters; - - - work - - - Objet Threaded à exécuter par le worker. - - - - - - - - &reftitle.returnvalues; - - La nouvelle taille de la pile. - - - - - &reftitle.examples; - - Empilage d'une tâche pour l'exécution sur un worker - -stack($work));]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/worker/unstack.xml b/reference/pthreads/worker/unstack.xml deleted file mode 100644 index e4b951e345..0000000000 --- a/reference/pthreads/worker/unstack.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - Worker::unstack - Dépile une tâche - - - - &reftitle.description; - - public intWorker::unstack - - - - Supprime la première tâche (la plus ancienne) de la pile. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La nouvelle taille de la pile. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL pthreads 3.0.0 - - Le paramètre pour spécifier la tâche à dépiler a été supprimé. - Maintenant, seule la première tâche dans la pile est supprimée. - - - - - - - - - &reftitle.examples; - - Supprime l'objet depuis la pile d'attente des Workers - -stack($work)); -var_dump($my->unstack()); -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/quickhash/book.xml b/reference/quickhash/book.xml deleted file mode 100644 index 9d6ebd1846..0000000000 --- a/reference/quickhash/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - Quickhash - Quickhash - - - &reftitle.intro; - - L'extension Quickhash contient un ensemble de classes spécifiques fortement typées - pour traiter des implémentations spécifiques de tableaux et de hachages. - - - - &reference.quickhash.setup; - &reference.quickhash.examples; - - &reference.quickhash.quickhashintset; - &reference.quickhash.quickhashinthash; - &reference.quickhash.quickhashstringinthash; - &reference.quickhash.quickhashintstringhash; - - diff --git a/reference/quickhash/examples.xml b/reference/quickhash/examples.xml deleted file mode 100644 index c4d9903a8d..0000000000 --- a/reference/quickhash/examples.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - &reftitle.examples; - - Exemple de Quickhash - -add( 1 ); -$set->add( 3 ); - -var_dump( $set->exists( 3 ) ); -var_dump( $set->exists( 4 ) ); - -$set->saveToFile( "/tmp/test-set.set" ); - -$newSet = QuickHashIntSet::loadFromFile( - "/tmp/test-set.set" -); - -var_dump( $newSet->exists( 3 ) ); -var_dump( $newSet->exists( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple d'ArrayAccess Quickhash - - -]]> - - &example.outputs.similar; - - - - - - Exemple d'Iterator Quickhash - - $value ) -{ - echo $key, ' => ', $value, "\n"; -} -?> -]]> - - &example.outputs.similar; - - -4234 -4 => 712314 -1 => 145926 -2 => 1415926 -3 => 72 -]]> - - - - Exemple de valeur de chaîne Quickhash - -add( 2, "one more" ); - -foreach( $hash as $key => $value ) -{ - echo $key, ' => ', $value, "\n"; -} -?> -]]> - - &example.outputs.similar; - - one million four hundred fifteen thousand nine hundred twenty six -2 => one more -]]> - - - - - diff --git a/reference/quickhash/quickhashinthash.xml b/reference/quickhash/quickhashinthash.xml deleted file mode 100644 index 4d7a3b978d..0000000000 --- a/reference/quickhash/quickhashinthash.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - La classe QuickHashIntHash - QuickHashIntHash - - - - -
    - &reftitle.intro; - - Cette classe enveloppe un hachage contenant des nombres entiers, où les - valeurs sont également des nombres entiers. Les hachages sont également - disponibles en tant qu'implémentation de l'interface ArrayAccess. - - - Les hachages peuvent être itérés avec foreach car l'interface Iterator est - également implémentée. L'ordre dans lequel les éléments sont retournés n'est pas - garanti. - -
    - - -
    - &reftitle.classsynopsis; - - - - QuickHashIntHash - - - - - QuickHashIntHash - - - - &Constants; - - const - int - QuickHashIntHash::CHECK_FOR_DUPES - 1 - - - const - int - QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC - 2 - - - const - int - QuickHashIntHash::HASHER_NO_HASH - 256 - - - const - int - QuickHashIntHash::HASHER_JENKINS1 - 512 - - - const - int - QuickHashIntHash::HASHER_JENKINS2 - 1024 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - QuickHashIntHash::CHECK_FOR_DUPES - - Si activé, l'ajout d'éléments dupliqués à un hachage (via QuickHashIntHash::add ou - QuickHashIntHash::loadFromFile) entraînera la suppression de ces éléments du - hachage. Cela prendra plus de temps, donc ne l'utiliser que si c'est nécessaire. - - - - - QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC - - Désactive l'utilisation du gestionnaire de mémoire interne de PHP pour les structures de jeu internes. - Avec cette option activée, les allocations internes ne compteront pas dans - les paramètres memory_limit. - - - - - QuickHashIntHash::HASHER_NO_HASH - - Sélectionne de ne pas utiliser de fonction de hachage, mais simplement - utiliser un modulo pour trouver l'index de la liste de seaux. Cela n'est pas plus rapide que le hachage normal, et - donne plus de collisions. - - - - - QuickHashIntHash::HASHER_JENKINS1 - - Ceci est la fonction de hachage par défaut pour transformer les hachages entiers - en index de liste de seaux. - - - - - QuickHashIntHash::HASHER_JENKINS2 - - Sélectionne un algorithme de hachage de variante. - - - - -
    - - - -     - - &reference.quickhash.entities.quickhashinthash; - -     - diff --git a/reference/quickhash/quickhashinthash/add.xml b/reference/quickhash/quickhashinthash/add.xml deleted file mode 100644 index 25c5d36fa0..0000000000 --- a/reference/quickhash/quickhashinthash/add.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - QuickHashIntHash::add - Cette méthode ajoute une nouvelle entrée au hachage - - - - &reftitle.description; - - public boolQuickHashIntHash::add - intkey - intvalue - - - Cette méthode ajoute une nouvelle entrée au hachage, et retourne si l'entrée a été - ajoutée. Les entrées sont par défaut toujours ajoutées sauf si - QuickHashIntHash::CHECK_FOR_DUPES a été passé lors de la création du hachage. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à ajouter. - - - - - value - - - La valeur optionnelle de l'entrée à ajouter. Si aucune valeur n'est spécifiée, - 1 sera utilisé. - - - - - - - - &reftitle.returnvalues; - - &true; lorsque l'entrée a été ajoutée, et &false; si l'entrée n'a pas été ajoutée. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntHash::add</function> - -exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, 22 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, 12 ) ); - -echo "\navec vérification des doublons\n"; -$hash = new QuickHashIntHash( 1024, QuickHashIntHash::CHECK_FOR_DUPES ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, 78 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, 9 ) ); - -echo "\nvaleur par défaut\n"; -var_dump( $hash->add( 5 ) ); -var_dump( $hash->get( 5 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/construct.xml b/reference/quickhash/quickhashinthash/construct.xml deleted file mode 100644 index 3e8cfb0daa..0000000000 --- a/reference/quickhash/quickhashinthash/construct.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - QuickHashIntHash::__construct - Créer un nouvel objet QuickHashIntHash - - - - &reftitle.description; - - public QuickHashIntHash::__construct - intsize - intoptions - - - Ce constructeur crée un nouvel objet QuickHashIntHash. La taille est le nombre de - listes de seaux à créer. Plus il y a de listes, moins on aura de collisions. - Les options sont également prises en charge. - - - - - &reftitle.parameters; - - - size - - - La quantité de listes de seaux à configurer. Le nombre que l'on passe sera - automatiquement arrondi à la puissance de deux suivante. Il est également - automatiquement limité de 64 à 4194304. - - - - - options - - - Les options qu'il est possible de passer sont: QuickHashIntHash::CHECK_FOR_DUPES, - qui s'assure qu'aucune entrée dupliquée n'est ajoutée au hachage; - QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC pour ne pas utiliser le gestionnaire de mémoire interne de PHP - ainsi que l'une des QuickHashIntHash::HASHER_NO_HASH, - QuickHashIntHash::HASHER_JENKINS1 ou QuickHashIntHash::HASHER_JENKINS2. - Ces trois derniers configurent l'algorithme de hachage à utiliser. Toutes les options - peuvent être combinées en utilisant des masques de bits. - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouvel objet QuickHashIntHash. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntHash::__construct</function> - - -]]> - - - - - - - diff --git a/reference/quickhash/quickhashinthash/delete.xml b/reference/quickhash/quickhashinthash/delete.xml deleted file mode 100644 index 134c4cd0b1..0000000000 --- a/reference/quickhash/quickhashinthash/delete.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - QuickHashIntHash::delete - Cette méthode supprime une entrée du hachage - - - - &reftitle.description; - - public boolQuickHashIntHash::delete - intkey - - - Cette méthode supprime une entrée du hachage, et retourne si l'entrée a été - supprimée. Les structures mémoire associées ne seront pas libérées immédiatement, - mais plutôt lorsque le hachage lui-même est libéré. - - - Les éléments ne peuvent pas être supprimés lorsque le hachage est utilisé dans un itérateur. La - méthode ne lancera pas d'exception, mais renverra simplement &false; comme cela se - produirait avec tout autre échec de suppression. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à supprimer. - - - - - - - - &reftitle.returnvalues; - - &true; lorsque l'entrée a été supprimée, et &false; si l'entrée n'a pas été supprimée. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntHash::delete</function> - -exists( 4 ) ); -var_dump( $hash->add( 4, 5 ) ); -var_dump( $hash->delete( 4 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->delete( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/exists.xml b/reference/quickhash/quickhashinthash/exists.xml deleted file mode 100644 index 5d74a116ab..0000000000 --- a/reference/quickhash/quickhashinthash/exists.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - QuickHashIntHash::exists - Cette méthode vérifie si une clé fait partie du hachage - - - - &reftitle.description; - - public boolQuickHashIntHash::exists - intkey - - - Cette méthode vérifie si une entrée avec la clé fournie existe dans le - hachage. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à vérifier si elle existe dans le hachage. - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; lorsque l'entrée est trouvée, ou &false; lorsque l'entrée n'est pas - trouvée. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntHash::exists</function> - -add( $key, 56 ); -} - -echo "Exécution de 1000 tests : ", microtime( true ), "\n"; -foreach( $testForEntries as $key ) -{ - $foundCount += $hash->exists( $key ); -} -echo "Terminé, $foundCount trouvés : ", microtime( true ), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/get.xml b/reference/quickhash/quickhashinthash/get.xml deleted file mode 100644 index 3b1d313a0b..0000000000 --- a/reference/quickhash/quickhashinthash/get.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - QuickHashIntHash::get - Cette méthode récupère une valeur du hachage par sa clé - - - - &reftitle.description; - - public intQuickHashIntHash::get - intkey - - - Cette méthode récupère une valeur du hachage par sa clé. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à récupérer. - - - - - - - - &reftitle.returnvalues; - - La valeur si la clé existe, ou &null; si la clé n'était pas une partie du hachage. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntHash::get</function> - -get( 1 ) ); - -var_dump( $hash->add( 2 ) ); -var_dump( $hash->get( 2 ) ); - -var_dump( $hash->add( 3, 5 ) ); -var_dump( $hash->get( 3 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/getsize.xml b/reference/quickhash/quickhashinthash/getsize.xml deleted file mode 100644 index e3694ae543..0000000000 --- a/reference/quickhash/quickhashinthash/getsize.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - QuickHashIntHash::getSize - Renvoie le nombre d'éléments dans le hachage - - - - &reftitle.description; - - public intQuickHashIntHash::getSize - - - Renvoie le nombre d'éléments dans le hachage. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre d'éléments dans le hachage. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntHash::getSize</function> - -add( 2 ) ); -var_dump( $hash->add( 3, 5 ) ); -var_dump( $hash->getSize() ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/loadfromfile.xml b/reference/quickhash/quickhashinthash/loadfromfile.xml deleted file mode 100644 index 1592fe878a..0000000000 --- a/reference/quickhash/quickhashinthash/loadfromfile.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - QuickHashIntHash::loadFromFile - Cette méthode d'usine crée un hachage à partir d'un fichier - - - - &reftitle.description; - - public static QuickHashIntHashQuickHashIntHash::loadFromFile - stringfilename - intoptions - - - Cette méthode d'usine crée un nouveau hachage à partir d'un fichier de définition sur disque. Le - format de fichier consiste en une signature 'QH\0x11\0', le nombre d'éléments en tant - qu'entier signé 32 bits en Endianness système, suivi d'entiers 32 bits signés empaquetés ensemble - dans l'Endianness que le système sur lequel le code s'exécute utilise. Pour chaque élément de hachage, il y a deux entiers 32 bits signés - stockés. Le premier de chaque élément est la clé, et le second est la valeur - appartenant à la clé. Un exemple pourrait être : - - - Format de fichier QuickHash IntHash - - - - Format de fichier QuickHash IntHash - - - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier à partir duquel lire le hachage. - - - - - options - - - Les mêmes options que le constructeur de la classe; à l'exception de l'option - size qui est ignorée. Elle est automatiquement calculée pour être la même que le - nombre d'entrées dans le hachage, arrondie à la puissance de deux la plus proche - avec une limite maximale de 4194304. - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouveau QuickHashIntHash. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntHash::loadFromFile</function> - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/loadfromstring.xml b/reference/quickhash/quickhashinthash/loadfromstring.xml deleted file mode 100644 index 88dd00fe98..0000000000 --- a/reference/quickhash/quickhashinthash/loadfromstring.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - QuickHashIntHash::loadFromString - Cette méthode d'usine crée un hachage à partir d'une chaîne de caractères - - - - &reftitle.description; - - public static QuickHashIntHashQuickHashIntHash::loadFromString - stringcontents - intoptions - - - Cette méthode d'usine crée un nouveau hachage à partir d'une définition dans une chaîne de caractères. Le - format de fichier consiste en des entiers signés 32 bits empaquetés ensemble dans l'Endianness que le système - sur lequel le code s'exécute utilise. Pour chaque élément de hachage, il y a deux entiers 32 bits signés - stockés ensemble. Le premier de chaque élément est la clé, et le second est la valeur appartenant à la clé. - - - - - &reftitle.parameters; - - - contents - - - La chaîne contenant un format sérialisé du hachage. - - - - - options - - - Les mêmes options que le constructeur de la classe; à l'exception de l'option - size qui est ignorée. Elle est automatiquement calculée pour être la même que le - nombre d'entrées dans le hachage, arrondie à la puissance de deux la plus proche - avec une limite maximale de 4194304. - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouveau QuickHashIntHash. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntHash::loadFromString</function> - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/savetofile.xml b/reference/quickhash/quickhashinthash/savetofile.xml deleted file mode 100644 index 39a32cd74b..0000000000 --- a/reference/quickhash/quickhashinthash/savetofile.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - QuickHashIntHash::saveToFile - Cette méthode stocke un hachage en mémoire sur disque - - - - &reftitle.description; - - public voidQuickHashIntHash::saveToFile - stringfilename - - - Cette méthode stocke un hachage existant dans un fichier sur disque, dans le même format - que QuickHashIntHash::loadFromFile peut lire. - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier dans lequel stocker le hachage. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntHash::saveToFile</function> - -exists( 4 ) ); -var_dump( $hash->add( 4, 43 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->add( 4, 52 ) ); - -$hash->saveToFile( '/tmp/test.hash' ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashinthash/savetostring.xml b/reference/quickhash/quickhashinthash/savetostring.xml deleted file mode 100644 index a2558ce00f..0000000000 --- a/reference/quickhash/quickhashinthash/savetostring.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - QuickHashIntHash::saveToString - Cette méthode renvoie une version sérialisée du hachage - - - - &reftitle.description; - - public stringQuickHashIntHash::saveToString - - - Cette méthode renvoie une version sérialisée du hachage dans le même format que - QuickHashIntHash::loadFromString peut lire. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Cette méthode renvoie une chaîne de caractères contenant une version sérialisée du hachage. - Chaque élément est stocké sous la forme d'une valeur de quatre octets dans l'Endianness que - le système actuel utilise. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntHash::saveToString</function> - -exists( 4 ) ); -var_dump( $hash->add( 4, 34 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->add( 4, 55 ) ); - -var_dump( $hash->saveToString() ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashinthash/set.xml b/reference/quickhash/quickhashinthash/set.xml deleted file mode 100644 index 5c2ba4d7bd..0000000000 --- a/reference/quickhash/quickhashinthash/set.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - QuickHashIntHash::set - Cette méthode met à jour une entrée dans le hachage avec une nouvelle valeur, ou - ajoute une nouvelle entrée si l'entrée n'existe pas - - - - &reftitle.description; - - public intQuickHashIntHash::set - intkey - intvalue - - - Cette méthode tente de mettre à jour une entrée avec une nouvelle valeur. Si l'entrée - n'existait pas, elle ajoutera une nouvelle entrée. Elle retourne si l'entrée a été - ajoutée ou mise à jour. Si des clés en double sont présentes, seul le premier - élément trouvé sera mis à jour. Utiliser - QuickHashIntHash::CHECK_FOR_DUPES lors de la création du hachage pour empêcher les clés en double - de faire partie du hachage. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à ajouter ou mettre à jour. - - - - - value - - - La nouvelle valeur à mettre à jour l'entrée. - - - - - - - - &reftitle.returnvalues; - - 2 si l'entrée a été nouvellement ajoutée, 1 si l'entrée a été trouvée et mise à jour, ou 0 - s'il y a eu une erreur. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntHash::set</function> - -Add\n"; -var_dump($hash->get(46692)); -var_dump($hash->set(46692, 16091)); -var_dump($hash->get(46692)); - -echo "\n\nSet->Update\n"; -var_dump($hash->set(46692, 29906)); -var_dump($hash->get(46692)); -]]> - - &example.outputs.similar; - -Add -bool(false) -int(2) -int(16091) - -Set->Update -int(1) -int(29906) -]]> - - - - - - - diff --git a/reference/quickhash/quickhashinthash/update.xml b/reference/quickhash/quickhashinthash/update.xml deleted file mode 100644 index e23e3545d4..0000000000 --- a/reference/quickhash/quickhashinthash/update.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - QuickHashIntHash::update - Cette méthode met à jour une entrée dans le hachage avec une nouvelle valeur - - - - &reftitle.description; - - public boolQuickHashIntHash::update - intkey - intvalue - - - Cette méthode met à jour une entrée avec une nouvelle valeur, et retourne si - l'entrée a été mise à jour. Si des clés en double sont présentes, seul le premier - élément trouvé sera mis à jour. Utiliser QuickHashIntHash::CHECK_FOR_DUPES lors de la création du hachage - pour empêcher les clés en double de faire partie du hachage. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à mettre à jour. - - - - - value - - - La nouvelle valeur pour mettre à jour l'entrée. - - - - - - - - &reftitle.returnvalues; - - &true; lorsque l'entrée a été trouvée et mise à jour, et &false; si l'entrée n'était pas - déjà présente dans le hachage. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntHash::update</function> - -add( 141421, 173205 ) ); -var_dump( $hash->update( 141421, 223606 ) ); -var_dump( $hash->get( 141421 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset.xml b/reference/quickhash/quickhashintset.xml deleted file mode 100644 index 6303c1007a..0000000000 --- a/reference/quickhash/quickhashintset.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - La classe QuickHashIntSet - QuickHashIntSet - - - - -
    - &reftitle.intro; - - Cette classe enveloppe un ensemble contenant des nombres entiers. - - - Les ensembles peuvent être utilisés pour stocker des valeurs uniques avec foreach car l'interface Iterator est - implémentée. L'ordre dans lequel les éléments sont retournés n'est pas - garanti. - -
    - - -
    - &reftitle.classsynopsis; - - - - QuickHashIntSet - - - - - QuickHashIntSet - - - - &Constants; - - const - int - QuickHashIntSet::CHECK_FOR_DUPES - 1 - - - const - int - QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC - 2 - - - const - int - QuickHashIntSet::HASHER_NO_HASH - 256 - - - const - int - QuickHashIntSet::HASHER_JENKINS1 - 512 - - - const - int - QuickHashIntSet::HASHER_JENKINS2 - 1024 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - QuickHashIntSet::CHECK_FOR_DUPES - - Si activé, l'ajout d'éléments dupliqués à un ensemble (via QuickHashIntSet::add ou - QuickHashIntSet::loadFromFile) entraînera la suppression de ces éléments de l'ensemble. - Cela prendra plus de temps, donc n'utiliser cette option que si nécessaire. - - - - - QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC - - Désactive l'utilisation du gestionnaire de mémoire interne de PHP - pour les structures de jeu internes. Avec cette option activée, les allocations internes ne - compteront pas pour les paramètres memory_limit. - - - - - QuickHashIntSet::HASHER_NO_HASH - - Sélectionne de ne pas utiliser de fonction de hachage, mais simplement - utiliser un modulo pour trouver l'index de la liste de seaux. Cela n'est pas plus rapide que le hachage normal, et - donne plus de collisions. - - - - - QuickHashIntSet::HASHER_JENKINS1 - - Ceci est la fonction de hachage par défaut pour transformer les hachages entiers - en index de liste de seaux. - - - - - QuickHashIntSet::HASHER_JENKINS2 - - Sélectionne un algorithme de hachage de variante. - - - - -
    - - - -     - - &reference.quickhash.entities.quickhashintset; - -     - diff --git a/reference/quickhash/quickhashintset/add.xml b/reference/quickhash/quickhashintset/add.xml deleted file mode 100644 index 77b1c8ac5f..0000000000 --- a/reference/quickhash/quickhashintset/add.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - QuickHashIntSet::add - Cette méthode ajoute une nouvelle entrée à l'ensemble - - - - &reftitle.description; - - public boolQuickHashIntSet::add - intkey - - - Cette méthode ajoute une nouvelle entrée à l'ensemble, et retourne si l'entrée - a été ajoutée. Les entrées sont par défaut toujours ajoutées sauf si - QuickHashIntSet::CHECK_FOR_DUPES a été passé lors de la création de l'ensemble. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à ajouter. - - - - - - - - &reftitle.returnvalues; - - &true; lorsque l'entrée a été ajoutée, et &false; si l'entrée n'a pas été ajoutée. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntSet::add</function> - -exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); - -echo "\navec vérification des doublons\n"; -$set = new QuickHashIntSet( 1024, QuickHashIntSet::CHECK_FOR_DUPES ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset/construct.xml b/reference/quickhash/quickhashintset/construct.xml deleted file mode 100644 index 5686cd6184..0000000000 --- a/reference/quickhash/quickhashintset/construct.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - QuickHashIntSet::__construct - Créer un nouvel objet QuickHashIntSet - - - - &reftitle.description; - - public QuickHashIntSet::__construct - intsize - intoptions - - - Ce constructeur crée un nouvel QuickHashIntSet. La taille est le nombre de - liste de seaux à créer. Plus il y a de listes, moins il y aura de collisions. - Les options sont également supportées. - - - - - &reftitle.parameters; - - - size - - - La quantité de liste de seaux à configurer. Le nombre que l'on passe sera - automatiquement arrondi à la puissance de deux suivante. Il est également - automatiquement limité de 4 à 4194304. - - - - - options - - - Les options qu'il est possible de passer sont: QuickHashIntSet::CHECK_FOR_DUPES, - qui s'assure qu'aucune entrée dupliquée n'est ajoutée à l'ensemble; - QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC pour ne pas utiliser le gestionnaire de mémoire - interne de PHP ainsi que l'une des QuickHashIntSet::HASHER_NO_HASH, - QuickHashIntSet::HASHER_JENKINS1 ou QuickHashIntSet::HASHER_JENKINS2. - Ces trois derniers configurent l'algorithme de hachage à utiliser. Toutes les options - peuvent être combinées en utilisant des masques de bits. - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouvel objet QuickHashIntSet. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntSet::__construct</function> - - -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintset/delete.xml b/reference/quickhash/quickhashintset/delete.xml deleted file mode 100644 index 25494814e3..0000000000 --- a/reference/quickhash/quickhashintset/delete.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - QuickHashIntSet::delete - Cette méthode supprime une entrée de l'ensemble - - - - &reftitle.description; - - public boolQuickHashIntSet::delete - intkey - - - Cette méthode supprime une entrée de l'ensemble, et retourne si l'entrée - a été supprimée. Les structures mémoire associées ne seront pas libérées - immédiatement, mais plutôt lorsque l'ensemble lui-même sera libéré. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à supprimer. - - - - - - - - &reftitle.returnvalues; - - &true; lorsque l'entrée a été supprimée, et &false; si l'entrée n'a pas été supprimée. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntSet::delete</function> - -exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->delete( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->delete( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset/exists.xml b/reference/quickhash/quickhashintset/exists.xml deleted file mode 100644 index 8cba768e63..0000000000 --- a/reference/quickhash/quickhashintset/exists.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - QuickHashIntSet::exists - Cette méthode vérifie si une clé fait partie de l'ensemble - - - - &reftitle.description; - - public boolQuickHashIntSet::exists - intkey - - - Cette méthode vérifie si une entrée avec la clé fournie existe dans - l'ensemble. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à vérifier si elle existe dans l'ensemble. - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; lorsque l'entrée est trouvée, ou &false; lorsque l'entrée n'est pas - trouvée. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntSet::exists</function> - -add( $key ); -} - -echo "Exécution de 1000 tests : ", microtime( true ), "\n"; -foreach( $testForEntries as $key ) -{ - $foundCount += $set->exists( $key ); -} -echo "Terminé, $foundCount trouvés : ", microtime( true ), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset/getsize.xml b/reference/quickhash/quickhashintset/getsize.xml deleted file mode 100644 index 30e49e49db..0000000000 --- a/reference/quickhash/quickhashintset/getsize.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - QuickHashIntSet::getSize - Renvoie le nombre d'éléments dans l'ensemble - - - - &reftitle.description; - - publicintQuickHashIntSet::getSize - - - Renvoie le nombre d'éléments dans l'ensemble. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre d'éléments dans l'ensemble. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntSet::getSize</function> - -add( 2 ) ); -var_dump( $set->add( 3 ) ); -var_dump( $set->getSize() ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset/loadfromfile.xml b/reference/quickhash/quickhashintset/loadfromfile.xml deleted file mode 100644 index a49ba7589b..0000000000 --- a/reference/quickhash/quickhashintset/loadfromfile.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - QuickHashIntSet::loadFromFile - Cette méthode d'usine crée un ensemble à partir d'un fichier - - - - &reftitle.description; - - public static QuickHashIntSetQuickHashIntSet::loadFromFile - stringfilename - intsize - intoptions - - - Cette méthode d'usine crée un nouvel ensemble à partir d'un fichier sur disque. Le - format du fichier consiste en des entiers signés de 32 bits emballés ensemble dans - l'ordre d'octets que le système sur lequel le code s'exécute utilise. - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier à partir duquel lire l'ensemble. - - - - - size - - - La quantité de listes de seaux à configurer. Le nombre que l'on passe sera - automatiquement arrondi à la puissance de deux suivante. Il est également - automatiquement limité de 4 à 4194304. - - - - - options - - - Les mêmes options que le constructeur de la classe; sauf que l'option de taille - est ignorée. Elle est automatiquement calculée pour être la même que le nombre - d'entrées dans l'ensemble, arrondie à la puissance de deux la plus proche - avec une limite maximale de 4194304. - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouveau QuickHashIntSet. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntSet::loadFromFile</function> - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset/loadfromstring.xml b/reference/quickhash/quickhashintset/loadfromstring.xml deleted file mode 100644 index 7680ba2f2f..0000000000 --- a/reference/quickhash/quickhashintset/loadfromstring.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - QuickHashIntSet::loadFromString - Cette méthode d'usine crée un ensemble à partir d'une chaîne - - - - &reftitle.description; - - public static QuickHashIntSetQuickHashIntSet::loadFromString - stringcontents - intsize - intoptions - - - Cette méthode d'usine crée un nouvel ensemble à partir d'une chaîne. Le - format du fichier consiste en des entiers signés de 32 bits emballés ensemble dans - l'ordre d'octets que le système sur lequel le code s'exécute utilise. - - - - - &reftitle.parameters; - - - contents - - - La chaîne contenant un format sérialisé de l'ensemble. - - - - - size - - - La quantité de listes de seaux à configurer. Le nombre que l'on passe sera - automatiquement arrondi à la puissance de deux suivante. Il est également - automatiquement limité de 4 à 4194304. - - - - - options - - - Les mêmes options que le constructeur de la classe; sauf que l'option de taille - est ignorée. Elle est automatiquement calculée pour être la même que le nombre - d'entrées dans l'ensemble, arrondie à la puissance de deux la plus proche - avec une limite maximale de 4194304. - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouveau QuickHashIntSet. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntSet::loadFromString</function> - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset/savetofile.xml b/reference/quickhash/quickhashintset/savetofile.xml deleted file mode 100644 index 5b49aa8678..0000000000 --- a/reference/quickhash/quickhashintset/savetofile.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - QuickHashIntSet::saveToFile - Cette méthode stocke un ensemble en mémoire sur disque - - - - &reftitle.description; - - public voidQuickHashIntSet::saveToFile - stringfilename - - - Cette méthode stocke un ensemble existant dans un fichier sur disque, dans le même format - que QuickHashIntSet::loadFromFile peut lire. - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier dans lequel stocker l'ensemble. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntSet::saveToFile</function> - -exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); - -$set->saveToFile( '/tmp/test.set' ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintset/savetostring.xml b/reference/quickhash/quickhashintset/savetostring.xml deleted file mode 100644 index 2c29304341..0000000000 --- a/reference/quickhash/quickhashintset/savetostring.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - QuickHashIntSet::saveToString - Cette méthode retourne une version sérialisée de l'ensemble - - - - &reftitle.description; - - public stringQuickHashIntSet::saveToString - - - Cette méthode retourne une version sérialisée de l'ensemble dans le même format que - QuickHashIntSet::loadFromString peut lire. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Cette méthode retourne une chaîne de caractères contenant une version sérialisée de l'ensemble. - Chaque élément est stocké sous forme de valeur de quatre octets dans l'ordre d'octets que le - système actuel utilise. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntSet::saveToString</function> - -exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); - -var_dump( $set->saveToString() ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash.xml b/reference/quickhash/quickhashintstringhash.xml deleted file mode 100644 index b99f04dec3..0000000000 --- a/reference/quickhash/quickhashintstringhash.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - La classe QuickHashIntStringHash - QuickHashIntStringHash - - - - -
    - &reftitle.intro; - - Cette classe enveloppe un tableau contenant des nombres entiers, où les - valeurs sont des chaînes de caractères. Les tableaux sont également - disponibles en tant qu'implémentation de l'interface ArrayAccess. - - - Les hachages peuvent également être parcourus avec foreach car l'interface Iterator est - implémentée. L'ordre dans lequel les éléments sont retournés n'est pas - garanti. - -
    - - -
    - &reftitle.classsynopsis; - - - - QuickHashIntStringHash - - - - - QuickHashIntStringHash - - - - &Constants; - - const - int - QuickHashIntStringHash::CHECK_FOR_DUPES - 1 - - - const - int - QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC - 2 - - - const - int - QuickHashIntStringHash::HASHER_NO_HASH - 256 - - - const - int - QuickHashIntStringHash::HASHER_JENKINS1 - 512 - - - const - int - QuickHashIntStringHash::HASHER_JENKINS2 - 1024 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - QuickHashIntStringHash::CHECK_FOR_DUPES - - Si activé, ajouter des éléments dupliqués à un ensemble (via QuickHashIntStringHash::add ou - QuickHashIntStringHash::loadFromFile) entraînera la suppression de ces éléments de l'ensemble. - Cela prendra plus de temps, donc ne l'utiliser que si nécessaire. - - - - - QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC - - Désactive l'utilisation du gestionnaire de mémoire interne de PHP pour - les structures de jeu internes. Avec cette option activée, les allocations internes ne compteront pas - vers les paramètres memory_limit. - - - - - QuickHashIntStringHash::HASHER_NO_HASH - - Sélectionne de ne pas utiliser de fonction de hachage, mais simplement - utiliser un modulo pour trouver l'index de la liste de seaux. Cela n'est pas plus rapide que le hachage normal, et - donne plus de collisions. - - - - - QuickHashIntStringHash::HASHER_JENKINS1 - - Ceci est la fonction de hachage par défaut pour transformer les hachages entiers - en index de liste de seaux. - - - - - QuickHashIntStringHash::HASHER_JENKINS2 - - Sélectionne un algorithme de hachage de variantes. - - - - -
    - - - -     - - &reference.quickhash.entities.quickhashintstringhash; - -     - diff --git a/reference/quickhash/quickhashintstringhash/add.xml b/reference/quickhash/quickhashintstringhash/add.xml deleted file mode 100644 index 75437f42fa..0000000000 --- a/reference/quickhash/quickhashintstringhash/add.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - QuickHashIntStringHash::add - Cette méthode ajoute une nouvelle entrée au hachage - - - - &reftitle.description; - - public boolQuickHashIntStringHash::add - intkey - stringvalue - - - Cette méthode ajoute une nouvelle entrée au hachage, et retourne si l'entrée a été - ajoutée. Les entrées sont par défaut toujours ajoutées sauf si - QuickHashIntStringHash::CHECK_FOR_DUPES a été passé lors de la création du hachage. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à ajouter. - - - - - value - - - La valeur de l'entrée à ajouter. Si une valeur non-string est passée, elle sera - convertie en string automatiquement si possible. - - - - - - - - &reftitle.returnvalues; - - &true; lorsque l'entrée a été ajoutée, et &false; si l'entrée n'a pas été ajoutée. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntStringHash::add</function> - -exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, "twenty two" ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, "twelve" ) ); - -echo "\navec vérification des doublons\n"; -$hash = new QuickHashIntStringHash( 1024, QuickHashIntStringHash::CHECK_FOR_DUPES ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, "seventy eight" ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, "nine" ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/construct.xml b/reference/quickhash/quickhashintstringhash/construct.xml deleted file mode 100644 index 027f1c2fcf..0000000000 --- a/reference/quickhash/quickhashintstringhash/construct.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - QuickHashIntStringHash::__construct - Créer un nouvel objet QuickHashIntStringHash - - - - &reftitle.description; - - public QuickHashIntStringHash::__construct - intsize - intoptions0 - - - Ce constructeur crée un nouvel objet QuickHashIntStringHash. La taille est le nombre de - listes de seaux à créer. Plus il y a de listes, moins il y aura de collisions. - Les options sont également prises en charge. - - - - - &reftitle.parameters; - - - size - - - La quantité de listes de seaux à configurer. Le nombre que l'on passe sera - automatiquement arrondi à la puissance de deux suivante. Il est également - automatiquement limité de 64 à 4194304. - - - - - options - - - Les options qu'il est possible de passer sont : QuickHashIntStringHash::CHECK_FOR_DUPES, - qui s'assure qu'aucune entrée dupliquée n'est ajoutée au hachage ; - QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC pour ne pas utiliser le gestionnaire de mémoire interne de PHP - ainsi que l'une des valeurs QuickHashIntStringHash::HASHER_NO_HASH, - QuickHashIntStringHash::HASHER_JENKINS1 ou QuickHashIntStringHash::HASHER_JENKINS2. - Ces trois dernières configurent l'algorithme de hachage à utiliser. Toutes les options - peuvent être combinées en utilisant des masques de bits. - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouvel objet QuickHashIntStringHash. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntStringHash::__construct</function> - - -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/delete.xml b/reference/quickhash/quickhashintstringhash/delete.xml deleted file mode 100644 index f61941a074..0000000000 --- a/reference/quickhash/quickhashintstringhash/delete.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - QuickHashIntStringHash::delete - Cette méthode supprime une entrée du hachage - - - - &reftitle.description; - - public boolQuickHashIntStringHash::delete - intkey - - - Cette méthode supprime une entrée du hachage, et retourne si l'entrée a été - supprimée. Les structures mémoire associées ne seront pas libérées immédiatement, - mais plutôt lorsque le hachage lui-même est libéré. - - - Les éléments ne peuvent pas être supprimés lorsque le hachage est utilisé dans un itérateur. La - méthode ne lancera pas d'exception, mais renverra simplement &false; comme cela se - produirait avec tout autre échec de suppression. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à supprimer. - - - - - - - - &reftitle.returnvalues; - - &true; lorsque l'entrée a été supprimée, et &false; si l'entrée n'a pas été supprimée. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntStringHash::delete</function> - -exists( 4 ) ); -var_dump( $hash->add( 4, "five" ) ); -var_dump( $hash->delete( 4 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->delete( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/exists.xml b/reference/quickhash/quickhashintstringhash/exists.xml deleted file mode 100644 index 45770c4898..0000000000 --- a/reference/quickhash/quickhashintstringhash/exists.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - QuickHashIntStringHash::exists - Cette méthode vérifie si une clé fait partie du hachage - - - - &reftitle.description; - - public boolQuickHashIntStringHash::exists - intkey - - - Cette méthode vérifie si une entrée avec la clé fournie existe dans le - hachage. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à vérifier si elle existe dans le hachage. - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; lorsque l'entrée a été trouvée, ou &false; lorsque l'entrée n'est pas - trouvée. - - - - - diff --git a/reference/quickhash/quickhashintstringhash/get.xml b/reference/quickhash/quickhashintstringhash/get.xml deleted file mode 100644 index a4652642b4..0000000000 --- a/reference/quickhash/quickhashintstringhash/get.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - QuickHashIntStringHash::get - Cette méthode récupère une valeur du hachage par sa clé - - - - &reftitle.description; - - public mixedQuickHashIntStringHash::get - intkey - - - Cette méthode récupère une valeur du hachage par sa clé. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à récupérer. - - - - - - - - &reftitle.returnvalues; - - La valeur si la clé existe, ou &null; si la clé n'était pas une partie du hachage. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntStringHash::get</function> - -get( 1 ) ); - -var_dump( $hash->add( 2, "two" ) ); -var_dump( $hash->get( 2 ) ); - -var_dump( $hash->add( 3, 5 ) ); -var_dump( $hash->get( 3 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/getsize.xml b/reference/quickhash/quickhashintstringhash/getsize.xml deleted file mode 100644 index 2844a9e774..0000000000 --- a/reference/quickhash/quickhashintstringhash/getsize.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - QuickHashIntStringHash::getSize - Renvoie le nombre d'éléments dans le hachage - - - - &reftitle.description; - - public intQuickHashIntStringHash::getSize - - - Renvoie le nombre d'éléments dans le hachage. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre d'éléments dans le hachage. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntStringHash::getSize</function> - -add( 2, "two" ) ); -var_dump( $hash->add( 3, 5 ) ); -var_dump( $hash->getSize() ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/loadfromfile.xml b/reference/quickhash/quickhashintstringhash/loadfromfile.xml deleted file mode 100644 index c80adf2981..0000000000 --- a/reference/quickhash/quickhashintstringhash/loadfromfile.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - QuickHashIntStringHash::loadFromFile - Cette méthode d'usine crée un hachage à partir d'un fichier - - - - &reftitle.description; - - public static QuickHashIntStringHashQuickHashIntStringHash::loadFromFile - stringfilename - intsize0 - intoptions0 - - - Cette méthode d'usine crée un nouveau hachage à partir d'un fichier de définition sur le disque. Le - format du fichier consiste en une signature 'QH\0x12\0', le nombre d'éléments en tant - qu'entier signé 32 bits en Endianness du système, un entier non signé 32 bits - contenant le nombre de données d'éléments à suivre en caractères. Ces données - d'éléments contiennent toutes les chaînes. Après l'en-tête et les chaînes, les - éléments suivent par paires de deux entiers non signés 32 bits où le premier - est la clé, et le second l'index dans la chaîne de données d'éléments. - Un exemple pourrait être : - - - Format de fichier QuickHash IntString - - - - Format de fichier QuickHash IntString - - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier à partir duquel lire le hachage. - - - - - size - - - La quantité de listes de seaux à configurer. Le nombre que l'on passe sera - automatiquement arrondi à la puissance de deux suivante. Il est également - automatiquement limité de 4 à 4194304. - - - - - options - - - Les mêmes options que le constructeur de la classe ; sauf que l'option - size est ignorée. Elle est automatiquement calculée pour être la même que - le nombre d'entrées dans le hachage, arrondie à la puissance de deux la plus proche - avec une limite maximale de 4194304. - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouveau QuickHashIntStringHash. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntStringHash::loadFromFile</function> - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/loadfromstring.xml b/reference/quickhash/quickhashintstringhash/loadfromstring.xml deleted file mode 100644 index c61dcf1555..0000000000 --- a/reference/quickhash/quickhashintstringhash/loadfromstring.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - QuickHashIntStringHash::loadFromString - Cette méthode d'usine crée un hachage à partir d'une chaîne - - - - &reftitle.description; - - public static QuickHashIntStringHashQuickHashIntStringHash::loadFromString - stringcontents - intsize0 - intoptions0 - - - Cette méthode d'usine crée un nouveau hachage à partir d'une définition dans une chaîne. Le - format est le même que celui utilisé dans "loadFromFile". - - - - - &reftitle.parameters; - - - contents - - - La chaîne contenant un format sérialisé du hachage. - - - - - size - - - La quantité de listes de seaux à configurer. Le nombre que l'on passe sera - automatiquement arrondi à la puissance de deux suivante. Il est également - automatiquement limité de 4 à 4194304. - - - - - options - - - Les mêmes options que le constructeur de la classe ; sauf que l'option - size est ignorée. Elle est automatiquement calculée pour être la même que le - nombre d'entrées dans le hachage, arrondie à la puissance de deux la plus proche - avec une limite maximale de 4194304. - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouveau QuickHashIntStringHash. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntStringHash::loadFromString</function> - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/savetofile.xml b/reference/quickhash/quickhashintstringhash/savetofile.xml deleted file mode 100644 index 779bcf720a..0000000000 --- a/reference/quickhash/quickhashintstringhash/savetofile.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - QuickHashIntStringHash::saveToFile - Cette méthode stocke un hachage en mémoire sur disque - - - - &reftitle.description; - - public voidQuickHashIntStringHash::saveToFile - stringfilename - - - Cette méthode stocke un hachage existant dans un fichier sur disque, dans le même format - que loadFromFile() peut lire. - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier où stocker le hachage. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntStringHash::saveToFile</function> - -exists( 4 ) ); -var_dump( $hash->add( 4, "forty three" ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->add( 4, "fifty two" ) ); - -$hash->saveToFile( '/tmp/test.string.hash' ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/savetostring.xml b/reference/quickhash/quickhashintstringhash/savetostring.xml deleted file mode 100644 index d3a900198c..0000000000 --- a/reference/quickhash/quickhashintstringhash/savetostring.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - QuickHashIntStringHash::saveToString - Cette méthode renvoie une version sérialisée du hachage - - - - &reftitle.description; - - public stringQuickHashIntStringHash::saveToString - - - Cette méthode renvoie une version sérialisée du hachage dans le même format que - QuickHashIntStringHash::loadFromString peut lire. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Cette méthode renvoie une chaîne contenant une version sérialisée du hachage. - Chaque élément est stocké sous forme de valeur de quatre octets dans l'Endianness - que le système actuel utilise. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntStringHash::saveToString</function> - -exists( 4 ) ); -var_dump( $hash->add( 4, "thirty four" ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->add( 5, "fifty five" ) ); - -var_dump( $hash->saveToString() ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/set.xml b/reference/quickhash/quickhashintstringhash/set.xml deleted file mode 100644 index 810c69e6f7..0000000000 --- a/reference/quickhash/quickhashintstringhash/set.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - QuickHashIntStringHash::set - Cette méthode met à jour une entrée dans le hachage avec une nouvelle valeur, ou - ajoute une nouvelle entrée si l'entrée n'existe pas - - - - &reftitle.description; - - public intQuickHashIntStringHash::set - intkey - stringvalue - - - Cette méthode essaie de mettre à jour une entrée avec une nouvelle valeur. Si - l'entrée n'existait pas, elle ajoutera une nouvelle entrée. Elle renvoie si - l'entrée a été ajoutée ou mise à jour. Si des clés en double sont présentes, - seul le premier élément trouvé sera mis à jour. Utiliser - QuickHashIntStringHash::CHECK_FOR_DUPES lors de la création du hachage pour empêcher les clés en double - de faire partie du hachage. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à ajouter ou mettre à jour. - - - - - value - - - La valeur de l'entrée à ajouter. Si une non chaîne est passée, elle sera - convertie en chaîne automatiquement si possible. - - - - - - - - &reftitle.returnvalues; - - 2 si l'entrée a été trouvée et mise à jour, 1 si l'entrée a été nouvellement ajoutée ou 0 - s'il y a eu une erreur. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntStringHash::set</function> - -Add\n"; -var_dump( $hash->get( 46692 ) ); -var_dump( $hash->set( 46692, "sixteen thousand ninety one" ) ); -var_dump( $hash->get( 46692 ) ); - -echo "Set->Update\n"; -var_dump( $hash->set( 46692, "twenty nine thousand nine hundred six" ) ); -var_dump( $hash->get( 46692 ) ); -?> -]]> - - &example.outputs.similar; - -Add -bool(false) -int(2) -string(27) "sixteen thousand ninety one" -Set->Update -int(1) -string(37) "twenty nine thousand nine hundred six" -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/update.xml b/reference/quickhash/quickhashintstringhash/update.xml deleted file mode 100644 index 7d4375de2b..0000000000 --- a/reference/quickhash/quickhashintstringhash/update.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - QuickHashIntStringHash::update - Cette méthode met à jour une entrée dans le hachage avec une nouvelle valeur - - - - &reftitle.description; - - public boolQuickHashIntStringHash::update - intkey - stringvalue - - - Cette méthode met à jour une entrée avec une nouvelle valeur, et renvoie si - l'entrée a été mise à jour. Si des clés en double sont présentes, seul le - premier élément trouvé sera mis à jour. Utiliser QuickHashIntStringHash::CHECK_FOR_DUPES - lors de la création du hachage pour empêcher les clés en double de faire partie du hachage. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à mettre à jour. - - - - - value - - - La nouvelle valeur pour l'entrée. Si une non chaîne est passée, elle sera - convertie en chaîne automatiquement si possible. - - - - - - - - &reftitle.returnvalues; - - &true; lorsque l'entrée a été trouvée et mise à jour, et &false; si l'entrée n'était pas - déjà une partie du hachage. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashIntStringHash::update</function> - -add( 161803398, "--" ); -$hash->add( 314159265, "a lot" ); - -echo $hash->get( 161803398 ), "\n"; -echo $hash->get( 314159265 ), "\n"; - -var_dump( $hash->update( 314159265, "a lot plus one" ) ); -var_dump( $hash->update( 314159999, "a lot plus one" ) ); - -echo $hash->get( 161803398 ), "\n"; -echo $hash->get( 314159265 ), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash.xml b/reference/quickhash/quickhashstringinthash.xml deleted file mode 100644 index d6f267b436..0000000000 --- a/reference/quickhash/quickhashstringinthash.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - La classe QuickHashStringIntHash - QuickHashStringIntHash - - - - -
    - &reftitle.intro; - - Cette classe enveloppe un hachage contenant des chaînes de caractères, où les - valeurs sont des nombres entiers. Les hachages sont également - disponibles en tant qu'implémentation de l'interface ArrayAccess. - - - Les hachages peuvent également être parcourus avec foreach car l'interface Iterator est - implémentée. L'ordre dans lequel les éléments sont retournés n'est pas - garanti. - -
    - - -
    - &reftitle.classsynopsis; - - - - QuickHashStringIntHash - - - - - QuickHashStringIntHash - - - - &Constants; - - const - int - QuickHashStringIntHash::CHECK_FOR_DUPES - 1 - - - const - int - QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC - 2 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - QuickHashStringIntHash::CHECK_FOR_DUPES - - Si activé, l'ajout d'éléments dupliqués à un hachage (via QuickHashStringIntHash::add ou - QuickHashStringIntHash::loadFromFile) entraînera la suppression de ces éléments du - hachage. Cela prendra du temps supplémentaire, alors n'utiliser cette option que si nécessaire. - - - - - QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC - - Désactive l'utilisation du gestionnaire de mémoire interne de PHP pour les structures de - hachage internes. Avec cette option activée, les allocations internes ne seront pas prises en - compte dans les paramètres memory_limit. - - - - -
    - - - -     - - &reference.quickhash.entities.quickhashstringinthash; - -     - diff --git a/reference/quickhash/quickhashstringinthash/add.xml b/reference/quickhash/quickhashstringinthash/add.xml deleted file mode 100644 index c5a6f6b7f3..0000000000 --- a/reference/quickhash/quickhashstringinthash/add.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - QuickHashStringIntHash::add - Cette méthode ajoute une nouvelle entrée au hachage - - - - &reftitle.description; - - public boolQuickHashStringIntHash::add - stringkey - intvalue - - - Cette méthode ajoute une nouvelle entrée au hachage, et retourne si l'entrée - a été ajoutée. Les entrées sont par défaut toujours ajoutées sauf si - QuickHashStringIntHash::CHECK_FOR_DUPES a été passé lors de la création du hachage. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à ajouter. - - - - - value - - - La valeur de l'entrée à ajouter. - - - - - - - - &reftitle.returnvalues; - - &true; lorsque l'entrée a été ajoutée, et &false; si l'entrée n'a pas été ajoutée. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashStringIntHash::add</function> - -exists( "four" ) ); -var_dump( $hash->get( "four" ) ); -var_dump( $hash->add( "four", 22 ) ); -var_dump( $hash->exists( "four" ) ); -var_dump( $hash->get( "four" ) ); -var_dump( $hash->add( "four", 12 ) ); - -echo "\navec vérification des doublons\n"; -$hash = new QuickHashStringIntHash( 1024, QuickHashStringIntHash::CHECK_FOR_DUPES ); -var_dump( $hash ); -var_dump( $hash->exists( "four" ) ); -var_dump( $hash->get( "four" ) ); -var_dump( $hash->add( "four", 78 ) ); -var_dump( $hash->exists( "four" ) ); -var_dump( $hash->get( "four" ) ); -var_dump( $hash->add( "four", 9 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/construct.xml b/reference/quickhash/quickhashstringinthash/construct.xml deleted file mode 100644 index c1857b48a4..0000000000 --- a/reference/quickhash/quickhashstringinthash/construct.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - QuickHashStringIntHash::__construct - Créer un nouvel objet QuickHashStringIntHash - - - - &reftitle.description; - - public QuickHashStringIntHash::__construct - intsize - intoptions0 - - - Ce constructeur crée un nouvel objet QuickHashStringIntHash. La taille est le nombre de - listes de seaux à créer. Plus il y a de listes, moins il y aura de collisions. - Les options sont également prises en charge. - - - - - &reftitle.parameters; - - - size - - - La quantité de listes de seaux à configurer. Le nombre que l'on passe sera - automatiquement arrondi à la puissance de deux suivante. Il est également - automatiquement limité de 64 à 4194304. - - - - - options - - - Les options qu'il est possible de passer sont : - QuickHashStringIntHash::CHECK_FOR_DUPES, qui vérifie qu'aucune entrée dupliquée - n'est ajoutée au hachage et - QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC pour ne pas utiliser le gestionnaire de mémoire - interne de PHP. - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouvel objet QuickHashStringIntHash. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashStringIntHash::__construct</function> - - -]]> - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/delete.xml b/reference/quickhash/quickhashstringinthash/delete.xml deleted file mode 100644 index ffd4b499c8..0000000000 --- a/reference/quickhash/quickhashstringinthash/delete.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - QuickHashStringIntHash::delete - Cette méthode supprime une entrée du hachage - - - - &reftitle.description; - - public boolQuickHashStringIntHash::delete - stringkey - - - Cette méthode supprime une entrée du hachage, et retourne si l'entrée a été - supprimée ou non. Les structures mémoire associées ne seront pas libérées immédiatement, - mais plutôt lorsque le hachage lui-même est libéré. - - - Les éléments ne peuvent pas être supprimés lorsque le hachage est utilisé dans un itérateur. La - méthode ne lancera pas d'exception, mais renverra simplement &false; comme cela se produirait - avec tout autre échec de suppression. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à supprimer. - - - - - - - - &reftitle.returnvalues; - - &true; lorsque l'entrée a été supprimée, et &false; si l'entrée n'a pas été supprimée. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashStringIntHash::delete</function> - -exists( 'four' ) ); -var_dump( $hash->add( 'four', 5 ) ); -var_dump( $hash->get( 'four' ) ); -var_dump( $hash->delete( 'four' ) ); -var_dump( $hash->exists( 'four' ) ); -var_dump( $hash->get( 'four' ) ); -var_dump( $hash->delete( 'four' ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/exists.xml b/reference/quickhash/quickhashstringinthash/exists.xml deleted file mode 100644 index d1b89f72fa..0000000000 --- a/reference/quickhash/quickhashstringinthash/exists.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - QuickHashStringIntHash::exists - Cette méthode vérifie si une clé fait partie du hachage - - - - &reftitle.description; - - public boolQuickHashStringIntHash::exists - stringkey - - - Cette méthode vérifie si une entrée avec la clé fournie existe dans le - hachage. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à vérifier si elle existe dans le hachage. - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; lorsque l'entrée est trouvée, ou &false; lorsque l'entrée n'est pas - trouvée. - - - - - diff --git a/reference/quickhash/quickhashstringinthash/get.xml b/reference/quickhash/quickhashstringinthash/get.xml deleted file mode 100644 index e77679de41..0000000000 --- a/reference/quickhash/quickhashstringinthash/get.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - QuickHashStringIntHash::get - Cette méthode récupère une valeur du hachage par sa clé - - - - &reftitle.description; - - public mixedQuickHashStringIntHash::get - stringkey - - - Cette méthode récupère une valeur du hachage par sa clé. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à récupérer. - - - - - - - - &reftitle.returnvalues; - - La valeur si la clé existe, ou &null; si la clé n'était pas une partie du hachage. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashStringIntHash::get</function> - -get( "one" ) ); - -var_dump( $hash->add( "two", 2 ) ); -var_dump( $hash->get( "two" ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/getsize.xml b/reference/quickhash/quickhashstringinthash/getsize.xml deleted file mode 100644 index 19ee1ff935..0000000000 --- a/reference/quickhash/quickhashstringinthash/getsize.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - QuickHashStringIntHash::getSize - Renvoie le nombre d'éléments dans le hachage - - - - &reftitle.description; - - public intQuickHashStringIntHash::getSize - - - Renvoie le nombre d'éléments dans le hachage. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre d'éléments dans le hachage. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashStringIntHash::getSize</function> - -add( "two", 2 ) ); -var_dump( $hash->add( "three", 5 ) ); -var_dump( $hash->getSize() ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/loadfromfile.xml b/reference/quickhash/quickhashstringinthash/loadfromfile.xml deleted file mode 100644 index 06a8919c33..0000000000 --- a/reference/quickhash/quickhashstringinthash/loadfromfile.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - QuickHashStringIntHash::loadFromFile - Cette méthode d'usine crée un hachage à partir d'un fichier - - - - &reftitle.description; - - public static QuickHashStringIntHashQuickHashStringIntHash::loadFromFile - stringfilename - intsize0 - intoptions0 - - - Cette méthode d'usine crée un nouveau hachage à partir d'un fichier de définition sur le disque. Le - format du fichier se compose d'une signature 'QH\0x21\0', du nombre d'éléments en tant que - entier signé 32 bits en Endianness du système, d'un entier non signé 32 bits - contenant le nombre de données d'éléments à suivre en caractères. Ces données - d'éléments contiennent toutes les chaînes. Suit un autre entier signé 32 bits - contenant le nombre de listes de seaux. Après l'en-tête et les chaînes, - les éléments suivent. Ils sont ordonnés par liste de seaux de sorte que les clés ne - doivent pas être hachées pour restaurer le hachage. Pour chaque liste de seaux, les - informations suivantes sont stockées (toutes en entiers 32 bits) : l'index de la liste de seaux, - le nombre d'éléments dans cette liste, et ensuite par paire de deux - entiers non signés 32 bits les éléments, où le premier est l'index - dans la liste de chaînes contenant les clés, et le second la valeur. Un - exemple pourrait être : - - - Format de fichier QuickHash StringIntHash - - - - Format de fichier QuickHash IntHash - - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier à partir duquel lire le hachage. - - - - - size - - - Le nombre de listes de seaux à configurer. Le nombre que l'on passe sera - automatiquement arrondi à la puissance de deux suivante. Il est également - automatiquement limité de 4 à 4194304. - - - - - options - - - Les mêmes options que le constructeur de la classe; sauf que l'option - size est ignorée. Elle est lue à partir du format de fichier (contrairement aux - classes QuickHashIntHash et QuickHashIntStringHash, où elle est - automatiquement calculée à partir du nombre d'entrées dans le hachage.) - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouveau QuickHashStringIntHash. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashStringIntHash::loadFromFile</function> - - ', $hash->get( $k ), "\n"; -} -?> -]]> - - &example.outputs.similar; - - 48712 -12uf => 50343 -143q => 51974 -15d1 => 53605 -16mc => 55236 -17vn => 56867 -194y => 58498 -1ae9 => 60129 -1bnk => 61760 -1cwv => 63391 -1e66 => 65022 -1ffh => 66653 -1gos => 68284 -1hy3 => 69915 -1j7e => 71546 -1kgp => 73177 -]]> - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/loadfromstring.xml b/reference/quickhash/quickhashstringinthash/loadfromstring.xml deleted file mode 100644 index 7fc798ee28..0000000000 --- a/reference/quickhash/quickhashstringinthash/loadfromstring.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - QuickHashStringIntHash::loadFromString - Cette méthode d'usine crée un hachage à partir d'une chaîne - - - - &reftitle.description; - - public static QuickHashStringIntHashQuickHashStringIntHash::loadFromString - stringcontents - intsize0 - intoptions0 - - - Cette méthode d'usine crée un nouveau hachage à partir d'une définition dans une chaîne. Le - format est le même que celui utilisé dans "loadFromFile". - - - - - &reftitle.parameters; - - - contents - - - La chaîne contenant un format sérialisé du hachage. - - - - - size - - - La quantité de listes de seaux à configurer. Le nombre que l'on passe sera - automatiquement arrondi à la puissance de deux suivante. Il est également - automatiquement limité de 4 à 4194304. - - - - - options - - - Les mêmes options que le constructeur de la classe; sauf que l'option - size est ignorée. Elle est automatiquement calculée pour être la même que le - nombre d'entrées dans le hachage, arrondie à la puissance de deux la plus proche - avec une limite maximale de 4194304. - - - - - - - - &reftitle.returnvalues; - - Renvoie un nouveau QuickHashStringIntHash. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashStringIntHash::loadFromString</function> - - ', $hash->get( $k ), "\n"; -} -?> -]]> - - &example.outputs.similar; - - 48712 -12uf => 50343 -143q => 51974 -15d1 => 53605 -16mc => 55236 -17vn => 56867 -194y => 58498 -1ae9 => 60129 -1bnk => 61760 -1cwv => 63391 -1e66 => 65022 -1ffh => 66653 -1gos => 68284 -1hy3 => 69915 -1j7e => 71546 -1kgp => 73177 -]]> - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/savetofile.xml b/reference/quickhash/quickhashstringinthash/savetofile.xml deleted file mode 100644 index 8feb9844b2..0000000000 --- a/reference/quickhash/quickhashstringinthash/savetofile.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - QuickHashStringIntHash::saveToFile - Cette méthode stocke un hachage en mémoire sur le disque - - - - &reftitle.description; - - public voidQuickHashStringIntHash::saveToFile - stringfilename - - - Cette méthode stocke un hachage existant dans un fichier sur le disque, dans le même format - que loadFromFile() peut lire. - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier où stocker le hachage. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>QuickHashStringIntHash::saveToFile</function> - -add( "forty three", 42 ) ); -var_dump( $hash->add( "fifty two", 52 ) ); - -$hash->saveToFile( '/tmp/test.hash.string' ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/savetostring.xml b/reference/quickhash/quickhashstringinthash/savetostring.xml deleted file mode 100644 index 6e6907a596..0000000000 --- a/reference/quickhash/quickhashstringinthash/savetostring.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - QuickHashStringIntHash::saveToString - Cette méthode retourne une version sérialisée du hachage - - - - &reftitle.description; - - public stringQuickHashStringIntHash::saveToString - - - Cette méthode retourne une version sérialisée du hachage dans le même format que - QuickHashStringIntHash::loadFromString peut lire. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Cette méthode retourne une version sérialisée du hachage, dans le même format que - QuickHashStringIntHash::loadFromString peut lire. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashStringIntHash::saveToString</function> - -add( "forty three", 42 ) ); -var_dump( $hash->add( "fifty two", 52 ) ); - -var_dump( $hash->saveToString() ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/set.xml b/reference/quickhash/quickhashstringinthash/set.xml deleted file mode 100644 index 51ae4ef188..0000000000 --- a/reference/quickhash/quickhashstringinthash/set.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - QuickHashStringIntHash::set - Cette méthode met à jour une entrée dans le hachage avec une nouvelle valeur, ou - ajoute une nouvelle entrée si l'entrée n'existe pas - - - - &reftitle.description; - - public intQuickHashStringIntHash::set - stringkey - intvalue - - - Cette méthode met à jour une entrée avec une nouvelle valeur. Si l'entrée - n'existait pas, elle ajoutera une nouvelle entrée. Elle retourne si l'entrée - a été ajoutée ou mise à jour. Si des clés en double sont présentes, seul le - premier élément trouvé sera mis à jour. Utiliser - QuickHashStringIntHash::CHECK_FOR_DUPES lors de la création du hachage pour empêcher les clés en double - de faire partie du hachage. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à ajouter ou mettre à jour. - - - - - value - - - La valeur de l'entrée à ajouter. Si un non-chaîne est passé, il sera - converti en chaîne automatiquement si possible. - - - - - - - - &reftitle.returnvalues; - - 2 si l'entrée a été trouvée et mise à jour, 1 si l'entrée a été nouvellement ajoutée ou 0 - s'il y a eu une erreur. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashStringIntHash::set</function> - -Add\n"; -var_dump( $hash->get( "forty six thousand six hundred ninety two" ) ); -var_dump( $hash->set( "forty six thousand six hundred ninety two", 16091 ) ); -var_dump( $hash->get( "forty six thousand six hundred ninety two" ) ); - -echo "Set->Update\n"; -var_dump( $hash->set( "forty six thousand six hundred ninety two", 29906 ) ); -var_dump( $hash->get( "forty six thousand six hundred ninety two" ) ); -?> -]]> - - &example.outputs.similar; - -Add -bool(false) -int(2) -int(16091) -Set->Update -int(1) -int(29906) -]]> - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/update.xml b/reference/quickhash/quickhashstringinthash/update.xml deleted file mode 100644 index b32dfb5aac..0000000000 --- a/reference/quickhash/quickhashstringinthash/update.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - QuickHashStringIntHash::update - Cette méthode met à jour une entrée dans le hachage avec une nouvelle valeur - - - - &reftitle.description; - - public boolQuickHashStringIntHash::update - stringkey - intvalue - - - Cette méthode met à jour une entrée avec une nouvelle valeur, et retourne si - l'entrée a été mise à jour. Si des clés en double sont présentes, seul le - premier élément trouvé sera mis à jour. Utiliser QuickHashStringIntHash::CHECK_FOR_DUPES lors de - la création du hachage pour empêcher les clés en double de faire partie du hachage. - - - - - &reftitle.parameters; - - - key - - - La clé de l'entrée à mettre à jour. - - - - - value - - - La nouvelle valeur de l'entrée. Si une non chaîne est passée, elle sera - convertie en chaîne automatiquement si possible. - - - - - - - - &reftitle.returnvalues; - - &true; lorsque l'entrée a été trouvée et mise à jour, et &false; si l'entrée n'était pas - déjà une partie du hachage. - - - - - &reftitle.examples; - - Exemple de <function>QuickHashStringIntHash::update</function> - -add( 'six', 314159265 ); -$hash->add( "a lot", 314159265 ); - -echo $hash->get( 'six' ), "\n"; -echo $hash->get( 'a lot' ), "\n"; - -var_dump( $hash->update( 'a lot', 314159266 ) ); -var_dump( $hash->update( "a lot plus one", 314159999 ) ); - -echo $hash->get( 'six' ), "\n"; -echo $hash->get( 'a lot' ), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/setup.xml b/reference/quickhash/setup.xml deleted file mode 100644 index fcdcda6adc..0000000000 --- a/reference/quickhash/setup.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Cette extension ne nécessite aucune bibliothèque supplémentaire. - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;quickhash - -
    - -     - diff --git a/reference/radius/book.xml b/reference/radius/book.xml deleted file mode 100644 index 5c816f397e..0000000000 --- a/reference/radius/book.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Radius - - - - &reftitle.intro; - - Ce paquet est basé sur la bibliothèque libradius - (Remote Authentication Dial In User Service) - de FreeBSD. Il permet aux clients d'effectuer des identifications - et de la comptabilité par le biais de requêtes réseau - sur des serveurs distants. - - - Cette extension PECL supporte tout le protocole Radius Authentication - complet pour l'authentification - (RFC 2865) et Radius Accounting - (RFC 2866). Ce paquet est - disponible pour Unix (testé sous FreeBSD et Linux) mais aussi pour Windows. - - - - Une description de libradius peut être trouvée - ici. Une description détaillée - du fichier de configuration peut être trouvée - ici. - - - - - - &reference.radius.setup; - &reference.radius.constants; - &reference.radius.examples; - &reference.radius.reference; - - - diff --git a/reference/radius/configure.xml b/reference/radius/configure.xml deleted file mode 100644 index d65588c9b8..0000000000 --- a/reference/radius/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;radius. - -
    - diff --git a/reference/radius/constants.xml b/reference/radius/constants.xml deleted file mode 100644 index 4ef9b875e3..0000000000 --- a/reference/radius/constants.xml +++ /dev/null @@ -1,2001 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - - RADIUS_MPPE_KEY_LEN - (int) - - - - La longueur maximale des clés MPPE. - - - - - -
    - RADIUS Options - - - Plusieurs fonctions RADIUS acceptent des options sous forme de masque d'octets. - Les constantes représentant ces options sont listées ci-dessous. - - - - - - RADIUS_OPTION_SALT - (int) - - - - Lorsque définie, cette option fera que la valeur de l'attribut - sera chiffrée salt. - - - - - - RADIUS_OPTION_TAGGED - (int) - - - - Lorsque définie, cette option fera que la valeur de l'attribut - proviendra du paramètre tag. - - - - -
    - -
    - Types de paquets RADIUS - - - Les paquets RADIUS, qu'ils soient demandés ou obtenus en réponse, incluent - toujours un type. Cette constante est fournie pour rendre plus simple - la spécification d'un type lors de l'utilisation de la fonction - radius_create_request, et lors d'une comparaison - du résultat avec la fonction radius_send_request. - - - - - - RADIUS_ACCESS_REQUEST - (int) - - - - Un Access-Request, utilisé pour authentifier un utilisateur - sur un serveur RADIUS. Les paquets Access-Request doivent inclure - un attribut RADIUS_NAS_IP_ADDRESS, - ou un attribut RADIUS_NAS_IDENTIFIER - mais aussi inclure un attribut RADIUS_USER_PASSWORD, - et un attribut RADIUS_CHAP_PASSWORD - ou bien un attribut RADIUS_STATE, - et doivent inclure un attribut RADIUS_USER_NAME. - - - - - - RADIUS_ACCESS_ACCEPT - (int) - - - - Une réponse Access-Accept à un paquet Access-Request indique que le serveur RADIUS - a authentifié l'utilisateur avec succès. - - - - - - RADIUS_ACCESS_REJECT - (int) - - - - Une réponse Access-Reject à un paquet Access-Request indique que le serveur RADIUS - n'a pas réussi à authentifier l'utilisateur. - - - - - - RADIUS_ACCESS_CHALLENGE - (int) - - - - Une réponse Access-Challenge à un paquet Access-Request indique que le serveur RADIUS - requiert plus d'informations d'un autre paquet Access-Request avant d'authentifier - l'utilisateur. - - - - - - RADIUS_ACCOUNTING_REQUEST - (int) - - - - Un paquet Accounting-Request, utilisé pour transmettre des informations de - comptabilité pour un service du serveur RADIUS. - - - - - - RADIUS_ACCOUNTING_RESPONSE - (int) - - - - Une réponse Accounting-Response à un paquet Accounting-Request. - - - - - - RADIUS_COA_REQUEST - (int) - - - - Un paquet CoA-Request, envoyé depuis un serveur RADIUS pour - indiquer que les autorisations ont changé dans la session utilisateur. - Une réponse doit être émise sous la forme d'un CoA-ACK ou d'un CoA-NAK. - - - Cette constante est disponible depuis PECL radius 1.3.0 et suivants. - - - - - - RADIUS_COA_ACK - (int) - - - - Un paquet CoA-ACK, envoyé au serveur RADIUS pour indiquer - que les autorisations utilisateurs ont été mises à jour. - - - Cette constante est disponible depuis PECL radius 1.3.0 et suivants. - - - - - - RADIUS_COA_NAK - (int) - - - - Un paquet CoA-NAK, envoyé au serveur RADIUS pour indiquer que les autorisations - utilisateurs n'ont pas pu être mises à jour. - - - Cette constante est disponible depuis PECL radius 1.3.0 et suivants. - - - - - - RADIUS_DISCONNECT_REQUEST - (int) - - - - Un paquet Disconnect-Request, envoyé depuis le serveur RADIUS pour indiquer - que la session utilisateur doit être close. - - - Cette constante est disponible depuis PECL radius 1.3.0 et suivants. - - - - - - RADIUS_DISCONNECT_ACK - (int) - - - - Un paquet Disconnect-ACK, envoyé au serveur RADIUS pour indiquer que - la session utilisateur s'est terminée. - - - Cette constante est disponible depuis PECL radius 1.3.0 et suivants. - - - - - - RADIUS_DISCONNECT_NAK - (int) - - - - Un paquet Disconnect-NAK, envoyé au serveur RADIUS pour indiquer - que la session utilisateur n'a pas pu se terminer. - - - Cette constante est disponible depuis PECL radius 1.3.0 et suivants. - - - - -
    - -
    - Types d'attribut RADIUS - - - Ces constantes définissent des types d'attribut RADIUS qui peuvent être utilisées - avec les fonctions radius_put_addr, radius_put_attr, - radius_put_int et radius_put_string. - - - - - - RADIUS_USER_NAME - (int) - - - - L'attribut User-Name. La valeur de l'attribut doit être une chaîne de - caractères contenant le nom de l'utilisateur désirant s'authentifier, - et peut être définie en utilisant la fonction radius_put_attr. - - - - - - RADIUS_USER_PASSWORD - (int) - - - - L'attribut User-Password. La valeur de l'attribut doit être une chaîne - de caractères contenant le mot de passe de l'utilisateur, et peut être - définie en utilisant la fonction radius_put_attr. - Cette valeur sera brouillée pendant la transmission tel que décrit à - la section 5.2 de la RFC 2865. - - - - - - RADIUS_CHAP_PASSWORD - (int) - - - - L'attribut Chap-Password. La valeur de l'attribut doit être une chaîne - contenant le premier octet (qui est l'identifiant CHAP), puis une sous-séquence de 16 octets contenant le hash MD5 de l'identifiant - CHAP, le mot de passe en clair, et la valeur du challenge CHAP, - le tout, concaténés. Il est à noter que la valeur du challenge CHAP doit - aussi être envoyée séparément dans l'attribut - RADIUS_CHAP_CHALLENGE. - - - Utilisation des mots de passe CHAP - - -]]> - - - - - - - RADIUS_NAS_IP_ADDRESS - (int) - - - - L'attribut NAS-IP-Address. La valeur de l'attribut attendue est l'adresse - IP du client RADIUS encodée sous la forme d'un entier, qui peut - être définie en utilisant la fonction radius_put_addr. - - - - - - RADIUS_NAS_PORT - (int) - - - - L'attribut NAS-Port. La valeur de l'attribut attendue est le port - physique de l'utilisateur sur le client RADIUS, encodé sous la - forme d'un entier, qui peut être définie en utilisant la fonction - radius_put_int. - - - - - - RADIUS_SERVICE_TYPE - (int) - - - - L'attribut Service-Type. La valeur de l'attribut indique le type - de service que l'utilisateur requiert, et doit être un entier, - qui peut être défini en utilisant la fonction - radius_put_int. - - - Des constantes sont fournies pour représenter les valeurs possibles - de cet attribut. Les voici : - - RADIUS_LOGIN - RADIUS_FRAMED - RADIUS_CALLBACK_LOGIN - RADIUS_CALLBACK_FRAMED - RADIUS_OUTBOUND - RADIUS_ADMINISTRATIVE - RADIUS_NAS_PROMPT - RADIUS_AUTHENTICATE_ONLY - RADIUS_CALLBACK_NAS_PROMPT - - - - - - - RADIUS_FRAMED_PROTOCOL - (int) - - - - L'attribut Framed-Protocol. La valeur de l'attribut attendue est - un entier, indiquant le framing à utiliser pour l'accès, et peut être - définie en utilisant la fonction radius_put_int. - Les valeurs possibles pour cet attribut sont : - - RADIUS_PPP - RADIUS_SLIP - RADIUS_ARAP - RADIUS_GANDALF - RADIUS_XYLOGICS - - - - - - - RADIUS_FRAMED_IP_ADDRESS - (int) - - - - L'attribut Framed-IP-Address. La valeur attendue est une adresse - du réseau utilisateur encodée sous la forme d'un entier, - qui peut être définie en utilisant la fonction radius_put_addr - et récupérée en utilisant la fonction radius_cvt_addr. - - - - - - RADIUS_FRAMED_IP_NETMASK - (int) - - - - L'attribut Framed-IP-Netmask. La valeur attendue est un netmask - du réseau utilisateur, encodé sous la forme d'un entier, qui - peut être définie en utilisant la fonction radius_put_addr - et récupérée en utilisant la fonction radius_cvt_addr. - - - - - - RADIUS_FRAMED_ROUTING - (int) - - - - L'attribut Framed-Routing. La valeur attendue est un entier - indiquant la méthode de routage pour l'utilisateur, qui peut - être définie en utilisant la fonction radius_put_int. - - - Valeurs possibles : - - 0 : Aucun routage - 1 : Envoi des paquets de routage - 2 : Ecoute des paquets de routage - 3 : Envoi et écoute - - - - - - - RADIUS_FILTER_ID - (int) - - - - L'attribut Filter-ID. La valeur attendue est une implémentation - spécifique, humainement lisible, de chaînes de filtres, qui - peuvent être définies en utilisant la fonction - radius_put_attr. - - - - - - RADIUS_FRAMED_MTU - (int) - - - - L'attribut Framed-MTU. La valeur attendue est un entier, indiquant - le MTU à configurer pour l'utilisateur, et peut être - définie en utilisant la fonction radius_put_int. - - - - - - RADIUS_FRAMED_COMPRESSION - (int) - - - - L'attribut Framed-Compression. La valeur attendue est un entier, - indiquant le protocole de compression à utiliser, et peut être - définie en utilisant la fonction radius_put_int. - Valeurs possibles : - - RADIUS_COMP_NONE : Aucune compression - RADIUS_COMP_VJ : Compression de l'en-tête VJ TCP/IP - RADIUS_COMP_IPXHDR : Compression de l'en-tête IPX - - RADIUS_COMP_STAC_LZS : Compression Stac-LZS (ajouté en PECL radius 1.3.0b2) - - - - - - - - RADIUS_LOGIN_IP_HOST - (int) - - - - L'attribut Login-IP-Host. La valeur attendue est l'adresse IP - de connexion de l'utilisateur, encodée sous la forme d'un entier, - qui peut être défini en utilisant la fonction - radius_put_addr. - - - - - - RADIUS_LOGIN_SERVICE - (int) - - - - L'attribut Login-Service. La valeur attendue est un entier indiquant - le service sur lequel l'utilisateur se connecte sur l'hôte d'identification. - La valeur peut être convertie en un entier PHP via la fonction - radius_cvt_int. - - - - - - RADIUS_LOGIN_TCP_PORT - (int) - - - - L'attribut Login-TCP-Port. La valeur attendue est un entier indiquant - le port sur lequel l'utilisateur se connecte sur l'hôte d'identification. - La valeur peut être convertie en un entier PHP via la fonction - radius_cvt_int. - - - - - - RADIUS_REPLY_MESSAGE - (int) - - - - L'attribut Reply-Message. La valeur attendue est une chaîne de caractères - contenant un texte qui peut être affiché à l'utilisateur en réponse - à une requête d'accès. - - - - - - RADIUS_CALLBACK_NUMBER - (int) - - - - L'attribut Callback-Number. La valeur attendue est une chaîne de - caractères contenant la chaîne de numérotation à utiliser pour - la fonction de rappel. - - - - - - RADIUS_CALLBACK_ID - (int) - - - - L'attribut Callback-Id. La valeur attendue est une chaîne contenant - le nom de l'implémentation spécifique de la place à appeler. - - - - - - RADIUS_FRAMED_ROUTE - (int) - - - - L'attribut Framed-Route. La valeur attendue est une chaîne - contenant un jeu de routes d'implémentation spécifique à configurer - pour l'utilisateur. - - - - - - RADIUS_FRAMED_IPX_NETWORK - (int) - - - - L'attribut Framed-IPX-Network. La valeur attendue est un entier - contenant le réseau IPX à configurer pour l'utilisateur, ou - 0xFFFFFFFE pour indiquer que le client RADIUS doit sélectionner - le réseau, et peut être accédé via la fonction - radius_cvt_int. - - - - - - RADIUS_STATE - (int) - - - - L'attribut State. La valeur attendue est une chaîne contenant - l'implémentation définie incluse dans un Access-Challenge depuis - un serveur qui doit être inclus dans la sous-séquence Access-Request, - et peut être défini en utilisant la fonction - radius_put_attr. - - - - - - RADIUS_CLASS - (int) - - - - L'attribut Class. La valeur attendue est une chaîne arbitraire incluant - le message d'un Access-Accept qui doit être envoyé au serveur de comptes - dans les messages Accounting-Request, et peut être défini via la fonction - radius_put_attr. - - - - - - RADIUS_VENDOR_SPECIFIC - (int) - - - - L'attribut Vendor-Specific. En général, les valeurs de l'attribut du vendeur - doivent être définies en utilisant les fonctions - radius_put_vendor_addr, - radius_put_vendor_attr, - radius_put_vendor_int et - radius_put_vendor_string, plutôt que directement. - - - Cette constante est utile lors de l'interprétation des attributs - spécifiques du vendeur dans les réponses d'un serveur RADIUS ; lorsqu'un - attribut spécifique du vendeur est reçu, la fonction - radius_get_vendor_attr doit être utilisée pour - accéder à l'identifiant du vendeur, le type d'attribut et la valeur de l'attribut. - - - - - - RADIUS_SESSION_TIMEOUT - (int) - - - - Timeout de la session - - - - - - RADIUS_IDLE_TIMEOUT - (int) - - - - Durée d'expiration - - - - - - RADIUS_TERMINATION_ACTION - (int) - - - - Action de termination - - - - - - RADIUS_CALLED_STATION_ID - (int) - - - - Identifiant de la station appelée - - - - - - RADIUS_CALLING_STATION_ID - (int) - - - - Identifiant de la station appelante - - - - - - RADIUS_NAS_IDENTIFIER - (int) - - - - Identifiant NAS - - - - - - RADIUS_PROXY_STATE - (int) - - - - Statut du Proxy - - - - - - RADIUS_LOGIN_LAT_SERVICE - (int) - - - - Service d'identification LAT - - - - - - RADIUS_LOGIN_LAT_NODE - (int) - - - - Noeud d'identification LAT - - - - - - RADIUS_LOGIN_LAT_GROUP - (int) - - - - Groupe d'identification LAT - - - - - - RADIUS_FRAMED_APPLETALK_LINK - (int) - - - - Lien framé Appletalk - - - - - - RADIUS_FRAMED_APPLETALK_NETWORK - (int) - - - - Réseau framé Appletalk - - - - - - RADIUS_FRAMED_APPLETALK_ZONE - (int) - - - - Zone framée Appletalk - - - - - - RADIUS_CHAP_CHALLENGE - (int) - - - - Challenge - - - - - - RADIUS_NAS_PORT_TYPE - (int) - - - - Type du port NAS : - - RADIUS_ASYNC - RADIUS_SYNC - RADIUS_ISDN_SYNC - RADIUS_ISDN_ASYNC_V120 - RADIUS_ISDN_ASYNC_V110 - RADIUS_VIRTUAL - RADIUS_PIAFS - RADIUS_HDLC_CLEAR_CHANNEL - RADIUS_X_25 - RADIUS_X_75 - RADIUS_G_3_FAX - RADIUS_SDSL - RADIUS_ADSL_CAP - RADIUS_ADSL_DMT - RADIUS_IDSL - RADIUS_ETHERNET - RADIUS_XDSL - RADIUS_CABLE - RADIUS_WIRELESS_OTHER - RADIUS_WIRELESS_IEEE_802_11 - - - - - - - RADIUS_PORT_LIMIT - (int) - - - - Limite du port - - - - - - RADIUS_LOGIN_LAT_PORT - (int) - - - - Port d'identification LAT - - - - - - RADIUS_CONNECT_INFO - (int) - - - - Information de connexion - - - - - - RADIUS_ACCT_STATUS_TYPE - (int) - - - - Type de statut du compte : - - RADIUS_START - RADIUS_STOP - RADIUS_ACCOUNTING_ON - RADIUS_ACCOUNTING_OFF - - - - - - - RADIUS_ACCT_DELAY_TIME - (int) - - - - Délai maximal d'identification - - - - - - RADIUS_ACCT_INPUT_OCTETS - (int) - - - - Octets d'entrée d'identification - - - - - - RADIUS_ACCT_OUTPUT_OCTETS - (int) - - - - Octets de sortie d'identification - - - - - - RADIUS_ACCT_SESSION_ID - (int) - - - - Identifiant de session d'identification - - - - - - RADIUS_ACCT_AUTHENTIC - (int) - - - - Identification authentique, un parmi : - - RADIUS_AUTH_RADIUS - RADIUS_AUTH_LOCAL - RADIUS_AUTH_REMOTE - - - - - - - RADIUS_ACCT_SESSION_TIME - (int) - - - - Durée de la session d'identification - - - - - - RADIUS_ACCT_INPUT_PACKETS - (int) - - - - Paquets d'entrée d'identification - - - - - - RADIUS_ACCT_OUTPUT_PACKETS - (int) - - - - Paquets de sortie d'identification - - - - - - RADIUS_ACCT_TERMINATE_CAUSE - (int) - - - - Cause de la fin de l'identification, un parmi : - - RADIUS_TERM_USER_REQUEST - RADIUS_TERM_LOST_CARRIER - RADIUS_TERM_LOST_SERVICE - RADIUS_TERM_IDLE_TIMEOUT - RADIUS_TERM_SESSION_TIMEOUT - RADIUS_TERM_ADMIN_RESET - RADIUS_TERM_ADMIN_REBOOT - RADIUS_TERM_PORT_ERROR - RADIUS_TERM_NAS_ERROR - RADIUS_TERM_NAS_REQUEST - RADIUS_TERM_NAS_REBOOT - RADIUS_TERM_PORT_UNNEEDED - RADIUS_TERM_PORT_PREEMPTED - RADIUS_TERM_PORT_SUSPENDED - RADIUS_TERM_SERVICE_UNAVAILABLE - RADIUS_TERM_CALLBACK - RADIUS_TERM_USER_ERROR - RADIUS_TERM_HOST_REQUEST - - - - - - - RADIUS_ACCT_MULTI_SESSION_ID - (int) - - - - Identifiant d'une session multiple d'identification - - - - - - RADIUS_ACCT_LINK_COUNT - (int) - - - - Nombre de liens d'identification - - - - - - Constantes de type de service - - - RADIUS_LOGIN - - - - - - - - - RADIUS_FRAMED - - - - - - - - - RADIUS_CALLBACK_LOGIN - - - - - - - - - RADIUS_CALLBACK_FRAMED - - - - - - - - - RADIUS_OUTBOUND - - - - - - - - - RADIUS_ADMINISTRATIVE - - - - - - - - - RADIUS_NAS_PROMPT - - - - - - - - - RADIUS_AUTHENTICATE_ONLY - - - - - - - - - RADIUS_CALLBACK_NAS_PROMPT - - - - - - - - - - Framed-Protocol Constants - - - RADIUS_PPP - - - - - - - - - RADIUS_SLIP - - - - - - - - - RADIUS_ARAP - - - - - - - - - RADIUS_GANDALF - - - - - - - - - RADIUS_XYLOGICS - - - - - - - - - - Framed-Compression Constants - - - RADIUS_COMP_NONE - - - - - - - - - RADIUS_COMP_VJ - - - - - - - - - RADIUS_COMP_IPXHDR - - - - - - - - - RADIUS_COMP_STAC_LZS - - - - - - - - - - NAS Port Type Constants - - - RADIUS_ASYNC - - - - - - - - - RADIUS_SYNC - - - - - - - - - RADIUS_ISDN_SYNC - - - - - - - - - RADIUS_ISDN_ASYNC_V120 - - - - - - - - - RADIUS_ISDN_ASYNC_V110 - - - - - - - - - RADIUS_VIRTUAL - - - - - - - - - RADIUS_PIAFS - - - - - - - - - RADIUS_HDLC_CLEAR_CHANNEL - - - - - - - - - RADIUS_X_25 - - - - - - - - - RADIUS_X_75 - - - - - - - - - RADIUS_G_3_FAX - - - - - - - - - RADIUS_SDSL - - - - - - - - - RADIUS_ADSL_CAP - - - - - - - - - RADIUS_ADSL_DMT - - - - - - - - - RADIUS_IDSL - - - - - - - - - RADIUS_ETHERNET - - - - - - - - - RADIUS_XDSL - - - - - - - - - RADIUS_CABLE - - - - - - - - - RADIUS_WIRELESS_OTHER - - - - - - - - - RADIUS_WIRELESS_IEEE_802_11 - - - - - - - - - - Accounting Status Type Constants - - - RADIUS_START - - - - - - - - - RADIUS_STOP - - - - - - - - - RADIUS_ACCOUNTING_ON - - - - - - - - - RADIUS_ACCOUNTING_OFF - - - - - - - - - - Accounting Authentic Constants - - - RADIUS_AUTH_RADIUS - - - - - - - - - RADIUS_AUTH_LOCAL - - - - - - - - - RADIUS_AUTH_REMOTE - - - - - - - - - - Accounting Terminate Cause Constants - - - RADIUS_TERM_USER_REQUEST - - - - - - - - - RADIUS_TERM_LOST_CARRIER - - - - - - - - - RADIUS_TERM_LOST_SERVICE - - - - - - - - - RADIUS_TERM_IDLE_TIMEOUT - - - - - - - - - RADIUS_TERM_SESSION_TIMEOUT - - - - - - - - - RADIUS_TERM_ADMIN_RESET - - - - - - - - - RADIUS_TERM_ADMIN_REBOOT - - - - - - - - - RADIUS_TERM_PORT_ERROR - - - - - - - - - RADIUS_TERM_NAS_ERROR - - - - - - - - - RADIUS_TERM_NAS_REQUEST - - - - - - - - - RADIUS_TERM_NAS_REBOOT - - - - - - - - - RADIUS_TERM_PORT_UNNEEDED - - - - - - - - - RADIUS_TERM_PORT_PREEMPTED - - - - - - - - - RADIUS_TERM_PORT_SUSPENDED - - - - - - - - - RADIUS_TERM_SERVICE_UNAVAILABLE - - - - - - - - - RADIUS_TERM_CALLBACK - - - - - - - - - RADIUS_TERM_USER_ERROR - - - - - - - - - RADIUS_TERM_HOST_REQUEST - - - - - - - -
    - -
    - Types d'attribut RADIUS spécifique au vendeur - - - - - RADIUS_VENDOR_MICROSOFT - (int) - - - - Attributs spécifiques à Microsoft (RFC 2548) : - - RADIUS_MICROSOFT_MS_CHAP_RESPONSE - RADIUS_MICROSOFT_MS_CHAP_ERROR - RADIUS_MICROSOFT_MS_CHAP_PW_1 - RADIUS_MICROSOFT_MS_CHAP_PW_2 - RADIUS_MICROSOFT_MS_CHAP_LM_ENC_PW - RADIUS_MICROSOFT_MS_CHAP_NT_ENC_PW - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_POLICY - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_TYPES - RADIUS_MICROSOFT_MS_RAS_VENDOR - RADIUS_MICROSOFT_MS_CHAP_DOMAIN - RADIUS_MICROSOFT_MS_CHAP_CHALLENGE - RADIUS_MICROSOFT_MS_CHAP_MPPE_KEYS - RADIUS_MICROSOFT_MS_BAP_USAGE - RADIUS_MICROSOFT_MS_LINK_UTILIZATION_THRESHOLD - RADIUS_MICROSOFT_MS_LINK_DROP_TIME_LIMIT - RADIUS_MICROSOFT_MS_MPPE_SEND_KEY - RADIUS_MICROSOFT_MS_MPPE_RECV_KEY - RADIUS_MICROSOFT_MS_RAS_VERSION - RADIUS_MICROSOFT_MS_OLD_ARAP_PASSWORD - RADIUS_MICROSOFT_MS_NEW_ARAP_PASSWORD - RADIUS_MICROSOFT_MS_ARAP_PASSWORD_CHANGE_REASON - RADIUS_MICROSOFT_MS_FILTER - RADIUS_MICROSOFT_MS_ACCT_AUTH_TYPE - RADIUS_MICROSOFT_MS_ACCT_EAP_TYPE - RADIUS_MICROSOFT_MS_CHAP2_RESPONSE - RADIUS_MICROSOFT_MS_CHAP2_SUCCESS - RADIUS_MICROSOFT_MS_CHAP2_PW - RADIUS_MICROSOFT_MS_PRIMARY_DNS_SERVER - RADIUS_MICROSOFT_MS_SECONDARY_DNS_SERVER - RADIUS_MICROSOFT_MS_PRIMARY_NBNS_SERVER - RADIUS_MICROSOFT_MS_SECONDARY_NBNS_SERVER - RADIUS_MICROSOFT_MS_ARAP_CHALLENGE - - - - - - - RADIUS_MICROSOFT_MS_CHAP_RESPONSE - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_ERROR - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_PW_1 - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_PW_2 - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_LM_ENC_PW - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_NT_ENC_PW - - - - - - - - - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_POLICY - - - - - - - - - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_TYPES - - - - - - - - - RADIUS_MICROSOFT_MS_RAS_VENDOR - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_DOMAIN - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_CHALLENGE - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_MPPE_KEYS - - - - - - - - - RADIUS_MICROSOFT_MS_BAP_USAGE - - - - - - - - - RADIUS_MICROSOFT_MS_LINK_UTILIZATION_THRESHOLD - - - - - - - - - RADIUS_MICROSOFT_MS_LINK_DROP_TIME_LIMIT - - - - - - - - - RADIUS_MICROSOFT_MS_MPPE_SEND_KEY - - - - - - - - - RADIUS_MICROSOFT_MS_MPPE_RECV_KEY - - - - - - - - - RADIUS_MICROSOFT_MS_RAS_VERSION - - - - - - - - - RADIUS_MICROSOFT_MS_OLD_ARAP_PASSWORD - - - - - - - - - RADIUS_MICROSOFT_MS_NEW_ARAP_PASSWORD - - - - - - - - - RADIUS_MICROSOFT_MS_ARAP_PASSWORD_CHANGE_REASON - - - - - - - - - RADIUS_MICROSOFT_MS_FILTER - - - - - - - - - RADIUS_MICROSOFT_MS_ACCT_AUTH_TYPE - - - - - - - - - RADIUS_MICROSOFT_MS_ACCT_EAP_TYPE - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP2_RESPONSE - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP2_SUCCESS - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP2_PW - - - - - - - - - RADIUS_MICROSOFT_MS_PRIMARY_DNS_SERVER - - - - - - - - - RADIUS_MICROSOFT_MS_SECONDARY_DNS_SERVER - - - - - - - - - RADIUS_MICROSOFT_MS_PRIMARY_NBNS_SERVER - - - - - - - - - RADIUS_MICROSOFT_MS_SECONDARY_NBNS_SERVER - - - - - - - - - RADIUS_MICROSOFT_MS_ARAP_CHALLENGE - - - - - - - -
    -     - diff --git a/reference/radius/examples.xml b/reference/radius/examples.xml deleted file mode 100644 index 6df2bfcd81..0000000000 --- a/reference/radius/examples.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - &reftitle.examples; - - - Comment commencer ? - - récupérez une ressource radius - configurez la bibliothèque - créez la requête - ajoutez les attributs - envoyez la requête - récupérer les attributs - fermez la ressource radius (optionnel) - - Regardez également aux exemples fournis avec ce paquet. - - - Le paquet contient un exemple de script PHP. Ce script montre une identification - avec radius, en utilisant PAP ou CHAP (md5). Si l'on effectue une identification via - Microsoft Radius servers, alors il est possible d'utiliser CHAP (md5). Pour - s'identifier avec Microsoft Servers, il faut utiliser - MS-CHAPv1 ou MS-CHAPv2, mais c'est plus compliqué, car on doit avoir md4, - sha1 et des pour générer les bonnes données. L'exemple fourni montre toutes les - méthodes d'identification, incluant MS-CHAPv1 et MS-CHAPv2. Pour faire en sorte que - MS-CHAP fonctionne, il faut activer les extensions mcrypt - et mhash, à partir de la version 1.2 de ce paquet, - l'extension mcrypt n'est plus nécessaire. - - - diff --git a/reference/radius/functions/radius-acct-open.xml b/reference/radius/functions/radius-acct-open.xml deleted file mode 100644 index 6019376726..0000000000 --- a/reference/radius/functions/radius-acct-open.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - radius_acct_open - Crée une ressource Radius pour les comptes - - - - &reftitle.description; - - resourceradius_acct_open - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une ressource en cas de succès ou &false; si une erreur survient. - Cette fonction n'échoue que s'il y a un manque de mémoire. - - - - - &reftitle.examples; - - Exemple avec <function>radius_acct_open</function> - - -]]> - - - - - diff --git a/reference/radius/functions/radius-add-server.xml b/reference/radius/functions/radius-add-server.xml deleted file mode 100644 index b087768de8..0000000000 --- a/reference/radius/functions/radius-add-server.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - radius_add_server - Ajoute un serveur - - - - &reftitle.description; - - boolradius_add_server - resourceradius_handle - stringhostname - intport - stringsecret - inttimeout - intmax_tries - - - radius_add_server peut être utilisé plusieurs fois, et il - peut être utilisé avec la fonction radius_config. - Tout au plus, 10 serveurs peuvent être spécifiés. Lorsque plusieurs serveurs sont fournis, - ils sont essayés à la façon round-robin tant qu'une réponse valide - n'est pas reçue, ou tant que la limite max_tries - de chaque serveur n'est pas atteinte. - - - - - &reftitle.parameters; - - - radius_handle - - - - - - - hostname - - - Le paramètre hostname spécifie l'hôte serveur, - soit en tant que nom de domaine qualifié, soit en tant qu'adresse IP. - - - - - port - - - Le port spécifie le port UDP à - contacter sur le serveur. Si le port donné vaut &zero;, la bibliothèque - recherchera le service radius/udp ou - radacct/udp - dans la base de données des services du réseau et utilisera le port - s'y trouvant. Si aucune entrée n'est trouvée, la bibliothèque utilisera les ports - Radius standards, 1812 pour l'identification et 1813 pour les comptes. - - - - - secret - - - Le secret partagé pour l'hôte serveur est passé au paramètre - secret. Le protocole Radius ignore - tout mais garde les 128 premiers octets du secret partagé. - - - - - timeout - - - Le délai limite pour recevoir les réponses du serveur est passé au - paramètre timeout, sous la forme de secondes. - - - - - max_tries - - - Le nombre maximal de requêtes répétées à faire avant d'échouer. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>radius_add_server</function> - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_config - - - - diff --git a/reference/radius/functions/radius-auth-open.xml b/reference/radius/functions/radius-auth-open.xml deleted file mode 100644 index b8e387bf29..0000000000 --- a/reference/radius/functions/radius-auth-open.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - radius_auth_open - Crée une ressource Radius pour l'identification - - - - &reftitle.description; - - resourceradius_auth_open - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une ressource en cas de succès ou &false; si une erreur survient. - Cette fonction n'échoue que s'il y a un manque de mémoire. - - - - - &reftitle.examples; - - Exemple avec <function>radius_auth_open</function> - - -]]> - - - - - diff --git a/reference/radius/functions/radius-close.xml b/reference/radius/functions/radius-close.xml deleted file mode 100644 index 792d9e91f6..0000000000 --- a/reference/radius/functions/radius-close.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - radius_close - Libère toutes les ressources Radius - - - - &reftitle.description; - - boolradius_close - resourceradius_handle - - - Il n'est pas nécessaire d'appeler cette fonction car PHP libère toutes les - ressources à la fin de chaque demande. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/radius/functions/radius-config.xml b/reference/radius/functions/radius-config.xml deleted file mode 100644 index 268da9b8ff..0000000000 --- a/reference/radius/functions/radius-config.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - radius_config - Demande à la bibliothèque de lire un fichier de configuration donné - - - - &reftitle.description; - - boolradius_config - resourceradius_handle - stringfile - - - Avant toute demande Radius, la bibliothèque doit connaître le serveur à contacter. - La manière simple de configurer la bibliothèque est d'appeler la fonction - radius_config. radius_config - demande à la bibliothèque de lire un fichier de configuration dont le format - est décrit sur la page radius.conf. - - - - - &reftitle.parameters; - - - radius_handle - - - - - - - - file - - - Le chemin vers le fichier de configuration est passé en tant - qu'argument à la fonction radius_config. - La bibliothèque peut également être configurée en appelant la - fonction radius_add_server. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - radius_add_server - - - - diff --git a/reference/radius/functions/radius-create-request.xml b/reference/radius/functions/radius-create-request.xml deleted file mode 100644 index 7e795bfdf4..0000000000 --- a/reference/radius/functions/radius-create-request.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - radius_create_request - Crée une demande de compte ou d'identification - - - - &reftitle.description; - - boolradius_create_request - resourceradius_handle - inttype - - - Une demande Radius consiste en du code spécifiant une demande spécifique, - ainsi que zéro ou plusieurs attributs qui fournissent des informations - supplémentaires. Pour commencer à construire une nouvelle demande, - appelez la fonction radius_create_request. - - - - Attention : Il faut appeler cette fonction avant de passer n'importe quel attribut ! - - - - - - &reftitle.parameters; - - - radius_handle - - - - - - - type - - - Le type est RADIUS_ACCESS_REQUEST ou - RADIUS_ACCOUNTING_REQUEST. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>radius_create_request</function> - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_send_request - - - - diff --git a/reference/radius/functions/radius-cvt-addr.xml b/reference/radius/functions/radius-cvt-addr.xml deleted file mode 100644 index b7fe3aaa1d..0000000000 --- a/reference/radius/functions/radius-cvt-addr.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - radius_cvt_addr - Convertit des données brutes en adresse IP - - - - &reftitle.description; - - stringradius_cvt_addr - stringdata - - - Convertit des données brutes en adresse IP - - - - - &reftitle.parameters; - - - data - - - Données d'entrée - - - - - - - - &reftitle.returnvalues; - - Retourne l'adresse IP. - - - - - &reftitle.examples; - - Exemple avec <function>radius_cvt_addr</function> - -\n"; - break; - - case RADIUS_FRAMED_IP_NETMASK: - $mask = radius_cvt_addr($data); - echo "MASQUE : $mask
    \n"; - break; - } -} -?> -]]> -     -     -     - - - &reftitle.seealso; - - radius_cvt_int - radius_cvt_string - - -     - diff --git a/reference/radius/functions/radius-cvt-int.xml b/reference/radius/functions/radius-cvt-int.xml deleted file mode 100644 index 21677ac961..0000000000 --- a/reference/radius/functions/radius-cvt-int.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - radius_cvt_int - Convertit des données brutes en entier - - - - &reftitle.description; - - intradius_cvt_int - stringdata - - - Convertit des données brutes en entier - - - - - &reftitle.parameters; - - - data - - - Données d'entrée. - - - - - - - - &reftitle.returnvalues; - - Retourne l'entier, récupéré depuis les données. - - - - - &reftitle.examples; - - Exemple avec <function>radius_cvt_int</function> - -\n"; - break; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_cvt_addr - radius_cvt_string - - - - diff --git a/reference/radius/functions/radius-cvt-string.xml b/reference/radius/functions/radius-cvt-string.xml deleted file mode 100644 index 8dff53b38f..0000000000 --- a/reference/radius/functions/radius-cvt-string.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - radius_cvt_string - Convertit des données brutes en chaîne de caractères - - - - &reftitle.description; - - stringradius_cvt_string - stringdata - - - Convertit des données brutes en chaîne de caractères - - - - - &reftitle.parameters; - - - data - - - Données d'entrée - - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne, récupérée depuis les données. - - - - - &reftitle.examples; - - Exemple avec <function>radius_cvt_string</function> - -\n"; - break; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_cvt_addr - radius_cvt_int - - - - diff --git a/reference/radius/functions/radius-demangle-mppe-key.xml b/reference/radius/functions/radius-demangle-mppe-key.xml deleted file mode 100644 index 3e1771ef99..0000000000 --- a/reference/radius/functions/radius-demangle-mppe-key.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - radius_demangle_mppe_key - Dérive les clés mppe depuis des données - - - - &reftitle.description; - - stringradius_demangle_mppe_key - resourceradius_handle - stringmangled - - - Lors de l'utilisation de MPPE avec MS-CHAPv2, les clés reçues et envoyées - sont déformées (voir la RFC 2548), - cependant, cette fonction est inutile, car il n'existe pas et n'existera - probablement pas d'implémentation de PPTP-MPPE dans PHP. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - mangled - - - Les données déformées à déchiffrer - - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne ou &false; si une erreur survient. - - - - diff --git a/reference/radius/functions/radius-demangle.xml b/reference/radius/functions/radius-demangle.xml deleted file mode 100644 index 100ad6c12d..0000000000 --- a/reference/radius/functions/radius-demangle.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - radius_demangle - Déchiffre des données déformées - - - - &reftitle.description; - - stringradius_demangle - resourceradius_handle - stringmangled - - - Quelques données (mots de passe, clés MS-CHAPv1 MPPE) sont déformées pour - des raisons de sécurité et doivent être déchiffrées avant de pouvoir les utiliser. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - mangled - - - Les données déformées à déchiffrer - - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne déchiffrée ou &false; si une erreur survient. - - - - diff --git a/reference/radius/functions/radius-get-attr.xml b/reference/radius/functions/radius-get-attr.xml deleted file mode 100644 index 09716b5895..0000000000 --- a/reference/radius/functions/radius-get-attr.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - radius_get_attr - Extrait un attribut - - - - &reftitle.description; - - mixedradius_get_attr - resourceradius_handle - - - Comme les demandes Radius, chaque réponse doit contenir zéro ou plusieurs attributs. - Après la réception d'une réponse avec succès par la fonction - radius_send_request, ces attributs peuvent être - extraits un par un en utilisant la fonction radius_get_attr. - À chaque appel de radius_get_attr, le prochain attribut - est récupéré depuis la réponse courante. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif contenant le type de l'attribut ainsi que les données - ou un numéro d'erreur <= 0. - - - - - &reftitle.examples; - - Exemple avec <function>radius_get_attr</function> - - -]]> - - - - - - &reftitle.seealso; - - radius_put_attr - radius_get_vendor_attr - radius_put_vendor_attr - radius_send_request - - - - diff --git a/reference/radius/functions/radius-get-tagged-attr-data.xml b/reference/radius/functions/radius-get-tagged-attr-data.xml deleted file mode 100644 index 7199cb49e8..0000000000 --- a/reference/radius/functions/radius-get-tagged-attr-data.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - radius_get_tagged_attr_data - Extrait les données d'un attribut - - - - &reftitle.description; - - stringfalseradius_get_tagged_attr_data - stringdata - - - Si un attribut contenant un tag a été retourné depuis la - fonction radius_get_attr, - radius_get_tagged_attr_data va retourner les - données depuis cet attribut. - - - - - &reftitle.parameters; - - - data - - - L'attribut contenant un tag à décoder. - - - - - - - - &reftitle.returnvalues; - - Retourne les données de l'attribut&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>radius_get_tagged_attr_data</function> - - -]]> - - - - - - &reftitle.seealso; - - radius_get_attr - radius_get_tagged_attr_tag - - - - diff --git a/reference/radius/functions/radius-get-tagged-attr-tag.xml b/reference/radius/functions/radius-get-tagged-attr-tag.xml deleted file mode 100644 index 6515dc576e..0000000000 --- a/reference/radius/functions/radius-get-tagged-attr-tag.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - radius_get_tagged_attr_tag - Extrait le tag depuis un attribut - - - - &reftitle.description; - - intfalseradius_get_tagged_attr_tag - stringdata - - - Si un attribut contenant un tag a été retourné depuis la fonction - radius_get_attr, - radius_get_tagged_attr_data va retourner le tag - depuis l'attribut. - - - - - &reftitle.parameters; - - - data - - - L'attribut à décoder. - - - - - - - - &reftitle.returnvalues; - - Retourne le tag depuis l'attribut &return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple avec <function>radius_get_tagged_attr_tag</function> - - -]]> - - - - - - &reftitle.seealso; - - radius_get_attr - radius_get_tagged_attr_data - - - - diff --git a/reference/radius/functions/radius-get-vendor-attr.xml b/reference/radius/functions/radius-get-vendor-attr.xml deleted file mode 100644 index 0f76e5e633..0000000000 --- a/reference/radius/functions/radius-get-vendor-attr.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - radius_get_vendor_attr - Extrait un attribut spécifique au vendeur - - - - &reftitle.description; - - arrayfalseradius_get_vendor_attr - stringdata - - - Si radius_get_attr retourne - RADIUS_VENDOR_SPECIFIC, - radius_get_vendor_attr peut être appelé pour - déterminer le vendeur. - - - - - &reftitle.parameters; - - - data - - - Données d'entrée. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif contenant le type de l'attribut, le vendeur ainsi - que les données, ou &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>radius_get_vendor_attr</function> - - -]]> - - - - - - &reftitle.seealso; - - radius_get_attr - radius_put_vendor_attr - - - - diff --git a/reference/radius/functions/radius-put-addr.xml b/reference/radius/functions/radius-put-addr.xml deleted file mode 100644 index 80ea7e151d..0000000000 --- a/reference/radius/functions/radius-put-addr.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - radius_put_addr - Attache une adresse IP en tant qu'attribut - - - - &reftitle.description; - - boolradius_put_addr - resourceradius_handle - inttype - stringaddr - intoptions0 - inttag - - - Attache une adresse IP à la requête RADIUS courante. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.attribute-type; - - addr - - - Une adresse IPv4 ; par exemple 10.0.0.1. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Les paramètres options et tag - ont été ajoutés. - - - - - - - - - diff --git a/reference/radius/functions/radius-put-attr.xml b/reference/radius/functions/radius-put-attr.xml deleted file mode 100644 index 65de13cdc3..0000000000 --- a/reference/radius/functions/radius-put-attr.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - radius_put_attr - Attache un attribut binaire - - - - &reftitle.description; - - boolradius_put_attr - resourceradius_handle - inttype - stringvalue - intoptions0 - inttag - - - Attache un attribut binaire à la requête RADIUS courante. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.attribute-type; - - value - - - La valeur de l'attribut, qui sera traité comme une chaîne binaire brute. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Les paramètres options et tag - ont été ajoutés. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>radius_put_attr</function> - - "; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_get_attr - radius_get_vendor_attr - radius_put_vendor_attr - - - - diff --git a/reference/radius/functions/radius-put-int.xml b/reference/radius/functions/radius-put-int.xml deleted file mode 100644 index a82de33186..0000000000 --- a/reference/radius/functions/radius-put-int.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - radius_put_int - Attache un attribut entier - - - - &reftitle.description; - - boolradius_put_int - resourceradius_handle - inttype - intvalue - intoptions0 - inttag - - - Attache un attribut entier à la requête RADIUS courante. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.attribute-type; - - value - - - La valeur de l'attribut. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Les paramètres options et tag - ont été ajoutés. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>radius_put_int</function> - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_put_string - radius_put_vendor_int - radius_put_vendor_string - - - - diff --git a/reference/radius/functions/radius-put-string.xml b/reference/radius/functions/radius-put-string.xml deleted file mode 100644 index bc7d72ea77..0000000000 --- a/reference/radius/functions/radius-put-string.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - radius_put_string - Attache un attribut chaîne de caractères - - - - &reftitle.description; - - boolradius_put_string - resourceradius_handle - inttype - stringvalue - intoptions0 - inttag - - - Attache un attribut sous forme de chaîne à la requête RADIUS courante. - En général, la fonction radius_put_attr est plus - utile pour cela, car elle est sécurisée au niveau binaire. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.attribute-type; - - value - - - La valeur de l'attribut. Cette valeur est attendue par la bibliothèque - sous-jacente comme devant se terminer par &null; ; aussi, ce paramètre - n'est pas sécurisé binairement. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Les paramètres options et tag - ont été ajoutés. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>radius_put_string</function> - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_put_int - radius_put_vendor_int - radius_put_vendor_string - - - - diff --git a/reference/radius/functions/radius-put-vendor-addr.xml b/reference/radius/functions/radius-put-vendor-addr.xml deleted file mode 100644 index da208680a9..0000000000 --- a/reference/radius/functions/radius-put-vendor-addr.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - radius_put_vendor_addr - Attache une adresse IP spécifique à un vendeur - - - - &reftitle.description; - - boolradius_put_vendor_addr - resourceradius_handle - intvendor - inttype - stringaddr - - - Attache une adresse IP spécifique au vendeur pour la requête RADIUS courante. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.vendor; - &radius.parameter.attribute-type; - - addr - - - Une adresse IPv4 ; par exemple 10.0.0.1. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Les paramètres options et tag - ont été ajoutés. - - - - - - - - - diff --git a/reference/radius/functions/radius-put-vendor-attr.xml b/reference/radius/functions/radius-put-vendor-attr.xml deleted file mode 100644 index f2ead7a00c..0000000000 --- a/reference/radius/functions/radius-put-vendor-attr.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - radius_put_vendor_attr - Attache un attribut binaire à un vendeur spécifique - - - - &reftitle.description; - - boolradius_put_vendor_attr - resourceradius_handle - intvendor - inttype - stringvalue - intoptions0 - inttag - - - Attache un attribut binaire spécifique au vendeur pour la requête courante RADIUS. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.vendor; - &radius.parameter.attribute-type; - - value - - - La valeur de l'attribut, qui sera traité comme une chaîne binaire brute. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Les paramètres options et tag - ont été ajoutés. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>radius_put_vendor_attr</function> - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_get_vendor_attr - - - - diff --git a/reference/radius/functions/radius-put-vendor-int.xml b/reference/radius/functions/radius-put-vendor-int.xml deleted file mode 100644 index 44c48cd6c7..0000000000 --- a/reference/radius/functions/radius-put-vendor-int.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - radius_put_vendor_int - Attache un attribut entier à un vendeur spécifique - - - - &reftitle.description; - - boolradius_put_vendor_int - resourceradius_handle - intvendor - inttype - intvalue - intoptions0 - inttag - - - Attache un attribut spécifique au vendeur à la requête courante RADIUS. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.vendor; - &radius.parameter.attribute-type; - - value - - - La valeur de l'attribut. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Les options options et tag - ont été ajoutées. - - - - - - - - - &reftitle.seealso; - - radius_put_vendor_string - - - - diff --git a/reference/radius/functions/radius-put-vendor-string.xml b/reference/radius/functions/radius-put-vendor-string.xml deleted file mode 100644 index 6389c6bc4d..0000000000 --- a/reference/radius/functions/radius-put-vendor-string.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - radius_put_vendor_string - Attache un attribut sous la forme d'une chaîne à un vendeur spécifique - - - - &reftitle.description; - - boolradius_put_vendor_string - resourceradius_handle - intvendor - inttype - stringvalue - intoptions0 - inttag - - - Attache un attribut spécifique au vendeur à la requête courante RADIUS. - En général, radius_put_vendor_attr est une fonction plus - pratique pour attacher des attributs, sachant qu'elle est sécurisée au niveau binaire. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.vendor; - &radius.parameter.attribute-type; - - value - - - La valeur de l'attribut. Cette valeur est attendue par la bibliothèque - sous-jacente comme se terminant par &null; ; aussi, ce paramètre - n'est pas sécurisé au niveau binaire. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Les paramètres options et tag - ont été ajoutés. - - - - - - - - - &reftitle.seealso; - - radius_put_vendor_int - - - - diff --git a/reference/radius/functions/radius-request-authenticator.xml b/reference/radius/functions/radius-request-authenticator.xml deleted file mode 100644 index 0ab171eec3..0000000000 --- a/reference/radius/functions/radius-request-authenticator.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - radius_request_authenticator - Retourne l'authentificateur de requête - - - - &reftitle.description; - - stringradius_request_authenticator - resourceradius_handle - - - L'authentificateur de requête est nécessaire pour le déchiffrement des données - comme les mots de passe et les clés de chiffrement. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Retourne l'authentificateur de requête en tant que chaîne de caractères ou - &false; si une erreur survient. - - - - - &reftitle.seealso; - - radius_demangle - - - - diff --git a/reference/radius/functions/radius-salt-encrypt-attr.xml b/reference/radius/functions/radius-salt-encrypt-attr.xml deleted file mode 100644 index a1487fad51..0000000000 --- a/reference/radius/functions/radius-salt-encrypt-attr.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - radius_salt_encrypt_attr - Chiffre une valeur en utilisant un Salt - - - - &reftitle.description; - - stringfalseradius_salt_encrypt_attr - resourceradius_handle - stringdata - - - Applique l'algorithme RADIUS salt à la valeur fournie. - - - En général, ceci est fait automatiquement en fournissant - l'option RADIUS_OPTION_SALT à la fonction - définissant l'attribut, mais cette fonction peut être utilisée - si une construction de requête bas niveau est requise. - - - - - &reftitle.parameters; - - - data - - - Les données à chiffrer avec un salt. - - - - - - - - &reftitle.returnvalues; - - Retourne les données chiffrées en utilisant un salt - &return.falseforfailure;. - - - - - &reftitle.seealso; - - radius_put_addr - radius_put_attr - radius_put_int - radius_put_string - - - - diff --git a/reference/radius/functions/radius-send-request.xml b/reference/radius/functions/radius-send-request.xml deleted file mode 100644 index c9e21d5405..0000000000 --- a/reference/radius/functions/radius-send-request.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - radius_send_request - Envoie une requête et attend une réponse - - - - &reftitle.description; - - intradius_send_request - resourceradius_handle - - - Après qu'une demande Radius ait été construite, elle est envoyée grâce à - la fonction radius_send_request. - - - La fonction radius_send_request envoie la requête - et attend une réponse valide, essayant à nouveau, suivant la méthode - round-robin autant que nécessaire. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Si une réponse valide est reçue, radius_send_request - retourne le code Radius qui spécifie le type de réponse. C'est, typiquement, - RADIUS_ACCESS_ACCEPT, - RADIUS_ACCESS_REJECT ou - RADIUS_ACCESS_CHALLENGE. Si aucune - réponse valide n'est reçue, radius_send_request retournera &false;. - - - - - &reftitle.seealso; - - radius_create_request - - - - diff --git a/reference/radius/functions/radius-server-secret.xml b/reference/radius/functions/radius-server-secret.xml deleted file mode 100644 index 0b54e81681..0000000000 --- a/reference/radius/functions/radius-server-secret.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - radius_server_secret - Retourne le secret partagé - - - - &reftitle.description; - - stringradius_server_secret - resourceradius_handle - - - Le secret partagé est nécessaire pour le rétablissement des données - comme les mots de passe et les clés de chiffrement. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Retourne le secret partagé du serveur en tant que chaîne de caractères - ou &false; si une erreur survient. - - - - diff --git a/reference/radius/functions/radius-strerror.xml b/reference/radius/functions/radius-strerror.xml deleted file mode 100644 index b18cb4792f..0000000000 --- a/reference/radius/functions/radius-strerror.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - radius_strerror - Retourne un message d'erreur - - - - &reftitle.description; - - stringradius_strerror - resourceradius_handle - - - Si une fonction Radius échoue, alors, elle enregistre un message d'erreur. - Ce message d'erreur peut être récupéré avec cette fonction. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Retourne un message d'erreur en tant que chaîne de caractères. - - - - diff --git a/reference/radius/reference.xml b/reference/radius/reference.xml deleted file mode 100644 index b1c3165b64..0000000000 --- a/reference/radius/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - &Functions; Radius - - &reference.radius.entities.functions; - - - diff --git a/reference/radius/setup.xml b/reference/radius/setup.xml deleted file mode 100644 index 3f5ffedd03..0000000000 --- a/reference/radius/setup.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.radius.configure; - - - - - - diff --git a/reference/rar/book.xml b/reference/rar/book.xml deleted file mode 100644 index 6317468dde..0000000000 --- a/reference/rar/book.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - Archives RAR - Rar - - - - &reftitle.intro; - - Rar est un archiveur puissant et fiable, créé par Eugene Roshal. - Cette extension donne la possibilité de lire des archives Rar, - mais ne supporte pas l'écriture, car elle n'est pas supportée par - la bibliothèque UnRar et que c'est interdit directement par la licence. - - - Plus d'informations sur Rar et UnRar peuvent être trouvées sur &url.rar;. - - - - - &reference.rar.setup; - &reference.rar.constants; - &reference.rar.examples; - &reference.rar.reference; - &reference.rar.rararchive; - &reference.rar.rarentry; - &reference.rar.rarexception; - - - diff --git a/reference/rar/constants.xml b/reference/rar/constants.xml deleted file mode 100644 index 860a5f2fbb..0000000000 --- a/reference/rar/constants.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - RAR_HOST_MSDOS - (int) - - - - Utiliser la constante RarEntry::HOST_MSDOS à la place. - - - - - - RAR_HOST_OS2 - (int) - - - - Utiliser la constante RarEntry::HOST_OS2 à la place. - - - - - - RAR_HOST_WIN32 - (int) - - - - Utiliser la constante RarEntry::HOST_WIN32 à la place. - - - - - - RAR_HOST_UNIX - (int) - - - - Utiliser la constante RarEntry::HOST_UNIX à la place. - - - - - - RAR_HOST_BEOS - (int) - - - - Utiliser la constante RarEntry::HOST_BEOS à la place. - - - - - - - - diff --git a/reference/rar/examples.xml b/reference/rar/examples.xml deleted file mode 100644 index 25ef75ed43..0000000000 --- a/reference/rar/examples.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - &reftitle.examples; - - - Voir aussi les exemples de la section sur le gestionnaire - rar://. - - - - Décompression à la volée - -getEntries(); -if ($entries === FALSE) - die("Impossible de récupérer les entrées"); - -if (!array_key_exists($index, $entries)) - die("L'index $index n'existe pas"); - -$orfilename = $entries[$index]->getName(); //Encodage UTF-8 - -$filesize = $entries[$index]->getUnpackedSize(); - -/* Il est possible de vérifier ici HTTP_IF_MODIFIED_SINCE et le comparer - * avec $entries[$index]->getFileTime(). Il est également possible de envoyer - * un en-tête "Last modified" */ - -$fp = $entries[$index]->getStream(); -if ($fp === FALSE) - die("Impossible d'ouvrir le fichier d'index $index depuis l'archive."); - -$arch->close(); //plus nécessaire ; le flux est indépendant - -function detectUserAgent() { - if (!array_key_exists('HTTP_USER_AGENT', $_SERVER)) - return "Autre"; - - $uas = $_SERVER['HTTP_USER_AGENT']; - if (preg_match("@Opera/@", $uas)) - return "Opera"; - if (preg_match("@Firefox/@", $uas)) - return "Firefox"; - if (preg_match("@Chrome/@", $uas)) - return "Chrome"; - if (preg_match("@MSIE ([0-9.]+);@", $uas, $matches)) { - if (((float) $matches[1]) >= 7.0) - return "IE"; - } - - return "Autre"; -} - -/* - * Nous avons 3 options : - * - Pour FF et Opera, qui supportent RFC 2231, utiliser ce format. - * - Pour IE et Chrome, utiliser attwithfnrawpctenclong - * (http://greenbytes.de/tech/tc2231/#attwithfnrawpctenclong) - * - Pour les autres, convertissez en ISO-8859-1, si possible - */ -$formatRFC2231 = 'Content-Disposition: attachment; filename*=UTF-8\'\'%s'; -$formatDef = 'Content-Disposition: attachment; filename="%s"'; - -switch (detectUserAgent()) { - case "Opera": - case "Firefox": - $orfilename = rawurlencode($orfilename); - $format = $formatRFC2231; - break; - - case "IE": - case "Chrome": - $orfilename = rawurlencode($orfilename); - $format = $formatDef; - break; - default: - if (function_exists('iconv')) - $orfilename = - @iconv("UTF-8", "ISO-8859-1//TRANSLIT", $orfilename); - $format = $formatDef; -} - -header(sprintf($format, $orfilename)); -// Impossible d'envoyer les messages d'erreur à partir d'ici (les en-têtes -// ont déjà été émis) - -// Remplacement par le type de contenu réel, pourquoi pas par déduction de l'extension du fichier -$contentType = "application/octet-stream"; -header("Content-Type: $contentType"); - -header("Content-Transfer-Encoding: binary"); - -header("Content-Length: $filesize"); - -if ($_SERVER['REQUEST_METHOD'] == "HEAD") - die(); - -while (!feof($fp)) { - $s = @fread($fp, 8192); - if ($s === false) - break; //utile pour envoyer des messages d'erreur - - echo $s; -} -?> -]]> - - - - Cet exemple ouvre un fichier RAR et présente le fichier demandé contenu - dans l'archive RAR pour téléchargement par le client. - - - - Exemple d'extractions RAR - -getName() . "\n"; - echo 'Taille compressée : ' . $entry->getPackedSize() . "\n"; - echo 'Taille après décompression : ' . $entry->getUnpackedSize() . "\n"; - - $entry->extract('/dir/extract/to/'); -} - -rar_close($rar_file); - -?> -]]> - - - - Cet exemple ouvre une archive RAR et extrait chaque entrée dans le - dossier spécifié. - - - - diff --git a/reference/rar/functions/rar-wrapper-cache-stats.xml b/reference/rar/functions/rar-wrapper-cache-stats.xml deleted file mode 100644 index f0f5c1ff22..0000000000 --- a/reference/rar/functions/rar-wrapper-cache-stats.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - rar_wrapper_cache_stats - Statistique pour le cache du gestionnaire URL - - - - &reftitle.description; - - stringrar_wrapper_cache_stats - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/rar/rararchive.xml b/reference/rar/rararchive.xml deleted file mode 100644 index 4a66788f55..0000000000 --- a/reference/rar/rararchive.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - La classe RarArchive - RarArchive - - - - -
    - &reftitle.intro; - - Cette classe représente une archive RAR, qui peut être formée de plusieurs volumes (parties) et - qui peut contenir plusieurs entrées RAR (c.-à-d., fichiers, dossiers et autres objets spéciaux comme - des liens symboliques). - - - Les objets de cette classe peuvent être parcourus, permettant ainsi d'accéder - aux entrées contenues dans les archives RAR respectives. - Ces entrées peuvent également être obtenues via les méthodes - RarArchive::getEntry et - RarArchive::getEntries. - -
    - - -
    - &reftitle.classsynopsis; - - - - RarArchive - - - - - final - RarArchive - - - - Traversable - - - - - &Methods; - - - - -
    - -     - - &reference.rar.entities.rararchive; - -     - diff --git a/reference/rar/rararchive/close.xml b/reference/rar/rararchive/close.xml deleted file mode 100644 index 386992c153..0000000000 --- a/reference/rar/rararchive/close.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - RarArchive::close - rar_close - Ferme une archive RAR et libère toutes les ressources - - - - &reftitle.description; - &style.oop; (méthode) : - - public boolRarArchive::close - - - &style.procedural; : - - boolrar_close - RarArchiverarfile - - - Ferme une archive RAR et libère toutes les ressources associées. - - - - - &reftitle.parameters; - - - rarfile - - - Un objet RarArchive, - ouvert avec la fonction rar_open. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - Les entrées RAR retournées par RarArchive::getEntry - et RarArchive::getEntries sont désormais invalidées - lors de l'appel à cette méthode. Cela signifie que tous les appels d'instances - sur de telles entrées ne sont pas garanties. - - - - - - - - - &reftitle.examples; - - &style.oop; - -close(); -echo $rar_arch."\n"; -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - - diff --git a/reference/rar/rararchive/getcomment.xml b/reference/rar/rararchive/getcomment.xml deleted file mode 100644 index ba1ee51a1a..0000000000 --- a/reference/rar/rararchive/getcomment.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - RarArchive::getComment - rar_comment_get - Récupère un commentaire depuis une archive RAR - - - - &reftitle.description; - &style.oop; (méthode) : - - public stringRarArchive::getComment - - - &style.procedural; : - - stringrar_comment_get - RarArchiverarfile - - - Récupère le commentaire global stocké dans l'archive RAR. - Il peut atteindre 64 Ko de long. - - - - Cette extension ne supporte pas les commentaires sur de simples entrées. - - - - - - &reftitle.parameters; - - - rarfile - - - Un objet RarArchive, - ouvert avec la fonction rar_open. - - - - - - - - &reftitle.returnvalues; - - Retourne le commentaire, ou &null; s'il n'y en a pas. - - - - RAR ne supporte actuellement pas les commentaires unicodes. - L'encodage du résultat de cette fonction n'est pas spécifié, - mais il sera probablement de type Windows-1252. - - - - - - &reftitle.examples; - - &style.oop; - -getComment(); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - - diff --git a/reference/rar/rararchive/getentries.xml b/reference/rar/rararchive/getentries.xml deleted file mode 100644 index 31b3d47e8c..0000000000 --- a/reference/rar/rararchive/getentries.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - RarArchive::getEntries - rar_list - Récupère la liste complète depuis l'archive RAR - - - - &reftitle.description; - &style.oop; (méthode): - - public arrayfalseRarArchive::getEntries - - - &style.procedural; : - - arrayfalserar_list - RarArchiverarfile - - - Récupère la liste complète (fichiers et dossiers) depuis l'archive RAR. - - - - Si l'archive contient des entrées portant le même nom, cette méthode, combinée - avec l'itération RarArchive foreach et un accès style - tableau avec des index numériques, est la seule permettant d'accéder à toutes les entrées - (c.-à-d. RarArchive::getEntry et le gestionnaire - rar:// sont insuffisants). - - - - - - &reftitle.parameters; - - - rarfile - - - Un objet RarArchive, ouvert avec la fonction - rar_open. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau d'objets RarEntry - &return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 3.0.0 - - Support des archives RAR contenant des entrées portant le même nom. - - - - - - - - - &reftitle.examples; - - &style.oop; - -getEntries(); -if ($rar_entries === FALSE) - die("Impossible de récupérer les entrées."); - -echo "Nombre d'entrées trouvées : " . count($rar_entries) . "\n"; - -foreach ($rar_entries as $e) { - echo $e; - echo "\n"; -} -$rar_arch->close(); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - &reftitle.seealso; - - RarArchive::getEntry - Le gestionnaire rar:// - - - - - diff --git a/reference/rar/rararchive/getentry.xml b/reference/rar/rararchive/getentry.xml deleted file mode 100644 index f357aba1ab..0000000000 --- a/reference/rar/rararchive/getentry.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - RarArchive::getEntry - rar_entry_get - Récupère une entrée depuis une archive RAR - - - - &reftitle.description; - &style.oop; (méthode): - - public RarEntryfalseRarArchive::getEntry - stringentryname - - &style.procedural; : - - RarEntryfalserar_entry_get - RarArchiverarfile - stringentryname - - - Récupère une entrée (fichier ou dossier) depuis une archive RAR. - - - - Il est possible d'également récupérer les entrées en utilisant - la méthode RarArchive::getEntries. - - - Il est à noter qu'une archive RAR peut avoir plusieurs entrées portant le même nom ; - cette méthode ne récupérera que la première. - - - - - - &reftitle.parameters; - - - rarfile - - - Un objet RarArchive, - ouvert avec la fonction rar_open. - - - - - entryname - - - Chemin vers l'entrée, dans l'archive RAR. - - - - Le chemin doit être le même que celui retourné par - la méthode - RarEntry::getName. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'entrée RarEntry correspondante &return.falseforfailure;. - - - - - &reftitle.examples; - - &style.oop; - -getEntry('tese.txt'); -if ($rar_entry === FALSE) - die("Impossible de récupérer cette entrée."); -echo get_class($rar_entry)."\n"; -echo $rar_entry; -$rar_arch->close(); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - &reftitle.seealso; - - RarArchive::getEntries - Le gestionnaire rar:// - - - - - diff --git a/reference/rar/rararchive/isbroken.xml b/reference/rar/rararchive/isbroken.xml deleted file mode 100644 index 0c6c0fcc8a..0000000000 --- a/reference/rar/rararchive/isbroken.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - RarArchive::isBroken - rar_broken_is - Teste si une archive est corrompue (incomplète) - - - - &reftitle.description; - &style.oop; (méthode) : - - public boolRarArchive::isBroken - - - &style.procedural; : - - boolrar_broken_is - RarArchiverarfile - - - Cette fonction détermine si une archive est incomplète, - c.-à-d., si un volume est manquant ou un volume est tronqué. - - - - - &reftitle.parameters; - - - rarfile - - - Un objet RarArchive, ouvert avec la fonction - rar_open. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si l'archive est corrompue, &false; sinon. - Cette fonction peut également retourner &false; si le fichier - passé a déjà été clos. La seule solution pour faire la différence - entre ces 2 cas est d'activer les exceptions grâce à la méthode - RarException::setUsingExceptions ; - cependant, ce n'est pas nécessaire sachant qu'un programme - ne doit pas fonctionner sur des fichiers fermés. - - - - - &reftitle.examples; - - &style.oop; - -isBroken()); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - &reftitle.seealso; - - RarArchive::setAllowBroken - - - - - diff --git a/reference/rar/rararchive/issolid.xml b/reference/rar/rararchive/issolid.xml deleted file mode 100644 index 892dbbc40c..0000000000 --- a/reference/rar/rararchive/issolid.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - RarArchive::isSolid - rar_solid_is - Vérifie si l'archive RAR est solide - - - - &reftitle.description; - &style.oop; (méthode) : - - public boolRarArchive::isSolid - - - &style.procedural; : - - boolrar_solid_is - RarArchiverarfile - - - Vérifie si l'archive RAR est solide. L'extraction de fichier individuel est plus - lente sur les archives solides. - - - - - &reftitle.parameters; - - - rarfile - - - Un objet RarArchive, - ouvert avec la fonction rar_open. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si l'archive est solide, &false; sinon. - - - - - &reftitle.examples; - - &style.oop; - -isSolid()?'oui':'non') ."\n"; -echo "$arch2: " . ($arch2->isSolid()?'oui':'non') . "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - diff --git a/reference/rar/rararchive/open.xml b/reference/rar/rararchive/open.xml deleted file mode 100644 index 005e8f5058..0000000000 --- a/reference/rar/rararchive/open.xml +++ /dev/null @@ -1,240 +0,0 @@ - - - - - - - RarArchive::open - rar_open - Ouvre une archive RAR - - - - &reftitle.description; - &style.oop; (méthode) : - - public static RarArchivefalseRarArchive::open - stringfilename - stringpasswordNULL - callablevolume_callbackNULL - - &style.procedural; : - - RarArchivefalserar_open - stringfilename - stringpasswordNULL - callablevolume_callbackNULL - - - Ouvre une archive RAR et retourne une instance RarArchive la représentant. - - - - Si on tente d'ouvrir une archive multivolume, le chemin du premier volume - doit être passé comme premier paramètre. - Sinon, l'ensemble des fichiers ne sera pas affiché. - - - - - - &reftitle.parameters; - - - filename - - - Chemin vers l'archive Rar. - - - - - password - - - Un mot de passe en texte brut, si nécessaire pour déchiffrer l'en-tête. - Il sera également utilisé par défaut si des fichiers cryptés sont trouvés. - Il est à noter que les fichiers peuvent avoir un mot de passe - différent de celui des en-têtes et différents entre eux. - - - - - volume_callback - - - Une fonction qui reçoit un seul paramètre - le chemin du volume - non trouvé - et retourne une &string; contenant le chemin correct - du volume ou &null; si le volume n'existe pas ou - le chemin n'est pas connu. Attention à ne pas créer de boucle infinie - sachant que la fonction sera appelée indéfiniment si le chemin retourné - dans un précédent appel ne correspond pas au volume désiré. Le fait de - spécifier ce paramètre évitera une alerte qui devrait être émise lorsqu'un - volume n'est pas trouvé ; une implémentation qui ne retourne que &null; - peut toutefois être utilisée pour éviter une telle alerte. - - - - - - - Avant la version 2.0.0, cette fonction ne gérait pas correctement les - chemins relatifs. Utiliser la fonction - realpath pour corriger ce bogue. - - - - - &reftitle.returnvalues; - - Retourne l'instance RarArchive requise &return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 3.0.0 - - Le paramètre volume_callback a été ajouté. - - - - - - - - - &reftitle.examples; - - &style.oop; - -getEntries(); -if ($entries === FALSE) - die("Échec lors de la récupération des entrées"); - -echo count($entries) . " fichier(s) trouvé(s).\n"; - -if (empty($entries)) - die("Aucune entrée valide n'a été trouvée."); - -$stream = reset($entries)->getStream(); -if ($stream === FALSE) - die("Échec lors de l'ouverture du premier fichier"); - -$rar_arch->close(); - -echo "Contenu du premier fichier :\n"; -echo stream_get_contents($stream); - -fclose($stream); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - -getStream(); -if ($stream === FALSE) - die("Échec lors de l'ouverture du premier fichier"); - -rar_close($rar_arch); - -echo "Contenu du premier fichier :\n"; -echo stream_get_contents($stream); - -fclose($stream); -?> -]]> - - - - Fonction de rappel pour le volume - -getEntry('file2.txt'); -$entry->extract(null, dirname(__FILE__) . "/temp_file2.txt"); -?> -]]> - - - - - - &reftitle.seealso; - - Le gestionnaire rar:// - - - - - - diff --git a/reference/rar/rararchive/setallowbroken.xml b/reference/rar/rararchive/setallowbroken.xml deleted file mode 100644 index 1c09c00fae..0000000000 --- a/reference/rar/rararchive/setallowbroken.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - RarArchive::setAllowBroken - Autorise ou non l'ouverture d'archives corrompues - - - - &reftitle.description; - &style.oop; (méthode) : - - public boolRarArchive::setAllowBroken - boolallow_broken - - &style.procedural; : - - boolrar_allow_broken_set - RarArchiverarfile - boolallow_broken - - - Cette méthode définit si les archives corrompues peuvent être lues ou bien - si les opérations qui tentent d'extraire les entrées de l'archive doivent - échouer. Les archives corrompues sont les archives pour lesquelles aucune - erreur n'est détectée lorsque le fichier est ouvert mais qu'une erreur - survient lors de la lecture des entrées. - - - - - &reftitle.parameters; - - - rarfile - - - Un objet RarArchive, ouvert avec la fonction - rar_open. - - - - - allow_broken - - - Si la lecture des archives corrompues est autorisée (&true;) - ou non (&false;). - - - - - - - - &reftitle.returnvalues; - - Retourne &true; &return.falseforfailure;. La méthode échouera uniquement - si le fichier a déjà été clos. - - - - - &reftitle.examples; - - &style.oop; - -setAllowBroken(true); -foreach ($a->getEntries() as $e) { - echo "$e\n"; -} -var_dump(count($a)); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - &reftitle.seealso; - - RarArchive::isBroken - - - - - diff --git a/reference/rar/rararchive/tostring.xml b/reference/rar/rararchive/tostring.xml deleted file mode 100644 index 4485dd7c93..0000000000 --- a/reference/rar/rararchive/tostring.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - RarArchive::__toString - Récupère une représentation sous forme de texte - - - - &reftitle.description; - - public stringRarArchive::__toString - - - - Fournit une représentation sous forme de &string; pour l'objet - RarArchive. Actuellement, ce sera le nom du chemin complet vers - le volume de l'archive ouverte ainsi qu'une information indiquant si la ressource est - valide ou bien si elle a été close via un appel à la méthode - RarArchive::close. - - - Cette méthode ne doit être utilisée qu'à des fins de débogage, sachant qu'elle n'est - ni garantie dans les informations composant le résultat, ni garantie dans la façon dont le - résultat sera formaté. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une représentation textuelle de l'objet RarArchive. - Le contenu de cette représentation n'est pas spécifié. - - - - - &reftitle.examples; - - Exemple avec <methodname>RarArchive::__toString</methodname> - -close(); -echo $rar_arch."\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/rar/rarentry.xml b/reference/rar/rarentry.xml deleted file mode 100644 index 117ed229c2..0000000000 --- a/reference/rar/rarentry.xml +++ /dev/null @@ -1,808 +0,0 @@ - - - - - - La classe <classname>RarEntry</classname> - RarEntry - - - - -
    - &reftitle.intro; - - Une entrée RAR, représentant un dossier ou un fichier compressé dans une archive RAR. - -
    - - -
    - &reftitle.classsynopsis; - - - - RarEntry - - - - - final - RarEntry - - - - &Constants; - - const - int - RarEntry::HOST_MSDOS - 0 - - - const - int - RarEntry::HOST_OS2 - 1 - - - const - int - RarEntry::HOST_WIN32 - 2 - - - const - int - RarEntry::HOST_UNIX - 3 - - - const - int - RarEntry::HOST_MACOS - 4 - - - const - int - RarEntry::HOST_BEOS - 5 - - - const - int - RarEntry::ATTRIBUTE_WIN_READONLY - 1 - - - const - int - RarEntry::ATTRIBUTE_WIN_HIDDEN - 2 - - - const - int - RarEntry::ATTRIBUTE_WIN_SYSTEM - 4 - - - const - int - RarEntry::ATTRIBUTE_WIN_DIRECTORY - 16 - - - const - int - RarEntry::ATTRIBUTE_WIN_ARCHIVE - 32 - - - const - int - RarEntry::ATTRIBUTE_WIN_DEVICE - 64 - - - const - int - RarEntry::ATTRIBUTE_WIN_NORMAL - 128 - - - const - int - RarEntry::ATTRIBUTE_WIN_TEMPORARY - 256 - - - const - int - RarEntry::ATTRIBUTE_WIN_SPARSE_FILE - 512 - - - const - int - RarEntry::ATTRIBUTE_WIN_REPARSE_POINT - 1024 - - - const - int - RarEntry::ATTRIBUTE_WIN_COMPRESSED - 2048 - - - const - int - RarEntry::ATTRIBUTE_WIN_OFFLINE - 4096 - - - const - int - RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED - 8192 - - - const - int - RarEntry::ATTRIBUTE_WIN_ENCRYPTED - 16384 - - - const - int - RarEntry::ATTRIBUTE_WIN_VIRTUAL - 65536 - - - const - int - RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE - 1 - - - const - int - RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE - 2 - - - const - int - RarEntry::ATTRIBUTE_UNIX_WORLD_READ - 4 - - - const - int - RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE - 8 - - - const - int - RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE - 16 - - - const - int - RarEntry::ATTRIBUTE_UNIX_GROUP_READ - 32 - - - const - int - RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE - 64 - - - const - int - RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE - 128 - - - const - int - RarEntry::ATTRIBUTE_UNIX_OWNER_READ - 256 - - - const - int - RarEntry::ATTRIBUTE_UNIX_STICKY - 512 - - - const - int - RarEntry::ATTRIBUTE_UNIX_SETGID - 1024 - - - const - int - RarEntry::ATTRIBUTE_UNIX_SETUID - 2048 - - - const - int - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET - 61440 - - - const - int - RarEntry::ATTRIBUTE_UNIX_FIFO - 4096 - - - const - int - RarEntry::ATTRIBUTE_UNIX_CHAR_DEV - 8192 - - - const - int - RarEntry::ATTRIBUTE_UNIX_DIRECTORY - 16384 - - - const - int - RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV - 24576 - - - const - int - RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE - 32768 - - - const - int - RarEntry::ATTRIBUTE_UNIX_SYM_LINK - 40960 - - - const - int - RarEntry::ATTRIBUTE_UNIX_SOCKET - 49152 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - RarEntry::HOST_MSDOS - - - Si la valeur retournée de RarEntry::getHostOs - est égale à cette constante, MS-DOS est utilisé pour ajouter cette entrée. - Destinée à remplacer la constante RAR_HOST_MSDOS. - - - - - - RarEntry::HOST_OS2 - - - Si la valeur retournée de RarEntry::getHostOs - est égale à cette constante, OS/2 est utilisé pour ajouter cette entrée. - Destinée à remplacer la constante RAR_HOST_OS2. - - - - - - RarEntry::HOST_WIN32 - - - Si la valeur retournée de RarEntry::getHostOs - est égale à cette constante, Microsoft Windows est utilisé pour ajouter cette entrée. - Destinée à remplacer la constante RAR_HOST_WIN32. - - - - - - RarEntry::HOST_UNIX - - - Si la valeur retournée de RarEntry::getHostOs - est égale à cette constante, UNIX OS est utilisé pour ajouter cette entrée. - Destinée à remplacer la constante RAR_HOST_UNIX. - - - - - - RarEntry::HOST_MACOS - - - Si la valeur retournée de RarEntry::getHostOs - est égale à cette constante, Mac OS est utilisé pour ajouter cette entrée. - - - - - - RarEntry::HOST_BEOS - - - Si la valeur retournée de RarEntry::getHostOs - est égale à cette constante, BeOS est utilisé pour ajouter cette entrée. - Destinée à remplacer la constante RAR_HOST_BEOS. - - - - - - RarEntry::ATTRIBUTE_WIN_READONLY - - - Bit représentant une entrée Windows avec un attribut en lecture seule. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_WIN_HIDDEN - - - Bit représentant une entrée Windows avec un attribut caché. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_WIN_SYSTEM - - - Bit représentant une entrée Windows avec un attribut système. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_WIN_DIRECTORY - - - Bit représentant une entrée Windows avec un attribut dossier (l'entrée - est un dossier). - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. Voir aussi la méthode - RarEntry::isDirectory, qui fonctionne également - avec les entrées qui ne sont pas ajoutées dans WinRAR. - - - - - - RarEntry::ATTRIBUTE_WIN_ARCHIVE - - - Bit représentant une entrée Windows avec un attribut d'archive. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_WIN_DEVICE - - - Bit représentant une entrée Windows avec un attribut de périphérique. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_WIN_NORMAL - - - Bit représentant une entrée Windows avec un attribut de fichier normal - (l'entrée n'est pas un dossier). - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. Voir aussi la méthode - RarEntry::isDirectory, qui fonctionne également - avec les entrées qui ne sont pas ajoutées dans WinRAR. - - - - - - RarEntry::ATTRIBUTE_WIN_TEMPORARY - - - Bit représentant une entrée Windows avec un attribut temporaire. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_WIN_SPARSE_FILE - - - Bit représentant une entrée Windows avec un attribut de fichier fragmenté - (le fichier est un fichier NTFS fragmenté). - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_WIN_REPARSE_POINT - - - Bit représentant une entrée Windows avec un attribut de point d'analyse - (le fichier est un point d'analyse NTFS ; c.-à-d. une jonction de dossier ou un système - de fichier monté). - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_WIN_COMPRESSED - - - Bit représentant une entrée Windows avec un attribut compressé - (NTFS uniquement). - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_WIN_OFFLINE - - - Bit représentant une entrée Windows avec un attribut hors-ligne - (le fichier est hors-ligne et non accessible). - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED - - - Bit représentant une entrée Windows avec un attribut dont le contenu n'est pas indexé - (l'entrée doit être indexée). - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_WIN_ENCRYPTED - - - Bit représentant une entrée Windows avec un attribut crypté - (NTFS uniquement). - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_WIN_VIRTUAL - - - Bit représentant une entrée Windows avec un attribut virtuel. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est Microsoft Windows. - - - - - - RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE - - - Bit représentant une entrée UNIX qui est exécutable par tous. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX. - - - - - - RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE - - - Bit représentant une entrée UNIX qui est accessible en écriture par tous. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX. - - - - - - RarEntry::ATTRIBUTE_UNIX_WORLD_READ - - - Bit représentant une entrée UNIX qui est accessible en lecture par tous. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX. - - - - - - RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE - - - Bit représentant une entrée UNIX qui est dans le groupe des exécutables. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX. - - - - - - RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE - - - Bit représentant une entrée UNIX qui est dans le groupe des accessibles en écriture. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX. - - - - - - RarEntry::ATTRIBUTE_UNIX_GROUP_READ - - - Bit représentant une entrée UNIX qui est dans le groupe des accessibles en lecture. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX. - - - - - - RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE - - - Bit représentant une entrée UNIX dont le propriétaire est exécutable. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX. - - - - - - RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE - - - Bit représentant une entrée UNIX dont le propriétaire est accessible en écriture. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX. - - - - - - RarEntry::ATTRIBUTE_UNIX_OWNER_READ - - - Bit représentant une entrée UNIX dont le propriétaire est accessible en lecture. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX. - - - - - - RarEntry::ATTRIBUTE_UNIX_STICKY - - - Bit représentant une entrée UNIX ayant le bit sticky. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX. - - - - - - RarEntry::ATTRIBUTE_UNIX_SETGID - - - Bit représentant un attribut UNIX setgid. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX. - - - - - - RarEntry::ATTRIBUTE_UNIX_SETUID - - - Bit représentant un attribut UNIX setuid. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX. - - - - - - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET - - - Masque permettant d'isoler les 4 derniers bits (nibble) des attributs UNIX - (_S_IFMT, le type du masque de fichier). - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX et avec les constantes - RarEntry::ATTRIBUTE_UNIX_FIFO, - RarEntry::ATTRIBUTE_UNIX_CHAR_DEV, - RarEntry::ATTRIBUTE_UNIX_DIRECTORY, - RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV, - RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE, - RarEntry::ATTRIBUTE_UNIX_SYM_LINK et - RarEntry::ATTRIBUTE_UNIX_SOCKET. - - - - - RarEntry::ATTRIBUTE_UNIX_FIFO - - - Attributs FIFOs Unix dont les 4 derniers bits ont cette valeur. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX et avec la constante - - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - - RarEntry::ATTRIBUTE_UNIX_CHAR_DEV - - - Attributs des périphériques Unix dont les 4 derniers bits ont cette valeur. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX et avec la constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - - RarEntry::ATTRIBUTE_UNIX_DIRECTORY - - - Attributs des dossiers Unix dont les 4 derniers bits ont cette valeur. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX et avec la constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - Voir aussi la méthode RarEntry::isDirectory - qui fonctionne également avec les entrées qui ont été ajoutées sous - d'autres systèmes d'exploitation. - - - - - - RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV - - - Attributs des périphériques de bloc Unix dont les 4 derniers bits ont cette valeur. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX et avec la constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - - RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE - - - Attributs des fichiers réguliers (pas de dossiers) Unix dont les 4 derniers bits ont cette valeur. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX et avec la constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - Voir aussi la méthode RarEntry::isDirectory - qui fonctionne également avec les entrées qui ont été ajoutées sous - d'autres systèmes d'exploitation. - - - - - - RarEntry::ATTRIBUTE_UNIX_SYM_LINK - - - Attributs des liens symboliques Unix dont les 4 derniers bits ont cette valeur. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX et avec la constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - - RarEntry::ATTRIBUTE_UNIX_SOCKET - - - Attributs des sockets Unix dont les 4 derniers bits ont cette valeur. - À utiliser avec la méthode RarEntry::getAttr - sur les entrées dont l'OS hôte est UNIX et avec la constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - -
    - - - -     - - &reference.rar.entities.rarentry; - -     - diff --git a/reference/rar/rarentry/extract.xml b/reference/rar/rarentry/extract.xml deleted file mode 100644 index d6d2eb4035..0000000000 --- a/reference/rar/rarentry/extract.xml +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - - RarEntry::extract - Extrait une entrée d'une archive - - - - &reftitle.description; - - public boolRarEntry::extract - stringdir - stringfilepath"" - stringpasswordNULL - boolextended_data&false; - - - RarEntry::extract extrait une entrée de données. - Ceci va créer un nouveau fichier dans le dossier spécifié par le paramètre - dir portant un nom identique au nom de l'entrée, - tant que le second argument n'est pas spécifié. Voir ci-dessous pour plus - d'informations. - - - - - &reftitle.parameters; - - - dir - - - Chemin vers le dossier où le fichier extrait devra être créé. - Ce paramètre sera utilisé uniquement si le paramètre - filepath n'est pas fourni. Si ces 2 paramètres - sont vides, l'extraction se fera dans le dossier courant. - - - - - - filepath - - - Chemin (relatif ou absolu) contenant le dossier et le nom du fichier à extraire. - Ce paramètre écrase à la fois le paramètre dir - et le nom original du fichier. - - - - - - password - - - Le mot de passe à utiliser pour déchiffrer cette entrée. Si l'entrée n'est pas cryptée, - cette valeur ne sera pas utilisée et peut être omise. Si ce paramètre est omis et que - l'entrée est cryptée, le mot de passe fourni à la fonction rar_open, - s'il existe, sera utilisé. Si un mauvais mot de passe est fourni, soit explicitement - ou implicitement via la fonction rar_open, la vérification CRC - échouera et cette méthode échouera, en retournant &false;. - Si aucun mot de passe n'est fourni alors qu'il est nécessaire, cette méthode échouera - en retournant &false;. Il est possible de vérifier si une entrée est cryptée avec la méthode - RarEntry::isEncrypted. - - - - - - extended_data - - - Si vaut &true;, les informations étendues comme NTFS ACLs - et les informations sur le propriétaire Unix seront - définies dans les fichiers extraits, s'ils sont bien définis - dans l'archive. - - - - - - - Avant la version 2.0.0, cette fonction ne gérait pas les chemins relatifs - correctement. Utiliser la fonction realpath comme contournement. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 3.0.0 - - Le paramètre extended_data a été ajouté. - - - - PECL rar 3.0.0 - - Support des archives RAR contenant des entrées portant le même nom. - - - - - - - - - &reftitle.examples; - - - Exemple avec <methodname>RarEntry::extract</methodname> - -extract('/dir/to'); // Création de /dir/to/Dir/file.txt -$entry->extract(false, '/dir/to/new_name.txt'); // Création de /dir/to/new_name.txt - -?> -]]> - - - - Comment extraire tous les fichiers d'une archive : - -extract("."); // Extraction dans le dossier courant -} -rar_close($rar_file); - -?> -]]> - - - - - - - &reftitle.seealso; - - RarEntry::getStream - Le gestionnaire rar:// - - - - - diff --git a/reference/rar/rarentry/getattr.xml b/reference/rar/rarentry/getattr.xml deleted file mode 100644 index a3100c47d6..0000000000 --- a/reference/rar/rarentry/getattr.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - RarEntry::getAttr - Récupère les attributs d'une entrée - - - - &reftitle.description; - - public intRarEntry::getAttr - - - - Retourne les attributs dépendants de l'OS d'une entrée d'une archive. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les attributs ou &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <methodname>RarEntry::getAttr</methodname> - -getHostOs(); -$attr = $entry->getAttr(); - -switch($host_os) { - case RAR_HOST_MSDOS: - case RAR_HOST_OS2: - case RAR_HOST_WIN32: - case RAR_HOST_MACOS: - printf("%c%c%c%c%c%c\n", - ($attr & 0x08) ? 'V' : '.', - ($attr & 0x10) ? 'D' : '.', - ($attr & 0x01) ? 'R' : '.', - ($attr & 0x02) ? 'H' : '.', - ($attr & 0x04) ? 'S' : '.', - ($attr & 0x20) ? 'A' : '.'); - break; - case RAR_HOST_UNIX: - case RAR_HOST_BEOS: - switch ($attr & 0xF000) - { - case 0x4000: - printf("d"); - break; - case 0xA000: - printf("l"); - break; - default: - printf("-"); - break; - } - printf("%c%c%c%c%c%c%c%c%c\n", - ($attr & 0x0100) ? 'r' : '-', - ($attr & 0x0080) ? 'w' : '-', - ($attr & 0x0040) ? (($attr & 0x0800) ? 's':'x'):(($attr & 0x0800) ? 'S':'-'), - ($attr & 0x0020) ? 'r' : '-', - ($attr & 0x0010) ? 'w' : '-', - ($attr & 0x0008) ? (($attr & 0x0400) ? 's':'x'):(($attr & 0x0400) ? 'S':'-'), - ($attr & 0x0004) ? 'r' : '-', - ($attr & 0x0002) ? 'w' : '-', - ($attr & 0x0001) ? 'x' : '-'); - break; -} - -rar_close($rar_file); - -?> -]]> - - - - - - - &reftitle.seealso; - - RarEntry::getHostOs - Les constantes de la classe RarEntry - - - - - diff --git a/reference/rar/rarentry/getcrc.xml b/reference/rar/rarentry/getcrc.xml deleted file mode 100644 index b861bc8a65..0000000000 --- a/reference/rar/rarentry/getcrc.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - RarEntry::getCrc - Récupère le CRC d'une entrée - - - - &reftitle.description; - - public stringRarEntry::getCrc - - - - Retourne une &string; hexadécimale représentant le CRC d'une entrée d'une archive. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le CRC d'une entrée d'une archive, ou &false; si une erreur survient. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - Cette méthode retourne maintenant des valeurs correctes pour les - archives sur plusieurs volumes. - - - - - - - - - diff --git a/reference/rar/rarentry/getfiletime.xml b/reference/rar/rarentry/getfiletime.xml deleted file mode 100644 index 1328db984e..0000000000 --- a/reference/rar/rarentry/getfiletime.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - RarEntry::getFileTime - Récupère la date de dernière modification d'une entrée - - - - &reftitle.description; - - public stringRarEntry::getFileTime - - - - Récupère la date de dernière modification d'une entrée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la date de dernière modification de l'entrée sous la forme - d'une &string; au format YYYY-MM-DD HH:II:SS, ou - &false; si une erreur survient. - - - - - diff --git a/reference/rar/rarentry/gethostos.xml b/reference/rar/rarentry/gethostos.xml deleted file mode 100644 index ad52f8d3f5..0000000000 --- a/reference/rar/rarentry/gethostos.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - RarEntry::getHostOs - Récupère le code de l'hôte pour une entrée - - - - &reftitle.description; - - public intRarEntry::getHostOs - - - - Retourne le code de l'OS hôte d'une entrée d'une archive. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le code de l'OS hôte d'une entrée, ou &false; si une erreur - survient. - - - - - &reftitle.examples; - - - Exemple avec <methodname>RarEntry::getHostOs</methodname> (version >= 2.0.0) - -getHostOs()) { - case RarEntry::HOST_MSDOS: - echo "MS-DOS\n"; - break; - case RarEntry::HOST_OS2: - echo "OS2\n"; - break; - case RarEntry::HOST_WIN32: - echo "Win32\n"; - break; - case RarEntry::HOST_MACOS: - echo "MacOS\n"; - break; - case RarEntry::HOST_UNIX: - echo "Unix/Linux\n"; - break; - case RarEntry::HOST_BEOS: - echo "BeOS\n"; - break; -} - -?> -]]> - - - - - Exemple avec <methodname>RarEntry::getHostOs</methodname> (version <= 1.0.0) - -getHostOs()) { - case RAR_HOST_MSDOS: - echo "MS-DOS\n"; - break; - case RAR_HOST_OS2: - echo "OS2\n"; - break; - case RAR_HOST_WIN32: - echo "Win32\n"; - break; - case RAR_HOST_MACOS: - echo "MacOS\n"; - break; - case RAR_HOST_UNIX: - echo "Unix/Linux\n"; - break; - case RAR_HOST_BEOS: - echo "BeOS\n"; - break; -} - -?> -]]> - - - - - - - &reftitle.seealso; - - RarEntry::extract - - - - - diff --git a/reference/rar/rarentry/getmethod.xml b/reference/rar/rarentry/getmethod.xml deleted file mode 100644 index a823f58c31..0000000000 --- a/reference/rar/rarentry/getmethod.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - RarEntry::getMethod - Récupère la méthode utilisée pour l'ajout d'une entrée - - - - &reftitle.description; - - public intRarEntry::getMethod - - - - Récupère la méthode utilisée lors de l'ajout d'une entrée dans l'archive courante. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le numéro de la méthode, ou &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <methodname>RarEntry::getMethod</methodname> - -getMethod(); - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/getname.xml b/reference/rar/rarentry/getname.xml deleted file mode 100644 index e36f276e42..0000000000 --- a/reference/rar/rarentry/getname.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - RarEntry::getName - Récupère le nom de l'entrée - - - - &reftitle.description; - - public stringRarEntry::getName - - - - Retourne le nom (avec le chemin) de l'entrée d'une archive. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le nom de l'entrée, sous la forme d'une &string; - ou &false; si une erreur survient. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - Depuis la version 2.0.0, la &string; retournée est encodée en - Unicode/UTF-8. - - - - - - - - - &reftitle.examples; - - Exemple avec <methodname>RarEntry::getName</methodname> - -getName(), - ENT_COMPAT, - "UTF-8" - ), - "HTML-ENTITIES", - "UTF-8" -); - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/getpackedsize.xml b/reference/rar/rarentry/getpackedsize.xml deleted file mode 100644 index c130845c53..0000000000 --- a/reference/rar/rarentry/getpackedsize.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - RarEntry::getPackedSize - Récupère la taille compressée d'une entrée - - - - &reftitle.description; - - public intRarEntry::getPackedSize - - - - Récupère la taille compressée d'une entrée d'archive. - - - - Noter que sous les plateformes 32bits (y compris sous Windows 64bits), - la taille maximale retournée sera tronquée à 2 Go. Vérifier la constante - PHP_INT_MAX. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la taille compressée, ou &false; si une erreur survient. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - Cette méthode retourne maintenant des valeurs correctes de tailles - compressées plus grandes que 2Go sous les plateformes 64bits et - ne retourne jamais de valeurs négatives sous les autres plateformes. - - - - - - - - - &reftitle.examples; - - Exemple avec <methodname>RarEntry::getPackedSize</methodname> - -getName() . " = " . $entry->getPackedSize() . " octets"; - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/getstream.xml b/reference/rar/rarentry/getstream.xml deleted file mode 100644 index 2dd472cc6d..0000000000 --- a/reference/rar/rarentry/getstream.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - RarEntry::getStream - Récupère le gestionnaire de fichier pour une entrée - - - - &reftitle.description; - - public resourcefalseRarEntry::getStream - stringpassword - - - Retourne le gestionnaire de fichier qui supporte les opérations de lecture. - Ce gestionnaire permet la décompression à la volée de l'entrée. - - - Le gestionnaire ne sera pas touché par l'appel à la fonction - rar_close. - - - - Le flux résultant ne permet pas de vérifier l'intégrité des données. - Par exemple, un fichier corrompu ou crypté avec une clé fausse ne sera - pas détecté. Ce sera de la responsabilité du développeur d'utiliser - le CRC de l'entrée pour vérifier son intégrité, s'il le souhaite. - - - - - - &reftitle.parameters; - - - password - - - Le mot de passe à utiliser pour déchiffrer l'entrée. Si l'entrée - n'est pas cryptée, la valeur ne sera pas utilisée et peut - être omise. Si ce paramètre est omis et que l'entrée est cryptée, - le mot de passe fourni lors de l'appel à la fonction - rar_open sera utilisé, s'il a été fourni. - Si un mauvais mot de passe est fourni, soit explicitement, soit - implicitement via la fonction rar_open, - le flux résultant produira un affichage incorrect. Si aucun - mot de passe n'est fourni alors qu'il est nécessaire, la méthode - échoue et retournera &false;. Il est possible de vérifier si l'entrée - est cryptée en utilisant la méthode RarEntry::isEncrypted. - - - - - - - - &reftitle.returnvalues; - - Le gestionnaire de fichier,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 3.0.0 - - Support des archives RAR dont les entrées portent le même nom. - - - - - - - - - &reftitle.examples; - - Exemple avec <methodname>RarEntry::getStream</methodname> - -getStream(); -if ($stream === false) - die("Échec lors de la récupération du flux."); - -rar_close($rar_file); //le flux est indépendant du fichier - -while (!feof($stream)) { - $buff = fread($stream, 8192); - if ($buff !== false) - echo $buff; - else - break; //erreur fread -} - -fclose($stream); - -?> -]]> - - - - - - &reftitle.seealso; - - RarEntry::extract - Le gestionnaire rar:// - - - - - diff --git a/reference/rar/rarentry/getunpackedsize.xml b/reference/rar/rarentry/getunpackedsize.xml deleted file mode 100644 index 06a7391e7a..0000000000 --- a/reference/rar/rarentry/getunpackedsize.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - RarEntry::getUnpackedSize - Récupère la taille décompressée d'une entrée - - - - &reftitle.description; - - public intRarEntry::getUnpackedSize - - - - Récupère la taille décompressée d'une entrée d'une archive. - - - - Il est à noter que sur les plateformes 32bits (y compris les Windows x64), - la taille maximale est tronquée à 2 Go. Vérifier la constante - PHP_INT_MAX. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la taille décompressée, ou &false; si une erreur survient. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - Cette méthode retourne désormais les valeurs correctes pour - les tailles décompressées plus grandes que 2Go sur les plateformes - 64bits et ne retournera jamais de valeurs négatives pour les autres - plateformes. - - - - - - - - - &reftitle.returnvalues; - - Exemple avec <methodname>RarEntry::getUnpackedSize</methodname> - -getName() . " = " . $entry->getUnpackedSize() . " octets"; - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/getversion.xml b/reference/rar/rarentry/getversion.xml deleted file mode 100644 index 68aa411c67..0000000000 --- a/reference/rar/rarentry/getversion.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - RarEntry::getVersion - Récupère la version minimale du logiciel RAR à utiliser pour décompresser une entrée - - - - &reftitle.description; - - public intRarEntry::getVersion - - - - Retourne la version minimale du logiciel RAR (e.g. WinRAR) requise - pour décompresser l'entrée. Elle sera encodée sous la forme - 10 * version majeure + version mineure. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la version ou &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <methodname>RarEntry::getVersion</methodname> - -getVersion(); - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/isdirectory.xml b/reference/rar/rarentry/isdirectory.xml deleted file mode 100644 index 89ffdac7eb..0000000000 --- a/reference/rar/rarentry/isdirectory.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - RarEntry::isDirectory - Teste si l'entrée courante est un dossier - - - - &reftitle.description; - - public boolRarEntry::isDirectory - - - - Teste si l'entrée courante est un dossier. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si l'entrée est un dossier, &false; sinon. - - - - - &reftitle.notes; - - Cette fonction est uniquement disponible depuis la version 2.0.0, - mais ce test peut également être effectué en vérifiant les attributs - de l'entrée comme ceci (ne fonctionne que pour des fichiers compressés - avec RAR sous Windows ou Unix) : - -getHostOs() == RAR_HOST_WIN32) && ($e->getAttr() & 0x10)) || - (($e->getHostOs() == RAR_HOST_UNIX) && (($e->getAttr() & 0xf000) == 0x4000))); -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/isencrypted.xml b/reference/rar/rarentry/isencrypted.xml deleted file mode 100644 index a6893ea6d2..0000000000 --- a/reference/rar/rarentry/isencrypted.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - RarEntry::isEncrypted - Teste si une entrée est cryptée - - - - &reftitle.description; - - public boolRarEntry::isEncrypted - - - - Teste si le contenu de l'entrée courante est crypté. - - - - Le mot de passe utilisé peut différer entre plusieurs fichiers de la même - archive RAR. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si l'entrée courante est cryptée, &false; sinon. - - - - - - diff --git a/reference/rar/rarentry/tostring.xml b/reference/rar/rarentry/tostring.xml deleted file mode 100644 index dddbd5be6b..0000000000 --- a/reference/rar/rarentry/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - RarEntry::__toString - Récupère une représentation sous forme de chaîne de caractères d'une entrée - - - - &reftitle.description; - - public stringRarEntry::__toString - - - - Retourne une représentation textuelle d'une entrée. - Ceci inclut les entrées sous forme de fichier, de dossier (les liens symboliques ou les objets spéciaux seront - traités comme des fichiers), les noms UTF-8 des entrées, mais aussi les CRC. - La forme et le contenu de cette représentation peuvent changer dans le futur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une représentation textuelle de l'entrée. - - - - - - diff --git a/reference/rar/rarexception.xml b/reference/rar/rarexception.xml deleted file mode 100644 index 2c9eb41061..0000000000 --- a/reference/rar/rarexception.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - La classe RarException - RarException - - - - -
    - &reftitle.intro; - - Cette classe sert à 2 choses : C'est le type d'exceptions lancées par l'extension RAR - et permet, via ses méthodes statiques, de savoir et de définir les comportements - des erreurs de l'extension, c.-à-d. si l'exception doit être émise ou bien si des alertes PHP - doivent être émises. - - - Les codes erreurs suivants sont utilisés : - - - - - -1 - Erreur externe à la bibliothèque UnRAR - - - - - 11 - Mémoire insuffisante - - - - - - 12 - Données incorrectes - - - - - - 13 - Archive incorrecte - - - - - - 14 - Format inconnu - - - - - - 15 - Erreur lors de l'ouverture du fichier - - - - - - 16 - Erreur lors de la création d'un fichier - - - - - - 17 - Erreur lors de la fermeture d'un fichier - - - - - - 18 - Erreur lors de la lecture - - - - - 19 - Erreur lors de l'écriture - - - - - - 20 - Buffer trop petit - - - - - - 21 - Erreur RAR inconnue - - - - - - 22 - Mot de passe nécessaire mais non fourni - - - -
    - - -
    - &reftitle.classsynopsis; - - - - RarException - - - - - final - RarException - - - - extends - Exception - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.rar.entities.rarexception; - -     - diff --git a/reference/rar/rarexception/isusingexceptions.xml b/reference/rar/rarexception/isusingexceptions.xml deleted file mode 100644 index 80d07b556f..0000000000 --- a/reference/rar/rarexception/isusingexceptions.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - RarException::isUsingExceptions - Vérifie si le gestionnaire d'erreur utilise les exceptions ou non - - - - &reftitle.description; - - public static boolRarException::isUsingExceptions - - - - Vérifie si les fonctions RAR émettent des alertes et retournent des valeurs d'erreur - ou bien si elles émettent des exceptions dans la plupart des cas (cela n'inclut pas - certaines erreurs de programmation telles que le fait de passer des types incorrects - comme arguments). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si les exceptions sont utilisées, &false; sinon. - - - - - &reftitle.examples; - - Exemple avec <function>RarException::isUsingExceptions</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - RarException::setUsingExceptions - - - - - diff --git a/reference/rar/rarexception/setusingexceptions.xml b/reference/rar/rarexception/setusingexceptions.xml deleted file mode 100644 index 83d65bdb0f..0000000000 --- a/reference/rar/rarexception/setusingexceptions.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - RarException::setUsingExceptions - Active ou désactive les exceptions dans le gestionnaire d'erreurs - - - - &reftitle.description; - - public static voidRarException::setUsingExceptions - boolusing_exceptions - - - Si et seulement si l'argument vaut &true;, alors, au lieu d'émettre des alertes - et de retourner des valeurs spéciales indiquant une erreur lorsque la - bibliothèque UnRAR rencontre une erreur, une exception de type - RarException est émise. - - - Les exceptions seront également lancées pour les erreurs suivantes, - qui surviennent en dehors de la bibliothèque (leurs codes erreurs seront -1) : - - - - - tentative d'une opération sur un objet RarArchive clos ou - un objet RarEntry relatif au premier ; - - - - - - tentative de récupération d'une entrée qui n'existe pas avec la méthode - RarArchive::getEntry. - - - - - - - - &reftitle.parameters; - - - using_exceptions - - - Doit valoir &true; pour activer l'émission d'exceptions, &false; pour le - désactiver (par défaut). - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple avec <function>RarException::setUsingExceptions</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - RarException::isUsingExceptions - - - - - diff --git a/reference/rar/reference.xml b/reference/rar/reference.xml deleted file mode 100644 index bae24425ad..0000000000 --- a/reference/rar/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - &Functions; Rar - - &reference.rar.entities.functions; - - - diff --git a/reference/rar/setup.xml b/reference/rar/setup.xml deleted file mode 100644 index ce4576887d..0000000000 --- a/reference/rar/setup.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.install; - - Rar est actuellement disponible via PECL - &url.pecl.package;rar. - - - Il est possible d'utiliser l'assistant d'installation PECL pour installer l'extension - Rar, en utilisant la commande suivante : pecl -v install rar. - - - Il est possible d'également télécharger le paquet tar.gz et installer - Rar manuellement : - - Installation de Rar - - - - - - - Les utilisateurs de Windows doivent activer la bibliothèque - php_rar.dll dans le fichier &php.ini; - afin d'utiliser ces fonctions. - -
    - - - -
    - &reftitle.resources; - - Cette extension enregistre 3 classes internes : - La représentation de l'archive retournée par la fonction - rar_open – RarArchive, - la représentation des entrées retournée par - les fonctions rar_list et - rar_entry_get – RarEntry - et les exceptions de type RarException. - - - Cette extension enregistre également un flux de ressource appelé "rar" - et un gestionnaire d'url appelé "rar wrapper", et enregistré sous le préfixe - "rar". - -
    - - -     - diff --git a/reference/recode/book.xml b/reference/recode/book.xml deleted file mode 100644 index e424943a9b..0000000000 --- a/reference/recode/book.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - GNU Recode - Recode - - - - &reftitle.intro; - &warn.pecl.unmaintained; - - Ce module contient une interface à la bibliothèque GNU Recode. La - bibliothèque GNU Recode convertit les fichiers entre divers codages. - Lorsque cette conversion n'a pu être effectuée de manière précise, - des approximations sont effectuées. La bibliothèque reconnaît environ - 150 jeux de caractères différents et est capable de convertir des - fichiers en les utilisant. La plupart des jeux de caractères - RFC 1345 sont supportés. - - - - Cette extension a été retirée et déplacée dans - PECL à partir de PHP 7.4.0. - Considérez l'utilisation des extensions - Chaînes Multioctets ou - iconv à la place. - - - ¬e.no-windows.extension; - - - - &reference.recode.setup; - &reference.recode.reference; - - - diff --git a/reference/recode/configure.xml b/reference/recode/configure.xml deleted file mode 100644 index 8c405955c0..0000000000 --- a/reference/recode/configure.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - -
    - &reftitle.install; - -
    - PHP 7.4 - - &pecl.moved-ver;7.4.0 - - - &pecl.info; - &url.pecl.package;recode. - -
    - -
    - PHP < 7.4 - - Pour utiliser les fonctions définies dans ce module PHP doit être compilé - avec l'option . - - - - Des crashs et des problèmes de démarrage de PHP - peuvent être rencontrés lorsque l'extension recode est chargée - après les extensions - MySQL ou - imap. - Charger l'extension recode avant ces deux extensions corrige - le problème. Ceci est dû à un problème technique car la bibliothèque - c-client de IMAP et recode ont toutes les deux leur propre fonction - hash_lookup() et les extensions mysql et recode - ont toutes les deux leur fonction hash_insert. - - - &warn.imaprecodeyaz; -
    -
    - diff --git a/reference/recode/functions/recode-file.xml b/reference/recode/functions/recode-file.xml deleted file mode 100644 index 1bce087043..0000000000 --- a/reference/recode/functions/recode-file.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - recode_file - Recodage de fichier à fichier, en fonction de la demande - - - - &reftitle.description; - - boolrecode_file - stringrequest - resourceinput - resourceoutput - - - Recode le fichier identifié par input - dans le fichier identifié par output - en fonction de la requête de recodage request. - - - - - &reftitle.parameters; - - - request - - - Le type de requête recode désiré - - - - - input - - - Un gestionnaire de fichier local pour le paramètre - input - - - - - output - - - Un gestionnaire de fichier local pour le paramètre - output - - - - - - - - &reftitle.returnvalues; - - Retourne &false;, en cas d'échec, et &true; sinon. - - - - - &reftitle.examples; - - Exemple avec <function>recode_file</function> - - -]]> - - - - - - &reftitle.notes; - - Cette fonction ne gère pas encore les fichiers - distants (URL). Les deux fichiers doivent faire référence - à des fichiers locaux. - - - - - &reftitle.seealso; - - fopen - - - - - diff --git a/reference/recode/functions/recode-string.xml b/reference/recode/functions/recode-string.xml deleted file mode 100644 index d3be005b4f..0000000000 --- a/reference/recode/functions/recode-string.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - recode_string - Recode une chaîne en fonction de la requête - - - - &reftitle.description; - - stringrecode_string - stringrequest - stringstring - - - Recode la chaîne string en fonction - de la requête request. - - - - - &reftitle.parameters; - - - request - - - Le type de requête recode désiré - - - - - string - - - La &string; à recoder - - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne recodée en cas de succès et &false; sinon. - - - - - &reftitle.examples; - - Exemple avec <function>recode_string</function> - - - -]]> - - - - - - &reftitle.notes; - - Une requête simple de recodage peut être "lat1..iso646-de". - - - - - &reftitle.seealso; - - - Se reporter à la documentation GNU Recode de l'installation - pour plus de détails sur les requêtes. - - mb_convert_encoding - UConverter::transcode - iconv - - - - - diff --git a/reference/recode/functions/recode.xml b/reference/recode/functions/recode.xml deleted file mode 100644 index f3e9d98343..0000000000 --- a/reference/recode/functions/recode.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - recode - &Alias; recode_string - - - - &reftitle.description; - - &info.function.alias; - recode_string. - - - - - diff --git a/reference/recode/reference.xml b/reference/recode/reference.xml deleted file mode 100644 index e6911d0e90..0000000000 --- a/reference/recode/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - &Functions; Recode - - &reference.recode.entities.functions; - - - - diff --git a/reference/recode/setup.xml b/reference/recode/setup.xml deleted file mode 100644 index 2dcf1826a3..0000000000 --- a/reference/recode/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Il faut avoir GNU Recode 3.5 ou supérieur installé sur le système. - Il est possible de télécharger le paquet depuis - &url.recode;. - - - - La version 3.6 de la bibliothèque Recode ajoute des caractères étranges - à la suite des chaînes converties sous certaines circonstances. Aussi, - il est préférable d'utiliser Recode v3.5 ou une bibliothèque alternative - disponible, comme l'extension - iconv ou l'extension - mbstring. - - -
    - - - - &reference.recode.configure; - - -     - diff --git a/reference/rnp/book.xml b/reference/rnp/book.xml deleted file mode 100644 index 2011ceabb3..0000000000 --- a/reference/rnp/book.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - Rnp - Rnp - - - &reftitle.intro; - &warn.experimental; - - Ce module permet d'utiliser la bibliothèque RNP. - RNP est une bibliothèque OpenPGP C++ haute - performance utilisée par Mozilla Thunderbird. - - - - &reference.rnp.setup; - &reference.rnp.constants; - &reference.rnp.examples; - &reference.rnp.reference; - - &reference.rnp.rnpffi; - - - diff --git a/reference/rnp/configure.xml b/reference/rnp/configure.xml deleted file mode 100644 index 6c6a716031..0000000000 --- a/reference/rnp/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;rnp - - -
    - diff --git a/reference/rnp/constants.xml b/reference/rnp/constants.xml deleted file mode 100644 index b488d735a5..0000000000 --- a/reference/rnp/constants.xml +++ /dev/null @@ -1,363 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - RNP_KEYSTORE_GPG - (string) - - - - Format du trousseau "GPG". - - - - - - RNP_KEYSTORE_KBX - (string) - - - - Format du trousseau "KBX". Pour les clés publiques uniquement. - Une boîte à clés (keybox) est un format de fichier utilisé pour stocker des clés publiques avec des métadonnées et des indices. - - - - - - RNP_KEYSTORE_G10 - (string) - - - - Format du trousseau "G10". Pour les clés privées. - - - - - - RNP_LOAD_SAVE_PUBLIC_KEYS - (integer) - - - - Charge ou sauvegarde uniquement les clés publiques. Peut être combiné avec RNP_LOAD_SAVE_SECRET_KEYS - pour charger à la fois les clés publiques et privées dans le contexte FFI ou les sauvegarder du contexte. - - - - - - RNP_LOAD_SAVE_SECRET_KEYS - (integer) - - - - Charge ou sauvegarde uniquement les clés secrètes. Peut être combiné avec RNP_LOAD_SAVE_PUBLIC_KEYS - pour charger à la fois les clés publiques et privées dans le contexte FFI ou les sauvegarder du contexte. - - - - - - RNP_LOAD_SAVE_PERMISSIVE - (integer) - - - - Permet d'ignorer les paquets de signature/clé/sous-clé incorrects lors de l'importation de clés. - - - - - - RNP_LOAD_SAVE_SINGLE - (integer) - - - - Si défini, seule la première clé sera chargée. - - - - - - RNP_LOAD_SAVE_BASE64 - (integer) - - - - Permet l'importation de clés codées en base64 (clés autocrypt). - - - - - - RNP_FEATURE_SYMM_ALG - (string) - - - - Liste les algorithmes de chiffrement symétrique disponibles. - - - - - - RNP_FEATURE_AEAD_ALG - (string) - - - - Liste les algorithmes AEAD disponibles. - - - - - - RNP_FEATURE_PROT_MODE - (string) - - - - Liste les modes de protection disponibles. - - - - - - RNP_FEATURE_PK_ALG - (string) - - - - Liste les algorithmes de clé publique disponibles. - - - - - - RNP_FEATURE_HASH_ALG - (string) - - - - Liste les algorithmes de hachage disponibles. - - - - - - RNP_FEATURE_COMP_ALG - (string) - - - - Liste les algorithmes de compression disponibles. - - - - - - RNP_FEATURE_CURVE - (string) - - - - Liste les courbes elliptiques disponibles. - - - - - - RNP_DUMP_MPI - (integer) - - - - Affiche les valeurs MPI (entiers multi-précision). - - - - - - RNP_DUMP_RAW - (integer) - - - - Affiche également le contenu brut du paquet. - - - - - - RNP_DUMP_GRIP - (integer) - - - - Affiche les empreintes et les identifiants de clé. - - - - - - RNP_JSON_DUMP_MPI - (integer) - - - - Affiche les valeurs MPI (entiers multi-précision). - - - - - - RNP_JSON_DUMP_RAW - (integer) - - - - Affiche également le contenu brut du paquet. - - - - - - RNP_JSON_DUMP_GRIP - (integer) - - - - Affiche les empreintes et les identifiants de clé. - - - - - - RNP_ENCRYPT_NOWRAP - (integer) - - - - Permet le chiffrement du message signé. Le message n'est pas enveloppé - dans un paquet de données littérales. - - - - - - RNP_KEY_EXPORT_ARMORED - (integer) - - - - Active l'armure ASCII des données exportées. - - - - - - RNP_KEY_EXPORT_PUBLIC - (integer) - - - - Exporte la clé publique. - - - - - - RNP_KEY_EXPORT_SECRET - (integer) - - - - Exporte la clé secrète. - - - - - - RNP_KEY_EXPORT_SUBKEYS - (integer) - - - - Si la clé principale est exportée, toutes les sous-clés le seront également. - - - - - - RNP_KEY_EXPORT_BASE64 - (integer) - - - - Exporte la clé autocrypt codée en base64 au lieu de binaire. - - - - - - RNP_KEY_REMOVE_PUBLIC - (integer) - - - - Supprime la clé publique. - - - - - - RNP_KEY_REMOVE_SECRET - (integer) - - - - Supprime la clé secrète. - - - - - - RNP_KEY_REMOVE_SUBKEYS - (integer) - - - - Si la clé principale est supprimée, toutes les sous-clés le seront également. - - - - - - diff --git a/reference/rnp/examples.xml b/reference/rnp/examples.xml deleted file mode 100644 index bae73e4704..0000000000 --- a/reference/rnp/examples.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - &reftitle.examples; -
    - Texte signé en clair - - Cet exemple va signer en clair un texte donné. - - - Exemple RNP signature en clair - - -]]> - - -
    -     - diff --git a/reference/rnp/functions/rnp-backend-string.xml b/reference/rnp/functions/rnp-backend-string.xml deleted file mode 100644 index a29e162006..0000000000 --- a/reference/rnp/functions/rnp-backend-string.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - rnp_backend_string - Renvoie le nom de la bibliothèque back-end de cryptographie - - - - &reftitle.description; - - stringrnp_backend_string - - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom de la bibliothèque back-end de cryptographie. Les bibliothèques de cryptographie - supportées sont "Botan" et "OpenSSL". - - - - - - diff --git a/reference/rnp/functions/rnp-backend-version.xml b/reference/rnp/functions/rnp-backend-version.xml deleted file mode 100644 index 7a8622aa66..0000000000 --- a/reference/rnp/functions/rnp-backend-version.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - rnp_backend_version - Renvoie la version de la bibliothèque back-end de cryptographie - - - - &reftitle.description; - - stringrnp_backend_version - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La version sous forme de chaîne. - - - - - - diff --git a/reference/rnp/functions/rnp-decrypt.xml b/reference/rnp/functions/rnp-decrypt.xml deleted file mode 100644 index 6c830e61d9..0000000000 --- a/reference/rnp/functions/rnp-decrypt.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - rnp_decrypt - Déchiffre un message PGP - - - - &reftitle.description; - - stringfalsernp_decrypt - RnpFFIffi - stringinput - - - Les clés privées utilisées pour le déchiffrement doivent être chargées dans l'objet FFI avant d'appeler cette fonction. - Si le chiffrement par mot de passe a été utilisé, le fournisseur de mot de passe doit être défini en appelant - rnp_ffi_set_pass_provider. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - input - - - Le message chiffré. - - - - - - - - &reftitle.returnvalues; - - Le message déchiffré en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-dump-packets-to-json.xml b/reference/rnp/functions/rnp-dump-packets-to-json.xml deleted file mode 100644 index d1daa8e374..0000000000 --- a/reference/rnp/functions/rnp-dump-packets-to-json.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - rnp_dump_packets_to_json - Affiche les informations du flux de paquets OpenPGP dans une chaîne JSON - - - - &reftitle.description; - - stringfalsernp_dump_packets_to_json - stringinput - intflags - - - - - - - - - &reftitle.parameters; - - - input - - - La chaîne d'entrée contenant les données OpenPGP, soit au format binaire, soit au format ASCII-armored. - - - - - flags - - - Voir les constantes prédéfinies RNP_JSON_DUMP_*. - - - - - - - - &reftitle.returnvalues; - - Une chaîne JSON avec les informations&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-dump-packets.xml b/reference/rnp/functions/rnp-dump-packets.xml deleted file mode 100644 index d02d2ca3b5..0000000000 --- a/reference/rnp/functions/rnp-dump-packets.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - rnp_dump_packets - Affiche les informations du flux de paquets OpenPGP dans un format lisible par l'homme - - - - &reftitle.description; - - stringfalsernp_dump_packets - stringinput - intflags - - - - - - - - - &reftitle.parameters; - - - input - - - La chaîne d'entrée contenant les données OpenPGP, soit au format binaire, soit au format ASCII-armored. - - - - - flags - - - Voir les constantes prédéfinies RNP_DUMP_*. - - - - - - - - &reftitle.returnvalues; - - Un texte décrivant la séquence de paquets&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-ffi-create.xml b/reference/rnp/functions/rnp-ffi-create.xml deleted file mode 100644 index 8e8bb24f5f..0000000000 --- a/reference/rnp/functions/rnp-ffi-create.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - rnp_ffi_create - Créer un objet de niveau supérieur utilisé pour interagir avec la bibliothèque - - - - &reftitle.description; - - RnpFFIfalsernp_ffi_create - stringpub_format - stringsec_format - - - - - - - - - - &reftitle.parameters; - - - pub_format - - - Le format du trousseau de clés public, RNP_KEYSTORE_GPG ou - autre constante RNP_KEYSTORE_*. - - - - - sec_format - - - Le format du trousseau de clés secrètes, RNP_KEYSTORE_GPG ou - autre constante RNP_KEYSTORE_*. - - - - - - - - &reftitle.returnvalues; - - Renvoie un objet RnpFFI en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-ffi-destroy.xml b/reference/rnp/functions/rnp-ffi-destroy.xml deleted file mode 100644 index 7d4d9ea2d1..0000000000 --- a/reference/rnp/functions/rnp-ffi-destroy.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - rnp_ffi_destroy - Détruit l'objet de niveau supérieur utilisé pour interagir avec la bibliothèque - - - - &reftitle.description; - - voidrnp_ffi_destroy - RnpFFIffi - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/rnp/functions/rnp-ffi-set-pass-provider.xml b/reference/rnp/functions/rnp-ffi-set-pass-provider.xml deleted file mode 100644 index 3281491879..0000000000 --- a/reference/rnp/functions/rnp-ffi-set-pass-provider.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - rnp_ffi_set_pass_provider - Définit la fonction de rappel du fournisseur de mot de passe - - - - &reftitle.description; - - boolrnp_ffi_set_pass_provider - RnpFFIffi - callablepassword_callback - - - Définit la fonction de rappel du fournisseur de mot de passe. Cette fonction peut demander le mot de passe sur une entrée standard - (si le script PHP est exécuté dans un environnement de ligne de commande), afficher une boîte de dialogue GUI ou fournir - le mot de passe de toutes les manières possibles. Les mots de passe demandés sont utilisés pour chiffrer ou déchiffrer - les clés secrètes ou effectuer des opérations de chiffrement/déchiffrement symétriques. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - password_callback - - - La fonction qui doit être appelée pour chaque demande de mot de passe. Elle a la signature suivante: - - boolpassword_callback - stringkey_fp - stringpgp_context - stringpassword - - - $key_fp - L'empreinte de la clé, le cas échéant. Peut être vide. - $pgp_context - Chaîne décrivant pourquoi la clé est demandée. - $password - Référence de chaîne où le mot de passe fourni doit être stocké. - - La fonction de rappel doit retourner &true; si le mot de passe a été défini avec succès&return.falseforfailure;. - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exemple d'une fonction de rappel simple - - - - - - - - diff --git a/reference/rnp/functions/rnp-import-keys.xml b/reference/rnp/functions/rnp-import-keys.xml deleted file mode 100644 index 981eed0f8d..0000000000 --- a/reference/rnp/functions/rnp-import-keys.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - rnp_import_keys - Importe des clés depuis une chaîne PHP vers le trousseau de clés et renvoie un JSON décrivant les clés nouvelles ou mises à jour - - - - &reftitle.description; - - stringfalsernp_import_keys - RnpFFIffi - stringinput - intflags - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - input - - - Les paquets OpenPGP contenant la ou les clés à charger. Peut être binaire ou ASCII armored. - - - - - flags - - - Voir les constantes prédéfinies RNP_LOAD_SAVE_*. - - - - - - - - &reftitle.returnvalues; - - Une chaîne JSON avec les informations sur les clés nouvelles et mises à jour en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-import-signatures.xml b/reference/rnp/functions/rnp-import-signatures.xml deleted file mode 100644 index ddaa3efb30..0000000000 --- a/reference/rnp/functions/rnp-import-signatures.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - rnp_import_signatures - Importe des signatures autonomes dans le trousseau de clés et renvoie un JSON décrivant les clés mises à jour - - - - &reftitle.description; - - stringfalsernp_import_signatures - RnpFFIffi - stringinput - intflags - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - input - - - Les paquets OpenPGP contenant les signatures à importer. Peut être binaire ou ASCII armé. - - - - - flags - - - Actuellement doit être 0. - - - - - - - - &reftitle.returnvalues; - - La chaîne JSON avec des informations sur les clés mises à jour en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-key-export-autocrypt.xml b/reference/rnp/functions/rnp-key-export-autocrypt.xml deleted file mode 100644 index ca3d9d83f2..0000000000 --- a/reference/rnp/functions/rnp-key-export-autocrypt.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - rnp_key_export_autocrypt - - Exporte la clé minimale pour la fonctionnalité autocrypt (juste 5 paquets: clé, uid, signature, - sous-clé de chiffrement, signature) - - - - - &reftitle.description; - - stringfalsernp_key_export_autocrypt - RnpFFIffi - stringkey_fp - stringsubkey_fp - stringuid - intflags - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - L'empreinte de la clé primaire. - - - - - subkey_fp - - - La sous-clé à exporter. Peut être une chaîne vide - pour choisir la première sous-clé appropriée. - - - - - uid - - - L'identifiant de l'utilisateur à exporter. Peut être une chaîne vide - si la clé exportée n'a qu'un seul identifiant. - - - - - flags - - - Seulement RNP_KEY_EXPORT_BASE64 est actuellement supporté. L'activer - exportera les données de clé encodées en base64 au lieu de binaire. - - - - - - - - &reftitle.returnvalues; - - Les paquets OpenPGP de la clé exportée en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-key-export-revocation.xml b/reference/rnp/functions/rnp-key-export-revocation.xml deleted file mode 100644 index 2127564e0b..0000000000 --- a/reference/rnp/functions/rnp-key-export-revocation.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - rnp_key_export_revocation - Génère et exporte une signature de révocation de clé primaire - - - - &reftitle.description; - - stringfalsernp_key_export_revocation - RnpFFIffi - stringkey_fp - intflags - arrayoptions - - - Notes: pour révoquer une clé, il faudra importer cette signature dans le trousseau de clés ou utiliser - la fonction rnp_key_revoke. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - L'empreinte de la clé primaire à révoquer. - - - - - flags - - - RNP_KEY_EXPORT_ARMORED ou 0. - - - - - options - - - Un tableau associatif avec des options. - - - - - - Key - Type de donnée - &Description; - - - - - "hash" - string - Définit l'algorithme de hachage utilisé lors du calcul de la signature. - - - "code" - string - Code de raison de la révocation. Valeurs possibles : 'no', 'superseded', 'compromised', - 'retired'. Si non défini, la valeur 'no' sera utilisée par défaut. - - - "reason" - string - Représentation textuelle de la raison de la révocation. - - - - - - - - - - - &reftitle.returnvalues; - - Révocation exportée en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-key-export.xml b/reference/rnp/functions/rnp-key-export.xml deleted file mode 100644 index d65082b7dd..0000000000 --- a/reference/rnp/functions/rnp-key-export.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - rnp_key_export - Exporte une clé - - - - &reftitle.description; - - stringfalsernp_key_export - RnpFFIffi - stringkey_fp - intflags - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - L'empreinte de la clé. - - - - - flags - - - Voir RNP_KEY_EXPORT_* constantes prédéfinies - (sauf RNP_KEY_EXPORT_BASE64). - - - - - - - - &reftitle.returnvalues; - - Le paquet OpenPGP exporté de la clé (binaire ou ASCII-armored) en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-key-get-info.xml b/reference/rnp/functions/rnp-key-get-info.xml deleted file mode 100644 index ab0dcc8c14..0000000000 --- a/reference/rnp/functions/rnp-key-get-info.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - - - - rnp_key_get_info - Renvoie des informations sur la clé - - - - &reftitle.description; - - arrayfalsernp_key_get_info - RnpFFIffi - stringkey_fp - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - L'empreinte de la clé. - - - - - - - - &reftitle.returnvalues; - - Un tableau associatif avec des informations sur la clé&return.falseforfailure;. - - - - - - Key - Type de données - &Description; - - - - - "is_primary" - boolean - - &true; si cette clé est la clé primaire. - - - - "is_sub" - boolean - - &true; si cette clé est une sous-clé. - - - - "is_valid" - boolean - - &true; si la clé publique est valide. - Cela inclut les vérifications des auto-signatures, - les dates d'expiration, les révocations, etc. - - - - "is_revoked" - boolean - - &true; si cette clé est révoquée. - - - - "is_superseded" - boolean - - &true; si cette clé est obsolète. Présent uniquement si la clé est révoquée. - - - - "is_compromised" - boolean - - &true; si cette clé est compromise. Présent uniquement si la clé est révoquée. - - - - "is_retired" - boolean - - &true; si cette clé est retirée. Présent uniquement si la clé est révoquée. - - - - "is_expired" - boolean - - &true; si cette clé est expirée. - - - - "have_secret" - boolean - - &true; si cette clé a une partie secrète. - - - - "is_locked" - boolean - - &true; si cette clé est actuellement verrouillée. Présent uniquement pour les clés secrètes. - - - - "is_protected" - boolean - - &true; si cette clé est protégée. Présent uniquement pour les clés secrètes. - Une clé protégée est une clé qui est chiffrée et peut être stockée en toute sécurité en mémoire - et verrouillée/déverrouillée au besoin. - - - - "have_public" - boolean - - &true; si cette clé a une partie publique. En général, toutes les clés ont une partie publique. - - - - "valid_till" - integer - - Le timestamp jusqu'auquel la clé peut être considérée comme valide. - Note : cela prendra en compte non seulement l'expiration de la clé, mais aussi les révocations. - Pour la sous-clé primaire, le temps de validité de la clé publique sera également vérifié. - - - - "bits" - integer - - Le nombre de bits dans la clé. Pour les clés basées sur EC, cela contiendra la taille de la courbe. - - - - "alg" - string - - L'algorithme de nom de clé. - - - - "subkeys" - array - - Un tableau indexé contenant des informations sur les sous-clés. - Peut être vide si la clé primaire n'a pas de sous-clés. - - - - "uids" - array - - Un tableau indexé contenant des informations sur les identifiants d'utilisateur. - Peut être vide si la clé primaire n'a pas d'identifiants d'utilisateur. - - - - - - - - - - diff --git a/reference/rnp/functions/rnp-key-remove.xml b/reference/rnp/functions/rnp-key-remove.xml deleted file mode 100644 index 4d08a6c62f..0000000000 --- a/reference/rnp/functions/rnp-key-remove.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - rnp_key_remove - Supprime une clé des trousseaux de clés - - - - &reftitle.description; - - boolrnp_key_remove - RnpFFIffi - stringkey_fp - intflags - - - Note: il faut appeler rnp_save_keys pour écrire les trousseaux de clés mis à jour. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - L'empreinte de la clé. - - - - - flags - - - Voir RNP_KEY_REMOVE_* constantes prédéfinies. Le drapeau - RNP_KEY_REMOVE_SUBKEYS ne fonctionnera que pour - la clé principale et supprimera également toutes ses sous-clés. - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-key-revoke.xml b/reference/rnp/functions/rnp-key-revoke.xml deleted file mode 100644 index 63af669e3b..0000000000 --- a/reference/rnp/functions/rnp-key-revoke.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - rnp_key_revoke - Supprime une clé ou une sous-clé en générant et ajoutant une signature de révocation - - - - &reftitle.description; - - boolrnp_key_revoke - RnpFFIffi - stringkey_fp - intflags - arrayoptions - - - Note: il faut appeler rnp_save_keys pour écrire les trousseaux de clés mis à jour. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - L'empreinte de la clé. - - - - - flags - - - Actuellement doit être 0. - - - - - options - - - Un tableau associatif avec des options. - - - - - - Key - Type de donnée - &Description; - - - - - "hash" - string - Définit l'algorithme de hachage utilisé lors du calcul de la signature. - - - "code" - string - Le code de révocation de la clé. Les valeurs possibles sont 'no', 'superseded', 'compromised', 'retired'. - Si non défini, la valeur 'no' sera utilisée par défaut. - - - "reason" - string - Représentation textuelle de la raison de la révocation. - - - - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-list-keys.xml b/reference/rnp/functions/rnp-list-keys.xml deleted file mode 100644 index 36fadcfb4a..0000000000 --- a/reference/rnp/functions/rnp-list-keys.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - rnp_list_keys - Enumère toutes les clés présentes dans un trousseau de clés par type d'identifiant spécifié - - - - &reftitle.description; - - arrayfalsernp_list_keys - RnpFFIffi - stringidentifier_type - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - identifier_type - - - La clé de type d'identifiant ("userid", "keyid", "grip", "fingerprint"). - - - - - - - - &reftitle.returnvalues; - - Un tableau associatif où la clé est une chaîne d'identifiant et la valeur est une empreinte de clé PGP&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-load-keys-from-path.xml b/reference/rnp/functions/rnp-load-keys-from-path.xml deleted file mode 100644 index aea4f31182..0000000000 --- a/reference/rnp/functions/rnp-load-keys-from-path.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - rnp_load_keys_from_path - Charge des clés à partir du chemin spécifié - - - - &reftitle.description; - - boolrnp_load_keys_from_path - RnpFFIffi - stringformat - stringinput_path - intflags - - - Il est à noter que pour G10, l'entrée doit être un répertoire (qui doit déjà exister). - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - format - - - &rnp.parameter.key-format; - - - - - input_path - - - le fichier ou le répertoire contenant les clés. - - - - - flags - - - &rnp.parameter.loadsave-flags; - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-load-keys.xml b/reference/rnp/functions/rnp-load-keys.xml deleted file mode 100644 index 514a68b994..0000000000 --- a/reference/rnp/functions/rnp-load-keys.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - rnp_load_keys - Charge les clés à partir d'une chaîne PHP - - - - &reftitle.description; - - boolrnp_load_keys - RnpFFIffi - stringformat - stringinput - intflags - - - Il est à noter que pour G10, l'entrée doit être un répertoire (qui doit déjà exister). - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - format - - - &rnp.parameter.key-format; - - - - - input - - - Les paquets OpenPGP contenant la ou les clés à charger. Peut être binaire ou ASCII armored. - - - - - flags - - - &rnp.parameter.loadsave-flags; - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-locate-key.xml b/reference/rnp/functions/rnp-locate-key.xml deleted file mode 100644 index ba8ac4af86..0000000000 --- a/reference/rnp/functions/rnp-locate-key.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - rnp_locate_key - Recherche de la clé - - - - &reftitle.description; - - stringfalsernp_locate_key - RnpFFIffi - stringidentifier_type - stringidentifier - - - Note: les identifiants valides sont vérifiés lors de la recherche par identifiant. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - identifier_type - - - Chaîne de type d'identifiant: "userid", "keyid", "fingerprint", "grip". - - - - - identifier - - - L'identifiant de l'utilisateur OpenPGP (nom et email) pour le type "userid", chaîne hexadécimale - qui représente l'identifiant de clé, l'empreinte ou le grip de clé correspondant. - - - - - - - - &reftitle.returnvalues; - - Renvoie l'empreinte hexadécimale de la clé trouvée en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-op-encrypt.xml b/reference/rnp/functions/rnp-op-encrypt.xml deleted file mode 100644 index a4cfc3f7ce..0000000000 --- a/reference/rnp/functions/rnp-op-encrypt.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - rnp_op_encrypt - Chiffre un message - - - - &reftitle.description; - - stringfalsernp_op_encrypt - RnpFFIffi - stringmessage - arrayrecipient_keys_fp - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - message - - - Le message à chiffrer. - - - - - recipient_keys_fp - - - Un tableau avec les empreintes des clés du destinataire. Au moins une clé doit être présente. - - - - - options - - - Un tableau associatif avec des options. - - - - - - Key - Type de donnée - &Description; - - - - - "compression_alg" - string - Algorithme de compression. Les options - "compression_alg" et "compression_level" doivent toutes les deux être définies - pour activer la compression des données. - - - - "compression_level" - integer - Le niveau de compression, de 0 à 9. 0 désactive la compression. - - - "armor" - boolean - Active la sortie ASCII armée. Désactivé par défaut. - - - "add_signature" - boolean - Le message chiffré sera également signé. - - - "hash" - string - Définit l'algorithme de hachage utilisé lors du calcul de la signature. L'option "add_signature" doit être définie à &true;. - - - "creation_time" - integer - Définit l'heure de création de la signature en secondes depuis le 1er janvier 1970 UTC. Par défaut, l'heure actuelle est utilisée. - - - "expiration_time" - integer - Définit le temps d'expiration de la signature en secondes depuis l'heure de création. La valeur 0 est utilisée pour marquer - la signature comme non expirante (valeur par défaut). - - - "password" - string - Ajoute un mot de passe utilisé pour chiffrer les données. - - - "cipher" - string - - Définit l'algorithme de chiffrement symétrique. Les valeurs possibles sont "IDEA", "TRIPLEDES", - "CAST5", "BLOWFISH", "AES128", "AES192", "AES256", "TWOFISH", "CAMELLIA128", - "CAMELLIA192", "CAMELLIA256", "SM4". - - - - "aead" - string - - Définit l'algorithme de mode AEAD. Les valeurs possibles sont "None" pour désactiver AEAD, "EAX", "OCB". - - - - "aead_bits" - integer - Définit la longueur du chunk pour le mode AEAD en nombre de bits de taille de chunk. Doit être compris entre 0 et 56. - - - "flags" - integer - - Définit des indicateurs de chiffrement supplémentaires. Les indicateurs pris en charge sont : RNP_ENCRYPT_NOWRAP - ne pas envelopper - les données dans un paquet de données littérales. Cela permettrait de chiffrer des données déjà signées. - - - - "file_name" - string - Définit le nom de fichier stocké en interne pour les données chiffrées. La valeur spéciale _CONSOLE peut être utilisée pour marquer - le message comme "pour les yeux seulement", c'est-à-dire qu'il ne doit être stocké nulle part mais seulement affiché - au destinataire. Par défaut, c'est une chaîne vide. - - - "file_mtime" - integer - Définit la date de modification du fichier d'entrée en secondes depuis le 1er janvier 1970 UTC. - - - - - - - - - - - &reftitle.returnvalues; - - Les données chiffrées en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-op-generate-key.xml b/reference/rnp/functions/rnp-op-generate-key.xml deleted file mode 100644 index 51612568fc..0000000000 --- a/reference/rnp/functions/rnp-op-generate-key.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - rnp_op_generate_key - Génère une clé - - - - &reftitle.description; - - stringfalsernp_op_generate_key - RnpFFIffi - stringuserid - stringkey_alg - stringsub_alg - arrayoptions - - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - userid - - - L'identifiant de l'utilisateur PGP - texte qui est censé représenter - le nom et l'adresse email du détenteur de la clé. - - - - - key_alg - - - La clé d'algorithme (c'est-à-dire 'RSA', 'DSA', etc). - - - - - sub_alg - - - L'algorithme de sous-clé. Si non défini, la sous-clé ne sera pas générée. - - - - - options - - - Un tableau associatif avec des options. - - - - - - Key - Type de donnée - &Description; - - - - - "bits" - integer - La taille de la clé primaire en bits. Applicable uniquement aux clés RSA, DSA et El-Gamal. - - - "hash" - string - Algorithme de hachage utilisé dans la signature de la clé ou la signature de liaison de sous-clé. - - - "dsa_qbits" - integer - Définit la taille d'un paramètre q pour la clé DSA. - Remarque : une valeur par défaut appropriée sera définie, en fonction du nombre de bits de la clé. Cependant, il est possible de - la remplacer si nécessaire. - - - "curve" - string - Définit la courbe utilisée pour la clé ECC. Remarque : cela s'applique uniquement aux clés ECDSA, ECDH et SM2. - - - "request_password" - boolean - Active la demande de mot de passe via le fournisseur de mot de passe. Ce mot de passe - sera utilisé pour le chiffrement de la clé. La fonction de rappel du fournisseur de mot de passe doit être définie à l'avance en - appelant rnp_ffi_set_pass_provider. - Remarque : ce paramètre sera ignoré si le mot de passe a été défini via "password" - - - "password" - string - Définit le mot de passe utilisé pour chiffrer les données de la clé secrète. - - - "expiration" - integer - Définit le temps d'expiration de la clé primaire et de la sous-clé en secondes. - - - "sub_bits" - integer - La taille de la sous-clé en bits. Applicable uniquement aux clés RSA, DSA et El-Gamal. - - - "sub_hash" - string - Algorithme de hachage utilisé dans la signature de la sous-clé ou la signature de liaison de sous-clé. - - - "sub_curve" - string - Définit la courbe utilisée pour la sous-clé ECC. Remarque : cela s'applique uniquement aux clés ECDSA, ECDH et SM2. - - - - - - - - - - - &reftitle.returnvalues; - - L'empreinte de la clé primaire générée&return.falseforfailure;. Cette empreinte peut être utilisée - plus tard pour référencer la clé dans les opérations de signature et de chiffrement. Les données de la clé sont stockées dans le contexte de mémoire - FFI et peuvent être sauvegardées en utilisant - rnp_save_keys ou rnp_save_keys_to_path. - - - - - - diff --git a/reference/rnp/functions/rnp-op-sign-cleartext.xml b/reference/rnp/functions/rnp-op-sign-cleartext.xml deleted file mode 100644 index 0c5d5880d8..0000000000 --- a/reference/rnp/functions/rnp-op-sign-cleartext.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - rnp_op_sign_cleartext - Effectue une opération de signature sur des données textuelles, renvoie le message signé en clair - - - - &reftitle.description; - - stringfalsernp_op_sign_cleartext - RnpFFIffi - stringdata - arraykeys_fp - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - La donnée à signer. - - - - - keys_fp - - - Le tableau avec les empreintes des clés. Au moins une clé doit être fournie. - Les clés doivent être présentes dans ffi. - - - - - options - - - Un tableau associatif avec des options. - - - - - - Key - Type de donnée - &Description; - - - - - "armor" - boolean - Active la sortie ASCII armée. Désactivé par défaut. - - - "hash" - string - Définit l'algorithme de hachage utilisé lors du calcul de la signature. - - - "creation_time" - integer - Définit l'heure de création de la signature en secondes depuis le 1er janvier 1970 UTC. Par défaut, l'heure actuelle est utilisée. - - - "expiration_time" - integer - Définit le temps d'expiration de la signature en secondes depuis l'heure de création. La valeur 0 est utilisée pour marquer - la signature comme non expirée (valeur par défaut). - - - - - - - - - - - &reftitle.returnvalues; - - Le message signé en clair contenant les données source avec - des en-têtes supplémentaires et la signature ASCII-armored en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-op-sign-detached.xml b/reference/rnp/functions/rnp-op-sign-detached.xml deleted file mode 100644 index 1281ddad2a..0000000000 --- a/reference/rnp/functions/rnp-op-sign-detached.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - rnp_op_sign_detached - Effectue une opération de signature, renvoie la signature détachée - - - - &reftitle.description; - - stringfalsernp_op_sign_detached - RnpFFIffi - stringdata - arraykeys_fp - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - La donnée à signer. - - - - - keys_fp - - - Un tableau avec les empreintes des clés. Au moins une clé doit être fournie. - Les clés doivent être présentes dans ffi. - - - - - options - - - Un tableau associatif avec des options. - - - - - - Key - Type de donnée - &Description; - - - - - "armor" - boolean - Active la sortie ASCII-armored. Désactivé par défaut. - - - "hash" - string - Définit l'algorithme de hachage utilisé lors du calcul de la signature. - - - "creation_time" - integer - Définit l'heure de création de la signature en secondes depuis le 1er janvier 1970 UTC. Par défaut, l'heure actuelle est utilisée. - - - "expiration_time" - integer - Définit le temps d'expiration de la signature en secondes depuis l'heure de création. La valeur 0 est utilisée - pour marquer la signature comme non expirée (valeur par défaut). - - - - - - - - - - - &reftitle.returnvalues; - - Les données de signature détachées en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-op-sign.xml b/reference/rnp/functions/rnp-op-sign.xml deleted file mode 100644 index f3961bf26e..0000000000 --- a/reference/rnp/functions/rnp-op-sign.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - rnp_op_sign - Effectue une opération de signature sur des données binaires, renvoie la ou les signatures intégrées - - - - &reftitle.description; - - stringfalsernp_op_sign - RnpFFIffi - stringdata - arraykeys_fp - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Les données à signer. - - - - - keys_fp - - - Un tableau avec les empreintes des clés. Au moins une clé doit être fournie. - Les clés doivent être présentes dans ffi. - - - - - options - - - Un tableau associatif avec des options. - - - - - - Key - Type de donnée - &Description; - - - - - "compression_alg" - string - Algorithme de compression. Les options - "compression_alg" et "compression_level" - doivent toutes les deux être définies pour activer la compression des données. - - - - "compression_level" - integer - Niveau de compression, 0-9. 0 désactive la compression. - - - "armor" - boolean - Active la sortie ASCII armée. Désactivé par défaut. - - - "hash" - string - Définit l'algorithme de hachage utilisé lors du calcul de la signature. - - - "creation_time" - integer - Définit l'heure de création de la signature en secondes depuis le 1er janvier 1970 UTC. Par défaut, l'heure actuelle est utilisée. - - - "expiration_time" - integer - Définit le temps d'expiration de la signature en secondes depuis l'heure de création. La valeur 0 est utilisée - pour marquer la signature comme non expirante (valeur par défaut). - - - "file_name" - string - Définit le nom du fichier d'entrée. La valeur spéciale _CONSOLE peut être utilisée pour marquer le message - comme 'pour les yeux seulement', c'est-à-dire qu'il ne doit pas être stocké n'importe où mais seulement affiché - au destinataire. Par défaut, c'est une chaîne vide. - - - "file_mtime" - integer - Définit la date de modification du fichier d'entrée en secondes depuis le 1er janvier 1970 UTC. - - - - - - - - - - - &reftitle.returnvalues; - - Les données signées avec la ou les signatures intégrées en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-op-verify-detached.xml b/reference/rnp/functions/rnp-op-verify-detached.xml deleted file mode 100644 index 98424541d6..0000000000 --- a/reference/rnp/functions/rnp-op-verify-detached.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - rnp_op_verify_detached - Vérifie les signatures détachées - - - - &reftitle.description; - - arrayfalsernp_op_verify_detached - RnpFFIffi - stringdata - stringsignature - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Les données source. - - - - - signature - - - Les données de signature détachée. - - - - - - - - &reftitle.returnvalues; - - Un tableau associatif avec des informations sur les résultats de la vérification&return.falseforfailure;. - - - - - - Key - Type de donnée - &Description; - - - - - "verification_status" - string - - Les résultats de la vérification globale, soit la chaîne "Success" soit un message d'erreur approprié. - Le résultat "Success" est défini lorsqu'au moins une signature est valide et vérifiée avec succès. - Les résultats de vérification individuels pour chaque signature peuvent être vérifiés dans le tableau "signatures". - - - - "file_name" - string - Nom du fichier. - - - "file_mtime" - integer - Heure de modification du fichier. - - - "mode" - string - Mode de protection des données (chiffrement) utilisé dans le message traité. - Les valeurs actuellement définies sont "none", "cfb", "cfb-mdc", "aead-ocb", "aead-eax". - - - - "cipher" - string - Algorithme de chiffrement symétrique utilisé pour le chiffrement des données. - - - "valid_integrity" - boolean - &true; si la protection de l'intégrité du message a été utilisée (c'est-à-dire MDC ou AEAD) et qu'elle a été - validée avec succès. - - - - "signatures" - array - - Un tableau associatif décrivant chaque signature trouvée. Voir la description ci-dessous. - - - - - - - Un sous-tableau "signatures". - - - - - - Key - Type de donnée - &Description; - - - - - "verification_status" - string - Statut de vérification de la signature, soit la chaîne "Success" soit un message d'erreur approprié. - - - "creation_time" - integer - Heure de création de la signature en secondes depuis le 1er janvier 1970 UTC. - - - "expiration_time" - integer - Temps d'expiration de la signature en secondes depuis l'heure de création ou 0 si la signature n'expire jamais. - - - "hash" - string - Algorithme de hachage utilisé pour calculer la signature. - - - "signing_key" - string - L'empreinte de la clé utilisée pour signer. Peut être "Not found" si la clé publique correspondante n'est pas chargée dans l'objet FFI. - - - "signature_type" - string - - Le type de signature. Les valeurs actuellement définies sont "binary", "text", "standalone", "certification (generic)", "certification (persona)", - "certification (casual)", "certification (positive)", "subkey binding", "primary key binding", "direct", "key revocation", - "subkey revocation", "certification revocation", "timestamp", "uknown: 0..255". - - - - - - - - - - diff --git a/reference/rnp/functions/rnp-op-verify.xml b/reference/rnp/functions/rnp-op-verify.xml deleted file mode 100644 index 218ea27960..0000000000 --- a/reference/rnp/functions/rnp-op-verify.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - rnp_op_verify - Vérifie les signatures intégrées ou en clair - - - - &reftitle.description; - - arrayfalsernp_op_verify - RnpFFIffi - stringdata - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Les données signées. - - - - - - - - &reftitle.returnvalues; - - Un tableau associatif avec des informations sur les résultats de la vérification&return.falseforfailure;. - - - - - - Key - Type de donnée - &Description; - - - - - "verification_status" - string - - Résultats de la vérification globale, soit la chaîne "Success" soit un message d'erreur approprié. - Le résultat "Success" est défini lorsqu'au moins une signature est valide et vérifiée avec succès. - Le résultat de la vérification individuelle pour chaque signature peut être vérifié dans le tableau "signatures". - - - - "file_name" - string - Le nom du fichier. - - - "file_mtime" - integer - Heure de modification du fichier. - - - "mode" - string - Mode de protection des données (chiffrement) utilisé dans le message traité. - Les valeurs actuellement définies sont "none", "cfb", "cfb-mdc", "aead-ocb", "aead-eax". - - - - "cipher" - string - Chiffrement symétrique utilisé pour le chiffrement des données. - - - "valid_integrity" - boolean - &true; si la protection de l'intégrité du message a été utilisée (c'est-à-dire MDC ou AEAD) et qu'elle a été - validée avec succès. - - - - "signatures" - array - - Un tableau associatif décrivant chaque signature trouvée. Voir la description ci-dessous. - - - - - - - Le sous-tableau "signatures". - - - - - - Key - Type de donnée - &Description; - - - - - "verification_status" - string - Statut de vérification de la signature, soit la chaîne "Success" soit un message d'erreur approprié. - - - "creation_time" - integer - Heure de création de la signature en secondes depuis le 1er janvier 1970 UTC. - - - "expiration_time" - integer - Le temps d'expiration de la signature en secondes depuis le temps de création ou 0 si la signature n'expire jamais. - - - "hash" - string - Algorithme de hachage utilisé pour calculer la signature. - - - "signing_key" - string - L'empreinte de la clé utilisée pour signer. Peut être "Not found" si la clé publique correspondante n'est pas chargée dans l'objet FFI. - - - "signature_type" - string - - Le type de signature. Les valeurs actuellement définies sont "binary", "text", "standalone", "certification (generic)", "certification (persona)", - "certification (casual)", "certification (positive)", "subkey binding", "primary key binding", "direct", "key revocation", - "subkey revocation", "certification revocation", "timestamp", "uknown: 0..255". - - - - - - - - - - diff --git a/reference/rnp/functions/rnp-save-keys-to-path.xml b/reference/rnp/functions/rnp-save-keys-to-path.xml deleted file mode 100644 index 2527c20a46..0000000000 --- a/reference/rnp/functions/rnp-save-keys-to-path.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - rnp_save_keys_to_path - Sauvegarde les clés dans le chemin spécifié - - - - &reftitle.description; - - boolrnp_save_keys_to_path - RnpFFIffi - stringformat - stringoutput_path - intflags - - - Sauvegarde les clés présentes dans l'objet FFI (chargées ou générées) dans le fichier ou le répertoire spécifié. - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - format - - - &rnp.parameter.key-format; - - - - - output_path - - - Le chemin du fichier ou du répertoire où les clés doivent être sauvegardées. - - - - - flags - - - &rnp.parameter.loadsave-flags; - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-save-keys.xml b/reference/rnp/functions/rnp-save-keys.xml deleted file mode 100644 index 461ad8616c..0000000000 --- a/reference/rnp/functions/rnp-save-keys.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - rnp_save_keys - Sauvegarde les clés dans une chaîne PHP - - - - &reftitle.description; - - boolrnp_save_keys - RnpFFIffi - stringformat - stringoutput - intflags - - - Il est à noter que pour G10, la sortie doit être un répertoire (qui doit déjà exister). - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - format - - - &rnp.parameter.key-format; - - - - - output - - - Les paquets de clés seront sauvegardés dans la chaîne référencée par output. - - - - - flags - - - &rnp.parameter.loadsave-flags; - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-supported-features.xml b/reference/rnp/functions/rnp-supported-features.xml deleted file mode 100644 index d612c0a8a2..0000000000 --- a/reference/rnp/functions/rnp-supported-features.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - rnp_supported_features - Renvoie les fonctionnalités supportées au format JSON - - - - &reftitle.description; - - stringfalsernp_supported_features - stringtype - - - Renvoie le format JSON contenant un tableau des valeurs de fonctionnalités rnp supportées (algorithmes, courbes, etc) par type. - - - - - - &reftitle.parameters; - - - type - - - Voir les constantes RNP_FEATURE_* pour les valeurs supportées. - - - - - - - - &reftitle.returnvalues; - - Une chaîne de caractères contenant un tableau formaté en JSON des algorithmes, courbes, etc supportés&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-version-string-full.xml b/reference/rnp/functions/rnp-version-string-full.xml deleted file mode 100644 index fdca78abce..0000000000 --- a/reference/rnp/functions/rnp-version-string-full.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - rnp_version_string_full - La chaîne de version complète de la bibliothèque RNP - - - - &reftitle.description; - - stringrnp_version_string_full - - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la chaîne de version complète de la bibliothèque RNP. - - - - - - diff --git a/reference/rnp/functions/rnp-version-string.xml b/reference/rnp/functions/rnp-version-string.xml deleted file mode 100644 index 27c65ab6ad..0000000000 --- a/reference/rnp/functions/rnp-version-string.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - rnp_version_string - La version de la bibliothèque RNP - - - - &reftitle.description; - - stringrnp_version_string - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la chaîne de version de la bibliothèque RNP. - - - - - - diff --git a/reference/rnp/reference.xml b/reference/rnp/reference.xml deleted file mode 100644 index a10d038277..0000000000 --- a/reference/rnp/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &Functions; de Rnp - - &reference.rnp.entities.functions; - - - diff --git a/reference/rnp/rnpffi.xml b/reference/rnp/rnpffi.xml deleted file mode 100644 index 0e63454129..0000000000 --- a/reference/rnp/rnpffi.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - La classe RnpFFI - RnpFFI - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - RnpFFI - - - - - RnpFFI - - - - - - - -
    - -     - -     - diff --git a/reference/rnp/setup.xml b/reference/rnp/setup.xml deleted file mode 100644 index 7cc4e3bf64..0000000000 --- a/reference/rnp/setup.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Pour utiliser les fonctions de la bibliothèque RNP, il faut installer la - bibliothèque RNP. La version de la - bibliothèque RNP doit être >= 0.16.2. - -
    - - &reference.rnp.configure; - -     - diff --git a/reference/rpminfo/book.xml b/reference/rpminfo/book.xml deleted file mode 100644 index f191b6c386..0000000000 --- a/reference/rpminfo/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - RpmInfo - RpmInfo - - - &reftitle.intro; - - Cette extension permet de récupérer des informations à partir de fichiers RPM - ou de la base de données des RPM installés. - - - Elle fournit également une enveloppe de flux rpm pour récupérer le contenu des RPM - (depuis la version 1.0.0 avec librpm >= 4.13). - - - - &reference.rpminfo.setup; - &reference.rpminfo.constants; - &reference.rpminfo.reference; - - - - diff --git a/reference/rpminfo/constants.xml b/reference/rpminfo/constants.xml deleted file mode 100644 index 5dd108a09e..0000000000 --- a/reference/rpminfo/constants.xml +++ /dev/null @@ -1,2938 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - Miscellaneous constants - - - RPMVERSION - (string) - - - - La version de la bibliothèque RPM. - - - - - - - RPM Senses - - - RPMSENSE_ANY - (int) - - - - - - - - - RPMSENSE_LESS - (int) - - - - - - - - - RPMSENSE_GREATER - (int) - - - - - - - - - RPMSENSE_EQUAL - (int) - - - - - - - - - RPMSENSE_POSTTRANS - (int) - - - - - - - - - RPMSENSE_PREREQ - (int) - - - - - - - - - RPMSENSE_PRETRANS - (int) - - - - - - - - - RPMSENSE_INTERP - (int) - - - - - - - - - RPMSENSE_SCRIPT_PRE - (int) - - - - - - - - - RPMSENSE_SCRIPT_POST - (int) - - - - - - - - - RPMSENSE_SCRIPT_PREUN - (int) - - - - - - - - - RPMSENSE_SCRIPT_POSTUN - (int) - - - - - - - - - RPMSENSE_SCRIPT_VERIFY - (int) - - - - - - - - - RPMSENSE_FIND_REQUIRES - (int) - - - - - - - - - RPMSENSE_FIND_PROVIDES - (int) - - - - - - - - - RPMSENSE_TRIGGERIN - (int) - - - - - - - - - RPMSENSE_TRIGGERUN - (int) - - - - - - - - - RPMSENSE_TRIGGERPOSTUN - (int) - - - - - - - - - RPMSENSE_MISSINGOK - (int) - - - - - - - - - RPMSENSE_RPMLIB - (int) - - - - - - - - - RPMSENSE_TRIGGERPREIN - (int) - - - - - - - - - RPMSENSE_KEYRING - (int) - - - - - - - - - RPMSENSE_CONFIG - (int) - - - - - - - - - - RPM Mire - - - RPMMIRE_DEFAULT - (int) - - - - Modèle de recherche dans une expression régulière avec - \., .*, - et ^...$ ajoutés. - - - - - - RPMMIRE_STRCMP - (int) - - - - Le modèle de recherche est une string, - utilisant strcmp(3). - - - - - - RPMMIRE_REGEX - (int) - - - - Le modèle de recherche est une expression régulière, - utilisant regcomp(3). - - - - - - RPMMIRE_GLOB - (int) - - - - Le modèle de recherche est une expression globale, - utilisant fnmatch(3). - - - - - - - RPM tags - - - RPMTAG_ARCH - (int) - - - - - - - - - RPMTAG_ARCHSUFFIX - (int) - - - - Requiert librpm >= 4.18 - - - - - - RPMTAG_ARCHIVESIZE - (int) - - - - - - - - - RPMTAG_BASENAMES - (int) - - - - Le nom (pas le chemin) des fichiers, avec l'index de la base de données. - - - - - - RPMTAG_BUGURL - (int) - - - - - - - - - RPMTAG_BUILDARCHS - (int) - - - - - - - - - RPMTAG_BUILDHOST - (int) - - - - - - - - - RPMTAG_BUILDTIME - (int) - - - - - - - - - RPMTAG_C - (int) - - - - - - - - - RPMTAG_CHANGELOGNAME - (int) - - - - - - - - - RPMTAG_CHANGELOGTEXT - (int) - - - - - - - - - RPMTAG_CHANGELOGTIME - (int) - - - - - - - - - RPMTAG_CLASSDICT - (int) - - - - - - - - - RPMTAG_CONFLICTFLAGS - (int) - - - - - - - - - RPMTAG_CONFLICTNAME - (int) - - - - Dépendances conflictuelles, avec l'index de la base de données. - - - - - - RPMTAG_CONFLICTNEVRS - (int) - - - - - - - - - RPMTAG_CONFLICTS - (int) - - - - - - - - - RPMTAG_CONFLICTVERSION - (int) - - - - - - - - - RPMTAG_COOKIE - (int) - - - - - - - - - RPMTAG_DBINSTANCE - (int) - - - - - - - - - RPMTAG_DEPENDSDICT - (int) - - - - - - - - - RPMTAG_DESCRIPTION - (int) - - - - - - - - - RPMTAG_DIRINDEXES - (int) - - - - - - - - - RPMTAG_DIRNAMES - (int) - - - - Le répertoire des fichiers, avec l'index de la base de données. - - - - - - RPMTAG_DISTRIBUTION - (int) - - - - - - - - - RPMTAG_DISTTAG - (int) - - - - - - - - - RPMTAG_DISTURL - (int) - - - - - - - - - RPMTAG_DSAHEADER - (int) - - - - - - - - - RPMTAG_E - (int) - - - - - - - - - RPMTAG_ENCODING - (int) - - - - - - - - - RPMTAG_ENHANCEFLAGS - (int) - - - - - - - - - RPMTAG_ENHANCENAME - (int) - - - - Faible dépendance, avec l'index de la base de données, nécessite librpm >= 4.13. - - - - - - RPMTAG_ENHANCENEVRS - (int) - - - - - - - - - RPMTAG_ENHANCES - (int) - - - - - - - - - RPMTAG_ENHANCEVERSION - (int) - - - - - - - - - RPMTAG_EPOCH - (int) - - - - - - - - - RPMTAG_EPOCHNUM - (int) - - - - - - - - - RPMTAG_EVR - (int) - - - - - - - - - RPMTAG_EXCLUDEARCH - (int) - - - - - - - - - RPMTAG_EXCLUDEOS - (int) - - - - - - - - - RPMTAG_EXCLUSIVEARCH - (int) - - - - - - - - - RPMTAG_EXCLUSIVEOS - (int) - - - - - - - - - RPMTAG_FILECAPS - (int) - - - - - - - - - RPMTAG_FILECLASS - (int) - - - - - - - - - RPMTAG_FILECOLORS - (int) - - - - - - - - - RPMTAG_FILECONTEXTS - (int) - - - - - - - - - RPMTAG_FILEDEPENDSN - (int) - - - - - - - - - RPMTAG_FILEDEPENDSX - (int) - - - - - - - - - RPMTAG_FILEDEVICES - (int) - - - - - - - - - RPMTAG_FILEDIGESTALGO - (int) - - - - - - - - - RPMTAG_FILEDIGESTS - (int) - - - - - - - - - RPMTAG_FILEFLAGS - (int) - - - - - - - - - RPMTAG_FILEGROUPNAME - (int) - - - - - - - - - RPMTAG_FILEINODES - (int) - - - - - - - - - RPMTAG_FILELANGS - (int) - - - - - - - - - RPMTAG_FILELINKTOS - (int) - - - - - - - - - RPMTAG_FILEMD5S - (int) - - - - - - - - - RPMTAG_FILEMODES - (int) - - - - - - - - - RPMTAG_FILEMTIMES - (int) - - - - - - - - - RPMTAG_FILENAMES - (int) - - - - - - - - - RPMTAG_FILENLINKS - (int) - - - - - - - - - RPMTAG_FILEPROVIDE - (int) - - - - - - - - - RPMTAG_FILERDEVS - (int) - - - - - - - - - RPMTAG_FILEREQUIRE - (int) - - - - - - - - - RPMTAG_FILESIGNATURELENGTH - (int) - - - - - - - - - RPMTAG_FILESIGNATURES - (int) - - - - - - - - - RPMTAG_FILESIZES - (int) - - - - - - - - - RPMTAG_FILESTATES - (int) - - - - - - - - - RPMTAG_FILETRIGGERCONDS - (int) - - - - - - - - - RPMTAG_FILETRIGGERFLAGS - (int) - - - - - - - - - RPMTAG_FILETRIGGERINDEX - (int) - - - - - - - - - RPMTAG_FILETRIGGERNAME - (int) - - - - Le nom du fichier déclencheur, avec l'index de la base de données, nécessite librpm >= 4.13. - - - - - - RPMTAG_FILETRIGGERPRIORITIES - (int) - - - - - - - - - RPMTAG_FILETRIGGERSCRIPTFLAGS - (int) - - - - - - - - - RPMTAG_FILETRIGGERSCRIPTPROG - (int) - - - - - - - - - RPMTAG_FILETRIGGERSCRIPTS - (int) - - - - - - - - - RPMTAG_FILETRIGGERTYPE - (int) - - - - - - - - - RPMTAG_FILETRIGGERVERSION - (int) - - - - - - - - - RPMTAG_FILEUSERNAME - (int) - - - - - - - - - RPMTAG_FILEVERIFYFLAGS - (int) - - - - - - - - - RPMTAG_FSCONTEXTS - (int) - - - - - - - - - RPMTAG_GIF - (int) - - - - - - - - - RPMTAG_GROUP - (int) - - - - Le groupe de paquet, avec l'index de la base de données. - - - - - - RPMTAG_HDRID - (int) - - - - Dépréciée, utiliser RPMTAG_SHA1HEADER à la place. Supprimé dans librpm 6. - - - - - - RPMTAG_HEADERCOLOR - (int) - - - - - - - - - RPMTAG_HEADERI18NTABLE - (int) - - - - - - - - - RPMTAG_HEADERIMAGE - (int) - - - - - - - - - RPMTAG_HEADERIMMUTABLE - (int) - - - - - - - - - RPMTAG_HEADERREGIONS - (int) - - - - - - - - - RPMTAG_HEADERSIGNATURES - (int) - - - - - - - - - RPMTAG_ICON - (int) - - - - - - - - - RPMTAG_INSTALLCOLOR - (int) - - - - - - - - - RPMTAG_INSTALLTID - (int) - - - - L'identifiant de transaction d'installation, avec l'index de la base de données. - - - - - - RPMTAG_INSTALLTIME - (int) - - - - - - - - - RPMTAG_INSTFILENAMES - (int) - - - - Le chemin des fichiers, avec l'index de la base de données. - - - - - - RPMTAG_INSTPREFIXES - (int) - - - - - - - - - RPMTAG_LICENSE - (int) - - - - - - - - - RPMTAG_LONGARCHIVESIZE - (int) - - - - - - - - - RPMTAG_LONGFILESIZES - (int) - - - - - - - - - RPMTAG_LONGSIGSIZE - (int) - - - - - - - - - RPMTAG_LONGSIZE - (int) - - - - - - - - - RPMTAG_MODULARITYLABEL - (int) - - - - - - - - - RPMTAG_N - (int) - - - - - - - - - RPMTAG_NAME - (int) - - - - Le nom du paquet, avec l'index de la base de données. - - - - - - RPMTAG_NEVR - (int) - - - - - - - - - RPMTAG_NEVRA - (int) - - - - - - - - - RPMTAG_NOPATCH - (int) - - - - - - - - - RPMTAG_NOSOURCE - (int) - - - - - - - - - RPMTAG_NVR - (int) - - - - - - - - - RPMTAG_NVRA - (int) - - - - - - - - - RPMTAG_O - (int) - - - - - - - - - RPMTAG_OBSOLETEFLAGS - (int) - - - - - - - - - RPMTAG_OBSOLETENAME - (int) - - - - Paquet obsolète, avec l'index de la base de données. - - - - - - RPMTAG_OBSOLETENEVRS - (int) - - - - - - - - - RPMTAG_OBSOLETES - (int) - - - - - - - - - RPMTAG_OBSOLETEVERSION - (int) - - - - - - - - - RPMTAG_OLDENHANCES - (int) - - - - - - - - - RPMTAG_OLDENHANCESFLAGS - (int) - - - - - - - - - RPMTAG_OLDENHANCESNAME - (int) - - - - - - - - - RPMTAG_OLDENHANCESVERSION - (int) - - - - - - - - - RPMTAG_OLDFILENAMES - (int) - - - - - - - - - RPMTAG_OLDSUGGESTS - (int) - - - - - - - - - RPMTAG_OLDSUGGESTSFLAGS - (int) - - - - - - - - - RPMTAG_OLDSUGGESTSNAME - (int) - - - - - - - - - RPMTAG_OLDSUGGESTSVERSION - (int) - - - - - - - - - RPMTAG_OPTFLAGS - (int) - - - - - - - - - RPMTAG_ORDERFLAGS - (int) - - - - - - - - - RPMTAG_ORDERNAME - (int) - - - - - - - - - RPMTAG_ORDERVERSION - (int) - - - - - - - - - RPMTAG_ORIGBASENAMES - (int) - - - - - - - - - RPMTAG_ORIGDIRINDEXES - (int) - - - - - - - - - RPMTAG_ORIGDIRNAMES - (int) - - - - - - - - - RPMTAG_ORIGFILENAMES - (int) - - - - - - - - - RPMTAG_OS - (int) - - - - - - - - - RPMTAG_P - (int) - - - - - - - - - RPMTAG_PACKAGER - (int) - - - - - - - - - RPMTAG_PATCH - (int) - - - - - - - - - RPMTAG_PATCHESFLAGS - (int) - - - - - - - - - RPMTAG_PATCHESNAME - (int) - - - - - - - - - RPMTAG_PATCHESVERSION - (int) - - - - - - - - - RPMTAG_PAYLOADCOMPRESSOR - (int) - - - - - - - - - RPMTAG_PAYLOADDIGEST - (int) - - - - - - - - - RPMTAG_PAYLOADDIGESTALT - (int) - - - - Avec librpm >= 4.16. - - - - - - RPMTAG_PAYLOADDIGESTALGO - (int) - - - - - - - - - RPMTAG_PAYLOADFLAGS - (int) - - - - - - - - - RPMTAG_PAYLOADFORMAT - (int) - - - - - - - - - RPMTAG_PKGID - (int) - - - - Dépréciée, utiliser RPMTAG_SIGMD5 à la place. Supprimé dans librpm 6. - - - - - - RPMTAG_PLATFORM - (int) - - - - - - - - - RPMTAG_POLICIES - (int) - - - - - - - - - RPMTAG_POLICYFLAGS - (int) - - - - - - - - - RPMTAG_POLICYNAMES - (int) - - - - - - - - - RPMTAG_POLICYTYPES - (int) - - - - - - - - - RPMTAG_POLICYTYPESINDEXES - (int) - - - - - - - - - RPMTAG_POSTIN - (int) - - - - - - - - - RPMTAG_POSTINFLAGS - (int) - - - - - - - - - RPMTAG_POSTINPROG - (int) - - - - - - - - - RPMTAG_POSTTRANS - (int) - - - - - - - - - RPMTAG_POSTTRANSFLAGS - (int) - - - - - - - - - RPMTAG_POSTTRANSPROG - (int) - - - - - - - - - RPMTAG_POSTUN - (int) - - - - - - - - - RPMTAG_POSTUNFLAGS - (int) - - - - - - - - - RPMTAG_POSTUNPROG - (int) - - - - - - - - - RPMTAG_POSTUNTRANS - (int) - - - - Requiert librpm >= 4.19 - - - - - - RPMTAG_POSTUNTRANSFLAGS - (int) - - - - Requiert librpm >= 4.19 - - - - - - RPMTAG_POSTUNTRANSPROG - (int) - - - - Requiert librpm >= 4.19 - - - - - - RPMTAG_PREFIXES - (int) - - - - - - - - - RPMTAG_PREIN - (int) - - - - - - - - - RPMTAG_PREINFLAGS - (int) - - - - - - - - - RPMTAG_PREINPROG - (int) - - - - - - - - - RPMTAG_PRETRANS - (int) - - - - - - - - - RPMTAG_PRETRANSFLAGS - (int) - - - - - - - - - RPMTAG_PRETRANSPROG - (int) - - - - - - - - - RPMTAG_PREUN - (int) - - - - - - - - - RPMTAG_PREUNFLAGS - (int) - - - - - - - - - RPMTAG_PREUNPROG - (int) - - - - - - - - - RPMTAG_PREUNTRANS - (int) - - - - Requiert librpm >= 4.19 - - - - - - RPMTAG_PREUNTRANSFLAGS - (int) - - - - Requiert librpm >= 4.19 - - - - - - RPMTAG_PREUNTRANSPROG - (int) - - - - Requiert librpm >= 4.19 - - - - - - RPMTAG_PROVIDEFLAGS - (int) - - - - - - - - - RPMTAG_PROVIDENAME - (int) - - - - Les dépendances fournies, avec l'index de la base de données. - - - - - - RPMTAG_PROVIDENEVRS - (int) - - - - - - - - - RPMTAG_PROVIDES - (int) - - - - - - - - - RPMTAG_PROVIDEVERSION - (int) - - - - - - - - - RPMTAG_PUBKEYS - (int) - - - - - - - - - RPMTAG_R - (int) - - - - - - - - - RPMTAG_RECOMMENDFLAGS - (int) - - - - - - - - - RPMTAG_RECOMMENDNAME - (int) - - - - Les dépendances faibles recommandées, avec l'index de la base de données, requiert librpm >= 4.13. - - - - - - RPMTAG_RECOMMENDNEVRS - (int) - - - - - - - - - RPMTAG_RECOMMENDS - (int) - - - - - - - - - RPMTAG_RECOMMENDVERSION - (int) - - - - - - - - - RPMTAG_RECONTEXTS - (int) - - - - - - - - - RPMTAG_RELEASE - (int) - - - - - - - - - RPMTAG_REMOVETID - (int) - - - - - - - - - RPMTAG_REQUIREFLAGS - (int) - - - - - - - - - RPMTAG_REQUIRENAME - (int) - - - - Les dépendances requises, avec l'index de la base de données. - - - - - - RPMTAG_REQUIRENEVRS - (int) - - - - - - - - - RPMTAG_REQUIRES - (int) - - - - - - - - - RPMTAG_REQUIREVERSION - (int) - - - - - - - - - RPMTAG_RPMVERSION - (int) - - - - - - - - - RPMTAG_RSAHEADER - (int) - - - - - - - - - RPMTAG_SHA1HEADER - (int) - - - - La signature SHA1, avec l'index de la base de données. - - - - - - RPMTAG_SHA256HEADER - (int) - - - - - - - - - RPMTAG_SIGGPG - (int) - - - - - - - - - RPMTAG_SIGMD5 - (int) - - - - La signature MD5, avec l'index de la base de données. - - - - - - RPMTAG_SIGPGP - (int) - - - - - - - - - RPMTAG_SIGSIZE - (int) - - - - - - - - - RPMTAG_SIZE - (int) - - - - - - - - - RPMTAG_SOURCE - (int) - - - - - - - - - RPMTAG_SOURCEPACKAGE - (int) - - - - - - - - - RPMTAG_SOURCEPKGID - (int) - - - - - - - - - RPMTAG_SOURCERPM - (int) - - - - - - - - - RPMTAG_SPEC - (int) - - - - Requiert librpm >= 4.18 - - - - - - RPMTAG_SUGGESTFLAGS - (int) - - - - - - - - - RPMTAG_SUGGESTNAME - (int) - - - - Le répertoire des fichiers, avec l'index de la base de données. - - - - - - RPMTAG_SUGGESTNEVRS - (int) - - - - - - - - - RPMTAG_SUGGESTS - (int) - - - - - - - - - RPMTAG_SUGGESTVERSION - (int) - - - - - - - - - RPMTAG_SUMMARY - (int) - - - - - - - - - RPMTAG_SUPPLEMENTFLAGS - (int) - - - - - - - - - RPMTAG_SUPPLEMENTNAME - (int) - - - - Les dépendances faibles, avec l'index de la base de données, requiert librpm >= 4.13. - - - - - - RPMTAG_SUPPLEMENTNEVRS - (int) - - - - - - - - - RPMTAG_SUPPLEMENTS - (int) - - - - - - - - - RPMTAG_SUPPLEMENTVERSION - (int) - - - - - - - - - RPMTAG_SYSUSERS - (int) - - - - Requiert librpm >= 4.19 - - - - - - RPMTAG_TRANSFILETRIGGERCONDS - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERFLAGS - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERINDEX - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERNAME - (int) - - - - Le nom du déclencheur de fichier de transaction, avec l'index de la base de données, requiert librpm >= 4.13. - - - - - - RPMTAG_TRANSFILETRIGGERPRIORITIES - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERSCRIPTFLAGS - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERSCRIPTPROG - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERSCRIPTS - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERTYPE - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERVERSION - (int) - - - - - - - - - RPMTAG_TRANSLATIONURL - (int) - - - - Requiert librpm >= 4.18 - - - - - - RPMTAG_TRIGGERCONDS - (int) - - - - - - - - - RPMTAG_TRIGGERFLAGS - (int) - - - - - - - - - RPMTAG_TRIGGERINDEX - (int) - - - - - - - - - RPMTAG_TRIGGERNAME - (int) - - - - Le nom du déclencheur, avec l'index de la base de données. - - - - - - RPMTAG_TRIGGERSCRIPTFLAGS - (int) - - - - - - - - - RPMTAG_TRIGGERSCRIPTPROG - (int) - - - - - - - - - RPMTAG_TRIGGERSCRIPTS - (int) - - - - - - - - - RPMTAG_TRIGGERTYPE - (int) - - - - - - - - - RPMTAG_TRIGGERVERSION - (int) - - - - - - - - - RPMTAG_UPSTREAMRELEASES - (int) - - - - Requiert librpm >= 4.18 - - - - - - RPMTAG_URL - (int) - - - - - - - - - RPMTAG_V - (int) - - - - - - - - - RPMTAG_VCS - (int) - - - - - - - - - RPMTAG_VENDOR - (int) - - - - - - - - - RPMTAG_VERBOSE - (int) - - - - - - - - - RPMTAG_VERIFYSCRIPT - (int) - - - - - - - - - RPMTAG_VERIFYSCRIPTFLAGS - (int) - - - - - - - - - RPMTAG_VERIFYSCRIPTPROG - (int) - - - - - - - - - RPMTAG_VERITYSIGNATUREALGO - (int) - - - - Avec librpm >= 4.17. - - - - - - RPMTAG_VERITYSIGNATURES - (int) - - - - Avec librpm >= 4.17. - - - - - - RPMTAG_VERSION - (int) - - - - - - - - - RPMTAG_XPM - (int) - - - - - - - - - diff --git a/reference/rpminfo/functions/rpmaddtag.xml b/reference/rpminfo/functions/rpmaddtag.xml deleted file mode 100644 index 860aaf8472..0000000000 --- a/reference/rpminfo/functions/rpmaddtag.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - rpmaddtag - Ajoute un tag récupéré dans une requête - - - - &reftitle.description; - - boolrpmaddtag - inttag - - - Ajoute un tag récupéré dans une requête précédente. - - - - - &reftitle.parameters; - - - tag - - - Une des constantes RPMTAG_*, voir la page des constantes rpminfo. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - rpminfo - rpmdbinfo - rpmdbsearch - - - - - diff --git a/reference/rpminfo/functions/rpmdbinfo.xml b/reference/rpminfo/functions/rpmdbinfo.xml deleted file mode 100644 index 95d848dbda..0000000000 --- a/reference/rpminfo/functions/rpmdbinfo.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - rpmdbinfo - Renvoie les informations d'un RPM installé - - - - &reftitle.description; - - arraynullrpmdbinfo - stringnevr - boolfull&false; - - - Récupère les informations sur un paquet installé, depuis la base de données RPM du système. - - - - - &reftitle.parameters; - - - nevr - - - Le nom avec optionnellement l'epoch, la version et la release. - - - - - full - - - Si &true; toutes les informations d'en-tête du fichier sont récupérées, sinon seulement un ensemble minimal. - - - - - - - - &reftitle.returnvalues; - - Un array d'array d'informations ou &null; en cas d'erreur. - - - - - &reftitle.examples; - - Un exemple de <function>rpmdbinfo</function> - - -]]> - - &example.outputs; - - Array - ( - [Name] => php-pecl-rpminfo - [Version] => 0.4.2 - [Release] => 1.fc31 - [Summary] => RPM information - [Installtime] => 1586244687 - [Arch] => x86_64 - ) -) -]]> - - - - - - &reftitle.seealso; - - rpmaddtag - - - - - diff --git a/reference/rpminfo/functions/rpmdbsearch.xml b/reference/rpminfo/functions/rpmdbsearch.xml deleted file mode 100644 index 636282acaf..0000000000 --- a/reference/rpminfo/functions/rpmdbsearch.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - rpmdbsearch - Recherche des paquets RPM - - - - &reftitle.description; - - arraynullrpmdbsearch - stringpattern - intrpmtagRPMTAG_NAME - intrpmmire-1 - boolfull&false; - - - Recherche des paquets dans la base de données RPM du système. - - - - - &reftitle.parameters; - - - pattern - - - La valeur à rechercher. - - - - - rpmtag - - - Le critère de recherche, une des constantes - RPMTAG_*. - - - - - rpmmire - - - Le type de motif, une des constantes - RPMMIRE_*. - Quand < 0 le critère doit être égal à la valeur, et l'index de la base de données est utilisé si possible. - - - - - full - - - Si &true; tous les en-têtes d'information pour le fichier sont récupérés, sinon seulement un ensemble minimal. - - - - - - - - &reftitle.returnvalues; - - Un array d'array d'informations ou &null; en cas d'erreur. - - - - - &reftitle.examples; - - Recherche du paquet possédant un fichier - - -]]> - - &example.outputs; - - Array - ( - [Name] => php-cli - [Version] => 7.4.4 - [Release] => 1.fc32 - [Summary] => Command-line interface for PHP - [Arch] => x86_64 - ) - -) -]]> - - - - - - &reftitle.seealso; - - rpmaddtag - - - - - diff --git a/reference/rpminfo/functions/rpmdefine.xml b/reference/rpminfo/functions/rpmdefine.xml deleted file mode 100644 index 446c2d9ead..0000000000 --- a/reference/rpminfo/functions/rpmdefine.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - rpmdefine - Définit ou change la valeur d'une macro RPM - - - - &reftitle.description; - - boolrpmdefine - stringtext - - - Définit ou change la valeur d'une macro RPM. - - - Cela peut être utilisé pour sélectionner le chemin de la base de données et le moteur à utiliser - au lieu de celui par défaut du système. - - - - - - &reftitle.parameters; - - - text - - - Le nom de la macro, les options, le corps. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Un exemple de <function>rpmdefine</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - rpmexpand - rpmdbinfo - - - - - - diff --git a/reference/rpminfo/functions/rpmexpand.xml b/reference/rpminfo/functions/rpmexpand.xml deleted file mode 100644 index 787092b927..0000000000 --- a/reference/rpminfo/functions/rpmexpand.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - rpmexpand - Récupère la valeur étendue d'une macro RPM - - - - &reftitle.description; - - stringrpmexpand - stringtext - - - Récupère la valeur étendue d'une macro RPM. - - - - - &reftitle.parameters; - - - text - - - Le texte avec les macros RPM à étendre. - - - - - - - - &reftitle.returnvalues; - - Un string avec les macro(s) étendue(s) concaténée(s). - - - - - &reftitle.examples; - - Un exemple de <function>rpmexpand</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - rpmexpandnumeric - - - - - diff --git a/reference/rpminfo/functions/rpmexpandnumeric.xml b/reference/rpminfo/functions/rpmexpandnumeric.xml deleted file mode 100644 index 21a54fe6f3..0000000000 --- a/reference/rpminfo/functions/rpmexpandnumeric.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - rpmexpandnumeric - Récupère la valeur numérique d'une macro RPM - - - - &reftitle.description; - - intrpmexpandnumeric - stringtext - - - Récupère la valeur numérique d'une macro RPM. - - - - - &reftitle.parameters; - - - text - - - Le texte avec les macros RPM à étendre. - - - - - - - - &reftitle.returnvalues; - - L'expansion de la macro en tant que int. - Les valeurs booléennes (Y ou y retourne 1, - N ou n retourne 0) - sont également permises. - Une macro non définie retourne 0. - - - - - &reftitle.examples; - - Un exemple <function>rpmexpandnumeric</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - rpmexpand - - - - - diff --git a/reference/rpminfo/functions/rpmgetsymlink.xml b/reference/rpminfo/functions/rpmgetsymlink.xml deleted file mode 100644 index 35ba084614..0000000000 --- a/reference/rpminfo/functions/rpmgetsymlink.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - rpmgetsymlink - Renvoie la cible d'un lien symbolique - - - - &reftitle.description; - - stringnullrpmgetsymlink - stringpath - stringname - - - Renvoie la cible d'un lien symbolique. - - - - - - &reftitle.parameters; - - - path - - - Le chemin du fichier RPM. - - - - - name - - - Le nom du fichier lien symbolique. - - - - - - - - &reftitle.returnvalues; - - Un string avec la cible du lien symbolique, - &null; en cas d'erreur, ou une chaîne vide si ce n'est pas un lien symbolique. - - - - - diff --git a/reference/rpminfo/functions/rpminfo.xml b/reference/rpminfo/functions/rpminfo.xml deleted file mode 100644 index b36be8dd07..0000000000 --- a/reference/rpminfo/functions/rpminfo.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - rpminfo - Renvoie des informations d'un fichier RPM - - - - &reftitle.description; - - arraynullrpminfo - stringpath - boolfull&false; - stringerror - - - Renvoie les informations sur un fichier local, un paquet RPM. - - - - - - &reftitle.parameters; - - - path - - - Le chemin du fichier RPM. - - - - - full - - - Si &true; toutes les informations d'en-tête du fichier sont récupérées, - sinon seulement un ensemble minimal. - - - - - error - - - Si fourni, recevra le message d'erreur possible, - et évitera un avertissement d'exécution. - - - - - - - - &reftitle.returnvalues; - - Un array d'informations, ou &null; en cas d'erreur. - - - - - &reftitle.examples; - - Un exemple de <function>rpminfo</function> - - -]]> - - &example.outputs; - - php-pecl-rpminfo - [Version] => 0.4.2 - [Release] => 1.el8 - [Summary] => RPM information - [Buildtime] => 1586244821 - [Arch] => x86_64 -) -]]> - - - - - - &reftitle.seealso; - - rpmaddtag - - - - - diff --git a/reference/rpminfo/functions/rpmvercmp.xml b/reference/rpminfo/functions/rpmvercmp.xml deleted file mode 100644 index c849dfe3f0..0000000000 --- a/reference/rpminfo/functions/rpmvercmp.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - rpmvercmp - Comparaison de versions RPM - - - - &reftitle.description; - - intboolrpmvercmp - stringevr1 - stringevr2 - stringnulloperator&null; - - - Compare deux versions de paquets RPM. - - - - - &reftitle.parameters; - - - evr1 - - - La première chaîne epoch:version-release. - - - - - evr2 - - - La seconde chaîne epoch:version-release. - - - - - operator - - - Un opérateur optionnel. - Les opérateurs possibles sont : - - < - lt - <= - le - > - gt - >= - ge - == - = - eq - != - <> - ne - . - - - Ce paramètre est sensible à la casse, les valeurs doivent être en minuscules. - - - - - - - - &reftitle.returnvalues; - - Renvoie -1 si evr1 est inférieur à - evr2, 1 si evr1 est - supérieur à evr2, et 0 si elles sont égales. - - - Lorsque l'argument optionnel operator est utilisé, la fonction - renverra &true; si la relation est celle spécifiée par - l'opérateur, sinon &false;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rpminfo 0.7.0 - - L'operator optionnel a été ajouté. - - - - - - - - - diff --git a/reference/rpminfo/reference.xml b/reference/rpminfo/reference.xml deleted file mode 100644 index de34b57906..0000000000 --- a/reference/rpminfo/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &Functions; de RpmInfo - - &reference.rpminfo.entities.functions; - - - diff --git a/reference/rpminfo/setup.xml b/reference/rpminfo/setup.xml deleted file mode 100644 index c8097cf971..0000000000 --- a/reference/rpminfo/setup.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Cette extension requiert la version 4.11.3 ou supérieure de librpm. - -
    - -
    - Installation via PECL - - &pecl.info; - &url.pecl.package;rpminfo. - -
    - -     - diff --git a/reference/rrd/book.xml b/reference/rrd/book.xml deleted file mode 100644 index c1a6576243..0000000000 --- a/reference/rrd/book.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - RRDtool - RRD - - - &reftitle.intro; - - L'extension PECL/rrd propose un lien avec la bibliothèque C RRDtool. - RRDtool est une norme dans l'industrie open source, fournissant - une historisation des données à haute performance, - ainsi qu'un système de représentation graphique des données de séries - chronologiques. - - - Page d'accueil RRDtool : &url.rrd;. - - - - &reference.rrd.setup; - &reference.rrd.examples; - &reference.rrd.reference; - - &reference.rrd.rrdcreator; - &reference.rrd.rrdgraph; - &reference.rrd.rrdupdater; - - diff --git a/reference/rrd/configure.xml b/reference/rrd/configure.xml deleted file mode 100644 index 58afde1e0e..0000000000 --- a/reference/rrd/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;rrd - - -
    - diff --git a/reference/rrd/examples.xml b/reference/rrd/examples.xml deleted file mode 100644 index e7233c6493..0000000000 --- a/reference/rrd/examples.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - &reftitle.examples; -
    - Exemple procédural PECL/rrd - - Utilisation procédurale de rrd - - -]]> - - -
    - -
    - Exemple orienté objet de PECL/rrd - - Utilisation orientée objet de rrd - -addDataSource("speed:COUNTER:600:U:U"); -$creator->addArchive("AVERAGE:0.5:1:24"); -$creator->addArchive("AVERAGE:0.5:6:10"); -$creator->save(); - -$updater = new RRDUpdater($rrdFile); -$updater->update(array("speed" => "12345"), "920804700"); -$updater->update(array("speed" => "12357"), "920805000"); - -$graphObj = new RRDGraph($outputPngFile); -$graphObj->setOptions( - array( - "--start" => "920804400", - "--end" => 920808000, - "--vertical-label" => "m/s", - "DEF:myspeed=$rrdFile:speed:AVERAGE", - "CDEF:realspeed=myspeed,1000,*", - "LINE2:realspeed#FF0000" - ) -); -$graphObj->save(); -?> -]]> - - -
    - -     - diff --git a/reference/rrd/functions/rrd-create.xml b/reference/rrd/functions/rrd-create.xml deleted file mode 100644 index 4b13979622..0000000000 --- a/reference/rrd/functions/rrd-create.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - rrd_create - Crée un fichier de base de données rrd - - - - &reftitle.description; - - boolrrd_create - stringfilename - arrayoptions - - - Crée un fichier de base de données rrd. - - - - - &reftitle.parameters; - - - filename - - - Nom de fichier du nouveau fichier rrd. - - - - - options - - - Options pour la création rrd - listes de chaînes. - Se reporter à la page man de rrd pour une liste - complète des options disponibles pour la création. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/rrd/functions/rrd-error.xml b/reference/rrd/functions/rrd-error.xml deleted file mode 100644 index be32ce44e5..0000000000 --- a/reference/rrd/functions/rrd-error.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - rrd_error - Récupère le message de la dernière erreur survenue - - - - &reftitle.description; - - stringrrd_error - - - - Récupère le message de la dernière erreur survenue. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le dernier message d'erreur. - - - - - diff --git a/reference/rrd/functions/rrd-fetch.xml b/reference/rrd/functions/rrd-fetch.xml deleted file mode 100644 index e18f9fb7ab..0000000000 --- a/reference/rrd/functions/rrd-fetch.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - rrd_fetch - Récupère les données pour le graphique - - - - &reftitle.description; - - arrayrrd_fetch - stringfilename - arrayoptions - - - Récupère les données pour le graphique depuis le fichier de base de - données RRD sous la forme d'un tableau. Cette fonction a le même résultat - que la fonction rrd_graph, mais les données récupérées - sont retournées sous la forme d'un tableau, aucun fichier image n'est créé. - - - - - &reftitle.parameters; - - - filename - - - Nom de fichier de la base de données RRD. - - - - - options - - - Tableau d'options pour la spécification de la résolution. - - - - - - - - &reftitle.returnvalues; - - Retourne des informations sur les données de graphique - récupérées. - - - - - diff --git a/reference/rrd/functions/rrd-first.xml b/reference/rrd/functions/rrd-first.xml deleted file mode 100644 index b6412de415..0000000000 --- a/reference/rrd/functions/rrd-first.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - rrd_first - Récupère le timestamp du premier échantillon depuis le fichier RRD - - - - &reftitle.description; - - intrrd_first - stringfile - intraaindex0 - - - Retourne les données du premier échantillon depuis le RRD spécifié - du fichier RRD. - - - - - &reftitle.parameters; - - - file - - - Nom de fichier de la base de données RRD. - - - - - raaindex - - - Le numéro d'index du RRA à examiner. La valeur par défaut est 0. - - - - - - - - &reftitle.returnvalues; - - Timestamp unix,&return.falseforfailure;. - - - - - diff --git a/reference/rrd/functions/rrd-graph.xml b/reference/rrd/functions/rrd-graph.xml deleted file mode 100644 index e45c8d389f..0000000000 --- a/reference/rrd/functions/rrd-graph.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - rrd_graph - Crée une image depuis des données - - - - &reftitle.description; - - arrayrrd_graph - stringfilename - arrayoptions - - - Crée une image depuis un fichier RRD. - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier dans lequel le graphique sera redirigé. - Il se termine normalement par l'extension .png, - .svg ou .eps, suivant le format - de sortie désiré. - - - - - options - - - Options pour la génération de l'image. Se reporter à la page man - du graphique RRD pour toutes les options possibles. Toutes les options - (définitions de données, définitions des variables, etc.) sont autorisées. - - - - - - - - &reftitle.returnvalues; - - Tableau contenant les informations sur l'image générée,&return.falseforfailure;. - - - - diff --git a/reference/rrd/functions/rrd-info.xml b/reference/rrd/functions/rrd-info.xml deleted file mode 100644 index fc7f498a15..0000000000 --- a/reference/rrd/functions/rrd-info.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - rrd_info - Récupère les informations sur un fichier RRD - - - - &reftitle.description; - - arrayrrd_info - stringfilename - - - Retourne les informations sur un fichier de base de données RRD. - - - - - &reftitle.parameters; - - - file - - - Nom de fichier de la base de données RRD. - - - - - - - - &reftitle.returnvalues; - - Tableau contenant les informations sur le fichier RRD demandé,&return.falseforfailure;. - - - - - - diff --git a/reference/rrd/functions/rrd-last.xml b/reference/rrd/functions/rrd-last.xml deleted file mode 100644 index af8f8adea5..0000000000 --- a/reference/rrd/functions/rrd-last.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - rrd_last - Récupère le timestamp unix du dernier échantillon - - - - &reftitle.description; - - intrrd_last - stringfilename - - - Retourne le timestamp UNIX de la mise à jour la plus récente de la - base de données RRD. - - - - - &reftitle.parameters; - - - filename - - - Nom de fichier de la base de données RRD. - - - - - - - - &reftitle.returnvalues; - - Timestamp Unix des données les plus récentes de la base de données RRD. - - - - - - diff --git a/reference/rrd/functions/rrd-lastupdate.xml b/reference/rrd/functions/rrd-lastupdate.xml deleted file mode 100644 index 96d6967c90..0000000000 --- a/reference/rrd/functions/rrd-lastupdate.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - rrd_lastupdate - Récupère les informations sur les dernières données mises à jour - - - - &reftitle.description; - - arrayrrd_lastupdate - stringfilename - - - Récupère un tableau de timestamp unix et les valeurs stockées pour chaque date - de la dernière mise à jour du fichier de base de données RRD. - - - - - &reftitle.parameters; - - - file - - - Nom de fichier de la base de données RRD. - - - - - - - - &reftitle.returnvalues; - - Tableau d'informations sur la dernière mise à jour,&return.falseforfailure;. - - - - diff --git a/reference/rrd/functions/rrd-restore.xml b/reference/rrd/functions/rrd-restore.xml deleted file mode 100644 index abb554618a..0000000000 --- a/reference/rrd/functions/rrd-restore.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - rrd_restore - Restaure le fichier RRD depuis une sauvegarde XML - - - - &reftitle.description; - - boolrrd_restore - stringxml_file - stringrrd_file - arrayoptions - - - Restaure le fichier RRD depuis une sauvegarde XML. - - - - - &reftitle.parameters; - - - xml_file - - - Nom de fichier XML de la sauvegarde du fichier original de base de données RRD. - - - - - rrd_file - - - Nom du fichier de la base de données RRD qui sera restauré. - - - - - options - - - Tableau d'options pour la restauration. Se reporter à la - page man de la restauration RRD. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/rrd/functions/rrd-tune.xml b/reference/rrd/functions/rrd-tune.xml deleted file mode 100644 index 45a3f3cf04..0000000000 --- a/reference/rrd/functions/rrd-tune.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - rrd_tune - Affine des options d'en-tête d'un fichier de base de données RRD - - - - &reftitle.description; - - boolrrd_tune - stringfilename - arrayoptions - - - Modifie quelques options de l'en-tête d'un fichier de base de données - RRD, comme le fait de renommer la source des données. - - - - - &reftitle.parameters; - - - filename - - - Nom du fichier de la base de données RRD. - - - - - options - - - Options avec les propriétés du fichier de la base de données - RRD qui doivent être modifiées. Se reporter à la page man - correspondante de RRD pour plus de détails. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/rrd/functions/rrd-update.xml b/reference/rrd/functions/rrd-update.xml deleted file mode 100644 index 1e00678d18..0000000000 --- a/reference/rrd/functions/rrd-update.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - rrd_update - Met à jour une base de données RRD - - - - &reftitle.description; - - boolrrd_update - stringfilename - arrayoptions - - - Met à jour le fichier d'une base de données RRD. Les données d'entrée sont la date/heure, - interpolée suivant les propriétés du fichier de la base de données RRD. - - - - - &reftitle.parameters; - - - filename - - - Nom du fichier de la base de données RRD. Cette base - de données sera mise à jour. - - - - - options - - - Options pour la mise à jour de la base de données RRD - - liste de chaînes. Se reporter à la page man correspondante - pour une liste complète des options. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/rrd/functions/rrd-version.xml b/reference/rrd/functions/rrd-version.xml deleted file mode 100644 index d90c17e5b7..0000000000 --- a/reference/rrd/functions/rrd-version.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - rrd_version - Récupère les informations de version de la bibliothèque rrdtool - - - - &reftitle.description; - - stringrrd_version - - - - Récupère les informations de version de la bibliothèque rrdtool. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une &string; contenant le numéro de version de la - bibliothèque rrdtool c.-à-d. "1.4.3". - - - - - diff --git a/reference/rrd/functions/rrd-xport.xml b/reference/rrd/functions/rrd-xport.xml deleted file mode 100644 index 8af092db2d..0000000000 --- a/reference/rrd/functions/rrd-xport.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - rrd_xport - Exporte les informations d'une base de données - - - - &reftitle.description; - - arrayrrd_xport - arrayoptions - - - Exporte les informations d'un fichier de base de données RRD. Ces données - peuvent être converties en fichier XML via un script PHP de l'espace - utilisateur puis, être utilisées pour restaurer le fichier de base de données - RRD. - - - - - &reftitle.parameters; - - - options - - - Tableau d'options pour l'exportation ; se reporter à la - page man correspondante. - - - - - - - - &reftitle.returnvalues; - - Tableau contenant les informations du fichier de base de données RRD,&return.falseforfailure;. - - - - - - diff --git a/reference/rrd/functions/rrdc-disconnect.xml b/reference/rrd/functions/rrdc-disconnect.xml deleted file mode 100644 index 80d4e83756..0000000000 --- a/reference/rrd/functions/rrdc-disconnect.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - rrdc_disconnect - Ferme toutes les connexions vers le daemon de mise en cache rrd - - - - &reftitle.description; - - voidrrdc_disconnect - - - - Ferme toutes les connexions vers le daemon de mise en cache rrd. - - - Cette fonction est automatiquement appelée lorsque le processus - global PHP se termine. Cela dépend de l'API utilisée. Par exemple, - cette fonction est appelée automatiquement à la fin d'un script - en ligne de commande. - - - Il en est de l'utilisateur que de vouloir appeler cette fonction à la - fin de chaque requête ou non. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/rrd/reference.xml b/reference/rrd/reference.xml deleted file mode 100644 index cb91b6d997..0000000000 --- a/reference/rrd/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; RRD - - &reference.rrd.entities.functions; - - - - diff --git a/reference/rrd/rrdcreator.xml b/reference/rrd/rrdcreator.xml deleted file mode 100644 index 1503d9b733..0000000000 --- a/reference/rrd/rrdcreator.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - La classe RRDCreator - RRDCreator - - - - -
    - &reftitle.intro; - - Classe pour créer des fichiers de base de données - RRD. - -
    - - -
    - &reftitle.classsynopsis; - - - - RRDCreator - - - - - RRDCreator - - - - - &Methods; - - - - - - - - - -
    - -     - - &reference.rrd.entities.rrdcreator; - -     - diff --git a/reference/rrd/rrdcreator/addarchive.xml b/reference/rrd/rrdcreator/addarchive.xml deleted file mode 100644 index 80476dd827..0000000000 --- a/reference/rrd/rrdcreator/addarchive.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - RRDCreator::addArchive - Ajoute des valeurs de données RRA - archive pour chaque source de données - - - - &reftitle.description; - - public voidRRDCreator::addArchive - stringdescription - - - Ajoute une définition RRA de la description de l'archive. Une archive - consiste en un nombre de valeurs de données ou de statistiques pour chaque - sources de données définies (DS). Les sources de données sont définies - par la méthode RRDCreator::addDataSource. - Il faut appeler cette méthode pour chaque archive demandée. - - - - - &reftitle.parameters; - - - description - - - Définition de l'archive RRA. Le format est identique à la définition RRA - dans la commande de création RRD. Se reporter à la page man - de création RRD pour plus de détails. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/rrd/rrdcreator/adddatasource.xml b/reference/rrd/rrdcreator/adddatasource.xml deleted file mode 100644 index 6d0edaad74..0000000000 --- a/reference/rrd/rrdcreator/adddatasource.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - RRDCreator::addDataSource - Ajoute une définition de source de données pour la base de données RRD - - - - &reftitle.description; - - public voidRRDCreator::addDataSource - stringdescription - - - RRD peut accepter des entrées depuis diverses sources de données (DS), c.-à-d. - un trafic entrant et sortant. Cette méthode ajoute une source de données - par sa description. Il faut appeler cette méthode pour chaque - source de données. - - - - - &reftitle.parameters; - - - description - - - Définition de la source de données (DS). Le format est identique à la - définition d'un DS dans la commande de création RRD. Se reporter à la - page man de la création RRD pour plus de détails. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/rrd/rrdcreator/construct.xml b/reference/rrd/rrdcreator/construct.xml deleted file mode 100644 index 5ffb320214..0000000000 --- a/reference/rrd/rrdcreator/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - RRDCreator::__construct - Crée une nouvelle instance RRDCreator - - - - &reftitle.description; - - public RRDCreator::__construct - stringpath - stringstartTime - intstep0 - - - Crée une nouvelle instance RRDCreator. - - - - - &reftitle.parameters; - - - path - - - Chemin vers le nouveau fichier de base de données RRD créé. - - - - - startTime - - - Date/heure pour la première valeur de la base de données RRD. - Ce paramètre supporte tous les formats qui sont supportés par l'appel - de création RRD. - - - - - intstep - - - Intervalle de base, en secondes, d'insertion des données dans la base de données - RRD. - - - - - - - - diff --git a/reference/rrd/rrdcreator/save.xml b/reference/rrd/rrdcreator/save.xml deleted file mode 100644 index 58c76cf3f1..0000000000 --- a/reference/rrd/rrdcreator/save.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - RRDCreator::save - Sauvegarde la base de données RRD dans un fichier - - - - &reftitle.description; - - public boolRRDCreator::save - - - - Sauvegarde la base de données RRD dans un fichier, dont le nom est défini par - la méthode RRDCreator::__construct. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/rrd/rrdgraph.xml b/reference/rrd/rrdgraph.xml deleted file mode 100644 index 9ad08b63b0..0000000000 --- a/reference/rrd/rrdgraph.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La classe RRDGraph - RRDGraph - - - - -
    - &reftitle.intro; - - Classe pour exporter les données depuis une base de données - RRD vers un fichier image. - -
    - - -
    - &reftitle.classsynopsis; - - - - RRDGraph - - - - - RRDGraph - - - - - &Methods; - - - - - - - - - -
    - -     - - &reference.rrd.entities.rrdgraph; - -     - diff --git a/reference/rrd/rrdgraph/construct.xml b/reference/rrd/rrdgraph/construct.xml deleted file mode 100644 index 339bbb0b75..0000000000 --- a/reference/rrd/rrdgraph/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - RRDGraph::__construct - Crée une nouvelle instance RRDGraph - - - - &reftitle.description; - - public RRDGraph::__construct - stringpath - - - Crée une nouvelle instance RRDGraph. Cette instance est responsable - du rendu du résultat de la requête à la base de données RRD dans l'image. - - - - - &reftitle.parameters; - - - path - - - Chemin complet pour la nouvelle image créée. - - - - - - - - diff --git a/reference/rrd/rrdgraph/save.xml b/reference/rrd/rrdgraph/save.xml deleted file mode 100644 index dcb8569cc2..0000000000 --- a/reference/rrd/rrdgraph/save.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - RRDGraph::save - Sauvegarde le résultat d'une requête dans une image - - - - &reftitle.description; - - public arrayRRDGraph::save - - - - Sauvegarde le résultat d'une requête de base de données RRD dans une - image définie par la méthode - RRDGraph::__construct. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les informations sur l'image générée,&return.falseforfailure;. - - - - diff --git a/reference/rrd/rrdgraph/saveverbose.xml b/reference/rrd/rrdgraph/saveverbose.xml deleted file mode 100644 index 6ca5c24860..0000000000 --- a/reference/rrd/rrdgraph/saveverbose.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - RRDGraph::saveVerbose - Sauvegarde une requête de base de données RRD dans l'image et retourne - les informations verbeuses sur le graphique généré. - - - - - &reftitle.description; - - public arrayRRDGraph::saveVerbose - - - - Sauvegarde la requête de base de données RRD dans le fichier image défini - par la méthode RRDGraph::__construct et retourne - les informations verbeuses sur le graphique généré ; si "-" est utilisé - comme nom de fichier image, les données de l'image - seront également retournées dans le tableau résultant. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les informations détaillées sur l'image - générée,&return.falseforfailure;. - - - - diff --git a/reference/rrd/rrdgraph/setoptions.xml b/reference/rrd/rrdgraph/setoptions.xml deleted file mode 100644 index 951f642eb6..0000000000 --- a/reference/rrd/rrdgraph/setoptions.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - RRDGraph::setOptions - Définit les options d'exportation d'un graphique RRD - - - - &reftitle.description; - - public voidRRDGraph::setOptions - arrayoptions - - - - - - - - &reftitle.parameters; - - - options - - - Liste les options pour la génération de l'image depuis un fichier - de base de données RRD. Peut être une liste d'options, ou une liste - de chaînes avec des clés pour une meilleure lisibilité. Se reporter - à la page man du graphique RRD pour une liste des options disponibles. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <methodname>RRDGraph::setOptions</methodname> - -setOptions(array( - "--start" => "920804400", - "--end" => 920808000, - "--vertical-label" => "m/s", - "DEF:myspeed=$rrdFile:speed:AVERAGE", - "CDEF:realspeed=myspeed,1000,*", - "LINE2:realspeed#FF0000" -)); -?> -]]> - - - - - Définit plusieurs options de couleur - -setOptions(array( - "--start" => "920804400", - "--end" => 920808000, - "--vertical-label" => "m/s", - "--color=BACK#00000000", - "--color=GRID#00000000", - "--color=MGRID#00000000", - "DEF:myspeed=$rrdFile:speed:AVERAGE", - "CDEF:realspeed=myspeed,1000,*", - "LINE2:realspeed#FF0000" -)); -?> -]]> - - - Ne pas utiliser la syntaxe clé/valeur pour une même option rrd. - C'est plus lisible certes, mais ça ne fonctionne pas. - - -setOptions(array( - "--color" => "BACK#00000000", - "--color" => "GRID#00000000", - "--color" => "MGRID#00000000" -)); -?> -]]> - - - D'un point de vue de PHP, c'est identique à - - -setOptions(array( - "--color" => "MGRID#00000000" -)); -?> -]]> - - - - - - diff --git a/reference/rrd/rrdupdater.xml b/reference/rrd/rrdupdater.xml deleted file mode 100644 index e340e62373..0000000000 --- a/reference/rrd/rrdupdater.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La classe RRDUpdater - RRDUpdater - - - - -
    - &reftitle.intro; - - Classe pour mettre à jour un fichier de base de données - RRD. - -
    - - -
    - &reftitle.classsynopsis; - - - - RRDUpdater - - - - - RRDUpdater - - - - - &Methods; - - - - - - - - - -
    - -     - - &reference.rrd.entities.rrdupdater; - -     - diff --git a/reference/rrd/rrdupdater/construct.xml b/reference/rrd/rrdupdater/construct.xml deleted file mode 100644 index c6a99871e2..0000000000 --- a/reference/rrd/rrdupdater/construct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - RRDUpdater::__construct - Crée une nouvelle instance RRDUpdater - - - - &reftitle.description; - - public RRDUpdater::__construct - stringpath - - - Crée une nouvelle instance RRDUpdater. Cette instance est chargée - de la mise à jour du fichier de base de données RRD. - - - - - &reftitle.parameters; - - - path - - - Chemin du système de fichiers vers le fichier de - base de données RRD à mettre à jour. - - - - - - - - diff --git a/reference/rrd/rrdupdater/update.xml b/reference/rrd/rrdupdater/update.xml deleted file mode 100644 index c2c56ed985..0000000000 --- a/reference/rrd/rrdupdater/update.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - RRDUpdater::update - Met à jour un fichier de base de données RRD - - - - &reftitle.description; - - public boolRRDUpdater::update - arrayvalues - stringtime - time() - - - - Met à jour le fichier RRD défini via la méthode - RRDUpdater::__construct. Le fichier - est mis à jour avec des valeurs spécifiques. - - - - - &reftitle.parameters; - - - values - - - Données à utiliser pour la mise à jour. - La clé est le nom de la source des données. - - - - - time - - - La date/heure pour la mise à jour de RRD avec une donnée - particulière. La valeur par défaut est la date/heure courante. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Émet une exception Exception en cas d'erreur. - - - - - &reftitle.examples; - - Exemple avec <methodname>RRDUpdater::update</methodname> - -update(array("speed" => "12411"), "920807700"); -?> -]]> - - - - - diff --git a/reference/rrd/setup.xml b/reference/rrd/setup.xml deleted file mode 100644 index 92f278d314..0000000000 --- a/reference/rrd/setup.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Il faut installer d'abord la bibliothèque librrd afin - d'utiliser l'extension PECL/rrd. Vérifier si la distribution - favorite Linux propose le paquet librrd-dev. - PECL/rrd est testé avec librrd 1.4.3, les anciennes versions ou les plus récentes - peuvent ou non fonctionner. - - - - Librrd et donc l'extension elle-même ne sont pas, la plupart du temps, thread safe. - Il y a beaucoup d'états globaux et partagés dans librrd. Ce peut être - dangereux d'utiliser cette extension en environnement multithread comme - Apache 2 mpm worker. S'il y a plusieurs requêtes parallèles, une d'entre elles - peut modifier l'état global de la bibliothèque librrd, affectant ainsi - les autres requêtes en cours d'exécution. - - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;rrd. - -
    - -     - diff --git a/reference/runkit7/book.xml b/reference/runkit7/book.xml deleted file mode 100644 index 64ea3fb825..0000000000 --- a/reference/runkit7/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - runkit7 - runkit7 - - - &reftitle.intro; - - L'extension runkit7 fournit des moyens pour modifier les constantes, - les fonctions définies par l'utilisateur et les classes définies par l'utilisateur. - Elle fournit également des variables superglobales personnalisées. - - - - Ce paquet est un fork du - paquet runkit fournissant un support PHP 7. - - - - &reference.runkit7.setup; - &reference.runkit7.constants; - &reference.runkit7.reference; - - - - diff --git a/reference/runkit7/constants.xml b/reference/runkit7/constants.xml deleted file mode 100644 index cada4ac834..0000000000 --- a/reference/runkit7/constants.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - RUNKIT7_IMPORT_FUNCTIONS - (int) - - - - Le drapeau runkit7_import indique - que les fonctions normales doivent être importées du - fichier spécifié. - - - - - - RUNKIT7_IMPORT_CLASS_METHODS - (int) - - - - Le drapeau runkit7_import indique - que les méthodes de classe doivent être importées du - fichier spécifié. - - - - - - RUNKIT7_IMPORT_CLASS_CONSTS - (int) - - - - Le drapeau runkit7_import indique - que les constantes de classe doivent être importées du - fichier spécifié. - - - - - - RUNKIT7_IMPORT_CLASS_PROPS - (int) - - - - Le drapeau runkit7_import indique - que les propriétés de classe standard doivent être importées - du fichier spécifié. - - - - - - RUNKIT7_IMPORT_CLASS_STATIC_PROPS - (int) - - - - Le drapeau runkit7_import indique - que les propriétés statiques de classe doivent être importées - du fichier spécifié. Disponible depuis Runkit 1.0.1. - - - - - - RUNKIT7_IMPORT_CLASSES - (int) - - - - Le drapeau runkit7_import représente - un OU binaire des constantes RUNKIT7_IMPORT_CLASS_*. - - - - - - RUNKIT7_IMPORT_OVERRIDE - (int) - - - - Le drapeau runkit7_import indique que - si une des fonctions, méthodes, constantes, ou propriétés - importées existent déjà, elles doivent être remplacées par - les nouvelles définitions. Si ce drapeau n'est pas défini, - alors toutes les définitions importées qui existent déjà - seront ignorées. - - - - - - RUNKIT7_ACC_RETURN_REFERENCE - (int) - - - - Inclure ce drapeau pour faire en sorte que la fonction ou la méthode créée ou redéfinie retourne une référence. - - - - - - RUNKIT7_ACC_PUBLIC - (int) - - - - Le drapeau pour runkit7_method_add et runkit7_method_redefine pour rendre la méthode publique. - - - - - - RUNKIT7_ACC_PROTECTED - (int) - - - - Le drapeau pour runkit7_method_add et runkit7_method_redefine pour rendre la méthode protégée. - - - - - - RUNKIT7_ACC_PRIVATE - (int) - - - - Le drapeau pour runkit7_method_add et runkit7_method_redefine pour rendre la méthode privée. - - - - - - RUNKIT7_ACC_STATIC - (int) - - - - Le drapeau pour runkit7_method_add et runkit7_method_redefine pour rendre la méthode statique. - - - - - - RUNKIT7_FEATURE_MANIPULATION - (int) - - - - Égale à un si la manipulation en temps d'exécution est activée, et 0 sinon. - - - - - - RUNKIT7_FEATURE_SUPERGLOBALS - (int) - - - - Égale à 1 si les superglobales personnalisées sont activées, et 0 sinon. - - - - - - RUNKIT7_FEATURE_SANDBOX - (int) - - - - Toujours 0, il est impraticable d'implémenter la fonctionnalité de bac à sable en php 7. - - - - - - diff --git a/reference/runkit7/functions/runkit7-constant-add.xml b/reference/runkit7/functions/runkit7-constant-add.xml deleted file mode 100644 index 3158baf7b1..0000000000 --- a/reference/runkit7/functions/runkit7-constant-add.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - runkit7_constant_add - - Similaire à define(), mais permet de définir dans les définitions de classe également - - - - - &reftitle.description; - - boolrunkit7_constant_add - stringconstant_name - mixedvalue - intnewVisibility - - - - - &reftitle.parameters; - - - constant_name - - - Le nom de la constante à déclarer. Soit une chaîne pour indiquer une constante globale, - soit classname::constname pour indiquer une constante de classe. - - - - - value - - - NULL, Bool, Long, Double, String, Array, ou Resource à stocker dans la nouvelle constante. - - - - - newVisibility - - - La visibilité de la constante, pour les constantes de classe. Public par défaut. - L'une des constantes RUNKIT7_ACC_*. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - define - runkit7_constant_redefine - runkit7_constant_remove - - - - - diff --git a/reference/runkit7/functions/runkit7-constant-redefine.xml b/reference/runkit7/functions/runkit7-constant-redefine.xml deleted file mode 100644 index 0180634473..0000000000 --- a/reference/runkit7/functions/runkit7-constant-redefine.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - runkit7_constant_redefine - Redéfinit une constante déjà définie - - - - &reftitle.description; - - boolrunkit7_constant_redefine - stringconstant_name - mixedvalue - intnew_visibility - - - - - - - - &reftitle.parameters; - - - constant_name - - - La constante à redéfinir. Soit le nom d'une constante globale, - soit classname::constname indiquant une constante de classe. - - - - - value - - - La valeur à assigner à la constante. - - - - - new_visibility - - - La nouvelle visibilité de la constante, pour les constantes de classe. - Par défaut inchangé. - L'une des constantes RUNKIT7_ACC_*. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - runkit7_constant_add - runkit7_constant_remove - - - - - - diff --git a/reference/runkit7/functions/runkit7-constant-remove.xml b/reference/runkit7/functions/runkit7-constant-remove.xml deleted file mode 100644 index 3f54c99097..0000000000 --- a/reference/runkit7/functions/runkit7-constant-remove.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - runkit7_constant_remove - - Enlève/Supprime une constante déjà définie - - - - - &reftitle.description; - - boolrunkit7_constant_remove - stringconstant_name - - - - - &reftitle.parameters; - - - constant_name - - - Le nom de la constante à enlever. Soit le nom d'une constante globale, - soit classname::constname indiquant une constante de classe. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - define - runkit7_constant_add - runkit7_constant_redefine - - - - - - diff --git a/reference/runkit7/functions/runkit7-function-add.xml b/reference/runkit7/functions/runkit7-function-add.xml deleted file mode 100644 index 4ba5473ddb..0000000000 --- a/reference/runkit7/functions/runkit7-function-add.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - runkit7_function_add - - Ajoute une nouvelle fonction, similaire à create_function - - - - - &reftitle.description; - - boolrunkit7_function_add - stringfunction_name - stringargument_list - stringcode - boolreturn_by_reference&null; - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - boolrunkit7_function_add - stringfunction_name - Closureclosure - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - - - &reftitle.parameters; - - - function_name - - - Le nom de la fonction à créer - - - - - argument_list - - - La liste des arguments séparés par des virgules - - - - - code - - - Le code composant la fonction - - - - - closure - - - Une closure qui définit la fonction - - - - - return_by_reference - - - Si la fonction doit retourner par référence - - - - - doc_comment - - - Le commentaire de documentation de la fonction - - - - - return_type - - - Le type de retour de la fonction - - - - - is_strict - - - Si la fonction doit se comporter comme si elle était déclarée dans un fichier avec strict_types=1 - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Un exemple de <function>runkit7_function_add</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - create_function - runkit7_function_redefine - runkit7_function_copy - runkit7_function_rename - runkit7_function_remove - runkit7_method_add - - - - - - diff --git a/reference/runkit7/functions/runkit7-function-copy.xml b/reference/runkit7/functions/runkit7-function-copy.xml deleted file mode 100644 index f833cb652e..0000000000 --- a/reference/runkit7/functions/runkit7-function-copy.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - runkit7_function_copy - - Copie une fonction vers un nouveau nom de fonction - - - - - &reftitle.description; - - boolrunkit7_function_copy - stringsource_name - stringtarget_name - - - - - &reftitle.parameters; - - - source_name - - - Le nom de la fonction existante - - - - - target_name - - - Le nom de la nouvelle fonction vers laquelle copier la définition - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - &reftitle.examples; - - Un exemple de <function>runkit7_function_copy</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - runkit7_function_add - runkit7_function_redefine - runkit7_function_rename - runkit7_function_remove - - - - - diff --git a/reference/runkit7/functions/runkit7-function-redefine.xml b/reference/runkit7/functions/runkit7-function-redefine.xml deleted file mode 100644 index 3b3510f096..0000000000 --- a/reference/runkit7/functions/runkit7-function-redefine.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - runkit7_function_redefine - - Remplace une définition de fonction par une nouvelle implémentation - - - - - &reftitle.description; - - boolrunkit7_function_redefine - stringfunction_name - stringargument_list - stringcode - boolreturn_by_reference&null; - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - boolrunkit7_function_redefine - stringfunction_name - Closureclosure - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - ¬e.runkit.internal-override; - - - - - &reftitle.parameters; - - - function_name - - - Le nom de la fonction à redéfinir - - - - - argument_list - - - La nouvelle liste d'arguments à accepter par la fonction - - - - - code - - - Le code de la nouvelle implémentation - - - - - closure - - - Une closure qui définit la fonction - - - - - return_by_reference - - - Si la fonction doit retourner par référence - - - - - doc_comment - - - Le commentaire de documentation de la fonction - - - - - return_type - - - Le type de retour de la fonction - - - - - is_strict - - - Si la fonction se comporte comme si elle était déclarée dans un fichier avec strict_types=1 - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Un exemple de <function>runkit7_function_redefine</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - runkit7_function_add - runkit7_function_copy - runkit7_function_rename - runkit7_function_remove - runkit7_method_redefine - - - - - diff --git a/reference/runkit7/functions/runkit7-function-remove.xml b/reference/runkit7/functions/runkit7-function-remove.xml deleted file mode 100644 index af73429489..0000000000 --- a/reference/runkit7/functions/runkit7-function-remove.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - runkit7_function_remove - - Supprime une définition de fonction - - - - - &reftitle.description; - - boolrunkit7_function_remove - stringfunction_name - - - ¬e.runkit.internal-override; - - - - - &reftitle.parameters; - - - function_name - - - Le nom de la fonction à supprimer - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - runkit7_function_add - runkit7_function_copy - runkit7_function_redefine - runkit7_function_rename - - - - - - diff --git a/reference/runkit7/functions/runkit7-function-rename.xml b/reference/runkit7/functions/runkit7-function-rename.xml deleted file mode 100644 index 8fb63a8e75..0000000000 --- a/reference/runkit7/functions/runkit7-function-rename.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - runkit7_function_rename - - Change un nom de fonction - - - - - &reftitle.description; - - boolrunkit7_function_rename - stringsource_name - stringtarget_name - - - ¬e.runkit.internal-override; - - - - - &reftitle.parameters; - - - source_name - - - Le nom de la fonction existante - - - - - target_name - - - Le nouveau nom de la fonction - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - runkit7_function_add - runkit7_function_copy - runkit7_function_redefine - runkit7_function_remove - - - - - - diff --git a/reference/runkit7/functions/runkit7-import.xml b/reference/runkit7/functions/runkit7-import.xml deleted file mode 100644 index 3a50df4b68..0000000000 --- a/reference/runkit7/functions/runkit7-import.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - runkit7_import - - Procède à l'importation d'un fichier PHP en important les définitions de fonctions et de classes, en les écrasant si nécessaire - - - - - - Cette fonctionnalité a été supprimée dans PECL runkit7 4.0.0. - - - - - &reftitle.description; - - boolrunkit7_import - stringfilename - intflags - - - Similaire à include. Cependant, tout code se trouvant en dehors - d'une fonction ou d'une classe est simplement ignoré. - De plus, en fonction de la valeur de flags, - toute fonction ou classe déjà existante dans l'environnement d'exécution actuel - peut être automatiquement écrasée par ses nouvelles définitions. - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier à partir duquel importer les définitions de fonctions et de classes - - - - - flags - - - Une opération bit à bit OU de la famille de constantes - RUNKIT7_IMPORT_*. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/runkit7/functions/runkit7-method-add.xml b/reference/runkit7/functions/runkit7-method-add.xml deleted file mode 100644 index 36a4419516..0000000000 --- a/reference/runkit7/functions/runkit7-method-add.xml +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - runkit7_method_add - Ajoute dynamiquement une nouvelle méthode à une classe donnée - - - - &reftitle.description; - - boolrunkit7_method_add - stringclass_name - stringmethod_name - stringargument_list - stringcode - intflagsRUNKIT7_ACC_PUBLIC - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - boolrunkit7_method_add - stringclass_name - stringmethod_name - Closureclosure - intflagsRUNKIT7_ACC_PUBLIC - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - - &reftitle.parameters; - - - class_name - - - La classe à laquelle cette méthode sera ajoutée - - - - - method_name - - - Le nom de la méthode à ajouter - - - - - argument_list - - - La liste des arguments séparés par des virgules pour la nouvelle méthode - - - - - code - - - Le code à évaluer lorsque method_name - est appelé - - - - - closure - - - Une closure qui définit la méthode. - - - - - flags - - - Le type de méthode à créer, peut être - RUNKIT7_ACC_PUBLIC, - RUNKIT7_ACC_PROTECTED ou - RUNKIT7_ACC_PRIVATE optionnellement combiné via une opération bit à bit OU avec - RUNKIT7_ACC_STATIC - - - - - doc_comment - - - Le commentaire de documentation de la méthode. - - - - - return_type - - - Le type de retour de la méthode. - - - - - - is_strict - - - Si la méthode se comporte comme si elle était déclarée dans un fichier avec strict_types=1 - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - &reftitle.examples; - - Exemple de <function>runkit7_method_add</function> - -add(12, 4); -?> -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_copy - runkit7_method_redefine - runkit7_method_remove - runkit7_method_rename - runkit7_function_add - - - - diff --git a/reference/runkit7/functions/runkit7-method-copy.xml b/reference/runkit7/functions/runkit7-method-copy.xml deleted file mode 100644 index 5cd63db223..0000000000 --- a/reference/runkit7/functions/runkit7-method-copy.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - runkit7_method_copy - Copie une méthode d'une classe vers une autre - - - - &reftitle.description; - - boolrunkit7_method_copy - stringdestination_class - stringdestination_method_name - stringsource_class - stringsource_method_name - - - - - &reftitle.parameters; - - - destination_class - - - La classe de destination pour la méthode copiée - - - - - destination_method_name - - - Le nom de la méthode de destination - - - - - source_class - - - La classe source de la méthode à copier - - - - - source_method_name - - - Le nom de la méthode à copier de la classe source. Si ce paramètre est - omis la valeur de destination_method_name est supposée. - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>runkit7_method_copy</function> - - -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_add - runkit7_method_redefine - runkit7_method_remove - runkit7_method_rename - runkit7_function_copy - - - - - diff --git a/reference/runkit7/functions/runkit7-method-redefine.xml b/reference/runkit7/functions/runkit7-method-redefine.xml deleted file mode 100644 index ec871f525f..0000000000 --- a/reference/runkit7/functions/runkit7-method-redefine.xml +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - runkit7_method_redefine - Change dynamiquement le code de la méthode donnée - - - - &reftitle.description; - - boolrunkit7_method_redefine - stringclass_name - stringmethod_name - stringargument_list - stringcode - intflagsRUNKIT7_ACC_PUBLIC - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - boolrunkit7_method_redefine - stringclass_name - stringmethod_name - Closureclosure - intflagsRUNKIT7_ACC_PUBLIC - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - - - &reftitle.parameters; - - - class_name - - - La classe dans laquelle redéfinir la méthode - - - - - method_name - - - Le nom de la méthode à redéfinir - - - - - argument_list - - - La liste des arguments séparés par des virgules pour la méthode redéfinie - - - - - code - - - Le nouveau code à évaluer lorsque method_name - est appelé - - - - - closure - - - Une closure qui définit la méthode. - - - - - flags - - - La méthode redéfinie peut être - RUNKIT7_ACC_PUBLIC, - RUNKIT7_ACC_PROTECTED ou - RUNKIT7_ACC_PRIVATE optionnellement combiné via une opération bit à bit OU avec - RUNKIT7_ACC_STATIC - - - - - doc_comment - - - Le commentaire de documentation de la méthode. - - - - - return_type - - - Le type de retour de la méthode. - - - - - is_strict - - - Si la méthode se comporte comme si elle était déclarée dans un fichier avec strict_types=1 - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple de <function>runkit7_method_redefine</function> - -foo(); - -// Redéfinit la méthode 'foo' -runkit7_method_redefine( - 'Example', - 'foo', - '', - 'return "bar!\n";', - RUNKIT7_ACC_PUBLIC -); - -// affiche Example::foo() (après la redéfinition) -echo "After: " . $e->foo(); -?> -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_add - runkit7_method_copy - runkit7_method_remove - runkit7_method_rename - runkit7_function_redefine - - - - - diff --git a/reference/runkit7/functions/runkit7-method-remove.xml b/reference/runkit7/functions/runkit7-method-remove.xml deleted file mode 100644 index 1c8fd3933b..0000000000 --- a/reference/runkit7/functions/runkit7-method-remove.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - runkit7_method_remove - Supprime dynamiquement la méthode donnée - - - - &reftitle.description; - - boolrunkit7_method_remove - stringclass_name - stringmethod_name - - ¬e.runkit.selfmanipulation; - - - - &reftitle.parameters; - - - class_name - - - La classe dans laquelle supprimer la méthode - - - - - method_name - - - Le nom de la méthode à supprimer - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Exemple de <function>runkit7_method_remove</function> - - -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_add - runkit7_method_copy - runkit7_method_redefine - runkit7_method_rename - runkit7_function_remove - - - - - - diff --git a/reference/runkit7/functions/runkit7-method-rename.xml b/reference/runkit7/functions/runkit7-method-rename.xml deleted file mode 100644 index 6434a7ff0a..0000000000 --- a/reference/runkit7/functions/runkit7-method-rename.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - runkit7_method_rename - Change dynamiquement le nom de la méthode donnée - - - - &reftitle.description; - - boolrunkit7_method_rename - stringclass_name - stringsource_method_name - stringtarget_method_name - - ¬e.runkit.selfmanipulation; - - - - &reftitle.parameters; - - - class_name - - - La classe dans laquelle renommer la méthode - - - - - source_method_name - - - Le nom de la méthode à renommer - - - - - target_method_name - - - Le nouveau nom à donner à la méthode renommée - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Exemple de <function>runkit7_method_rename</function> - -bar(); -?> -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_add - runkit7_method_copy - runkit7_method_redefine - runkit7_method_remove - runkit7_function_rename - - - - diff --git a/reference/runkit7/functions/runkit7-object-id.xml b/reference/runkit7/functions/runkit7-object-id.xml deleted file mode 100644 index cdd8b4a720..0000000000 --- a/reference/runkit7/functions/runkit7-object-id.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - runkit7_object_id - - Renvoie l'identifiant d'objet pour un objet donné - - - - - &reftitle.description; - - intrunkit7_object_id - objectobj - - - Cette fonction est équivalente à spl_object_id. - - - Cette fonction renvoie un identifiant unique pour l'objet. L'identifiant - d'objet est unique pour la durée de vie de l'objet. Une fois l'objet - détruit, son identifiant peut être réutilisé pour d'autres objets. Ce - comportement est similaire à spl_object_hash. - - - - - &reftitle.parameters; - - - obj - - - Un objet quelconque. - - - - - - - - &reftitle.returnvalues; - - Un identifiant entier qui est unique pour chaque objet actuellement existant - et est toujours le même pour chaque objet. - - - - - &reftitle.notes; - - - Lorsqu'un objet est détruit, son identifiant peut être réutilisé pour d'autres objets. - - - - - &reftitle.seealso; - - spl_object_id - - - - diff --git a/reference/runkit7/functions/runkit7-superglobals.xml b/reference/runkit7/functions/runkit7-superglobals.xml deleted file mode 100644 index 069bc2711b..0000000000 --- a/reference/runkit7/functions/runkit7-superglobals.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - runkit7_superglobals - - Renvoie un tableau indexé numériquement des superglobales enregistrées - - - - - &reftitle.description; - - arrayrunkit7_superglobals - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un tableau indexé numériquement des superglobales enregistrées. - c'est-à-dire _GET, _POST, _REQUEST, _COOKIE, _SESSION, _SERVER, _ENV, _FILES - - - - - &reftitle.seealso; - - Variable Scope - - - - - diff --git a/reference/runkit7/functions/runkit7-zval-inspect.xml b/reference/runkit7/functions/runkit7-zval-inspect.xml deleted file mode 100644 index db90940c0e..0000000000 --- a/reference/runkit7/functions/runkit7-zval-inspect.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - runkit7_zval_inspect - Renvoie des informations sur la valeur passée avec les types de données, les comptes de référence, etc - - - - &reftitle.description; - - arrayrunkit7_zval_inspect - stringvalue - - - - - &reftitle.parameters; - - - value - - - La valeur pour laquelle renvoyer la représentation - - - - - - - - &reftitle.returnvalues; - - Le tableau retourné par cette fonction contient les éléments suivants : - - address - refcount (optionnel) - is_ref (optionnel) - type - - - - - - &reftitle.examples; - - Exemple de <function>runkit7_zval_inspect</function> - - -]]> - - &example.outputs; - - - string(14) "0x7f45ab21b1e0" - ["refcount"]=> - int(2) - ["is_ref"]=> - bool(false) - ["type"]=> - int(8) -} - -array(2) { - ["address"]=> - string(14) "0x7f45ab21b1e0" - ["type"]=> - int(4) -} -]]> - - - - - - &reftitle.seealso; - - References Explained - References Explained (by Derick Rethans) - - - - diff --git a/reference/runkit7/ini.xml b/reference/runkit7/ini.xml deleted file mode 100644 index a0ceac6406..0000000000 --- a/reference/runkit7/ini.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Options de configuration de Runkit - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - runkit.superglobal - "" - INI_PERDIR - - - - runkit.internal_override - "0" - INI_SYSTEM - - - - -
    - &ini.php.constants; -     - - &ini.descriptions.title; - - - - - runkit.superglobal - string - - - - Une liste séparée par des virgules de noms de variables à traiter comme des superglobales. - Cette valeur doit être définie dans le fichier php.ini du système, mais peut fonctionner - dans des contextes de configuration perdir en fonction du SAPI. - - - Superglobales personnalisées avec runkit.superglobal=_FOO,_BAR dans php.ini - - -]]> - - - - - - - - runkit.internal_override - bool - - - - Active la possibilité de modifier/renommer/supprimer des fonctions internes. - - - - - -
    - diff --git a/reference/runkit7/reference.xml b/reference/runkit7/reference.xml deleted file mode 100644 index 2e7154ecee..0000000000 --- a/reference/runkit7/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; de runkit7 - - &reference.runkit7.entities.functions; - - - - diff --git a/reference/runkit7/setup.xml b/reference/runkit7/setup.xml deleted file mode 100644 index cf499791f8..0000000000 --- a/reference/runkit7/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Modifier les constantes, fonctions, classes et méthodes - ainsi que les superglobales personnalisées - fonctionne avec toutes les versions de PHP 7. Aucune exigence - spéciale n'est nécessaire. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;runkit7. - - - &pecl.windows.download.avail; - -
    - - &reference.runkit7.ini; - -     - diff --git a/reference/scoutapm/book.xml b/reference/scoutapm/book.xml deleted file mode 100644 index 102e8e5a3f..0000000000 --- a/reference/scoutapm/book.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - ScoutAPM - ScoutAPM - - - &reftitle.intro; - ¬e.no-windows.extension; - - L'extension ScoutAPM fournit des fonctionnalités supplémentaires pour la - surveillance des applications par rapport à l'utilisation de la bibliothèque de l'espace utilisateur PHP de base. - - - - &reference.scoutapm.setup; - &reference.scoutapm.reference; - - - diff --git a/reference/scoutapm/configure.xml b/reference/scoutapm/configure.xml deleted file mode 100644 index 1039e0a69f..0000000000 --- a/reference/scoutapm/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;scoutapm - - - -
    - diff --git a/reference/scoutapm/functions/scoutapm-get-calls.xml b/reference/scoutapm/functions/scoutapm-get-calls.xml deleted file mode 100644 index 67477234b4..0000000000 --- a/reference/scoutapm/functions/scoutapm-get-calls.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - scoutapm_get_calls - Renvoie une liste d'appels instrumentés qui se sont produits - - - - &reftitle.description; - - arrayscoutapm_get_calls - - - Renvoie une liste de tous les appels de fonctions instrumentées enregistrés depuis la dernière fois que la fonction scoutapm_get_calls a été appelée. La liste est effacée à chaque fois que la fonction est appelée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - scoutapm_get_calls renvoie un tableau contenant une liste - de tous les appels enregistrés aux appels de fonctions instrumentées. - - - - - &reftitle.examples; - Récupérer les appels instrumentés - - -]]> - - &example.outputs.similar; - - Array - ( - [function] => file_get_contents - [entered] => 1576839727.7934 - [exited] => 1576839727.7935 - [time_taken] => 2.7894973754883E-5 - [argv] => Array - ( - [0] => a.txt - ) - - ) - - [1] => Array - ( - [function] => file_get_contents - [entered] => 1576839727.7935 - [exited] => 1576839727.7935 - [time_taken] => 7.8678131103516E-6 - [argv] => Array - ( - [0] => b.txt - ) - - ) - -) -]]> - - - - - - - diff --git a/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml b/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml deleted file mode 100644 index 85ba670166..0000000000 --- a/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - scoutapm_list_instrumented_functions - Liste les fonctions que scoutapm va instrumenter. - - - - &reftitle.description; - - arrayscoutapm_list_instrumented_functions - - - Renvoie une liste des fonctions que l'extension va instrumenter. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - scoutapm_list_instrumented_functions renvoie un tableau - contenant une liste de toutes les fonctions que l'extension scoutapm est capable - d'instrumenter dans l'installation actuelle. - - - - - &reftitle.examples; - Récupérer la liste des fonctions que scoutapm va instrumenter - - -]]> - - &example.outputs.similar; - - file_get_contents - [1] => file_put_contents - [2] => fopen - [3] => fread - [4] => fwrite - [5] => pdo->exec - [6] => pdo->query - [7] => pdo->prepare - [8] => pdostatement->execute -) -]]> - - - - - - - diff --git a/reference/scoutapm/reference.xml b/reference/scoutapm/reference.xml deleted file mode 100644 index 99eecb751c..0000000000 --- a/reference/scoutapm/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; de Scoutapm - - &reference.scoutapm.entities.functions; - - - - diff --git a/reference/scoutapm/setup.xml b/reference/scoutapm/setup.xml deleted file mode 100644 index 95e61d1bf7..0000000000 --- a/reference/scoutapm/setup.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - - PHP >= 7.1.0 - - - Windows n'est pas actuellement pris en charge - - -
    - -
    - &reftitle.install; - - Cette extension est disponible sur PECL. Exécuter : - - - - Il faudra peut-être ajouter Scout au php.ini, par exemple : - - - - -
    - -     - diff --git a/reference/seaslog/book.xml b/reference/seaslog/book.xml deleted file mode 100644 index d53f609224..0000000000 --- a/reference/seaslog/book.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Seaslog - Seaslog - - - &reftitle.intro; - - Seaslog est une extension de journalisation efficace, rapide et stable pour PHP. - - - Le journal, qui est généralement le journal d'exploitation du système, - du logiciel et de l'application. - À travers l'analyse du journal, il peut faciliter les utilisateurs à comprendre le fonctionnement du système, - du logiciel et de l'application. - Si le journal d'application est assez riche, - il peut également analyser le comportement opérationnel de l'utilisateur précédent, le type, - la distribution régionale ou d'autres informations plus. - Le journal d'application indique également les multiples niveaux en même temps, - il est possible de facilement obtenir l'analyse de l'état de santé de l'application, - trouver rapidement les problèmes et les localiser rapidement, et résoudre le problème, remédier à la perte. - - - L'erreur_log, la fonction syslog qui est intégrée dans PHP est puissante et a une excellente performance, - mais en raison de divers défauts (error_log n'a pas de niveau d'erreur, pas de format fixe, syslog indépendamment du module, - et se mélange avec le journal système), réduisant beaucoup de flexibilité, et ne peut pas répondre aux exigences de l'application. - - - La bonne nouvelle est qu'il existe un certain nombre de bibliothèques de classes de journalisation tierces établies - pour compenser les défauts, telles que log4php, plog, monolog (bien sûr, - il y a de nombreuses applications dans le développement de projet de la classe de journal). - - - Donc il y a un journal de bibliothèques répondant aux exigences suivantes: - - Modules, classification - Configuration simple (de préférence sans configuration) - Format de journal clair et facile à comprendre - Application simple et bonne performance - - Seaslog répond à ces demandes. - - - Ce qui est fourni actuellement: - - Dans le projet PHP, enregistrer la spécification du journal et repidly. - Configurer le répertoire de journal par défaut et le module - Répertoire de journal spécifié et capture de la configuration actuelle - Analyse préliminaire du cadre d'alerte précoce - Tampon de journal efficace et débogage de tampon pratique - Suivre la spécification de l'interface de journal PSR-3 - Enregistrer automatiquement les informations d'erreur - Enregistrer automatiquement les informations anormales - Support Connectez le port TCP, envoyez avec RFC5424 - Support Connectez le port UDP, envoyez avec RFC5424 - Support RequestId différencie les demandes - Support pour les personnalisations de modèle de journal - - - - Voir plus Document SeasLog sur Github. - - - - &reference.seaslog.setup; - &reference.seaslog.constants; - &reference.seaslog.examples; - &reference.seaslog.reference; - &reference.seaslog.seaslog; - - - diff --git a/reference/seaslog/configure.xml b/reference/seaslog/configure.xml deleted file mode 100644 index 81cd477906..0000000000 --- a/reference/seaslog/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;seaslog - - - -
    - diff --git a/reference/seaslog/constants.xml b/reference/seaslog/constants.xml deleted file mode 100644 index 32ca2304a8..0000000000 --- a/reference/seaslog/constants.xml +++ /dev/null @@ -1,269 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - SEASLOG_VERSION - (string) - - - - - - - - - SEASLOG_AUTHOR - (string) - - - - - - - - - SEASLOG_ALL - (string) - - - - "ALL" - - - - - - SEASLOG_DEBUG - (string) - - - - "DEBUG" - Informations de débogage détaillées.Informations détaillées sur les événements. - - - - - - SEASLOG_INFO - (string) - - - - "INFO" - Événements intéressants.Emphase sur le processus d'exécution de l'application. - - - - - - SEASLOG_NOTICE - (string) - - - - "NOTICE" - Événements normaux mais significatifs.Informations plus importantes que le niveau INFO pendant l'exécution. - - - - - - SEASLOG_WARNING - (string) - - - - "WARNING" - Occurrences exceptionnelles qui ne sont pas des erreurs.Informations aberrantes potentielles qui nécessitent une attention et doivent être réparées. - - - - - - SEASLOG_ERROR - (string) - - - - "ERROR" - Erreurs de fonctionnement qui ne nécessitent pas d'action immédiate mais qui devraient typiquement en nécessiter. - - - - - - SEASLOG_CRITICAL - (string) - - - - "CRITICAL" - Conditions critiques.Nécessite une réparation immédiate, et le composant du programme est indisponible. - - - - - - SEASLOG_ALERT - (string) - - - - "ALERT" - Action doit être prise immédiatement.Attention immédiate doit être accordée au personnel concerné pour les réparations d'urgence. - - - - - - SEASLOG_EMERGENCY - (string) - - - - "EMERGENCY" - Système inutilisable. - - - - - - SEASLOG_DETAIL_ORDER_ASC - (int) - - - - 1 - - - - - - SEASLOG_DETAIL_ORDER_DESC - (int) - - - - 2 - - - - - - SEASLOG_APPENDER_FILE - (int) - - - - 1 - - - - - - SEASLOG_APPENDER_TCP - (int) - - - - 2 - - - - - - SEASLOG_APPENDER_UDP - (int) - - - - 3 - - - - - - SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALL - (int) - - - - 1 - - - - - - SEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN - (int) - - - - 2 - - - - - - SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT - (int) - - - - 1 - - - - - - SEASLOG_REQUEST_VARIABLE_REQUEST_URI - (int) - - - - 2 - - - - - - SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD - (int) - - - - 3 - - - - - - SEASLOG_REQUEST_VARIABLE_CLIENT_IP - (int) - - - - 4 - - - - - - diff --git a/reference/seaslog/examples.xml b/reference/seaslog/examples.xml deleted file mode 100644 index bbf50e47ab..0000000000 --- a/reference/seaslog/examples.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - - - &reftitle.examples; - - - Obtenir et définir le chemin de base - - -]]> - - &example.outputs.similar; - - - - - - - Obtenir et définir le journal - - -]]> - - &example.outputs.similar; - - - - - - - Journal d'écriture rapide - - 'neeke')); -SeasLog::info('this is a info log'); -SeasLog::notice('this is a notice log'); -SeasLog::warning('your {website} was down,please {action} it ASAP!',array('{website}' => 'github.com','{action}' => 'rboot')); -SeasLog::error('a error log'); -SeasLog::critical('some thing was critical'); -SeasLog::alert('yes this is a {messageName}',array('{messageName}' => 'alertMSG')); -SeasLog::emergency('Just now, the house next door was completely burnt out! {note}',array('{note}' => 'it`s a joke')); -?> -]]> - - - Par défaut, seaslog.default_template = "%T | %L | %P | %Q | %t | %M". - Cela signifie que, par défaut, le style de l'enregistrement du journal est: `{dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo}`. - - &example.outputs.similar; - - seaslog.appender = 1 - - - - - &example.outputs.similar; - - seaslog.appender = 2 ou seaslog.appender = 3 - - -1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | DEBUG | 21423 | 599157af4e937 | 1466787583.322 | this is a neeke debug -<14>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | INFO | 21423 | 599157af4e937 | 1466787583.323 | this is a info log -<13>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | NOTICE | 21423 | 599157af4e937 | 1466787583.324 | this is a notice log -]]> - - - - - Compter rapidement certains types de valeurs de journal - - SeasLog récupère le compte de la valeur `grep -wc` en utilisant le tube système et la renvoie à PHP (tableau ou entier). - - - -]]> - - &example.outputs.similar; - - - int(3) - ["INFO"]=> - int(3) - ["NOTICE"]=> - int(3) - ["WARNING"]=> - int(3) - ["ERROR"]=> - int(6) - ["CRITICAL"]=> - int(3) - ["ALERT"]=> - int(3) - ["EMERGENCY"]=> - int(3) -} -int(7) -int(1) -]]> - - - - - Obtenir quelques types de liste de journaux - - SeasLog récupère la liste des valeurs de `grep -w` en utilisant le tube système et la renvoie à PHP. - - - -]]> - - &example.outputs.similar; - - - string(83) "2014-02-24 00:14:02 | ERROR | 8568 | 599157af4e937 | 1393172042.717 | test error 3 " - [1] => - string(83) "2014-02-24 00:14:04 | ERROR | 8594 | 5991576584446 | 1393172044.104 | test error 3 " - [2] => - string(83) "2014-02-24 00:14:04 | ERROR | 8620 | 1502697015147 | 1393172044.862 | test error 3 " - [3] => - string(83) "2014-02-24 00:14:05 | ERROR | 8646 | 599159975a9ff | 1393172045.989 | test error 3 " - [4] => - string(83) "2014-02-24 00:14:07 | ERROR | 8672 | 599159986ec28 | 1393172047.882 | test error 3 " - [5] => - string(83) "2014-02-24 00:14:08 | ERROR | 8698 | 5991599981cec | 1393172048.736 | test error 3 " -} - -array(2) { - [0] => - string(83) "2014-02-24 00:14:02 | ERROR | 8568 | 599157af4e937 | 1393172042.717 | test error 3 " - [1] => - string(83) "2014-02-24 00:14:04 | ERROR | 8594 | 5991576584446 | 1393172044.104 | test error 3 " -} -]]> - - - - - diff --git a/reference/seaslog/functions/seaslog-get-author.xml b/reference/seaslog/functions/seaslog-get-author.xml deleted file mode 100644 index 309bd3d288..0000000000 --- a/reference/seaslog/functions/seaslog-get-author.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - seaslog_get_author - Renvoie l'auteur de SeasLog. - - - - &reftitle.description; - - stringseaslog_get_author - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'auteur de SeasLog en tant que chaîne. - - - - - &reftitle.examples; - - Exemple de <function>seaslog_get_author</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/seaslog/functions/seaslog-get-version.xml b/reference/seaslog/functions/seaslog-get-version.xml deleted file mode 100644 index a0c1981ce3..0000000000 --- a/reference/seaslog/functions/seaslog-get-version.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - seaslog_get_version - Renvoie la version de SeasLog. - - - - &reftitle.description; - - stringseaslog_get_version - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la version de SeasLog (SEASLOG_VERSION) en tant que chaîne. - - - - - &reftitle.examples; - - Exemple de <function>seaslog_get_version</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/seaslog/ini.xml b/reference/seaslog/ini.xml deleted file mode 100644 index c026daf615..0000000000 --- a/reference/seaslog/ini.xml +++ /dev/null @@ -1,629 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - &ConfigureOptions; de Seaslog - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - seaslog.appender - 1 - INI_SYSTEM - - - - seaslog.appender_retry - 0 - INI_ALL - - - - seaslog.level - 8 - INI_ALL - - - - seaslog.remote_host - 127.0.0.1 - INI_ALL - - - - seaslog.remote_port - 514 - INI_ALL - - - - seaslog.remote_timeout - 1 - INI_SYSTEM - - - - seaslog.default_basepath - /var/log/www - INI_SYSTEM - - - - seaslog.default_logger - default - INI_SYSTEM - - - - seaslog.default_template - %T | %L | %P | %Q | %t | %M - INI_SYSTEM - - - - seaslog.default_datetime_format - Y-m-d H:i:s - INI_SYSTEM - - - - seaslog.trace_error - 1 - INI_ALL - - - - seaslog.trace_exception - 0 - INI_SYSTEM - - - - seaslog.trace_notice - 0 - INI_ALL - - - - seaslog.trace_warning - 0 - INI_ALL - - - - seaslog.use_buffer - 0 - INI_SYSTEM - - - - seaslog.buffer_size - 0 - INI_ALL - - - - seaslog.buffer_disabled_in_cli - 0 - INI_SYSTEM - - - - seaslog.disting_type - 0 - INI_SYSTEM - - - - seaslog.disting_folder - 1 - INI_SYSTEM - - - - seaslog.disting_by_hour - 0 - INI_SYSTEM - - - - seaslog.recall_depth - 0 - INI_ALL - - - - seaslog.trim_wrap - 0 - INI_ALL - - - - seaslog.ignore_warning - 1 - INI_ALL - - - - seaslog.throw_exception - 1 - INI_ALL - - - - -
    - - &ini.descriptions.title; - - - - - seaslog.appender - int - - - - Change le magasin de données du journal. 1Fichier 2TCP 3UDP (Changer par défaut 1) - - - Seaslog va envoyer le journal à tcp://remote_host:remote_port ou udp://remote_host:remote_port serveur, - lorsque seaslog.appender est configuré à 2 (TCP) ou 3 (UDP). - - - Lorsque SeasLog envoie un journal à TCP/UDP, le style suit la RFC5424. - Le {logInfo} est affecté par seaslog.default_template. - - - 1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | DEBUG | 21423 | 599157af4e937 | 1466787583.322 | this is a neeke debug -<14>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | INFO | 21423 | 599157af4e937 | 1466787583.323 | this is a info log -<13>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | NOTICE | 21423 | 599157af4e937 | 1466787583.324 | this is a notice log - ]]> - - - - - - seaslog.appender_retry - int - - - - Le compte de réessayage de l'enregistrement du journal. - 0 (Ne pas réessayer) - - - - - - seaslog.buffer_disabled_in_cli - int - - - - Désactive le tampon dans le CLI. 1-Y 0-N (Par défaut) - - - Activer le commutateur buffer_disabled_in_cli. - Le commutateur buffer_disabled_in_cli par défaut est désactivé. - Si le commutateur buffer_disabled_in_cli est activé et que l'on exécute en CLI, - le paramètre seaslog.use_buffer sera ignoré, - Seaslog écrira IMMÉDIATEMENT dans le magasin de données. - - - - - - seaslog.buffer_size - int - - - - Configure la taille du tampon avec 100. - La taille du tampon par défaut 0, cela signifie ne pas utiliser de tampon. - Si buffer_size > 0, SeasLog réécrira vers le bas dans le magasin de données - lorsque le journal préenregistré en mémoire est >= à cette buffer_size, puis rafraîchira le pool de mémoire. - - - - - - seaslog.default_basepath - string - - - - Le chemin de base du journal par défaut. Par défaut "/var/log/www". - - - - - - seaslog.default_datetime_format - string - - - - Le format de la date et de l'heure. Par défaut "Y-m-d H:i:s". - - - - - - seaslog.default_logger - string - - - - Le chemin du journal par défaut. Par défaut "default". - - - - - - seaslog.disting_by_hour - int - - - - Le commutateur utilise le journal avec l'heure. 1-Y 0-N (Par défaut) - - - - seaslog.disting_by_hour = 1 Le commutateur utilise Logger DisTing par heure. - Cela signifie que SeasLog créera le fichier chaque heure. - - - - - - - seaslog.disting_folder - int - - - - Le commutateur utilise le journal avec le dossier. 1-Y (Par défaut) 0-N - - - - seaslog.disting_folder = 1 Le commutateur utilise Logger DisTing par dossier. - Cela signifie que SeasLog créera le fichier deistic par dossier, - et lorsque cette configuration est désactivée, SeasLog créera le fichier - utiliser le connecteur de soulignement Logger et Time comme default_20180211.log. - - - - - - - seaslog.disting_type - int - - - - Le commutateur utilise le journal avec le type. 1-Y 0-N (Par défaut) - - - - seaslog.disting_type = 1 Le commutateur utilise Logger DisTing par type, - cela signifie que SeasLog créera le fichier deistic info\warn\error et l'autre type. - - - - - - - seaslog.ignore_warning - int - - - - Le commutateur ignore les avertissements de SeasLog. 1-On (Par défaut) 0-Off - - - - seaslog.ignore_warning = 1 Ouvrir un avertissement pour ignorer SeasLog lui-même. - Lorsque les autorisations de répertoire ou les ports de serveur de réception sont bloqués, ils sont ignorés; - lorsqu'ils sont fermés, un avertissement est levé. - - - - - - - seaslog.level - int - - - - Le niveau de journalisation. Par défaut 8 (Tous). - 0-EMERGENCY 1-ALERT 2-CRITICAL 3-ERROR 4-WARNING 5-NOTICE 6-INFO 7-DEBUG 8-TOUS - - - - Astuce: L'élément de configuration a changé depuis la version 1.7.0. - Avant la version 1.7.0, plus la valeur est petite, plus les journaux sont pris en fonction du niveau: - 0-tous 1-débogage 2-info 3-avis 4-avertissement 5-erreur 6-critique 7-alerte 8-urgence - Avant la version 1.7.0, par défaut 0 (Tous). - - - - - - - seaslog.recall_depth - int - - - - La profondeur de rappel de la fonction. Cela affectera la variable LineNo dans %F. - Par défaut 0 - - - - - - seaslog.remote_host - string - - - - Lors de l'utilisation de Record TCP ou UDP, configurez cet hôte distant. Par défaut "127.0.0.1" - - - - - - seaslog.remote_port - int - - - - Lors de l'utilisation de Record TCP ou UDP, configurez ce port distant. Par défaut 514 - - - - - - seaslog.remote_timeout - int - - - - Lors de l'utilisation de Record TCP ou UDP, configurez ce délai distant. Par défaut 1 seconde - - - - - - seaslog.throw_exception - int - - - - Le commutateur lance l'exception SeasLog. 1-On (Par défaut) 0-Off - - - - seaslog.throw_exception = 1 Ouvrir une exception qui lance le SeasLog pour se jeter lui-même. - Lorsque les autorisations de répertoire ou les ports de serveur de réception sont bloqués, - levez une exception; ne levez pas d'exception lorsqu'ils sont fermés. - - - - - - - seaslog.trace_error - int - - - - Automatiquement enregistrer l'erreur finale avec le journal par défaut. 1-Y (Par défaut) 0-N - - - - - - seaslog.trace_exception - int - - - - Automatiquement enregistrer l'exception avec le journal par défaut. 1-Y 0-N (Par défaut) - - - - - - seaslog.trace_notice - int - - - - Automatiquement enregistrer notice avec le journal par défaut. 1-Y 0-N (Par défaut) - - - - - - seaslog.trace_warning - int - - - - Automatiquement enregistrer l'avertissement avec le journal par défaut. 1-Y 0-N (Par défaut) - - - - - - seaslog.trim_wrap - int - - - - Rogner les \n et \r dans le message du journal. 1-On 0-Off (Par défaut) - - - - - - seaslog.use_buffer - int - - - - Le commutateur utilise le tampon du journal avec la mémoire. 1-Y 0-N (Par défaut) - - - - seaslog.use_buffer = 1 Active le commutateur use_buffer. - Le commutateur use_buffer par défaut est désactivé. - Si le commutateur use_buffer est activé, SeasLog préenregistre le journal avec la mémoire, - et ils seront réécrits dans le magasin de données par demande d'arrêt - ou sortie du processus php (PHP RSHUTDOWN ou PHP MSHUTDOWN). - - - - - - - seaslog.default_template - string - - - - Le modèle de journal par défaut. - Par défaut "%T | %L | %P | %Q | %t | %M". - - - - Les variables par défaut suivantes sont fournies, - qui peuvent être utilisées directement dans le modèle de journal et remplacées par une valeur correspondante - lorsque le journal est finalement généré. - - - Le modèle de journal par défaut est: seaslog.default_template = "%T | %L | %P | %Q | %t | %M", - cela signifie que le style de journal par défaut est: {dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo} - - - Si l'on a un modèle de journal personnalisé, tel que: seaslog.default_template = "[%T]:%L %P %Q %t %M", - cela signifiera que le style de journal a été personnalisé comme: [{dateTime}]:{level} {pid} {uniqid} {timeStamp} {logInfo} - - - Tableau des variables par défaut de Seaslog - - - - Nom de variable - Description - - - - - %L - Niveau. - - - %M - Message. - - - %T - Date et heure. Tel que 2017-08-16 19:15:02, affecté par seaslog.default_datetime_format. - - - %t - Horodatage. Tel que 1502882102.862, précis à la milliseconde. - - - %Q - L'identifiant de requête. Pour distinguer une seule requête, - ne pas invoquer la fonction SeasLog::setRequestId($string), - la valeur unique générée par la fonction intégrée static char *get_uniqid() - lorsque la requête est initialisée est utilisée. - - - %H - Le nom d'hôte. - - - %P - L'identifiant du processus. - - - %D - Domaine:Port. Tel que www.cloudwise.com:80; Avec la Cli, tel que cli. - - - %R - L'URI de la requête. Tel que /app/user/signin; - Avec la Cli, c'est le script d'index, tel que CliIndex.php. - - - %m - La méthode de la requête. Tel que Get; Avec la Cli, c'est le script de commande, tel que /bin/bash. - - - %I - L'IP Client; Avec la Cli c'est local. - La valeur de priorité: HTTP_X_REAL_IP > HTTP_X_FORWARDED_FOR > REMOTE_ADDR - - - %F - Nom du Fichier:Numéro de ligne. Tel que UserService.php:118. - - - %U - Utilisation de la mémoire. octet. Appel zend_memory_usage. - - - %u - Plus haute utilisation de la mémoire. octet. Appel zend_memory_peak_usage. - - - %C - TODO Classe::Action. Tel que UserService::getUserInfo - - - -
    -     -     -     -     -
    - diff --git a/reference/seaslog/reference.xml b/reference/seaslog/reference.xml deleted file mode 100644 index 44d6c73145..0000000000 --- a/reference/seaslog/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; de Seaslog - - &reference.seaslog.entities.functions; - - - - diff --git a/reference/seaslog/seaslog.xml b/reference/seaslog/seaslog.xml deleted file mode 100644 index 858d3ad55c..0000000000 --- a/reference/seaslog/seaslog.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - La classe SeasLog - SeasLog - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SeasLog - - - - - SeasLog - - - - - &Methods; - - - - -
    - -     - - &reference.seaslog.entities.seaslog; - -     - diff --git a/reference/seaslog/seaslog/alert.xml b/reference/seaslog/seaslog/alert.xml deleted file mode 100644 index a7c09e3300..0000000000 --- a/reference/seaslog/seaslog/alert.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - SeasLog::alert - Enregistre les informations du journal d'alerte - - - - &reftitle.description; - - public static boolSeasLog::alert - stringmessage - arraycontent - stringlogger - - - Enregistre les informations du journal d'alerte. - - - "ALERT" - Une action doit être prise immédiatement. - Une attention immédiate doit être accordée au personnel concerné pour des réparations d'urgence. - - - - - - - - &reftitle.parameters; - - - message - - - Le message du journal. - - - - - content - - - Le `message` contient des espaces réservés que les implémentateurs remplacent par des valeurs du tableau de contenu. - Par exemple, si le `message` est 'log info depuis {NAME}' et que le 'content' est 'array('NAME' => neeke)', - l'information de journal sera 'log info depuis neeke'. - - - - - logger - - - Le `logger` causé par le troisième paramètre serait utilisé dès maintenant, - comme un journal temporaire, lorsque la fonction SeasLog::setLogger() est appelée dans le contenu précédent. - Si `logger` est NULL ou "", SeasLog utilisera le dernier journal défini par SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Retourne TRUE en cas de succès de l'enregistrement des informations du journal, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::alert</function> - - 'neeke'))); - -//avec journal temporaire -var_dump(SeasLog::alert('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | ALERT | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | ALERT | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | ALERT | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::emergency - SeasLog::log - - - - - - diff --git a/reference/seaslog/seaslog/analyzercount.xml b/reference/seaslog/seaslog/analyzercount.xml deleted file mode 100644 index 073248ad4a..0000000000 --- a/reference/seaslog/seaslog/analyzercount.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - SeasLog::analyzerCount - Renvoie le nombre de journaux par niveau, chemin de journal et mot-clé - - - - &reftitle.description; - - public static mixedSeasLog::analyzerCount - stringlevel - stringlog_path - stringkey_word - - - `SeasLog` récupère la valeur du compteur de `grep -ai '{level}' | grep -aic '{key_word}'` - utilise le pipe système et retourne à PHP (tableau ou entier). - - - - - - &reftitle.parameters; - - - level - - - Chaîne de caractères. Le niveau d'information du journal. - - - - - log_path - - - Chaîne de caractères. Le chemin de l'information du journal. - - - - - key_word - - - Chaîne de caractères. Le mot-clé de recherche pour l'information du journal. - - - - - - - - &reftitle.returnvalues; - - Si `level` est SEASLOG_ALL ou vide, retourne tous les niveaux comptent comme `tableau`. - Si `level` est SEASLOG_INFO ou l'autre niveau, retourne le compteur comme `entier`. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::analyzerCount</function> - - -]]> - - &example.outputs.similar; - - - int(180) - ["INFO"]=> - int(214) - ["NOTICE"]=> - int(0) - ["WARNING"]=> - int(0) - ["ERROR"]=> - int(228) - ["CRITICAL"]=> - int(244) - ["ALERT"]=> - int(1) - ["EMERGENCY"]=> - int(0) -} - -int(180) - -int(228) - -int(29) -]]> - - - - - - &reftitle.seealso; - - SeasLog::analyzerDetail - - - - - diff --git a/reference/seaslog/seaslog/analyzerdetail.xml b/reference/seaslog/seaslog/analyzerdetail.xml deleted file mode 100644 index ba8a4b5dfc..0000000000 --- a/reference/seaslog/seaslog/analyzerdetail.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - SeasLog::analyzerDetail - Renvoie les détails du journal par niveau, chemin de journal, mot-clé, début, limite, ordre - - - - &reftitle.description; - - public static mixedSeasLog::analyzerDetail - stringlevel - stringlog_path - stringkey_word - intstart - intlimit - intorder - - - `SeasLog` obtient les résultats - `grep -ai '{level}' | grep -ai '{key_word}' | sed -n '{start},{limit}'p` - utilise le pipe système et retourne un tableau à PHP. - - - - - - &reftitle.parameters; - - - level - - - Chaîne de caractères. Le niveau d'information du journal. - - - - - log_path - - - Chaîne de caractères. Le chemin de l'information du journal. - - - - - key_word - - - Chaîne de caractères. Le mot-clé de recherche pour l'information du journal. - - - - - start - - - Entier. Par défaut, `1`. - - - - - limit - - - Entier. Par défaut, `20`. - - - - - order - - - Entier. Par défaut, SEASLOG_DETAIL_ORDER_ASC. - Voir aussi: - - SEASLOG_DETAIL_ORDER_ASC - SEASLOG_DETAIL_ORDER_DESC - - - - - - - - - &reftitle.returnvalues; - - Renvoie les résultats sous forme de tableau. - - - Lorsque `start`,`limit` n'est pas NULL et sous Windows, - SeasLog lancera une exception avec le message 'Param start and limit don't support Windows'. - - - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::analyzerDetail</function> - - -]]> - - &example.outputs.similar; - - - string(93) "2018-07-09 12:52:53 | ERROR | 12247 | 5b42ea2580e51 | 1531111973.528 | log message from neeke" - [1]=> - string(93) "2018-07-09 12:52:54 | ERROR | 12256 | 5b42ea26d6657 | 1531111974.878 | log message from neeke" - [2]=> - string(93) "2018-07-09 12:52:55 | ERROR | 12265 | 5b42ea277b8d4 | 1531111975.506 | log message from neeke" - [3]=> - string(104) "2018-07-09 12:52:55 | ERROR | 12274 | 5b42ea27db5dc | 1531111975.898 | log message from the other people" -... -} - -array(3) { - [0]=> - string(93) "2018-07-09 12:52:53 | ERROR | 12247 | 5b42ea2580e51 | 1531111973.528 | log message from neeke" - [1]=> - string(93) "2018-07-09 12:52:54 | ERROR | 12256 | 5b42ea26d6657 | 1531111974.878 | log message from neeke" - [2]=> - string(93) "2018-07-09 12:52:55 | ERROR | 12265 | 5b42ea277b8d4 | 1531111975.506 | log message from neeke" -} - -array(2) { - [0]=> - string(93) "2018-07-09 12:52:53 | ERROR | 12247 | 5b42ea2580e51 | 1531111973.528 | log message from neeke" - [1]=> - string(93) "2018-07-09 12:52:54 | ERROR | 12256 | 5b42ea26d6657 | 1531111974.878 | log message from neeke" -} -]]> - - - - - - &reftitle.seealso; - - SeasLog::analyzerCount - - - - - - diff --git a/reference/seaslog/seaslog/closeloggerstream.xml b/reference/seaslog/seaslog/closeloggerstream.xml deleted file mode 100644 index 7fe93c7655..0000000000 --- a/reference/seaslog/seaslog/closeloggerstream.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - SeasLog::closeLoggerStream - Libère manuellement le flux de journalisation du journal - - - - &reftitle.description; - - public static boolSeasLog::closeLoggerStream - intmodel - stringlogger - - - Libère manuellement le flux de journalisation du journal. - SeasLog met en cache la poignée de flux ouverte par le journal pour enregistrer les frais généraux de création d'un flux. La poignée sera automatiquement libérée à la fin de la requête. - Si en mode CLI, le processus libérera également automatiquement lorsqu'il se termine. Ou il est possible d'utiliser les fonctions suivantes pour libérer manuellement(la fonction de libération manuelle doit mettre à jour SeasLog 1.8.6 ou version ultérieure). - - - - - - &reftitle.parameters; - - - model - - - Une constante d'entier. - - SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALL - SEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN - - - - - - logger - - - Le nom du journal. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE sur le succès du flux de journalisation libéré, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <methodname>SeasLog::closeLoggerStream</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setLogger - SeasLog::getLastLogger - - - - - diff --git a/reference/seaslog/seaslog/construct.xml b/reference/seaslog/seaslog/construct.xml deleted file mode 100644 index 76243277dc..0000000000 --- a/reference/seaslog/seaslog/construct.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - SeasLog::__construct - Description - - - - &reftitle.description; - - public SeasLog::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::__construct</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/seaslog/seaslog/critical.xml b/reference/seaslog/seaslog/critical.xml deleted file mode 100644 index 8fb380c9bd..0000000000 --- a/reference/seaslog/seaslog/critical.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - SeasLog::critical - Enregistre les informations de journalisation critiques - - - - &reftitle.description; - - public static boolSeasLog::critical - stringmessage - arraycontent - stringlogger - - - Enregistre les informations de journalisation critiques. - - - "CRITICAL" - Conditions critiques. Doivent être réparés immédiatement, et le composant du programme est indisponible. - - - - - - - - &reftitle.parameters; - - - message - - - Le message de journalisation. - - - - - content - - - Le `message` contient des espaces réservés que les implémentateurs remplacent par des valeurs du tableau de contenu. - Par exemple, si `message` est `log info from {NAME}` et `content` est `array('NAME' => neeke)`, - les informations de journalisation seront `log info from neeke`. - - - - - logger - - - Le `journal` causé par le troisième paramètre serait utilisé dès maintenant, - comme un journal temporaire, lorsque la fonction SeasLog::setLogger() est appelée dans le contenu précédent. - Si `logger` est NULL ou "", SeasLog utilisera le dernier journal défini par SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE sur le succès de l'enregistrement des informations de journalisation, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::critical</function> - - 'neeke'))); - -//avec journal temporaire -var_dump(SeasLog::critical('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | CRITICAL | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | CRITICAL | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | CRITICAL | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - diff --git a/reference/seaslog/seaslog/debug.xml b/reference/seaslog/seaslog/debug.xml deleted file mode 100644 index 0104f80aac..0000000000 --- a/reference/seaslog/seaslog/debug.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - SeasLog::debug - Enregistre les informations de journalisation de débogage - - - - &reftitle.description; - - public static boolSeasLog::debug - stringmessage - arraycontent - stringlogger - - - Enregistre les informations de journalisation de débogage. - - - "DEBUG" - Informations de débogage détaillées. Evènements d'information détaillés. - - - - - - - - &reftitle.parameters; - - - message - - - Le message du journal. - - - - - content - - - Le `message` contient des espaces réservés que les implémentateurs remplacent par des valeurs du tableau de contenu. - Par exemple, si `message` est `log info from {NAME}` et `content` est `array('NAME' => neeke)`, - les informations de journalisation seront `log info from neeke`. - - - - - logger - - - Le `journal` causé par le troisième paramètre serait utilisé dès maintenant, - comme un journal temporaire, lorsque la fonction SeasLog::setLogger() est appelée dans le contenu précédent. - Si `logger` est NULL ou "", SeasLog utilisera le dernier journal défini par SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès de l'enregistrement des informations de journalisation, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::debug</function> - - 'neeke'))); - -//avec journal temporaire -var_dump(SeasLog::debug('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | DEBUG | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | DEBUG | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | DEBUG | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - - diff --git a/reference/seaslog/seaslog/destruct.xml b/reference/seaslog/seaslog/destruct.xml deleted file mode 100644 index 55bdfc40a1..0000000000 --- a/reference/seaslog/seaslog/destruct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - SeasLog::__destruct - Description - - - - &reftitle.description; - - public SeasLog::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::__destruct</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/seaslog/seaslog/emergency.xml b/reference/seaslog/seaslog/emergency.xml deleted file mode 100644 index 3365ec4de8..0000000000 --- a/reference/seaslog/seaslog/emergency.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - SeasLog::emergency - Enregistre les informations du journal d'urgence - - - - &reftitle.description; - - public static boolSeasLog::emergency - stringmessage - arraycontent - stringlogger - - - Enregistre les informations du journal d'urgence. - - - "EMERGENCY" - Le système est inutilisable. - - - - - - - - &reftitle.parameters; - - - message - - - Le message du journal. - - - - - content - - - Le `message` contient des espaces réservés que les implémentateurs remplacent par des valeurs du tableau de contenu. - Par exemple, si `message` est `log info from {NAME}` et `content` est `array('NAME' => neeke)`, - les informations de journalisation seront `log info from neeke`. - - - - - logger - - - Le `journal` causé par le troisième paramètre serait utilisé dès maintenant, - comme un journal temporaire, lorsque la fonction SeasLog::setLogger() est appelée dans le contenu précédent. - Si `logger` est NULL ou "", SeasLog utilisera le dernier journal défini par SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès de l'enregistrement des informations du journal, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::emergency</function> - - 'neeke'))); - -//avec logger temporaire -var_dump(SeasLog::emergency('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | EMERGENCY | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | EMERGENCY | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | EMERGENCY | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::log - - - - - - diff --git a/reference/seaslog/seaslog/error.xml b/reference/seaslog/seaslog/error.xml deleted file mode 100644 index 578c00ea71..0000000000 --- a/reference/seaslog/seaslog/error.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - SeasLog::error - Enregistre les informations du journal d'erreur - - - - &reftitle.description; - - public static boolSeasLog::error - stringmessage - arraycontent - stringlogger - - - Enregistre les informations du journal d'erreur. - - - "ERROR" - Erreurs d'exécution ne nécessitant pas d'action immédiate mais qui devraient généralement. - - - - - - - - &reftitle.parameters; - - - message - - - Le message du journal. - - - - - content - - - Le `message` contient des espaces réservés que les implémentateurs remplacent par des valeurs du tableau de contenu. - Par exemple, si `message` est `log info from {NAME}` et `content` est `array('NAME' => neeke)`, - les informations de journalisation seront `log info from neeke`. - - - - - logger - - - Le `journal` causé par le troisième paramètre serait utilisé dès maintenant, - comme un journal temporaire, lorsque la fonction SeasLog::setLogger() est appelée dans le contenu précédent. - Si `logger` est NULL ou "", SeasLog utilisera le dernier journal défini par SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès de l'enregistrement des informations du journal, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::error</function> - - 'neeke'))); - -//avec journal temporaire -var_dump(SeasLog::error('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | ERROR | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | ERROR | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | ERROR | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - - diff --git a/reference/seaslog/seaslog/flushbuffer.xml b/reference/seaslog/seaslog/flushbuffer.xml deleted file mode 100644 index 4f72b22195..0000000000 --- a/reference/seaslog/seaslog/flushbuffer.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - SeasLog::flushBuffer - Vide le tampon de journaux, le déverse dans le fichier de l'appender ou l'envoie à l'API distante avec TCP/UDP - - - - &reftitle.description; - - public static boolSeasLog::flushBuffer - - - - Vide le tampon de journaux par seaslog.appender: - déverse dans le fichier, ou envoie à l'API distante avec TCP/UDP. - - - Voir aussi: - seaslog.appender_retry - seaslog.remote_host - seaslog.remote_port - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès du vidage du tampon, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::flushBuffer</function> - - -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(79) "2018-07-07 10:47:58 | INFO | 71910 | 5b4029ded6009 | 1530931678.877 | info log -" - [1]=> - string(81) "2018-07-07 10:47:58 | DEBUG | 71910 | 5b4029ded6009 | 1530931678.877 | debug log -" - } -} -bool(true) -array(0) { -} -]]> - - - - - - &reftitle.seealso; - - seaslog.use_buffer - seaslog.buffer_size - seaslog.buffer_disabled_in_cli - SeasLog::getBufferEnabled - SeasLog::getBuffer - - - - - - diff --git a/reference/seaslog/seaslog/getbasepath.xml b/reference/seaslog/seaslog/getbasepath.xml deleted file mode 100644 index 37f78fc7f4..0000000000 --- a/reference/seaslog/seaslog/getbasepath.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - SeasLog::getBasePath - Renvoie le chemin de base de SeasLog - - - - &reftitle.description; - - public static stringSeaslog::getBasePath - - - - Utiliser la fonction SeasLog::getBasePath - pour obtenir la valeur de seaslog.default_basepath - configurée dans php.ini (seaslog.ini). - - - Lors de l'utilisation de Seaslog::setBasePath, le résultat sera modifié. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie seaslog.default_basepath en tant que chaîne de caractères. - - - - - &reftitle.examples; - - Exemple de <methodname>SeasLog::getBasePath</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/seaslog/seaslog/getbuffer.xml b/reference/seaslog/seaslog/getbuffer.xml deleted file mode 100644 index d9598b2718..0000000000 --- a/reference/seaslog/seaslog/getbuffer.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - SeasLog::getBuffer - Renvoie le tampon de journaux en mémoire sous forme de tableau - - - - &reftitle.description; - - public static arraySeasLog::getBuffer - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un tableau du tampon de journaux en mémoire. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::getBuffer</function> - - -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(79) "2018-07-07 10:43:32 | INFO | 71785 | 5b4028d4c58d5 | 1530931412.810 | info log -" - [1]=> - string(81) "2018-07-07 10:43:32 | DEBUG | 71785 | 5b4028d4c58d5 | 1530931412.810 | debug log -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.use_buffer - seaslog.buffer_size - seaslog.buffer_disabled_in_cli - SeasLog::getBufferEnabled - SeasLog::flushBuffer - - - - - - diff --git a/reference/seaslog/seaslog/getbufferenabled.xml b/reference/seaslog/seaslog/getbufferenabled.xml deleted file mode 100644 index 1789361904..0000000000 --- a/reference/seaslog/seaslog/getbufferenabled.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - SeasLog::getBufferEnabled - Détermine si le tampon est activé - - - - &reftitle.description; - - public static boolSeasLog::getBufferEnabled - - - - Résulte de la combinaison de seaslog.use_buffer - et seaslog.buffer_disabled_in_cli. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie TRUE si seaslog.use_buffer est activé. - Si seaslog.buffer_disabled_in_cli est activé, et que le script est exécuté en CLI, - le paramètre seaslog.use_buffer sera ignoré, Seaslog écrira dans le magasin de données IMMÉDIATEMENT. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::getBufferEnabled</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - seaslog.use_buffer - seaslog.buffer_size - seaslog.buffer_disabled_in_cli - SeasLog::getBuffer - SeasLog::flushBuffer - - - - - - diff --git a/reference/seaslog/seaslog/getdatetimeformat.xml b/reference/seaslog/seaslog/getdatetimeformat.xml deleted file mode 100644 index d85574e413..0000000000 --- a/reference/seaslog/seaslog/getdatetimeformat.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - SeasLog::getDatetimeFormat - Renvoie le format de date et d'heure de SeasLog - - - - &reftitle.description; - - public static stringSeasLog::getDatetimeFormat - - - - Renvoie le format de date et d'heure de SeasLog. - Utiliser la fonction SeasLog::getDatetimeFormat pour obtenir la valeur de - seaslog.default_datetime_format - configurée dans php.ini (seaslog.ini). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le format de date et d'heure de SeasLog - seaslog.default_datetime_format. - Utiliser la fonction SeasLog::setDatetimeFormat - pour modifier cette valeur. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::getDatetimeFormat</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setDatetimeFormat - - - - - - diff --git a/reference/seaslog/seaslog/getlastlogger.xml b/reference/seaslog/seaslog/getlastlogger.xml deleted file mode 100644 index fb573c222f..0000000000 --- a/reference/seaslog/seaslog/getlastlogger.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - SeasLog::getLastLogger - Renvoie le dernier journalisateur de SeasLog - - - - &reftitle.description; - - public static stringSeasLog::getLastLogger - - - - Utilise la fonction SeasLog::getLastLogger - pour obtenir la valeur de seaslog.default_logger - configurée dans php.ini (seaslog.ini). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Utilise la fonction SeasLog::setLogger - pour modifier la valeur de la fonction SeasLog::getLastLogger. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::getLastLogger</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setLogger - - - - - - diff --git a/reference/seaslog/seaslog/getrequestid.xml b/reference/seaslog/seaslog/getrequestid.xml deleted file mode 100644 index 23e5617db1..0000000000 --- a/reference/seaslog/seaslog/getrequestid.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - SeasLog::getRequestID - Renvoie les requêtes différenciées par request_id de SeasLog - - - - &reftitle.description; - - public static stringSeasLog::getRequestID - - - - Pour différencier une seule requête, en n'invoquant pas la fonction - SeasLog::setRequestId, - la valeur unique générée par la fonction intégrée `static char *get_uniqid ()` - est utilisée lors de l'initialisation de la requête. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la chaîne générée par la fonction intégrée `static char *get_uniqid ()`, - ou définie par la fonction SeasLog::setRequestId. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::getRequestID</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setRequestID - The Variable `%Q` in - Seaslog Default Variable Table. - - - - - - diff --git a/reference/seaslog/seaslog/getrequestvariable.xml b/reference/seaslog/seaslog/getrequestvariable.xml deleted file mode 100644 index f80a0c1fa8..0000000000 --- a/reference/seaslog/seaslog/getrequestvariable.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - SeasLog::getRequestVariable - Renvoie la variable de requête de SeasLog - - - - &reftitle.description; - - public static boolSeasLog::getRequestVariable - intkey - - - Renvoie la variable de requête de SeasLog. - - - - - - &reftitle.parameters; - - - key - - - Un entier de constante. - - SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT - SEASLOG_REQUEST_VARIABLE_REQUEST_URI - SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD - SEASLOG_REQUEST_VARIABLE_CLIENT_IP - - - - - - - - - &reftitle.returnvalues; - - Renvoie la valeur de la variable de requête en cas de succès. - - - - - &reftitle.examples; - - Exemple de <methodname>SeasLog::getRequestVariable</methodname> - -setRequestVariable(SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT, $sDomainPort)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_URI, $sRequestUri)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD, $sRequestMethod)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_CLIENT_IP, $sClientIp)); - -var_dump($oSeasLog->setRequestVariable($iErrorKey,NULL)); - -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT) == $sDomainPort); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_URI) == $sRequestUri); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD) == $sRequestMethod); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_CLIENT_IP) == $sClientIp); - -var_dump($oSeasLog->getRequestVariable($iErrorKey)); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setRequestVariable - - - - - diff --git a/reference/seaslog/seaslog/info.xml b/reference/seaslog/seaslog/info.xml deleted file mode 100644 index 1c30ad2a32..0000000000 --- a/reference/seaslog/seaslog/info.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - SeasLog::info - Enregistre les informations de journalisation de niveau info - - - - &reftitle.description; - - public static boolSeasLog::info - stringmessage - arraycontent - stringlogger - - - Enregistre les informations de journalisation de niveau info. - - - "INFO" - Événements intéressants. Met en évidence le processus en cours de l'application. - - - - - - - - &reftitle.parameters; - - - message - - - Le message de journalisation. - - - - - content - - - Le `message` contient des espaces réservés que les implémentateurs remplacent par des valeurs du tableau de contenu. - Par exemple, si `message` est `log info from {NAME}` et `content` est `array('NAME' => neeke)`, - les informations de journalisation seront `log info from neeke`. - - - - - logger - - - Le `journal` causé par le troisième paramètre serait utilisé dès maintenant, - comme un journal temporaire, lorsque la fonction SeasLog::setLogger() est appelée dans le contenu précédent. - Si `logger` est NULL ou "", SeasLog utilisera le dernier journal défini par SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès de l'enregistrement des informations de journalisation, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::info</function> - - 'neeke'))); - -//avec journal temporaire -var_dump(SeasLog::info('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | INFO | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | INFO | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | INFO | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - - diff --git a/reference/seaslog/seaslog/log.xml b/reference/seaslog/seaslog/log.xml deleted file mode 100644 index e3c6a195bc..0000000000 --- a/reference/seaslog/seaslog/log.xml +++ /dev/null @@ -1,195 +0,0 @@ - - - - - - SeasLog::log - La fonction de journalisation de l'enregistrement commun - - - - &reftitle.description; - - public static boolSeasLog::log - stringlevel - stringmessage - arraycontent - stringlogger - - - La fonction de journalisation de l'enregistrement commun. - - - - - - &reftitle.parameters; - - - level - - - Utiliser les niveaux dans: - - SEASLOG_DEBUG - SEASLOG_INFO - SEASLOG_NOTICE - SEASLOG_WARNING - SEASLOG_ERROR - SEASLOG_CRITICAL - SEASLOG_ALERT - SEASLOG_EMERGENCY - - Ou il est possible de créer un nouveau niveau d'auto-assistance. - - - - - message - - - Le message du journal. - - - - - content - - - Le `message` contient des espaces réservés que les implémentateurs remplacent par des valeurs du tableau de contenu. - Par exemple, si `message` est `log info from {NAME}` et `content` est `array('NAME' => neeke)`, - les informations de journalisation seront `log info from neeke`. - - - - - logger - - - Le `journal` causé par le troisième paramètre serait utilisé dès maintenant, - comme un journal temporaire, lorsque la fonction SeasLog::setLogger() est appelée dans le contenu précédent. - Si `logger` est NULL ou "", SeasLog utilisera le dernier journal défini par SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès de l'enregistrement des informations de journalisation, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::log</function> - - 'neeke'))); -var_dump(SeasLog::getBuffer()); - -//with `logger` -var_dump(SeasLog::log('MySelfLevel','info log {NAME}',array('NAME' => 'neeke'),'tmp_logger')); -var_dump(SeasLog::getBuffer()); - - -?> -]]> - - &example.outputs.similar; - - - array(1) { - [0]=> - string(79) "2018-07-07 11:12:37 | INFO | 72427 | 5b402fa56a2ea | 1530933157.436 | info log -" - } -} - -bool(true) -array(1) { - ["/var/log/www/default/20180707.log"]=> - array(1) { - [0]=> - string(86) "2018-07-07 11:13:59 | MySelfLevel | 72470 | 5b402ff781c5e | 1530933239.532 | info log -" - } -} - -bool(true) -array(1) { - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:28:12 | MySelfLevel | 72833 | 5b40334ce6a2f | 1530934092.946 | info log neeke -" - } -} - -bool(true) -array(1) { - ["/var/log/www/default/20180707.log"]=> - array(1) { - [0]=> - string(86) "2018-07-07 11:20:12 | INFO | 72616 | 5b40316c3641e | 1530933612.222 | info log neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - - - - - - diff --git a/reference/seaslog/seaslog/notice.xml b/reference/seaslog/seaslog/notice.xml deleted file mode 100644 index 82e89e1e6f..0000000000 --- a/reference/seaslog/seaslog/notice.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - SeasLog::notice - Enregistre les informations de journalisation de notification - - - - &reftitle.description; - - public static boolSeasLog::notice - stringmessage - arraycontent - stringlogger - - - Enregistre les informations de journalisation de notification. - - - "NOTICE" - Événements normaux mais significatifs. Les informations qui sont plus importantes que le niveau INFO pendant l'exécution. - - - - - - - - &reftitle.parameters; - - - message - - - Le message du journal. - - - - - content - - - Le `message` contient des espaces réservés que les implémentateurs remplacent par des valeurs du tableau de contenu. - Par exemple, si `message` est `log info from {NAME}` et `content` est `array('NAME' => neeke)`, - les informations de journalisation seront `log info from neeke`. - - - - - logger - - - Le `journal` causé par le troisième paramètre serait utilisé dès maintenant, - comme un journal temporaire, lorsque la fonction SeasLog::setLogger() est appelée dans le contenu précédent. - Si `logger` est NULL ou "", SeasLog utilisera le dernier journal défini par SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès de l'enregistrement des informations du journal, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::notice</function> - - 'neeke'))); - -//avec journal temporaire -var_dump(SeasLog::notice('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | NOTICE | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | NOTICE | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | NOTICE | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - - - diff --git a/reference/seaslog/seaslog/setbasepath.xml b/reference/seaslog/seaslog/setbasepath.xml deleted file mode 100644 index 1ca5fa27ac..0000000000 --- a/reference/seaslog/seaslog/setbasepath.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - SeasLog::setBasePath - Définit le chemin de base de SeasLog - - - - &reftitle.description; - - public static boolSeasLog::setBasePath - stringbase_path - - - Définit le chemin de base de SeasLog. - - - - - - &reftitle.parameters; - - - base_path - - - Une chaîne de caractères. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès de la définition du chemin de base, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <methodname>SeasLog::setBasePath</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/seaslog/seaslog/setdatetimeformat.xml b/reference/seaslog/seaslog/setdatetimeformat.xml deleted file mode 100644 index 05e287707b..0000000000 --- a/reference/seaslog/seaslog/setdatetimeformat.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - SeasLog::setDatetimeFormat - Définit le format de date et d'heure de SeasLog - - - - &reftitle.description; - - public static boolSeasLog::setDatetimeFormat - stringformat - - - Définit le style de format de date et d'heure de SeasLog. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - format - - - Chaîne. Tel que `Y-m-d H:i:s` ou `Ymd His`. Voir aussi le premier paramètre `format` à date. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès de la définition du format de date et d'heure, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::setDatetimeFormat</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::getDateTimeFormat - - - - - - diff --git a/reference/seaslog/seaslog/setlogger.xml b/reference/seaslog/seaslog/setlogger.xml deleted file mode 100644 index aa50127ecc..0000000000 --- a/reference/seaslog/seaslog/setlogger.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - SeasLog::setLogger - Définit le nom du journalisateur de SeasLog - - - - &reftitle.description; - - public static boolSeasLog::setLogger - stringlogger - - - Utiliser la fonction SeasLog::setLogger - pour définir la valeur de la fonction SeasLog::getLastLogger. - Cela signifie que SeasLog enregistrera les informations de journal dans le répertoire du journalisateur. - - - - - - &reftitle.parameters; - - - logger - - - Le nom du journalisateur. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès de la création du répertoire du journalisateur, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::setLogger</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::getLastLogger - SeasLog::closeLoggerStream - - - - - - diff --git a/reference/seaslog/seaslog/setrequestid.xml b/reference/seaslog/seaslog/setrequestid.xml deleted file mode 100644 index 41c6636ec9..0000000000 --- a/reference/seaslog/seaslog/setrequestid.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - SeasLog::setRequestID - Définit les request_id des requêtes différenciées de SeasLog - - - - &reftitle.description; - - public static boolSeasLog::setRequestID - stringrequest_id - - - Pour distinguer une seule requête, en n'invoquant pas la fonction - SeasLog::setRequestId, - la valeur unique générée par la fonction intégrée `static char *get_uniqid ()` - est utilisée lors de l'initialisation de la requête. - - - - - &reftitle.parameters; - - - request_id - - - Chaîne. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès de la définition, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::setRequestID</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::getRequestID - - - - - - diff --git a/reference/seaslog/seaslog/setrequestvariable.xml b/reference/seaslog/seaslog/setrequestvariable.xml deleted file mode 100644 index 7b4f3cf0f3..0000000000 --- a/reference/seaslog/seaslog/setrequestvariable.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - SeasLog::setRequestVariable - Définit manuellement la variable de requête de SeasLog - - - - &reftitle.description; - - public static boolSeasLog::setRequestVariable - intkey - stringvalue - - - Définit manuellement la variable de requête de SeasLog. - - - - - - &reftitle.parameters; - - - key - - - Constant int. - - SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT - SEASLOG_REQUEST_VARIABLE_REQUEST_URI - SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD - SEASLOG_REQUEST_VARIABLE_CLIENT_IP - - - - - - value - - - La valeur de la variable de requête. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès de la définition, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <methodname>SeasLog::setRequestVariable</methodname> - -setRequestVariable(SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT, $sDomainPort)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_URI, $sRequestUri)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD, $sRequestMethod)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_CLIENT_IP, $sClientIp)); - -var_dump($oSeasLog->setRequestVariable($iErrorKey,NULL)); - -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT) == $sDomainPort); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_URI) == $sRequestUri); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD) == $sRequestMethod); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_CLIENT_IP) == $sClientIp); - -var_dump($oSeasLog->getRequestVariable($iErrorKey)); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::getRequestVariable - - - - - diff --git a/reference/seaslog/seaslog/warning.xml b/reference/seaslog/seaslog/warning.xml deleted file mode 100644 index bb341a17ae..0000000000 --- a/reference/seaslog/seaslog/warning.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - SeasLog::warning - Enregistre les informations de journalisation d'avertissement - - - - &reftitle.description; - - public static boolSeasLog::warning - stringmessage - arraycontent - stringlogger - - - Enregistre les informations de journalisation d'avertissement. - - - "WARNING" - Occurrences exceptionnelles qui ne sont pas des erreurs. - Informations potentiellement aberrantes qui nécessitent une attention et doivent être réparées. - - - - - - - - &reftitle.parameters; - - - message - - - Le message du journal. - - - - - content - - - Le `message` contient des espaces réservés que les implémentateurs remplacent par des valeurs du tableau de contenu. - Par exemple, si `message` est `log info from {NAME}` et `content` est `array('NAME' => neeke)`, - les informations de journalisation seront `log info from neeke`. - - - - - logger - - - Le `journal` causé par le troisième paramètre serait utilisé dès maintenant, - comme un journal temporaire, lorsque la fonction SeasLog::setLogger() est appelée dans le contenu précédent. - Si `logger` est NULL ou "", SeasLog utilisera le dernier journal défini par SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE en cas de succès de l'enregistrement des informations de journalisation, FALSE en cas d'échec. - - - - - &reftitle.examples; - - Exemple de <function>SeasLog::warning</function> - - 'neeke'))); - -//avec journal temporaire -var_dump(SeasLog::warning('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | WARNING | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | WARNING | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | WARNING | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - - diff --git a/reference/seaslog/setup.xml b/reference/seaslog/setup.xml deleted file mode 100644 index 49b7aec93e..0000000000 --- a/reference/seaslog/setup.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - - -
    - - - &reference.seaslog.configure; - - - - &reference.seaslog.ini; - - -
    - &reftitle.resources; - - - -
    - -     - diff --git a/reference/simdjson/book.xml b/reference/simdjson/book.xml deleted file mode 100644 index 4d52a222bd..0000000000 --- a/reference/simdjson/book.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - Simdjson - Simdjson - - - &reftitle.intro; - - Apporte un décodage JSON plus rapide grâce aux liaisons simdjson pour PHP (Single Instruction, Multiple Data) - - - - &reference.simdjson.setup; - &reference.simdjson.constants; - &reference.simdjson.reference; - - &reference.simdjson.simdjsonexception; - &reference.simdjson.simdjsonvalueerror; - - diff --git a/reference/simdjson/constants.xml b/reference/simdjson/constants.xml deleted file mode 100644 index 2c697e8b04..0000000000 --- a/reference/simdjson/constants.xml +++ /dev/null @@ -1,358 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - SIMDJSON_ERR_CAPACITY - (&integer;) - - - - Cet analyseur ne peut pas prendre en charge un document aussi volumineux. - Lancé lors de l'analyse d'une chaîne JSON de plus de 4 Gio. - - - - - - SIMDJSON_ERR_TAPE_ERROR - (&integer;) - - - - Le document JSON a une structure incorrecte : virgules manquantes ou superflues, accolades, clés manquantes, etc. - - - - - - SIMDJSON_ERR_DEPTH_ERROR - (&integer;) - - - - Le document JSON était trop profond (trop d'objets et de tableaux imbriqués) - - - - - - SIMDJSON_ERR_STRING_ERROR - (&integer;) - - - Problème lors de l'analyse d'une chaîne - - - - - - SIMDJSON_ERR_T_ATOM_ERROR - (&integer;) - - - Problème lors de l'analyse d'un atome commençant par la lettre 't' - - - - - - SIMDJSON_ERR_F_ATOM_ERROR - (&integer;) - - - - Problème lors de l'analyse d'un atome commençant par la lettre 'f' - - - - - - SIMDJSON_ERR_N_ATOM_ERROR - (&integer;) - - - - Problème lors de l'analyse d'un atome commençant par la lettre 'n' - - - - - - SIMDJSON_ERR_NUMBER_ERROR - (&integer;) - - - - Problème lors de l'analyse d'un nombre - - - - - - SIMDJSON_ERR_UTF8_ERROR - (&integer;) - - - - L'entrée n'est pas un UTF-8 valide - - - - - - SIMDJSON_ERR_UNINITIALIZED - (&integer;) - - - - L'analyseur utilisé par simdjson n'est pas initialisé. Ne devrait pas se produire. - - - - - - SIMDJSON_ERR_EMPTY - (&integer;) - - - Vide: aucun JSON trouvé - - - - - - SIMDJSON_ERR_UNESCAPED_CHARS - (&integer;) - - - Avec des chaînes, certains caractères doivent être échappés, nous avons trouvé des caractères non échappés - - - - - - SIMDJSON_ERR_UNCLOSED_STRING - (&integer;) - - - - Une chaîne est ouverte, mais jamais fermée. - - - - - - SIMDJSON_ERR_UNSUPPORTED_ARCHITECTURE - (&integer;) - - - - simdjson n'a pas d'implémentation prise en charge par cette architecture CPU (peut-être un CPU non-SIMD ?). - - - - - - SIMDJSON_ERR_INCORRECT_TYPE - (&integer;) - - - - Ne devrait pas se produire. - - - - - - SIMDJSON_ERR_NUMBER_OUT_OF_RANGE - (&integer;) - - - - Le nombre JSON est trop grand ou trop petit pour tenir dans le type demandé. - Il convient de noter que la bibliothèque C simdjson est un fork et que cette erreur est ignorée pour correspondre à la gestion de PHP - des nombres JSON qui sont trop grands ou trop petits. - - - - - - SIMDJSON_ERR_INDEX_OUT_OF_BOUNDS - (&integer;) - - - - Ne devrait pas se produire. - - - - - - SIMDJSON_ERR_NO_SUCH_FIELD - (&integer;) - - - Ne devrait pas se produire. - - - - - - SIMDJSON_ERR_IO_ERROR - (&integer;) - - - Ne devrait pas se produire. - - - - - - SIMDJSON_ERR_INVALID_JSON_POINTER - (&integer;) - - - - Une syntaxe de pointeur JSON invalide dans simdjson_key_value - et d'autres fonctions acceptant un pointeur JSON $key. - - - - - - SIMDJSON_ERR_INVALID_URI_FRAGMENT - (&integer;) - - - Syntaxe de fragment URI invalide. - - - - - - SIMDJSON_ERR_UNEXPECTED_ERROR - (&integer;) - - - Erreur inattendue, envisagez de signaler ce problème car on a peut-être trouvé un bogue dans le PECL simdjson - - - - - - SIMDJSON_ERR_PARSER_IN_USE - (&integer;) - - - Ne devrait pas se produire. - - - - - - SIMDJSON_ERR_OUT_OF_ORDER_ITERATION - (&integer;) - - - Ne devrait pas se produire. - - - - - - SIMDJSON_ERR_INSUFFICIENT_PADDING - (&integer;) - - - Ne devrait pas se produire. - - - - - - SIMDJSON_ERR_INCOMPLETE_ARRAY_OR_OBJECT - (&integer;) - - - Le document JSON s'est terminé prématurément au milieu d'un objet ou d'un tableau. - - - - - - SIMDJSON_ERR_SCALAR_DOCUMENT_AS_VALUE - (&integer;) - - - Ne devrait pas se produire. - - - - - - SIMDJSON_ERR_OUT_OF_BOUNDS - (&integer;) - - - Essaie d'accéder à un emplacement en dehors du document. - - - - - - SIMDJSON_ERR_TRAILING_CONTENT - (&integer;) - - - - - - - - - SIMDJSON_ERR_KEY_COUNT_NOT_COUNTABLE - (&integer;) - - - - - - - - - SIMDJSON_ERR_INVALID_PROPERTY - (&integer;) - - - Nom de propriété invalide pour un stdClass lors du décodage d'une valeur - avec simdjson_decode ou simdjson_key_value - - - - - - diff --git a/reference/simdjson/functions/simdjson-decode.xml b/reference/simdjson/functions/simdjson-decode.xml deleted file mode 100644 index 7834fb275b..0000000000 --- a/reference/simdjson/functions/simdjson-decode.xml +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - simdjson_decode - Décode une chaîne JSON - - - - &reftitle.description; - - mixedsimdjson_decode - stringjson - boolassociative&false; - intdepth512 - - - Prend une chaîne encodée en JSON et la convertit en une valeur PHP. - Cela utilise une Instruction Simultanée plus Rapide, Données Multiples (Simultaneous Instruction, Multiple Data - SIMD) - que json_decode lorsqu'elle est prise en charge par l'architecture de l'ordinateur. - - - - - &reftitle.parameters; - - - json - - - Le string json à décoder. - - - Cette fonction ne fonctionne qu'avec des chaînes encodées en UTF-8. - - - Cette fonction analyse les entrées valides que - json_decode peut décoder, - à condition qu'elles soient inférieures à 4 Go de longueur. - - - - - associative - - - Lorsque &true;, les objets JSON seront retournés sous forme - de &array; associatifs ; lorsqu'ils sont &false;, les objets JSON seront retournés sous forme d'&object;s. - - - - - depth - - - La profondeur maximale de la structure à décoder. - La valeur doit être supérieure à 0, - et inférieure ou égale à 2147483647. - - Ceux qui appellent cette fonction devraient utiliser des valeurs raisonnablement petites, - car des profondeurs plus importantes nécessitent plus d'espace tampon et augmenteront - la profondeur de récursion, contrairement à l'implémentation actuelle de json_decode. - - - - - - - - &reftitle.returnvalues; - - Renvoie la valeur encodée dans json dans le - type PHP approprié. Les valeurs true, false et - null sont renvoyées respectivement comme &true;, &false; et &null;. - - - - - &reftitle.errors; - - Si json est invalide, une SimdJsonException est lancée à partir de PECL simdjson 2.1.0, - alors qu'auparavant, une RuntimeException était lancée. - - - Si depth est en dehors de la plage autorisée, - une SimdJsonValueError est lancée à partir de PECL simdjson 3.0.0, - alors qu'auparavant, une erreur de niveau E_WARNING était lancée. - - - - - &reftitle.examples; - - - Exemples de <function>simdjson_decode</function> - - -]]> - - &example.outputs; - - - int(1) - ["b"]=> - int(2) - ["c"]=> - int(3) -} -array(3) { - ["a"]=> - int(1) - ["b"]=> - int(2) - ["c"]=> - int(3) -} -]]> - - - - Accéder à des propriétés d'objet non valides - - Accéder à des éléments dans un objet qui contiennent des caractères non - autorisés par la convention de nommage de PHP (par exemple, le trait d'union) peut être - accompli en encapsulant le nom de l'élément entre des accolades et des apostrophes. - - -{'foo-bar'}; // 12345 - -?> -]]> - - - - Erreurs courantes lors de l'utilisation de <function>simdjson_decode</function> - - -]]> - - - - Erreurs de <parameter>depth</parameter> - - array -> array -> string) -$json = json_encode( - [ - 1 => [ - 'English' => [ - 'One', - 'January' - ], - 'French' => [ - 'Une', - 'Janvier' - ] - ] - ] -); - -// Afficher les erreurs pour différentes profondeurs. -var_dump(simdjson_decode($json, true, 4)); -try { - var_dump(simdjson_decode($json, true, 3)); -} catch (SimdJsonException $e) { - echo "Caught: ", $e->getMessage(), "\n"; -} -?> -]]> - - &example.outputs; - - - array(2) { - ["English"]=> - array(2) { - [0]=> - string(3) "One" - [1]=> - string(7) "January" - } - ["French"]=> - array(2) { - [0]=> - string(3) "Une" - [1]=> - string(7) "Janvier" - } - } -} -Caught: The JSON document was too deep (too many nested objects and arrays) -]]> - - - - <function>simdjson_decode</function> de grands entiers - - -]]> - - &example.outputs; - - - float(1.2345678901235E+19) -} -]]> - - - - - - - &reftitle.notes; - - - La spécification JSON n'est pas JavaScript, mais un sous-ensemble de JavaScript. - - - - - Dans le cas où le décodage échoue, - une SimdJsonException est lancée - et SimdJsonException::getCode et - SimdJsonException::getMessage peuvent être utilisés - pour déterminer la nature exacte de l'erreur. - - - - - - &reftitle.seealso; - - json_encode - json_decode - - - - diff --git a/reference/simdjson/functions/simdjson-is-valid.xml b/reference/simdjson/functions/simdjson-is-valid.xml deleted file mode 100644 index ddaca96cd7..0000000000 --- a/reference/simdjson/functions/simdjson-is-valid.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - simdjson_is_valid - Vérifie si une chaîne JSON est valide - - - - &reftitle.description; - - boolsimdjson_is_valid - stringjson - intdepth512 - - - Prend une chaîne encodée en JSON et retourne true si elle est valide. - - - - - &reftitle.parameters; - - - json - - - Le string json à valider. - - - Cette fonction ne fonctionne qu'avec des chaînes encodées en UTF-8. - - - Cette fonction valide les entrées que - json_decode peut décoder, - à condition qu'elles soient inférieures à 4 Go de longueur. - - - - - depth - - - La profondeur maximale de la structure à décoder. - La valeur doit être supérieure à 0, - et inférieure ou égale à 2147483647. - - Ceux qui appellent cette fonction devraient utiliser des valeurs raisonnablement petites, - car des profondeurs plus importantes nécessitent plus d'espace tampon et augmenteront - la profondeur de récursion, contrairement à l'implémentation actuelle de json_decode. - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; si json est une chaîne JSON - valide, sinon &false;. - - - - - &reftitle.errors; - - Si json est invalide, une SimdJsonException est lancée à partir de PECL simdjson 2.1.0, - alors qu'auparavant, une RuntimeException était lancée. - - - Si depth est en dehors de la plage autorisée, - une SimdJsonValueError est lancée à partir de PECL simdjson 3.0.0, - alors qu'auparavant, une erreur de niveau E_WARNING était lancée. - - - - - &reftitle.examples; - - - Exemples de <function>simdjson_decode</function> - - -]]> - - &example.outputs; - - - - - - Erreurs de <parameter>depth</parameter> - - array -> array -> string) -$json = json_encode( - [ - 1 => [ - 'English' => [ - 'One', - 'January' - ], - 'French' => [ - 'Une', - 'Janvier' - ] - ] - ] -); - -// Afficher les erreurs pour différentes profondeurs. -var_dump(simdjson_is_valid($json, 4)); -var_dump(simdjson_is_valid($json, 3)); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.notes; - - - La spécification JSON n'est pas JavaScript, mais un sous-ensemble de JavaScript. - - - - - Dans le cas où le décodage échoue, - une SimdJsonException est lancée - et SimdJsonException::getCode et - SimdJsonException::getMessage peuvent être utilisés - pour déterminer la nature exacte de l'erreur. - - - - - - &reftitle.seealso; - - json_encode - json_decode - - - - diff --git a/reference/simdjson/functions/simdjson-key-count.xml b/reference/simdjson/functions/simdjson-key-count.xml deleted file mode 100644 index fffc59b16d..0000000000 --- a/reference/simdjson/functions/simdjson-key-count.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - simdjson_key_count - Renvoie la valeur à un pointeur JSON. - - - - &reftitle.description; - - intsimdjson_key_count - stringjson - stringkey - intdepth512 - boolthrow_if_uncountable&false; - - - Compte le nombre d'éléments de l'objet/tableau trouvé au pointeur JSON demandé. - - - - - &reftitle.parameters; - - - json - - - Le string json à interroger. - - - - - key - - - Le string du pointeur JSON. - - - - - depth - - - La profondeur maximale de la structure à décoder. - La valeur doit être supérieure à 0, - et inférieure ou égale à 2147483647. - - Ceux qui appellent cette fonction devraient utiliser des valeurs raisonnablement petites, - car des profondeurs plus importantes nécessitent plus d'espace tampon et augmenteront - la profondeur de récursion, contrairement à l'implémentation actuelle de json_decode. - - - - - throw_if_uncountable - - - Lorsque vrai, une SimdJsonException sera lancée - au lieu de renvoyer 0 lorsque la valeur pointée par le JSON n'est ni - un objet ni un tableau. - - - - - - - - &reftitle.returnvalues; - - Renvoie un &integer; avec le nombre d'éléments de la valeur au pointeur JSON donné. - - - - - - diff --git a/reference/simdjson/functions/simdjson-key-exists.xml b/reference/simdjson/functions/simdjson-key-exists.xml deleted file mode 100644 index 9da1e140f3..0000000000 --- a/reference/simdjson/functions/simdjson-key-exists.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - simdjson_key_exists - Vérifie si le JSON contient la valeur référencée par un pointeur JSON. - - - - &reftitle.description; - - boolsimdjson_key_exists - stringjson - stringkey - intdepth - - - Compte le nombre d'éléments de l'objet/tableau trouvé au pointeur JSON demandé. - - - - - &reftitle.parameters; - - - json - - - Le string json à interroger. - - - - - key - - - Le string du pointeur JSON. - - - - - depth - - - La profondeur maximale de la structure à décoder. - La valeur doit être supérieure à 0, - et inférieure ou égale à 2147483647. - - Ceux qui appellent cette fonction devraient utiliser des valeurs raisonnablement petites, - car des profondeurs plus importantes nécessitent plus d'espace tampon et augmenteront - la profondeur de récursion, contrairement à l'implémentation actuelle de json_decode. - - - - - throw_if_uncountable - - - Lorsque vrai, une SimdJsonException sera lancée - au lieu de renvoyer 0 lorsque la valeur pointée par le JSON n'est ni - un objet ni un tableau. - - - - - - - - &reftitle.returnvalues; - - Renvoie &true; si le pointeur JSON est valide et référence une valeur trouvée dans une chaîne JSON valide. - Renvoie &false; si le JSON est valide mais ne contient pas le pointeur JSON. - - - - - - diff --git a/reference/simdjson/functions/simdjson-key-value.xml b/reference/simdjson/functions/simdjson-key-value.xml deleted file mode 100644 index 0f79d1a04d..0000000000 --- a/reference/simdjson/functions/simdjson-key-value.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - simdjson_key_value - Décode la valeur d'une chaîne JSON située à l'indicateur JSON demandé. - - - - &reftitle.description; - - mixedsimdjson_key_value - stringjson - stringkey - boolassociative&false; - intdepth512 - - - Décode et renvoie la valeur trouvée à l'indicateur JSON demandé. - - - - - &reftitle.parameters; - - - json - - - Le json string à interroger et décoder. - - - Cette fonction ne fonctionne qu'avec des chaînes encodées en UTF-8. - - - Cette fonction analyse les entrées valides que - json_decode peut décoder, - à condition qu'elles soient inférieures à 4 Go de longueur. - - - - - key - - - Le string du pointeur JSON. - - - - - associative - - - Lorsque &true; les objets JSON seront retournés sous forme - de &array; associatifs ; lorsqu'ils sont &false;, les objets JSON seront retournés sous forme d'&object;s. - - - - - depth - - - La profondeur maximale de la structure à décoder. - La valeur doit être supérieure à 0, - et inférieure ou égale à 2147483647. - - Ceux qui appellent cette fonction devraient utiliser des valeurs raisonnablement petites, - car des profondeurs plus importantes nécessitent plus d'espace tampon et augmenteront - la profondeur de récursion, contrairement à l'implémentation actuelle de json_decode. - - - - - - - - &reftitle.returnvalues; - - Renvoie la partie de la valeur encodée dans json - que key référence dans le type PHP approprié. - Les valeurs true, false et - null sont renvoyées respectivement comme &true;, &false; et &null;. - - - - &reftitle.errors; - - Si json ou key est invalide, - ou si key n'a pas pu être trouvé dans json, - une SimdJsonException est lancée à partir de PECL simdjson 2.1.0, - alors qu'auparavant, une RuntimeException était lancée. - - - Si depth est en dehors de la plage autorisée, - une SimdJsonValueError est lancée à partir de PECL simdjson 3.0.0, - alors qu'auparavant, une erreur de niveau E_WARNING était lancée. - - - - &reftitle.seealso; - - json_encode - simdjson_decode - - - - diff --git a/reference/simdjson/reference.xml b/reference/simdjson/reference.xml deleted file mode 100644 index 750d3b451c..0000000000 --- a/reference/simdjson/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &Functions; de Simdjson - - &reference.simdjson.entities.functions; - - - diff --git a/reference/simdjson/setup.xml b/reference/simdjson/setup.xml deleted file mode 100644 index af8792368a..0000000000 --- a/reference/simdjson/setup.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;simdjson. - - - &pecl.windows.download.avail; - -
    -     - diff --git a/reference/simdjson/simdjsonexception.xml b/reference/simdjson/simdjsonexception.xml deleted file mode 100644 index 31b8cd09de..0000000000 --- a/reference/simdjson/simdjsonexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La classe SimdJsonException - SimdJsonException - - - - -
    - &reftitle.intro; - - Exception lancée si simdjson_decode, - simdjson_key_count, - simdjson_key_exists, - ou simdjson_key_value. - - Pour obtenir des valeurs possibles, voir les constantes d'erreur simdjson. - -
    - - -
    - &reftitle.classsynopsis; - - - - SimdJsonException - - - - - SimdJsonException - - - - extends - RuntimeException - - - - - &InheritedProperties; - - - - - -
    - -     -     - diff --git a/reference/simdjson/simdjsonvalueerror.xml b/reference/simdjson/simdjsonvalueerror.xml deleted file mode 100644 index 8cbe0cb3d4..0000000000 --- a/reference/simdjson/simdjsonvalueerror.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - La classe SimdJsonValueError - SimdJsonValueError - - - - -
    - &reftitle.intro; - - Une exception SimdJsonValueError est lancée lorsque le - type d'un argument d'une fonction de simdjson est correct mais que la valeur - de celui-ci est incorrecte. - Par exemple, lorsque le décodage JSON $depth n'est pas positif ou que le $depth est trop grand. - -
    - - -
    - &reftitle.classsynopsis; - - - - SimdJsonValueError - - - - - SimdJsonValueError - - - - extends - ValueError - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PHP 8.0.0 - - SimdJsonValueError étend désormais ValueError - à la place de Error. - - - - - -
    -     - -     - diff --git a/reference/solr/book.xml b/reference/solr/book.xml deleted file mode 100644 index ddb1bd7667..0000000000 --- a/reference/solr/book.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - Apache Solr - Solr - - - &reftitle.intro; - - L'extension Solr autorise la communication avec le serveur Apache Solr - en PHP. - - - - L'extension Solr est une bibliothèque rapide, légère et riche qui autorise les - développeurs PHP à communiquer efficacement avec les instances de serveur Solr. - - Les versions 1.x de l'extension PECL supportent Apache Solr Server 1.3-3.x - Les versions 2.x de l'extension PECL supportent Apache Solr Server 4.0+ - - Elle contient des outils pour ajouter des documents mais aussi pour faire des - mises à jour sur le serveur Solr. - - - Elle contient également des outils qui permettent de construire des requêtes - avancées à destination du serveur pour y rechercher des documents. - - - - &reference.solr.setup; - &reference.solr.constants; - &reference.solr.reference; - - &reference.solr.examples; - - &reference.solr.solrutils; - - &reference.solr.solrinputdocument; - &reference.solr.solrdocument; - &reference.solr.solrdocumentfield; - - &reference.solr.solrobject; - - &reference.solr.solrclient; - - &reference.solr.solrresponse; - &reference.solr.solrqueryresponse; - &reference.solr.solrupdateresponse; - &reference.solr.solrpingresponse; - &reference.solr.solrgenericresponse; - - &reference.solr.solrparams; - &reference.solr.solrmodifiableparams; - &reference.solr.solrquery; - &reference.solr.solrdismaxquery; - &reference.solr.solrcollapsefunction; - - &reference.solr.solrexception; - &reference.solr.solrclientexception; - &reference.solr.solrserverexception; - &reference.solr.solrillegalargumentexception; - &reference.solr.solrillegaloperationexception; - &reference.solr.solrmissingmandatoryparameterexception; - - - - - diff --git a/reference/solr/constants.xml b/reference/solr/constants.xml deleted file mode 100644 index 1ea3419db5..0000000000 --- a/reference/solr/constants.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - - SOLR_MAJOR_VERSION - (int) - - - - - - - - - SOLR_MINOR_VERSION - (int) - - - - - - - - - SOLR_PATCH_VERSION - (int) - - - - - - - - - SOLR_EXTENSION_VERSION - (string) - - - - - - - - - - - - diff --git a/reference/solr/examples.xml b/reference/solr/examples.xml deleted file mode 100644 index 5c0df2f0ae..0000000000 --- a/reference/solr/examples.xml +++ /dev/null @@ -1,1280 +0,0 @@ - - - - - - - &reftitle.examples; - - Exemples d'utilisation de l'extension Apache Solr en PHP. - - - Contenu du fichier BootStrap - - - -]]> - - - - - - Ajout d'un document à l'index - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -$updateResponse = $client->addDocument($doc); - -print_r($updateResponse->getResponse()); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 446 - ) - -) -]]> - - - - - Fusion d'un document dans un autre - -addField('id', 1123); - -$doc->features = "PHP Client Side"; -$doc->features = "Fast development cycles"; - -$doc['cat'] = 'Software'; -$doc['cat'] = 'Custom Search'; -$doc->cat = 'Information Technology'; - -$second_doc->addField('cat', 'Lucene Search'); - -$second_doc->merge($doc, true); - -print_r($second_doc->toArray()); - - -?> - -]]> - - &example.outputs.similar; - - 0 - [field_count] => 3 - [fields] => Array - ( - [0] => SolrDocumentField Object - ( - [name] => cat - [boost] => 0 - [values] => Array - ( - [0] => Software - [1] => Custom Search - [2] => Information Technology - ) - - ) - - [1] => SolrDocumentField Object - ( - [name] => id - [boost] => 0 - [values] => Array - ( - [0] => 1123 - ) - - ) - - [2] => SolrDocumentField Object - ( - [name] => features - [boost] => 0 - [values] => Array - ( - [0] => PHP Client Side - [1] => Fast development cycles - ) - - ) - - ) - -) -]]> - - - - - - Recherche de documents - réponses sous la forme d'un objet SolrObject - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setQuery('lucene'); - -$query->setStart(0); - -$query->setRows(50); - -$query->addField('cat')->addField('features')->addField('id')->addField('timestamp'); - -$query_response = $client->query($query); - -$response = $query_response->getResponse(); - -print_r($response); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - [params] => SolrObject Object - ( - [wt] => xml - [rows] => 50 - [start] => 0 - [indent] => on - [q] => lucene - [fl] => cat,features,id,timestamp - [version] => 2.2 - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 3 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [cat] => Array - ( - [0] => Software - [1] => Lucene - ) - - [id] => 334456 - ) - - [1] => SolrObject Object - ( - [cat] => Array - ( - [0] => Software - [1] => Lucene - ) - - [id] => 334455 - ) - - [2] => SolrObject Object - ( - [cat] => Array - ( - [0] => software - [1] => search - ) - - [features] => Array - ( - [0] => Advanced Full-Text Search Capabilities using Lucene - [1] => Optimized for High Volume Web Traffic - [2] => Standards Based Open Interfaces - XML and HTTP - [3] => Comprehensive HTML Administration Interfaces - [4] => Scalability - Efficient Replication to other Solr Search Servers - [5] => Flexible and Adaptable with XML configuration and Schema - [6] => Good unicode support: héllo (hello with an accent over the e) - ) - - [id] => SOLR1000 - [timestamp] => 2009-09-04T20:38:55.906 - ) - - ) - - ) - -) -]]> - - - - - Recherche de documents - réponses sous la forme d'un objet SolrDocument - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setQuery('lucene'); - -$query->setStart(0); - -$query->setRows(50); - -$query->addField('cat')->addField('features')->addField('id')->addField('timestamp'); - -$query_response = $client->query($query); - -$query_response->setParseMode(SolrQueryResponse::PARSE_SOLR_DOC); - -$response = $query_response->getResponse(); - -print_r($response); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - [params] => SolrObject Object - ( - [wt] => xml - [rows] => 50 - [start] => 0 - [indent] => on - [q] => lucene - [fl] => cat,features,id,timestamp - [version] => 2.2 - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 3 - [start] => 0 - [docs] => Array - ( - [0] => SolrDocument Object - ( - [_hashtable_index:SolrDocument:private] => 19740 - ) - - [1] => SolrDocument Object - ( - [_hashtable_index:SolrDocument:private] => 25485 - ) - - [2] => SolrDocument Object - ( - [_hashtable_index:SolrDocument:private] => 25052 - ) - - ) - - ) - -) -]]> - - - - - Exemple simple avec TermsComponent - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setTerms(true); - -$query->setTermsField('cat'); - -$updateResponse = $client->query($query); - -print_r($updateResponse->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 2 - ) - - [terms] => SolrObject Object - ( - [cat] => SolrObject Object - ( - [electronics] => 14 - [Lucene] => 4 - [Software] => 4 - [memory] => 3 - [card] => 2 - [connector] => 2 - [drive] => 2 - [graphics] => 2 - [hard] => 2 - [monitor] => 2 - ) - - ) - -) - -]]> - - - - - Exemple simple avec TermsComponent en utilisant un préfixe - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setTerms(true); - -/* Return only terms starting with $prefix */ -$prefix = 'c'; - -$query->setTermsField('cat')->setTermsPrefix($prefix); - -$updateResponse = $client->query($query); - -print_r($updateResponse->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - ) - - [terms] => SolrObject Object - ( - [cat] => SolrObject Object - ( - [card] => 2 - [connector] => 2 - [camera] => 1 - [copier] => 1 - ) - - ) - -) -]]> - - - - - Exemple simple avec TermsComponent en spécifiant une fréquence minimale - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setTerms(true); - -/* Return only terms starting with $prefix */ -$prefix = 'c'; - -/* Return only terms with a frequency of 2 or greater */ -$min_frequency = 2; - -$query->setTermsField('cat')->setTermsPrefix($prefix)->setTermsMinCount($min_frequency); - -$updateResponse = $client->query($query); - -print_r($updateResponse->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 0 - ) - - [terms] => SolrObject Object - ( - [cat] => SolrObject Object - ( - [card] => 2 - [connector] => 2 - ) - - ) - -) -]]> - - - - - Exemple simple avec Facet - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$query->setFacet(true); - -$query->addFacetField('cat')->addFacetField('name')->setFacetMinCount(2); - -$updateResponse = $client->query($query); - -$response_array = $updateResponse->getResponse(); - -$facet_data = $response_array->facet_counts->facet_fields; - -print_r($facet_data); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [electronics] => 14 - [memory] => 3 - [Lucene] => 2 - [Software] => 2 - [card] => 2 - [connector] => 2 - [drive] => 2 - [graphics] => 2 - [hard] => 2 - [monitor] => 2 - [search] => 2 - [software] => 2 - ) - - [name] => SolrObject Object - ( - [gb] => 6 - [1] => 3 - [184] => 3 - [2] => 3 - [3200] => 3 - [400] => 3 - [500] => 3 - [ddr] => 3 - [i] => 3 - [ipod] => 3 - [memori] => 3 - [pc] => 3 - [pin] => 3 - [pod] => 3 - [sdram] => 3 - [system] => 3 - [unbuff] => 3 - [canon] => 2 - [corsair] => 2 - [drive] => 2 - [hard] => 2 - [mb] => 2 - [n] => 2 - [power] => 2 - [retail] => 2 - [video] => 2 - [x] => 2 - ) - -) -]]> - - - - - Exemple simple avec Facet et un champ optionnel d'écrasement pour mincount - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$query->setFacet(true); - -$query->addFacetField('cat')->addFacetField('name')->setFacetMinCount(2)->setFacetMinCount(4, 'name'); - -$updateResponse = $client->query($query); - -$response_array = $updateResponse->getResponse(); - -$facet_data = $response_array->facet_counts->facet_fields; - -print_r($facet_data); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [electronics] => 14 - [memory] => 3 - [Lucene] => 2 - [Software] => 2 - [card] => 2 - [connector] => 2 - [drive] => 2 - [graphics] => 2 - [hard] => 2 - [monitor] => 2 - [search] => 2 - [software] => 2 - ) - - [name] => SolrObject Object - ( - [gb] => 6 - ) - -) -]]> - - - - - Exemple avec les Facet - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$query->setFacet(true); - -$query->addFacetDateField('manufacturedate_dt'); - -$query->setFacetDateStart('2006-02-13T00:00:00Z'); - -$query->setFacetDateEnd('2012-02-13T00:00:00Z'); - -$query->setFacetDateGap('+1YEAR'); - -$query->setFacetDateHardEnd(1); - -$query->addFacetDateOther('before'); - -$updateResponse = $client->query($query); - -$response_array = $updateResponse->getResponse(); - -$facet_data = $response_array->facet_counts->facet_dates; - -print_r($facet_data); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [2006-02-13T00:00:00Z] => 9 - [2007-02-13T00:00:00Z] => 0 - [2008-02-13T00:00:00Z] => 0 - [2009-02-13T00:00:00Z] => 0 - [2010-02-13T00:00:00Z] => 0 - [2011-02-13T00:00:00Z] => 0 - [gap] => +1YEAR - [start] => 2006-02-13T00:00:00Z - [end] => 2012-02-13T00:00:00Z - [before] => 2 - ) - -) -]]> - - - - - Connexion à un serveur SSL - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'timeout' => SOLR_SERVER_TIMEOUT, - 'secure' => SOLR_SECURE, - 'ssl_cert' => SOLR_SSL_CERT_ONLY, - 'ssl_key' => SOLR_SSL_KEY, - 'ssl_keypassword' => SOLR_SSL_KEYPASSWORD, - 'ssl_cainfo' => SOLR_SSL_CAINFO, -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$query->setFacet(true); - -$query->addFacetField('cat')->addFacetField('name')->setFacetMinCount(2)->setFacetMinCount(4, 'name'); - -$updateResponse = $client->query($query); - -$response_array = $updateResponse->getResponse(); - -$facet_data = $response_array->facet_counts->facet_fields; - -print_r($facet_data); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [electronics] => 14 - [memory] => 3 - [Lucene] => 2 - [Software] => 2 - [card] => 2 - [connector] => 2 - [drive] => 2 - [graphics] => 2 - [hard] => 2 - [monitor] => 2 - [search] => 2 - [software] => 2 - ) - - [name] => SolrObject Object - ( - [gb] => 6 - ) - -) -]]> - - - - - Exemple avec <type>SolrQuery</type> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$collapseFunction = new SolrCollapseFunction('manu_id_s'); - -$collapseFunction -->setSize(2) -->setNullPolicy(SolrCollapseFunction::NULLPOLICY_IGNORE); - -$query -->collapse($collapseFunction) -->setRows(4); - -$queryResponse = $client->query($query); - -$response = $queryResponse->getResponse(); - -print_r($response); -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - [params] => SolrObject Object - ( - [q] => *:* - [indent] => on - [fq] => {!collapse field=manu_id_s size=2 nullPolicy=ignore} - [rows] => 4 - [version] => 2.2 - [wt] => xml - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 14 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [id] => SP2514N - [name] => Array - ( - [0] => Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133 - ) - - [manu] => Array - ( - [0] => Samsung Electronics Co. Ltd. - ) - - [manu_id_s] => samsung - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => 7200RPM, 8MB cache, IDE Ultra ATA-133 - [1] => NoiseGuard, SilentSeek technology, Fluid Dynamic Bearing (FDB) motor - ) - - [price] => Array - ( - [0] => 92 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [store] => Array - ( - [0] => 35.0752,-97.032 - ) - - [_version_] => 1510294336412057600 - ) - - [1] => SolrObject Object - ( - [id] => 6H500F0 - [name] => Array - ( - [0] => Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300 - ) - - [manu] => Array - ( - [0] => Maxtor Corp. - ) - - [manu_id_s] => maxtor - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => SATA 3.0Gb/s, NCQ - [1] => 8.5ms seek - [2] => 16MB cache - ) - - [price] => Array - ( - [0] => 350 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 45.17614,-93.87341 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [_version_] => 1510294336449806336 - ) - - [2] => SolrObject Object - ( - [id] => F8V7067-APL-KIT - [name] => Array - ( - [0] => Belkin Mobile Power Cord for iPod w/ Dock - ) - - [manu] => Array - ( - [0] => Belkin - ) - - [manu_id_s] => belkin - [cat] => Array - ( - [0] => electronics - [1] => connector - ) - - [features] => Array - ( - [0] => car power adapter, white - ) - - [weight] => Array - ( - [0] => 4 - ) - - [price] => Array - ( - [0] => 19.95 - ) - - [popularity] => Array - ( - [0] => 1 - ) - - [inStock] => Array - ( - [0] => - ) - - [store] => Array - ( - [0] => 45.18014,-93.87741 - ) - - [manufacturedate_dt] => 2005-08-01T16:30:25Z - [_version_] => 1510294336458194944 - ) - - [3] => SolrObject Object - ( - [id] => MA147LL/A - [name] => Array - ( - [0] => Apple 60 GB iPod with Video Playback Black - ) - - [manu] => Array - ( - [0] => Apple Computer Inc. - ) - - [manu_id_s] => apple - [cat] => Array - ( - [0] => electronics - [1] => music - ) - - [features] => Array - ( - [0] => iTunes, Podcasts, Audiobooks - [1] => Stores up to 15,000 songs, 25,000 photos, or 150 hours of video - [2] => 2.5-inch, 320x240 color TFT LCD display with LED backlight - [3] => Up to 20 hours of battery life - [4] => Plays AAC, MP3, WAV, AIFF, Audible, Apple Lossless, H.264 video - [5] => Notes, Calendar, Phone book, Hold button, Date display, Photo wallet, Built-in games, JPEG photo playback, Upgradeable firmware, USB 2.0 compatibility, Playback speed control, Rechargeable capability, Battery level indication - ) - - [includes] => Array - ( - [0] => earbud headphones, USB cable - ) - - [weight] => Array - ( - [0] => 5.5 - ) - - [price] => Array - ( - [0] => 399 - ) - - [popularity] => Array - ( - [0] => 10 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 37.7752,-100.0232 - ) - - [manufacturedate_dt] => 2005-10-12T08:00:00Z - [_version_] => 1510294336562003968 - ) - - ) - - ) - -) -]]> - - - - - Exemple "Solr Real Time Get (RTG)" avec <function>SolrClient::getById</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); -$response = $client->getById('GB18030TEST'); -print_r($response->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [id] => GB18030TEST - [name] => Array - ( - [0] => Test with some GB18030 encoded characters - ) - - [features] => Array - ( - [0] => No accents here - [1] => 这是一个功能 - [2] => This is a feature (translated) - [3] => 这份文件是很有光泽 - [4] => This document is very shiny (translated) - ) - - [price] => Array - ( - [0] => 0 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [_version_] => 1510294336239042560 - ) - -) -]]> - - - - - - - diff --git a/reference/solr/functions/solr-get-version.xml b/reference/solr/functions/solr-get-version.xml deleted file mode 100644 index 7064d10145..0000000000 --- a/reference/solr/functions/solr-get-version.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - solr_get_version - Retourne la version courante de l'extension Solr utilisée par Apache - - - - &reftitle.description; - - stringsolr_get_version - - - - Cette fonction retourne la version courante de l'extension, - sous la forme d'une &string;. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - Retourne un &string; en cas de succès, et &false; - si une erreur survient. - - - - - &reftitle.errors; - - Cette fonction ne lance aucune erreur ni exception. - - - - - &reftitle.examples; - - - Exemple avec <function>solr_get_version</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - SolrUtils::getSolrVersion - - - - - - - diff --git a/reference/solr/reference.xml b/reference/solr/reference.xml deleted file mode 100644 index 7259b8ccb1..0000000000 --- a/reference/solr/reference.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - &Functions; Solr - - &reference.solr.entities.functions; - - - - - diff --git a/reference/solr/setup.xml b/reference/solr/setup.xml deleted file mode 100644 index 7cbc82b013..0000000000 --- a/reference/solr/setup.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - - Les extensions libxml et curl doivent aussi être activées - afin de rendre disponible l'extension Apache Solr. - - - libxml2 en version 2.6.31 et suivant est requis. - - - libcurl en version 7.18.0 et suivant est aussi requis. - - - Les versions de bibliothèque ci-dessus sont nécessaires et - tenter de modifier le code pour compiler cette extension - avec des bibliothèques de version différente n'est pas recommandé. - Cela pourrait échouer avec des erreurs qui pourraient être - très difficiles à déboguer. - -
    - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;solr. - - - Pour de l'aide et du support, visitez le groupe google de - l'extension. - Extension Apache Solr PHP - - - &pecl.windows.download.avail; - - - - Le module Solr peut être compilé en mode de déboguage en passant - l'option de configuration . - - - Lors d'une compilation manuelle, il faut s'assurer d'inclure le support - curl et libxml. - - -
    - - -     - - - diff --git a/reference/solr/solrclient.xml b/reference/solr/solrclient.xml deleted file mode 100644 index 110c91169c..0000000000 --- a/reference/solr/solrclient.xml +++ /dev/null @@ -1,266 +0,0 @@ - - - - - - - La classe SolrClient - SolrClient - - - - -
    - &reftitle.intro; - - 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. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrClient - - - - - final - SolrClient - - - - &Constants; - - const - int - SolrClient::SEARCH_SERVLET_TYPE - 1 - - - const - int - SolrClient::UPDATE_SERVLET_TYPE - 2 - - - const - int - SolrClient::THREADS_SERVLET_TYPE - 4 - - - const - int - SolrClient::PING_SERVLET_TYPE - 8 - - - const - int - SolrClient::TERMS_SERVLET_TYPE - 16 - - - const - int - SolrClient::SYSTEM_SERVLET_TYPE - 32 - - - const - string - SolrClient::DEFAULT_SEARCH_SERVLET - select - - - const - string - SolrClient::DEFAULT_UPDATE_SERVLET - update - - - const - string - SolrClient::DEFAULT_THREADS_SERVLET - admin/threads - - - const - string - SolrClient::DEFAULT_PING_SERVLET - admin/ping - - - const - string - SolrClient::DEFAULT_TERMS_SERVLET - terms - - - const - string - SolrClient::DEFAULT_SYSTEM_SERVLET - admin/system - - - &Methods; - - - - - - -
    - - -
    - &reftitle.constants; - - - - SolrClient::SEARCH_SERVLET_TYPE - - - Utilisé lors de la mise à jour du servlet de recherche. - - - - - - SolrClient::UPDATE_SERVLET_TYPE - - - Utilisé lors de la mise à jour du servlet de mise à jour. - - - - - - SolrClient::THREADS_SERVLET_TYPE - - - Utilisé lors de la mise à jour du servlet de threads. - - - - - - SolrClient::PING_SERVLET_TYPE - - - Utilisé lors de la mise à jour du servlet de ping. - - - - - - SolrClient::TERMS_SERVLET_TYPE - - - Utilisé lors de la mise à jour du servlet de termes. - - - - - - SolrClient::SYSTEM_SERVLET_TYPE - - - Utilisé lors de la récupération des informations système - depuis le servlet système. - - - - - - SolrClient::DEFAULT_SEARCH_SERVLET - - - Ceci est la valeur initiale pour le servlet de recherche. - - - - - - SolrClient::DEFAULT_UPDATE_SERVLET - - - Ceci est la valeur initiale pour le servlet de mise à jour. - - - - - - SolrClient::DEFAULT_THREADS_SERVLET - - - Ceci est la valeur initiale pour le servlet de threads. - - - - - - SolrClient::DEFAULT_PING_SERVLET - - - Ceci est la valeur initiale pour le servlet de ping. - - - - - - SolrClient::DEFAULT_TERMS_SERVLET - - - Ceci est la valeur initiale pour le servlet de termes utilisé - pour le TermsComponent. - - - - - - SolrClient::DEFAULT_SYSTEM_SERVLET - - - Ceci est la valeur initiale pour le servlet système utilisé pour obtenir - les informations du serveur Solr. - - - - - -
    - - - -     - - &reference.solr.entities.solrclient; - -     - diff --git a/reference/solr/solrclient/adddocument.xml b/reference/solr/solrclient/adddocument.xml deleted file mode 100644 index 3f6b5434f7..0000000000 --- a/reference/solr/solrclient/adddocument.xml +++ /dev/null @@ -1,238 +0,0 @@ - - - - - - - - SolrClient::addDocument - Ajoute un document à l'index - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::addDocument - SolrInputDocumentdoc - booloverwrite&true; - intcommitWithin0 - - - Cette méthode ajoute un document à l'index. - - - - - - &reftitle.parameters; - - - - doc - - - L'instance SolrInputDocument. - - - - - overwrite - - - Si l'on doit ou non écraser un document existant. - Si vaut &false;, 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 - - - - - - commitWithin - - - Nombre de millisecondes après lequel le document doit être validé. - 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 exigences de latence des mises à jour ; Solr va automatiquement - réaliser une validation lorsque le plus vieil ajout du buffer est atteint. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrUpdateResponse et lance une - exception si une erreur survient. - - - - - &reftitle.errors; - - Lance une exception SolrClientException si le client a échoué - ou s'il y a eu un problème avec la connexion. - - - Lance une exception SolrServerException si le serveur - Solr a échoué dans l'exécution de la requête. - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrClient::addDocument</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -$updateResponse = $client->addDocument($doc); - -// vous devriez valider ces modifications si vous n'utilisez pas $commitWithin -$client->commit(); - -print_r($updateResponse->getResponse()); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - ) - -) - -]]> - - - - - - Exemple 2 avec <methodname>SolrClient::addDocument</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -// Inutile d'appeler commit() car $commitWithin est passé ; ainsi, -// le serveur Solr va valider automatiquement dans les 10 secondes - -$updateResponse = $client->addDocument($doc, false, 10000); - -print_r($updateResponse->getResponse()); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - ) - -) - -]]> - - - - - - - - &reftitle.seealso; - - - SolrClient::addDocuments - SolrClient::commit - - - - - - - diff --git a/reference/solr/solrclient/adddocuments.xml b/reference/solr/solrclient/adddocuments.xml deleted file mode 100644 index ded2f3e16d..0000000000 --- a/reference/solr/solrclient/adddocuments.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - - - SolrClient::addDocuments - Ajoute une collection d'instances SolrInputDocument à l'index - - - - &reftitle.description; - - public voidSolrClient::addDocuments - arraydocs - booloverwrite&true; - intcommitWithin0 - - - Ajoute une collection de documents à l'index. - - - - - - &reftitle.parameters; - - - - docs - - - Un tableau contenant la collection d'instances SolrInputDocument. - Ce tableau doit être une variable réelle. - - - - - overwrite - - - Si l'on doit écraser les documents ou non. Si vaut &false;, - 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 - - - - - - commitWithin - - - 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 vieil ajout - du buffer est atteint. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrUpdateResponse en cas de succès, - et lance une exception si une erreur survient. - - - - - &reftitle.errors; - - Lance une exception SolrClientException si le client a échoué - ou s'il y a eu un problème avec la connexion. - - - Lance une exception SolrServerException si le serveur - Solr a échoué dans l'exécution de la requête. - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrClient::addDocuments</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -$doc2 = clone $doc; - -$doc2->deleteField('id'); -$doc2->addField('id', 334456); - -$docs = array($doc, $doc2); - -$updateResponse = $client->addDocuments($docs); - -// Aucune modification ne sera écrite sur le disque tant que l'argument $commitWithin ne soit passé, ou la méthode SolrClient::commit appelée. - -print_r($updateResponse->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 2 - ) - -) - -]]> - - - - - - - &reftitle.seealso; - - - SolrClient::addDocument - SolrClient::commit - - - - - - - diff --git a/reference/solr/solrclient/commit.xml b/reference/solr/solrclient/commit.xml deleted file mode 100644 index f7d01ef85a..0000000000 --- a/reference/solr/solrclient/commit.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - - SolrClient::commit - Commit tous les ajouts/modifications effectués sur l'index - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::commit - boolsoftCommit&false; - boolwaitSearcher&true; - boolexpungeDeletes&false; - - - Commit tous les ajouts/modifications effectués sur l'index. - - - - - - &reftitle.parameters; - - - - softCommit - - - 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 une perte d'énergie, les modifications - 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. - - - - - waitSearcher - - - Attend jusqu'à ce qu'un nouvel objet de recherche soit ouvert - et enregistré comme objet de recherche principal, rendant visible - les modifications. - - - - - expungeDeletes - - - Supprime définitivement les effacements. (Solr1.4+) - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrUpdateResponse en cas de succès, - et lance une exception si une erreur survient. - - - - - &reftitle.errors; - - Lance une exception SolrClientException si le client a échoué - ou s'il y a eu un problème avec la connexion. - - - Lance une exception SolrServerException si le serveur - Solr a échoué dans l'exécution de la requête. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL solr 1.1.0, PECL solr 2.0.0 - - Suppression de l'argument $maxSegments - - - - PECL solr 2.0.0b - - Modification de l'API : SolrClient::commit ([ int $maxSegments = 0 [, bool $softCommit = false [, bool $waitSearcher = true[, bool $expungeDeletes = false ]]] ) - - - - PECL solr 0.9.2 - - Signature : SolrClient::commit ([ int $maxSegments = 1 [, bool $waitFlush = true [, bool $waitSearcher = true ]]] ). - $waitFlush : bloque tant que les modifications de l'index ne sont pas écrites sur le disque. - - - - - - - - - - &reftitle.notes; - - - PECL Solr >= 2.0 ne supporte que le serveur Solr >= 4.0 - - - - - - &reftitle.seealso; - - - SolrClient::optimize - SolrClient::rollback - - - - - - - diff --git a/reference/solr/solrclient/construct.xml b/reference/solr/solrclient/construct.xml deleted file mode 100644 index fb7f37bb83..0000000000 --- a/reference/solr/solrclient/construct.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - - SolrClient::__construct - Constructeur de l'objet SolrClient - - - - &reftitle.description; - - public SolrClient::__construct - arrayclientOptions - - - Constructeur de l'objet SolrClient. - - - - - - &reftitle.parameters; - - - - clientOptions - - - Tableau contenant les clés suivantes : - - - - - - - - - - - - - &reftitle.errors; - - Lance une exception SolrIllegalArgumentException en cas d'échec. - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrClient::__construct</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_PATH_TO_SOLR, - 'wt' => 'xml', -); - -$client = new SolrClient($options); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -$updateResponse = $client->addDocument($doc); - -?> - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - SolrClient::getOptions - - - - - - diff --git a/reference/solr/solrclient/deletebyid.xml b/reference/solr/solrclient/deletebyid.xml deleted file mode 100644 index 3050adee0b..0000000000 --- a/reference/solr/solrclient/deletebyid.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - SolrClient::deleteById - Effacement par Id - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::deleteById - stringid - - - Efface un document en spécifiant son ID. L'ID est la valeur - du champ uniqueKey déclaré dans le schéma. - - - - - - &reftitle.parameters; - - - - id - - - La valeur du champ uniqueKey déclaré dans le schéma. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrUpdateResponse en cas de succès, - et lance une exception en cas d'échec. - - - - - &reftitle.errors; - - Lance une exception SolrClientException si le client a échoué - ou s'il y a eu un problème avec la connexion. - - - Lance une exception SolrServerException si le serveur - Solr a échoué dans l'exécution de la requête. - - - - - &reftitle.seealso; - - - SolrClient::deleteByIds - SolrClient::deleteByQuery - SolrClient::deleteByQueries - - - - - - - diff --git a/reference/solr/solrclient/deletebyids.xml b/reference/solr/solrclient/deletebyids.xml deleted file mode 100644 index 92a4709c5d..0000000000 --- a/reference/solr/solrclient/deletebyids.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - SolrClient::deleteByIds - Effacement par Ids - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::deleteByIds - arrayids - - - Efface une collection de documents représentée par le jeu d'Ids spécifié. - - - - - - &reftitle.parameters; - - - - ids - - - Un tableau d'Ids, représentant le champ uniqueKey - déclaré dans le schéma de chaque document. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrUpdateResponse en cas de succès, - et lance une exception en cas d'échec. - - - - - &reftitle.errors; - - Lance une exception SolrClientException si le client a échoué - ou s'il y a eu un problème avec la connexion. - - - Lance une exception SolrServerException si le serveur - Solr a échoué dans l'exécution de la requête. - - - - - &reftitle.seealso; - - - SolrClient::deleteById - SolrClient::deleteByQuery - SolrClient::deleteByQueries - - - - - - - diff --git a/reference/solr/solrclient/deletebyqueries.xml b/reference/solr/solrclient/deletebyqueries.xml deleted file mode 100644 index ff80544a49..0000000000 --- a/reference/solr/solrclient/deletebyqueries.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - SolrClient::deleteByQueries - Efface tous les documents correspondant à des requêtes - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::deleteByQueries - arrayqueries - - - Efface tous les documents correspondant à des requêtes. - - - - - - &reftitle.parameters; - - - - queries - - - Un tableau de requêtes. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrUpdateResponse en cas de succès, - et lance une exception SolrClientException en cas d'échec. - - - - - &reftitle.errors; - - Lance une exception SolrClientException si le client - a échoué, ou s'il y a eu un problème avec la connexion. - - - Lance une exception SolrServerException si le serveur - Solr a échoué dans l'exécution de la requête. - - - - - &reftitle.seealso; - - - SolrClient::deleteById - SolrClient::deleteByIds - SolrClient::deleteByQuery - - - - - - - diff --git a/reference/solr/solrclient/deletebyquery.xml b/reference/solr/solrclient/deletebyquery.xml deleted file mode 100644 index b6641d5e6e..0000000000 --- a/reference/solr/solrclient/deletebyquery.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - - SolrClient::deleteByQuery - Efface tous les documents correspondant à une requête - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::deleteByQuery - stringquery - - - Efface tous les documents correspondant à la requête fournie. - - - - - - &reftitle.parameters; - - - - query - - - La requête. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrUpdateResponse en cas de succès, - et lance une exception en cas d'échec. - - - - - &reftitle.errors; - - Lance une exception SolrClientException si le client a échoué, - ou s'il y a eu un problème avec la connexion. - - - Lance une exception SolrServerException si le serveur Solr - a échoué dans l'exécution de la requête. - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrQuery::deleteByQuery</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -//Ceci va effacer la totalité de l'index -$client->deleteByQuery("*:*"); -$client->commit(); - -?> -]]> - - - - - - - &reftitle.seealso; - - - SolrClient::deleteById - SolrClient::deleteByIds - SolrClient::deleteByQueries - - - - - - - diff --git a/reference/solr/solrclient/destruct.xml b/reference/solr/solrclient/destruct.xml deleted file mode 100644 index c6a4ea0327..0000000000 --- a/reference/solr/solrclient/destruct.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - SolrClient::__destruct - Destructeur pour SolrClient - - - - &reftitle.description; - - public SolrClient::__destruct - - - - Destructeur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Destructeur pour SolrClient. - - - - - &reftitle.seealso; - - - SolrClient::__construct - - - - - - - diff --git a/reference/solr/solrclient/getbyid.xml b/reference/solr/solrclient/getbyid.xml deleted file mode 100644 index 27adb1b228..0000000000 --- a/reference/solr/solrclient/getbyid.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - SolrClient::getById - Renvoie un document par son identifiant. Utilise la fonctionnalité de recherche en temps réel de Solr (Solr Realtime Get - RTG) - - - - &reftitle.description; - - public SolrQueryResponseSolrClient::getById - stringid - - - Renvoie un document par son identifiant. Utilise la recherche en temps réel de Solr. - - - - - &reftitle.parameters; - - - id - - - L'identifiant du document. - - - - - - - - &reftitle.returnvalues; - - SolrQueryResponse - - - - - &reftitle.examples; - - Exemple de <function>SolrClient::getById</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); -$response = $client->getById('GB18030TEST'); -print_r($response->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [id] => GB18030TEST - [name] => Array - ( - [0] => Test with some GB18030 encoded characters - ) - - [features] => Array - ( - [0] => No accents here - [1] => 这是一个功能 - [2] => This is a feature (translated) - [3] => 这份文件是很有光泽 - [4] => This document is very shiny (translated) - ) - - [price] => Array - ( - [0] => 0 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [_version_] => 1510294336239042560 - ) - -) -]]> - - - - - - - &reftitle.seealso; - - SolrClient::getByIds - - - - - - diff --git a/reference/solr/solrclient/getbyids.xml b/reference/solr/solrclient/getbyids.xml deleted file mode 100644 index 448af22dda..0000000000 --- a/reference/solr/solrclient/getbyids.xml +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - SolrClient::getByIds - Renvoie des documents par leurs identifiants. Utilise la fonctionnalité de recherche en temps réel de Solr (Solr Realtime Get - RTG) - - - - &reftitle.description; - - public SolrQueryResponseSolrClient::getByIds - arrayids - - - Renvoie les documents par leurs identifiants. Utilise la recherche en temps réel de Solr. - - - - - - &reftitle.parameters; - - - ids - - - Les identifiants des documents. - - - - - - - - &reftitle.returnvalues; - - SolrQueryResponse - - - - - &reftitle.examples; - - Exemple de <function>SolrClient::getByIds</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); -$response = $client->getByIds(['GB18030TEST', '6H500F0']); - -print_r($response->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [numFound] => 2 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [id] => GB18030TEST - [name] => Array - ( - [0] => Test with some GB18030 encoded characters - ) - - [features] => Array - ( - [0] => No accents here - [1] => 这是一个功能 - [2] => This is a feature (translated) - [3] => 这份文件是很有光泽 - [4] => This document is very shiny (translated) - ) - - [price] => Array - ( - [0] => 0 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [_version_] => 1510294336239042560 - ) - - [1] => SolrObject Object - ( - [id] => 6H500F0 - [name] => Array - ( - [0] => Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300 - ) - - [manu] => Array - ( - [0] => Maxtor Corp. - ) - - [manu_id_s] => maxtor - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => SATA 3.0Gb/s, NCQ - [1] => 8.5ms seek - [2] => 16MB cache - ) - - [price] => Array - ( - [0] => 350 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 45.17614,-93.87341 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [_version_] => 1510294336449806336 - ) - - ) - - ) - -) -]]> - - - - - - - &reftitle.seealso; - - SolrClient::getById - - - - - - diff --git a/reference/solr/solrclient/getdebug.xml b/reference/solr/solrclient/getdebug.xml deleted file mode 100644 index 25885ede66..0000000000 --- a/reference/solr/solrclient/getdebug.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrClient::getDebug - Récupère les données de débogage de la dernière tentative de connexion - - - - &reftitle.description; - - public stringSolrClient::getDebug - - - - Retourne les données de débogage de la dernière tentative de connexion. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; s'il n'y a aucune - donnée à retourner. - - - - - - diff --git a/reference/solr/solrclient/getoptions.xml b/reference/solr/solrclient/getoptions.xml deleted file mode 100644 index 4f3fc6088c..0000000000 --- a/reference/solr/solrclient/getoptions.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrClient::getOptions - Récupère les options clientes définies en interne - - - - &reftitle.description; - - public arraySolrClient::getOptions - - - - 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. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant toutes les options de l'objet - SolrClient définies en interne. - - - - - &reftitle.seealso; - - - SolrClient::__construct - - - - - - - diff --git a/reference/solr/solrclient/optimize.xml b/reference/solr/solrclient/optimize.xml deleted file mode 100644 index a471e1e099..0000000000 --- a/reference/solr/solrclient/optimize.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - SolrClient::optimize - Défragmente l'index - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::optimize - intmaxSegments1 - boolsoftCommit&true; - boolwaitSearcher&true; - - - Défragmente l'index afin de rendre la recherche plus - performante. - - - - - - &reftitle.parameters; - - - - maxSegments - - - Optimise jusqu'à ce nombre de fragments. Disponible depuis Solr 1.3. - - - - - softCommit - - - Permet de rafraîchir la vue de l'index de manière plus performante, - mais sans garantie "sur le disque". (Solr4.0+) - - - - - waitSearcher - - - S'interrompt jusqu'à ce qu'un nouvel objet de recherche soit ouvert et - enregistré comme objet principal, rendant les modifications visibles. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrUpdateResponse en cas de succès, ou lance - une exception en cas d'échec. - - - - - &reftitle.errors; - - Lance une exception SolrClientException si le client - a échoué, ou s'il y a eu un problème avec la connexion. - - - Lance une exception SolrServerException si le serveur - Solr a échoué dans l'exécution de la requête. - - - - - &reftitle.notes; - - - PECL Solr >= 2.0 ne supporte que Solr Server >= 4.0 - - - Avant PECL Solr 2.0, cette méthode utilisait les arguments suivants : - "int $maxSegments, bool $waitFlush, bool $waitSearcher". - - - - - - &reftitle.seealso; - - - SolrClient::commit - SolrClient::rollback - - - - - - - diff --git a/reference/solr/solrclient/ping.xml b/reference/solr/solrclient/ping.xml deleted file mode 100644 index ecb7d54a38..0000000000 --- a/reference/solr/solrclient/ping.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - SolrClient::ping - Vérifie si le serveur Solr est disponible - - - - &reftitle.description; - - public SolrPingResponseSolrClient::ping - - - - Vérifie si le serveur Solr est toujours disponible. - Envoie une requête HEAD au serveur Apache Solr. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un objet SolrPingResponse en cas de succès, - et lance une exception SolrClientException en cas d'échec. - - - - - &reftitle.errors; - - Lance une exception SolrClientException si le - client a échoué, ou s'il y a eu un problème avec la connexion. - - - Lance une exception SolrServerException si le - serveur Solr n'a pas réussi à satisfaire la requête. - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrClient::ping</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$pingresponse = $client->ping(); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrclient/query.xml b/reference/solr/solrclient/query.xml deleted file mode 100644 index 5e85f6925b..0000000000 --- a/reference/solr/solrclient/query.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - - - SolrClient::query - Envoie une requête au serveur - - - - &reftitle.description; - - public SolrQueryResponseSolrClient::query - SolrParamsquery - - - Envoie une requête au serveur. - - - - - - &reftitle.parameters; - - - - query - - - Un objet SolrParams. Il est recommandé d'utiliser un objet - SolrQuery pour des requêtes avancées. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrQueryResponse en cas de succès, et - lance une exception en cas d'échec. - - - - - &reftitle.errors; - - Lance une exception SolrClientException si le client a échoué - ou s'il y a eu un problème avec la connexion. - - - Lance une exception SolrServerException si le serveur - Solr a échoué dans l'exécution de la requête. - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrClient::query</methodname> - - 'localhost', - 'login' => 'username', - 'password' => 'password', - 'port' => '8983', -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setQuery('lucene'); - -$query->setStart(0); - -$query->setRows(50); - -$query->addField('cat')->addField('features')->addField('id')->addField('timestamp'); - -$query_response = $client->query($query); - -$response = $query_response->getResponse(); - -print_r($response); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 3 - [params] => SolrObject Object - ( - [fl] => cat,features,id,timestamp - [indent] => on - [start] => 0 - [q] => lucene - [wt] => xml - [version] => 2.2 - [rows] => 50 - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 1 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [id] => SOLR1000 - [cat] => Array - ( - [0] => software - [1] => search - ) - - [features] => Array - ( - [0] => Advanced Full-Text Search Capabilities using Lucene - [1] => Optimized for High Volume Web Traffic - [2] => Standards Based Open Interfaces - XML and HTTP - [3] => Comprehensive HTML Administration Interfaces - [4] => Scalability - Efficient Replication to other Solr Search Servers - [5] => Flexible and Adaptable with XML configuration and Schema - [6] => Good unicode support: héllo (hello with an accent over the e) - ) - - ) - - ) - - ) - -) -]]> - - - - - - - - diff --git a/reference/solr/solrclient/request.xml b/reference/solr/solrclient/request.xml deleted file mode 100644 index 0937037574..0000000000 --- a/reference/solr/solrclient/request.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - SolrClient::request - Envoie une requête brute de mise à jour - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::request - stringraw_request - - - Envoie une requête XML brute de mise à jour au serveur. - - - - - - &reftitle.parameters; - - - - raw_request - - - Une chaîne XML contenant la requête brute vers le serveur. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrUpdateResponse en cas de succès. - Lance une exception en cas d'échec. - - - - - &reftitle.errors; - - Lance une exception SolrIllegalArgumentException si - raw_request est une chaîne vide. - - - Lance une exception SolrClientException si le client a échoué - ou s'il y a eu un problème avec la connexion. - - - Lance une exception SolrServerException si le serveur - Solr a échoué dans l'exécution de la requête. - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrClient::request</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$update_response = $client->request(""); - -$response = $update_response->getResponse(); - -print_r($response); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrclient/rollback.xml b/reference/solr/solrclient/rollback.xml deleted file mode 100644 index 9b456258b8..0000000000 --- a/reference/solr/solrclient/rollback.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrClient::rollback - Annule les ajouts/effacements effectués sur l'index depuis le dernier commit - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::rollback - - - - 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. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un objet SolrUpdateResponse en cas de succès, ou - lance une exception SolrClientException si une erreur survient. - - - - - &reftitle.seealso; - - - SolrClient::commit - SolrClient::optimize - - - - - - - diff --git a/reference/solr/solrclient/setresponsewriter.xml b/reference/solr/solrclient/setresponsewriter.xml deleted file mode 100644 index f3ddc62e54..0000000000 --- a/reference/solr/solrclient/setresponsewriter.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - - SolrClient::setResponseWriter - Définit le gestionnaire à utiliser pour préparer la réponse depuis Solr - - - - &reftitle.description; - - public voidSolrClient::setResponseWriter - stringresponseWriter - - - Définit le gestionnaire à utiliser pour préparer la réponse depuis Solr. - - - - - - &reftitle.parameters; - - - - responseWriter - - Un parmi les suivants : - - json - phps - xml - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrClient::setResponseWriter</methodname> - -$property_name; - - } else if (isset($_properties[$property_name])) { - - return $_properties[$property_name]; - } - - return null; - } -} - -$options = array -( - 'hostname' => 'localhost', - 'port' => 8983, - 'path' => '/solr/core1' -); - -$client = new SolrClient($options); - -$client->setResponseWriter("json"); - -//$response = $client->ping(); - -$query = new SolrQuery(); - -$query->setQuery("*:*"); - -$query->set("objectClassName", "SolrClass"); - -$query->set("objectPropertiesStorageMode", 1); // 0 pour des propriétés indépendantes, 1 pour des propriétés combinées - -try -{ - -$response = $client->query($query); - -$resp = $response->getResponse(); - -print_r($response); - -print_r($resp); - -} catch (Exception $e) { - -print_r($e); - -} - -?> -]]> - - - - - - - - diff --git a/reference/solr/solrclient/setservlet.xml b/reference/solr/solrclient/setservlet.xml deleted file mode 100644 index ae91497421..0000000000 --- a/reference/solr/solrclient/setservlet.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - SolrClient::setServlet - Modifie le type d'un servlet en une nouvelle valeur - - - - &reftitle.description; - - public boolSolrClient::setServlet - inttype - stringvalue - - - Modifie le type d'un servlet en une nouvelle valeur. - - - - - - &reftitle.parameters; - - - - type - - Une constante parmi : - - - - - - - value - - - La nouvelle valeur du servlet - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrclient/system.xml b/reference/solr/solrclient/system.xml deleted file mode 100644 index b8773a87c8..0000000000 --- a/reference/solr/solrclient/system.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrClient::system - Récupère les informations du serveur Solr - - - - &reftitle.description; - - public voidSolrClient::system - - - - Récupère les informations du serveur Solr - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un objet SolrGenericResponse en cas de succès. - - - - - &reftitle.errors; - - Émet SolrClientException si le client a échoué, ou s'il y a eu un problème de connexion. - - - Émet SolrServerException si le serveur Solr n'a pas pu satisfaire la requête. - - - - - - diff --git a/reference/solr/solrclient/threads.xml b/reference/solr/solrclient/threads.xml deleted file mode 100644 index 05a8a84880..0000000000 --- a/reference/solr/solrclient/threads.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrClient::threads - Vérifie le statut des threads - - - - &reftitle.description; - - public voidSolrClient::threads - - - - Vérifie le statut des threads. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un objet SolrGenericResponse. - - - - - &reftitle.errors; - - Lance une exception SolrClientException si le client a échoué - ou s'il y a eu un problème avec la connexion. - - - Lance une exception SolrServerException si le serveur - Solr a échoué dans l'exécution de la requête. - - - - - - diff --git a/reference/solr/solrclientexception.xml b/reference/solr/solrclientexception.xml deleted file mode 100644 index 84c55d0be6..0000000000 --- a/reference/solr/solrclientexception.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - La classe SolrClientException - SolrClientException - - - - -
    - &reftitle.intro; - - Une exception est lancée lorsqu'une erreur survient pendant l'exécution - d'une requête vers le serveur depuis le client. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrClientException - - - - - SolrClientException - - - - extends - SolrException - - - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -     - - &reference.solr.entities.solrclientexception; - -     - - diff --git a/reference/solr/solrclientexception/getinternalinfo.xml b/reference/solr/solrclientexception/getinternalinfo.xml deleted file mode 100644 index 3d0e4a2924..0000000000 --- a/reference/solr/solrclientexception/getinternalinfo.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrClientException::getInternalInfo - Retourne des informations internes sur l'endroit d'où est lancée l'exception - - - - &reftitle.description; - - public arraySolrClientException::getInternalInfo - - - - Retourne des informations internes sur l'endroit d'où est lancée l'exception. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant des informations internes sur l'endroit d'où est lancée l'exception. - Utilisé uniquement par les développeurs de l'extension. - - - - - - diff --git a/reference/solr/solrcollapsefunction.xml b/reference/solr/solrcollapsefunction.xml deleted file mode 100644 index cc8c6dab3e..0000000000 --- a/reference/solr/solrcollapsefunction.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - La classe SolrCollapseFunction - SolrCollapseFunction - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrCollapseFunction - - - - - SolrCollapseFunction - - - - &Constants; - - const - string - SolrCollapseFunction::NULLPOLICY_IGNORE - ignore - - - const - string - SolrCollapseFunction::NULLPOLICY_EXPAND - expand - - - const - string - SolrCollapseFunction::NULLPOLICY_COLLAPSE - collapse - - - &Methods; - - - - - - - -
    - - -
    - &reftitle.constants; - - - - SolrCollapseFunction::NULLPOLICY_IGNORE - - - - - - - SolrCollapseFunction::NULLPOLICY_EXPAND - - - - - - - SolrCollapseFunction::NULLPOLICY_COLLAPSE - - - - - - -
    - - - -     - - &reference.solr.entities.solrcollapsefunction; - -     - - diff --git a/reference/solr/solrcollapsefunction/construct.xml b/reference/solr/solrcollapsefunction/construct.xml deleted file mode 100644 index 2b1a79706b..0000000000 --- a/reference/solr/solrcollapsefunction/construct.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - SolrCollapseFunction::__construct - Constructeur - - - - &reftitle.description; - - public SolrCollapseFunction::__construct - stringfield - - - Fonction de construction de Collapse. - - - - - - &reftitle.parameters; - - - field - - - Le nom du champ à réduire. - - - Pour réduire un résultat, le type de champ doit être une chaîne de caractères, un entier ou un flottant. - - - - - - - - &reftitle.examples; - - Exemple de <function>SolrCollapseFunction::__construct</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$func = new SolrCollapseFunction('field_name'); - -$func->setMax('sum(cscore(),field(some_other_field))'); -$func->setSize(100); -$func->setNullPolicy(SolrCollapseFunction::NULLPOLICY_EXPAND); - -$query->collapse($func); - -$queryResponse = $client->query($query); - -$response = $queryResponse->getResponse(); - -print_r($response); - -?> -]]> - - - - - - - &reftitle.seealso; - - SolrQuery::collapse - - - - - - diff --git a/reference/solr/solrcollapsefunction/getfield.xml b/reference/solr/solrcollapsefunction/getfield.xml deleted file mode 100644 index 8157b8fa4d..0000000000 --- a/reference/solr/solrcollapsefunction/getfield.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrCollapseFunction::getField - Renvoie le champ sur lequel la réduction est effectué - - - - &reftitle.description; - - public stringSolrCollapseFunction::getField - - - - Renvoie le champ sur lequel la réduction est effectuée. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setField - - - - - - diff --git a/reference/solr/solrcollapsefunction/gethint.xml b/reference/solr/solrcollapsefunction/gethint.xml deleted file mode 100644 index af2e40a421..0000000000 --- a/reference/solr/solrcollapsefunction/gethint.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrCollapseFunction::getHint - Renvoie l'indice de réduction - - - - &reftitle.description; - - public stringSolrCollapseFunction::getHint - - - - Renvoie l'indice de réduction. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setHint - - - - - - diff --git a/reference/solr/solrcollapsefunction/getmax.xml b/reference/solr/solrcollapsefunction/getmax.xml deleted file mode 100644 index 0bf7fb3ef0..0000000000 --- a/reference/solr/solrcollapsefunction/getmax.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrCollapseFunction::getMax - Renvoie le paramètre max - - - - &reftitle.description; - - public stringSolrCollapseFunction::getMax - - - - Renvoie le paramètre max. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setMax - - - - - - diff --git a/reference/solr/solrcollapsefunction/getmin.xml b/reference/solr/solrcollapsefunction/getmin.xml deleted file mode 100644 index 17fcffe7f5..0000000000 --- a/reference/solr/solrcollapsefunction/getmin.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrCollapseFunction::getMin - Renvoie le paramètre min - - - - &reftitle.description; - - public stringSolrCollapseFunction::getMin - - - - Renvoie le paramètre min. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setMin - - - - - - diff --git a/reference/solr/solrcollapsefunction/getnullpolicy.xml b/reference/solr/solrcollapsefunction/getnullpolicy.xml deleted file mode 100644 index 5114d321bc..0000000000 --- a/reference/solr/solrcollapsefunction/getnullpolicy.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrCollapseFunction::getNullPolicy - Renvoie la politique de null - - - - &reftitle.description; - - public stringSolrCollapseFunction::getNullPolicy - - - - Renvoie la politique de null utilisée ou null - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setNullPolicy - - - - - - diff --git a/reference/solr/solrcollapsefunction/getsize.xml b/reference/solr/solrcollapsefunction/getsize.xml deleted file mode 100644 index e74a3aefd8..0000000000 --- a/reference/solr/solrcollapsefunction/getsize.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrCollapseFunction::getSize - Renvoie le paramètre de taille - - - - &reftitle.description; - - public intSolrCollapseFunction::getSize - - - - Renvoie la taille initiale des structures de données de réduction lors de la réduction sur un champ numérique uniquement - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setSize - - - - - - diff --git a/reference/solr/solrcollapsefunction/setfield.xml b/reference/solr/solrcollapsefunction/setfield.xml deleted file mode 100644 index ce7aaa0251..0000000000 --- a/reference/solr/solrcollapsefunction/setfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrCollapseFunction::setField - Définit le champ sur lequel la réduction est effectuée - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setField - stringfieldName - - - Le champ sur lequel la réduction est effectuée. - - Pour réduire un résultat, le type de champ doit être une chaîne de caractères, un entier ou un flottant. - - - - - - &reftitle.parameters; - - - fieldName - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - - diff --git a/reference/solr/solrcollapsefunction/sethint.xml b/reference/solr/solrcollapsefunction/sethint.xml deleted file mode 100644 index 2ad884d075..0000000000 --- a/reference/solr/solrcollapsefunction/sethint.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - SolrCollapseFunction::setHint - Définit l'indice de réduction - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setHint - stringhint - - - Définit l'indice de réduction. - - - - - - &reftitle.parameters; - - - hint - - - Actuellement, il n'y a qu'un seul indice disponible "top_fc", qui signifie top level FieldCache - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - &reftitle.examples; - - Exemple de <function>SolrCollapseFunction::setHint</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/solr/solrcollapsefunction/setmax.xml b/reference/solr/solrcollapsefunction/setmax.xml deleted file mode 100644 index 2417ab5535..0000000000 --- a/reference/solr/solrcollapsefunction/setmax.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - SolrCollapseFunction::setMax - Sélectionne les têtes de groupe par la valeur maximale d'un champ numérique ou d'une requête de fonction - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setMax - stringmax - - - Sélectionne les têtes de groupe par la valeur maximale d'un champ numérique ou d'une requête de fonction. - - - - - - &reftitle.parameters; - - - max - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - &reftitle.examples; - - Exemple de <function>SolrCollapseFunction::setMax</function> - -setMax('sum(cscore(),field(some_field))'); - -$query = new SolrQuery('*:*'); - -$query->collapse($func); - -?> -]]> - - - - - - diff --git a/reference/solr/solrcollapsefunction/setmin.xml b/reference/solr/solrcollapsefunction/setmin.xml deleted file mode 100644 index 480f929ade..0000000000 --- a/reference/solr/solrcollapsefunction/setmin.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrCollapseFunction::setMin - Définit la taille initiale des structures de données de réduction lors de la réduction sur un champ numérique uniquement - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setMin - stringmin - - - Définit la taille initiale des structures de données de réduction lors de la réduction sur un champ numérique uniquement - - - - - - &reftitle.parameters; - - - min - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - - diff --git a/reference/solr/solrcollapsefunction/setnullpolicy.xml b/reference/solr/solrcollapsefunction/setnullpolicy.xml deleted file mode 100644 index 28f0988d83..0000000000 --- a/reference/solr/solrcollapsefunction/setnullpolicy.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrCollapseFunction::setNullPolicy - Définit la politique NULL - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setNullPolicy - stringnullPolicy - - - Définit la politique NULL. L'une des 3 politiques définies en tant que constantes de classe doit être passée. - Accepte les politiques ignore, expand ou collapse. - - - - - - &reftitle.parameters; - - - nullPolicy - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - - diff --git a/reference/solr/solrcollapsefunction/setsize.xml b/reference/solr/solrcollapsefunction/setsize.xml deleted file mode 100644 index 8767e64f9b..0000000000 --- a/reference/solr/solrcollapsefunction/setsize.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrCollapseFunction::setSize - Définit la taille initiale des structures de données de réduction lors de la réduction sur un champ numérique uniquement - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setSize - intsize - - - Définit la taille initiale des structures de données de réduction lors de la réduction sur un champ numérique uniquement. - - - - - - &reftitle.parameters; - - - size - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - - diff --git a/reference/solr/solrcollapsefunction/tostring.xml b/reference/solr/solrcollapsefunction/tostring.xml deleted file mode 100644 index 93d2ecf11a..0000000000 --- a/reference/solr/solrcollapsefunction/tostring.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrCollapseFunction::__toString - Renvoie une chaîne représentant la fonction de réduction construite - - - - &reftitle.description; - - public stringSolrCollapseFunction::__toString - - - - Renvoie une chaîne représentant la fonction de réduction construite - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/solr/solrdismaxquery.xml b/reference/solr/solrdismaxquery.xml deleted file mode 100644 index d1a302ee6f..0000000000 --- a/reference/solr/solrdismaxquery.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - La classe SolrDisMaxQuery - SolrDisMaxQuery - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrDisMaxQuery - - - - - SolrDisMaxQuery - - - - extends - SolrQuery - - - - Serializable - - - - - &InheritedProperties; - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - SolrDisMaxQuery::ORDER_ASC - - Utilisé pour spécifier que le tri doit être effectué dans l'ordre croissant (Dupliqué pour faciliter la migration) - - - - - SolrDisMaxQuery::ORDER_DESC - - Utilisé pour spécifier que le tri doit être effectué dans l'ordre décroissant (Dupliqué pour faciliter la migration) - - - - - SolrDisMaxQuery::FACET_SORT_INDEX - - Utilisé pour spécifier que la facette doit être triée par index (Dupliqué pour faciliter la migration) - - - - - SolrDisMaxQuery::FACET_SORT_COUNT - - Utilisé pour spécifier que la facette doit être triée par nombre (Dupliqué pour faciliter la migration) - - - - - SolrDisMaxQuery::TERMS_SORT_INDEX - - Utilisé dans le TermsComponent (Dupliqué pour faciliter la migration) - - - - - SolrDisMaxQuery::TERMS_SORT_COUNT - - Utilisé dans le TermsComponent (Dupliqué pour faciliter la migration) - - - - -
    - - - -     - - &reference.solr.entities.solrdismaxquery; - -     - - diff --git a/reference/solr/solrdismaxquery/addbigramphrasefield.xml b/reference/solr/solrdismaxquery/addbigramphrasefield.xml deleted file mode 100644 index e5009f57c8..0000000000 --- a/reference/solr/solrdismaxquery/addbigramphrasefield.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - SolrDisMaxQuery::addBigramPhraseField - Ajoute un champ de bigramme de phrase (paramètre pf2) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addBigramPhraseField - stringfield - stringboost - stringslop - - - Ajoute un champ de bigramme de phrase (paramètre pf2) - Format de sortie: champ~slop^boost OU champ^boost - Slop est facultatif - - - - - - &reftitle.parameters; - - - field - - - - - - - - boost - - - - - - - - slop - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::addBigramPhraseField</function> - -addBigramPhraseField('cat', 2, 5.1) - ->addBigramPhraseField('feature', 4.5) -; -echo $dismaxQuery; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeBigramPhraseField - SolrDisMaxQuery::setBigramPhraseFields - SolrDisMaxQuery::setBigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/addboostquery.xml b/reference/solr/solrdismaxquery/addboostquery.xml deleted file mode 100644 index 9d9e3ababd..0000000000 --- a/reference/solr/solrdismaxquery/addboostquery.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - SolrDisMaxQuery::addBoostQuery - Ajoute un champ de requête de boost avec valeur et boost facultatif (paramètre bq) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addBoostQuery - stringfield - stringvalue - stringboost - - - Ajoute un champ de requête de boost avec valeur [et boost] (paramètre bq) - - - - - - &reftitle.parameters; - - - field - - - - - - - - value - - - - - - - - boost - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::addBoostQuery</function> - -addBoostQuery('cat', 'clothing', 2) - ->addBoostQuery('cat', 'electronics', 5.1) -; -echo $dismaxQuery.PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeBoostQuery - SolrDisMaxQuery::setBoostQuery - - - - - - diff --git a/reference/solr/solrdismaxquery/addphrasefield.xml b/reference/solr/solrdismaxquery/addphrasefield.xml deleted file mode 100644 index 4a41765c96..0000000000 --- a/reference/solr/solrdismaxquery/addphrasefield.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - SolrDisMaxQuery::addPhraseField - Ajoute une phrase de champ (paramètre pf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addPhraseField - stringfield - stringboost - stringslop - - - Ajoute une phrase de champ (paramètre pf) - - - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - boost - - - - - - - - slop - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::addPhraseField</function> - -addPhraseField('cat', 3, 1) - ->addPhraseField('third', 4, 2) - ->addPhraseField('source', 55) -; -echo $dismaxQuery; -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removePhraseField - SolrDisMaxQuery::setPhraseFields - - - - - - diff --git a/reference/solr/solrdismaxquery/addqueryfield.xml b/reference/solr/solrdismaxquery/addqueryfield.xml deleted file mode 100644 index 541ef36302..0000000000 --- a/reference/solr/solrdismaxquery/addqueryfield.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - SolrDisMaxQuery::addQueryField - Ajoute un champ de requête avec boost facultatif (paramètre qf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addQueryField - stringfield - stringboost - - - Ajoute un champ de requête avec boost facultatif (paramètre qf) - - - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - boost - - - Le boost facultatif. Booste les documents avec des termes correspondants. - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::addQueryField</function> - -addQueryField("location", 4) - ->addQueryField("price") - ->addQueryField("sku") - ->addQueryField("title",3.4) -; -echo $dismaxQuery; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeQueryField - - - - - - diff --git a/reference/solr/solrdismaxquery/addtrigramphrasefield.xml b/reference/solr/solrdismaxquery/addtrigramphrasefield.xml deleted file mode 100644 index 5b9215ab5b..0000000000 --- a/reference/solr/solrdismaxquery/addtrigramphrasefield.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - SolrDisMaxQuery::addTrigramPhraseField - Ajoute un champ de trigramme de phrase (paramètre pf3) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addTrigramPhraseField - stringfield - stringboost - stringslop - - - Ajoute un champ de trigramme de phrase (paramètre pf3) - - - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - boost - - - Le boost du champ - - - - - slop - - - L'écart du champ - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::addTrigramPhraseField</function> - -addTrigramPhraseField('cat', 2, 5.1) -->addTrigramPhraseField('feature', 4.5) -; -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeTrigramPhraseField - SolrDisMaxQuery::setTrigramPhraseFields - SolrDisMaxQuery::setTrigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/adduserfield.xml b/reference/solr/solrdismaxquery/adduserfield.xml deleted file mode 100644 index d7c709f510..0000000000 --- a/reference/solr/solrdismaxquery/adduserfield.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - SolrDisMaxQuery::addUserField - Ajoute un champ au paramètre de champ utilisateur (uf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addUserField - stringfield - - - Ajoute un champ au paramètre de champ utilisateur (uf) - - - - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::addUserField</function> - -addUserField('cat') -->addUserField('text') -->addUserField('*_dt'); - -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeUserField - SolrDisMaxQuery::setUserFields - - - - - - diff --git a/reference/solr/solrdismaxquery/construct.xml b/reference/solr/solrdismaxquery/construct.xml deleted file mode 100644 index f8cb9ffa3e..0000000000 --- a/reference/solr/solrdismaxquery/construct.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - SolrDisMaxQuery::__construct - Constructeur de classe - - - - &reftitle.description; - - public SolrDisMaxQuery::__construct - stringq - - - Constructeur de classe qui initialise l'objet et définit le paramètre q si passé - - - - - &reftitle.parameters; - - - q - - - Le paramètre de recherche (paramètre q) - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.errors; - - Émet une exception SolrIllegalArgumentException si un paramètre invalide a été passé. - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::__construct</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/solr/solrdismaxquery/removebigramphrasefield.xml b/reference/solr/solrdismaxquery/removebigramphrasefield.xml deleted file mode 100644 index 84129c739f..0000000000 --- a/reference/solr/solrdismaxquery/removebigramphrasefield.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - SolrDisMaxQuery::removeBigramPhraseField - Supprime un champ de bigramme de phrase (paramètre pf2) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeBigramPhraseField - stringfield - - - Supprime un champ de bigramme de phrase (paramètre pf2) qui a été précédemment ajouté en utilisant SolrDisMaxQuery::addBigramPhraseField - - - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::removeBigramPhraseField</function> - -addBigramPhraseField('cat', 2, 5.1) - ->addBigramPhraseField('feature', 4.5) -; -echo $dismaxQuery.PHP_EOL; - -// supprime le champ cat de pf2 -$dismaxQuery - ->removeBigramPhraseField('cat'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addBigramPhraseField - SolrDisMaxQuery::setBigramPhraseFields - SolrDisMaxQuery::setBigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/removeboostquery.xml b/reference/solr/solrdismaxquery/removeboostquery.xml deleted file mode 100644 index 69bc68be36..0000000000 --- a/reference/solr/solrdismaxquery/removeboostquery.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - SolrDisMaxQuery::removeBoostQuery - Supprime une partie de requête de boost par nom de champ (bq) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeBoostQuery - stringfield - - - Supprime une partie de requête de boost par nom de champs, seulement si SolrDisMaxQuery::addBoostQuery a été utilisé. - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::removeBoostQuery</function> - -addBoostQuery('cat', 'electronics', 5.1) - ->addBoostQuery('cat', 'hard drive') -; -echo $dismaxQuery.PHP_EOL; -// supprime la partie de requête de boost avec le champ 'cat' -$dismaxQuery -->removeBoostQuery('cat'); -echo $dismaxQuery . PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addBoostQuery - SolrDisMaxQuery::setBoostQuery - - - - - - diff --git a/reference/solr/solrdismaxquery/removephrasefield.xml b/reference/solr/solrdismaxquery/removephrasefield.xml deleted file mode 100644 index 4502bd97cc..0000000000 --- a/reference/solr/solrdismaxquery/removephrasefield.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - SolrDisMaxQuery::removePhraseField - Supprime un champ de phrase (paramètre pf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removePhraseField - stringfield - - - Supprime un champ de phrase (paramètre pf) qui a été ajouté précédemment en utilisant SolrDisMaxQuery::addPhraseField - - - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::removePhraseField</function> - -addPhraseField('first', 3, 1) - ->addPhraseField('second', 4, 1) - ->addPhraseField('cat', 55); -echo $dismaxQuery . PHP_EOL; -echo $dismaxQuery->removePhraseField('second'); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addPhraseField - SolrDisMaxQuery::setPhraseFields - - - - - - diff --git a/reference/solr/solrdismaxquery/removequeryfield.xml b/reference/solr/solrdismaxquery/removequeryfield.xml deleted file mode 100644 index 4f7d042c43..0000000000 --- a/reference/solr/solrdismaxquery/removequeryfield.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - SolrDisMaxQuery::removeQueryField - Supprime un champ de requête (paramètre qf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeQueryField - stringfield - - - Supprime un champ de requête (paramètre qf) ajouté par SolrDisMaxQuery::addQueryField - - - qf: Lors de la construction de DisjunctionMaxQueries à partir de la requête de l'utilisateur, il spécifie les champs à rechercher et les boosts pour ces champs. - - - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::removeQueryField</function> - -addQueryField('first', 3) - ->addQueryField('second', 0.2) - ->addQueryField('cat'); -echo $dismaxQuery . PHP_EOL; -// supprime le champ 'second' -echo $dismaxQuery->removeQueryField('second'); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addQueryField - - - - - - diff --git a/reference/solr/solrdismaxquery/removetrigramphrasefield.xml b/reference/solr/solrdismaxquery/removetrigramphrasefield.xml deleted file mode 100644 index 1e1f182eee..0000000000 --- a/reference/solr/solrdismaxquery/removetrigramphrasefield.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - SolrDisMaxQuery::removeTrigramPhraseField - Supprime un champ de trigramme de phrase (paramètre pf3) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeTrigramPhraseField - stringfield - - - Supprime un champ de trigramme de phrase (paramètre pf3) - - - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::removeTrigramPhraseField</function> - -addTrigramPhraseField('cat', 2, 5.1) -->addTrigramPhraseField('feature', 4.5) -; -echo $dismaxQuery.PHP_EOL; -// inverse -$dismaxQuery -->removeTrigramPhraseField('cat'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addTrigramPhraseField - SolrDisMaxQuery::setTrigramPhraseFields - SolrDisMaxQuery::setTrigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/removeuserfield.xml b/reference/solr/solrdismaxquery/removeuserfield.xml deleted file mode 100644 index d3f9b11440..0000000000 --- a/reference/solr/solrdismaxquery/removeuserfield.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - SolrDisMaxQuery::removeUserField - Supprime un champ du paramètre de champ utilisateur (uf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeUserField - stringfield - - - Supprime un champ du paramètre de champ utilisateur (uf) - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::removeUserField</function> - -addUserField('cat') -->addUserField('text') -->addUserField('*_dt') -; -echo $dismaxQuery.PHP_EOL; - -// supprime le champ nommé 'text' -$dismaxQuery -->removeUserField('text'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addUserField - SolrDisMaxQuery::setUserFields - - - - - - diff --git a/reference/solr/solrdismaxquery/setbigramphrasefields.xml b/reference/solr/solrdismaxquery/setbigramphrasefields.xml deleted file mode 100644 index f9113b8598..0000000000 --- a/reference/solr/solrdismaxquery/setbigramphrasefields.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - SolrDisMaxQuery::setBigramPhraseFields - Définit les champs de phrase bigramme et leurs boosts (et écart) en utilisant le paramètre pf2 - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setBigramPhraseFields - stringfields - - - Définit les champs de phrase bigramme (pf2) et leurs boosts (et écarts) - - - - - &reftitle.parameters; - - - fields - - - Les boosts de champs (les écarts) - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setBigramPhraseFields</function> - -setBigramPhraseFields("cat~5.1^2 feature^4.5"); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::setBigramPhraseSlop - SolrDisMaxQuery::addBigramPhraseFields - SolrDisMaxQuery::removeBigramPhraseField - SolrDisMaxQuery::setTrigramPhraseFields - - - - - - diff --git a/reference/solr/solrdismaxquery/setbigramphraseslop.xml b/reference/solr/solrdismaxquery/setbigramphraseslop.xml deleted file mode 100644 index 13d151edd3..0000000000 --- a/reference/solr/solrdismaxquery/setbigramphraseslop.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - SolrDisMaxQuery::setBigramPhraseSlop - Définit l'écart Bigram Phrase (paramètre ps2) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setBigramPhraseSlop - stringslop - - - Définit l'écart Bigram Phrase (paramètre ps2). Un écart par défaut pour les champs de phrase Bigram. - - - - - - &reftitle.parameters; - - - slop - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setBigramPhraseSlop</function> - -setBigramPhraseSlop(5); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setboostfunction.xml b/reference/solr/solrdismaxquery/setboostfunction.xml deleted file mode 100644 index 9b1a9cd98e..0000000000 --- a/reference/solr/solrdismaxquery/setboostfunction.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - SolrDisMaxQuery::setBoostFunction - Définit une fonction de Boost (paramètre bf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setBoostFunction - stringfunction - - - Définit une fonction de Boost (paramètre bf). - - - Les fonctions (avec des boosts optionnels) qui seront incluses dans la - requête de l'utilisateur pour influencer le score. Toute fonction supportée - nativement par Solr peut être utilisée, avec une valeur de boost. Par exemple : - - - recip(rord(myfield),1,2,3)^1.5 - - - - - &reftitle.parameters; - - - function - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setBoostFunction</function> - -setBoostFunction($boostRecentDocsFunction); - -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setboostquery.xml b/reference/solr/solrdismaxquery/setboostquery.xml deleted file mode 100644 index 08a929b3ad..0000000000 --- a/reference/solr/solrdismaxquery/setboostquery.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - SolrDisMaxQuery::setBoostQuery - Définit directement le paramètre de requête de boost (bq) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setBoostQuery - stringq - - - Définit le paramètre de requête de boost (bq) - - - - - - &reftitle.parameters; - - - q - - - requête - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setBoostQuery</function> - -setBoostQuery('cat:electronics manu:local^2'); -echo $dismaxQuery.PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addBoostQuery - SolrDisMaxQuery::removeBoostQuery - - - - - - diff --git a/reference/solr/solrdismaxquery/setminimummatch.xml b/reference/solr/solrdismaxquery/setminimummatch.xml deleted file mode 100644 index 3905852d38..0000000000 --- a/reference/solr/solrdismaxquery/setminimummatch.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - SolrDisMaxQuery::setMinimumMatch - Définit le minimum "Should" Match (mm) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setMinimumMatch - stringvalue - - - Définir le paramètre de correspondance minimale "Should" (mm). Si l'opérateur de requête par défaut est AND, alors mm=100%, si l'opérateur de requête par défaut (q.op) est OR, alors mm=0%. - - - - - &reftitle.parameters; - - - value - - - La valeur/expression de correspondance minimale - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setMinimumMatch</function> - -setMinimumMatch("75%"); -echo $dismaxQuery . PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setphrasefields.xml b/reference/solr/solrdismaxquery/setphrasefields.xml deleted file mode 100644 index 45361ce966..0000000000 --- a/reference/solr/solrdismaxquery/setphrasefields.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - SolrDisMaxQuery::setPhraseFields - Définit les champs de phrase et leurs boosts (et slops) en utilisant le paramètre pf2 - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setPhraseFields - stringfields - - - Définit les champs de phrase (pf) et leurs boosts (et slops) - - - - - &reftitle.parameters; - - - fields - - - Les champs, les boosts [, écarts] - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setPhraseFields</function> - -setPhraseFields("cat~5.1^2 feature^4.5"); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addPhraseFields - SolrDisMaxQuery::removePhraseField - - - - - - diff --git a/reference/solr/solrdismaxquery/setphraseslop.xml b/reference/solr/solrdismaxquery/setphraseslop.xml deleted file mode 100644 index b388a96785..0000000000 --- a/reference/solr/solrdismaxquery/setphraseslop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - SolrDisMaxQuery::setPhraseSlop - Définit l'écart par défaut sur les requêtes de phrase (paramètre ps) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setPhraseSlop - stringslop - - - Définit l'écart par défaut sur les requêtes de phrase construites avec les champs "pf", "pf2" et/ou "pf3" (affecte le boosting). - paramètre "ps" - - - - - - &reftitle.parameters; - - - slop - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setPhraseSlop</function> - -setPhraseSlop(4); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setqueryalt.xml b/reference/solr/solrdismaxquery/setqueryalt.xml deleted file mode 100644 index 52b78b3b3e..0000000000 --- a/reference/solr/solrdismaxquery/setqueryalt.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - SolrDisMaxQuery::setQueryAlt - Définit la requête alternative (paramètre q.alt) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setQueryAlt - stringq - - - Définit la requête alternative (paramètre q.alt) - - - Lorsque le paramètre q principal n'est pas spécifié ou est vide. Le paramètre q.alt est utilisé - - - - - - &reftitle.parameters; - - - q - - - la chaîne de requête - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setQueryAlt</function> - -setQueryAlt('*:*'); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setqueryphraseslop.xml b/reference/solr/solrdismaxquery/setqueryphraseslop.xml deleted file mode 100644 index 30438d09d5..0000000000 --- a/reference/solr/solrdismaxquery/setqueryphraseslop.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - SolrDisMaxQuery::setQueryPhraseSlop - Spécifie la quantité d'écart autorisée sur les requêtes de phrase explicitement incluses dans la chaîne de requête de l'utilisateur (paramètre qf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setQueryPhraseSlop - stringslop - - - La quantité d'écart sur les requêtes de phrase explicitement incluses dans la chaîne de requête de l'utilisateur avec le paramètre qf. - - - L'écart se réfère au nombre de positions qu'un jeton doit être déplacé par rapport à un autre jeton pour correspondre à une phrase spécifiée dans une requête. - - - - - - &reftitle.parameters; - - - slop - - - La quantité d'écart - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setQueryPhraseSlop</function> - -setQueryPhraseSlop(3); -echo $dismaxQuery; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/solr/solrdismaxquery/settiebreaker.xml b/reference/solr/solrdismaxquery/settiebreaker.xml deleted file mode 100644 index 1686ae089f..0000000000 --- a/reference/solr/solrdismaxquery/settiebreaker.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - SolrDisMaxQuery::setTieBreaker - Définit le paramètre de Tie Breaker (paramètre tie) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setTieBreaker - stringtieBreaker - - - Définit le paramètre de Tie Breaker (paramètre tie) - - - - - &reftitle.parameters; - - - tieBreaker - - - Le paramètre tie spécifie une valeur flottante (qui devrait être quelque chose de beaucoup moins que 1) à utiliser comme briseur d'égalité dans les requêtes DisMax. - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setTieBreaker</function> - -setTieBreaker(0.1); - -echo $dismaxQuery; - -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/solr/solrdismaxquery/settrigramphrasefields.xml b/reference/solr/solrdismaxquery/settrigramphrasefields.xml deleted file mode 100644 index 976b22c2e0..0000000000 --- a/reference/solr/solrdismaxquery/settrigramphrasefields.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - SolrDisMaxQuery::setTrigramPhraseFields - Définit directement les champs de trigramme de phrase (paramètre pf3) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setTrigramPhraseFields - stringfields - - - Définit directement les champs de trigramme de phrase (paramètre pf3) - - - - - - &reftitle.parameters; - - - fields - - - Les champs de trigramme de phrase - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setTrigramPhraseFields</function> - -setTrigramPhraseFields('cat~5.1^2 feature^4.5'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addTrigramPhraseField - SolrDisMaxQuery::removeTrigramPhraseField - SolrDisMaxQuery::setTrigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/settrigramphraseslop.xml b/reference/solr/solrdismaxquery/settrigramphraseslop.xml deleted file mode 100644 index 883dd13267..0000000000 --- a/reference/solr/solrdismaxquery/settrigramphraseslop.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - SolrDisMaxQuery::setTrigramPhraseSlop - Définit l'écart de trigramme de phrase (paramètre ps3) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setTrigramPhraseSlop - stringslop - - - Définit l'écart de trigramme de phrase (paramètre ps3) - - - - - - &reftitle.parameters; - - - slop - - - L'écart de phrase - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setTrigramPhraseSlop</function> - -setTrigramPhraseSlop(2); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addTrigramPhraseField - SolrDisMaxQuery::removeTrigramPhraseField - SolrDisMaxQuery::setTrigramPhraseFields - - - - - - diff --git a/reference/solr/solrdismaxquery/setuserfields.xml b/reference/solr/solrdismaxquery/setuserfields.xml deleted file mode 100644 index 79a88a5a3d..0000000000 --- a/reference/solr/solrdismaxquery/setuserfields.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - SolrDisMaxQuery::setUserFields - Définit le paramètre de champs utilisateur (uf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setUserFields - stringfields - - - Définit le paramètre de champs utilisateur (uf) - - - Champs utilisateurs: Spécifie les champs de schéma que l'utilisateur final est autorisé à interroger. - - - - - - &reftitle.parameters; - - - fields - - - Les noms des champs séparés par un espace - - - Ce paramètre prend en charge les caractères génériques. - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::setUserFields</function> - -setUserFields('field1 field2 *_txt'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addUserField - SolrDisMaxQuery::removeUserField - - - - - - diff --git a/reference/solr/solrdismaxquery/usedismaxqueryparser.xml b/reference/solr/solrdismaxquery/usedismaxqueryparser.xml deleted file mode 100644 index 9cb197726c..0000000000 --- a/reference/solr/solrdismaxquery/usedismaxqueryparser.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - SolrDisMaxQuery::useDisMaxQueryParser - Change le QueryParser pour être le DisMax Query Parser - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::useDisMaxQueryParser - - - - Change le QueryParser pour être le DisMax Query Parser - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::useDisMaxQueryParser</function> - -useDisMaxQueryParser(); -echo $dismaxQuery; -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::useDisMaxQueryParser - - - - - - diff --git a/reference/solr/solrdismaxquery/useedismaxqueryparser.xml b/reference/solr/solrdismaxquery/useedismaxqueryparser.xml deleted file mode 100644 index 945b7e17de..0000000000 --- a/reference/solr/solrdismaxquery/useedismaxqueryparser.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - SolrDisMaxQuery::useEDisMaxQueryParser - Change le QueryParser pour être le EDisMax Query Parser - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::useEDisMaxQueryParser - - - - Change le QueryParser pour être le EDisMax Query Parser. Par défaut le constructeur de requête utilise edismax, s'il a été changé en utilisant SolrDisMaxQuery::useDisMaxQueryParser, il peut être changé en utilisant cette méthode. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrDisMaxQuery::useEDisMaxQueryParser</function> - -useEDisMaxQueryParser(); -echo $dismaxQuery; - -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/solr/solrdocument.xml b/reference/solr/solrdocument.xml deleted file mode 100644 index e51a3e6f64..0000000000 --- a/reference/solr/solrdocument.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - La classe SolrDocument - SolrDocument - - - - -
    - &reftitle.intro; - - Représente un document Solr récupéré suite à une requête. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrDocument - - - - - final - SolrDocument - - - - ArrayAccess - - - - Iterator - - - - Serializable - - - - &Constants; - - const - int - SolrDocument::SORT_DEFAULT - 1 - - - const - int - SolrDocument::SORT_ASC - 1 - - - const - int - SolrDocument::SORT_DESC - 2 - - - const - int - SolrDocument::SORT_FIELD_NAME - 1 - - - const - int - SolrDocument::SORT_FIELD_VALUE_COUNT - 2 - - - const - int - SolrDocument::SORT_FIELD_BOOST_VALUE - 4 - - - &Methods; - - - - - - -
    - - - -
    - &reftitle.constants; - - - - SolrDocument::SORT_DEFAULT - - Mode par défaut pour le tri des champs du document. - - - - - SolrDocument::SORT_ASC - - Tri croissant des champs. - - - - - SolrDocument::SORT_DESC - - Tri décroissant des champs. - - - - - SolrDocument::SORT_FIELD_NAME - - Trie les champs par leurs noms. - - - - - SolrDocument::SORT_FIELD_VALUE_COUNT - - Trie les champs par le nombre de valeurs dans chaque champ. - - - - - SolrDocument::SORT_FIELD_BOOST_VALUE - - Trie les champs par leurs valeurs de boost. - - - - -
    - - - -     - - &reference.solr.entities.solrdocument; - -     - diff --git a/reference/solr/solrdocument/addfield.xml b/reference/solr/solrdocument/addfield.xml deleted file mode 100644 index a98ce08bb5..0000000000 --- a/reference/solr/solrdocument/addfield.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - SolrDocument::addField - Ajoute un champ au document - - - - &reftitle.description; - - public boolSolrDocument::addField - stringfieldName - stringfieldValue - - - Cette méthode ajoute un champ à l'instance SolrDocument. - - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - fieldValue - - - La valeur du champ. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/clear.xml b/reference/solr/solrdocument/clear.xml deleted file mode 100644 index f0615f26c9..0000000000 --- a/reference/solr/solrdocument/clear.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrDocument::clear - Efface tous les champs du document - - - - &reftitle.description; - - public boolSolrDocument::clear - - - - Réinitialise l'objet courant. Efface tous les champs et réinitialise le document. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/clone.xml b/reference/solr/solrdocument/clone.xml deleted file mode 100644 index d06832eff9..0000000000 --- a/reference/solr/solrdocument/clone.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrDocument::__clone - Crée une copie de l'objet SolrDocument - - - - &reftitle.description; - - public voidSolrDocument::__clone - - - - Crée une copie de l'objet SolrDocument. À ne pas appeler directement. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None. - - - - - - diff --git a/reference/solr/solrdocument/construct.xml b/reference/solr/solrdocument/construct.xml deleted file mode 100644 index 2bc7d9c730..0000000000 --- a/reference/solr/solrdocument/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrDocument::__construct - Constructeur - - - - &reftitle.description; - - public SolrDocument::__construct - - - - Construit un nouvel objet SolrDocument - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/solr/solrdocument/current.xml b/reference/solr/solrdocument/current.xml deleted file mode 100644 index 65c7a5cbfa..0000000000 --- a/reference/solr/solrdocument/current.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrDocument::current - Récupère le champ courant - - - - &reftitle.description; - - public SolrDocumentFieldSolrDocument::current - - - - Récupère le champ courant. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le champ courant. - - - - - diff --git a/reference/solr/solrdocument/deletefield.xml b/reference/solr/solrdocument/deletefield.xml deleted file mode 100644 index 800eda1359..0000000000 --- a/reference/solr/solrdocument/deletefield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrDocument::deleteField - Efface un champ du document - - - - &reftitle.description; - - public boolSolrDocument::deleteField - stringfieldName - - - Efface un champ du document. - - - - - &reftitle.parameters; - - - - fieldName - - - Nom du champ - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/destruct.xml b/reference/solr/solrdocument/destruct.xml deleted file mode 100644 index a95acfc3d8..0000000000 --- a/reference/solr/solrdocument/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrDocument::__destruct - Destructeur - - - - &reftitle.description; - - public SolrDocument::__destruct - - - - Destructeur pour SolrDocument. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/solr/solrdocument/fieldexists.xml b/reference/solr/solrdocument/fieldexists.xml deleted file mode 100644 index 9a1939b6d3..0000000000 --- a/reference/solr/solrdocument/fieldexists.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrDocument::fieldExists - Vérifie si un champ existe dans le document - - - - &reftitle.description; - - public boolSolrDocument::fieldExists - stringfieldName - - - Vérifie si le champ demandé est un champ valide du document. - - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si le champ est présent, ou &false; sinon. - - - - - - diff --git a/reference/solr/solrdocument/get.xml b/reference/solr/solrdocument/get.xml deleted file mode 100644 index 296e3ebe85..0000000000 --- a/reference/solr/solrdocument/get.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrDocument::__get - Accède à un champ comme une propriété - - - - &reftitle.description; - - public SolrDocumentFieldSolrDocument::__get - stringfieldName - - - Méthode magique pour accéder au champ comme à une propriété. - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne une instance SolrDocumentField. - - - - - - diff --git a/reference/solr/solrdocument/getchilddocuments.xml b/reference/solr/solrdocument/getchilddocuments.xml deleted file mode 100644 index 3a3cf65525..0000000000 --- a/reference/solr/solrdocument/getchilddocuments.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrDocument::getChildDocuments - Renvoie un tableau de documents enfants (SolrDocument) - - - - &reftitle.description; - - public arraySolrDocument::getChildDocuments - - - - Renvoie un tableau de documents enfants (SolrDocument) - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrDocument::hasChildDocuments - SolrDocument::getChildDocumentsCount - - - - - diff --git a/reference/solr/solrdocument/getchilddocumentscount.xml b/reference/solr/solrdocument/getchilddocumentscount.xml deleted file mode 100644 index 29817d4ac3..0000000000 --- a/reference/solr/solrdocument/getchilddocumentscount.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrDocument::getChildDocumentsCount - Renvoie le nombre de documents enfants - - - - &reftitle.description; - - public intSolrDocument::getChildDocumentsCount - - - - Renvoie le nombre de documents enfants - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrDocument::hasChildDocuments - SolrDocument::getChildDocuments - - - - - - diff --git a/reference/solr/solrdocument/getfield.xml b/reference/solr/solrdocument/getfield.xml deleted file mode 100644 index 0f9d263bbb..0000000000 --- a/reference/solr/solrdocument/getfield.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrDocument::getField - Récupère un champ par son nom - - - - &reftitle.description; - - public SolrDocumentFieldSolrDocument::getField - stringfieldName - - - Récupère un champ par son nom. - - - - - - &reftitle.parameters; - - - - fieldName - - - Nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrDocumentField en cas de succès, ou &false; - si une erreur survient. - - - - - - diff --git a/reference/solr/solrdocument/getfieldcount.xml b/reference/solr/solrdocument/getfieldcount.xml deleted file mode 100644 index 70f3f75691..0000000000 --- a/reference/solr/solrdocument/getfieldcount.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrDocument::getFieldCount - Récupère le nombre de champs du document - - - - &reftitle.description; - - public intSolrDocument::getFieldCount - - - - Récupère le nombre de champs du document. Les champs à valeur multiple sont - comptés une seule fois. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, &false; sinon. - - - - - - diff --git a/reference/solr/solrdocument/getfieldnames.xml b/reference/solr/solrdocument/getfieldnames.xml deleted file mode 100644 index 71ff6a9187..0000000000 --- a/reference/solr/solrdocument/getfieldnames.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrDocument::getFieldNames - Récupère un tableau de noms de champs du document - - - - &reftitle.description; - - public arraySolrDocument::getFieldNames - - - - Récupère un tableau de noms de champs du document. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les noms des champs du document. - - - - - - diff --git a/reference/solr/solrdocument/getinputdocument.xml b/reference/solr/solrdocument/getinputdocument.xml deleted file mode 100644 index ee2f142001..0000000000 --- a/reference/solr/solrdocument/getinputdocument.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrDocument::getInputDocument - Retourne un objet SolrInputDocument équivalent à l'objet - - - - &reftitle.description; - - public SolrInputDocumentSolrDocument::getInputDocument - - - - Retourne un objet SolrInputDocument équivalent à l'objet. - Utile pour re-soumettre/mettre à jour un document issu d'une requête. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un objet SolrInputDocument en cas de succès, et &null; si une erreur survient. - - - - - - diff --git a/reference/solr/solrdocument/haschilddocuments.xml b/reference/solr/solrdocument/haschilddocuments.xml deleted file mode 100644 index ec36015967..0000000000 --- a/reference/solr/solrdocument/haschilddocuments.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrDocument::hasChildDocuments - Vérifie si le document a des documents enfants - - - - &reftitle.description; - - public boolSolrDocument::hasChildDocuments - - - - Renvoie si le document a des documents enfants - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrDocument::getChildDocuments - SolrDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrdocument/isset.xml b/reference/solr/solrdocument/isset.xml deleted file mode 100644 index 664bc12d3e..0000000000 --- a/reference/solr/solrdocument/isset.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrDocument::__isset - Vérifie si un champ existe - - - - &reftitle.description; - - public boolSolrDocument::__isset - stringfieldName - - - Vérifie si un champ existe. - - - - - &reftitle.parameters; - - - - fieldName - - - Nom du champ. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/key.xml b/reference/solr/solrdocument/key.xml deleted file mode 100644 index c8cfb67c40..0000000000 --- a/reference/solr/solrdocument/key.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrDocument::key - Récupère la clé courante - - - - &reftitle.description; - - public stringSolrDocument::key - - - - Récupère la clé courante. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la clé courante. - - - - - - diff --git a/reference/solr/solrdocument/merge.xml b/reference/solr/solrdocument/merge.xml deleted file mode 100644 index 8a8505b121..0000000000 --- a/reference/solr/solrdocument/merge.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrDocument::merge - Fusionne la source à l'objet SolrDocument courant - - - - &reftitle.description; - - public boolSolrDocument::merge - SolrDocumentsourceDoc - booloverwrite&true; - - - Fusionne la source à l'objet SolrDocument courant. - - - - - - &reftitle.parameters; - - - - sourceDoc - - - La source du document. - - - - - overwrite - - - Si vaut &true; alors les champs dont les noms sont identiques dans le - document destinataire seront écrasés. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/next.xml b/reference/solr/solrdocument/next.xml deleted file mode 100644 index 28d8b43b5a..0000000000 --- a/reference/solr/solrdocument/next.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrDocument::next - Déplace le pointeur interne sur le champ suivant - - - - &reftitle.description; - - public voidSolrDocument::next - - - - Déplace le pointeur interne sur le champ suivant. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Aucune valeur retournée. - - - - - - diff --git a/reference/solr/solrdocument/offsetexists.xml b/reference/solr/solrdocument/offsetexists.xml deleted file mode 100644 index cf1c37d7bb..0000000000 --- a/reference/solr/solrdocument/offsetexists.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrDocument::offsetExists - Vérifie si un champ particulier existe - - - - &reftitle.description; - - public boolSolrDocument::offsetExists - stringfieldName - - - Vérifie si un champ particulier existe. - Méthode utilisée lorsque l'objet est traité comme un tableau. - - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/offsetget.xml b/reference/solr/solrdocument/offsetget.xml deleted file mode 100644 index 30ce609d99..0000000000 --- a/reference/solr/solrdocument/offsetget.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrDocument::offsetGet - Récupère un champ - - - - &reftitle.description; - - public SolrDocumentFieldSolrDocument::offsetGet - stringfieldName - - - Utilisé pour récupérer un champ lorsque l'objet est traité comme un tableau. - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrDocumentField. - - - - - - diff --git a/reference/solr/solrdocument/offsetset.xml b/reference/solr/solrdocument/offsetset.xml deleted file mode 100644 index 18466e13ad..0000000000 --- a/reference/solr/solrdocument/offsetset.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrDocument::offsetSet - Ajoute un champ au document - - - - &reftitle.description; - - public voidSolrDocument::offsetSet - stringfieldName - stringfieldValue - - - Utilisé lorsque l'objet est traité comme un tableau, pour ajouter un champ - au document. - - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - fieldValue - - - La valeur du champ. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/offsetunset.xml b/reference/solr/solrdocument/offsetunset.xml deleted file mode 100644 index 24d4204dcb..0000000000 --- a/reference/solr/solrdocument/offsetunset.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrDocument::offsetUnset - Efface un champ - - - - &reftitle.description; - - public voidSolrDocument::offsetUnset - stringfieldName - - - Efface un champ du document. - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Aucune valeur retournée. - - - - - - diff --git a/reference/solr/solrdocument/reset.xml b/reference/solr/solrdocument/reset.xml deleted file mode 100644 index 519ed82aa8..0000000000 --- a/reference/solr/solrdocument/reset.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrDocument::reset - &Alias; SolrDocument::clear - - - - &reftitle.description; - - public boolSolrDocument::reset - - - - Alias de SolrDocument::clear() - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/rewind.xml b/reference/solr/solrdocument/rewind.xml deleted file mode 100644 index 4c4f507028..0000000000 --- a/reference/solr/solrdocument/rewind.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrDocument::rewind - Réinitialise le pointeur interne au début - - - - &reftitle.description; - - public voidSolrDocument::rewind - - - - Réinitialise le pointeur interne au début. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Aucune valeur retournée. - - - - - - diff --git a/reference/solr/solrdocument/serialize.xml b/reference/solr/solrdocument/serialize.xml deleted file mode 100644 index eca7e04eaa..0000000000 --- a/reference/solr/solrdocument/serialize.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrDocument::serialize - Utilisé pour une sérialisation personnalisée - - - - &reftitle.description; - - public stringSolrDocument::serialize - - - - Utilisé pour une sérialisation personnalisée. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; représentant le document Solr sérialisé. - - - - - - diff --git a/reference/solr/solrdocument/set.xml b/reference/solr/solrdocument/set.xml deleted file mode 100644 index fb084161c0..0000000000 --- a/reference/solr/solrdocument/set.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - SolrDocument::__set - Ajoute un champ au document - - - - &reftitle.description; - - public boolSolrDocument::__set - stringfieldName - stringfieldValue - - - Ajoute un champ au document. Utilisé pour définir les champs comme nouvelles propriétés. - - - - - - &reftitle.parameters; - - - - fieldName - - - Nom du champ. - - - - - fieldValue - - - Valeur du champ. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/sort.xml b/reference/solr/solrdocument/sort.xml deleted file mode 100644 index 21cf57c870..0000000000 --- a/reference/solr/solrdocument/sort.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - SolrDocument::sort - Trie les champs du document - - - - &reftitle.description; - - public boolSolrDocument::sort - intsortOrderBy - intsortDirectionSolrDocument::SORT_ASC - - - - - - - - &reftitle.parameters; - - - - sortOrderBy - - - Le critère de tri. - - - - - sortDirection - - - La direction du tri. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/toarray.xml b/reference/solr/solrdocument/toarray.xml deleted file mode 100644 index e9175b5ad5..0000000000 --- a/reference/solr/solrdocument/toarray.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - - SolrDocument::toArray - Récupère un tableau représentant le document - - - - &reftitle.description; - - public arraySolrDocument::toArray - - - - Récupère un tableau représentant le document. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau représentant le document. - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrDocument::toArray</methodname> - -addField('id', 1123); - -$doc->features = "PHP Client Side"; -$doc->features = "Fast development cycles"; - -$doc['cat'] = 'Software'; -$doc['cat'] = 'Custom Search'; -$doc->cat = 'Information Technology'; - -print_r($doc->toArray()); - -?> -]]> - - &example.outputs.similar; - - 0 - [field_count] => 3 - [fields] => Array - ( - [0] => SolrDocumentField Object - ( - [name] => id - [boost] => 0 - [values] => Array - ( - [0] => 1123 - ) - - ) - - [1] => SolrDocumentField Object - ( - [name] => features - [boost] => 0 - [values] => Array - ( - [0] => PHP Client Side - [1] => Fast development cycles - ) - - ) - - [2] => SolrDocumentField Object - ( - [name] => cat - [boost] => 0 - [values] => Array - ( - [0] => Software - [1] => Custom Search - [2] => Information Technology - ) - - ) - - ) - -) -]]> - - - - - - - - diff --git a/reference/solr/solrdocument/unserialize.xml b/reference/solr/solrdocument/unserialize.xml deleted file mode 100644 index 5044ec175d..0000000000 --- a/reference/solr/solrdocument/unserialize.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrDocument::unserialize - Sérialisation personnalisée d'objets SolrDocument - - - - &reftitle.description; - - public voidSolrDocument::unserialize - stringserialized - - - Sérialisation personnalisée d'objets SolrDocument. - - - - - &reftitle.parameters; - - - - serialized - - - Une représentation XML du document. - - - - - - - - - &reftitle.returnvalues; - - Aucune. - - - - - - diff --git a/reference/solr/solrdocument/unset.xml b/reference/solr/solrdocument/unset.xml deleted file mode 100644 index 4fe69edde8..0000000000 --- a/reference/solr/solrdocument/unset.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrDocument::__unset - Efface un champ du document - - - - &reftitle.description; - - public boolSolrDocument::__unset - stringfieldName - - - Efface un champ du document lorsqu'il est accessible sous la forme d'une propriété de l'objet. - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/valid.xml b/reference/solr/solrdocument/valid.xml deleted file mode 100644 index a6b2858915..0000000000 --- a/reference/solr/solrdocument/valid.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrDocument::valid - Vérifie si la position courante interne est toujours valide - - - - &reftitle.description; - - public boolSolrDocument::valid - - - - Vérifie si la position courante interne est toujours valide. - Utilisée lors d'opérations foreach. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, ou &false; si la position courante - n'est plus valide. - - - - - - diff --git a/reference/solr/solrdocumentfield.xml b/reference/solr/solrdocumentfield.xml deleted file mode 100644 index 68afb02a16..0000000000 --- a/reference/solr/solrdocumentfield.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - La classe SolrDocumentField - SolrDocumentField - - - - -
    - &reftitle.intro; - - Représente un champ d'un document Solr. Toutes les propriétés - sont en lecture seule. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrDocumentField - - - - - final - SolrDocumentField - - - - &Properties; - - public - readonly - string - name - - - public - readonly - float - boost - - - public - readonly - array - values - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - name - - Le nom du champ. - - - - boost - - La valeur de boost du champ. - - - - values - - Un tableau de valeurs pour ce champ. - - - -
    - - - -     - - &reference.solr.entities.solrdocumentfield; - -     - diff --git a/reference/solr/solrdocumentfield/construct.xml b/reference/solr/solrdocumentfield/construct.xml deleted file mode 100644 index b64e2eac25..0000000000 --- a/reference/solr/solrdocumentfield/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrDocumentField::__construct - Constructeur - - - - &reftitle.description; - - public SolrDocumentField::__construct - - - - Constructeur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Aucune. - - - - - - diff --git a/reference/solr/solrdocumentfield/destruct.xml b/reference/solr/solrdocumentfield/destruct.xml deleted file mode 100644 index 59bd90d5a4..0000000000 --- a/reference/solr/solrdocumentfield/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrDocumentField::__destruct - Destructeur - - - - &reftitle.description; - - public SolrDocumentField::__destruct - - - - Destructeur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Rien. - - - - - - diff --git a/reference/solr/solrexception.xml b/reference/solr/solrexception.xml deleted file mode 100644 index de4d6fc167..0000000000 --- a/reference/solr/solrexception.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - La classe SolrException - SolrException - - - - -
    - &reftitle.intro; - - C'est la classe de base pour toutes les exceptions lancées par les - classes de l'extension Solr. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrException - - - - - SolrException - - - - extends - Exception - - - - &Properties; - - protected - int - sourceline - - - protected - string - sourcefile - - - protected - string - zif_name - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - sourceline - - La ligne du fichier source de l'espace C d'où l'exception a été générée. - - - - sourcefile - - Le fichier source de l'espace C d'où l'exception a été générée. - - - - zif_name - - La fonction de l'espace C d'où l'exception a été générée. - - - -
    - - - -     - - &reference.solr.entities.solrexception; - -     - - diff --git a/reference/solr/solrexception/getinternalinfo.xml b/reference/solr/solrexception/getinternalinfo.xml deleted file mode 100644 index 0d0891cdff..0000000000 --- a/reference/solr/solrexception/getinternalinfo.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrException::getInternalInfo - Récupère des informations internes lorsqu'une exception a été lancée - - - - &reftitle.description; - - public arraySolrException::getInternalInfo - - - - Récupère des informations internes lorsqu'une exception a été lancée. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - 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. - - - - - - diff --git a/reference/solr/solrgenericresponse.xml b/reference/solr/solrgenericresponse.xml deleted file mode 100644 index 6ae08e08bb..0000000000 --- a/reference/solr/solrgenericresponse.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - La classe SolrGenericResponse - SolrGenericResponse - - - - -
    - &reftitle.intro; - - Représente une réponse du serveur Solr. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrGenericResponse - - - - - final - SolrGenericResponse - - - - extends - SolrResponse - - - - &Constants; - - const - int - SolrGenericResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrGenericResponse::PARSE_SOLR_DOC - 1 - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; -
    - Constantes de la classe SolrGenericResponse - - - - SolrGenericResponse::PARSE_SOLR_OBJ - - Les documents doivent être analysés comme des instances SolrObject. - - - - - SolrGenericResponse::PARSE_SOLR_DOC - - Les documents doivent être analysés comme des instances SolrDocument. - - - - -
    -
    - - - -     - - &reference.solr.entities.solrgenericresponse; - -     - diff --git a/reference/solr/solrgenericresponse/construct.xml b/reference/solr/solrgenericresponse/construct.xml deleted file mode 100644 index 00f7965e8d..0000000000 --- a/reference/solr/solrgenericresponse/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrGenericResponse::__construct - Constructeur - - - - &reftitle.description; - - public SolrGenericResponse::__construct - - - - Constructeur - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Rien - - - - - - diff --git a/reference/solr/solrgenericresponse/destruct.xml b/reference/solr/solrgenericresponse/destruct.xml deleted file mode 100644 index e854553d70..0000000000 --- a/reference/solr/solrgenericresponse/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrGenericResponse::__destruct - Destructeur - - - - &reftitle.description; - - public SolrGenericResponse::__destruct - - - - Destructeur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Rien - - - - - - diff --git a/reference/solr/solrillegalargumentexception.xml b/reference/solr/solrillegalargumentexception.xml deleted file mode 100644 index 2e045b0562..0000000000 --- a/reference/solr/solrillegalargumentexception.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - La classe SolrIllegalArgumentException - SolrIllegalArgumentException - - - - -
    - &reftitle.intro; - - Cet objet est lancé lorsqu'un argument illégal ou invalide est passé à une méthode. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrIllegalArgumentException - - - - - SolrIllegalArgumentException - - - - extends - SolrException - - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -     - - &reference.solr.entities.solrillegalargumentexception; - -     - - diff --git a/reference/solr/solrillegalargumentexception/getinternalinfo.xml b/reference/solr/solrillegalargumentexception/getinternalinfo.xml deleted file mode 100644 index 0f0e16196d..0000000000 --- a/reference/solr/solrillegalargumentexception/getinternalinfo.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - SolrIllegalArgumentException::getInternalInfo - Retourne des informations sur l'endroit d'où l'exception a été émise - - - - &reftitle.description; - - public arraySolrIllegalArgumentException::getInternalInfo - - - - Retourne des informations sur l'endroit d'où l'exception a été émise. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - 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. - - - - - - diff --git a/reference/solr/solrillegaloperationexception.xml b/reference/solr/solrillegaloperationexception.xml deleted file mode 100644 index 8fc0030ed0..0000000000 --- a/reference/solr/solrillegaloperationexception.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - La classe SolrIllegalOperationException - SolrIllegalOperationException - - - - -
    - &reftitle.intro; - - Cet objet est lancé lorsqu'une opération illégale ou non supportée - est effectuée sur l'objet. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrIllegalOperationException - - - - - SolrIllegalOperationException - - - - extends - SolrException - - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -     - - &reference.solr.entities.solrillegaloperationexception; - -     - - diff --git a/reference/solr/solrillegaloperationexception/getinternalinfo.xml b/reference/solr/solrillegaloperationexception/getinternalinfo.xml deleted file mode 100644 index 5dbba61d53..0000000000 --- a/reference/solr/solrillegaloperationexception/getinternalinfo.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - SolrIllegalOperationException::getInternalInfo - Récupère des informations internes lorsqu'une exception a été lancée - - - - &reftitle.description; - - public arraySolrIllegalOperationException::getInternalInfo - - - - Récupère des informations internes lorsqu'une exception a été lancée. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - 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. - - - - - - diff --git a/reference/solr/solrinputdocument.xml b/reference/solr/solrinputdocument.xml deleted file mode 100644 index 477b595037..0000000000 --- a/reference/solr/solrinputdocument.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - La classe SolrInputDocument - SolrInputDocument - - - - -
    - &reftitle.intro; - - Représente un document Solr qui est sur le point d'être - envoyé à l'index Solr. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrInputDocument - - - - - final - SolrInputDocument - - - - &Constants; - - const - int - SolrInputDocument::SORT_DEFAULT - 1 - - - const - int - SolrInputDocument::SORT_ASC - 1 - - - const - int - SolrInputDocument::SORT_DESC - 2 - - - const - int - SolrInputDocument::SORT_FIELD_NAME - 1 - - - const - int - SolrInputDocument::SORT_FIELD_VALUE_COUNT - 2 - - - const - int - SolrInputDocument::SORT_FIELD_BOOST_VALUE - 4 - - - &Methods; - - - - - - -
    - - -
    - &reftitle.constants; -
    - Constantes de la classe SolrInputDocument - - - - SolrInputDocument::SORT_DEFAULT - - Tri par défaut des champs. - - - - - SolrInputDocument::SORT_ASC - - Trie les champs de façon croissante. - - - - - SolrInputDocument::SORT_DESC - - Trie les champs de façon décroissante. - - - - - SolrInputDocument::SORT_FIELD_NAME - - Trie les champs par leur nom. - - - - - SolrInputDocument::SORT_FIELD_VALUE_COUNT - - Trie les champs par le nombre de valeurs. - - - - - SolrInputDocument::SORT_FIELD_BOOST_VALUE - - Trie les champs par la valeur de boost. - - - - -
    -
    - - - -     - - &reference.solr.entities.solrinputdocument; - -     - diff --git a/reference/solr/solrinputdocument/addchilddocument.xml b/reference/solr/solrinputdocument/addchilddocument.xml deleted file mode 100644 index e0d976c202..0000000000 --- a/reference/solr/solrinputdocument/addchilddocument.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - SolrInputDocument::addChildDocument - Ajoute un document enfant pour l'indexation de bloc - - - - &reftitle.description; - - public voidSolrInputDocument::addChildDocument - SolrInputDocumentchild - - - Ajoute un document enfant pour l'indexation de bloc avec des documents imbriqués. - - - - - &reftitle.parameters; - - - child - - - Un objet SolrInputDocument. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Lance une SolrIllegalArgumentException en cas d'échec. - - - Lance une SolrException en cas d'échec interne. - - - - - &reftitle.examples; - - Exemple de <function>SolrInputDocument::addChildDocument</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_STORE_PATH, -); - -$client = new SolrClient($options); - -$product = new SolrInputDocument(); - -$product->addField('id', 'P-BLACK'); -$product->addField('cat', 'tshirt'); -$product->addField('cat', 'polo'); -$product->addField('content_type', 'product'); - -$small = new SolrInputDocument(); -$small->addField('id', 'TS-BLK-S'); -$small->addField('content_type', 'sku'); -$small->addField('size', 'S'); -$small->addField('inventory', 100); - -$medium = new SolrInputDocument(); -$medium->addField('id', 'TS-BLK-M'); -$medium->addField('content_type', 'sku'); -$medium->addField('size', 'M'); -$medium->addField('inventory', 200); - -$large = new SolrInputDocument(); -$large->addField('id', 'TS-BLK-L'); -$large->addField('content_type', 'sku'); -$large->addField('size', 'L'); -$large->addField('inventory', 300); - -// ajoute un document enfant -$product->addChildDocument($small); -$product->addChildDocument($medium); -$product->addChildDocument($large); - -// ajoute le bloc de document produit à l'index -$updateResponse = $client->addDocument( - $product, - true, // surcharge si le document existe - 10000 // commit dans les 10 secondes -); - -print_r($updateResponse->getResponse()); - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 5 - ) -) -]]> - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocuments - SolrInputDocument::hasChildDocuments - SolrInputDocument::getChildDocuments - SolrInputDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrinputdocument/addchilddocuments.xml b/reference/solr/solrinputdocument/addchilddocuments.xml deleted file mode 100644 index 2935f05eb0..0000000000 --- a/reference/solr/solrinputdocument/addchilddocuments.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - SolrInputDocument::addChildDocuments - Ajoute un tableau de documents enfants - - - - &reftitle.description; - - public voidSolrInputDocument::addChildDocuments - arraydocs - - - Ajoute un tableau de documents enfants au document d'entrée actuel. - - - - - - &reftitle.parameters; - - - docs - - - Un array d'objets SolrInputDocument. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Lance une SolrIllegalArgumentException en cas d'échec. - - - Lance une SolrException en cas d'échec interne. - - - - - &reftitle.examples; - - Exemple de <function>SolrInputDocument::addChildDocuments</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_STORE_PATH, -); - -$client = new SolrClient($options); - -$product = new SolrInputDocument(); - -$product->addField('id', 'P-BLACK'); -$product->addField('cat', 'tshirt'); -$product->addField('cat', 'polo'); -$product->addField('content_type', 'product'); - -$small = new SolrInputDocument(); -$small->addField('id', 'TS-BLK-S'); -$small->addField('content_type', 'sku'); -$small->addField('size', 'S'); -$small->addField('inventory', 100); - -$medium = new SolrInputDocument(); -$medium->addField('id', 'TS-BLK-M'); -$medium->addField('content_type', 'sku'); -$medium->addField('size', 'M'); -$medium->addField('inventory', 200); - -$large = new SolrInputDocument(); -$large->addField('id', 'TS-BLK-L'); -$large->addField('content_type', 'sku'); -$large->addField('size', 'L'); -$large->addField('inventory', 300); - -// ajoute les documents enfants -$skus = [$small, $medium, $large]; -$product->addChildDocuments($skus); - -// ajoute le bloc de document produit à l'index -$updateResponse = $client->addDocument( - $product, - true, // surcharge si le document existe - 10000 // valide le commit dans 10 secondes -); - -print_r($updateResponse->getResponse()); - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 5 - ) -) -]]> - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocument - SolrInputDocument::hasChildDocuments - SolrInputDocument::getChildDocuments - SolrInputDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrinputdocument/addfield.xml b/reference/solr/solrinputdocument/addfield.xml deleted file mode 100644 index 2868193e7a..0000000000 --- a/reference/solr/solrinputdocument/addfield.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - SolrInputDocument::addField - Ajoute un champ au document - - - - &reftitle.description; - - public boolSolrInputDocument::addField - stringfieldName - stringfieldValue - floatfieldBoostValue0.0 - - - 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. - - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - fieldValue - - - La valeur du champ. - - - - - fieldBoostValue - - - Le boost de ce champ. Cette valeur ne peut être négative. - Il est possible de passer une valeur inférieure à 1.0 mais elle doit être - supérieure à 0. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/clear.xml b/reference/solr/solrinputdocument/clear.xml deleted file mode 100644 index 6fc8f45952..0000000000 --- a/reference/solr/solrinputdocument/clear.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrInputDocument::clear - Réinitialise le document d'entrée - - - - &reftitle.description; - - public boolSolrInputDocument::clear - - - - Réinitialise le document en supprimant tous les champs. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/clone.xml b/reference/solr/solrinputdocument/clone.xml deleted file mode 100644 index c242994fb4..0000000000 --- a/reference/solr/solrinputdocument/clone.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrInputDocument::__clone - Crée une copie de l'objet SolrDocument - - - - &reftitle.description; - - public voidSolrInputDocument::__clone - - - - Cette méthode ne devrait pas être appelée directement. - Elle est utilisée pour créer une copie interne de l'objet SolrInputDocument. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Crée une nouvelle instance SolrInputDocument. - - - - - - diff --git a/reference/solr/solrinputdocument/construct.xml b/reference/solr/solrinputdocument/construct.xml deleted file mode 100644 index 4bd979a42e..0000000000 --- a/reference/solr/solrinputdocument/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrInputDocument::__construct - Constructeur - - - - &reftitle.description; - - public SolrInputDocument::__construct - - - - Constructeur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Aucune. - - - - - - diff --git a/reference/solr/solrinputdocument/deletefield.xml b/reference/solr/solrinputdocument/deletefield.xml deleted file mode 100644 index 329db4f190..0000000000 --- a/reference/solr/solrinputdocument/deletefield.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrInputDocument::deleteField - Efface un champ d'un document - - - - &reftitle.description; - - public boolSolrInputDocument::deleteField - stringfieldName - - - Efface un champ d'un document. - - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/destruct.xml b/reference/solr/solrinputdocument/destruct.xml deleted file mode 100644 index b88381bd52..0000000000 --- a/reference/solr/solrinputdocument/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrInputDocument::__destruct - Destructeur - - - - &reftitle.description; - - public SolrInputDocument::__destruct - - - - Destructeur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Aucune. - - - - - - diff --git a/reference/solr/solrinputdocument/fieldexists.xml b/reference/solr/solrinputdocument/fieldexists.xml deleted file mode 100644 index 947f3b1412..0000000000 --- a/reference/solr/solrinputdocument/fieldexists.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrInputDocument::fieldExists - Vérifie si un champ existe - - - - &reftitle.description; - - public boolSolrInputDocument::fieldExists - stringfieldName - - - Vérifie si un champ existe. - - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si le champ existe, et &false; sinon. - - - - - - diff --git a/reference/solr/solrinputdocument/getboost.xml b/reference/solr/solrinputdocument/getboost.xml deleted file mode 100644 index d692b0542c..0000000000 --- a/reference/solr/solrinputdocument/getboost.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrInputDocument::getBoost - Récupère la valeur courante du boost pour le document - - - - &reftitle.description; - - public floatSolrInputDocument::getBoost - - - - Récupère la valeur courante du boost pour le document. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la valeur du boost en cas de succès, et - &false; si une erreur survient. - - - - - - diff --git a/reference/solr/solrinputdocument/getchilddocuments.xml b/reference/solr/solrinputdocument/getchilddocuments.xml deleted file mode 100644 index f9ec0b2bc0..0000000000 --- a/reference/solr/solrinputdocument/getchilddocuments.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrInputDocument::getChildDocuments - Renvoie un tableau de documents enfants (SolrInputDocument) - - - - &reftitle.description; - - public arraySolrInputDocument::getChildDocuments - - - - Renvoie un tableau de documents enfants (SolrInputDocument) - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocument - SolrInputDocument::addChildDocuments - SolrInputDocument::hasChildDocuments - SolrInputDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrinputdocument/getchilddocumentscount.xml b/reference/solr/solrinputdocument/getchilddocumentscount.xml deleted file mode 100644 index 4b4ec282c6..0000000000 --- a/reference/solr/solrinputdocument/getchilddocumentscount.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrInputDocument::getChildDocumentsCount - Renvoie le nombre de documents enfants - - - - &reftitle.description; - - public intSolrInputDocument::getChildDocumentsCount - - - - Renvoie le nombre de documents enfants - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocument - SolrInputDocument::addChildDocuments - SolrInputDocument::hasChildDocuments - SolrInputDocument::getChildDocuments - - - - - - diff --git a/reference/solr/solrinputdocument/getfield.xml b/reference/solr/solrinputdocument/getfield.xml deleted file mode 100644 index 683e5bdd28..0000000000 --- a/reference/solr/solrinputdocument/getfield.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrInputDocument::getField - Récupère un champ par son nom - - - - &reftitle.description; - - public SolrDocumentFieldSolrInputDocument::getField - stringfieldName - - - Récupère un champ par son nom. - - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrDocumentField en cas de succès, - et &false; si une erreur survient. - - - - - - diff --git a/reference/solr/solrinputdocument/getfieldboost.xml b/reference/solr/solrinputdocument/getfieldboost.xml deleted file mode 100644 index c500149b4d..0000000000 --- a/reference/solr/solrinputdocument/getfieldboost.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrInputDocument::getFieldBoost - Récupère la valeur du boost pour un champ donné - - - - &reftitle.description; - - public floatSolrInputDocument::getFieldBoost - stringfieldName - - - Récupère la valeur du boost pour un champ donné. - - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur du boost pour le champ, ou - &false; si une erreur survient. - - - - - - diff --git a/reference/solr/solrinputdocument/getfieldcount.xml b/reference/solr/solrinputdocument/getfieldcount.xml deleted file mode 100644 index d253585796..0000000000 --- a/reference/solr/solrinputdocument/getfieldcount.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrInputDocument::getFieldCount - Retourne le nombre de champs du document - - - - &reftitle.description; - - public intfalseSolrInputDocument::getFieldCount - - - - Retourne le nombre de champs du document. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès&return.falseforfailure;. - - - - - - diff --git a/reference/solr/solrinputdocument/getfieldnames.xml b/reference/solr/solrinputdocument/getfieldnames.xml deleted file mode 100644 index d5c91de15a..0000000000 --- a/reference/solr/solrinputdocument/getfieldnames.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrInputDocument::getFieldNames - Retourne un tableau contenant tous les champs du document - - - - &reftitle.description; - - public arraySolrInputDocument::getFieldNames - - - - Retourne un tableau contenant tous les champs du document. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &array; en cas de succès, et &false; si une erreur - survient. - - - - - - diff --git a/reference/solr/solrinputdocument/haschilddocuments.xml b/reference/solr/solrinputdocument/haschilddocuments.xml deleted file mode 100644 index f712e27359..0000000000 --- a/reference/solr/solrinputdocument/haschilddocuments.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrInputDocument::hasChildDocuments - Renvoie true si le document a des documents enfants - - - - &reftitle.description; - - public boolSolrInputDocument::hasChildDocuments - - - - Vérifie si le document a des documents enfants - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocument - SolrInputDocument::addChildDocuments - SolrInputDocument::getChildDocuments - SolrInputDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrinputdocument/merge.xml b/reference/solr/solrinputdocument/merge.xml deleted file mode 100644 index 10a6185bfd..0000000000 --- a/reference/solr/solrinputdocument/merge.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - SolrInputDocument::merge - Fusionne un document d'entrée dans un autre - - - - &reftitle.description; - - public boolSolrInputDocument::merge - SolrInputDocumentsourceDoc - booloverwrite&true; - - - Fusionne un document d'entrée dans un autre. - - - - - - &reftitle.parameters; - - - - sourceDoc - - - Le document source. - - - - - overwrite - - - Si vaut &true;, il remplacera les champs correspondant dans le document cible. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Dans le futur, cette méthode sera modifiée pour retourner le nombre de champs - du nouveau document. - - - - - - diff --git a/reference/solr/solrinputdocument/reset.xml b/reference/solr/solrinputdocument/reset.xml deleted file mode 100644 index dbddfb879d..0000000000 --- a/reference/solr/solrinputdocument/reset.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrInputDocument::reset - &Alias; SolrInputDocument::clear - - - - &reftitle.description; - - public boolSolrInputDocument::reset - - - - Alias de SolrInputDocument::clear. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/setboost.xml b/reference/solr/solrinputdocument/setboost.xml deleted file mode 100644 index fba9580aec..0000000000 --- a/reference/solr/solrinputdocument/setboost.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrInputDocument::setBoost - Définit la valeur de boost pour le document - - - - &reftitle.description; - - public boolSolrInputDocument::setBoost - floatdocumentBoostValue - - - Définit la valeur de boost pour le document. - - - - - - &reftitle.parameters; - - - - documentBoostValue - - - La valeur de boost pour ce document. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/setfieldboost.xml b/reference/solr/solrinputdocument/setfieldboost.xml deleted file mode 100644 index 6d6cfdc79f..0000000000 --- a/reference/solr/solrinputdocument/setfieldboost.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrInputDocument::setFieldBoost - Définit la valeur de boost pour un champ - - - - &reftitle.description; - - public boolSolrInputDocument::setFieldBoost - stringfieldName - floatfieldBoostValue - - - Définit la valeur de boost pour un champ. - Ceci remplacera la valeur de boost courante pour ce champ. - - - - - - &reftitle.parameters; - - - - fieldName - - - Le nom du champ. - - - - - fieldBoostValue - - - La valeur de boost. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/sort.xml b/reference/solr/solrinputdocument/sort.xml deleted file mode 100644 index 702f95f290..0000000000 --- a/reference/solr/solrinputdocument/sort.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - SolrInputDocument::sort - Trie les champs du document - - - - &reftitle.description; - - public boolSolrInputDocument::sort - intsortOrderBy - intsortDirectionSolrInputDocument::SORT_ASC - - - - - - - - &reftitle.parameters; - - - - sortOrderBy - - - Le critère de tri - - - - - sortDirection - - - La direction du tri - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/toarray.xml b/reference/solr/solrinputdocument/toarray.xml deleted file mode 100644 index 000b8f6677..0000000000 --- a/reference/solr/solrinputdocument/toarray.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrInputDocument::toArray - Retourne une représentation sous forme de tableau du document d'entrée - - - - &reftitle.description; - - public arraySolrInputDocument::toArray - - - - Retourne une représentation sous forme de tableau du document d'entrée. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une représentation sous forme de tableau des champs et &false; - si une erreur survient. - - - - - - diff --git a/reference/solr/solrmissingmandatoryparameterexception.xml b/reference/solr/solrmissingmandatoryparameterexception.xml deleted file mode 100644 index 547da67198..0000000000 --- a/reference/solr/solrmissingmandatoryparameterexception.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - La classe SolrMissingMandatoryParameterException - SolrMissingMandatoryParameterException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrMissingMandatoryParameterException - - - - - SolrMissingMandatoryParameterException - - - - extends - SolrException - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - -
    - -     - - - -     - - diff --git a/reference/solr/solrmodifiableparams.xml b/reference/solr/solrmodifiableparams.xml deleted file mode 100644 index c8b4e3a1de..0000000000 --- a/reference/solr/solrmodifiableparams.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - La classe SolrModifiableParams - SolrModifiableParams - - - - -
    - &reftitle.intro; - - Représente une collection de paires nom-valeur envoyées au serveur Solr - lors d'une requête. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrModifiableParams - - - - - SolrModifiableParams - - - - extends - SolrParams - - - - Serializable - - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - -     - - &reference.solr.entities.solrmodifiableparams; - -     - diff --git a/reference/solr/solrmodifiableparams/construct.xml b/reference/solr/solrmodifiableparams/construct.xml deleted file mode 100644 index 1df5504382..0000000000 --- a/reference/solr/solrmodifiableparams/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrModifiableParams::__construct - Constructeur - - - - &reftitle.description; - - public SolrModifiableParams::__construct - - - - Constructeur - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Aucune - - - - - - diff --git a/reference/solr/solrmodifiableparams/destruct.xml b/reference/solr/solrmodifiableparams/destruct.xml deleted file mode 100644 index d965bbd945..0000000000 --- a/reference/solr/solrmodifiableparams/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrModifiableParams::__destruct - Destructeur - - - - &reftitle.description; - - public SolrModifiableParams::__destruct - - - - Destructeur - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Rien - - - - - - diff --git a/reference/solr/solrobject.xml b/reference/solr/solrobject.xml deleted file mode 100644 index e1a931807b..0000000000 --- a/reference/solr/solrobject.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - La classe SolrObject - SolrObject - - - - -
    - &reftitle.intro; - - 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. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrObject - - - - - final - SolrObject - - - - ArrayAccess - - - - - &Methods; - - - - - - -
    - -     - - &reference.solr.entities.solrobject; - -     - diff --git a/reference/solr/solrobject/construct.xml b/reference/solr/solrobject/construct.xml deleted file mode 100644 index 9b9c5a0a91..0000000000 --- a/reference/solr/solrobject/construct.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - SolrObject::__construct - Crée un objet Solr - - - - &reftitle.description; - - public SolrObject::__construct - - - - Crée un objet Solr. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Rien - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrObject::__construct</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrobject/destruct.xml b/reference/solr/solrobject/destruct.xml deleted file mode 100644 index 83b444048d..0000000000 --- a/reference/solr/solrobject/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrObject::__destruct - Destructeur - - - - &reftitle.description; - - public SolrObject::__destruct - - - - Le destructeur - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Rien. - - - - - - diff --git a/reference/solr/solrobject/getpropertynames.xml b/reference/solr/solrobject/getpropertynames.xml deleted file mode 100644 index 1a7daa1c34..0000000000 --- a/reference/solr/solrobject/getpropertynames.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrObject::getPropertyNames - Récupère un tableau contenant les noms de toutes les propriétés - - - - &reftitle.description; - - public arraySolrObject::getPropertyNames - - - - Récupère un tableau contenant les noms de toutes les propriétés. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau. - - - - - - diff --git a/reference/solr/solrobject/offsetexists.xml b/reference/solr/solrobject/offsetexists.xml deleted file mode 100644 index 127e353cec..0000000000 --- a/reference/solr/solrobject/offsetexists.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrObject::offsetExists - Vérifie si une propriété existe - - - - &reftitle.description; - - public boolSolrObject::offsetExists - stringproperty_name - - - Vérifie si une propriété existe. Cette méthode est utilisée lorsque - l'objet est traité comme un tableau. - - - - - - &reftitle.parameters; - - - - property_name - - - Le nom de la propriété. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrobject/offsetget.xml b/reference/solr/solrobject/offsetget.xml deleted file mode 100644 index 2a973fd30f..0000000000 --- a/reference/solr/solrobject/offsetget.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrObject::offsetGet - Récupère une propriété - - - - &reftitle.description; - - public mixedSolrObject::offsetGet - stringproperty_name - - - Récupère la valeur d'une propriété. Cette méthode est utilisée lorsque l'objet - est traité comme un tableau. - - - - - &reftitle.parameters; - - - - property_name - - - Le nom de la propriété. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur de la propriété. - - - - - - diff --git a/reference/solr/solrobject/offsetset.xml b/reference/solr/solrobject/offsetset.xml deleted file mode 100644 index 0aa57b0792..0000000000 --- a/reference/solr/solrobject/offsetset.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - SolrObject::offsetSet - Définit la valeur d'une propriété - - - - &reftitle.description; - - public voidSolrObject::offsetSet - stringproperty_name - stringproperty_value - - - 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. - On ne devrait jamais utiliser cette méthode. - - - - - - &reftitle.parameters; - - - - property_name - - - Le nom de la propriété. - - - - - property_value - - - La nouvelle valeur. - - - - - - - - - &reftitle.returnvalues; - - Rien. - - - - - - diff --git a/reference/solr/solrobject/offsetunset.xml b/reference/solr/solrobject/offsetunset.xml deleted file mode 100644 index 6647c568b3..0000000000 --- a/reference/solr/solrobject/offsetunset.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - SolrObject::offsetUnset - Supprime la valeur de la propriété - - - - &reftitle.description; - - public voidSolrObject::offsetUnset - stringproperty_name - - - 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. - On ne devrait jamais utiliser cette méthode. - - - - - - &reftitle.parameters; - - - - property_name - - - Le nom de la propriété. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrObject::offsetUnset</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrparams.xml b/reference/solr/solrparams.xml deleted file mode 100644 index 7b5eb69e41..0000000000 --- a/reference/solr/solrparams.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - La classe SolrParams - SolrParams - - - - -
    - &reftitle.intro; - - Représente une collection de paires nom-valeur envoyées au serveur - Solr lors d'une requête. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrParams - - - - - abstract - SolrParams - - - - Serializable - - - - - - &Methods; - - - - -
    - -     - - &reference.solr.entities.solrparams; - -     - - diff --git a/reference/solr/solrparams/add.xml b/reference/solr/solrparams/add.xml deleted file mode 100644 index 3665269219..0000000000 --- a/reference/solr/solrparams/add.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - SolrParams::add - &Alias; SolrParams::addParam - - - - &reftitle.description; - - final public SolrParamsSolrParams::add - stringname - stringvalue - - - Alias de SolrParams::addParam. - - - - - - &reftitle.parameters; - - - - name - - - Nom du paramètre. - - - - - value - - - Valeur du paramètre. - - - - - - - - - &reftitle.returnvalues; - - Retourne une instance d'un objet SolrParams en cas de succès. - - - - - - - diff --git a/reference/solr/solrparams/addparam.xml b/reference/solr/solrparams/addparam.xml deleted file mode 100644 index 5ade11e5e8..0000000000 --- a/reference/solr/solrparams/addparam.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrParams::addParam - Ajoute un paramètre à l'objet - - - - &reftitle.description; - - public SolrParamsSolrParams::addParam - stringname - stringvalue - - - Ajoute un paramètre à l'objet. Cette méthode est utilisée - pour les paramètres pouvant être spécifiés plusieurs fois. - - - - - &reftitle.parameters; - - - - name - - - Nom du paramètre. - - - - - value - - - Valeur du paramètre. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrParam en cas de succès, et &false; - si une erreur survient. - - - - - - diff --git a/reference/solr/solrparams/get.xml b/reference/solr/solrparams/get.xml deleted file mode 100644 index 4ae5e4a71c..0000000000 --- a/reference/solr/solrparams/get.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrParams::get - &Alias; SolrParams::getParam - - - - &reftitle.description; - - final public mixedSolrParams::get - stringparam_name - - - Alias de SolrParams::getParam. - - - - - - &reftitle.parameters; - - - - param_name - - - Nom du paramètre. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; ou un &array; suivant le type du paramètre. - - - - - - diff --git a/reference/solr/solrparams/getparam.xml b/reference/solr/solrparams/getparam.xml deleted file mode 100644 index 119bb10a4f..0000000000 --- a/reference/solr/solrparams/getparam.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrParams::getParam - Retourne la valeur d'un paramètre - - - - &reftitle.description; - - final public mixedSolrParams::getParam - stringparam_name - - - Retourne la valeur d'un paramètre. - - - - - - &reftitle.parameters; - - - - param_name - - - Nom du paramètre. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; ou un tableau suivant le type du paramètre. - - - - - - diff --git a/reference/solr/solrparams/getparams.xml b/reference/solr/solrparams/getparams.xml deleted file mode 100644 index 9a9540b314..0000000000 --- a/reference/solr/solrparams/getparams.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrParams::getParams - Retourne un tableau de paramètres non encodés URL - - - - &reftitle.description; - - final public arraySolrParams::getParams - - - - Retourne un tableau de paramètres non encodés URL. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau de paramètres non encodés URL. - - - - - - diff --git a/reference/solr/solrparams/getpreparedparams.xml b/reference/solr/solrparams/getpreparedparams.xml deleted file mode 100644 index 474a2cc241..0000000000 --- a/reference/solr/solrparams/getpreparedparams.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrParams::getPreparedParams - Retourne un tableau de paramètres encodés URL - - - - &reftitle.description; - - final public arraySolrParams::getPreparedParams - - - - Retourne un tableau de paramètres encodés URL. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau de paramètres encodés URL. - - - - - - diff --git a/reference/solr/solrparams/serialize.xml b/reference/solr/solrparams/serialize.xml deleted file mode 100644 index 3492a14547..0000000000 --- a/reference/solr/solrparams/serialize.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrParams::serialize - Utilisé pour une sérialisation personnalisée - - - - &reftitle.description; - - final public stringSolrParams::serialize - - - - Utilisé pour une sérialisation personnalisée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Utilisé pour une sérialisation personnalisée. - - - - - - diff --git a/reference/solr/solrparams/set.xml b/reference/solr/solrparams/set.xml deleted file mode 100644 index fa4960e2af..0000000000 --- a/reference/solr/solrparams/set.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrParams::set - &Alias; SolrParams::setParam - - - - &reftitle.description; - - final public voidSolrParams::set - stringname - stringvalue - - - Alias de SolrParams::setParam. - - - - - &reftitle.parameters; - - - - name - - - Nom du paramètre. - - - - - value - - - Valeur du paramètre. - - - - - - - - - &reftitle.returnvalues; - - Retourne une instance de l'objet SolrParams - en cas de succès. - - - - - - diff --git a/reference/solr/solrparams/setparam.xml b/reference/solr/solrparams/setparam.xml deleted file mode 100644 index 456ad6d43b..0000000000 --- a/reference/solr/solrparams/setparam.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - SolrParams::setParam - Définit un paramètre à une valeur spécifique - - - - &reftitle.description; - - public SolrParamsSolrParams::setParam - stringname - stringvalue - - - 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. - - - - - - &reftitle.parameters; - - - - name - - - Nom du paramètre. - - - - - value - - - Valeur du paramètre. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrParam en cas de succès, et &false; - si une erreur survient. - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrParams::setParam</methodname> - -setParam('q', 'solr')->setParam('rows', 2); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrparams/tostring.xml b/reference/solr/solrparams/tostring.xml deleted file mode 100644 index 59935a21bf..0000000000 --- a/reference/solr/solrparams/tostring.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrParams::toString - Retourne tous les paramètres de l'objet - - - - &reftitle.description; - - final public stringSolrParams::toString - boolurl_encode&false; - - - Retourne tous les paramètres de l'objet, sous la forme de paire - nom-valeur. - - - - - - &reftitle.parameters; - - - - url_encode - - - Si l'on doit retourner les valeurs encodées URL. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &false; - si une erreur survient. - - - - - - diff --git a/reference/solr/solrparams/unserialize.xml b/reference/solr/solrparams/unserialize.xml deleted file mode 100644 index 34f2d0e784..0000000000 --- a/reference/solr/solrparams/unserialize.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrParams::unserialize - Utilisé pour la sérialisation personnalisée - - - - &reftitle.description; - - final public voidSolrParams::unserialize - stringserialized - - - Utilisé pour la sérialisation personnalisée. - - - - - &reftitle.parameters; - - - - serialized - - - La représentation sérialisée de l'objet. - - - - - - - - - &reftitle.returnvalues; - - Aucune. - - - - - - diff --git a/reference/solr/solrpingresponse.xml b/reference/solr/solrpingresponse.xml deleted file mode 100644 index 186ada4436..0000000000 --- a/reference/solr/solrpingresponse.xml +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - - La classe SolrPingResponse - SolrPingResponse - - - - -
    - &reftitle.intro; - - Représente une réponse à une requête de type ping au serveur Solr. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrPingResponse - - - - - final - SolrPingResponse - - - - extends - SolrResponse - - - - &Constants; - - const - int - SolrPingResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrPingResponse::PARSE_SOLR_DOC - 1 - - - &Properties; - - - &Methods; - - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - http_status - - Le statut http de la réponse. - - - - parser_mode - - Méthode d'analyse des documents Solr : instances SolrObject ou SolrDocument. - - - - success - - Si une erreur est survenue ou non durant la requête. - - - - http_status_message - - Message détaillé du statut http. - - - - http_request_url - - L'URL de la requête. - - - - http_raw_request_headers - - Une chaîne d'en-têtes bruts envoyée lors de la requête. - - - - http_raw_request - - La requête brute à envoyer au serveur. - - - - http_raw_response_headers - - Les en-têtes de réponse reçus du serveur Solr. - - - - http_raw_response - - Le message de réponse reçu par le serveur Solr. - - - - http_digested_response - - La réponse au format sérialisé PHP. - - - -
    - - - - -
    - &reftitle.constants; -
    - Constantes de la classe SolrPingResponse - - - - SolrPingResponse::PARSE_SOLR_OBJ - - Les documents doivent être analysés comme des instances SolrObject. - - - - - SolrPingResponse::PARSE_SOLR_DOC - - Les documents doivent être analysés comme des instances SolrDocument. - - - - -
    -
    - - - -     - - &reference.solr.entities.solrpingresponse; - -     - diff --git a/reference/solr/solrpingresponse/construct.xml b/reference/solr/solrpingresponse/construct.xml deleted file mode 100644 index 6a8219e19b..0000000000 --- a/reference/solr/solrpingresponse/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrPingResponse::__construct - Constructeur - - - - &reftitle.description; - - public SolrPingResponse::__construct - - - - Constructeur - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Rien - - - - - - diff --git a/reference/solr/solrpingresponse/destruct.xml b/reference/solr/solrpingresponse/destruct.xml deleted file mode 100644 index cfe16bfa2e..0000000000 --- a/reference/solr/solrpingresponse/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrPingResponse::__destruct - Destructeur - - - - &reftitle.description; - - public SolrPingResponse::__destruct - - - - Destructeur - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Rien - - - - - - diff --git a/reference/solr/solrpingresponse/getresponse.xml b/reference/solr/solrpingresponse/getresponse.xml deleted file mode 100644 index 6f2fcc416c..0000000000 --- a/reference/solr/solrpingresponse/getresponse.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrPingResponse::getResponse - Récupère la réponse du serveur - - - - &reftitle.description; - - public stringSolrPingResponse::getResponse - - - - Récupère la réponse du serveur. Normalement, la réponse devrait être vide car - la requête est de type HEAD. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne vide. - - - - - - diff --git a/reference/solr/solrquery.xml b/reference/solr/solrquery.xml deleted file mode 100644 index b96265185a..0000000000 --- a/reference/solr/solrquery.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - La classe SolrQuery - SolrQuery - - - - -
    - &reftitle.intro; - - Représente une collection de paires nom-valeur envoyées au serveur - Solr lors d'une requête. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrQuery - - - - - SolrQuery - - - - extends - SolrModifiableParams - - - - Serializable - - - - &Constants; - - const - int - SolrQuery::ORDER_ASC - 0 - - - const - int - SolrQuery::ORDER_DESC - 1 - - - const - int - SolrQuery::FACET_SORT_INDEX - 0 - - - const - int - SolrQuery::FACET_SORT_COUNT - 1 - - - const - int - SolrQuery::TERMS_SORT_INDEX - 0 - - - const - int - SolrQuery::TERMS_SORT_COUNT - 1 - - - &Properties; - - - &Methods; - - - - - &InheritedMethods; - - - - - - -
    - - - -
    - &reftitle.constants; - - - - SolrQuery::ORDER_ASC - - Utilisé pour spécifier une direction croissante du tri. - - - - - SolrQuery::ORDER_DESC - - Utilisé pour spécifier une direction décroissante du tri. - - - - - SolrQuery::FACET_SORT_INDEX - - Utilisé pour spécifier que la facette doit être triée par son index - - - - - SolrQuery::FACET_SORT_COUNT - - Utilisé pour spécifier que la facette doit être triée par son total. - - - - - SolrQuery::TERMS_SORT_INDEX - - Utilisé dans TermsComponent - - - - - SolrQuery::TERMS_SORT_COUNT - - Utilisé dans TermsComponent - - - - -
    - - - -     - - &reference.solr.entities.solrquery; - -     - diff --git a/reference/solr/solrquery/addexpandfilterquery.xml b/reference/solr/solrquery/addexpandfilterquery.xml deleted file mode 100644 index a3fb4c96b4..0000000000 --- a/reference/solr/solrquery/addexpandfilterquery.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - SolrQuery::addExpandFilterQuery - Surcharge la requête de filtre principale, détermine quels documents inclure dans le groupe principal - - - - &reftitle.description; - - public SolrQuerySolrQuery::addExpandFilterQuery - stringfq - - - Surcharge la requête de filtre principale, détermine quels documents inclure dans le groupe principal. - - - - - - &reftitle.parameters; - - - fq - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::removeExpandFilterQuery - - - - - - diff --git a/reference/solr/solrquery/addexpandsortfield.xml b/reference/solr/solrquery/addexpandsortfield.xml deleted file mode 100644 index f036ee01b5..0000000000 --- a/reference/solr/solrquery/addexpandsortfield.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - SolrQuery::addExpandSortField - Trie les documents dans les groupes étendus (paramètre expand.sort) - - - - &reftitle.description; - - public SolrQuerySolrQuery::addExpandSortField - stringfield - stringorder - - - Trie les documents dans les groupes étendus (paramètre expand.sort). - - - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - order - - - Ordre ASC/DESC, utilise les constantes SolrQuery::ORDER_*. - - - Défaut: SolrQuery::ORDER_DESC - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/addfacetdatefield.xml b/reference/solr/solrquery/addfacetdatefield.xml deleted file mode 100644 index 1fd672c88e..0000000000 --- a/reference/solr/solrquery/addfacetdatefield.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - SolrQuery::addFacetDateField - Lie un facet.date - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFacetDateField - stringdateField - - - Cette méthode 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. - - - - - - &reftitle.parameters; - - - - dateField - - - Le nom du champ date. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet SolrQuery. - - - - - - diff --git a/reference/solr/solrquery/addfacetdateother.xml b/reference/solr/solrquery/addfacetdateother.xml deleted file mode 100644 index 24fc0cb8da..0000000000 --- a/reference/solr/solrquery/addfacetdateother.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - SolrQuery::addFacetDateOther - Ajoute un autre paramètre facet.date.other - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFacetDateOther - stringvalue - stringfield_override - - - Définit le paramètre facet.date.other. Accepte un paramètre - optionnel permettant d'écraser la valeur. - - - - - - &reftitle.parameters; - - - - value - - - La valeur à utiliser. - - - - - field_override - - - Le nom du champ pour l'écrasement. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/addfacetfield.xml b/reference/solr/solrquery/addfacetfield.xml deleted file mode 100644 index d16f37b9f6..0000000000 --- a/reference/solr/solrquery/addfacetfield.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - SolrQuery::addFacetField - Ajoute un autre champ à la facette - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFacetField - stringfield - - - Ajoute un autre champ à la facette. - - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrQuery::addFacetField</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setQuery($query); - -$query->addField('price')->addField('color'); - -$query->setFacet(true); - -$query->addFacetField('price')->addFacetField('color'); - -$query_response = $client->query($query); - -$response = $query_response->getResponse(); - -print_r($response['facet_counts']['facet_fields']); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [blue] => 20 - [green] => 100 - ) - -) -]]> - - - - - - - - diff --git a/reference/solr/solrquery/addfacetquery.xml b/reference/solr/solrquery/addfacetquery.xml deleted file mode 100644 index e9c02e5fd9..0000000000 --- a/reference/solr/solrquery/addfacetquery.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - - SolrQuery::addFacetQuery - Ajoute une requête de facette - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFacetQuery - stringfacetQuery - - - Ajoute une requête de facette. - - - - - - &reftitle.parameters; - - - - facetQuery - - - La requête de facette - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrQuery::addFacetField</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$query->setFacet(true); - -$query->addFacetQuery('price:[* TO 500]')->addFacetQuery('price:[500 TO *]'); - -$query_response = $client->query($query); - -$response = $query_response->getResponse(); - -print_r($response->facet_counts->facet_queries); - -?> -]]> - - &example.outputs.similar; - - 14 - [price:[500 TO *]] => 2 -) - -]]> - - - - - - - - diff --git a/reference/solr/solrquery/addfield.xml b/reference/solr/solrquery/addfield.xml deleted file mode 100644 index 432b323a86..0000000000 --- a/reference/solr/solrquery/addfield.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - SolrQuery::addField - Spécifie quel champ doit retourner le résultat - - - - &reftitle.description; - - public SolrQuerySolrQuery::addField - stringfield - - - Cette méthode est utilisée 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. - - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant. - - - - - - diff --git a/reference/solr/solrquery/addfilterquery.xml b/reference/solr/solrquery/addfilterquery.xml deleted file mode 100644 index 02242f0b5a..0000000000 --- a/reference/solr/solrquery/addfilterquery.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - SolrQuery::addFilterQuery - Spécifie un filtre de requête - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFilterQuery - stringfq - - - Spécifie un filtre de requête. - - - - - - &reftitle.parameters; - - - - fq - - - Le filtre de requête - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant. - - - - - &reftitle.examples; - - - Exemple avec <methodname>SolrQuery::addFilterQuery</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setQuery('*:*'); - -$query->addFilterQuery('color:blue,green'); - -$query_response = $client->query($query); - -$response = $query_response->getResponse(); - -print_r($response['facet_counts']['facet_fields']); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrquery/addgroupfield.xml b/reference/solr/solrquery/addgroupfield.xml deleted file mode 100644 index 6d0e5ee312..0000000000 --- a/reference/solr/solrquery/addgroupfield.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - SolrQuery::addGroupField - Ajoute un champ à utiliser pour grouper les résultats - - - - &reftitle.description; - - public SolrQuerySolrQuery::addGroupField - stringvalue - - - Le nom du champ par lequel grouper les résultats. Le champ doit être à valeur unique, et soit indexé - ou un type de champ qui a une source de valeur et fonctionne dans une requête de fonction, - tel que ExternalFileField. Il doit également être un champ basé sur une chaîne, tel que StrField ou TextField - Utilise le paramètre group.field - - - - - - &reftitle.parameters; - - - value - - - Le nom du champ. - - - - - - - - &reftitle.returnvalues; - - Renvoie une instance de SolrQuery. - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/addgroupfunction.xml b/reference/solr/solrquery/addgroupfunction.xml deleted file mode 100644 index c3b78df88d..0000000000 --- a/reference/solr/solrquery/addgroupfunction.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - SolrQuery::addGroupFunction - Permet de grouper les résultats en fonction des valeurs uniques d'une requête de fonction (paramètre group.func) - - - - &reftitle.description; - - public SolrQuerySolrQuery::addGroupFunction - stringvalue - - - Ajoute une fonction de groupe (paramètre group.func) - Permet de grouper les résultats en fonction des valeurs uniques d'une requête de fonction. - - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/addgroupquery.xml b/reference/solr/solrquery/addgroupquery.xml deleted file mode 100644 index de383d94c3..0000000000 --- a/reference/solr/solrquery/addgroupquery.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrQuery::addGroupQuery - Permet de grouper les documents qui correspondent à la requête donnée - - - - &reftitle.description; - - public SolrQuerySolrQuery::addGroupQuery - stringvalue - - - Permet de grouper les documents qui correspondent à la requête donnée. - Ajoute la requête au paramètre group.query - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/addgroupsortfield.xml b/reference/solr/solrquery/addgroupsortfield.xml deleted file mode 100644 index b365943203..0000000000 --- a/reference/solr/solrquery/addgroupsortfield.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - SolrQuery::addGroupSortField - Ajoute un champ de tri de groupe (paramètre group.sort) - - - - &reftitle.description; - - public SolrQuerySolrQuery::addGroupSortField - stringfield - intorder - - - Permet de trier les documents de groupe, en utilisant le champ de tri de groupe (paramètre group.sort). - - - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - order - - - Ordre ASC/DESC, utilise les constantes SolrQuery::ORDER_*. - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple de <function>SolrQuery::addGroupSortField</function> - -setGroup(true) - ->addGroupSortField('price', SolrQuery::ORDER_ASC); - -echo $solrQuery; -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/addhighlightfield.xml b/reference/solr/solrquery/addhighlightfield.xml deleted file mode 100644 index 41759b7b34..0000000000 --- a/reference/solr/solrquery/addhighlightfield.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::addHighlightField - Lie un hl.fl - - - - &reftitle.description; - - public SolrQuerySolrQuery::addHighlightField - stringfield - - - Lie un hl.fl. - Ceci est utilisé pour spécifier le champ à mettre en évidence. - - - - - - &reftitle.parameters; - - - - field - - - Nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/addmltfield.xml b/reference/solr/solrquery/addmltfield.xml deleted file mode 100644 index fd2370d842..0000000000 --- a/reference/solr/solrquery/addmltfield.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::addMltField - Spécifie un champ à utiliser pour les similitudes - - - - &reftitle.description; - - public SolrQuerySolrQuery::addMltField - stringfield - - - Lie un mlt.fl. - Il spécifie qu'un champ doit être utilisé pour les similitudes. - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/addmltqueryfield.xml b/reference/solr/solrquery/addmltqueryfield.xml deleted file mode 100644 index d63c332688..0000000000 --- a/reference/solr/solrquery/addmltqueryfield.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - SolrQuery::addMltQueryField - Lie un mlt.qf - - - - &reftitle.description; - - public SolrQuerySolrQuery::addMltQueryField - stringfield - floatboost - - - Lie un mlt.qf. - Utilisé pour spécifier les champs de requêtes ainsi que leurs renforts. - - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ - - - - - boost - - - La valeur du renfort - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/addsortfield.xml b/reference/solr/solrquery/addsortfield.xml deleted file mode 100644 index 2f9999cf82..0000000000 --- a/reference/solr/solrquery/addsortfield.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrQuery::addSortField - Utilisé pour contrôler le tri du résultat - - - - &reftitle.description; - - public SolrQuerySolrQuery::addSortField - stringfield - intorderSolrQuery::ORDER_DESC - - - Utilisé pour contrôler le tri du résultat. - - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ - - - - - order - - - La direction du tri. Doit être soit SolrQuery::ORDER_ASC, - soit SolrQuery::ORDER_DESC. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant. - - - - - - diff --git a/reference/solr/solrquery/addstatsfacet.xml b/reference/solr/solrquery/addstatsfacet.xml deleted file mode 100644 index daad9aec65..0000000000 --- a/reference/solr/solrquery/addstatsfacet.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::addStatsFacet - Récupère un sous résultat pour y trouver des valeurs d'une facette donnée - - - - &reftitle.description; - - public SolrQuerySolrQuery::addStatsFacet - stringfield - - - Récupère un sous résultat pour y trouver des valeurs d'une facette - donnée. Lie un champ stats.facet. - - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet courant SolrQuery, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/addstatsfield.xml b/reference/solr/solrquery/addstatsfield.xml deleted file mode 100644 index 880042e8c5..0000000000 --- a/reference/solr/solrquery/addstatsfield.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::addStatsField - Lie un paramètre stats.field - - - - &reftitle.description; - - public SolrQuerySolrQuery::addStatsField - stringfield - - - Lie un paramètre stats.field. - Cette méthode ajoute un autre paramètre stats.field. - - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/collapse.xml b/reference/solr/solrquery/collapse.xml deleted file mode 100644 index f61e11cfa2..0000000000 --- a/reference/solr/solrquery/collapse.xml +++ /dev/null @@ -1,367 +0,0 @@ - - - - - - SolrQuery::collapse - Réduit le résultat à un seul document par groupe - - - - &reftitle.description; - - public SolrQuerySolrQuery::collapse - SolrCollapseFunctioncollapseFunction - - - Réduit le résultat à un seul document par groupe avant de le transmettre - aux autres composants de recherche. - - - De cette façon, tous les composants en aval (facettage, mise en évidence, etc.) - fonctionneront avec le résultat réduit. - - - - - - &reftitle.parameters; - - - - collapseFunction - - - - - - - - - - - - &reftitle.returnvalues; - - Renvoie l'objet SolrQuery actuel - - - - &reftitle.examples; - - Exemple de <methodname>SolrQuery::collapse</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$collapseFunction = new SolrCollapseFunction('manu_id_s'); - -$collapseFunction -->setSize(2) -->setNullPolicy(SolrCollapseFunction::NULLPOLICY_IGNORE); - -$query -->collapse($collapseFunction) -->setRows(4); - -$queryResponse = $client->query($query); - -$response = $queryResponse->getResponse(); - -print_r($response); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - [params] => SolrObject Object - ( - [q] => *:* - [indent] => on - [fq] => {!collapse field=manu_id_s size=2 nullPolicy=ignore} - [rows] => 4 - [version] => 2.2 - [wt] => xml - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 14 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [id] => SP2514N - [name] => Array - ( - [0] => Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133 - ) - - [manu] => Array - ( - [0] => Samsung Electronics Co. Ltd. - ) - - [manu_id_s] => samsung - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => 7200RPM, 8MB cache, IDE Ultra ATA-133 - [1] => NoiseGuard, SilentSeek technology, Fluid Dynamic Bearing (FDB) motor - ) - - [price] => Array - ( - [0] => 92 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [store] => Array - ( - [0] => 35.0752,-97.032 - ) - - [_version_] => 1510294336412057600 - ) - - [1] => SolrObject Object - ( - [id] => 6H500F0 - [name] => Array - ( - [0] => Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300 - ) - - [manu] => Array - ( - [0] => Maxtor Corp. - ) - - [manu_id_s] => maxtor - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => SATA 3.0Gb/s, NCQ - [1] => 8.5ms seek - [2] => 16MB cache - ) - - [price] => Array - ( - [0] => 350 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 45.17614,-93.87341 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [_version_] => 1510294336449806336 - ) - - [2] => SolrObject Object - ( - [id] => F8V7067-APL-KIT - [name] => Array - ( - [0] => Belkin Mobile Power Cord for iPod w/ Dock - ) - - [manu] => Array - ( - [0] => Belkin - ) - - [manu_id_s] => belkin - [cat] => Array - ( - [0] => electronics - [1] => connector - ) - - [features] => Array - ( - [0] => car power adapter, white - ) - - [weight] => Array - ( - [0] => 4 - ) - - [price] => Array - ( - [0] => 19.95 - ) - - [popularity] => Array - ( - [0] => 1 - ) - - [inStock] => Array - ( - [0] => - ) - - [store] => Array - ( - [0] => 45.18014,-93.87741 - ) - - [manufacturedate_dt] => 2005-08-01T16:30:25Z - [_version_] => 1510294336458194944 - ) - - [3] => SolrObject Object - ( - [id] => MA147LL/A - [name] => Array - ( - [0] => Apple 60 GB iPod with Video Playback Black - ) - - [manu] => Array - ( - [0] => Apple Computer Inc. - ) - - [manu_id_s] => apple - [cat] => Array - ( - [0] => electronics - [1] => music - ) - - [features] => Array - ( - [0] => iTunes, Podcasts, Audiobooks - [1] => Stores up to 15,000 songs, 25,000 photos, or 150 hours of video - [2] => 2.5-inch, 320x240 color TFT LCD display with LED backlight - [3] => Up to 20 hours of battery life - [4] => Plays AAC, MP3, WAV, AIFF, Audible, Apple Lossless, H.264 video - [5] => Notes, Calendar, Phone book, Hold button, Date display, Photo wallet, Built-in games, JPEG photo playback, Upgradeable firmware, USB 2.0 compatibility, Playback speed control, Rechargeable capability, Battery level indication - ) - - [includes] => Array - ( - [0] => earbud headphones, USB cable - ) - - [weight] => Array - ( - [0] => 5.5 - ) - - [price] => Array - ( - [0] => 399 - ) - - [popularity] => Array - ( - [0] => 10 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 37.7752,-100.0232 - ) - - [manufacturedate_dt] => 2005-10-12T08:00:00Z - [_version_] => 1510294336562003968 - ) - - ) - - ) - -) -]]> - - - - - - diff --git a/reference/solr/solrquery/construct.xml b/reference/solr/solrquery/construct.xml deleted file mode 100644 index 89bf90ade7..0000000000 --- a/reference/solr/solrquery/construct.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - SolrQuery::__construct - Constructeur - - - - &reftitle.description; - - public SolrQuery::__construct - stringq - - - Constructeur. - - - - - - &reftitle.parameters; - - - - q - - - Requête de recherche optionnelle - - - - - - - - - &reftitle.returnvalues; - - Aucun - - - - - &reftitle.errors; - - Émet une exception SolrIllegalArgumentException - lorsqu'un paramètre invalide est passé. - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL solr 2.0.0 - - Si q est invalide, alors une exception - SolrIllegalArgumentException est émise. - Auparavant, une erreur était émise. - - - - - - - - - - diff --git a/reference/solr/solrquery/destruct.xml b/reference/solr/solrquery/destruct.xml deleted file mode 100644 index e3c55dcb33..0000000000 --- a/reference/solr/solrquery/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::__destruct - Destructeur - - - - &reftitle.description; - - public SolrQuery::__destruct - - - - Destructeur - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Aucun. - - - - - - diff --git a/reference/solr/solrquery/getexpand.xml b/reference/solr/solrquery/getexpand.xml deleted file mode 100644 index ce7c2f67ef..0000000000 --- a/reference/solr/solrquery/getexpand.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrQuery::getExpand - Renvoie true si l'extension de groupe est activée - - - - &reftitle.description; - - public boolSolrQuery::getExpand - - - - Renvoie &true; si l'extension de groupe est activée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie si l'extension de groupe est activée. - - - - - - diff --git a/reference/solr/solrquery/getexpandfilterqueries.xml b/reference/solr/solrquery/getexpandfilterqueries.xml deleted file mode 100644 index 66bdbdefa2..0000000000 --- a/reference/solr/solrquery/getexpandfilterqueries.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getExpandFilterQueries - Renvoie les requêtes de filtre d'extension - - - - &reftitle.description; - - public arraySolrQuery::getExpandFilterQueries - - - - Renvoie les requêtes de filtre d'extension. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie les requêtes de filtre d'extension. - - - - - - diff --git a/reference/solr/solrquery/getexpandquery.xml b/reference/solr/solrquery/getexpandquery.xml deleted file mode 100644 index b14fb40079..0000000000 --- a/reference/solr/solrquery/getexpandquery.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrQuery::getExpandQuery - Renvoie le paramètre de requête d'extension expand.q - - - - &reftitle.description; - - public arraySolrQuery::getExpandQuery - - - - Renvoie le paramètre de requête d'extension expand.q. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la requête d'extension. - - - - - - diff --git a/reference/solr/solrquery/getexpandrows.xml b/reference/solr/solrquery/getexpandrows.xml deleted file mode 100644 index 53efe10660..0000000000 --- a/reference/solr/solrquery/getexpandrows.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getExpandRows - Renvoie le nombre de lignes à afficher dans chaque groupe (expand.rows) - - - - &reftitle.description; - - public intSolrQuery::getExpandRows - - - - Renvoie le nombre de lignes à afficher dans chaque groupe (expand.rows). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nombre de lignes. - - - - - - diff --git a/reference/solr/solrquery/getexpandsortfields.xml b/reference/solr/solrquery/getexpandsortfields.xml deleted file mode 100644 index b1a0a218d8..0000000000 --- a/reference/solr/solrquery/getexpandsortfields.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrQuery::getExpandSortFields - Renvoie un tableau de champs - - - - &reftitle.description; - - public arraySolrQuery::getExpandSortFields - - - - Renvoie un tableau de champs. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un tableau de champs. - - - - - - diff --git a/reference/solr/solrquery/getfacet.xml b/reference/solr/solrquery/getfacet.xml deleted file mode 100644 index e30064d884..0000000000 --- a/reference/solr/solrquery/getfacet.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getFacet - Retourne la valeur du paramètre de facette - - - - &reftitle.description; - - public boolSolrQuery::getFacet - - - - Retourne la valeur du paramètre de facette. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès, et &null; si aucun - paramètre n'est défini. - - - - - - diff --git a/reference/solr/solrquery/getfacetdateend.xml b/reference/solr/solrquery/getfacetdateend.xml deleted file mode 100644 index 349bed09c4..0000000000 --- a/reference/solr/solrquery/getfacetdateend.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::getFacetDateEnd - Retourne la valeur du paramètre facet.date.end - - - - &reftitle.description; - - public stringSolrQuery::getFacetDateEnd - stringfield_override - - - Retourne la valeur du paramètre facet.date.end. - Cette méthode accepte un champ optionnel permettant l'écrasement. - - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si aucun - paramètre n'est défini. - - - - - - diff --git a/reference/solr/solrquery/getfacetdatefields.xml b/reference/solr/solrquery/getfacetdatefields.xml deleted file mode 100644 index d47a03501b..0000000000 --- a/reference/solr/solrquery/getfacetdatefields.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getFacetDateFields - Retourne tous les champs facet.date - - - - &reftitle.description; - - public arraySolrQuery::getFacetDateFields - - - Retourne tous les champs facet.date. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne tous les champs facet.date sous la forme d'un &array; - ou &null; si aucun n'a été défini. - - - - - - - diff --git a/reference/solr/solrquery/getfacetdategap.xml b/reference/solr/solrquery/getfacetdategap.xml deleted file mode 100644 index d8ffcc56d7..0000000000 --- a/reference/solr/solrquery/getfacetdategap.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::getFacetDateGap - Récupère la valeur du paramètre facet.date.gap - - - - &reftitle.description; - - public stringSolrQuery::getFacetDateGap - stringfield_override - - - Récupère la valeur du paramètre facet.date.gap. La méthode - accepte un champ à y substituer. - - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; s'il n'est pas défini. - - - - - - - diff --git a/reference/solr/solrquery/getfacetdatehardend.xml b/reference/solr/solrquery/getfacetdatehardend.xml deleted file mode 100644 index 550ecb1c30..0000000000 --- a/reference/solr/solrquery/getfacetdatehardend.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::getFacetDateHardEnd - Récupère la valeur du paramètre facet.date.hardend - - - - &reftitle.description; - - public stringSolrQuery::getFacetDateHardEnd - stringfield_override - - - Récupère la valeur du paramètre facet.date.hardend . La méthode - accepte un champ à y substituer. - - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; s'il n'est pas défini. - - - - - - diff --git a/reference/solr/solrquery/getfacetdateother.xml b/reference/solr/solrquery/getfacetdateother.xml deleted file mode 100644 index 01e1af4df4..0000000000 --- a/reference/solr/solrquery/getfacetdateother.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::getFacetDateOther - Récupère la valeur du paramètre facet.date.other - - - - &reftitle.description; - - public arraySolrQuery::getFacetDateOther - stringfield_override - - - Récupère la valeur du paramètre facet.date.other. La méthode - accepte un champ à y substituer. - - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne un &array; en cas de succès, et &null; s'il n'est pas défini. - - - - - - - diff --git a/reference/solr/solrquery/getfacetdatestart.xml b/reference/solr/solrquery/getfacetdatestart.xml deleted file mode 100644 index 0fed597978..0000000000 --- a/reference/solr/solrquery/getfacetdatestart.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::getFacetDateStart - Récupère la limite inférieure du premier intervalle de la date pour toutes les facettes de date pour ce champ - - - - &reftitle.description; - - public stringSolrQuery::getFacetDateStart - stringfield_override - - - 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. - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si le paramètre - n'est pas défini. - - - - - - diff --git a/reference/solr/solrquery/getfacetfields.xml b/reference/solr/solrquery/getfacetfields.xml deleted file mode 100644 index 6133d2a631..0000000000 --- a/reference/solr/solrquery/getfacetfields.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrQuery::getFacetFields - Récupère toutes les facettes des champs - - - - &reftitle.description; - - public arraySolrQuery::getFacetFields - - - - Récupère toutes les facettes des champs. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant tous les champs et &null; si aucun - n'a été défini. - - - - - diff --git a/reference/solr/solrquery/getfacetlimit.xml b/reference/solr/solrquery/getfacetlimit.xml deleted file mode 100644 index 33c1c905ad..0000000000 --- a/reference/solr/solrquery/getfacetlimit.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - SolrQuery::getFacetLimit - Récupère le nombre maximal de contraintes qui peut être retourné pour les facettes des champs - - - - &reftitle.description; - - public intSolrQuery::getFacetLimit - stringfield_override - - - 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. - - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucun - paramètre n'est défini. - - - - - - diff --git a/reference/solr/solrquery/getfacetmethod.xml b/reference/solr/solrquery/getfacetmethod.xml deleted file mode 100644 index 27cd43baf7..0000000000 --- a/reference/solr/solrquery/getfacetmethod.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::getFacetMethod - Récupère la valeur du paramètre facet.method - - - - &reftitle.description; - - public stringSolrQuery::getFacetMethod - stringfield_override - - - Récupère la valeur du paramètre facet.method. La méthode - accepte un champ à y substituer. - - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; s'il n'est pas défini. - - - - - - - diff --git a/reference/solr/solrquery/getfacetmincount.xml b/reference/solr/solrquery/getfacetmincount.xml deleted file mode 100644 index 2f28baba5e..0000000000 --- a/reference/solr/solrquery/getfacetmincount.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::getFacetMinCount - Récupère le nombre minimal de facettes des champs qui doivent être incluses dans la réponse - - - - &reftitle.description; - - public intSolrQuery::getFacetMinCount - stringfield_override - - - 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. - - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucun paramètre n'est défini. - - - - - - diff --git a/reference/solr/solrquery/getfacetmissing.xml b/reference/solr/solrquery/getfacetmissing.xml deleted file mode 100644 index 17c634ff83..0000000000 --- a/reference/solr/solrquery/getfacetmissing.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrQuery::getFacetMissing - Récupère l'état courant du paramètre facet.missing - - - - &reftitle.description; - - public boolSolrQuery::getFacetMissing - stringfield_override - - - Récupère l'état courant du paramètre facet.missing. Accepte un champ - optionnel autorisant l'écrasement. - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès, et &null; si aucun paramètre n'est défini. - - - - - diff --git a/reference/solr/solrquery/getfacetoffset.xml b/reference/solr/solrquery/getfacetoffset.xml deleted file mode 100644 index c39ea9ce0a..0000000000 --- a/reference/solr/solrquery/getfacetoffset.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrQuery::getFacetOffset - Récupère la position dans la liste des contraintes à utiliser pour la pagination - - - - &reftitle.description; - - public intSolrQuery::getFacetOffset - stringfield_override - - - Récupère la position dans la liste des contraintes à utiliser pour la - pagination. Accepte un champ optionnel autorisant l'écrasement. - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucun paramètre n'est défini. - - - - - diff --git a/reference/solr/solrquery/getfacetprefix.xml b/reference/solr/solrquery/getfacetprefix.xml deleted file mode 100644 index 980310650d..0000000000 --- a/reference/solr/solrquery/getfacetprefix.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - SolrQuery::getFacetPrefix - Récupère le préfixe de la facette - - - - &reftitle.description; - - public stringSolrQuery::getFacetPrefix - stringfield_override - - - Récupère le préfixe de la facette. - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si aucun paramètre n'est défini. - - - - - diff --git a/reference/solr/solrquery/getfacetqueries.xml b/reference/solr/solrquery/getfacetqueries.xml deleted file mode 100644 index 618e0d19e2..0000000000 --- a/reference/solr/solrquery/getfacetqueries.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrQuery::getFacetQueries - Récupère toutes les facettes des requêtes - - - - &reftitle.description; - - public arraySolrQuery::getFacetQueries - - - - Récupère toutes les facettes des requêtes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau en cas de succès, et &null; si aucun paramètre - n'a été défini. - - - - - diff --git a/reference/solr/solrquery/getfacetsort.xml b/reference/solr/solrquery/getfacetsort.xml deleted file mode 100644 index cef735d869..0000000000 --- a/reference/solr/solrquery/getfacetsort.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::getFacetSort - Retourne le type de tri de la facette - - - - &reftitle.description; - - public intSolrQuery::getFacetSort - stringfield_override - - - Retourne un entier (SolrQuery::FACET_SORT_INDEX ou SolrQuery::FACET_SORT_COUNT). - - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne un entier (SolrQuery::FACET_SORT_INDEX ou SolrQuery::FACET_SORT_COUNT) - en cas de succès, et &null; si aucun paramètre n'est défini. - - - - - - diff --git a/reference/solr/solrquery/getfields.xml b/reference/solr/solrquery/getfields.xml deleted file mode 100644 index 690e9301db..0000000000 --- a/reference/solr/solrquery/getfields.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrQuery::getFields - Récupère la liste des champs qui seront retournés dans la réponse - - - - &reftitle.description; - - public arraySolrQuery::getFields - - - - Récupère la liste des champs qui seront retournés dans la réponse. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau en cas de succès, et &null; si aucun n'est défini. - - - - - diff --git a/reference/solr/solrquery/getfilterqueries.xml b/reference/solr/solrquery/getfilterqueries.xml deleted file mode 100644 index 50ec7e12eb..0000000000 --- a/reference/solr/solrquery/getfilterqueries.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrQuery::getFilterQueries - Récupère un tableau de filtres de requêtes - - - - &reftitle.description; - - public arraySolrQuery::getFilterQueries - - - - 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. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau en cas de succès, et &null; si aucun n'est défini. - - - - - - - diff --git a/reference/solr/solrquery/getgroup.xml b/reference/solr/solrquery/getgroup.xml deleted file mode 100644 index 809e9f1aaf..0000000000 --- a/reference/solr/solrquery/getgroup.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroup - Renvoie si le regroupement est activé - - - - &reftitle.description; - - public boolSolrQuery::getGroup - - - - Renvoie true si le regroupement est activé. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - - - - - - diff --git a/reference/solr/solrquery/getgroupcachepercent.xml b/reference/solr/solrquery/getgroupcachepercent.xml deleted file mode 100644 index 5564b9a46c..0000000000 --- a/reference/solr/solrquery/getgroupcachepercent.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - SolrQuery::getGroupCachePercent - Renvoie la valeur du pourcentage de cache de groupe - - - - &reftitle.description; - - public intSolrQuery::getGroupCachePercent - - - - Renvoie la valeur du pourcentage de cache de groupe. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupCachePercent - - - - - - diff --git a/reference/solr/solrquery/getgroupfacet.xml b/reference/solr/solrquery/getgroupfacet.xml deleted file mode 100644 index 5ca02b1d3b..0000000000 --- a/reference/solr/solrquery/getgroupfacet.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - SolrQuery::getGroupFacet - Renvoie la valeur du paramètre group.facet - - - - &reftitle.description; - - public boolSolrQuery::getGroupFacet - - - - Renvoie la valeur du paramètre group.facet. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupFacet - - - - - - diff --git a/reference/solr/solrquery/getgroupfields.xml b/reference/solr/solrquery/getgroupfields.xml deleted file mode 100644 index f57e2e1f9b..0000000000 --- a/reference/solr/solrquery/getgroupfields.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupFields - Renvoie les champs de groupe (valeurs du paramètre group.field) - - - - &reftitle.description; - - public arraySolrQuery::getGroupFields - - - - Renvoie les champs de groupe (valeurs du paramètre group.field). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::addGroupField - - - - - - diff --git a/reference/solr/solrquery/getgroupformat.xml b/reference/solr/solrquery/getgroupformat.xml deleted file mode 100644 index 8b0debdd01..0000000000 --- a/reference/solr/solrquery/getgroupformat.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupFormat - Renvoie la valeur de group.format - - - - &reftitle.description; - - public stringSolrQuery::getGroupFormat - - - - Renvoie la valeur de group.format. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupFormat - - - - - - diff --git a/reference/solr/solrquery/getgroupfunctions.xml b/reference/solr/solrquery/getgroupfunctions.xml deleted file mode 100644 index 3a1e1fe5c4..0000000000 --- a/reference/solr/solrquery/getgroupfunctions.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupFunctions - Renvoie les fonctions de groupe (valeurs du paramètre group.func) - - - - &reftitle.description; - - public arraySolrQuery::getGroupFunctions - - - - Renvoie les fonctions de groupe (valeurs du paramètre group.func). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::addGroupFunction - - - - - - diff --git a/reference/solr/solrquery/getgrouplimit.xml b/reference/solr/solrquery/getgrouplimit.xml deleted file mode 100644 index 1c2907677c..0000000000 --- a/reference/solr/solrquery/getgrouplimit.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupLimit - Renvoie la valeur de group.limit - - - - &reftitle.description; - - public intSolrQuery::getGroupLimit - - - - Renvoie la valeur de group.limit. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupLimit - - - - - - diff --git a/reference/solr/solrquery/getgroupmain.xml b/reference/solr/solrquery/getgroupmain.xml deleted file mode 100644 index 43942ccc4b..0000000000 --- a/reference/solr/solrquery/getgroupmain.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupMain - Renvoie la valeur de group.main - - - - &reftitle.description; - - public boolSolrQuery::getGroupMain - - - - Renvoie la valeur de group.main. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupMain - - - - - - diff --git a/reference/solr/solrquery/getgroupngroups.xml b/reference/solr/solrquery/getgroupngroups.xml deleted file mode 100644 index 87b4a67ae0..0000000000 --- a/reference/solr/solrquery/getgroupngroups.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupNGroups - Renvoie la valeur de group.ngroups - - - - &reftitle.description; - - public boolSolrQuery::getGroupNGroups - - - - Renvoie la valeur de group.ngroups. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupNGroups - - - - - - diff --git a/reference/solr/solrquery/getgroupoffset.xml b/reference/solr/solrquery/getgroupoffset.xml deleted file mode 100644 index 18d53902b6..0000000000 --- a/reference/solr/solrquery/getgroupoffset.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupOffset - Renvoie la valeur de group.offset - - - - &reftitle.description; - - public intSolrQuery::getGroupOffset - - - - Renvoie la valeur de group.offset. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupOffset - - - - - - diff --git a/reference/solr/solrquery/getgroupqueries.xml b/reference/solr/solrquery/getgroupqueries.xml deleted file mode 100644 index 3bc11de496..0000000000 --- a/reference/solr/solrquery/getgroupqueries.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupQueries - Renvoie toutes les valeurs du paramètre group.query - - - - &reftitle.description; - - public arraySolrQuery::getGroupQueries - - - - Renvoie toutes les valeurs du paramètre group.query. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - array - - - - - &reftitle.seealso; - - SolrQuery::addGroupQuery - - - - - - diff --git a/reference/solr/solrquery/getgroupsortfields.xml b/reference/solr/solrquery/getgroupsortfields.xml deleted file mode 100644 index 014c744697..0000000000 --- a/reference/solr/solrquery/getgroupsortfields.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupSortFields - Renvoie la valeur de group.sort - - - - &reftitle.description; - - public arraySolrQuery::getGroupSortFields - - - - Renvoie la valeur de group.sort. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::addGroupSortField - - - - - - diff --git a/reference/solr/solrquery/getgrouptruncate.xml b/reference/solr/solrquery/getgrouptruncate.xml deleted file mode 100644 index ec0d8bece8..0000000000 --- a/reference/solr/solrquery/getgrouptruncate.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupTruncate - Renvoie la valeur de group.truncate - - - - &reftitle.description; - - public boolSolrQuery::getGroupTruncate - - - - Renvoie la valeur de group.truncate. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupTruncate - - - - - - diff --git a/reference/solr/solrquery/gethighlight.xml b/reference/solr/solrquery/gethighlight.xml deleted file mode 100644 index e4712f7f0c..0000000000 --- a/reference/solr/solrquery/gethighlight.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrQuery::getHighlight - Récupère l'état du paramètre hl - - - - &reftitle.description; - - public boolSolrQuery::getHighlight - - - - Retourne un booléen indiquant si les extraits mis en évidence doivent - être générés dans la réponse. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès, et &null; si aucun n'est défini. - - - - - diff --git a/reference/solr/solrquery/gethighlightalternatefield.xml b/reference/solr/solrquery/gethighlightalternatefield.xml deleted file mode 100644 index 4ae36001f8..0000000000 --- a/reference/solr/solrquery/gethighlightalternatefield.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::getHighlightAlternateField - Récupère le champ mis en évidence à utiliser comme champ par défaut ou comme champ de sauvegarde - - - - &reftitle.description; - - public stringSolrQuery::getHighlightAlternateField - stringfield_override - - - 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. - - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si aucun n'a été défini. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightfields.xml b/reference/solr/solrquery/gethighlightfields.xml deleted file mode 100644 index 15ee2f20b4..0000000000 --- a/reference/solr/solrquery/gethighlightfields.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - SolrQuery::getHighlightFields - Récupère tous les champs pour lesquels Solr doit mettre en évidence un extrait - - - - &reftitle.description; - - public arraySolrQuery::getHighlightFields - - - - Récupère tous les champs pour lesquels Solr doit mettre en évidence un extrait. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau en cas de succès, et &null; si aucun n'a été défini. - - - - - diff --git a/reference/solr/solrquery/gethighlightformatter.xml b/reference/solr/solrquery/gethighlightformatter.xml deleted file mode 100644 index f7ee65bffc..0000000000 --- a/reference/solr/solrquery/gethighlightformatter.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrQuery::getHighlightFormatter - Récupère le formatage utilisé pour mettre en évidence la sortie - - - - &reftitle.description; - - public stringSolrQuery::getHighlightFormatter - stringfield_override - - - Récupère le formatage utilisé pour mettre en évidence la sortie. - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si aucun n'est défini. - - - - - - diff --git a/reference/solr/solrquery/gethighlightfragmenter.xml b/reference/solr/solrquery/gethighlightfragmenter.xml deleted file mode 100644 index 3befaed412..0000000000 --- a/reference/solr/solrquery/gethighlightfragmenter.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::getHighlightFragmenter - Récupère le générateur d'extrait de texte pour la mise en évidence - - - - &reftitle.description; - - public stringSolrQuery::getHighlightFragmenter - stringfield_override - - - Récupère le générateur d'extrait de texte pour la mise en évidence. - Accepte un champ optionnel permettant l'écrasement. - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si aucun n'est défini. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightfragsize.xml b/reference/solr/solrquery/gethighlightfragsize.xml deleted file mode 100644 index 56c6f02aa4..0000000000 --- a/reference/solr/solrquery/gethighlightfragsize.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrQuery::getHighlightFragsize - Retourne le nombre de caractères des fragments à considérer pour la mise en évidence - - - - &reftitle.description; - - public intSolrQuery::getHighlightFragsize - stringfield_override - - - Retourne le nombre de caractères des fragments à considérer pour la mise en - évidence. Zéro signifie aucun fragment. Le champ entier devrait être utilisé. - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucun n'est défini. - - - - - diff --git a/reference/solr/solrquery/gethighlighthighlightmultiterm.xml b/reference/solr/solrquery/gethighlighthighlightmultiterm.xml deleted file mode 100644 index 54312ef10a..0000000000 --- a/reference/solr/solrquery/gethighlighthighlightmultiterm.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getHighlightHighlightMultiTerm - Retourne si l'on doit activer la mise en évidence pour les intervalles/jokers/flous/préfixes des requêtes - - - - &reftitle.description; - - public boolSolrQuery::getHighlightHighlightMultiTerm - - - - Retourne si l'on doit activer la mise en évidence pour les - intervalles/jokers/flous/préfixes des requêtes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès, et &null; si aucun n'est défini. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightmaxalternatefieldlength.xml b/reference/solr/solrquery/gethighlightmaxalternatefieldlength.xml deleted file mode 100644 index ed9999550b..0000000000 --- a/reference/solr/solrquery/gethighlightmaxalternatefieldlength.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::getHighlightMaxAlternateFieldLength - Retourne le nombre maximal de caractères du champ à retourner - - - - &reftitle.description; - - public intSolrQuery::getHighlightMaxAlternateFieldLength - stringfield_override - - - Retourne le nombre maximal de caractères du champ à retourner. - - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucun n'est défini. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightmaxanalyzedchars.xml b/reference/solr/solrquery/gethighlightmaxanalyzedchars.xml deleted file mode 100644 index b0442002fa..0000000000 --- a/reference/solr/solrquery/gethighlightmaxanalyzedchars.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrQuery::getHighlightMaxAnalyzedChars - Retourne le nombre maximal de caractères du document dans lequel les extraits seront cherchés - - - - &reftitle.description; - - public intSolrQuery::getHighlightMaxAnalyzedChars - - - - Retourne le nombre maximal de caractères du document dans lequel les extraits seront cherchés. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucun n'est défini. - - - - - - diff --git a/reference/solr/solrquery/gethighlightmergecontiguous.xml b/reference/solr/solrquery/gethighlightmergecontiguous.xml deleted file mode 100644 index c34cded76d..0000000000 --- a/reference/solr/solrquery/gethighlightmergecontiguous.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::getHighlightMergeContiguous - Retourne si l'on doit rassembler les fragments contigus en un seul fragment - - - - &reftitle.description; - - public boolSolrQuery::getHighlightMergeContiguous - stringfield_override - - - Retourne si l'on doit rassembler les fragments contigus en un seul fragment. - Accepte un champ optionnel permettant l'écrasement. - - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès, et &null; si aucun n'est défini. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightquery.xml b/reference/solr/solrquery/gethighlightquery.xml deleted file mode 100644 index 9d7d1efb86..0000000000 --- a/reference/solr/solrquery/gethighlightquery.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - SolrQuery::getHighlightQuery - Retourne la requête de mise en évidence - - - - &reftitle.description; - - public stringnullSolrQuery::getHighlightQuery - - - - Retourne la requête de mise en évidence précédemment définie via le - paramètre hl.q. - Ce paramètre permet de mettre en évidence des termes ou des champs différents de ceux utilisés pour récupérer les documents. - Voir la section Highlighting - pour plus de détails. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant la requête de mise en évidence de l'objet - SolrQuery courant, ou &null; si la requête de mise en - évidence n'est pas définie. - - - - - &reftitle.seealso; - - SolrQuery::setHighlightQuery - SolrQuery::getHighlightFields - SolrQuery::setHighlightFields - - - - diff --git a/reference/solr/solrquery/gethighlightregexmaxanalyzedchars.xml b/reference/solr/solrquery/gethighlightregexmaxanalyzedchars.xml deleted file mode 100644 index d1cba14ff0..0000000000 --- a/reference/solr/solrquery/gethighlightregexmaxanalyzedchars.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getHighlightRegexMaxAnalyzedChars - Retourne le nombre maximal de caractères depuis un champ lors de l'utilisation d'une regex - - - - &reftitle.description; - - public intSolrQuery::getHighlightRegexMaxAnalyzedChars - - - - Retourne le nombre maximal de caractères depuis un champ lors de l'utilisation d'une regex. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucun n'est défini. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightregexpattern.xml b/reference/solr/solrquery/gethighlightregexpattern.xml deleted file mode 100644 index 861c0a3668..0000000000 --- a/reference/solr/solrquery/gethighlightregexpattern.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrQuery::getHighlightRegexPattern - Récupère l'expression rationnelle utilisée pour la fragmentation - - - - &reftitle.description; - - public stringSolrQuery::getHighlightRegexPattern - - - - Récupère l'expression rationnelle utilisée pour la fragmentation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si aucun n'est défini. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightregexslop.xml b/reference/solr/solrquery/gethighlightregexslop.xml deleted file mode 100644 index 92a5f7270f..0000000000 --- a/reference/solr/solrquery/gethighlightregexslop.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - SolrQuery::getHighlightRegexSlop - Récupère le facteur de déviation depuis la taille du fragment idéal - - - - &reftitle.description; - - public floatSolrQuery::getHighlightRegexSlop - - - - Retourne le facteur utilisé par l'expression rationnelle de fragmentation - pour la déviation depuis la taille idéale du fragment afin d'accommoder - l'expression rationnelle. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un float en cas de succès, et &null; si aucun n'est défini. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightrequirefieldmatch.xml b/reference/solr/solrquery/gethighlightrequirefieldmatch.xml deleted file mode 100644 index 1b5be82da9..0000000000 --- a/reference/solr/solrquery/gethighlightrequirefieldmatch.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrQuery::getHighlightRequireFieldMatch - Retourne si le champ ne doit être mis en évidence que si la requête correspond à un champ en particulier - - - - &reftitle.description; - - public boolSolrQuery::getHighlightRequireFieldMatch - - - - Retourne si le champ ne doit être mis en évidence que si la requête - correspond à un champ en particulier. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès, et &null; si aucun n'est défini. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightsimplepost.xml b/reference/solr/solrquery/gethighlightsimplepost.xml deleted file mode 100644 index 7bad90912d..0000000000 --- a/reference/solr/solrquery/gethighlightsimplepost.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::getHighlightSimplePost - Récupère le texte qui doit apparaître après le terme mis en évidence - - - - &reftitle.description; - - public stringSolrQuery::getHighlightSimplePost - stringfield_override - - - Récupère le texte qui doit apparaître après le terme mis en évidence. - Accepte un champ optionnel permettant l'écrasement. - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si aucun n'est défini. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightsimplepre.xml b/reference/solr/solrquery/gethighlightsimplepre.xml deleted file mode 100644 index 2011709a1d..0000000000 --- a/reference/solr/solrquery/gethighlightsimplepre.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::getHighlightSimplePre - Retourne le texte qui doit apparaître avant le terme mis en évidence - - - - &reftitle.description; - - public stringSolrQuery::getHighlightSimplePre - stringfield_override - - - Retourne le texte qui doit apparaître avant le terme mis en évidence. - Accepte un champ optionnel permettant l'écrasement. - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si aucun n'est défini. - - - - - - diff --git a/reference/solr/solrquery/gethighlightsnippets.xml b/reference/solr/solrquery/gethighlightsnippets.xml deleted file mode 100644 index a51c4a27aa..0000000000 --- a/reference/solr/solrquery/gethighlightsnippets.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::getHighlightSnippets - Récupère le nombre maximal d'extraits mis en évidence à générer par champ - - - - &reftitle.description; - - public intSolrQuery::getHighlightSnippets - stringfield_override - - - Récupère le nombre maximal d'extraits mis en évidence à générer par champ. - Accepte un champ optionnel permettant l'écrasement. - - - - - &reftitle.parameters; - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucun n'est défini. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightusephrasehighlighter.xml b/reference/solr/solrquery/gethighlightusephrasehighlighter.xml deleted file mode 100644 index 792019a094..0000000000 --- a/reference/solr/solrquery/gethighlightusephrasehighlighter.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrQuery::getHighlightUsePhraseHighlighter - Récupère l'état du paramètre hl.usePhraseHighlighter - - - - &reftitle.description; - - public boolSolrQuery::getHighlightUsePhraseHighlighter - - - - 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. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès, et &null; si aucun n'est défini. - - - - - - - diff --git a/reference/solr/solrquery/getmlt.xml b/reference/solr/solrquery/getmlt.xml deleted file mode 100644 index b35ccf0979..0000000000 --- a/reference/solr/solrquery/getmlt.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrQuery::getMlt - Retourne si les résultats MoreLikeThis doivent être activés - - - - &reftitle.description; - - public boolSolrQuery::getMlt - - - - Retourne si les résultats MoreLikeThis doivent être activés. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès, et &null; si aucun n'est défini. - - - - - - diff --git a/reference/solr/solrquery/getmltboost.xml b/reference/solr/solrquery/getmltboost.xml deleted file mode 100644 index 594c559d80..0000000000 --- a/reference/solr/solrquery/getmltboost.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrQuery::getMltBoost - Retourne si la requête doit être améliorée en utilisant la pertinence des termes - - - - &reftitle.description; - - public boolSolrQuery::getMltBoost - - - - Retourne si la requête doit être améliorée en utilisant la pertinence - des termes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès, et &null; si aucun n'est défini. - - - - - - diff --git a/reference/solr/solrquery/getmltcount.xml b/reference/solr/solrquery/getmltcount.xml deleted file mode 100644 index 23f57713ff..0000000000 --- a/reference/solr/solrquery/getmltcount.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrQuery::getMltCount - Récupère le nombre de documents similaires à retourner pour chaque résultat - - - - &reftitle.description; - - public intSolrQuery::getMltCount - - - - Récupère le nombre de documents similaires à retourner pour chaque résultat. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucun n'est défini. - - - - - - diff --git a/reference/solr/solrquery/getmltfields.xml b/reference/solr/solrquery/getmltfields.xml deleted file mode 100644 index 9a41e3ede4..0000000000 --- a/reference/solr/solrquery/getmltfields.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrQuery::getMltFields - Récupère tous les champs à utiliser pour la similarité - - - - &reftitle.description; - - public arraySolrQuery::getMltFields - - - - Récupère tous les champs à utiliser pour la similarité. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau en cas de succès, et &null; si aucun n'est défini. - - - - - - diff --git a/reference/solr/solrquery/getmltmaxnumqueryterms.xml b/reference/solr/solrquery/getmltmaxnumqueryterms.xml deleted file mode 100644 index e198d5a93c..0000000000 --- a/reference/solr/solrquery/getmltmaxnumqueryterms.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrQuery::getMltMaxNumQueryTerms - Retourne le nombre maximal de termes de requête qui peuvent être inclus lors de la génération d'une requête - - - - &reftitle.description; - - public intSolrQuery::getMltMaxNumQueryTerms - - - - Retourne le nombre maximal de termes de requête qui peuvent être inclus lors - de la génération d'une requête. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si le nombre maximal - n'est pas défini. - - - - - - diff --git a/reference/solr/solrquery/getmltmaxnumtokens.xml b/reference/solr/solrquery/getmltmaxnumtokens.xml deleted file mode 100644 index 2666733694..0000000000 --- a/reference/solr/solrquery/getmltmaxnumtokens.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrQuery::getMltMaxNumTokens - Retourne le nombre maximal de jokers à analyser dans chaque champ du document - - - - &reftitle.description; - - public intSolrQuery::getMltMaxNumTokens - - - - Retourne le nombre maximal de jokers à analyser dans chaque champ du document - qui n'est pas stocké avec le support TermVector. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si le nombre maximal - de jokers n'est pas défini. - - - - - - diff --git a/reference/solr/solrquery/getmltmaxwordlength.xml b/reference/solr/solrquery/getmltmaxwordlength.xml deleted file mode 100644 index 5701b784d1..0000000000 --- a/reference/solr/solrquery/getmltmaxwordlength.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getMltMaxWordLength - Retourne la longueur maximale des mots au-delà de laquelle ils seront ignorés - - - - &reftitle.description; - - public intSolrQuery::getMltMaxWordLength - - - - Retourne la longueur maximale des mots au-delà de laquelle ils seront ignorés. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si la longueur n'est pas - définie. - - - - - - diff --git a/reference/solr/solrquery/getmltmindocfrequency.xml b/reference/solr/solrquery/getmltmindocfrequency.xml deleted file mode 100644 index ec68d4e41b..0000000000 --- a/reference/solr/solrquery/getmltmindocfrequency.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrQuery::getMltMinDocFrequency - Retourne le seuil de fréquence d'apparition des mots - - - - &reftitle.description; - - public intSolrQuery::getMltMinDocFrequency - - - - Retourne le seuil de fréquence d'apparition des mots en deçà duquel - ils seront ignorés. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si le seuil n'est - pas défini. - - - - - - diff --git a/reference/solr/solrquery/getmltmintermfrequency.xml b/reference/solr/solrquery/getmltmintermfrequency.xml deleted file mode 100644 index a00c124552..0000000000 --- a/reference/solr/solrquery/getmltmintermfrequency.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrQuery::getMltMinTermFrequency - Retourne la fréquence en deçà de laquelle les termes doivent être ignorés dans le document source - - - - &reftitle.description; - - public intSolrQuery::getMltMinTermFrequency - - - - Retourne la fréquence en deçà de laquelle les termes doivent être ignorés dans le - document source. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si la fréquence - n'est pas définie. - - - - - - diff --git a/reference/solr/solrquery/getmltminwordlength.xml b/reference/solr/solrquery/getmltminwordlength.xml deleted file mode 100644 index c1b7ef67d7..0000000000 --- a/reference/solr/solrquery/getmltminwordlength.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getMltMinWordLength - Retourne la longueur minimum d'un mot en deçà duquel il sera ignoré - - - - &reftitle.description; - - public intSolrQuery::getMltMinWordLength - - - - Retourne la longueur minimum d'un mot en deçà duquel il sera ignoré. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si la longueur - n'est pas définie. - - - - - - diff --git a/reference/solr/solrquery/getmltqueryfields.xml b/reference/solr/solrquery/getmltqueryfields.xml deleted file mode 100644 index e772021c76..0000000000 --- a/reference/solr/solrquery/getmltqueryfields.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrQuery::getMltQueryFields - Retourne les champs de la requête ainsi que leurs boosts - - - - &reftitle.description; - - public arraySolrQuery::getMltQueryFields - - - - Retourne les champs de la requête ainsi que leurs boosts. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau en cas de succès, et &null; - si aucun champ n'est défini. - - - - - - diff --git a/reference/solr/solrquery/getquery.xml b/reference/solr/solrquery/getquery.xml deleted file mode 100644 index 4330766fda..0000000000 --- a/reference/solr/solrquery/getquery.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getQuery - Retourne la requête principale - - - - &reftitle.description; - - public stringSolrQuery::getQuery - - - - Retourne la requête principale. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si indéfini. - - - - - - - diff --git a/reference/solr/solrquery/getrows.xml b/reference/solr/solrquery/getrows.xml deleted file mode 100644 index 53107c2724..0000000000 --- a/reference/solr/solrquery/getrows.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getRows - Retourne le nombre maximal de documents - - - - &reftitle.description; - - public intSolrQuery::getRows - - - - Retourne le nombre maximal de documents depuis le jeu complet de résultats - à retourner au client à chaque requête. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si indéfini. - - - - - - diff --git a/reference/solr/solrquery/getsortfields.xml b/reference/solr/solrquery/getsortfields.xml deleted file mode 100644 index 9d60e8d081..0000000000 --- a/reference/solr/solrquery/getsortfields.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getSortFields - Retourne tous les champs de tri - - - - &reftitle.description; - - public arraySolrQuery::getSortFields - - - - Retourne tous les champs de tri. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau en cas de succès, et &null; si aucun - paramètre n'est défini. - - - - - - diff --git a/reference/solr/solrquery/getstart.xml b/reference/solr/solrquery/getstart.xml deleted file mode 100644 index 94259fb99f..0000000000 --- a/reference/solr/solrquery/getstart.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrQuery::getStart - Retourne la position dans le jeu complet de résultats - - - - &reftitle.description; - - public intSolrQuery::getStart - - - - Retourne la position dans le jeu complet de résultats - de la requête à partir de laquelle on doit commencer à - retourner les documents. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si indéfini. - - - - - - diff --git a/reference/solr/solrquery/getstats.xml b/reference/solr/solrquery/getstats.xml deleted file mode 100644 index 44f40280b0..0000000000 --- a/reference/solr/solrquery/getstats.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrQuery::getStats - Vérifie si les statistiques sont actives ou non - - - - &reftitle.description; - - public boolSolrQuery::getStats - - - - Vérifie si les statistiques sont actives ou non. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès, et &null; si indéfini. - - - - - - diff --git a/reference/solr/solrquery/getstatsfacets.xml b/reference/solr/solrquery/getstatsfacets.xml deleted file mode 100644 index 03cccb38d2..0000000000 --- a/reference/solr/solrquery/getstatsfacets.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrQuery::getStatsFacets - Retourne toutes les statistiques définies - - - - &reftitle.description; - - public arraySolrQuery::getStatsFacets - - - - Retourne toutes les statistiques définies. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau en cas de succès, et &null; si aucune - n'est définie. - - - - - - diff --git a/reference/solr/solrquery/getstatsfields.xml b/reference/solr/solrquery/getstatsfields.xml deleted file mode 100644 index 32ee4ff08c..0000000000 --- a/reference/solr/solrquery/getstatsfields.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getStatsFields - Retourne les statistiques des champs - - - - &reftitle.description; - - public arraySolrQuery::getStatsFields - - - - Retourne les statistiques des champs. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau en cas de succès, et &null; si aucun - n'est défini. - - - - - - diff --git a/reference/solr/solrquery/getterms.xml b/reference/solr/solrquery/getterms.xml deleted file mode 100644 index f2a33d6467..0000000000 --- a/reference/solr/solrquery/getterms.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrQuery::getTerms - Vérifie si le TermsComponent est activé ou non - - - - &reftitle.description; - - public boolSolrQuery::getTerms - - - - Vérifie si le TermsComponent est activé ou non - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès, et &null; si indéfini. - - - - - - diff --git a/reference/solr/solrquery/gettermsfield.xml b/reference/solr/solrquery/gettermsfield.xml deleted file mode 100644 index 3f43a569c6..0000000000 --- a/reference/solr/solrquery/gettermsfield.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrQuery::getTermsField - Récupère le champ depuis lequel les termes sont récupérés - - - - &reftitle.description; - - public stringSolrQuery::getTermsField - - - - Récupère le champ depuis lequel les termes sont récupérés. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si aucun - champ n'est défini. - - - - - - diff --git a/reference/solr/solrquery/gettermsincludelowerbound.xml b/reference/solr/solrquery/gettermsincludelowerbound.xml deleted file mode 100644 index b0847a0573..0000000000 --- a/reference/solr/solrquery/gettermsincludelowerbound.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getTermsIncludeLowerBound - Vérifie si l'on doit inclure ou non la limite inférieure dans le jeu de résultats - - - - &reftitle.description; - - public boolSolrQuery::getTermsIncludeLowerBound - - - - Vérifie si l'on doit inclure ou non la limite - inférieure dans le jeu de résultats. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès, et &null; si aucun n'est défini. - - - - - - diff --git a/reference/solr/solrquery/gettermsincludeupperbound.xml b/reference/solr/solrquery/gettermsincludeupperbound.xml deleted file mode 100644 index e124128c7e..0000000000 --- a/reference/solr/solrquery/gettermsincludeupperbound.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrQuery::getTermsIncludeUpperBound - Vérifie si l'on doit inclure ou non la limite supérieure dans le jeu de résultats - - - - &reftitle.description; - - public boolSolrQuery::getTermsIncludeUpperBound - - - - Vérifie si l'on doit inclure ou non la limite - supérieure dans le jeu de résultats. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès et &null; si aucun - n'est défini. - - - - - - diff --git a/reference/solr/solrquery/gettermslimit.xml b/reference/solr/solrquery/gettermslimit.xml deleted file mode 100644 index 206d3aa157..0000000000 --- a/reference/solr/solrquery/gettermslimit.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getTermsLimit - Retourne le nombre maximal de termes que Solr peut retourner - - - - &reftitle.description; - - public intSolrQuery::getTermsLimit - - - - Retourne le nombre maximal de termes que Solr peut retourner. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucun - nombre n'est défini. - - - - - - diff --git a/reference/solr/solrquery/gettermslowerbound.xml b/reference/solr/solrquery/gettermslowerbound.xml deleted file mode 100644 index 78dafb5d2a..0000000000 --- a/reference/solr/solrquery/gettermslowerbound.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getTermsLowerBound - Retourne le terme sur lequel on doit commencer - - - - &reftitle.description; - - public stringSolrQuery::getTermsLowerBound - - - - Retourne le terme sur lequel on doit commencer. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si aucun - terme n'est défini. - - - - - - diff --git a/reference/solr/solrquery/gettermsmaxcount.xml b/reference/solr/solrquery/gettermsmaxcount.xml deleted file mode 100644 index aa4495f393..0000000000 --- a/reference/solr/solrquery/gettermsmaxcount.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getTermsMaxCount - Retourne la fréquence maximale des documents - - - - &reftitle.description; - - public intSolrQuery::getTermsMaxCount - - - - Retourne la fréquence maximale des documents. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucune - fréquence n'est retournée. - - - - - - diff --git a/reference/solr/solrquery/gettermsmincount.xml b/reference/solr/solrquery/gettermsmincount.xml deleted file mode 100644 index 512228dfda..0000000000 --- a/reference/solr/solrquery/gettermsmincount.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrQuery::getTermsMinCount - Retourne la fréquence minimale des documents - - - - &reftitle.description; - - public intSolrQuery::getTermsMinCount - - - - Retourne la fréquence minimale des documents à retourner aux fins - d'inclusion. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucune - fréquence n'est définie. - - - - - - diff --git a/reference/solr/solrquery/gettermsprefix.xml b/reference/solr/solrquery/gettermsprefix.xml deleted file mode 100644 index bb93ffa21b..0000000000 --- a/reference/solr/solrquery/gettermsprefix.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - SolrQuery::getTermsPrefix - Retourne le préfixe du terme - - - - &reftitle.description; - - public stringSolrQuery::getTermsPrefix - - - - Retourne le préfixe utilisé pour restreindre les termes. - Ainsi, seuls les termes qui commencent par ce préfixe correspondront - à la recherche. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; - si aucun n'est défini. - - - - - - diff --git a/reference/solr/solrquery/gettermsreturnraw.xml b/reference/solr/solrquery/gettermsreturnraw.xml deleted file mode 100644 index 851d4a2e10..0000000000 --- a/reference/solr/solrquery/gettermsreturnraw.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - SolrQuery::getTermsReturnRaw - Si l'on doit retourner ou non les caractères bruts - - - - &reftitle.description; - - public boolSolrQuery::getTermsReturnRaw - - - - Retourne un booléen indiquant si l'on doit retourner - ou non les caractères bruts des termes indexés, suivant s'ils - sont humainement lisibles. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen en cas de succès et &null; si aucun - n'est défini. - - - - - - diff --git a/reference/solr/solrquery/gettermssort.xml b/reference/solr/solrquery/gettermssort.xml deleted file mode 100644 index 0175ea2d8a..0000000000 --- a/reference/solr/solrquery/gettermssort.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - SolrQuery::getTermsSort - Retourne un entier indiquant comment les termes sont triés - - - - &reftitle.description; - - public intSolrQuery::getTermsSort - - - - 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 triés par la fréquence des termes (le plus grand nombre en premier). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucun n'est - défini. - - - - - - diff --git a/reference/solr/solrquery/gettermsupperbound.xml b/reference/solr/solrquery/gettermsupperbound.xml deleted file mode 100644 index 94bb363fb5..0000000000 --- a/reference/solr/solrquery/gettermsupperbound.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrQuery::getTermsUpperBound - Retourne le terme sur lequel on doit s'arrêter - - - - &reftitle.description; - - public stringSolrQuery::getTermsUpperBound - - - - Retourne le terme sur lequel on doit s'arrêter. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, et &null; si aucun - n'est défini. - - - - - - diff --git a/reference/solr/solrquery/gettimeallowed.xml b/reference/solr/solrquery/gettimeallowed.xml deleted file mode 100644 index 3dc074ba2c..0000000000 --- a/reference/solr/solrquery/gettimeallowed.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - SolrQuery::getTimeAllowed - Retourne le délai d'exécution autorisé pour une requête - - - - &reftitle.description; - - public intSolrQuery::getTimeAllowed - - - - Retourne le délai d'exécution, en millisecondes, autorisé pour une requête. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier en cas de succès, et &null; si aucun - délai n'est défini. - - - - - - diff --git a/reference/solr/solrquery/removeexpandfilterquery.xml b/reference/solr/solrquery/removeexpandfilterquery.xml deleted file mode 100644 index b8e9a73246..0000000000 --- a/reference/solr/solrquery/removeexpandfilterquery.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::removeExpandFilterQuery - Supprime une requête de filtre d'extension - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeExpandFilterQuery - stringfq - - - Supprime une requête de filtre d'extension. - - - - - - &reftitle.parameters; - - - fq - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/removeexpandsortfield.xml b/reference/solr/solrquery/removeexpandsortfield.xml deleted file mode 100644 index e170811520..0000000000 --- a/reference/solr/solrquery/removeexpandsortfield.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SolrQuery::removeExpandSortField - Supprime un champ de tri d'extension du paramètre expand.sort - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeExpandSortField - stringfield - - - Supprime un champ de tri d'extension du paramètre expand.sort. - - - - - &reftitle.parameters; - - - field - - - Le nom du champ - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/removefacetdatefield.xml b/reference/solr/solrquery/removefacetdatefield.xml deleted file mode 100644 index 73829f73b5..0000000000 --- a/reference/solr/solrquery/removefacetdatefield.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::removeFacetDateField - Supprime un champ date - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFacetDateField - stringfield - - - Supprime un champ date. - - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ à supprimer - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/removefacetdateother.xml b/reference/solr/solrquery/removefacetdateother.xml deleted file mode 100644 index 4b106932bb..0000000000 --- a/reference/solr/solrquery/removefacetdateother.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrQuery::removeFacetDateOther - Supprime un paramètre facet.date.other - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFacetDateOther - stringvalue - stringfield_override - - - Supprime un paramètre facet.date.other. - - - - - - &reftitle.parameters; - - - - value - - - La valeur - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/removefacetfield.xml b/reference/solr/solrquery/removefacetfield.xml deleted file mode 100644 index d7fe3f4925..0000000000 --- a/reference/solr/solrquery/removefacetfield.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::removeFacetField - Supprime un paramètre facet.date - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFacetField - stringfield - - - Supprime un paramètre facet.date. - - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/removefacetquery.xml b/reference/solr/solrquery/removefacetquery.xml deleted file mode 100644 index 450c60dc47..0000000000 --- a/reference/solr/solrquery/removefacetquery.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::removeFacetQuery - Supprime un paramètre facet.query - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFacetQuery - stringvalue - - - Supprime un paramètre facet.query. - - - - - - &reftitle.parameters; - - - - value - - - La valeur - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/removefield.xml b/reference/solr/solrquery/removefield.xml deleted file mode 100644 index 82870caea6..0000000000 --- a/reference/solr/solrquery/removefield.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::removeField - Efface un champ depuis la liste des champs - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeField - stringfield - - - Efface un champ depuis la liste des champs. - - - - - - &reftitle.parameters; - - - - field - - - Nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/removefilterquery.xml b/reference/solr/solrquery/removefilterquery.xml deleted file mode 100644 index d3ec9ede78..0000000000 --- a/reference/solr/solrquery/removefilterquery.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::removeFilterQuery - Supprime un filtre de requête - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFilterQuery - stringfq - - - Supprime un filtre de requête. - - - - - - &reftitle.parameters; - - - - fq - - - Le filtre de requête à supprimer - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/removehighlightfield.xml b/reference/solr/solrquery/removehighlightfield.xml deleted file mode 100644 index 1ec962c090..0000000000 --- a/reference/solr/solrquery/removehighlightfield.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::removeHighlightField - Supprime un des champs utilisés pour la mise en évidence - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeHighlightField - stringfield - - - Supprime un des champs utilisés pour la mise en évidence. - - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/removemltfield.xml b/reference/solr/solrquery/removemltfield.xml deleted file mode 100644 index 9808d57be1..0000000000 --- a/reference/solr/solrquery/removemltfield.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::removeMltField - Supprime un des champs moreLikeThis - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeMltField - stringfield - - - Supprime un des champs moreLikeThis. - - - - - - &reftitle.parameters; - - - - field - - - Nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/removemltqueryfield.xml b/reference/solr/solrquery/removemltqueryfield.xml deleted file mode 100644 index 027aedc0a3..0000000000 --- a/reference/solr/solrquery/removemltqueryfield.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::removeMltQueryField - Supprime un des champs moreLikeThis de la requête - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeMltQueryField - stringqueryField - - - Supprime un des champs moreLikeThis de la requête. - - - - - - &reftitle.parameters; - - - - queryField - - - Le champ de la requête - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/removesortfield.xml b/reference/solr/solrquery/removesortfield.xml deleted file mode 100644 index 5150bae098..0000000000 --- a/reference/solr/solrquery/removesortfield.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::removeSortField - Supprime un champ de tri - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeSortField - stringfield - - - Supprime un champ de tri - - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/removestatsfacet.xml b/reference/solr/solrquery/removestatsfacet.xml deleted file mode 100644 index 80ffbc05bf..0000000000 --- a/reference/solr/solrquery/removestatsfacet.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::removeStatsFacet - Supprime un paramètre stats.facet - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeStatsFacet - stringvalue - - - Supprime un paramètre stats.facet. - - - - - - &reftitle.parameters; - - - - value - - - La valeur - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/removestatsfield.xml b/reference/solr/solrquery/removestatsfield.xml deleted file mode 100644 index 844e1f94fa..0000000000 --- a/reference/solr/solrquery/removestatsfield.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::removeStatsField - Supprime un paramètre stats.field - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeStatsField - stringfield - - - Supprime un paramètre stats.field. - - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setechohandler.xml b/reference/solr/solrquery/setechohandler.xml deleted file mode 100644 index baa1ea5076..0000000000 --- a/reference/solr/solrquery/setechohandler.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::setEchoHandler - Bascule le paramètre echoHandler - - - - &reftitle.description; - - public SolrQuerySolrQuery::setEchoHandler - boolflag - - - Si défini à &true;, Solr placera le nom du gestionnaire utilisé - dans la réponse au client à des fins de débogage. - - - - - &reftitle.parameters; - - - - flag - - - &true; ou &false; - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setechoparams.xml b/reference/solr/solrquery/setechoparams.xml deleted file mode 100644 index 703e863519..0000000000 --- a/reference/solr/solrquery/setechoparams.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - SolrQuery::setEchoParams - Détermine les paramètres à inclure dans la réponse - - - - &reftitle.description; - - public SolrQuerySolrQuery::setEchoParams - stringtype - - - Indique à Solr les paramètres à inclure dans la réponse - aux fins de déboguage : - - - - - - - - - - - &reftitle.parameters; - - - - type - - - Le type de paramètres à inclure. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setexpand.xml b/reference/solr/solrquery/setexpand.xml deleted file mode 100644 index f34a1385a0..0000000000 --- a/reference/solr/solrquery/setexpand.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - SolrQuery::setExpand - Active/désactive le composant Expand - - - - &reftitle.description; - - public SolrQuerySolrQuery::setExpand - boolvalue - - - Active/désactive le composant Expand. - - - - - - &reftitle.parameters; - - - value - - - Un drapeau booléen - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - - &reftitle.examples; - - Exemple de <function>SolrQuery::setExpand</function> - -setExpand(true) - ->setExpandRows(50) - ->setExpandQuery('text:product') - ->addExpandFilterQuery('manu:apple') - ->addExpandFilterQuery('inStock:true') - ->addExpandSortField('score', SolrQuery::ORDER_DESC) - ->addExpandSortField('title', SolrQuery::ORDER_ASC); - -echo $query.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - - diff --git a/reference/solr/solrquery/setexpandquery.xml b/reference/solr/solrquery/setexpandquery.xml deleted file mode 100644 index a8b7cb6735..0000000000 --- a/reference/solr/solrquery/setexpandquery.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - SolrQuery::setExpandQuery - Définit le paramètre expand.q - - - - &reftitle.description; - - public SolrQuerySolrQuery::setExpandQuery - stringq - - - Définit le paramètre expand.q. - - - Surcharge le paramètre principal q, - détermine quels documents inclure dans le groupe principal. - - - - - &reftitle.parameters; - - - q - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/setexpandrows.xml b/reference/solr/solrquery/setexpandrows.xml deleted file mode 100644 index ac5ea8209f..0000000000 --- a/reference/solr/solrquery/setexpandrows.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SolrQuery::setExpandRows - Définit le nombre de lignes à afficher dans chaque groupe (expand.rows). Valeur par défaut du serveur 5 - - - - &reftitle.description; - - public SolrQuerySolrQuery::setExpandRows - intvalue - - - Définit le nombre de lignes à afficher dans chaque groupe (expand.rows). Valeur par défaut du serveur 5 - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/setexplainother.xml b/reference/solr/solrquery/setexplainother.xml deleted file mode 100644 index 856f754844..0000000000 --- a/reference/solr/solrquery/setexplainother.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setExplainOther - Définit le paramètre de requête explainOther - - - - &reftitle.description; - - public SolrQuerySolrQuery::setExplainOther - stringquery - - - Définit le paramètre de requête explainOther. - - - - - &reftitle.parameters; - - - - query - - - La requête Lucene identifiant un jeu de documents - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacet.xml b/reference/solr/solrquery/setfacet.xml deleted file mode 100644 index f4c5b39d27..0000000000 --- a/reference/solr/solrquery/setfacet.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::setFacet - Lie un paramètre facet. Active ou désactive les facettes - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacet - boolflag - - - Active ou désactive les facettes. - - - - - - &reftitle.parameters; - - - - value - - - &true; pour activer les facettes, &false; pour les désactiver. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacetdateend.xml b/reference/solr/solrquery/setfacetdateend.xml deleted file mode 100644 index ea96322b61..0000000000 --- a/reference/solr/solrquery/setfacetdateend.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrQuery::setFacetDateEnd - Lie un facet.date.end - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetDateEnd - stringvalue - stringfield_override - - - Lie un facet.date.end - - - - - - &reftitle.parameters; - - - - value - - - Voir facet.date.end - - - - - field_override - - - Le nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacetdategap.xml b/reference/solr/solrquery/setfacetdategap.xml deleted file mode 100644 index dd98672d90..0000000000 --- a/reference/solr/solrquery/setfacetdategap.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrQuery::setFacetDateGap - Lie un facet.date.gap - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetDateGap - stringvalue - stringfield_override - - - Lie un facet.date.gap - - - - - - &reftitle.parameters; - - - - value - - - Voir facet.date.gap - - - - - field_override - - - Le nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée - est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacetdatehardend.xml b/reference/solr/solrquery/setfacetdatehardend.xml deleted file mode 100644 index c2d2759a64..0000000000 --- a/reference/solr/solrquery/setfacetdatehardend.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrQuery::setFacetDateHardEnd - Lie un facet.date.hardend - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetDateHardEnd - boolvalue - stringfield_override - - - Lie un facet.date.hardend - - - - - - &reftitle.parameters; - - - - value - - - Voir facet.date.hardend - - - - - field_override - - - Le nom du champ - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacetdatestart.xml b/reference/solr/solrquery/setfacetdatestart.xml deleted file mode 100644 index 05612594e7..0000000000 --- a/reference/solr/solrquery/setfacetdatestart.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - SolrQuery::setFacetDateStart - Lie un facet.date.start - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetDateStart - stringvalue - stringfield_override - - - Lie un facet.date.start. - - - - - &reftitle.parameters; - - - - value - - - Voir facet.date.start - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacetenumcachemindefaultfrequency.xml b/reference/solr/solrquery/setfacetenumcachemindefaultfrequency.xml deleted file mode 100644 index 5c4758cadb..0000000000 --- a/reference/solr/solrquery/setfacetenumcachemindefaultfrequency.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrQuery::setFacetEnumCacheMinDefaultFrequency - Définit la fréquence minimale du document utilisée pour déterminer le comptage des termes - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetEnumCacheMinDefaultFrequency - intfrequency - stringfield_override - - - Définit la fréquence minimale du document utilisée pour déterminer - le comptage des termes. - - - - - &reftitle.parameters; - - - - value - - - La fréquence minimale. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacetlimit.xml b/reference/solr/solrquery/setfacetlimit.xml deleted file mode 100644 index fc609f591d..0000000000 --- a/reference/solr/solrquery/setfacetlimit.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - SolrQuery::setFacetLimit - Lie un facet.limit - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetLimit - intlimit - stringfield_override - - - Lie un facet.limit. Définit le nombre maximal de contraintes qui doit - être retourné pour les champs facet. - - - - - - &reftitle.parameters; - - - - limit - - - Le nombre maximal de contraintes. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacetmethod.xml b/reference/solr/solrquery/setfacetmethod.xml deleted file mode 100644 index 1e4cde762f..0000000000 --- a/reference/solr/solrquery/setfacetmethod.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrQuery::setFacetMethod - Spécifie le type d'algorithme à utiliser pour un champ facet - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetMethod - stringmethod - stringfield_override - - - Spécifie le type d'algorithme à utiliser pour un champ facet. - - - - - - &reftitle.parameters; - - - - method - - - La méthode à utiliser. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacetmincount.xml b/reference/solr/solrquery/setfacetmincount.xml deleted file mode 100644 index 36b2c843f4..0000000000 --- a/reference/solr/solrquery/setfacetmincount.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - SolrQuery::setFacetMinCount - Lie un facet.mincount - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetMinCount - intmincount - stringfield_override - - - Définit le nombre minimal pour les champs facet - qui doit être inclus dans la réponse. - - - - - - &reftitle.parameters; - - - - mincount - - - Le nombre minimal. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacetmissing.xml b/reference/solr/solrquery/setfacetmissing.xml deleted file mode 100644 index cdb36b1fd2..0000000000 --- a/reference/solr/solrquery/setfacetmissing.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - SolrQuery::setFacetMissing - Lie un facet.missing - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetMissing - boolflag - stringfield_override - - - 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é. - - - - - - &reftitle.parameters; - - - - flag - - - &true; pour activer cette fonctionnalité. - &false; pour la désactiver. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacetoffset.xml b/reference/solr/solrquery/setfacetoffset.xml deleted file mode 100644 index 025b92edb8..0000000000 --- a/reference/solr/solrquery/setfacetoffset.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - SolrQuery::setFacetOffset - Définit la position dans la liste des contraintes pour la pagination - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetOffset - intoffset - stringfield_override - - - Définit la position dans la liste des contraintes - pour la pagination. - - - - - - &reftitle.parameters; - - - - offset - - - La position. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacetprefix.xml b/reference/solr/solrquery/setfacetprefix.xml deleted file mode 100644 index 873d056a84..0000000000 --- a/reference/solr/solrquery/setfacetprefix.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrQuery::setFacetPrefix - Spécifie un préfixe utilisé pour limiter les termes - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetPrefix - stringprefix - stringfield_override - - - Spécifie un préfixe utilisé pour limiter les termes. - - - - - - &reftitle.parameters; - - - - prefix - - - Le préfixe. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setfacetsort.xml b/reference/solr/solrquery/setfacetsort.xml deleted file mode 100644 index a5761a6653..0000000000 --- a/reference/solr/solrquery/setfacetsort.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - SolrQuery::setFacetSort - Détermine le tri des facet - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetSort - intfacetSort - stringfield_override - - - Détermine le tri des facet. - - - - - - &reftitle.parameters; - - - - facetSort - - - Utiliser SolrQuery::FACET_SORT_INDEX pour trier sur l'index, - ou SolrQuery::FACET_SORT_COUNT pour trier sur le total. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur - retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setgroup.xml b/reference/solr/solrquery/setgroup.xml deleted file mode 100644 index 3cb5be4d38..0000000000 --- a/reference/solr/solrquery/setgroup.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - SolrQuery::setGroup - Active/désactive le regroupement des résultats (paramètre group) - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroup - boolvalue - - - Active/désactive le regroupement des résultats (paramètre group). - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - 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 - - - - - - diff --git a/reference/solr/solrquery/setgroupcachepercent.xml b/reference/solr/solrquery/setgroupcachepercent.xml deleted file mode 100644 index e04f50a4db..0000000000 --- a/reference/solr/solrquery/setgroupcachepercent.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - SolrQuery::setGroupCachePercent - Définit le pourcentage de cache pour le regroupement des résultats - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupCachePercent - intpercent - - - Définir ce paramètre sur un nombre supérieur à 0 active le cache pour le regroupement des résultats. - Le regroupement des résultats exécute deux recherches; cette option met en cache la deuxième recherche. La valeur par défaut du serveur est 0. - - Tester a montré que le cache de groupe n'améliore que le temps de recherche avec des requêtes booléennes, de caractère générique et floues. Pour des requêtes simples comme les requêtes de terme ou "match all", - le cache de groupe dégrade les performances. - Paramètre group.cache.percent - - - - - &reftitle.parameters; - - - percent - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.errors; - - Émet une SolrIllegalArgumentException si un paramètre invalide a été passé. - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - - - - - - diff --git a/reference/solr/solrquery/setgroupfacet.xml b/reference/solr/solrquery/setgroupfacet.xml deleted file mode 100644 index 9bd1c2ad14..0000000000 --- a/reference/solr/solrquery/setgroupfacet.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrQuery::setGroupFacet - Définit le paramètre group.facet - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupFacet - boolvalue - - - Détermine si les facettes groupées doivent être calculées pour les facettes de champ spécifiées dans les paramètres facet.field. - Les facettes groupées sont calculées en fonction du premier groupe spécifié. - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgroupformat.xml b/reference/solr/solrquery/setgroupformat.xml deleted file mode 100644 index ab6d864d50..0000000000 --- a/reference/solr/solrquery/setgroupformat.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - SolrQuery::setGroupFormat - Définit le format de groupe, la structure de résultat (paramètre group.format) - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupFormat - stringvalue - - - Définit le paramètre group.format. - Si ce paramètre est défini sur simple, les documents groupés sont présentés dans une seule liste plate, et les paramètres start et rows affectent le nombre de documents au lieu des groupes. - Accepte : grouped/simple - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgrouplimit.xml b/reference/solr/solrquery/setgrouplimit.xml deleted file mode 100644 index 792c912654..0000000000 --- a/reference/solr/solrquery/setgrouplimit.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - SolrQuery::setGroupLimit - Spécifie le nombre de résultats à retourner pour chaque groupe. Valeur par défaut du serveur 1 - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupLimit - intvalue - - - Spécifie le nombre de résultats à retourner pour chaque groupe. Valeur par défaut du serveur 1 - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgroupmain.xml b/reference/solr/solrquery/setgroupmain.xml deleted file mode 100644 index 24b4825c20..0000000000 --- a/reference/solr/solrquery/setgroupmain.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - SolrQuery::setGroupMain - Si vrai, le résultat de la première commande de regroupement de champ est utilisé comme liste de résultats principale dans la réponse, en utilisant group.format=simple - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupMain - stringvalue - - - Si &true;, le résultat de la première commande de regroupement de champ est utilisé comme liste de résultats principale dans la réponse, en utilisant group.format=simple. - - - - - - &reftitle.parameters; - - - value - - - Si &true; le résultat de la première commande de regroupement de champ est utilisé comme liste de résultats principale dans la réponse. - - - - - - - - &reftitle.returnvalues; - - Renvoie une instance de SolrQuery. - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgroupngroups.xml b/reference/solr/solrquery/setgroupngroups.xml deleted file mode 100644 index ec8185f18f..0000000000 --- a/reference/solr/solrquery/setgroupngroups.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrQuery::setGroupNGroups - Si vrai, Solr inclut le nombre de groupes qui ont correspondu à la requête dans les résultats - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupNGroups - boolvalue - - - Si vrai, Solr inclut le nombre de groupes qui ont correspondu à la requête dans les résultats. - - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgroupoffset.xml b/reference/solr/solrquery/setgroupoffset.xml deleted file mode 100644 index 40747683ca..0000000000 --- a/reference/solr/solrquery/setgroupoffset.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrQuery::setGroupOffset - Définit le paramètre group.offset - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupOffset - intvalue - - - Définit le paramètre group.offset. - - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgrouptruncate.xml b/reference/solr/solrquery/setgrouptruncate.xml deleted file mode 100644 index 6906047e59..0000000000 --- a/reference/solr/solrquery/setgrouptruncate.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - SolrQuery::setGroupTruncate - Si vrai, les comptes de facettes sont basés sur le document le plus pertinent de chaque groupe correspondant à la requête - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupTruncate - boolvalue - - - Si vrai, les comptes de facettes sont basés sur le document le plus pertinent de chaque groupe correspondant à la requête. - La valeur par défaut du serveur est false. - Paramètre group.truncate - - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/sethighlight.xml b/reference/solr/solrquery/sethighlight.xml deleted file mode 100644 index 26c779cd71..0000000000 --- a/reference/solr/solrquery/sethighlight.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - SolrQuery::setHighlight - Active ou désactive la coloration - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlight - boolflag - - - Le fait de définir à &true; active la coloration des extraits à générer dans - la réponse à la requête. - - - - Le fait de définir à &false; désactive la coloration. - - - - - &reftitle.parameters; - - - - flag - - - Active ou désactive la coloration - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightalternatefield.xml b/reference/solr/solrquery/sethighlightalternatefield.xml deleted file mode 100644 index ddb8cc9223..0000000000 --- a/reference/solr/solrquery/sethighlightalternatefield.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - SolrQuery::setHighlightAlternateField - Spécifie le champ de sauvegarde à utiliser - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightAlternateField - stringfield - stringfield_override - - - 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. - - - - - - &reftitle.parameters; - - - - field - - - Le nom du champ de sauvegarde - - - - - field_override - - - Le nom du champ qui sera écrasé par cette configuration. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightformatter.xml b/reference/solr/solrquery/sethighlightformatter.xml deleted file mode 100644 index 2d5e56b468..0000000000 --- a/reference/solr/solrquery/sethighlightformatter.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - SolrQuery::setHighlightFormatter - Spécifie un formateur pour la sortie colorisée - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightFormatter - stringformatter - stringfield_override - - - Spécifie un formateur pour la sortie colorisée. - - - - - &reftitle.parameters; - - - - formatter - - - Actuellement, la seule valeur est "simple". - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Renvoie une instance de SolrQuery. - - - - - diff --git a/reference/solr/solrquery/sethighlightfragmenter.xml b/reference/solr/solrquery/sethighlightfragmenter.xml deleted file mode 100644 index 4580aff4b0..0000000000 --- a/reference/solr/solrquery/sethighlightfragmenter.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - SolrQuery::setHighlightFragmenter - Définit un générateur d'extraits de texte pour le texte colorisé - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightFragmenter - stringfragmenter - stringfield_override - - - Définit un générateur d'extraits de texte pour le texte colorisé. - - - - - &reftitle.parameters; - - - - fragmenter - - - Le fragmenteur standard est gap. Une autre option est regex, qui tente de - créer des fragments qui correspondent à une certaine expression rationnelle. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightfragsize.xml b/reference/solr/solrquery/sethighlightfragsize.xml deleted file mode 100644 index 3542212ace..0000000000 --- a/reference/solr/solrquery/sethighlightfragsize.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - SolrQuery::setHighlightFragsize - La taille du fragment à considérer pour la coloration - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightFragsize - intsize - stringfield_override - - - Définit la taille, en caractères, du fragment à considérer pour la coloration. - "0" indique que la valeur du champ complet doit être utilisée (aucune fragmentation). - - - - - &reftitle.parameters; - - - - size - - - La taille, en caractères, du fragment à considérer pour la coloration. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlighthighlightmultiterm.xml b/reference/solr/solrquery/sethighlighthighlightmultiterm.xml deleted file mode 100644 index 3a4aaeb613..0000000000 --- a/reference/solr/solrquery/sethighlighthighlightmultiterm.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::setHighlightHighlightMultiTerm - Utilise SpanScorer pour coloriser les termes d'une phrase - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightHighlightMultiTerm - boolflag - - - Utilise SpanScorer pour coloriser les termes d'une phrase uniquement - lorsqu'ils apparaissent dans la phrase de requête du document. - - - - - &reftitle.parameters; - - - - flag - - - 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. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightmaxalternatefieldlength.xml b/reference/solr/solrquery/sethighlightmaxalternatefieldlength.xml deleted file mode 100644 index f88e670758..0000000000 --- a/reference/solr/solrquery/sethighlightmaxalternatefieldlength.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - SolrQuery::setHighlightMaxAlternateFieldLength - Définit le nombre maximal de caractères du champ à retourner - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightMaxAlternateFieldLength - intfieldLength - stringfield_override - - - Si SolrQuery::setHighlightAlternateField() passe la valeur &true;, 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. - - - - - &reftitle.parameters; - - - - fieldLength - - - La longueur du champ. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightmaxanalyzedchars.xml b/reference/solr/solrquery/sethighlightmaxanalyzedchars.xml deleted file mode 100644 index 687b62abc0..0000000000 --- a/reference/solr/solrquery/sethighlightmaxanalyzedchars.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setHighlightMaxAnalyzedChars - Spécifie le nombre de caractères dans un document pour y chercher des extraits correspondants - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightMaxAnalyzedChars - intvalue - - - Spécifie le nombre de caractères dans un document pour y chercher des extraits correspondants. - - - - - - &reftitle.parameters; - - - - value - - - Le nombre de caractères dans un document pour y chercher des extraits correspondants - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightmergecontiguous.xml b/reference/solr/solrquery/sethighlightmergecontiguous.xml deleted file mode 100644 index 7c473a5de2..0000000000 --- a/reference/solr/solrquery/sethighlightmergecontiguous.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - SolrQuery::setHighlightMergeContiguous - Si l'on doit rassembler les fragments proches dans un seul fragment - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightMergeContiguous - boolflag - stringfield_override - - - Si l'on doit rassembler les fragments proches dans un seul fragment. - - - - - - &reftitle.parameters; - - - - value - - - Si l'on doit rassembler les fragments proches dans un seul fragment. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightquery.xml b/reference/solr/solrquery/sethighlightquery.xml deleted file mode 100644 index db2e19e6c9..0000000000 --- a/reference/solr/solrquery/sethighlightquery.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - SolrQuery::setHighlightQuery - Une requête désignée pour la mise en évidence - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightQuery - stringq - - - Une requête à utiliser pour la mise en évidence, qui sera affectée au - paramètre Solr hl.q. - Ce paramètre permet de mettre en évidence des termes ou des champs différents de ceux utilisés pour récupérer les documents. - - - - Valeur par défaut lorsqu'elle n'est pas définie : la valeur du paramètre - q de la requête. - - - - Voir la section Highlighting - pour plus de détails sur le paramètre Solr hl.q. - - - - - &reftitle.parameters; - - - - q - - - La requête de mise en évidence. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant. - - - - - &reftitle.seealso; - - SolrQuery::getHighlightQuery - SolrQuery::setHighlightFields - SolrQuery::getHighlightFields - - - - - diff --git a/reference/solr/solrquery/sethighlightregexmaxanalyzedchars.xml b/reference/solr/solrquery/sethighlightregexmaxanalyzedchars.xml deleted file mode 100644 index bbeefeba9c..0000000000 --- a/reference/solr/solrquery/sethighlightregexmaxanalyzedchars.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::setHighlightRegexMaxAnalyzedChars - Spécifie le nombre maximal de caractères à analyser - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightRegexMaxAnalyzedChars - intmaxAnalyzedChars - - - Spécifie le nombre maximal de caractères à analyser dans un champ lors - de l'utilisation du formatteur regex. - - - - - - &reftitle.parameters; - - - - maxAnalyzedChars - - - Le nombre maximal de caractères à analyser dans un champ lors - de l'utilisation du formatteur regex. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightregexpattern.xml b/reference/solr/solrquery/sethighlightregexpattern.xml deleted file mode 100644 index cf65b7ad70..0000000000 --- a/reference/solr/solrquery/sethighlightregexpattern.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::setHighlightRegexPattern - Spécifie l'expression rationnelle pour la fragmentation - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightRegexPattern - stringvalue - - - Spécifie l'expression rationnelle pour la fragmentation. - Peut être utilisée pour extraire des phrases. - - - - - - &reftitle.parameters; - - - - value - - - L'expression rationnelle pour la fragmentation. Peut être utilisée pour - extraire des phrases. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightregexslop.xml b/reference/solr/solrquery/sethighlightregexslop.xml deleted file mode 100644 index 9552d1443a..0000000000 --- a/reference/solr/solrquery/sethighlightregexslop.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::setHighlightRegexSlop - Définit le facteur par lequel le fragmenteur regex peut dévier de la taille idéale du fragment - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightRegexSlop - floatfactor - - - 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. - - - - - - &reftitle.parameters; - - - - factor - - - Le facteur par lequel le fragmenteur regex peut dévier de la taille idéale du fragment. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightrequirefieldmatch.xml b/reference/solr/solrquery/sethighlightrequirefieldmatch.xml deleted file mode 100644 index b9db3e7465..0000000000 --- a/reference/solr/solrquery/sethighlightrequirefieldmatch.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - SolrQuery::setHighlightRequireFieldMatch - Champ correspondant requis lors de la colorisation - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightRequireFieldMatch - boolflag - - - Si &true;, 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 à &true;. - - - - - - &reftitle.parameters; - - - - flag - - - &true; ou &false; - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightsimplepost.xml b/reference/solr/solrquery/sethighlightsimplepost.xml deleted file mode 100644 index a2bee07109..0000000000 --- a/reference/solr/solrquery/sethighlightsimplepost.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrQuery::setHighlightSimplePost - Définit le texte qui doit apparaître après un terme colorisé - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightSimplePost - stringsimplePost - stringfield_override - - - Définit le texte qui doit apparaître après un terme colorisé. - - - - - - &reftitle.parameters; - - - - simplePost - - - Définit le texte qui doit apparaître après un terme colorisé. - - ]]> - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Renvoie une instance de SolrQuery. - - - - - - diff --git a/reference/solr/solrquery/sethighlightsimplepre.xml b/reference/solr/solrquery/sethighlightsimplepre.xml deleted file mode 100644 index de5111648e..0000000000 --- a/reference/solr/solrquery/sethighlightsimplepre.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - SolrQuery::setHighlightSimplePre - Définit le texte qui doit apparaître avant un terme colorisé - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightSimplePre - stringsimplePre - stringfield_override - - - Définit le texte qui doit apparaître avant un terme colorisé. - - ]]> - - - - &reftitle.parameters; - - - - simplePre - - - Le texte qui doit apparaître avant un terme colorisé - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightsnippets.xml b/reference/solr/solrquery/sethighlightsnippets.xml deleted file mode 100644 index dbdbb78875..0000000000 --- a/reference/solr/solrquery/sethighlightsnippets.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - SolrQuery::setHighlightSnippets - Définit le nombre maximal d'extraits à coloriser par champ - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightSnippets - intvalue - stringfield_override - - - Définit le nombre maximal d'extraits à coloriser par champ. - - - - - - &reftitle.parameters; - - - - value - - - Le nombre maximal d'extraits à coloriser par champ. - - - - - field_override - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/sethighlightusephrasehighlighter.xml b/reference/solr/solrquery/sethighlightusephrasehighlighter.xml deleted file mode 100644 index 0f1a01aff1..0000000000 --- a/reference/solr/solrquery/sethighlightusephrasehighlighter.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::setHighlightUsePhraseHighlighter - Si l'on doit coloriser les termes d'une phrase uniquement s'ils apparaissent dans la requête - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightUsePhraseHighlighter - boolflag - - - Si l'on doit utiliser SpanScorer pour coloriser les termes d'une phrase - uniquement s'ils apparaissent dans la requête du document. - - - - - - &reftitle.parameters; - - - - value - - - Si l'on doit utiliser SpanScorer pour coloriser les termes d'une phrase - uniquement s'ils apparaissent dans la requête du document. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setmlt.xml b/reference/solr/solrquery/setmlt.xml deleted file mode 100644 index 32f245c04e..0000000000 --- a/reference/solr/solrquery/setmlt.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setMlt - Active ou désactive moreLikeThis - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMlt - boolflag - - - Active ou désactive moreLikeThis - - - - - - &reftitle.parameters; - - - - flag - - - &true; pour l'activer, &false; pour le désactiver. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setmltboost.xml b/reference/solr/solrquery/setmltboost.xml deleted file mode 100644 index 1cf1feb683..0000000000 --- a/reference/solr/solrquery/setmltboost.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setMltBoost - Si la requête doit être stimulée par la pertinence des termes - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltBoost - boolflag - - - Si la requête doit être stimulée par la pertinence des termes. - - - - - - &reftitle.parameters; - - - - value - - - À définir à &true; ou à &false;. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setmltcount.xml b/reference/solr/solrquery/setmltcount.xml deleted file mode 100644 index cf7a6e3d77..0000000000 --- a/reference/solr/solrquery/setmltcount.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setMltCount - Définit le nombre de documents similaires à retourner à chaque résultat - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltCount - intcount - - - Définit le nombre de documents similaires à retourner à chaque résultat. - - - - - - &reftitle.parameters; - - - - count - - - Le nombre de documents similaires à retourner à chaque résultat - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setmltmaxnumqueryterms.xml b/reference/solr/solrquery/setmltmaxnumqueryterms.xml deleted file mode 100644 index 95b5dfc71a..0000000000 --- a/reference/solr/solrquery/setmltmaxnumqueryterms.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setMltMaxNumQueryTerms - Définit le nombre maximal de termes de requête à inclure - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMaxNumQueryTerms - intvalue - - - Définit le nombre maximal de termes de requête à inclure dans chaque requête générée. - - - - - - &reftitle.parameters; - - - - value - - - Le nombre maximal de termes de requête à inclure dans chaque requête générée. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setmltmaxnumtokens.xml b/reference/solr/solrquery/setmltmaxnumtokens.xml deleted file mode 100644 index da6751b638..0000000000 --- a/reference/solr/solrquery/setmltmaxnumtokens.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setMltMaxNumTokens - Spécifie le nombre maximal de motifs à analyser - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMaxNumTokens - intvalue - - - Spécifie le nombre maximal de motifs à analyser dans chaque champ d'exemple du document - qui n'est pas stocké avec le support TermVector. - - - - - &reftitle.parameters; - - - - value - - - Le nombre maximal de motifs à analyser. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setmltmaxwordlength.xml b/reference/solr/solrquery/setmltmaxwordlength.xml deleted file mode 100644 index e66713a73f..0000000000 --- a/reference/solr/solrquery/setmltmaxwordlength.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::setMltMaxWordLength - Définit la longueur maximale d'un mot - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMaxWordLength - intmaxWordLength - - - Définit la longueur maximale d'un mot en dessus duquel les mots - seront ignorés. - - - - - - &reftitle.parameters; - - - - maxWordLength - - - La longueur maximale d'un mot en dessus duquel les mots - seront ignorés - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setmltmindocfrequency.xml b/reference/solr/solrquery/setmltmindocfrequency.xml deleted file mode 100644 index bdc69ea3ff..0000000000 --- a/reference/solr/solrquery/setmltmindocfrequency.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setMltMinDocFrequency - Définit la fréquence mltMinDoc - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMinDocFrequency - intminDocFrequency - - - Définit la fréquence à partir de laquelle les mots seront ignorés s'ils n'apparaissent pas dans les documents. - - - - - - &reftitle.parameters; - - - - minDocFrequency - - - La fréquence à partir de laquelle les mots seront ignorés s'ils n'apparaissent pas dans les documents - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setmltmintermfrequency.xml b/reference/solr/solrquery/setmltmintermfrequency.xml deleted file mode 100644 index bc091f7bca..0000000000 --- a/reference/solr/solrquery/setmltmintermfrequency.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setMltMinTermFrequency - Définit la fréquence en dessous de laquelle les termes seront ignorés dans le document source - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMinTermFrequency - intminTermFrequency - - - Définit la fréquence en dessous de laquelle les termes seront ignorés dans le document source. - - - - - - &reftitle.parameters; - - - - minTermFrequency - - - La fréquence en dessous de laquelle les termes seront ignorés dans le document source - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setmltminwordlength.xml b/reference/solr/solrquery/setmltminwordlength.xml deleted file mode 100644 index 8053a33e1c..0000000000 --- a/reference/solr/solrquery/setmltminwordlength.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setMltMinWordLength - Définit la longueur minimale d'un mot - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMinWordLength - intminWordLength - - - Définit la longueur minimale d'un mot en dessous de laquelle il sera ignoré. - - - - - - &reftitle.parameters; - - - - minWordLength - - - La longueur minimale d'un mot en dessous de laquelle il sera ignoré. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setomitheader.xml b/reference/solr/solrquery/setomitheader.xml deleted file mode 100644 index 97082dc79f..0000000000 --- a/reference/solr/solrquery/setomitheader.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setOmitHeader - Exclut l'en-tête des résultats retournés - - - - &reftitle.description; - - public SolrQuerySolrQuery::setOmitHeader - boolflag - - - Exclut l'en-tête des résultats retournés. - - - - - - &reftitle.parameters; - - - - flag - - - &true; pour exclure l'en-tête des résultats. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setquery.xml b/reference/solr/solrquery/setquery.xml deleted file mode 100644 index e690a1c0a3..0000000000 --- a/reference/solr/solrquery/setquery.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setQuery - Définit la requête de recherche - - - - &reftitle.description; - - public SolrQuerySolrQuery::setQuery - stringquery - - - Définit la requête de recherche. - - - - - - &reftitle.parameters; - - - - query - - - La requête de recherche - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant. - - - - - - diff --git a/reference/solr/solrquery/setrows.xml b/reference/solr/solrquery/setrows.xml deleted file mode 100644 index cb2a27a8c3..0000000000 --- a/reference/solr/solrquery/setrows.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setRows - Spécifie le nombre maximal de lignes à retourner dans le résultat - - - - &reftitle.description; - - public SolrQuerySolrQuery::setRows - introws - - - Spécifie le nombre maximal de lignes à retourner dans le résultat. - - - - - - &reftitle.parameters; - - - - rows - - - Le nombre maximal de lignes à retourner. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant. - - - - - - diff --git a/reference/solr/solrquery/setshowdebuginfo.xml b/reference/solr/solrquery/setshowdebuginfo.xml deleted file mode 100644 index a38d5eba85..0000000000 --- a/reference/solr/solrquery/setshowdebuginfo.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::setShowDebugInfo - Drapeau pour afficher les informations de débogage - - - - &reftitle.description; - - public SolrQuerySolrQuery::setShowDebugInfo - boolflag - - - Drapeau pour afficher les informations de débogage. - - - - - - &reftitle.parameters; - - - - flag - - - Si l'on doit ou non afficher les informations de débogage. - &true; ou &false;. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setstart.xml b/reference/solr/solrquery/setstart.xml deleted file mode 100644 index c1272a5469..0000000000 --- a/reference/solr/solrquery/setstart.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setStart - Spécifie le nombre maximal de lignes à ignorer - - - - &reftitle.description; - - public SolrQuerySolrQuery::setStart - intstart - - - Spécifie le nombre maximal de lignes à ignorer. Utile pour paginer les résultats. - - - - - - &reftitle.parameters; - - - - start - - - Le nombre de lignes à ignorer. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant. - - - - - - diff --git a/reference/solr/solrquery/setstats.xml b/reference/solr/solrquery/setstats.xml deleted file mode 100644 index 5c95c0f830..0000000000 --- a/reference/solr/solrquery/setstats.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setStats - Active ou désactive le composant statistique - - - - &reftitle.description; - - public SolrQuerySolrQuery::setStats - boolflag - - - Active ou désactive le composant statistique. - - - - - - &reftitle.parameters; - - - - flag - - - &true; pour activer le composant statistique, &false; pour le désactiver. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/setterms.xml b/reference/solr/solrquery/setterms.xml deleted file mode 100644 index 30d604c8d2..0000000000 --- a/reference/solr/solrquery/setterms.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setTerms - Active ou désactive le TermsComponent - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTerms - boolflag - - - Active ou désactive le TermsComponent. - - - - - - &reftitle.parameters; - - - - flag - - - &true; pour l'activer, &false; pour le désactiver. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/settermsfield.xml b/reference/solr/solrquery/settermsfield.xml deleted file mode 100644 index d6ba119f48..0000000000 --- a/reference/solr/solrquery/settermsfield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrQuery::setTermsField - Définit le nom du champ dans lequel les termes seront récupérés - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsField - stringfieldname - - - Définit le nom du champ dans lequel les termes seront récupérés. - - - - - &reftitle.parameters; - - - - fieldname - - - Le nom du champ. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/settermsincludelowerbound.xml b/reference/solr/solrquery/settermsincludelowerbound.xml deleted file mode 100644 index e1ccccce34..0000000000 --- a/reference/solr/solrquery/settermsincludelowerbound.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setTermsIncludeLowerBound - Inclut le terme inférieur lié dans le jeu de résultat - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsIncludeLowerBound - boolflag - - - Inclut le terme inférieur lié dans le jeu de résultat. - - - - - - &reftitle.parameters; - - - - flag - - - Inclut le terme inférieur lié dans le jeu de résultat. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/settermsincludeupperbound.xml b/reference/solr/solrquery/settermsincludeupperbound.xml deleted file mode 100644 index cbade47bc4..0000000000 --- a/reference/solr/solrquery/settermsincludeupperbound.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setTermsIncludeUpperBound - Inclut le terme supérieur lié dans le jeu de résultat - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsIncludeUpperBound - boolflag - - - Inclut le terme supérieur lié dans le jeu de résultat. - - - - - - &reftitle.parameters; - - - - flag - - - &true; ou &false; - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/settermslimit.xml b/reference/solr/solrquery/settermslimit.xml deleted file mode 100644 index 2e175d9e96..0000000000 --- a/reference/solr/solrquery/settermslimit.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::setTermsLimit - Définit le nombre maximal de termes à retourner - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsLimit - intlimit - - - Définit le nombre maximal de termes à retourner. - - - - - - &reftitle.parameters; - - - - limit - - - Le nombre maximal de termes à retourner. Tous les termes seront - retournés si la limite est négative. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/settermslowerbound.xml b/reference/solr/solrquery/settermslowerbound.xml deleted file mode 100644 index 7b984c7f28..0000000000 --- a/reference/solr/solrquery/settermslowerbound.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setTermsLowerBound - Spécifie le terme de départ - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsLowerBound - stringlowerBound - - - Spécifie le terme de départ. - - - - - - &reftitle.parameters; - - - - lowerBound - - - Le terme - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/settermsmaxcount.xml b/reference/solr/solrquery/settermsmaxcount.xml deleted file mode 100644 index 22f1dfcb55..0000000000 --- a/reference/solr/solrquery/settermsmaxcount.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrQuery::setTermsMaxCount - Définit la fréquence maximale du document - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsMaxCount - intfrequency - - - Définit la fréquence maximale du document. - - - - - &reftitle.parameters; - - - - frequency - - - La fréquence maximale du document. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/settermsmincount.xml b/reference/solr/solrquery/settermsmincount.xml deleted file mode 100644 index 3ab0b020c9..0000000000 --- a/reference/solr/solrquery/settermsmincount.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setTermsMinCount - Définit la fréquence minimale d'un document - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsMinCount - intfrequency - - - Définit la fréquence minimale d'un document. - - - - - - &reftitle.parameters; - - - - frequency - - - La fréquence minimale. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/settermsprefix.xml b/reference/solr/solrquery/settermsprefix.xml deleted file mode 100644 index 9999abcf0c..0000000000 --- a/reference/solr/solrquery/settermsprefix.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setTermsPrefix - Restreint les termes correspondants qui commencent avec un préfixe donné - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsPrefix - stringprefix - - - Restreint les termes correspondants qui commencent avec un préfixe donné. - - - - - - &reftitle.parameters; - - - - prefix - - - Le préfixe. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/settermsreturnraw.xml b/reference/solr/solrquery/settermsreturnraw.xml deleted file mode 100644 index 97a8781a69..0000000000 --- a/reference/solr/solrquery/settermsreturnraw.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::setTermsReturnRaw - Retourne les caractères bruts d'un terme indexé - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsReturnRaw - boolflag - - - Si vaut &true;, retourne les caractères bruts d'un terme - indexé, qu'ils soient lisibles ou non par un humain. - - - - - - &reftitle.parameters; - - - - value - - - &true; ou &false; - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/settermssort.xml b/reference/solr/solrquery/settermssort.xml deleted file mode 100644 index 4fe3024bc5..0000000000 --- a/reference/solr/solrquery/settermssort.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrQuery::setTermsSort - Spécifie la façon dont seront triés les termes retournés - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsSort - intsortType - - - Si SolrQuery::TERMS_SORT_COUNT, les termes seront triés par leur fréquence - (ceux dont la fréquence est la plus élevée en premier). - Si SolrQuery::TERMS_SORT_INDEX, retourne les termes suivant leur index. - - - - - - &reftitle.parameters; - - - - sortType - - - SolrQuery::TERMS_SORT_INDEX ou SolrQuery::TERMS_SORT_COUNT - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/settermsupperbound.xml b/reference/solr/solrquery/settermsupperbound.xml deleted file mode 100644 index a5cbd4e95d..0000000000 --- a/reference/solr/solrquery/settermsupperbound.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setTermsUpperBound - Définit le terme à partir duquel on doit stopper - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsUpperBound - stringupperBound - - - Définit le terme à partir duquel on doit stopper. - - - - - - &reftitle.parameters; - - - - upperBound - - - Le terme. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrquery/settimeallowed.xml b/reference/solr/solrquery/settimeallowed.xml deleted file mode 100644 index fe04afce95..0000000000 --- a/reference/solr/solrquery/settimeallowed.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - SolrQuery::setTimeAllowed - Le temps alloué pour faire une recherche - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTimeAllowed - inttimeAllowed - - - Le temps alloué pour faire une recherche. Cette valeur ne s'applique - qu'aux recherches et non aux requêtes en général. Le temps est en millisecondes. - Les valeurs inférieures ou égales à zéro impliquent aucune restriction de temps. - Les résultats partiels peuvent être retournés, s'il y en a. - - - - - - &reftitle.parameters; - - - - timeAllowed - - - Le temps alloué pour faire une recherche. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée. - - - - - - diff --git a/reference/solr/solrqueryresponse.xml b/reference/solr/solrqueryresponse.xml deleted file mode 100644 index db88c48f69..0000000000 --- a/reference/solr/solrqueryresponse.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - La classe SolrQueryResponse - SolrQueryResponse - - - - -
    - &reftitle.intro; - - Représente une réponse à une requête. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrQueryResponse - - - - - final - SolrQueryResponse - - - - extends - SolrResponse - - - - &Constants; - - const - int - SolrQueryResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrQueryResponse::PARSE_SOLR_DOC - 1 - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.constants; -
    - Constantes de la classe SolrQueryResponse - - - - SolrQueryResponse::PARSE_SOLR_OBJ - - Les documents doivent être analysés comme des instances SolrObject. - - - - - SolrQueryResponse::PARSE_SOLR_DOC - - Les documents doivent être analysés comme des instances SolrDocument. - - - - -
    -
    - - - -     - - &reference.solr.entities.solrqueryresponse; - -     - diff --git a/reference/solr/solrqueryresponse/construct.xml b/reference/solr/solrqueryresponse/construct.xml deleted file mode 100644 index 6caa243b36..0000000000 --- a/reference/solr/solrqueryresponse/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrQueryResponse::__construct - Constructeur - - - - &reftitle.description; - - public SolrQueryResponse::__construct - - - - Constructeur - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Rien - - - - - - diff --git a/reference/solr/solrqueryresponse/destruct.xml b/reference/solr/solrqueryresponse/destruct.xml deleted file mode 100644 index 460ab0cf4c..0000000000 --- a/reference/solr/solrqueryresponse/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQueryResponse::__destruct - Destructeur - - - - &reftitle.description; - - public SolrQueryResponse::__destruct - - - - Destructeur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Rien - - - - - - diff --git a/reference/solr/solrresponse.xml b/reference/solr/solrresponse.xml deleted file mode 100644 index 3c3f09901d..0000000000 --- a/reference/solr/solrresponse.xml +++ /dev/null @@ -1,233 +0,0 @@ - - - - - - - - La classe SolrResponse - SolrResponse - - - - -
    - &reftitle.intro; - - Représente une réponse du serveur Solr. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrResponse - - - - - abstract - SolrResponse - - - - &Constants; - - const - int - SolrResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrResponse::PARSE_SOLR_DOC - 1 - - - &Properties; - - protected - int - http_status - - - protected - int - parser_mode - - - protected - bool - success - - - protected - string - http_status_message - - - protected - string - http_request_url - - - protected - string - http_raw_request_headers - - - protected - string - http_raw_request - - - protected - string - http_raw_response_headers - - - protected - string - http_raw_response - - - protected - string - http_digested_response - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - http_status - - Le statut http de la réponse. - - - - parser_mode - - Méthode d'analyse des documents Solr : instances SolrObject ou SolrDocument. - - - - success - - Si une erreur est survenue ou non durant la requête. - - - - http_status_message - - Message détaillé du statut http. - - - - http_request_url - - L'URL de la requête. - - - - http_raw_request_headers - - Une chaîne d'en-têtes bruts envoyée lors de la requête. - - - - http_raw_request - - La requête brute à envoyer au serveur. - - - - http_raw_response_headers - - Les en-têtes de réponse reçus du serveur Solr. - - - - http_raw_response - - Le message de réponse reçu par le serveur Solr. - - - - http_digested_response - - La réponse au format sérialisé PHP. - - - -
    - - - - -
    - &reftitle.constants; -
    - Constantes de la classe SolrResponse - - - - SolrResponse::PARSE_SOLR_OBJ - - Les documents doivent être analysés comme des instances SolrObject. - - - - - SolrResponse::PARSE_SOLR_DOC - - Les documents doivent être analysés comme des instances SolrDocument. - - - - -
    -
    - - - -     - - &reference.solr.entities.solrresponse; - -     - - diff --git a/reference/solr/solrresponse/getdigestedresponse.xml b/reference/solr/solrresponse/getdigestedresponse.xml deleted file mode 100644 index d26f631616..0000000000 --- a/reference/solr/solrresponse/getdigestedresponse.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrResponse::getDigestedResponse - Récupère la réponse XML sous la forme de données PHP sérialisées - - - - &reftitle.description; - - public stringSolrResponse::getDigestedResponse - - - - Récupère la réponse XML sous la forme de données PHP sérialisées. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la réponse XML sous la forme de données PHP sérialisées. - - - - - - diff --git a/reference/solr/solrresponse/gethttpstatus.xml b/reference/solr/solrresponse/gethttpstatus.xml deleted file mode 100644 index 927da5c0dc..0000000000 --- a/reference/solr/solrresponse/gethttpstatus.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrResponse::getHttpStatus - Récupère le statut HTTP de la réponse - - - - &reftitle.description; - - public intSolrResponse::getHttpStatus - - - - Récupère le statut HTTP de la réponse. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le statut HTTP de la réponse. - - - - - - diff --git a/reference/solr/solrresponse/gethttpstatusmessage.xml b/reference/solr/solrresponse/gethttpstatusmessage.xml deleted file mode 100644 index 7f561ba2b7..0000000000 --- a/reference/solr/solrresponse/gethttpstatusmessage.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrResponse::getHttpStatusMessage - Récupère plus de détails sur le statut HTTP - - - - &reftitle.description; - - public stringSolrResponse::getHttpStatusMessage - - - - Récupère plus de détails sur le statut HTTP. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne plus de détails sur le statut HTTP. - - - - - - diff --git a/reference/solr/solrresponse/getrawrequest.xml b/reference/solr/solrresponse/getrawrequest.xml deleted file mode 100644 index 3623aa2e01..0000000000 --- a/reference/solr/solrresponse/getrawrequest.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrResponse::getRawRequest - Récupère la requête brute envoyée au serveur Solr - - - - &reftitle.description; - - public stringSolrResponse::getRawRequest - - - - Récupère la requête brute envoyée au serveur Solr. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la requête brute envoyée au serveur Solr. - - - - - - diff --git a/reference/solr/solrresponse/getrawrequestheaders.xml b/reference/solr/solrresponse/getrawrequestheaders.xml deleted file mode 100644 index fc1aad9770..0000000000 --- a/reference/solr/solrresponse/getrawrequestheaders.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrResponse::getRawRequestHeaders - Récupère les en-têtes bruts de la requête envoyée au serveur Solr - - - - &reftitle.description; - - public stringSolrResponse::getRawRequestHeaders - - - - Récupère les en-têtes bruts de la requête envoyée au serveur Solr. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les en-têtes bruts de la requête envoyée au serveur Solr. - - - - - - diff --git a/reference/solr/solrresponse/getrawresponse.xml b/reference/solr/solrresponse/getrawresponse.xml deleted file mode 100644 index 5ba956e65a..0000000000 --- a/reference/solr/solrresponse/getrawresponse.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrResponse::getRawResponse - Récupère la réponse brute du serveur - - - - &reftitle.description; - - public stringSolrResponse::getRawResponse - - - - Récupère la réponse brute du serveur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la réponse brute du serveur. - - - - - - diff --git a/reference/solr/solrresponse/getrawresponseheaders.xml b/reference/solr/solrresponse/getrawresponseheaders.xml deleted file mode 100644 index d35a134698..0000000000 --- a/reference/solr/solrresponse/getrawresponseheaders.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrResponse::getRawResponseHeaders - Récupère les en-têtes bruts de la réponse du serveur - - - - &reftitle.description; - - public stringSolrResponse::getRawResponseHeaders - - - - Récupère les en-têtes bruts de la réponse du serveur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne les en-têtes bruts de la réponse du serveur. - - - - - - diff --git a/reference/solr/solrresponse/getrequesturl.xml b/reference/solr/solrresponse/getrequesturl.xml deleted file mode 100644 index 123f530154..0000000000 --- a/reference/solr/solrresponse/getrequesturl.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrResponse::getRequestUrl - Récupère l'URL complète de la requête émise au serveur - - - - &reftitle.description; - - public stringSolrResponse::getRequestUrl - - - - Récupère l'URL complète de la requête émise au serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'URL complète de la requête émise au serveur. - - - - - - diff --git a/reference/solr/solrresponse/getresponse.xml b/reference/solr/solrresponse/getresponse.xml deleted file mode 100644 index a9dc5286c9..0000000000 --- a/reference/solr/solrresponse/getresponse.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrResponse::getResponse - Récupère l'objet SolrObject représentant la réponse XML du serveur - - - - &reftitle.description; - - public SolrObjectSolrResponse::getResponse - - - - Récupère l'objet SolrObject représentant la réponse XML du serveur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'objet SolrObject représentant la réponse XML du serveur. - - - - - - diff --git a/reference/solr/solrresponse/setparsemode.xml b/reference/solr/solrresponse/setparsemode.xml deleted file mode 100644 index f7a511a5d8..0000000000 --- a/reference/solr/solrresponse/setparsemode.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - SolrResponse::setParseMode - Définit le mode d'analyse - - - - &reftitle.description; - - public boolSolrResponse::setParseMode - intparser_mode0 - - - Définit le mode d'analyse. - - - - - - &reftitle.parameters; - - - - parser_mode - - - SolrResponse::PARSE_SOLR_DOC analyse les documents - avec SolrDocument. - SolrResponse::PARSE_SOLR_OBJ analyse les documents - avec SolrObjects. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrresponse/success.xml b/reference/solr/solrresponse/success.xml deleted file mode 100644 index 4d4fa3e7b9..0000000000 --- a/reference/solr/solrresponse/success.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrResponse::success - Vérifie si la requête au serveur a réussi - - - - &reftitle.description; - - public boolSolrResponse::success - - - - Vérifie si la requête au serveur a réussi. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si la requête a réussi, &false; sinon. - - - - - - diff --git a/reference/solr/solrserverexception.xml b/reference/solr/solrserverexception.xml deleted file mode 100644 index e3374e6e8e..0000000000 --- a/reference/solr/solrserverexception.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - La classe SolrServerException - SolrServerException - - - - -
    - &reftitle.intro; - - Une exception est émise lorsque se produit une erreur dans le - serveur Solr. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrServerException - - - - - SolrServerException - - - - extends - SolrException - - - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -     - - &reference.solr.entities.solrserverexception; - -     - - diff --git a/reference/solr/solrserverexception/getinternalinfo.xml b/reference/solr/solrserverexception/getinternalinfo.xml deleted file mode 100644 index 0a4aecf210..0000000000 --- a/reference/solr/solrserverexception/getinternalinfo.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrServerException::getInternalInfo - Retourne des informations internes sur le lieu où l'exception a été émise - - - - &reftitle.description; - - public arraySolrServerException::getInternalInfo - - - - Retourne des informations internes sur le lieu où l'exception a été émise. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant des informations internes sur le lieu - où l'exception a été émise. Utilisé uniquement par les développeurs de - l'extension dans un but de débogage. - - - - - - diff --git a/reference/solr/solrupdateresponse.xml b/reference/solr/solrupdateresponse.xml deleted file mode 100644 index abcd6ffbf0..0000000000 --- a/reference/solr/solrupdateresponse.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - La classe SolrUpdateResponse - SolrUpdateResponse - - - - -
    - &reftitle.intro; - - Représente une réponse à une requête de mise à jour. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrUpdateResponse - - - - - final - SolrUpdateResponse - - - - extends - SolrResponse - - - - &Constants; - - const - int - SolrUpdateResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrUpdateResponse::PARSE_SOLR_DOC - 1 - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; -
    - Constantes de la classe SolrUpdateResponse - - - - SolrUpdateResponse::PARSE_SOLR_OBJ - - Les documents doivent être analysés comme des instances SolrObject. - - - - - SolrUpdateResponse::PARSE_SOLR_DOC - - Les documents doivent être analysés comme des instances SolrDocument. - - - - -
    -
    - - - -     - - &reference.solr.entities.solrupdateresponse; - -     - diff --git a/reference/solr/solrupdateresponse/construct.xml b/reference/solr/solrupdateresponse/construct.xml deleted file mode 100644 index fa4091084d..0000000000 --- a/reference/solr/solrupdateresponse/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrUpdateResponse::__construct - Constructeur - - - - &reftitle.description; - - public SolrUpdateResponse::__construct - - - - Constructeur - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Rien - - - - - - diff --git a/reference/solr/solrupdateresponse/destruct.xml b/reference/solr/solrupdateresponse/destruct.xml deleted file mode 100644 index ff433bf910..0000000000 --- a/reference/solr/solrupdateresponse/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrUpdateResponse::__destruct - Destructeur - - - - &reftitle.description; - - public SolrUpdateResponse::__destruct - - - - Destructeur - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Rien - - - - - - diff --git a/reference/solr/solrutils.xml b/reference/solr/solrutils.xml deleted file mode 100644 index 1e891774e5..0000000000 --- a/reference/solr/solrutils.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - La classe SolrUtils - SolrUtils - - - - -
    - &reftitle.intro; - - Contient des méthodes utiles pour récupérer la version de l'extension - courante et préparer les requêtes. - - - Contient également des méthodes pour échapper les chaînes utilisées dans - les requêtes et analyser les réponses XML. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrUtils - - - - - abstract - SolrUtils - - - - - &Methods; - - - - -
    - -     - - &reference.solr.entities.solrutils; - -     - - diff --git a/reference/solr/solrutils/digestxmlresponse.xml b/reference/solr/solrutils/digestxmlresponse.xml deleted file mode 100644 index 922f499bcd..0000000000 --- a/reference/solr/solrutils/digestxmlresponse.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - SolrUtils::digestXmlResponse - Analyse une réponse XML dans un SolrObject - - - - &reftitle.description; - - public static SolrObjectSolrUtils::digestXmlResponse - stringxmlresponse - intparse_mode0 - - - Cette méthode analyse une réponse XML depuis un serveur Apache Solr dans un SolrObject. - Lance une exception SolrException si une erreur survient. - - - - - - &reftitle.parameters; - - - - xmlresponse - - - La réponse XML depuis le serveur Solr. - - - - - parse_mode - - - Utiliser SolrResponse::PARSE_SOLR_OBJ ou SolrResponse::PARSE_SOLR_DOC - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet SolrObject représentant la réponse XML. - - - Si le paramètre parse_mode vaut SolrResponse::PARSE_SOLR_OBJ, les - documents Solr seront analysés comme des instances SolrObject. - - - S'il vaut SolrResponse::PARSE_SOLR_DOC, ils seront analysés comme - des instances SolrDocument. - - - - - - diff --git a/reference/solr/solrutils/escapequerychars.xml b/reference/solr/solrutils/escapequerychars.xml deleted file mode 100644 index 6e5032d71d..0000000000 --- a/reference/solr/solrutils/escapequerychars.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - SolrUtils::escapeQueryChars - Protège une requête - - - - &reftitle.description; - - public static stringfalseSolrUtils::escapeQueryChars - stringstr - - - Le support Lucene protège les caractères spéciaux faisant partie - de la syntaxe de la requête. - - - La liste actuelle des caractères spéciaux est : - - - - - - Ces caractères font partie de la syntaxe de la requête et doivent - être échappés. - - - - - &reftitle.parameters; - - - - str - - - Chaîne à protéger. - - - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne protégée&return.falseforfailure;. - - - - - - diff --git a/reference/solr/solrutils/getsolrversion.xml b/reference/solr/solrutils/getsolrversion.xml deleted file mode 100644 index cefa73c118..0000000000 --- a/reference/solr/solrutils/getsolrversion.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrUtils::getSolrVersion - Récupère la version courante de l'extension Solr - - - - &reftitle.description; - - public static stringSolrUtils::getSolrVersion - - - - Récupère la version courante Solr. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La version courante de l'extension Apache Solr. - - - - - - diff --git a/reference/solr/solrutils/queryphrase.xml b/reference/solr/solrutils/queryphrase.xml deleted file mode 100644 index 4c2528c7a2..0000000000 --- a/reference/solr/solrutils/queryphrase.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrUtils::queryPhrase - Prépare une phrase depuis une chaîne non protégée par Lucene - - - - &reftitle.description; - - public static stringSolrUtils::queryPhrase - stringstr - - - Prépare une phrase depuis une chaîne non protégée par Lucene. - - - - - - &reftitle.parameters; - - - - str - - - La phrase Lucene. - - - - - - - - - &reftitle.returnvalues; - - Retourne la partie de la phrase contenue entre guillemets. - - - - - - diff --git a/reference/sqlsrv/book.xml b/reference/sqlsrv/book.xml deleted file mode 100644 index 65bf8063de..0000000000 --- a/reference/sqlsrv/book.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - Driver Microsoft SQL Server pour PHP - SQLSRV - - - - &reftitle.intro; - - L'extension SQLSRV permet d'accéder à un serveur de base de données - Microsoft SQL et SQL Azure. La version 3.0 du pilote supporte SQL Server, - en commençant par SQL Server 2005, et incluant SQL Server 2012 et SQL - Server 2012 LocalDB (pour plus d'informations à propos de LocalDB, voir - le pilote PHP pour le support de SQL Server pour LocalDB - et SQL Server 2012 Express LocalDB.) - - - L'extension SQLSRV est supportée par Microsoft et est disponible au - téléchargement ici : &url.sqlsrv;. - SQL Server 2012 LocalDB peut être téléchargé ici : - &url.sqlsrv.localdbdownload;. - - - - - &reference.sqlsrv.setup; - &reference.sqlsrv.constants; - &reference.sqlsrv.reference; - - - diff --git a/reference/sqlsrv/configure.xml b/reference/sqlsrv/configure.xml deleted file mode 100644 index 07176dee8f..0000000000 --- a/reference/sqlsrv/configure.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - -
    - &reftitle.install; - - L'extension SQLSRV est activée en ajoutant la bibliothèque DLL appropriée - dans le dossier d'extensions PHP et en ajoutant l'entrée correspondante - dans le fichier &php.ini;. Le téléchargement de SQLSRV est fourni avec - 8 pilotes, dont 4 dédiés au support de PDO. - - - La version la plus récente du pilote est disponible au téléchargement ici : - téléchargement de SQLSRV. - - - Pour plus d'informations sur les pré-requis SQLSRV, se reporter au - chapitre sur les - pré-requis du système SQLSRV. - - - Depuis la version 4.0, l'extension SQLSRV n'est compatible que lorsque PHP 7.0 fonctionne sur Linux ou Windows. - -
    - diff --git a/reference/sqlsrv/constants.xml b/reference/sqlsrv/constants.xml deleted file mode 100644 index 7a540ce6ba..0000000000 --- a/reference/sqlsrv/constants.xml +++ /dev/null @@ -1,1019 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - SQLSRV_FETCH_ASSOC - (int) - - - - Force sqlsrv_fetch_array à retourner un tableau - associatif quand il est passé en paramètre. - - - - - - SQLSRV_FETCH_NUMERIC - (int) - - - - Force sqlsrv_fetch_array à retourner un tableau - indexé numériquement quand il est passé en paramètre. - - - - - - SQLSRV_FETCH_BOTH - (int) - - - - Force sqlsrv_fetch_array à retourner un tableau - associatif et un tableau indexé numériquement quand il est passé en - paramètre (comportement par défaut). - - - - - - SQLSRV_ERR_ALL - (int) - - - - Force sqlsrv_errors à retourner les erreurs - et avertissements quand il est passé en paramètre (comportement par - défaut). - - - - - - SQLSRV_ERR_ERRORS - (int) - - - - Force sqlsrv_errors à retourner seulement - les erreurs (pas les avertissements) quand il est passé en paramètre. - - - - - - SQLSRV_ERR_WARNINGS - (int) - - - - Force sqlsrv_errors à retourner seulement - les avertissements (pas les erreurs) quand il est passé en paramètre. - - - - - - SQLSRV_LOG_SYSTEM_ALL - (int) - - - - Active les logs de tous les sous-systèmes quand il est passé à la fonction - sqlsrv_configure comme paramère. - - - - - - SQLSRV_LOG_SYSTEM_CONN - (int) - - - - Active les logs de toute l'activité des connexions quand il est passé - à la fonction sqlsrv_configure comme paramère. - - - - - - SQLSRV_LOG_SYSTEM_INIT - (int) - - - - Active les logs de toute l'activité des initialisations quand il est - passé à la fonction sqlsrv_configure comme paramère. - - - - - - SQLSRV_LOG_SYSTEM_OFF - (int) - - - - Désactive les logs de tous les sous-systèmes quand il est passé à la fonction - sqlsrv_configure comme paramère. - - - - - - SQLSRV_LOG_SYSTEM_STMT - (int) - - - - Active les logs des requêtes quand il est passé à la fonction - sqlsrv_configure comme paramère. - - - - - - SQLSRV_LOG_SYSTEM_UTIL - (int) - - - - Active les logs des erreurs de fonction quand il est passé à la fonction - sqlsrv_configure comme paramère. - - - - - - SQLSRV_LOG_SEVERITY_ALL - (int) - - - - Active les logs des erreurs, avertissements et notes quand il est - passé à la fonction sqlsrv_configure comme paramère. - - - - - - SQLSRV_LOG_SEVERITY_ERROR - (int) - - - - Spécifie que les erreurs seront enregistrées quand il est passé à la fonction - sqlsrv_configure comme paramère. - - - - - - SQLSRV_LOG_SEVERITY_NOTICE - (int) - - - - Spécifie que les notes seront enregistrées quand il est passé à la fonction - sqlsrv_configure comme paramère. - - - - - - SQLSRV_LOG_SEVERITY_WARNING - (int) - - - - Spécifie que les avertissements seront enregistrées quand il est passé à - la fonction sqlsrv_configure comme paramère. - - - - - - SQLSRV_NULLABLE_YES - (int) - - - - Indique qu'une colonne peut être nulle. - - - - - - SQLSRV_NULLABLE_NO - (int) - - - - Indique qu'une colonne ne peut pas être nulle. - - - - - - SQLSRV_NULLABLE_UNKNOWN - (int) - - - - Indique s'il est connu qu'une colonne est nulle. - - - - - - SQLSRV_PARAM_IN - (int) - - - - Indique un paramètre d'entrée quand il est passé à la fonction - sqlsrv_query ou à la fonction - sqlsrv_prepare. - - - - - - SQLSRV_PARAM_INOUT - (int) - - - - Indique un paramètre d'entrée ou de sortie quand il est passé à la - fonction sqlsrv_query ou à la fonction - sqlsrv_prepare. - - - - - - SQLSRV_PARAM_OUT - (int) - - - - Indique un paramètre de sortie quand il est passé à la fonction - sqlsrv_query ou à la fonction - sqlsrv_prepare. - - - - - - SQLSRV_PHPTYPE_INT - (int) - - - - Spécifie une donnée de type entier PHP. Pour plus d'informations, voir - Comment spécifier les types PHP. - - - - - - SQLSRV_PHPTYPE_DATETIME - (int) - - - - Spécifie une donnée de type datetime (date et heure) PHP. Pour plus d'informations, voir - Comment spécifier les types PHP. - - - - - - SQLSRV_PHPTYPE_FLOAT - (int) - - - - Spécifie une donnée de type nombre à virgule flottante PHP. Pour plus d'informations, voir - Comment spécifier les types PHP. - - - - - - SQLSRV_PHPTYPE_STREAM - (int) - - - - Spécifie une donnée de type flux de PHP. Cette constante fonctionne comme une fonction - et accepte une constante encodée. Voir les constantes SQLSRV_ENC_*. Pour plus d'informations, - se reporter à Comment spécifier les types PHP. - - - - - - SQLSRV_PHPTYPE_STRING - (int) - - - - Spécifie une donnée de type chaîne de caractères PHP. Cette constante fonctionne comme une fonction - et accepte une constante encodée. Voir les constantes SQLSRV_ENC_*. Pour plus d'informations, - se reporter à Comment spécifier les types PHP. - - - - - - SQLSRV_ENC_BINARY - (int) - - - - Spécifie que la donnée est retournée sous la forme d'un flux brute d'octets - depuis le serveur sans y effectuer un encodage ou une transformation. Pour plus - d'informations, se reporter à Comment spécifier - les types PHP. - - - - - - SQLSRV_ENC_CHAR - (int) - - - - Les données sont retournées sous la forme de caractères sur 8 octets, tels que - spécifiés dans la page de code des paramètres régionaux Windows définis sur le système. Tout - caractère multioctet ou caractères qui ne correspondent pas à cette page - de code seront substitués par un point d'interrogation sur un octet (?). - C'est l'encodage par défaut. Pour plus d'informations, se reporter à - Comment spécifier les types PHP. - - - - - - SQLSRV_SQLTYPE_BIGINT - (int) - - - - Décrit le type de données bigint SQL Server. Pour plus d'informations, se reporter à - Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_BINARY - (int) - - - - Décrit le type de données binaire SQL Server. Pour plus d'informations, se reporter à - Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_BIT - (int) - - - - Décrit le type de données bit SQL Server. Pour plus d'informations, se reporter à - Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_CHAR - (int) - - - - Décrit le type de données caractère SQL Server. Cette constante fonctionne comme - une fonction et accepte un paramètre indiquant le nombre de caractères. Pour plus - d'informations, se reporter à - Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_DATE - (int) - - - - Décrit le type de données date SQL Server. Pour plus d'informations, se reporter à - Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_DATETIME - (int) - - - - Décrit le type de données datetime SQL Server. Pour plus d'informations, - se reporter à - Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_DATETIME2 - (int) - - - - Décrit le type de données datetime2 SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_DATETIMEOFFSET - (int) - - - - Décrit le type de données datetimeoffset SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_DECIMAL - (int) - - - - Décrit le type de données décimal. Cette constante fonctionne comme une fonction - et accepte 2 paramètres indiquant (dans l'ordre) la précision et l'échelle. - Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_FLOAT - (int) - - - - Décrit le type de données nombre à virgule flottante SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_IMAGE - (int) - - - - Décrit le type de données image SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_INT - (int) - - - - Décrit le type de données entier SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_MONEY - (int) - - - - Décrit le type de données monnaie SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_NCHAR - (int) - - - - Décrit le type de données nchar SQL Server. Cette constante fonctionne comme une - fonction et accepte un seul paramètre indiquant le nombre de caractères. - Pour plus d'informations, se reporter à - Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_NUMERIC - (int) - - - - Décrit le type de données numérique SQL Server. Cette constante fonctionne comme - une fonction et accepte 2 paramètres (dans l'ordre), la précision et l'échelle. - Pour plus d'informations, se reporter à - Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_NVARCHAR - (int) - - - - Décrit le type de données nvarchar SQL Server. Cette constante fonctionne comme une - fonction et accepte un seul paramètre indiquant le nombre de caractères. - Pour plus d'informations, se reporter à - Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_NVARCHAR('max') - (int) - - - - Décrit le type de données nvarchar(MAX) SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_NTEXT - (int) - - - - Décrit le type de données ntext SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_REAL - (int) - - - - Décrit le type de données réelle SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_SMALLDATETIME - (int) - - - - Décrit le type de données smalldatetime SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_SMALLINT - (int) - - - - Décrit le type de données smallint SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_SMALLMONEY - (int) - - - - Décrit le type de données smallmoney SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_TEXT - (int) - - - - Décrit le type de données texte SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_TIME - (int) - - - - Décrit le type de données time SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_TIMESTAMP - (int) - - - - Décrit le type de données timestamp SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_TINYINT - (int) - - - - Décrit le type de données tinyint SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_UNIQUEIDENTIFIER - (int) - - - - Décrit le type de données uniqueidentifier SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_UDT - (int) - - - - Décrit le type de données UDT SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_VARBINARY - (int) - - - - 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, se reporter à - Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_VARBINARY('max') - (int) - - - - Décrit le type de données varbinary(MAX) SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_VARCHAR - (int) - - - - 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, se reporter à - Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_VARCHAR('max') - (int) - - - - Décrit le type de données varchar(MAX) SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_SQLTYPE_XML - (int) - - - - Décrit le type de données XML SQL Server. Pour plus d'informations, se reporter - à Comment spécifier les types SQL. - - - - - - SQLSRV_TXN_READ_UNCOMMITTED - (int) - - - - 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 - sqlsrv_connect. - - - - - - SQLSRV_TXN_READ_COMMITTED - (int) - - - - 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 - sqlsrv_connect. - - - - - - SQLSRV_TXN_REPEATABLE_READ - (int) - - - - 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 - sqlsrv_connect. - - - - - - SQLSRV_TXN_SNAPSHOT - (int) - - - - 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 - sqlsrv_connect. - - - - - - SQLSRV_TXN_READ_SERIALIZABLE - (int) - - - - 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 - sqlsrv_connect. - - - - - - SQLSRV_CURSOR_FORWARD - (int) - - - - Indique un curseur de type "suivant uniquement". Pour plus d'informations, - se reporter à la section sur - la spécification d'un type - de curseur et la sélection de lignes. - - - - - - SQLSRV_CURSOR_STATIC - (int) - - - - Indique un curseur de type "statique". Pour plus d'informations, - se reporter à la section sur - la spécification d'un type - de curseur et la sélection de lignes. - - - - - - SQLSRV_CURSOR_DYNAMIC - (int) - - - - Indique un curseur de type "dynamique". Pour plus d'informations, - se reporter à la section sur - la spécification d'un type - de curseur et la sélection de lignes. - - - - - - SQLSRV_CURSOR_KEYSET - (int) - - - - Indique un curseur de type "keyset". Pour plus d'informations, - se reporter à la section sur - la spécification d'un type - de curseur et la sélection de lignes. - - - - - - SQLSRV_CURSOR_BUFFERED - (int) - - - - Crée une requête de curseur côté client. Cela permet d'accéder aux - lignes dans n'importe quel ordre. Pour des informations quant à son utilisation, - se reporter à la section sur la - la spécification d'un type - de curseur et la sélection de lignes. - - - - - - SQLSRV_SCROLL_NEXT - (int) - - - - Spécifie la ligne à sélectionner dans un jeu de résultats. Pour plus d'informations, - se reporter à la section sur - la spécification d'un type - de curseur et la sélection de lignes. - - - - - - SQLSRV_SCROLL_PRIOR - (int) - - - - Spécifie la ligne à sélectionner dans un jeu de résultats. Pour plus d'informations, - se reporter à la section sur - la spécification d'un type - de curseur et la sélection de lignes. - - - - - - SQLSRV_SCROLL_FIRST - (int) - - - - Spécifie la ligne à sélectionner dans un jeu de résultats. Pour plus d'informations, - se reporter à la section sur la - spécification d'un type de curseur et la sélection de lignes. - - - - - - SQLSRV_SCROLL_LAST - (int) - - - - Spécifie la ligne à sélectionner dans un jeu de résultats. Pour plus d'informations, - se reporter à la section sur la - spécification d'un type de curseur et la sélection de lignes. - - - - - - SQLSRV_SCROLL_ABSOLUTE - (int) - - - - Spécifie la ligne à sélectionner dans un jeu de résultats. Pour plus d'informations, - se reporter à la section sur la - spécification d'un type de curseur et la sélection de lignes. - - - - - - SQLSRV_SCROLL_RELATIVE - (int) - - - - Spécifie la ligne à sélectionner dans un jeu de résultats. Pour plus d'informations, - se reporter à la section sur la - spécification d'un type de curseur et la sélection de lignes. - - - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml b/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml deleted file mode 100644 index 473f8b6254..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - sqlsrv_begin_transaction - Commence une transaction - - - &reftitle.description; - - boolsqlsrv_begin_transaction - resourceconn - - - La transaction commençant avec la fonction - sqlsrv_begin_transaction inclut toutes les - requêtes qui sont exécutées après l'appel à la fonction - sqlsrv_begin_transaction et avant l'appel à la fonction - sqlsrv_rollback ou la fonction - sqlsrv_commit. Une transaction explicite peut être - commencée et validée (ou annulée) en utilisant ces fonctions au lieu - d'exécuter les requêtes SQL qui commencent et valident/annulent les transactions. - Pour plus d'informations, se reporter aux - transactions SQLSRV. - - - - &reftitle.parameters; - - - conn - - - La ressource de connexion retournée par un appel à la fonction - sqlsrv_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_begin_transaction</function> - - L'exemple suivant montre la façon d'utiliser la fonction - sqlsrv_begin_transaction avec les fonctions - sqlsrv_commit et sqlsrv_rollback. - - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Commence la transaction. */ -if ( sqlsrv_begin_transaction( $conn ) === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Initialise les valeurs des paramètres. */ -$orderId = 1; $qty = 10; $productId = 100; - -/* Exécute la première requête. */ -$sql1 = "INSERT INTO OrdersTable (ID, Quantity, ProductID) - VALUES (?, ?, ?)"; -$params1 = array( $orderId, $qty, $productId ); -$stmt1 = sqlsrv_query( $conn, $sql1, $params1 ); - -/* Exécute la seconde requête. */ -$sql2 = "UPDATE InventoryTable - SET Quantity = (Quantity - ?) - WHERE ProductID = ?"; -$params2 = array($qty, $productId); -$stmt2 = sqlsrv_query( $conn, $sql2, $params2 ); - -/* Si les deux requêtes sont exécutées avec succès, on valide la transaction. */ -/* Sinon, on annule la transaction. */ -if( $stmt1 && $stmt2 ) { - sqlsrv_commit( $conn ); - echo "Transaction validée.
    "; -} else { - sqlsrv_rollback( $conn ); - echo "Transaction annulée.
    "; -} -?> -]]> -     - &example.outputs.similar; -     -     - - - &reftitle.seealso; - - sqlsrv_commit - sqlsrv_rollback - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-cancel.xml b/reference/sqlsrv/functions/sqlsrv-cancel.xml deleted file mode 100644 index 6919a4d6dd..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-cancel.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - sqlsrv_cancel - Annule une requête - - - &reftitle.description; - - boolsqlsrv_cancel - resourcestmt - - - Annule une requête. Tous les résultats associés avec la requête qui n'ont pas - été utilisés seront supprimés. Après l'appel à la fonction - sqlsrv_cancel, la requête spécifiée peut être ré-exécutée - si elle a été créée avec la fonction sqlsrv_prepare. - L'appel à la fonction sqlsrv_cancel n'est pas nécessaire - si tous les résultats associés avec la requête ont été utilisés. - - - - - &reftitle.parameters; - - - stmt - - - La ressource de la requête à annuler. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_cancel</function> - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT Sales FROM Table_1"; - -$stmt = sqlsrv_prepare( $conn, $sql); - -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -if( sqlsrv_execute( $stmt ) === false) { - die( print_r( sqlsrv_errors(), true)); -} - -$salesTotal = 0; -$count = 0; - -while( ($row = sqlsrv_fetch_array( $stmt)) && $salesTotal <=100000) -{ - $qty = $row[0]; - $price = $row[1]; - $salesTotal += ( $price * $qty); - $count++; -} - -echo "$count ventes ont représenté les premiers $$salesTotal de revenus.
    "; - -// Annule les résultats restants. La requête peut être ré-utilisée. -sqlsrv_cancel( $stmt); -?> -]]> -     -     -     - - - &reftitle.notes; - - La principale différence entre la fonction sqlsrv_cancel - et la fonction sqlsrv_free_stmt est qu'une ressource de - requête annulée avec la fonction sqlsrv_cancel peut être - ré-utilisée si elle a été créée avec la fonction sqlsrv_prepare. - Une ressource de requête annulée avec la fonction - sqlsrv_free_statement ne peut plus être ré-exécutée. - - - - - &reftitle.seealso; - - sqlsrv_free_stmt - sqlsrv_prepare - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-client-info.xml b/reference/sqlsrv/functions/sqlsrv-client-info.xml deleted file mode 100644 index ce8c159632..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-client-info.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - sqlsrv_client_info - Retourne les informations sur le client ainsi que sur la connexion spécifiée - - - &reftitle.description; - - arraysqlsrv_client_info - resourceconn - - - Retourne des informations sur le client ainsi que sur la connexion spécifiée. - - - - - &reftitle.parameters; - - - conn - - - La connexion sur laquelle on souhaite des informations. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif dont les clés sont décrites dans - la table ci-dessous. - Retourne &false; sinon. - - Tableau retourné par sqlsrv_client_info - - - - Clé - Description - - - - - DriverDllName - SQLNCLI10.DLL - - - DriverODBCVer - version ODBC (xx.yy) - - - DriverVer - version de la bibliothèque DLL native client du serveur (10.5.xxx) - - - ExtensionVer - version de la bibliothèque php_sqlsrv.dll (2.0.xxx.x) - - - -
    -     -     - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_client_info</function> - -"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connOptions ); - -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -if( $client_info = sqlsrv_client_info( $conn)) { - foreach( $client_info as $key => $value) { - echo $key.": ".$value."
    "; - } -} else { - echo "Erreur lors de la récupération des informations clientes.
    "; -} -?> -]]> -     -     -     - - - &reftitle.seealso; - - sqlsrv_server_info - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-close.xml b/reference/sqlsrv/functions/sqlsrv-close.xml deleted file mode 100644 index bde8afbf52..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-close.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - sqlsrv_close - Clôture une connexion établie et libère les ressources associées - - - &reftitle.description; - - boolsqlsrv_close - resourceconn - - - Clôture une connexion établie et libère les ressources associées. - - - - - &reftitle.parameters; - - - conn - - - La connexion à fermer. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_close</function> - -"nomutilisateur", "PWD"=>"motdepasse", "Database"=>"nomschema"); -$conn = sqlsrv_connect( $nomServeur, $connOptions ); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -//------------------------------------- -// Effectuer les operations sur la base de données -//------------------------------------- - -// Et on ferme la connexion. -sqlsrv_close( $conn ); -?> -]]> - - - - - - &reftitle.seealso; - - sqlsrv_connect - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-commit.xml b/reference/sqlsrv/functions/sqlsrv-commit.xml deleted file mode 100644 index 62e7c55dda..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-commit.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - sqlsrv_commit - Valide une transaction commencée avec la fonction sqlsrv_begin_transaction - - - &reftitle.description; - - boolsqlsrv_commit - resourceconn - - - Valide une transaction commencée par la fonction sqlsrv_begin_transaction. - La connexion est retournée en mode auto-commit après l'appel à la fonction - sqlsrv_commit. La transaction validée inclut toutes les - requêtes exécutées après un appel à la fonction - sqlsrv_begin_transaction. Les transactions doivent commencer, - être validées ou être annulées en utilisant ces fonctions au lieu d'utiliser des requêtes - déclarant le début ou l'annulation d'une transaction. Pour plus d'informations, - se reporter aux transactions SQLSRV. - - - - - &reftitle.parameters; - - - conn - - - La connexion sur laquelle la transaction va être validée. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_commit</function> - - L'exemple suivant montre la façon d'utiliser la fonction - sqlsrv_commit avec - sqlsrv_begin_transaction et - sqlsrv_rollback. - - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Début de la transaction. */ -if ( sqlsrv_begin_transaction( $conn ) === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Initialisation des paramètres. */ -$orderId = 1; $qty = 10; $productId = 100; - -/* Définition et exécution de la première requête. */ -$sql1 = "INSERT INTO OrdersTable (ID, Quantity, ProductID) - VALUES (?, ?, ?)"; -$params1 = array( $orderId, $qty, $productId ); -$stmt1 = sqlsrv_query( $conn, $sql1, $params1 ); - -/* Définition et exécution de la seconde requête. */ -$sql2 = "UPDATE InventoryTable - SET Quantity = (Quantity - ?) - WHERE ProductID = ?"; -$params2 = array($qty, $productId); -$stmt2 = sqlsrv_query( $conn, $sql2, $params2 ); - -/* Si les deux requêtes ont réussi, on commit la transaction. */ -/* Sinon, on l'annule. */ -if( $stmt1 && $stmt2 ) { - sqlsrv_commit( $conn ); - echo "Transaction validée.
    "; -} else { - sqlsrv_rollback( $conn ); - echo "Transaction annulée.
    "; -} -?> -]]> -     -     -     - - - &reftitle.seealso; - - sqlsrv_begin_transaction - sqlsrv_rollback - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-configure.xml b/reference/sqlsrv/functions/sqlsrv-configure.xml deleted file mode 100644 index 76272b8037..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-configure.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - sqlsrv_configure - Modifie la configuration du gestionnaire d'erreurs et d'historisations du driver - - - &reftitle.description; - - boolsqlsrv_configure - stringsetting - mixedvalue - - - Modifie la configuration du gestionnaire d'erreurs et d'historisations du driver. - - - - - &reftitle.parameters; - - - setting - - - Le nom de la configuration à définir. Les valeurs possibles sont - "WarningsReturnAsErrors", "LogSubsystems", et "LogSeverity". - - - - - value - - - La valeur de la configuration à définir. La table suivante montre les valeurs possibles : - - Options de configuration du gestionnaire d'erreurs et d'historisations - - - - Configurations - Options - - - - - WarningsReturnAsErrors - 1 (&true;) ou 0 (&false;) - - - LogSubsystems - SQLSRV_LOG_SYSTEM_ALL (-1) - SQLSRV_LOG_SYSTEM_CONN (2) - SQLSRV_LOG_SYSTEM_INIT (1) - SQLSRV_LOG_SYSTEM_OFF (0) - SQLSRV_LOG_SYSTEM_STMT (4) - SQLSRV_LOG_SYSTEM_UTIL (8) - - - LogSeverity - SQLSRV_LOG_SEVERITY_ALL (-1) - SQLSRV_LOG_SEVERITY_ERROR (1) - SQLSRV_LOG_SEVERITY_NOTICE (4) - SQLSRV_LOG_SEVERITY_WARNING (2) - - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - Le gestionnaire d'erreur SQLSRV. - Le gestionnaire d'historisation SQLSRV. - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-connect.xml b/reference/sqlsrv/functions/sqlsrv-connect.xml deleted file mode 100644 index 2562d77d0a..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-connect.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - sqlsrv_connect - Ouvre une connexion sur une base de données Microsoft SQL Server - - - &reftitle.description; - - resourcesqlsrv_connect - stringserverName - arrayconnectionInfo - - - Ouvre une connexion sur une base de données Microsoft SQL Server. Par défaut, - la connexion tente d'utiliser l'authentification Windows. Pour se connecter - en utilisant l'authentification SQL Server, ajouter l'"UID" et le "PWD" dans - le tableau d'options de connexion. - - - - - &reftitle.parameters; - - - serverName - - - Le nom du serveur sur lequel nous souhaitons réaliser une connexion. - Pour se connecter sur une instance particulière, faites suivre le nom - du serveur, puis un antislash, puis le nom de l'instance - (c.-à-d. serverName\sqlexpress). - - - - - connectionInfo - - - Un tableau associatif spécifiant les options pour la connexion sur le serveur. - Si les valeurs des clés UID et PWD ne sont pas spécifiées, la connexion - tentera d'utiliser l'authentification Windows. Pour une liste complète - des clés supportées, se reporter aux - options de connexion SQLSRV. - - - - - - - - &reftitle.returnvalues; - - Une ressource de connexion. Si la connexion n'a pu être ouverte, &false; sera retourné. - - - - - &reftitle.examples; - - Connexion en utilisant l'authentification Windows. - -"dbName"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); - -if( $conn ) { - echo "Connexion établie.
    "; -}else{ - echo "La connexion n'a pu être établie.
    "; - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> -     -     - - Connexion en spécifiant un nom d'utilisateur et un mot de passe. - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); - -if( $conn ) { - echo "Connexion établie.
    "; -}else{ - echo "La connexion n'a pu être établie.
    "; - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> -     -     - - Connexion sur un port spécifique. - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); - -if( $conn ) { - echo "Connexion établie.
    "; -}else{ - echo "La connexion n'a pu être établie.
    "; - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> -     -     -     - - - &reftitle.notes; - - Par défaut, la fonction sqlsrv_connect utilise la file d'attente - de connexion afin d'augmenter les performances. Pour désactiver cette file d'attente - (c.-à-d. et ainsi, forcer une nouvelle connexion à chaque appel à la fonction), définissez - l'option "ConnectionPooling" dans le tableau $connectionOptions à 0 (ou &false;). - Pour plus d'informations se reporter au chapitre sur la - file d'attente de connexions SQLSRV. - - - L'extension SQLSRV n'a pas de fonction dédiée pour modifier la base de données - sur laquelle l'extension est connectée. La base de données cible est spécifiée - dans le tableau $connectionOptions passé à la fonction sqlsrv_connect. - Pour changer la base de données sur une connexion ouverte, exécutez la requête suivante : - "USE dbName" (c.-à-d. sqlsrv_query($conn, "USE dbName")). - - - - - &reftitle.seealso; - - sqlsrv_close - sqlsrv_errors - sqlsrv_query - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-errors.xml b/reference/sqlsrv/functions/sqlsrv-errors.xml deleted file mode 100644 index b503647218..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-errors.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - sqlsrv_errors - Retourne une erreur ainsi que certaines informations sur la dernière opération SQLSRV effectuée - - - &reftitle.description; - - - mixedsqlsrv_errors - interrorsOrWarnings - - - Retourne une erreur ainsi que certaines informations sur la dernière opération - SQLSRV effectuée. - - - - - &reftitle.parameters; - - - errorsOrWarnings - - - Détermine si l'on doit retourner des informations sur l'erreur, - des informations sur l'alerte, ou les deux. Si ce paramètre n'est - pas fourni, les deux informations seront retournées. Voici la - liste des valeurs supportées par ce paramètre : SQLSRV_ERR_ALL, - SQLSRV_ERR_ERRORS, SQLSRV_ERR_WARNINGS. - - - - - - - - &reftitle.returnvalues; - - Si une erreur et/ou une alerte survient lors de la dernière opération SQLSRV, - un tableau de tableaux contenant les informations de l'erreur sera retourné. - Si aucune erreur ni alerte ne survient, &null; sera retourné. Le tableau - suivant décrit la structure du tableau retourné : - - Tableau retourné par sqlsrv_errors - - - - Clé - Description - - - - - SQLSTATE - - Pour les erreurs originaires du driver ODBC, ce sera le SQLSTATE retourné - par ODBC. Pour les erreurs originaires du Microsoft Drivers pour PHP - pour le serveur SQL, un SQLSTATE de IMSSP. Pour les alertes originaires - du Microsoft Drivers pour PHP pour le serveur SQL, un SQLSTATE de 01SSP. - - - - code - - Pour les erreurs originaires du serveur SQL, le code erreur natif du serveur - SQL. Pour les erreurs originaires du ODBC driver, le code erreur retourné - par ODBC. Pour les erreurs originaires du Microsoft Drivers pour PHP pour le - serveur SQL, le code erreur Microsoft Drivers pour PHP pour le serveur SQL. - - - - message - Une description de l'erreur. - - - -
    -     -     - - - &reftitle.examples; - - Exemple avec <function>functionname</function> - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -/* Requête pour sélectionner un nom de colonne invalide. */ -$sql = "SELECT BadColumnName FROM Table_1"; - -/* L'exécution de la requête va échouer car le nom de la colonne n'existe pas. */ -$stmt = sqlsrv_query( $conn, $sql ); -if( $stmt === false ) { - if( ($errors = sqlsrv_errors() ) != null) { - foreach( $errors as $error ) { - echo "SQLSTATE: ".$error[ 'SQLSTATE']."
    "; - echo "code: ".$error[ 'code']."
    "; - echo "message: ".$error[ 'message']."
    "; - } - } -} -?> -]]> -     -     -     - - - &reftitle.notes; - - Par défaut, les alertes générées lors d'un appel à une fonction SQLSRV - sont traitées comme des erreurs. Cela signifie que si une alerte survient - lors d'un appel à une fonction SQLSRV, la fonction retournera &false;. - Cependant, les alertes qui correspondent aux SQLSTATE de valeurs - 01000, 01001, 01003, et 01S02 ne seront jamais traitées comme des erreurs. - Pour plus d'informations sur la façon de modifier ce comportement, se reporter - à la documentation sur la fonction sqlsrv_configure - ainsi que sur la configuration de WarningsReturnAsErrors. - - - - - &reftitle.seealso; - - sqlsrv_configure - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-execute.xml b/reference/sqlsrv/functions/sqlsrv-execute.xml deleted file mode 100644 index df2f77eef6..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-execute.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - sqlsrv_execute - Exécute une requête préparée avec la fonction sqlsrv_prepare - - - &reftitle.description; - - boolsqlsrv_execute - resourcestmt - - - Exécute une requête préparée avec la fonction sqlsrv_prepare. - Cette fonction est idéale pour exécuter une requête préparée à plusieurs - reprises avec des valeurs différentes pour les paramètres. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource de requête retournée par la fonction - sqlsrv_prepare. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_execute</function> - - Cet exemple montre la façon pour préparer une requête avec la fonction - sqlsrv_prepare ainsi que l'exécution à plusieurs - reprises (avec des valeurs différentes pour les paramètres) - en utilisant la fonction sqlsrv_execute. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "UPDATE Table_1 - SET OrderQty = ? - WHERE SalesOrderID = ?"; - -// Initialise les paramètres et prépare la requête. -// Les variables $qty et $id sont liées à la requête, $stmt. -$qty = 0; $id = 0; -$stmt = sqlsrv_prepare( $conn, $sql, array( &$qty, &$id)); -if( !$stmt ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Définition des informations SalesOrderDetailID et OrderQty. -// Ce tableau lie l'ID order à la quantitié order dans une paire key=>value. -$orders = array( 1=>10, 2=>20, 3=>30); - -// Exécute la requête pour chaque ordre. -foreach( $orders as $id => $qty) { - // En raison du fait que $id et $qty sont liés à $stmt1, leurs valeurs - // mises à jour sont utilisées lors de chaque exécution de la requête. - if( sqlsrv_execute( $stmt ) === false ) { - die( print_r( sqlsrv_errors(), true)); - } -} -?> -]]> - - - - - - &reftitle.notes; - - Lorsque l'on prépare une requête qui utilise des variables comme paramètres, - les variables sont liées à la requête. Cela signifie que si l'on met à jour - les valeurs des variables, la prochaine exécution de la requête utilisera les - valeurs mises à jour. Pour les requêtes que l'on ne prévoit d'utiliser qu'une seule - fois, il est recommandé d'utiliser plutôt la fonction sqlsrv_query. - - - - - &reftitle.seealso; - - sqlsrv_prepare - sqlsrv_query - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-fetch-array.xml b/reference/sqlsrv/functions/sqlsrv-fetch-array.xml deleted file mode 100644 index e1e2e47009..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-fetch-array.xml +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - - sqlsrv_fetch_array - Retourne une ligne sous la forme d'un tableau - - - &reftitle.description; - - arraysqlsrv_fetch_array - resourcestmt - intfetchType - introw - intoffset - - - Retourne la prochaine ligne de données disponible sous la forme - d'un tableau associatif, d'un tableau numérique ou les deux (par défaut). - - - - - &reftitle.parameters; - - - stmt - - - Une ressource de requête retournée par - sqlsrv_query ou sqlsrv_prepare. - - - - - fetchType - - - Une constante prédéfinie spécifiant le type de tableau à - retourner. Les valeurs possibles sont - SQLSRV_FETCH_ASSOC, - SQLSRV_FETCH_NUMERIC, et - SQLSRV_FETCH_BOTH (la valeur par défaut). - - - Le type de récupération SQLSRV_FETCH_ASSOC ne doit pas être - utilisé lors du traitement d'un jeu de résultats possédant - des colonnes dont le nom est identique. - - - - - row - - - Spécifie la ligne à traiter dans le jeu de résultats utilisant un - curseur scrollable. Les valeurs possibles sont - SQLSRV_SCROLL_NEXT, SQLSRV_SCROLL_PRIOR, - SQLSRV_SCROLL_FIRST, SQLSRV_SCROLL_LAST, - SQLSRV_SCROLL_ABSOLUTE et, - SQLSRV_SCROLL_RELATIVE (la valeur par défaut). - Lorsque ce paramètre est spécifié, le paramètre - fetchType doit également être explicitement défini. - - - - - offset - - - Spécifie la ligne à accéder si le paramètre row est défini à - SQLSRV_SCROLL_ABSOLUTE ou - SQLSRV_SCROLL_RELATIVE. Il est à noter que la première - ligne du jeu de résultats a comme index 0. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau en cas de succès, &null; s'il n'y a plus de ligne - à retourner, et &false; si une erreur survient. - - - - - &reftitle.examples; - - Récupération d'un tableau associatif - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo ); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT FirstName, LastName FROM SomeTable"; -$stmt = sqlsrv_query( $conn, $sql ); -if( $stmt === false) { - die( print_r( sqlsrv_errors(), true) ); -} - -while( $row = sqlsrv_fetch_array( $stmt, SQLSRV_FETCH_ASSOC) ) { - echo $row['LastName'].", ".$row['FirstName']."
    "; -} - -sqlsrv_free_stmt( $stmt); -?> -]]> -     -     - - Récupération d'un tableau numérique - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo ); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT FirstName, LastName FROM SomeTable"; -$stmt = sqlsrv_query( $conn, $sql ); -if( $stmt === false) { - die( print_r( sqlsrv_errors(), true) ); -} - -while( $row = sqlsrv_fetch_array( $stmt, SQLSRV_FETCH_NUMERIC) ) { - echo $row[0].", ".$row[1]."
    "; -} - -sqlsrv_free_stmt( $stmt); -?> -]]> -     -     -     - - - &reftitle.notes; - - Le fait de ne pas spécifier le paramètre fetchType - ou le fait de le définir explicitement à la valeur - SQLSRV_FETCH_TYPE dans l'exemple ci-dessus retournera - un tableau contenant à la fois des clés associatives et des clés numériques. - - - Si plus d'une colonne est retournée avec le même nom, la dernière colonne - prendra le dessus. Pour éviter d'avoir des problèmes avec les noms des - colonnes, utiliser des alias. - - - Si une colonne ne possédant aucun nom est retournée, la clé associative de l'élément - du tableau sera une chaîne vide (""). - - - - - &reftitle.seealso; - - sqlsrv_connect - sqlsrv_query - sqlsrv_errors - sqlsrv_fetch - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-fetch-object.xml b/reference/sqlsrv/functions/sqlsrv-fetch-object.xml deleted file mode 100644 index e2768974a6..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-fetch-object.xml +++ /dev/null @@ -1,195 +0,0 @@ - - - - - - - sqlsrv_fetch_object - Récupère la prochaine ligne de données du jeu de résultats sous la forme d'un objet - - - &reftitle.description; - - mixedsqlsrv_fetch_object - resourcestmt - stringclassName - arrayctorParams - introw - intoffset - - - Récupère la prochaine ligne de données du jeu de résultats sous la forme - d'une instance de la classe spécifiée dont les propriétés correspondent aux - noms des champs de la ligne récupérée et les valeurs correspondant aux valeurs - des champs de la ligne récupérée. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource de requête créée par la fonction - sqlsrv_query ou la fonction - sqlsrv_execute. - - - - - className - - - Le nom de la classe à instancier. Si aucun nom de classe - n'est spécifié, stdClass sera instanciée. - - - - - ctorParams - - - Valeurs à passer au constructeur de la classe spécifiée. Si le constructeur - de la classe spécifiée prend des paramètres, le tableau ctorParams - doit être fourni. - - - - - row - - - La ligne à traiter. Ce paramètre ne peut être utilisé que si la - requête spécifiée a été préparée avec un curseur scrollable. Dans ce - cas, ce paramètre peut prendre une des valeurs suivantes : - - SQLSRV_SCROLL_NEXT - SQLSRV_SCROLL_PRIOR - SQLSRV_SCROLL_FIRST - SQLSRV_SCROLL_LAST - SQLSRV_SCROLL_ABSOLUTE - SQLSRV_SCROLL_RELATIVE - - - - - - offset - - - Spécifie la ligne à traiter si le paramètre row est défini à - la valeur SQLSRV_SCROLL_ABSOLUTE ou - SQLSRV_SCROLL_RELATIVE. - Il est à noter que la première ligne du jeu de résultats a un index de 0. - - - - - - - - &reftitle.returnvalues; - - Retourne un objet en cas de succès, &null; s'il n'y a plus de ligne à - retourner, et &false; si une erreur survient ou si la classe spécifiée - n'existe pas. - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_fetch_object</function> - - L'exemple suivant montre la façon pour récupérer une ligne sous la - forme d'un objet stdClass. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT fName, lName FROM Table_1"; -$stmt = sqlsrv_query( $conn, $sql); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Récupère chaque ligne sous la forme d'un objet -// Vu qu'aucune classe n'est spécifiée, chaque ligne sera récupérée sous la forme d'un objet stdClass. -// Les noms des propriétés correspondent aux noms des champs. -while( $obj = sqlsrv_fetch_object( $stmt)) { - echo $obj->fName.", ".$obj->lName."
    "; -} -?> -]]> -     -     -     - - - &reftitle.notes; - - Si un nom de classe est spécifié avec le paramètre optionnel $className - et la classe a des propriétés dont les noms correspondent à des noms de - champs du jeu de résultats, les valeurs correspondantes du jeu de résultats - seront appliquées à ces propriétés. Si un nom de champs du jeu de résultats - ne correspond pas à une propriété de la classe, une propriété dont le nom - correspond au nom du champ sera ajoutée à l'objet et la valeur correspondante - dans le jeu de résultats sera appliquée à cette propriété. La règle suivante - s'applique lors de l'utilisation du paramètre $className : - - Le nom du champ et de la propriété sont sensibles à la casse. - La correspondance champ/propriété survient en tenant compte des modificateurs d'accès. - Les types de données des propriétés de la classe sont ignorés lors de l'application - de la valeur d'un champ sur une propriété. - Si la classe n'existe pas, la fonction retourne &false; et ajoute une erreur dans la collection - des erreurs. - - Suivant si le paramètre $className est fourni ou non, si un champ avec aucun nom - est retourné, la valeur du champ sera ignorée et une alerte sera ajoutée à la collection - des erreurs. - - - Lors du traitement d'un jeu de résultats qui possède plusieurs colonnes portant le - même nom, il peut être plus judicieux d'utiliser la fonction - sqlsrv_fetch_array ou une combinaison des fonctions - sqlsrv_fetch et sqlsrv_get_field. - - - - - &reftitle.seealso; - - sqlsrv_fetch - sqlsrv_fetch_array - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-fetch.xml b/reference/sqlsrv/functions/sqlsrv-fetch.xml deleted file mode 100644 index 524aa6b3a7..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-fetch.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - sqlsrv_fetch - Rend la prochaine ligne d'un jeu de résultats disponible pour lecture - - - &reftitle.description; - - mixedsqlsrv_fetch - resourcestmt - introw - intoffset - - - Rend la prochaine ligne d'un jeu de résultats disponible pour lecture. - Utiliser la fonction sqlsrv_get_field pour lire les - champs de la ligne. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource de requête créée par l'exécution de la fonction - sqlsrv_query ou de la fonction - sqlsrv_execute. - - - - - row - - - La ligne à traiter. Ce paramètre ne peut être utilisé que si - la requête spécifiée a été préparée avec un curseur scrollable. Dans - ce cas, ce paramètre peut prendre une des valeurs suivantes : - - SQLSRV_SCROLL_NEXT - SQLSRV_SCROLL_PRIOR - SQLSRV_SCROLL_FIRST - SQLSRV_SCROLL_LAST - SQLSRV_SCROLL_ABSOLUTE - SQLSRV_SCROLL_RELATIVE - - - - - - offset - - - Spécifie la ligne à traiter si le paramètre row est défini - à SQLSRV_SCROLL_ABSOLUTE ou - SQLSRV_SCROLL_RELATIVE. Il est à noter que - la première ligne d'un jeu de résultats a l'index 0. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si la prochaine ligne du jeu de résultats a été récupérée avec - succès, &false; si une erreur survient et &null; s'il n'y a plus de ligne - à récupérer dans le jeu de résultats. - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_fetch</function> - - L'exemple suivant montre la façon pour récupérer une ligne avec - la fonction sqlsrv_fetch et pour récupérer les - champs de la ligne avec la fonction sqlsrv_get_field. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT Name, Comment - FROM Table_1 - WHERE ReviewID=1"; -$stmt = sqlsrv_query( $conn, $sql); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Récupère la première ligne (et dans ce cas, seulement celle-ci) du jeu de résultats -// pour lecture. -if( sqlsrv_fetch( $stmt ) === false) { - die( print_r( sqlsrv_errors(), true)); -} - -// Récupère les champs de la ligne. Les indices des champs commencent à 0 et -// doivent être récupérés dans l'ordre. -// Le fait de récupérer les champs de la ligne par leurs noms n'est pas supporté -// par la fonction sqlsrv_get_field. -$name = sqlsrv_get_field( $stmt, 0); -echo "$name: "; - -$comment = sqlsrv_get_field( $stmt, 1); -echo $comment; -?> -]]> - - - - - - - &reftitle.seealso; - - sqlsrv_get_field - sqlsrv_fetch_array - sqlsrv_fetch_object - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-field-metadata.xml b/reference/sqlsrv/functions/sqlsrv-field-metadata.xml deleted file mode 100644 index 5f42f25062..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-field-metadata.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - sqlsrv_field_metadata - Récupère les données méta pour les champs d'une requête préparée par la fonction - sqlsrv_prepare ou la fonction sqlsrv_query - - - - &reftitle.description; - - mixedsqlsrv_field_metadata - resourcestmt - - - Récupère les données méta pour les champs d'une requête préparée par la fonction - sqlsrv_prepare ou la fonction sqlsrv_query. - La fonction sqlsrv_field_metadata peut être appelée sur une - requête avant ou après son exécution. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource de requête depuis laquelle les données méta seront - récupérées. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau de tableaux en cas de succès. Sinon &false; est retourné. - Chaque tableau retourné est décrit dans la table suivante : - - Tableau retourné par la fonction sqlsrv_field_metadata - - - - Clé - Description - - - - - Name - Le nom du champ. - - - Type - La valeur numérique pour le type SQL. - - - Size - Le nombre de caractères pour les champs de type caractères, - le nombre d'octets pour les champs de type binaire, ou &null; pour - les autres types. - - - Precision - La précision pour les variables de type précision, &null; pour les - autres types. - - - Scale - - L'échelle pour les variables de type scale, &null; pour les autres types. - - - Nullable - Une énumération indiquant si la colonne peut être nulle, ne peut pas l'être, - ou si cette information n'est pas connue. - - - -
    - Pour plus d'informations, se reporter à la documentation sur la fonction - sqlsrv_field_metadata de la - documentation Microsoft SQLSRV. -     -     - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_field_metadata</function> - -"AdventureWorks", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT * FROM Table_1"; -$stmt = sqlsrv_prepare( $conn, $sql ); - -foreach( sqlsrv_field_metadata( $stmt ) as $fieldMetadata ) { - foreach( $fieldMetadata as $name => $value) { - echo "$name: $value
    "; - } - echo "
    "; -} -?> -]]> -     -     -     - - - &reftitle.seealso; - - sqlsrv_client_info - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-free-stmt.xml b/reference/sqlsrv/functions/sqlsrv-free-stmt.xml deleted file mode 100644 index f6938f3ab3..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-free-stmt.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - sqlsrv_free_stmt - Libère toutes les ressources de la requête spécifiée - - - &reftitle.description; - - boolsqlsrv_free_stmt - resourcestmt - - - Libère toutes les ressources pour la requête spécifiée. La requête ne pourra - plus être utilisée après le passage à la fonction sqlsrv_free_stmt. - Si la requête sqlsrv_free_stmt est appelée alors que la - requête est en cours d'exécution, l'exécution de la requête est interrompue, - et la requête est annulée. - - - - - &reftitle.parameters; - - - stmt - - - La requête dont les ressources seront libérées. - Il est à noter que &null; est une valeur de paramètre valide. Cette valeur - permet à la fonction d'être appelée à plusieurs reprises dans un script. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_free_stmt</function> - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$stmt = sqlsrv_query( $conn, "SELECT * FROM Table_1"); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -/*------------------------------- - Exploitation de la requête ici. --------------------------------*/ - -/* Libération des ressources associées à la requête. */ -sqlsrv_free_stmt( $stmt); - -?> -]]> - - - - - - &reftitle.notes; - - La principale différence entre la fonction sqlsrv_free_stmt et - la fonction sqlsrv_cancel est qu'une ressource de requête - annulée avec la fonction sqlsrv_cancel peut être ré-exécutée - si elle a été créée avec la fonction sqlsrv_prepare. - Une ressource de requête annulée avec la fonction - sqlsrv_free_statement ne peut plus être ré-exécutée. - - - - - &reftitle.seealso; - - sqlsrv_cancel - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-get-config.xml b/reference/sqlsrv/functions/sqlsrv-get-config.xml deleted file mode 100644 index cc94bfe0e2..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-get-config.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - sqlsrv_get_config - Retourne la valeur de la configuration spécifiée - - - &reftitle.description; - - mixedsqlsrv_get_config - stringsetting - - - Retourne la valeur de la configuration spécifiée. - - - - - &reftitle.parameters; - - - setting - - - Le nom de la configuration pour laquelle la valeur sera - retournée. Pour une liste des configurations, voir - la fonction sqlsrv_configure. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur de la configuration demandée. Si une - configuration invalide est fournie, &false; sera retourné. - - - - - &reftitle.seealso; - - sqlsrv_configure - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-get-field.xml b/reference/sqlsrv/functions/sqlsrv-get-field.xml deleted file mode 100644 index ed357e8407..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-get-field.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - sqlsrv_get_field - Récupère les données du champ depuis la ligne actuellement sélectionnée - - - &reftitle.description; - - mixedsqlsrv_get_field - resourcestmt - intfieldIndex - intgetAsType - - - Récupère les données du champ depuis la ligne actuellement sélectionnée. - Les champs doivent être lus dans l'ordre. Leurs indices commencent à 0. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource de requête retournée par la fonction - sqlsrv_query ou la fonction - sqlsrv_execute. - - - - - fieldIndex - - - L'index du champ à récupérer. Les indices des champs commencent à 0. - Les champs doivent être lus dans l'ordre, c.-à-d. si l'on accède au champ - d'indice 1, alors le champ d'indice 0 ne sera plus disponible. - - - - - getAsType - - - Le type de données PHP pour les données du champ retourné. Si ce paramètre - n'est pas défini, les données du champ seront retournées sous la forme - d'un type de données PHP par défaut. Pour plus d'informations sur les - types de données PHP par défaut, se reporter à la section sur - les types de données PHP par défaut - de la documentation Microsoft SQLSRV. - - - - - - - - &reftitle.returnvalues; - - Retourne les données depuis le champ spécifié en cas de succès. - Retourne &false; si une erreur survient. - - - - - &reftitle.examples; - - <function>sqlsrv_get_field</function> example - - L'exemple suivant montre la façon de récupérer une ligne avec la - fonction sqlsrv_fetch et récupère - les champs de la ligne avec la fonction sqlsrv_get_field. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT Name, Comment - FROM Table_1 - WHERE ReviewID=1"; -$stmt = sqlsrv_query( $conn, $sql); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Rend disponible la première (et dans ce cas, la seule) ligne du jeu de résultats pour lecture. -if( sqlsrv_fetch( $stmt ) === false) { - die( print_r( sqlsrv_errors(), true)); -} - -// Récupère les champs de la ligne. Les indices commencent à 0 et doivent être récupérés dans l'ordre. -// La récupération des champs de la ligne par leurs noms n'est pas supportée par la fonction sqlsrv_get_field. -$name = sqlsrv_get_field( $stmt, 0); -echo "$name: "; - -$comment = sqlsrv_get_field( $stmt, 1); -echo $comment; -?> -]]> - - - - - - &reftitle.seealso; - - sqlsrv_fetch - sqlsrv_fetch_array - sqlsrv_fetch_object - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-has-rows.xml b/reference/sqlsrv/functions/sqlsrv-has-rows.xml deleted file mode 100644 index a22c5d19d8..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-has-rows.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - sqlsrv_has_rows - Indique si la requête spécifiée contient des lignes - - - &reftitle.description; - - boolsqlsrv_has_rows - resourcestmt - - - Indique si la requête spécifiée contient des lignes. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource de requête retournée par la fonction - sqlsrv_query ou la fonction - sqlsrv_execute. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si la requête spécifiée contient des lignes, - &false; si elle n'en contient pas ou bien si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_has_rows</function> - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $server, $connectionInfo ); - -$stmt = sqlsrv_query( $conn, "SELECT * FROM Table_1"); - -if ($stmt) { - $rows = sqlsrv_has_rows( $stmt ); - if ($rows === true) - echo "Il y a des lignes.
    "; - else - echo "Il n'y a aucune ligne.
    "; -} -?> -]]> -     -     -     - - - &reftitle.seealso; - - sqlsrv_num_rows - sqlsrv_query - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-next-result.xml b/reference/sqlsrv/functions/sqlsrv-next-result.xml deleted file mode 100644 index 5784ac5da7..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-next-result.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - sqlsrv_next_result - Rend actif le prochain résultat de la requête spécifiée - - - &reftitle.description; - - mixedsqlsrv_next_result - - resourcestmt - - - Rend actif le prochain résultat de la requête spécifiée. Les résultats - incluent les jeux de résultats, le nombre de lignes, et les paramètres - de sortie. - - - - - &reftitle.parameters; - - - stmt - - - La requête sur laquelle le prochain résultat sera appelé. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si le prochain résultat a été récupéré avec succès, - &false; si une erreur survient, et &null; s'il n'y a plus - de résultat à récupérer. - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_next_result</function> - - L'exemple suivant exécute une requête batch qui fait des insertions - dans une table, puis, fait une sélection de la table. Ceci produit - 2 résultats sur la requête : un pour les lignes affectées par le INSERT, - et un pour les lignes retournées par le SELECT. Pour récupérer les lignes - retournées par le SELECT, la fonction sqlsrv_next_result - doit être appelée pour passer le premier résultat. - - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); - -$query = "INSERT INTO Table_1 (id, data) VALUES (?,?); SELECT * FROM TABLE_1;"; -$params = array(1, "some data"); -$stmt = sqlsrv_query($conn, $query, $params); - -// Consomme le premier résultat (lignes affectées par le INSERT) sans appeler la fonction sqlsrv_next_result. -echo "Lignes affectées : ".sqlsrv_rows_affected($stmt)."
    "; - -// Se déplace au résultat suivant et affiche les résultats. -$next_result = sqlsrv_next_result($stmt); -if( $next_result ) { - while( $row = sqlsrv_fetch_array( $stmt, SQLSRV_FETCH_ASSOC)){ - echo $row['id']." : ".$row['data']."
    "; - } -} elseif( is_null($next_result)) { - echo "Il n'y a plus de résultat.
    "; -} else { - die(print_r(sqlsrv_errors(), true)); -} -?> -]]> -     -     -     - - - &reftitle.seealso; - - sqlsrv_query - sqlsrv_fetch_array - sqlsrv_rows_affected - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-num-fields.xml b/reference/sqlsrv/functions/sqlsrv-num-fields.xml deleted file mode 100644 index 5ed588c1f5..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-num-fields.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - sqlsrv_num_fields - Récupère le nombre de champs (colonnes) dans une requête - - - &reftitle.description; - - mixedsqlsrv_num_fields - resourcestmt - - - Récupère le nombre de champs (colonnes) dans une requête. - - - - - &reftitle.parameters; - - - stmt - - - La requête depuis laquelle le nombre de champs est retournée. - La fonction sqlsrv_num_fields peut être - appelée sur une requête avant ou après l'exécution de la - requête. - - - - - - - - &reftitle.returnvalues; - - Retourne le nombre de champs en cas de succès. - Retourne &false; sinon. - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_num_fields</function> - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT * FROM Table_1"; -$stmt = sqlsrv_query($conn, $sql); -if( $stmt === false) { - die( print_r( sqlsrv_errors(), true)); -} - -$numFields = sqlsrv_num_fields( $stmt ); - -while( sqlsrv_fetch( $stmt )) { - // Itération sur les champs de chaque ligne. - for($i = 0; $i < $numFields; $i++) { - echo sqlsrv_get_field($stmt, $i)." "; - } - echo "
    "; -} -?> -]]> -     -     -     - - - &reftitle.seealso; - - sqlsrv_field_metadata - sqlsrv_fetch - sqlsrv_get_field - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-num-rows.xml b/reference/sqlsrv/functions/sqlsrv-num-rows.xml deleted file mode 100644 index a92973a17b..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-num-rows.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - sqlsrv_num_rows - Récupère le nombre de lignes d'un jeu de résultats - - - &reftitle.description; - - mixedsqlsrv_num_rows - resourcestmt - - - Récupère le nombre de lignes d'un jeu de résultats. Cette fonction - nécessite que la ressource de requête ait été créée avec un curseur - statique ou keyset. Pour plus d'informations, se reporter aux fonctions - sqlsrv_query, sqlsrv_prepare, - ou au chapitre - Spécifier un type de curseur et sélectionner des lignes - dans la documentation de Microsoft SQLSRV. - - - - - &reftitle.parameters; - - - stmt - - - La requête depuis laquelle le nombre total de lignes est retourné. - La ressource de requête doit avoir été créée avec un curseur statique - ou keyset. Pour plus d'informations, se reporter aux fonctions - sqlsrv_query, sqlsrv_prepare, - ou au chapitre - Spécifier un type de curseur et sélectionner des lignes - dans la documentation de Microsoft SQLSRV. - - - - - - - - &reftitle.returnvalues; - - Retourne le nombre total de lignes récupérées en cas de succès, et - &false; si une erreur survient. Si un curseur avant (par défaut), - ou un curseur dynamique est utilisé, &false; sera retourné. - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_num_rows</function> - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $server, $connectionInfo ); - -$sql = "SELECT * FROM Table_1"; -$params = array(); -$options = array( "Scrollable" => SQLSRV_CURSOR_KEYSET ); -$stmt = sqlsrv_query( $conn, $sql , $params, $options ); - -$row_count = sqlsrv_num_rows( $stmt ); - -if ($row_count === false) - echo "Erreur lors de la récupération du nombre de lignes."; -else - echo $row_count; -?> -]]> - - - - - - &reftitle.seealso; - - sqlsrv_has_rows - sqlsrv_rows_affected - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-prepare.xml b/reference/sqlsrv/functions/sqlsrv-prepare.xml deleted file mode 100644 index 867edcb9a6..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-prepare.xml +++ /dev/null @@ -1,243 +0,0 @@ - - - - - - - sqlsrv_prepare - Prépare une requête pour exécution - - - &reftitle.description; - - mixedsqlsrv_prepare - resourceconn - stringsql - arrayparams - arrayoptions - - - Prépare une requête pour exécution. Cette fonction est idéale pour - préparer une requête qui sera exécutée plusieurs fois avec des - valeurs de paramètres différents. - - - - - &reftitle.parameters; - - - conn - - - Une ressource de connexion retournée par la fonction - sqlsrv_connect. - - - - - sql - - - La chaîne qui définit la requête à préparer et à exécuter. - - - - - params - - - Un tableau spécifiant les informations de paramètres lors de l'exécution - d'une requête contenant des paramètres. Les éléments du tableau peuvent - être n'importe lequel de ceux qui suivent : - - Une valeur littérale - Une variable PHP - Un tableau avec la structure suivante : - array($value [, $direction [, $phpType [, $sqlType]]]) - - La table suivante décrit les éléments de la structure du tableau ci-dessus : - - - Structure du tableau - - - - Élément - Description - - - - - $value - Une valeur littérale, une variable PHP ou une variable PHP passée par référence. - - - $direction (optional) - Une des constantes SQLSRV suivantes, utilisées pour indiquer la - direction du paramètre : SQLSRV_PARAM_IN, SQLSRV_PARAM_OUT, SQLSRV_PARAM_INOUT. - La valeur par défaut est SQLSRV_PARAM_IN. - - - - $phpType (optional) - Une constante SQLSRV_PHPTYPE_* qui spécifie le type de données PHP - de la valeur retournée. - - - $sqlType (optional) - Une constante SQLSRV_SQLTYPE_* qui spécifie le type de données - du serveur SQL de la valeur d'entrée. - - - -
    -     -     - - options - - - Un tableau spécifiant les options de propriétés de la requête. - Les clés supportées sont décrites dans le tableau suivant : - - - Options de la requête - - - - Clé - Valeurs - Description - - - - - QueryTimeout - Une valeur entière positive. - Définit le délai maximal d'exécution de la requête, en seconde. - Par défaut, le driver attendra indéfiniment les résultats. - - - SendStreamParamsAtExec - &true; ou &false; (par défaut, &true;) - Configure le driver pour envoyer les données du flux à l'exécution (&true;), - ou envoyer les données du flux par morceaux (&false;). Par défaut, la valeur - est définie à &true;. Pour plus d'informations, se reporter à la fonction - sqlsrv_send_stream_data. - - - Scrollable - SQLSRV_CURSOR_FORWARD, SQLSRV_CURSOR_STATIC, SQLSRV_CURSOR_DYNAMIC, - ou SQLSRV_CURSOR_KEYSET - Voir la section sur la - spécification d'un type de curseur et la sélection de lignes de la documentation - Microsoft SQLSRV. - - - -
    -     -     -     -     - - - &reftitle.returnvalues; - - Retourne une ressource de requête en cas de succès, ou &false; si une - erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_prepare</function> - - Cet exemple montre la façon de préparer une requête avec la fonction - sqlsrv_prepare et sa ré-exécution à plusieurs reprises - (avec des valeurs de paramètres différents) en utilisant la fonction - sqlsrv_execute. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "UPDATE Table_1 - SET OrderQty = ? - WHERE SalesOrderID = ?"; - -// Initialise les paramètres et prépare la requête. -// Les variables $qty et $id sont liées à la requête $stmt. -$qty = 0; $id = 0; -$stmt = sqlsrv_prepare( $conn, $sql, array( &$qty, &$id)); -if( !$stmt ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Définit les informations SalesOrderDetailID et OrderQty. -// Ce tableau lie l'ordre des IDs avec l'ordre des quantités avec des paires clé=>valeur. -$orders = array( 1=>10, 2=>20, 3=>30); - -// Exécute la requête pour chaque ordre. -foreach( $orders as $id => $qty) { - // En raison du fait que $id et $qty sont liés à $stmt1, - // leurs valeurs mises à jour sont utilisées lors de chaque exécution - // de la requête. - if( sqlsrv_execute( $stmt ) === false ) { - die( print_r( sqlsrv_errors(), true)); - } -} -?> -]]> - - - - - - &reftitle.notes; - - Lorsque l'on prépare une requête qui utilise des variables comme paramètres, - les variables sont liées à la requête. Cela signifie que si l'on met à jour - les valeurs de ces variables, la prochaine exécution de la requête prendra - en compte ces nouvelles valeurs. Pour les requêtes que l'on ne prévoit - exécuter qu'une seule fois, utiliser la fonction - sqlsrv_query. - - - - - &reftitle.seealso; - - sqlsrv_execute - sqlsrv_query - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-query.xml b/reference/sqlsrv/functions/sqlsrv-query.xml deleted file mode 100644 index 14c211c34d..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-query.xml +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - - sqlsrv_query - Prépare et exécute une requête - - - &reftitle.description; - - mixedsqlsrv_query - resourceconn - stringsql - arrayparams - arrayoptions - - - Prépare et exécute une requête. - - - - - &reftitle.parameters; - - - conn - - - Une ressource de connexion retournée par la fonction - sqlsrv_connect. - - - - - sql - - - La chaîne qui définit la requête à préparer et à exécuter. - - - - - params - - - Un tableau spécifiant les paramètres lors de l'exécution - d'une requête les autorisant. - Les éléments du tableau peuvent être n'importe lequel parmi - la liste ci-dessous : - - Une valeur littérale - Une variable PHP - Un tableau avec cette structure : - array($value [, $direction [, $phpType [, $sqlType]]]) - - La table suivante décrit les éléments dans la structure du tableau ci-dessus : - - - Structure du tableau - - - - Élément - Description - - - - - $value - Une valeur littérale, une variable PHP ou une variable PHP par référence. - - - $direction (optional) - Une des constantes SQLSRV suivantes utilisées pour indiquer la - direction du paramètre : SQLSRV_PARAM_IN, SQLSRV_PARAM_OUT, SQLSRV_PARAM_INOUT. - La valeur par défaut est SQLSRV_PARAM_IN. - - - $phpType (optional) - Une constante SQLSRV_PHPTYPE_* qui spécifie le type de données PHP - de la valeur retournée. - - - $sqlType (optional) - Une constante SQLSRV_SQLTYPE_* qui spécifie le type de données - du serveur SQL pour la valeur en entrée. - - - -
    -     -     - - options - - - Un tableau spécifiant les options de la requête. Les clés supportées sont - décrites dans le tableau suivant : - - - Options de requête - - - - Clé - Valeur - Description - - - - - QueryTimeout - Une valeur entière positive. - Définit le délai d'exécution maximal de la requête en seconde. - Par défaut, le driver attendra indéfiniment les résultats. - - - SendStreamParamsAtExec - &true; ou &false; (par défaut, vaut &true;) - Configure le driver pour envoyer tous les flux de données - à l'exécution (&true;) ou envoyer les flux de données en morceaux - (&false;). Pour plus d'informations, voir la fonction - sqlsrv_send_stream_data. - - - Scrollable - SQLSRV_CURSOR_FORWARD, SQLSRV_CURSOR_STATIC, SQLSRV_CURSOR_DYNAMIC, - ou SQLSRV_CURSOR_KEYSET - Voir le chapitre sur la - spécification d'un type de curseur et la sélection de lignes - dans la documentation Microsoft SQLSRV. - - - -
    -     -     -     -     - - - &reftitle.returnvalues; - - Retourne une ressource de requête en cas de succès, et &false; si une - erreur survient. - - - - - &reftitle.examples; - - <function>sqlsrv_query</function> example - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "INSERT INTO Table_1 (id, data) VALUES (?, ?)"; -$params = array(1, "some data"); - -$stmt = sqlsrv_query( $conn, $sql, $params); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> - - - - - - &reftitle.notes; - - Pour les requêtes que l'on ne prévoit d'exécuter qu'une seule fois, - il est recommandé d'utiliser la fonction sqlsrv_query. - Pour ré-exécuter une requête avec des valeurs différentes pour ses - paramètres, utiliser la combinaison de la fonction - sqlsrv_prepare et de la fonction sqlsrv_execute. - - - - - &reftitle.seealso; - - sqlsrv_prepare - sqlsrv_execute - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-rollback.xml b/reference/sqlsrv/functions/sqlsrv-rollback.xml deleted file mode 100644 index d183838ca9..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-rollback.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - sqlsrv_rollback - Annule une transaction qui a été commencée grâce à la fonction - sqlsrv_begin_transaction - - - &reftitle.description; - - boolsqlsrv_rollback - resourceconn - - - Annule une transaction qui a été commencée grâce à la fonction - sqlsrv_begin_transaction et retourne - la connexion en mode auto-validation. - - - - - &reftitle.parameters; - - - conn - - - La ressource de connexion retournée par un appel - à la fonction sqlsrv_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_rollback</function> - - L'exemple suivant montre la façon d'utiliser la fonction - sqlsrv_begin_transaction avec les fonctions - sqlsrv_commit et sqlsrv_rollback. - - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Commence la transaction. */ -if ( sqlsrv_begin_transaction( $conn ) === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Initialise les valeurs des paramètres. */ -$orderId = 1; $qty = 10; $productId = 100; - -/* Exécution de la première requête. */ -$sql1 = "INSERT INTO OrdersTable (ID, Quantity, ProductID) - VALUES (?, ?, ?)"; -$params1 = array( $orderId, $qty, $productId ); -$stmt1 = sqlsrv_query( $conn, $sql1, $params1 ); - -/* Exécute la seconde requête. */ -$sql2 = "UPDATE InventoryTable - SET Quantity = (Quantity - ?) - WHERE ProductID = ?"; -$params2 = array($qty, $productId); -$stmt2 = sqlsrv_query( $conn, $sql2, $params2 ); - -/* Si les deux requêtes ont été exécutées avec succès, -on valide la transaction */ -/* Sinon, on annule la transaction. */ -if( $stmt1 && $stmt2 ) { - sqlsrv_commit( $conn ); - echo "Transaction validée.
    "; -} else { - sqlsrv_rollback( $conn ); - echo "Transaction annulée.
    "; -} -?> -]]> -     -     -     - - - &reftitle.seealso; - - sqlsrv_begin_transaction - sqlsrv_commit - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-rows-affected.xml b/reference/sqlsrv/functions/sqlsrv-rows-affected.xml deleted file mode 100644 index cb76210485..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-rows-affected.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - sqlsrv_rows_affected - Retourne le nombre de lignes modifiées par la dernière requête de type - INSERT, UPDATE, ou DELETE - - - &reftitle.description; - - intfalsesqlsrv_rows_affected - resourcestmt - - - Retourne le nombre de lignes modifiées par la dernière requête de type - INSERT, UPDATE, ou DELETE. Pour plus d'informations sur le nombre - de lignes retournées par une requête SELECT, se reporter à la fonction - sqlsrv_num_rows. - - - - - &reftitle.parameters; - - - stmt - - - La ressource de requête exécutée. - - - - - - - - &reftitle.returnvalues; - - Retourne le nombre de lignes affectées par la dernière requête - INSERT, UPDATE, ou DELETE. Si aucune ligne n'est affectée, 0 sera retourné. - Si le nombre de lignes affectées ne peut être déterminé, -1 sera retourné. - Si une erreur survient, &false; sera retourné. - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_rows_affected</function> - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "UPDATE Table_1 SET data = ? WHERE id = ?"; - -$params = array("updated data", 1); - -$stmt = sqlsrv_query( $conn, $sql, $params); - -$rows_affected = sqlsrv_rows_affected( $stmt); -if( $rows_affected === false) { - die( print_r( sqlsrv_errors(), true)); -} elseif( $rows_affected == -1) { - echo "Aucune information de disponible.
    "; -} else { - echo $rows_affected." lignes ont été mises à jour.
    "; -} -?> -]]> -     -     -     - - - &reftitle.seealso; - - sqlsrv_num_rows - - -     - diff --git a/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml b/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml deleted file mode 100644 index f8b020173f..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - sqlsrv_send_stream_data - Envoie des données depuis le flux vers le serveur - - - &reftitle.description; - - boolsqlsrv_send_stream_data - resourcestmt - - - Envoie des données depuis le flux vers le serveur. Jusqu'à 8 Ko - de données sont envoyées à chaque appel. - - - - - &reftitle.parameters; - - - stmt - - - Une ressource de requête retournée par la - fonction sqlsrv_query ou - par la fonction sqlsrv_execute. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; s'il y a encore des données à - envoyer, et &false; s'il n'y en a plus. - - - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_send_stream_data</function> - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "UPDATE Table_1 SET data = ( ?) WHERE id = 100"; - -// Ouvre les données sous forme de flux et on les place dans le tableau $params. -$data = fopen( "data://text/plain,[ Lengthy content here. ]", "r"); -$params = array( &$data); - -// Prépare la requête. Utilisation du tableau $options pour désactiver -// le comportement par défaut, qui est d'envoyer toutes les données du flux -// au moment de l'exécution de la requête. -$options = array("SendStreamParamsAtExec"=>0); -$stmt = sqlsrv_prepare( $conn, $sql, $params, $options); - -sqlsrv_execute( $stmt); - -// Envoie jusqu'à 8 Ko de données au serveur -// à chaque appel à la fonction sqlsrv_send_stream_data. -$i = 1; -while( sqlsrv_send_stream_data( $stmt)) { - $i++; -} -echo "$i appels ont été effectués."; -?> -]]> - - - - - - &reftitle.seealso; - - sqlsrv_prepare - sqlsrv_query - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-server-info.xml b/reference/sqlsrv/functions/sqlsrv-server-info.xml deleted file mode 100644 index 387625d1c7..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-server-info.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - sqlsrv_server_info - Retourne des informations sur le serveur - - - &reftitle.description; - - arraysqlsrv_server_info - resourceconn - - - Retourne des informations sur le serveur. - - - - - &reftitle.parameters; - - - conn - - - La ressource de connexion qui connecte le client et le serveur. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau tel que décrit dans la table suivante : - - Tableau retourné - - - - CurrentDatabase - La base de données connectée - - - - - SQLServerVersion - La version du serveur SQL - - - SQLServerName - Le nom du serveur - - - -
    -     -     - - - &reftitle.examples; - - Exemple avec <function>sqlsrv_server_info</function> - - $value) { - echo $key.": ".$value."
    "; - } -} else { - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> -     -     -     - - - &reftitle.seealso; - - sqlsrv_client_info - - -     - diff --git a/reference/sqlsrv/ini.xml b/reference/sqlsrv/ini.xml deleted file mode 100644 index e5432afd57..0000000000 --- a/reference/sqlsrv/ini.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - -
    - &reftitle.runtime; - &extension.runtime; - - La table suivante liste les options de configuration disponibles - pour l'extension. Pour plus d'informations sur ces options, - se reporter au chapitre sur la - gestion des erreurs - et alertes SQLSRV. - - - &ConfigureOptions; SQLSRV - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - sqlsrv.WarningsReturnAsErrors - 1 (&true;) - INI_ALL - Disponible depuis SQLSRV 1.0 - - - sqlsrv.LogSubsystems - 0 - INI_ALL - Disponible depuis SQLSRV 1.0 - - - sqlsrv.LogSeverity - 1 - INI_ALL - Disponible depuis SQLSRV 1.0 - - - -
    - - -
    - diff --git a/reference/sqlsrv/reference.xml b/reference/sqlsrv/reference.xml deleted file mode 100644 index 492e33aef7..0000000000 --- a/reference/sqlsrv/reference.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - - &Functions; SQLSRV - - - - &reference.sqlsrv.entities.functions; - - - - diff --git a/reference/sqlsrv/setup.xml b/reference/sqlsrv/setup.xml deleted file mode 100644 index 7c7f1ceaea..0000000000 --- a/reference/sqlsrv/setup.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - L'extension SQLSRV peut être utilisée sur les systèmes d'exploitation suivants : - - Windows Vista Service Pack 2 ou supérieur - Windows Server 2008 Service Pack 2 ou supérieur - Windows Server 2008 R2 - Windows 7 - - - - L'extension SQLSRV requiert que le client natif Microsoft SQL Server 2012 - soit installé sur la même machine que celle qui exécute PHP. Si le client natif - Microsoft SQL Server 2012 n'est pas installé, cliquez sur le lien approprié - ci-dessous pour le télécharger : - - Téléchargement du paquet x86 - Téléchargement du paquet x64 - - - - Le téléchargement SQLSRV est livré avec 8 pilotes, dont 4 dédiés au support de PDO. - - - La version la plus récente du pilote est disponible au téléchargement ici : - téléchargement de SQLSRV. - - - Pour plus d'informations sur les pré-requis SQLSRV, se reporter au - chapitre sur les - pré-requis du système SQLSRV. - -
    - - - - &reference.sqlsrv.configure; - - - - &reference.sqlsrv.ini; - - - -
    - &reftitle.resources; -
    - Ressource de connexion - - Une ressource de connexion retournée par la fonction - sqlsrv_connect. - -
    -
    - Ressource de requête - - Une ressource de requête retournée par la fonction - sqlsrv_query ou la fonction - sqlsrv_prepare. - -
    -
    - - -     - diff --git a/reference/ssdeep/book.xml b/reference/ssdeep/book.xml deleted file mode 100644 index 1b18b1e53e..0000000000 --- a/reference/ssdeep/book.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Hachages flous ssdeep - ssdeep - - - &reftitle.intro; - - ssdeep est un utilitaire pour créer et comparer les hachages flous - appelés encore - contexte déclenché par morceaux - de hachages. - - - Le hachage flou peut faire correspondre des signatures qui ont "...des - séquences d'octets identiques, dans le même ordre, malgré le fait que les - octets entre les séquences peuvent être différents aussi bien au niveau - du contenu que de leurs longueurs" ( - page du projet ssdeep). - - - Cette extension fournit les fonctions pour créer et comparer des hachages - flous. - - - - &reference.ssdeep.setup; - - &reference.ssdeep.reference; - - - diff --git a/reference/ssdeep/configure.xml b/reference/ssdeep/configure.xml deleted file mode 100644 index dbb5a7338e..0000000000 --- a/reference/ssdeep/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;ssdeep - - -
    - diff --git a/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml b/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml deleted file mode 100644 index 931fc38044..0000000000 --- a/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - ssdeep_fuzzy_compare - Calcule le score de correspondance entre 2 signatures de hachages flous - - - - &reftitle.description; - - intssdeep_fuzzy_compare - stringsignature1 - stringsignature2 - - - Calcule le score de correspondance entre la - signature1 et la - signature2 en utilisant le - contexte déclenché par morceaux de hachages, et retourne - le score de correspondance. - - - - - - &reftitle.parameters; - - - signature1 - - - La chaîne représentant la première signature de hachage flou. - - - - - signature2 - - - La chaîne représentant la seconde signature de hachage flou. - - - - - - - - &reftitle.returnvalues; - - Retourne un entier entre 0 et 100 en cas de succès, - ou &false; si une erreur survient. - - - - - diff --git a/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml b/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml deleted file mode 100644 index b75abb7fbc..0000000000 --- a/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - ssdeep_fuzzy_hash_filename - Crée un hachage flou d'un fichier - - - - &reftitle.description; - - stringssdeep_fuzzy_hash_filename - stringfile_name - - - ssdeep_fuzzy_hash_filename calcule le hachage - d'un fichier spécifié par le paramètre file_name - en utilisant le contexte - déclenché par morceaux de hachages, et retourne le - hachage correspondant. - - - - - - &reftitle.parameters; - - - file_name - - - Le nom du fichier à hacher. - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, ou bien - &false; si une erreur survient. - - - - - diff --git a/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml b/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml deleted file mode 100644 index 37937067d4..0000000000 --- a/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - ssdeep_fuzzy_hash - Crée un hachage flou depuis une &string; - - - - &reftitle.description; - - stringssdeep_fuzzy_hash - stringto_hash - - - ssdeep_fuzzy_hash calcule le hachage de la - chaîne to_hash en utilisant le - contexte déclenché par - morceaux de hachages, et retourne le hachage correspondant. - - - - - &reftitle.parameters; - - - to_hash - - - La &string; à hacher. - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; en cas de succès, &false; sinon. - - - - - diff --git a/reference/ssdeep/reference.xml b/reference/ssdeep/reference.xml deleted file mode 100644 index a45466b394..0000000000 --- a/reference/ssdeep/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; ssdeep - - &reference.ssdeep.entities.functions; - - - - diff --git a/reference/ssdeep/setup.xml b/reference/ssdeep/setup.xml deleted file mode 100644 index e6601e28fd..0000000000 --- a/reference/ssdeep/setup.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Cette extension nécessite la bibliothèque - ssdeep. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;ssdeep. - -
    - -     - diff --git a/reference/ssh2/book.xml b/reference/ssh2/book.xml deleted file mode 100644 index 2b02b16c1a..0000000000 --- a/reference/ssh2/book.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - SSH2 (Secure Shell version 2) - SSH2 - - - - &reftitle.intro; - - La liaison à la bibliothèque libssh2 - fournit un accès à des ressources (shell, exécution distante, tunneling, transfert de fichiers) - sur une machine distante en utilisant un transport chiffré sécurisé. - - - - - &reference.ssh2.setup; - &reference.ssh2.constants; - &reference.ssh2.reference; - - - diff --git a/reference/ssh2/constants.xml b/reference/ssh2/constants.xml deleted file mode 100644 index aa26d8f0ca..0000000000 --- a/reference/ssh2/constants.xml +++ /dev/null @@ -1,269 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - SSH2_FINGERPRINT_MD5 - (int) - - - - Flag permettant à la fonction ssh2_fingerprint de - demander l'empreinte de la clé de l'hôte en tant que hash MD5. - - - - - - SSH2_FINGERPRINT_SHA1 - (int) - - - - Flag permettant à la fonction ssh2_fingerprint de - demander l'empreinte de la clé de l'hôte en tant que hash SHA1. - - - - - - SSH2_FINGERPRINT_HEX - (int) - - - - Flag permettant à la fonction ssh2_fingerprint de - demander l'empreinte de la clé de l'hôte en tant que chaîne hexits. - - - - - - SSH2_FINGERPRINT_RAW - (int) - - - - Flag permettant à la fonction ssh2_fingerprint de - demander l'empreinte de la clé de l'hôte en tant que chaîne de caractères 8-bit. - - - - - - SSH2_TERM_UNIT_CHARS - (int) - - - - Flag spécifiant à la fonction ssh2_shell que - les paramètres width et - height sont fournis sous la forme de taille de caractères. - - - - - - SSH2_TERM_UNIT_PIXELS - (int) - - - - Flag spécifiant à la fonction ssh2_shell que - les paramètres width et - height sont fournis sous la forme de pixels. - - - - - - SSH2_DEFAULT_TERM_WIDTH - (int) - - - - Largeur par défaut du terminal demandé par la fonction - ssh2_shell. - - - - - - SSH2_DEFAULT_TERM_HEIGHT - (int) - - - - Hauteur par défaut du terminal demandé par la fonction - ssh2_shell. - - - - - - SSH2_DEFAULT_TERM_UNIT - (int) - - - - Unité par défaut du terminal demandé par la fonction - ssh2_shell. - - - - - - SSH2_STREAM_STDIO - (int) - - - - Flag pour que la fonction ssh2_fetch_stream - demande un sous-canal STDIO. - - - - - - SSH2_STREAM_STDERR - (int) - - - - Flag pour que la fonction ssh2_fetch_stream - demande un sous-canal STDERR. - - - - - - SSH2_DEFAULT_TERMINAL - (string) - - - - Type par défaut du terminal (e.g. "vt102", - "ansi", "xterm", - "vanilla") - demandé par la fonction ssh2_shell. - - - - - - SSH2_POLLIN - (int) - - - - - - - - - SSH2_POLLEXT - (int) - - - - - - - - - SSH2_POLLOUT - (int) - - - - - - - - - SSH2_POLLERR - (int) - - - - - - - - - SSH2_POLLHUP - (int) - - - - - - - - - SSH2_POLLNVAL - (int) - - - - - - - - - SSH2_POLL_SESSION_CLOSED - (int) - - - - - - - - - SSH2_POLL_CHANNEL_CLOSED - (int) - - - - - - - - - SSH2_POLL_LISTENER_CLOSED - (int) - - - - - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-agent.xml b/reference/ssh2/functions/ssh2-auth-agent.xml deleted file mode 100644 index ba5614042c..0000000000 --- a/reference/ssh2/functions/ssh2-auth-agent.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - ssh2_auth_agent - Authentification SSH en utilisant l'agent ssh - - - - &reftitle.description; - - boolssh2_auth_agent - resourcesession - stringusername - - - Authentification SSH en utilisant l'agent ssh. - - - - La fonction ssh2_auth_agent n'est disponible que - lorsque l'extension ssh2 a été compilée avec libssh2 >= 1.2.3. - - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu depuis un appel à la fonction - ssh2_connect. - - - - - username - - - Nom d'utilisateur distant. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Authentification en utilisant un agent ssh - - -]]> - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml b/reference/ssh2/functions/ssh2-auth-hostbased-file.xml deleted file mode 100644 index 138f1f876d..0000000000 --- a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - ssh2_auth_hostbased_file - Identification en utilisant une clé d'hôte publique - - - - &reftitle.description; - - boolssh2_auth_hostbased_file - resourcesession - stringusername - stringhostname - stringpubkeyfile - stringprivkeyfile - stringpassphrase - stringlocal_username - - - Identification en utilisant une clé d'hôte publique lue depuis un fichier. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu via la fonction - ssh2_connect. - - - - - username - - - - - - - hostname - - - - - - - pubkeyfile - - - - - - - privkeyfile - - - - - - - passphrase - - - Si privkeyfile est chiffré (et il doit l'être), la phrase secrète doit - être fournie. - - - - - local_username - - - Si local_username est omis, alors la valeur de - username sera utilisée pour cela. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Identification en utilisant une clé d'hôte publique - -'ssh-rsa')); - -if (ssh2_auth_hostbased_file($connection, 'remoteusername', 'myhost.example.com', - '/usr/local/etc/hostkey_rsa.pub', - '/usr/local/etc/hostkey_rsa', 'secret', - 'localusername')) { - echo "Identification en utilisant une clé d'hôte publique avec succès\n"; -} else { - die('Échec de l\'identification en utilisant une clé d\'hôte publique'); -} -?> -]]> - - - - - - &reftitle.notes; - - - ssh2_auth_hostbased_file nécessite libssh2 >= 0.7 et PHP/SSH2 >= 0.7. - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-none.xml b/reference/ssh2/functions/ssh2-auth-none.xml deleted file mode 100644 index f5380a71b4..0000000000 --- a/reference/ssh2/functions/ssh2-auth-none.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - ssh2_auth_none - Identification en tant que "none" - - - - &reftitle.description; - - mixedssh2_auth_none - resourcesession - stringusername - - - Tente une identification en tant que "none", qui, habituellement, échoue - (et doit échouer). Mis à part l'échec, cette fonction doit retourner un - tableau contenant les méthodes d'identification acceptées. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu avec la fonction - ssh2_connect. - - - - - username - - - Nom d'utilisateur distant. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si le serveur accepte "none" comme méthode d'identification, - ou un tableau de méthodes d'identification acceptées en cas d'échec. - - - - - &reftitle.examples; - - Récupération de la liste des méthodes d'identification - - -]]> - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-password.xml b/reference/ssh2/functions/ssh2-auth-password.xml deleted file mode 100644 index 67f214f59a..0000000000 --- a/reference/ssh2/functions/ssh2-auth-password.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - ssh2_auth_password - Identification via SSH en utilisant un mot de passe en clair - - - - &reftitle.description; - - boolssh2_auth_password - resourcesession - stringusername - stringpassword - - - Identification via SSH en utilisant un mot de passe en clair. - Depuis la version 0.12, cette fonction supporte également la méthode - keyboard_interactive. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu depuis la fonction - ssh2_connect. - - - - - username - - - Nom d'utilisateur distant. - - - - - password - - - Mot de passe pour l'utilisateur username. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Identification avec un mot de passe - - -]]> - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml b/reference/ssh2/functions/ssh2-auth-pubkey-file.xml deleted file mode 100644 index 14f0724137..0000000000 --- a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - ssh2_auth_pubkey_file - Identification en utilisant une clé publique lue depuis un fichier - - - - &reftitle.description; - - boolssh2_auth_pubkey_file - resourcesession - stringusername - stringpubkeyfile - stringprivkeyfile - stringpassphrase - - - Identification en utilisant une clé publique, lue depuis un fichier. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu depuis la fonction - ssh2_connect. - - - - - username - - - Nom de l'utilisateur à authentifier sur le serveur distant. - - - - - pubkeyfile - - - Le fichier contenant la clé publique doit être au format - OpenSSH. Il doit ressembler à ceci : - - - ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110 - - - - - privkeyfile - - - La clé privée doit être au format PEM - - - - - passphrase - - - Si privkeyfile est chiffré (et doit l'être), - la passe-phrase doit être fournie. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Identification en utilisant une clé publique - -'ssh-rsa')); - -if (ssh2_auth_pubkey_file($connection, 'username', - '/home/username/.ssh/id_rsa.pub', - '/home/username/.ssh/id_rsa', 'secret')) { - echo "Identification réussie en utilisant une clé publique\n"; -} else { - die('Échec de l\'identification en utilisant une clé publique'); -} -?> -]]> - - - - - &reftitle.notes; - - - La bibliothèque libssh2 sous-jacente ne supporte pas très proprement les - authentifications partielles. - C'est-à-dire que si l'on doit fournir à la - fois une clé publique et un mot de passe alors cela apparaitra comme si - la fonction est en erreur. Dans ce cas particulier, une erreur sur cet - appel peut juste signifier que l'authentification n'est pas encore terminée. - Il faut ignorer cette erreur et continuer avec l'appel - ssh2_auth_password pour terminer l'authentification. - - - - - - &reftitle.seealso; - - ssh2_auth_pubkey - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-pubkey.xml b/reference/ssh2/functions/ssh2-auth-pubkey.xml deleted file mode 100644 index 92881c6f61..0000000000 --- a/reference/ssh2/functions/ssh2-auth-pubkey.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - ssh2_auth_pubkey - Identification en utilisant une clé publique depuis une variable - - - - &reftitle.description; - - boolssh2_auth_pubkey - resourcesession - stringusername - stringpubkey - stringprivkey - stringpassphrase - - - Identification en utilisant une clé publique depuis une variable. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu depuis la fonction - ssh2_connect. - - - - - username - - - Nom de l'utilisateur à authentifier sur le serveur distant. - - - - - pubkey - - - La clé publique au format OpenSSH. Elle devrait ressembler à ceci : - ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110 - - - - - privkey - - - La clé privée au format OpenSSH. Elle devrait commencer par : - -----BEGIN RSA PRIVATE KEY----- - - - - - passphrase - - - Si privkey est chiffré (et devrait l'être), - la passe-phrase doit être fournie. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Identification en utilisant une clé publique - -'ssh-rsa')); -$publicKey = file_get_contents('/home/username/.ssh/id_rsa.pub'); -$privateKey = file_get_contents('/home/username/.ssh/id_rsa'); - -if (ssh2_auth_pubkey($connection, 'username', - $publicKey, - $privateKey, 'secret')) { - echo "Identification réussie en utilisant une clé publique\n"; -} else { - die('Échec de l\'identification en utilisant une clé publique'); -} -?> -]]> - - - - - - &reftitle.notes; - - - La bibliothèque libssh2 sous-jacente ne supporte pas très proprement les - authentifications partielles. - C'est-à-dire que si l'on doit fournir à la - fois une clé publique et un mot de passe alors cela apparaitra comme si - la fonction est en erreur. Dans ce cas particulier, une erreur sur cet - appel peut juste signifier que l'authentification n'est pas encore terminée. - Il faut ignorer cette erreur et continuer avec l'appel - ssh2_auth_password pour terminer l'authentification. - - - - - - &reftitle.seealso; - - ssh2_auth_pubkey_file - - - - - diff --git a/reference/ssh2/functions/ssh2-connect.xml b/reference/ssh2/functions/ssh2-connect.xml deleted file mode 100644 index 929aac39a3..0000000000 --- a/reference/ssh2/functions/ssh2-connect.xml +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - - ssh2_connect - Connexion à un serveur SSH - - - - &reftitle.description; - - resourcefalsessh2_connect - stringhost - intport22 - arraymethods - arraycallbacks - - - Établit une connexion à un serveur SSH distant. - - - Une fois connecté, le client doit vérifier la clé hôte du serveur - en utilisant la fonction ssh2_fingerprint, - puis s'identifier en utilisant soit un mot de passe, soit une clé publique. - - - - - &reftitle.parameters; - - - host - - - - - - - port - - - - - - - methods - - - methods doit être un tableau associatif d'au plus - quatre paramètres, comme décrit ci-dessous. methods - peut contenir n'importe quel ou tous les paramètres suivants. - - - Options de connexion SSH - - - - Index - Signification - Valeurs supportées * - - - - - kex - - La liste des méthodes d'échange à annoncer, séparées par une virgule, - par ordre de préférence. - - - diffie-hellman-group1-sha1, - diffie-hellman-group14-sha1, et - diffie-hellman-group-exchange-sha1 - - - - hostkey - - La liste des méthodes de clés d'hôte à annoncer, séparées par - une virgule, par ordre de préférence. - - - ssh-rsa et - ssh-dss - - - - client_to_server - - Tableau associatif contenant les codes des méthodes de chiffrement, - de compression et de code d'authentification de message (MAC) préférés - pour l'envoi des messages depuis le client vers le serveur. - - - - - server_to_client - - Tableau associatif contenant les codes des méthodes de chiffrement, - de compression et de code d'authentification de message (MAC) préférés - pour l'envoi des messages depuis le serveur vers le client. - - - - - -
    - - * - Les valeurs supportées sont dépendantes des méthodes supportées par - la bibliothèque. Voir la documentation libssh2 - pour plus d'informations. - - - - <parameter>client_to_server</parameter> et - <parameter>server_to_client</parameter> doivent être un tableau associatif - avec n'importe quel ou tous les paramètres suivants. - - - - - Index - Signification - Valeurs supportées * - - - - - crypt - - Liste des méthodes de chiffrement à annoncer, séparées par une virgule, - par ordre de préférence. - - - rijndael-cbc@lysator.liu.se, - aes256-cbc, - aes192-cbc, - aes128-cbc, - 3des-cbc, - blowfish-cbc, - cast128-cbc, - arcfour, et - none** - - - - comp - - Liste des méthodes de compression à annoncer, séparées par une virgule, - par ordre de préférence. - - - zlib et - none - - - - mac - - Liste des méthodes MAC à annoncer, séparées par une virgule, - par ordre de préférence. - - - hmac-sha1, - hmac-sha1-96, - hmac-ripemd160, - hmac-ripemd160@openssh.com, et - none** - - - - -
    - - Chiffrement et méthode MAC "<literal>none</literal>" - - Pour des raisons de sécurité, none est désactivé par la - bibliothèque libssh2 à moins qu'il soit - activé explicitement durant la compilation en utilisant les options - appropriées du ./configure. Voir la documentation sur la bibliothèque - pour plus d'informations. - - -     -     - - callbacks - - - callbacks doit être un tableau associatif - contenant n'importe quel ou tous les paramètres suivants. - - - Paramètres de rappel - - - - - Index - Signification - Prototype - - - - - ignore - - Nom de la fonction à appeler lorsqu'un paquet - SSH2_MSG_IGNORE est reçu - - void ignore_cb($message) - - - debug - - Nom de la fonction à appeler lorsqu'un paquet - SSH2_MSG_DEBUG est reçu - - void debug_cb($message, $language, $always_display) - - - macerror - - Nom de la fonction à appeler lorsqu'un paquet est reçu mais que - le code d'authentification de message échoue. Si la fonction de rappel - retourne &true;, l'erreur sera ignorée, sinon, la connexion se terminera. - - bool macerror_cb($packet) - - - disconnect - - Nom de la fonction à appeler lorsqu'un paquet - SSH2_MSG_DISCONNECT est reçu - - void disconnect_cb($reason, $message, $language) - - - -
    -     -     -     -     -     - - - &reftitle.returnvalues; - - Retourne une ressource en cas de succès, ou &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple avec <function>ssh2_connect</function> - - Ouverture d'une connexion forçant 3des-cbc lors de l'envoi de paquets, - n'importe quel chiffrement AES lors de la réception de paquets, - aucune compression dans les deux directions, et un échange de clés Group1. - - - 'diffie-hellman-group1-sha1', - 'client_to_server' => array( - 'crypt' => '3des-cbc', - 'comp' => 'none'), - 'server_to_client' => array( - 'crypt' => 'aes256-cbc,aes192-cbc,aes128-cbc', - 'comp' => 'none')); - -$callbacks = array('disconnect' => 'my_ssh_disconnect'); - -$connection = ssh2_connect('shell.example.com', 22, $methods, $callbacks); -if (!$connection) die('Échec de la connexion'); -?> -]]> - - - - - - &reftitle.seealso; - - ssh2_fingerprint - ssh2_auth_none - ssh2_auth_password - ssh2_auth_pubkey - ssh2_auth_pubkey_file - ssh2_disconnect - - - -     - diff --git a/reference/ssh2/functions/ssh2-disconnect.xml b/reference/ssh2/functions/ssh2-disconnect.xml deleted file mode 100644 index 8a825a14be..0000000000 --- a/reference/ssh2/functions/ssh2-disconnect.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - ssh2_disconnect - Ferme une connexion à un serveur SSH distant - - - - &reftitle.description; - - boolssh2_disconnect - resourcesession - - - Ferme une connexion à un serveur SSH distant. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de lien de connexion SSH, obtenu depuis un appel - à ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-exec.xml b/reference/ssh2/functions/ssh2-exec.xml deleted file mode 100644 index ad0aaa4bc7..0000000000 --- a/reference/ssh2/functions/ssh2-exec.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - ssh2_exec - Exécute une commande sur un serveur distant - - - - &reftitle.description; - - resourcefalsessh2_exec - resourcesession - stringcommand - stringpty - arrayenv - intwidth80 - intheight25 - intwidth_height_typeSSH2_TERM_UNIT_CHARS - - - Exécute une commande sur un serveur distant. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu depuis la fonction - ssh2_connect. - - - - - command - - - - - - - pty - - - - - - - env - - - env peut être passé sous la forme d'un - tableau associatif de paires nom/valeur, à définir dans - l'environnement cible. - - - - - width - - - Largeur du terminal virtuel. - - - - - height - - - Hauteur du terminal virtuel. - - - - - width_height_type - - - width_height_type peut valoir - SSH2_TERM_UNIT_CHARS ou - SSH2_TERM_UNIT_PIXELS. - - - - - - - - &reftitle.returnvalues; - - Retourne un flux en cas de succès&return.falseforfailure;. - - - - - &reftitle.examples; - - Exécution d'une commande - - -]]> - - - - - - &reftitle.seealso; - - ssh2_connect - ssh2_shell - ssh2_tunnel - - - - - diff --git a/reference/ssh2/functions/ssh2-fetch-stream.xml b/reference/ssh2/functions/ssh2-fetch-stream.xml deleted file mode 100644 index a854273ad5..0000000000 --- a/reference/ssh2/functions/ssh2-fetch-stream.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - ssh2_fetch_stream - Parcours un flux étendu de données - - - - &reftitle.description; - - resourcessh2_fetch_stream - resourcechannel - intstreamid - - - Parcourt un sous-flux alternatif associé à un flux de canal SSH2. - Le protocole SSH2 définit actuellement un seul sous-flux, STDERR, qui a - un identifiant de sous-flux de SSH2_STREAM_STDERR (défini à 1). - - - - - &reftitle.parameters; - - - channel - - - - - - - streamid - - - Un canal de flux SSH2. - - - - - - - - &reftitle.returnvalues; - - Retourne la ressource, représentant le flux demandé. - - - - - &reftitle.examples; - - Ouverture d'un shell et récupération du flux stderr qui lui est associé - - -]]> - - - - - - &reftitle.seealso; - - ssh2_shell - ssh2_exec - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-fingerprint.xml b/reference/ssh2/functions/ssh2-fingerprint.xml deleted file mode 100644 index 481a75f0bc..0000000000 --- a/reference/ssh2/functions/ssh2-fingerprint.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - ssh2_fingerprint - Récupère l'empreinte d'un serveur distant - - - - &reftitle.description; - - stringssh2_fingerprint - resourcesession - intflagsSSH2_FINGERPRINT_MD5 | SSH2_FINGERPRINT_HEX - - - Récupère l'empreinte d'un serveur distant. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu depuis la fonction - ssh2_connect. - - - - - flags - - - flags peut être soit - SSH2_FINGERPRINT_MD5 ou - SSH2_FINGERPRINT_SHA1 associé logiquement avec - SSH2_FINGERPRINT_HEX ou - SSH2_FINGERPRINT_RAW. - - - - - - - - &reftitle.returnvalues; - - Retourne l'empreinte, sous la forme d'une &string;. - - - - - &reftitle.examples; - - Comparaison d'une empreinte à une valeur connue - - -]]> - - - - - - diff --git a/reference/ssh2/functions/ssh2-forward-accept.xml b/reference/ssh2/functions/ssh2-forward-accept.xml deleted file mode 100644 index f4364f4e4a..0000000000 --- a/reference/ssh2/functions/ssh2-forward-accept.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ssh2_forward_accept - Accepte une connexion créée par un observateur - - - - &reftitle.description; - - resourcefalsessh2_forward_accept - resourcelistener - - - Accepte une connexion créée par un observateur. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - desc - - - Un observateur SSH2, obtenu par un appel à ssh2_forward_listen. - - - - - - - - &reftitle.returnvalues; - - Renvoie une ressource de flux, &return.falseforfailure;. - - - - - diff --git a/reference/ssh2/functions/ssh2-forward-listen.xml b/reference/ssh2/functions/ssh2-forward-listen.xml deleted file mode 100644 index bbca365676..0000000000 --- a/reference/ssh2/functions/ssh2-forward-listen.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - ssh2_forward_listen - Lie un port sur le serveur distant et observe les connexions - - - - &reftitle.description; - - resourcefalsessh2_forward_listen - resourcesession - intport - stringhost - intmax_connections16 - - - Lie un port sur le serveur distant et observe les connexions. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - session - - - Une ressource de session SSH, obtenue par un appel à ssh2_connect. - - - - - port - - - Un port du serveur distant. - - - - - host - - - - - - - - max_connections - - - - - - - - - - - &reftitle.returnvalues; - - Renvoie un observateur SSH2, &return.falseforfailure;. - - - - - &reftitle.seealso; - - ssh2_forward_accept - - - - diff --git a/reference/ssh2/functions/ssh2-keepalive-config.xml b/reference/ssh2/functions/ssh2-keepalive-config.xml deleted file mode 100644 index 0155492efe..0000000000 --- a/reference/ssh2/functions/ssh2-keepalive-config.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - ssh2_keepalive_config - Configure la fréquence d'envoi des messages de maintien de connexion - - - - &reftitle.description; - - voidssh2_keepalive_config - resourcesession - boolwant_reply - intinterval - - - Configure la fréquence d'envoi des messages de maintien de connexion sur la - session fournie, et détermine si une réponse est - demandée au serveur. - - - Les messages de maintien de connexion ne sont pas envoyés automatiquement. - Une fois la configuration faite, il faut appeler - ssh2_keepalive_send pour envoyer effectivement un - message de maintien de connexion. - - - - Cette fonction n'est disponible que lorsque l'extension est compilée avec - une version de libssh2 fournissant le support du maintien de connexion. - - - - - - &reftitle.parameters; - - - session - - - Un identifiant de lien de connexion SSH, obtenu depuis un appel à - ssh2_connect. - - - - - want_reply - - - Indique si une réponse aux messages de maintien de connexion est demandée - au serveur. Demander une réponse permet de détecter un serveur qui ne - répond plus, au prix d'un trafic supplémentaire. - - - - - interval - - - Le nombre de secondes pouvant s'écouler sans aucun trafic avant qu'un - message de maintien de connexion ne soit envoyé. La valeur - 0 désactive les messages de maintien de connexion, et - la valeur 1 est traitée comme 2 par - la bibliothèque sous-jacente. - - - Les valeurs acceptées vont de 0 à - 4294967295. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Une erreur de niveau E_WARNING est émise lorsque - interval est en dehors de l'intervalle accepté ; - dans ce cas, la configuration du maintien de connexion reste inchangée. - - - - - &reftitle.examples; - - Envoi de messages de maintien de connexion - - -]]> - - - - - - &reftitle.seealso; - - ssh2_keepalive_send - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-keepalive-send.xml b/reference/ssh2/functions/ssh2-keepalive-send.xml deleted file mode 100644 index bd9a60dd9e..0000000000 --- a/reference/ssh2/functions/ssh2-keepalive-send.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - ssh2_keepalive_send - Envoie un message de maintien de connexion - - - - &reftitle.description; - - intfalsessh2_keepalive_send - resourcesession - - - Envoie un message de maintien de connexion sur la session - fournie, conformément à la configuration définie avec - ssh2_keepalive_config. - - - - Cette fonction n'est disponible que lorsque l'extension est compilée avec - une version de libssh2 fournissant le support du maintien de connexion. - - - - - - &reftitle.parameters; - - - session - - - Un identifiant de lien de connexion SSH, obtenu depuis un appel à - ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - Retourne le nombre de secondes pouvant s'écouler avant qu'un nouveau message - de maintien de connexion ne doive être envoyé, ou &false; en cas d'échec. - 0 est retourné lorsque les messages de maintien de - connexion sont désactivés. - - - 0 et &false; étant tous deux évalués à faux, l'opérateur - === doit être utilisé pour les distinguer. - - - - - &reftitle.examples; - - Envoi d'un message de maintien de connexion - - -]]> - - - - - - &reftitle.seealso; - - ssh2_keepalive_config - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-methods-negotiated.xml b/reference/ssh2/functions/ssh2-methods-negotiated.xml deleted file mode 100644 index 3343cd5dbb..0000000000 --- a/reference/ssh2/functions/ssh2-methods-negotiated.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - ssh2_methods_negotiated - Retourne une liste de méthodes négociées - - - - &reftitle.description; - - arrayssh2_methods_negotiated - resourcesession - - - Retourne une liste de méthodes négociées. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu depuis la fonction - ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - Détermine quelles méthodes ont été négociées - - -]]> - - - - - - &reftitle.seealso; - - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-poll.xml b/reference/ssh2/functions/ssh2-poll.xml deleted file mode 100644 index e3f65b2e8b..0000000000 --- a/reference/ssh2/functions/ssh2-poll.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - ssh2_poll - Questionne les canaux/observateurs/flux pour des événements - - - - &reftitle.description; - - intssh2_poll - arraydesc - inttimeout30 - - - Questionne les canaux/observateurs/flux pour des événements, - et renvoie le nombre de descripteurs qui ont renvoyé des événement non nuls. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - desc - - - Un tableau indexé de sous-tableaux avec les clés - 'resource' et 'events'. - La valeur de la ressource est un flux (de canal) ou une ressource de type SSH2 Listener. - La valeur de l'événement est un masque de bits SSH2_POLL*. - Chaque sous-tableau sera peuplé d'un élément 'revents' à la fin, - dont les valeurs sont des masques de bits SSH2_POLL* des événements qui se sont produits. - - - - - timeout - - - Le délai d'attente en secondes. - - - - - - - - &reftitle.returnvalues; - - Renvoie le nombre de descripteurs qui ont renvoyé des événements non nuls. - - - - - diff --git a/reference/ssh2/functions/ssh2-publickey-add.xml b/reference/ssh2/functions/ssh2-publickey-add.xml deleted file mode 100644 index f9d2ad00eb..0000000000 --- a/reference/ssh2/functions/ssh2-publickey-add.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - ssh2_publickey_add - Ajoute une clé publique autorisée - - - - &reftitle.description; - - boolssh2_publickey_add - resourcepkey - stringalgoname - stringblob - booloverwrite&false; - arrayattributes - - - ¬e.ssh2.subsystem.publickey; - - - - - &reftitle.parameters; - - - pkey - - - Ressource Publickey Subsystem créée par - ssh2_publickey_init. - - - - - algoname - - - Algorithme de clé publique (exemple) : ssh-dss, ssh-rsa - - - - - blob - - - Blob de clé publique comme données binaires brutes - - - - - overwrite - - - Si la clé spécifiée existe déjà, devrait-elle être écrasée ? - - - - - attributes - - - Tableau associatif d'attributs pour assigner à cette clé publique. - Se référer à ietf-secsh-publickey-subsystem pour une liste des - attributs supportés. Pour marquer un attribut comme obligatoire, - précédez son nom par un astérisque. Si le serveur n'est pas capable de - supporter un attribut marqué comme obligatoire, il abandonnera le - processus d'ajout. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ajout d'une clé publique avec <function>ssh2_publickey_add</function> - -"John's Key")); -?> -]]> - - - - - - &reftitle.seealso; - - ssh2_publickey_init - ssh2_publickey_remove - ssh2_publickey_list - - - - - diff --git a/reference/ssh2/functions/ssh2-publickey-init.xml b/reference/ssh2/functions/ssh2-publickey-init.xml deleted file mode 100644 index a28ce58700..0000000000 --- a/reference/ssh2/functions/ssh2-publickey-init.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - ssh2_publickey_init - Initialise un Publickey Subsystem (sous-système de clé publique) - - - - &reftitle.description; - - resourcefalsessh2_publickey_init - resourcesession - - - Demande le subsystem de la clé publique à partir d'un serveur SSH2 déjà - connecté. - - - Le publickey subsystem permet à un client déjà connecté et identifié de - gérer la liste des clés publiques autorisées enregistrée sur le serveur - cible dans une manière d'implémentation agnostique. Si le serveur ne - supporte pas le publickey subsystem, la fonction - ssh2_publickey_init retournera &false;. - - - - - &reftitle.parameters; - - - session - - - - - - - - - - &reftitle.returnvalues; - - Retourne une ressource SSH2 Publickey Subsystem - pour utiliser avec toutes les autres méthodes ssh2_publickey_*()&return.falseforfailure;. - - - - - &reftitle.notes; - ¬e.ssh2.subsystem.publickey; - - - - &reftitle.seealso; - - ssh2_publickey_add - ssh2_publickey_remove - ssh2_publickey_list - - - - - diff --git a/reference/ssh2/functions/ssh2-publickey-list.xml b/reference/ssh2/functions/ssh2-publickey-list.xml deleted file mode 100644 index c80a3b990b..0000000000 --- a/reference/ssh2/functions/ssh2-publickey-list.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - ssh2_publickey_list - Liste les clés publiques actuellement autorisées - - - - &reftitle.description; - - arrayssh2_publickey_list - resourcepkey - - - Liste les clés publiques actuellement autorisées. - - - - - &reftitle.parameters; - - - pkey - - - Ressource Publickey Subsystem. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau de clés indexées numériquement, chacune d'elle est un - tableau associatif contenant : nom, blob et éléments attrs. - - - Élément de clé publique - - - - Clé Tableau - Signification - - - - - name - Nom de l'algorithme utilisé par cette clé publique, par exemple : - ssh-dss ou ssh-rsa. - - - blob - Blob de clé publique comme données binaires brutes. - - - attrs - - Attributs assignés à cette clé publique. - L'attribut le plus commun et seulement celui supporté par la clé - publique version 1 des serveurs est comment, - qui peut être n'importe quelle forme de chaîne de - caractères. - - - - -
    -     - - - &reftitle.examples; - - Liste des clés autorisées avec <function>ssh2_publickey_list</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - ¬e.ssh2.subsystem.publickey; - - - - &reftitle.seealso; - - ssh2_publickey_init - ssh2_publickey_add - ssh2_publickey_remove - - - -     - diff --git a/reference/ssh2/functions/ssh2-publickey-remove.xml b/reference/ssh2/functions/ssh2-publickey-remove.xml deleted file mode 100644 index cca8e0928f..0000000000 --- a/reference/ssh2/functions/ssh2-publickey-remove.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - ssh2_publickey_remove - Supprime une clé publique autorisée - - - - &reftitle.description; - - boolssh2_publickey_remove - resourcepkey - stringalgoname - stringblob - - - Supprime une clé publique autorisée. - - - - - &reftitle.parameters; - - - pkey - - - Ressource Publickey Subsystem - - - - - algoname - - - Algorithme de clé publique (exemple) : ssh-dss, ssh-rsa - - - - - blob - - - Blob de clé publique comme données binaires brutes - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - ¬e.ssh2.subsystem.publickey; - - - - &reftitle.seealso; - - ssh2_publickey_init - ssh2_publickey_add - ssh2_publickey_list - - - - diff --git a/reference/ssh2/functions/ssh2-scp-recv.xml b/reference/ssh2/functions/ssh2-scp-recv.xml deleted file mode 100644 index 3180cd4579..0000000000 --- a/reference/ssh2/functions/ssh2-scp-recv.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - ssh2_scp_recv - Demande un fichier via SCP - - - - &reftitle.description; - - boolssh2_scp_recv - resourcesession - stringremote_file - stringlocal_file - - - Copie un fichier depuis un serveur distant vers le système de fichiers local. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu depuis la fonction - ssh2_connect. - - - - - remote_file - - - Chemin vers le fichier distant. - - - - - local_file - - - Chemin vers le fichier local. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Téléchargement d'un fichier via SCP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_scp_send - copy - - - - - diff --git a/reference/ssh2/functions/ssh2-scp-send.xml b/reference/ssh2/functions/ssh2-scp-send.xml deleted file mode 100644 index 3cfa0a6224..0000000000 --- a/reference/ssh2/functions/ssh2-scp-send.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - ssh2_scp_send - Envoie un fichier via SCP - - - - &reftitle.description; - - boolssh2_scp_send - resourcesession - stringlocal_file - stringremote_file - intcreate_mode0644 - - - Copie un fichier depuis le système de fichiers local vers un serveur distant. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu depuis la fonction - ssh2_connect. - - - - - local_file - - - Chemin vers le fichier local. - - - - - remote_file - - - Chemin vers le fichier distant. - - - - - create_mode - - - Le fichier sera créé avec le mode spécifié par - create_mode. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Chargement d'un fichier via SCP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_scp_recv - copy - - - - - diff --git a/reference/ssh2/functions/ssh2-send-eof.xml b/reference/ssh2/functions/ssh2-send-eof.xml deleted file mode 100644 index b3ab067fb5..0000000000 --- a/reference/ssh2/functions/ssh2-send-eof.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ssh2_send_eof - Envoie un EOF au flux - - - - &reftitle.description; - - boolssh2_send_eof - resourcechannel - - - Envoie un EOF au flux; c'est typiquement utilisé pour fermer l'entrée standard, - tout en gardant la sortie et les erreurs ouvertes. Par exemple, on peut envoyer - des données à un processus distant sur l'entrée standard, la fermer pour commencer - le traitement, et toujours être capable de lire les résultats sans créer de fichiers supplémentaires. - - - - - &reftitle.parameters; - - - channel - - - Un flux SSH; peut être acquis par des fonctions comme ssh2_fetch_stream - ou ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ssh2_fetch_stream - - - - - diff --git a/reference/ssh2/functions/ssh2-send-signal.xml b/reference/ssh2/functions/ssh2-send-signal.xml deleted file mode 100644 index 843253e7e3..0000000000 --- a/reference/ssh2/functions/ssh2-send-signal.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - ssh2_send_signal - Envoie un signal à un processus distant - - - - &reftitle.description; - - boolssh2_send_signal - resourcechannel - stringsignal - - - Envoie un signal au processus s'exécutant à l'extrémité distante du - channel fourni. - - - - Cette fonction n'est disponible que lorsque l'extension est compilée avec - libssh2 >= 1.9.0. - - - - - - &reftitle.parameters; - - - channel - - - Un flux de canal SSH, tel que retourné par ssh2_exec - ou ssh2_shell. - - - - - signal - - - Le nom du signal à envoyer, sans le préfixe SIG, tel - que défini par le protocole de connexion SSH - (RFC 4254) ; par exemple - TERM, KILL ou - INT. - - - La valeur est transmise telle quelle au serveur ; elle n'est pas validée - par rapport aux noms listés par le protocole. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Une erreur de niveau E_WARNING est émise lorsque - channel n'est pas un flux de canal SSH, et lorsque le - signal n'a pas pu être envoyé. - - - - - &reftitle.examples; - - Interruption d'une commande distante - - -]]> - - - - - - &reftitle.seealso; - - ssh2_exec - ssh2_shell - ssh2_send_eof - - - - - diff --git a/reference/ssh2/functions/ssh2-set-timeout.xml b/reference/ssh2/functions/ssh2-set-timeout.xml deleted file mode 100644 index 5806eea8c9..0000000000 --- a/reference/ssh2/functions/ssh2-set-timeout.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - ssh2_set_timeout - Définit le délai d'expiration des opérations bloquantes d'une session - - - - &reftitle.description; - - voidssh2_set_timeout - resourcesession - intseconds - intmicroseconds0 - - - Définit la durée pendant laquelle une opération bloquante sur la - session fournie peut attendre avant d'être considérée - comme expirée. - - - Lorsque le délai résultant vaut 0, ce qui est la valeur - par défaut, aucun délai d'expiration n'est appliqué et les opérations - bloquantes peuvent attendre indéfiniment. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de lien de connexion SSH, obtenu depuis un appel à - ssh2_connect. - - - - - seconds - - - Le délai d'expiration, en secondes. - - - - - microseconds - - - Un nombre de microsecondes supplémentaires ajouté au délai d'expiration. - La bibliothèque sous-jacente ne supporte qu'une précision à la - milliseconde, cette valeur est donc arrondie à la milliseconde entière - supérieure. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Limitation du temps d'attente des opérations bloquantes - - -]]> - - - - - - &reftitle.seealso; - - ssh2_connect - ssh2_keepalive_config - stream_set_timeout - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-chmod.xml b/reference/ssh2/functions/ssh2-sftp-chmod.xml deleted file mode 100644 index f24d39fb14..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-chmod.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - ssh2_sftp_chmod - Modifie le mode d'un fichier - - - - &reftitle.description; - - boolssh2_sftp_chmod - resourcesftp - stringfilename - intmode - - - Tente de modifier le mode du fichier spécifié, en utilisant le - mode fourni. - - - - - &reftitle.parameters; - - - sftp - - - Une ressource SSH2 SFTP, ouverte avec la fonction - ssh2_sftp. - - - - - filename - - - Chemin vers le fichier. - - - - - mode - - - Permissions sur le fichier. Voir la fonction - chmod pour plus de détails concernant - ce paramètre. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Changement du mode du fichier sur le serveur distant - - -]]> - - - - - - &reftitle.seealso; - - chmod - ssh2_sftp - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-lstat.xml b/reference/ssh2/functions/ssh2-sftp-lstat.xml deleted file mode 100644 index 051ba2cfcc..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-lstat.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - ssh2_sftp_lstat - Obtient les informations d'un lien symbolique - - - - &reftitle.description; - - arrayfalsessh2_sftp_lstat - resourcesftp - stringpath - - - Obtient les informations d'un lien symbolique sur le système - de fichiers distant sans suivre le lien. - - - Cette fonction est similaire à l'utilisation de la fonction - lstat avec le gestionnaire - ssh2.sftp:// et retourne les - mêmes valeurs. - - - - - &reftitle.parameters; - - - sftp - - - Une ressource SSH2 SFTP ouverte par ssh2_sftp. - - - - - path - - - Chemin vers le lien symbolique distant. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau de statistiques pour le lien symbolique donné en cas - de succès&return.falseforfailure;. - Voir la documentation de la fonction stat - pour les détails concernant les valeurs retournées. - - - - - &reftitle.examples; - - Obtient les informations d'un lien symbolique via SFTP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_sftp_stat - lstat - stat - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-mkdir.xml b/reference/ssh2/functions/ssh2-sftp-mkdir.xml deleted file mode 100644 index a3c54cf6f7..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-mkdir.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - ssh2_sftp_mkdir - Crée un dossier - - - - &reftitle.description; - - boolssh2_sftp_mkdir - resourcesftp - stringdirname - intmode0777 - boolrecursive&false; - - - Crée un dossier sur le système de fichiers distant. - - - Cette fonction est similaire à la fonction mkdir - avec le gestionnaire ssh2.sftp://. - - - - - &reftitle.parameters; - - - sftp - - - Une ressource SSH2 SFTP, ouverte avec la fonction - ssh2_sftp. - - - - - dirname - - - Chemin du nouveau dossier. - - - - - mode - - - Permissions du nouveau dossier. - Le mode actuel est affecté par le umask courant. - - - - - recursive - - - Si recursive vaut &true;, tous les dossiers requis - pour dirname seront également automatiquement - créés. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Création d'un dossier sur un serveur distant - - -]]> - - - - - - &reftitle.seealso; - - mkdir - ssh2_sftp_rmdir - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-readlink.xml b/reference/ssh2/functions/ssh2-sftp-readlink.xml deleted file mode 100644 index d759933986..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-readlink.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ssh2_sftp_readlink - Retourne la cible d'un lien symbolique - - - - &reftitle.description; - - stringfalsessh2_sftp_readlink - resourcesftp - stringlink - - - Retourne la cible d'un lien symbolique. - - - - - &reftitle.parameters; - - - sftp - - - Une ressource SSH2 SFTP, ouverte par la fonction ssh2_sftp. - - - - - link - - - Chemin vers le lien symbolique. - - - - - - - - &reftitle.returnvalues; - - Retourne la cible du lien symbolique link&return.falseforfailure;. - - - - - &reftitle.examples; - - Lecture d'un lien symbolique - - -]]> - - - - - - &reftitle.seealso; - - readlink - ssh2_sftp_symlink - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-realpath.xml b/reference/ssh2/functions/ssh2-sftp-realpath.xml deleted file mode 100644 index cddf659765..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-realpath.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - ssh2_sftp_realpath - Résout le chemin réel d'un chemin fourni - - - - &reftitle.description; - - stringfalsessh2_sftp_realpath - resourcesftp - stringfilename - - - Traduit un nom de fichier filename en son chemin - réellement effectif sur le système de fichiers distant. - - - - - &reftitle.parameters; - - - sftp - - - Une ressource SSH2 SFTP, ouverte par la fonction ssh2_sftp. - - - - - filename - - - - - - - - - - &reftitle.returnvalues; - - Retourne le chemin réel, sous la forme d'une &string;&return.falseforfailure;. - - - - - &reftitle.examples; - - Résoudre un nom de chemin - - -]]> - - - - - - &reftitle.seealso; - - realpath - ssh2_sftp_symlink - ssh2_sftp_readlink - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-rename.xml b/reference/ssh2/functions/ssh2-sftp-rename.xml deleted file mode 100644 index 7c8782b12b..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-rename.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - ssh2_sftp_rename - Renomme un fichier distant - - - - &reftitle.description; - - boolssh2_sftp_rename - resourcesftp - stringfrom - stringto - - - Renomme un fichier distant. - - - - - &reftitle.parameters; - - - sftp - - - Une ressource SSH2 SFTP, ouverte par la fonction ssh2_sftp. - - - - - from - - - Le fichier courant à renommer. - - - - - to - - - Le nouveau nom du fichier. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Renommer un fichier via sftp - - -]]> - - - - - - &reftitle.seealso; - - rename - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-rmdir.xml b/reference/ssh2/functions/ssh2-sftp-rmdir.xml deleted file mode 100644 index b18ccc5a64..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-rmdir.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - ssh2_sftp_rmdir - Efface un dossier - - - - &reftitle.description; - - boolssh2_sftp_rmdir - resourcesftp - stringdirname - - - Efface un dossier du système de fichiers distant. - - - Cette fonction est similaire à l'utilisation de la fonction - rmdir avec le gestionnaire - ssh2.sftp://. - - - - - &reftitle.parameters; - - - sftp - - - Une ressource SSH2 SFTP, ouverte par la fonction ssh2_sftp. - - - - - dirname - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Effacement d'un dossier sur un serveur distant - - -]]> - - - - - - &reftitle.seealso; - - rmdir - ssh2_sftp_mkdir - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-stat.xml b/reference/ssh2/functions/ssh2-sftp-stat.xml deleted file mode 100644 index a5b032baf4..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-stat.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - ssh2_sftp_stat - Lit les informations d'un fichier sur un système de fichiers distant - - - - &reftitle.description; - - arrayfalsessh2_sftp_stat - resourcesftp - stringpath - - - Lit les informations d'un fichier sur un système de fichiers distant, en suivant les liens - symboliques. - - - Cette fonction est similaire à l'utilisation de la fonction - stat avec le gestionnaire - ssh2.sftp:// et retourne les - mêmes valeurs. - - - - - &reftitle.parameters; - - - sftp - - - Une ressource SSH2 SFTP, ouverte par la fonction ssh2_sftp. - - - - - path - - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau de statistiques pour le fichier donné en cas de succès&return.falseforfailure;. - Voir la documentation de la fonction - stat pour les détails concernant les valeurs retournées. - - - - - &reftitle.examples; - - Statut d'un fichier via SFTP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_sftp_lstat - lstat - stat - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-symlink.xml b/reference/ssh2/functions/ssh2-sftp-symlink.xml deleted file mode 100644 index fe8c37be3a..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-symlink.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - ssh2_sftp_symlink - Crée un lien symbolique - - - - &reftitle.description; - - boolssh2_sftp_symlink - resourcesftp - stringtarget - stringlink - - - Crée un lien symbolique sur le système de fichiers distant. - - - - - &reftitle.parameters; - - - sftp - - - Une ressource SSH2 SFTP, ouverte par la fonction ssh2_sftp. - - - - - target - - - Cible du lien symbolique. - - - - - link - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Création d'un lien symbolique - - -]]> - - - - - - &reftitle.seealso; - - ssh2_sftp_readlink - symlink - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-unlink.xml b/reference/ssh2/functions/ssh2-sftp-unlink.xml deleted file mode 100644 index 29e0a8e20c..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-unlink.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - ssh2_sftp_unlink - Efface un fichier - - - - &reftitle.description; - - boolssh2_sftp_unlink - resourcesftp - stringfilename - - - Efface un fichier sur le système de fichiers distant. - - - - - &reftitle.parameters; - - - sftp - - - Une ressource SSH2 SFTP, ouverte par la fonction ssh2_sftp. - - - - - filename - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Effacement d'un fichier - - -]]> - - - - - - &reftitle.seealso; - - unlink - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp.xml b/reference/ssh2/functions/ssh2-sftp.xml deleted file mode 100644 index 6d7f56f279..0000000000 --- a/reference/ssh2/functions/ssh2-sftp.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - ssh2_sftp - Initialise un sous-système SFTP - - - - &reftitle.description; - - resourcefalsessh2_sftp - resourcesession - - - Demande un sous-système SFTP depuis un serveur déjà connecté SSH2. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu depuis la fonction - ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - Cette méthode retourne une ressource SSH2 SFTP - pour utilisation avec toutes les méthodes ssh2_sftp_*() - ainsi que le gestionnaire ouvert - ssh2.sftp://, - &return.falseforfailure;. - - - - - &reftitle.examples; - - Ouverture d'un fichier via SFTP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_scp_recv - ssh2_scp_send - - - - - diff --git a/reference/ssh2/functions/ssh2-shell-resize.xml b/reference/ssh2/functions/ssh2-shell-resize.xml deleted file mode 100644 index 9719036a9a..0000000000 --- a/reference/ssh2/functions/ssh2-shell-resize.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - ssh2_shell_resize - Change les dimensions du pseudo-terminal d'un canal - - - - &reftitle.description; - - boolssh2_shell_resize - resourcechannel - intwidth - intheight - intwidth_px0 - intheight_px0 - - - Demande que le pseudo-terminal (PTY) attaché au channel - fourni soit redimensionné aux dimensions données. - - - - L'extension ne déclare que les trois premiers paramètres, avec le nom - session pour channel. Par - conséquent, width_px et - height_px ne peuvent être fournis que - positionnellement. - - - - - - &reftitle.parameters; - - - channel - - - Un flux de canal SSH, tel que retourné par ssh2_exec - ou ssh2_shell. - - - - - width - - - La largeur du terminal, en caractères. - - - - - height - - - La hauteur du terminal, en caractères. - - - - - width_px - - - La largeur du terminal en pixels, ou 0 pour laisser - les dimensions en pixels non spécifiées. - - - - - height_px - - - La hauteur du terminal en pixels, ou 0 pour laisser - les dimensions en pixels non spécifiées. - - - - - - - - &reftitle.returnvalues; - - Retourne &true;, ou &false; lorsque channel n'est pas - un flux de canal SSH. - - - Le résultat de la demande de redimensionnement elle-même n'est pas rapporté: - &true; est retourné même lorsque l'extrémité distante ne l'honore pas. - - - - - &reftitle.errors; - - Une erreur de niveau E_WARNING est émise lorsque - channel n'est pas un flux de canal SSH. - - - - - &reftitle.examples; - - Redimensionnement du pseudo-terminal d'un shell - - -]]> - - - - - - &reftitle.seealso; - - ssh2_shell - ssh2_exec - - - - - diff --git a/reference/ssh2/functions/ssh2-shell.xml b/reference/ssh2/functions/ssh2-shell.xml deleted file mode 100644 index 22be11e261..0000000000 --- a/reference/ssh2/functions/ssh2-shell.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - ssh2_shell - Demande un shell interactif - - - - &reftitle.description; - - resourcefalsessh2_shell - resourcesession - stringtermtype"vanilla" - arraynullenv&null; - intwidth80 - intheight25 - intwidth_height_typeSSH2_TERM_UNIT_CHARS - - - Ouvre un shell sur le serveur distant et lui alloue un flux. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu depuis la fonction - ssh2_connect. - - - - - termtype - - - termtype doit correspondre à une - des entrées du fichier /etc/termcap du système cible. - - - - - env - - - env doit être passé en tant qu'un tableau associatif - de paires nom/valeur à définir dans l'environnement cible. - - - - - width - - - Largeur du terminal virtuel. - - - - - height - - - Hauteur du terminal virtuel. - - - - - width_height_type - - - width_height_type doit être soit - SSH2_TERM_UNIT_CHARS, soit - SSH2_TERM_UNIT_PIXELS. - - - - - - - - &reftitle.returnvalues; - - Retourne un flux de &resource; en cas de succès, &return.falseforfailure;. - - - - - &reftitle.examples; - - Demande d'un shell interactif - - -]]> - - - - - - &reftitle.seealso; - - ssh2_exec - ssh2_tunnel - ssh2_fetch_stream - - - - - diff --git a/reference/ssh2/functions/ssh2-tunnel.xml b/reference/ssh2/functions/ssh2-tunnel.xml deleted file mode 100644 index 6ec12e0eb8..0000000000 --- a/reference/ssh2/functions/ssh2-tunnel.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - ssh2_tunnel - Ouvre un tunnel à travers un serveur distant - - - - &reftitle.description; - - resourcessh2_tunnel - resourcesession - stringhost - intport - - - Ouvre un socket vers un hôte/port arbitraire - via un serveur connecté SSH. - - - - - &reftitle.parameters; - - - session - - - Un identifiant de connexion SSH, obtenu depuis la fonction - ssh2_connect. - - - - - host - - - - - - - port - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - Ouverture d'un tunnel sur un hôte arbitraire - - -]]> - - - - - - &reftitle.seealso; - - ssh2_connect - fsockopen - - - - - diff --git a/reference/ssh2/installation.xml b/reference/ssh2/installation.xml deleted file mode 100644 index 50d2ea6ed4..0000000000 --- a/reference/ssh2/installation.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;ssh2. - - - &pecl.windows.download.avail; - - -
    - diff --git a/reference/ssh2/reference.xml b/reference/ssh2/reference.xml deleted file mode 100644 index 6fccff9c20..0000000000 --- a/reference/ssh2/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; SSH2 - - &reference.ssh2.entities.functions; - - - - diff --git a/reference/ssh2/setup.xml b/reference/ssh2/setup.xml deleted file mode 100644 index 33a2333456..0000000000 --- a/reference/ssh2/setup.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Les bibliothèques - OpenSSL et - libssh2 sont nécessaires. - Il faut s'assurer que les bibliothèques de développement sont installées ; - typiquement, le nom du paquet est openssl-dev. - - - La version 1.2 ou supérieure de la bibliothèque libssh2 est requise, - mais il est possible que les nouvelles versions de pecl/ssh2 puissent - nécessiter des versions encore plus récentes (voir les notes de versions). - - - La fonction ssh2_auth_agent ne sera disponible qu'avec - libssh2 >= 1.2.3. - - - Le support de la fonction stream_set_timeout - pour les flux d'un canal ne sera disponible qu'avec libssh2 >= 1.2.9. - - - Libssh2 peut contenir deux versions : gcrypt ou openssl. - Quelques distributions Linux compilent libssh2 avec la bibliothèque - gcrypt, alors que d'autres utilisent openssl. Libssh2 comporte - quelques bogues lorsqu'elle est compilée avec gcrypt, aussi, il est conseillé - d'utiliser openssl. - -
    - - - - &reference.ssh2.installation; - - - -
    - &reftitle.resources; - - Cette extension définit les types de ressources suivants : - - SSH2 Session - SSH2 Listener - SSH2 SFTP - SSH2 Publickey Subsystem (à partir de ssh2 0.10) - - -
    - - -     - diff --git a/reference/stats/book.xml b/reference/stats/book.xml deleted file mode 100644 index 4a02bee987..0000000000 --- a/reference/stats/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - Statistics - - - - &reftitle.intro; - - &warn.pecl.unmaintained; - Ceci est l'extension statistique. Elle contient quelques dizaines de fonctions - utiles pour les calculs statistiques. C'est une enveloppe autour de 2 bibliothèques - scientifiques à savoir DCDFLIB (Library of C routines for Cumulative - Distributions Functions, Inverses, and Other parameters) par B. Brown & - J. Lavato et RANDLIB par Barry Brown, James Lavato & Kathy Russell. - Inclut les fonctions CD et PD. - - - - - &reference.stats.setup; - &reference.stats.reference; - - - - diff --git a/reference/stats/functions/stats-absolute-deviation.xml b/reference/stats/functions/stats-absolute-deviation.xml deleted file mode 100644 index 663808ff4f..0000000000 --- a/reference/stats/functions/stats-absolute-deviation.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_absolute_deviation - Renvoie l'écart absolu d'un tableau de valeurs - - - &reftitle.description; - - floatstats_absolute_deviation - arraya - - - Renvoie l'écart absolu des valeurs dans a. - - - - &reftitle.parameters; - - - - a - - - Le tableau d'entrée - - - - - - - - - &reftitle.returnvalues; - - Renvoie l'écart absolu des valeurs dans a, - ou &false; si a est vide ou n'est pas un tableau. - - - - - - diff --git a/reference/stats/functions/stats-cdf-beta.xml b/reference/stats/functions/stats-cdf-beta.xml deleted file mode 100644 index b62720821e..0000000000 --- a/reference/stats/functions/stats-cdf-beta.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_beta - Calcule un paramètre de la distribution beta en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_beta - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution beta. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, alpha, et beta désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - et les paramètres de forme de la distribution beta, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - - - - - 1 - CDF - x - alpha - beta - - - 2 - x - CDF - alpha - beta - - - 3 - alpha - x - CDF - beta - - - 4 - beta - x - CDF - alpha - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, alpha, ou beta, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-binomial.xml b/reference/stats/functions/stats-cdf-binomial.xml deleted file mode 100644 index 5c99fd742c..0000000000 --- a/reference/stats/functions/stats-cdf-binomial.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_binomial - Calcule un paramètre de la distribution binomiale en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_binomial - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution binomiale. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, n, et p désignent la fonction de distribution cumulative, le nombre de succès, - le nombre d'essais, et le taux de succès pour chaque essai, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - - - - - 1 - CDF - x - n - p - - - 2 - x - CDF - n - p - - - 3 - n - x - CDF - p - - - 4 - p - x - CDF - n - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, n, ou p, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-cauchy.xml b/reference/stats/functions/stats-cdf-cauchy.xml deleted file mode 100644 index e0a05d03cd..0000000000 --- a/reference/stats/functions/stats-cdf-cauchy.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_cauchy - Calcule un paramètre de la distribution de Cauchy en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_cauchy - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution de Cauchy. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, x0, et gamma désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - le paramètre de localisation et le paramètre d'échelle de la distribution de Cauchy, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - - - - - 1 - CDF - x - x0 - gamma - - - 2 - x - CDF - x0 - gamma - - - 3 - x0 - x - CDF - gamma - - - 4 - gamma - x - CDF - x0 - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, x0, ou gamma, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-chisquare.xml b/reference/stats/functions/stats-cdf-chisquare.xml deleted file mode 100644 index c7b7063f7f..0000000000 --- a/reference/stats/functions/stats-cdf-chisquare.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - stats_cdf_chisquare - Calcule un paramètre de la distribution du chi-deux en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_chisquare - floatpar1 - floatpar2 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution du chi-deux. Le type de la valeur de retour et les paramètres (par1 - et par2) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, et k désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - et le degré de liberté de la distribution du chi-deux, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - - - - - 1 - CDF - x - k - - - 2 - x - CDF - k - - - 3 - k - x - CDF - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, ou k, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-exponential.xml b/reference/stats/functions/stats-cdf-exponential.xml deleted file mode 100644 index 75c2f30611..0000000000 --- a/reference/stats/functions/stats-cdf-exponential.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - stats_cdf_exponential - Calcule un paramètre de la distribution exponentielle en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_exponential - floatpar1 - floatpar2 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution exponentielle. Le type de la valeur de retour et les paramètres (par1 - et par2) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, et lambda désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - et le paramètre de taux de la distribution exponentielle, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - - - - - 1 - CDF - x - lambda - - - 2 - x - CDF - lambda - - - 3 - lambda - x - CDF - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, ou lambda, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-f.xml b/reference/stats/functions/stats-cdf-f.xml deleted file mode 100644 index d7a6301c23..0000000000 --- a/reference/stats/functions/stats-cdf-f.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_f - Calcule un paramètre de la distribution F en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_f - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution F. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, d1, et d2 désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - et les degrés de liberté de la distribution F, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - - - - - 1 - CDF - x - d1 - d2 - - - 2 - x - CDF - d1 - d2 - - - 3 - d1 - x - CDF - d2 - - - 4 - d2 - x - CDF - d1 - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, d1, ou d2, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-gamma.xml b/reference/stats/functions/stats-cdf-gamma.xml deleted file mode 100644 index 5f68036197..0000000000 --- a/reference/stats/functions/stats-cdf-gamma.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_gamma - Calcule un paramètre de la distribution gamma en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_gamma - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution gamma. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, k, et theta désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - et les paramètres de forme et d'échelle de la distribution gamma, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - - - - - 1 - CDF - x - k - theta - - - 2 - x - CDF - k - theta - - - 3 - k - x - CDF - theta - - - 4 - theta - x - CDF - k - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, k, ou theta, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-laplace.xml b/reference/stats/functions/stats-cdf-laplace.xml deleted file mode 100644 index d63538c727..0000000000 --- a/reference/stats/functions/stats-cdf-laplace.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_laplace - Calcule un paramètre de la distribution de Laplace en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_laplace - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution de Laplace. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, mu, et b désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - et les paramètres de localisation et d'échelle de la distribution de Laplace, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - - - - - 1 - CDF - x - mu - b - - - 2 - x - CDF - mu - b - - - 3 - mu - x - CDF - b - - - 4 - b - x - CDF - mu - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, mu, ou b, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-logistic.xml b/reference/stats/functions/stats-cdf-logistic.xml deleted file mode 100644 index 81ae079cf1..0000000000 --- a/reference/stats/functions/stats-cdf-logistic.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_logistic - Calcule un paramètre de la distribution logistique en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_logistic - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution logistique. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, mu, et s désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - et les paramètres de localisation et d'échelle de la distribution logistique, respectivement. - - Valeur de retour et paramètres - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - mu - s - - - 2 - x - CDF - mu - s - - - 3 - mu - x - CDF - s - - - 4 - s - x - CDF - mu - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, mu, ou s, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-negative-binomial.xml b/reference/stats/functions/stats-cdf-negative-binomial.xml deleted file mode 100644 index 1580b3b886..0000000000 --- a/reference/stats/functions/stats-cdf-negative-binomial.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_negative_binomial - Calcule un paramètre de la distribution binomiale négative en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_negative_binomial - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution binomiale négative. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, r, et p désignent la fonction de distribution cumulative, le nombre d'échecs, le nombre de succès, - et le taux de succès pour chaque essai, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - - - - - 1 - CDF - x - r - p - - - 2 - x - CDF - r - p - - - 3 - r - x - CDF - p - - - 4 - p - x - CDF - r - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, r, ou p, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-noncentral-chisquare.xml b/reference/stats/functions/stats-cdf-noncentral-chisquare.xml deleted file mode 100644 index c18160375b..0000000000 --- a/reference/stats/functions/stats-cdf-noncentral-chisquare.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_noncentral_chisquare - Calcule un paramètre de la distribution du chi-deux non-centrale en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_noncentral_chisquare - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution du chi-deux non-centrale. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, k, et lambda désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - le degré de liberté et le paramètre de non-centralité de la distribution du chi-deux non-centrale, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - - - - - 1 - CDF - x - k - lambda - - - 2 - x - CDF - k - lambda - - - 3 - k - x - CDF - lambda - - - 4 - lambda - x - CDF - k - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, k, ou lambda, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-noncentral-f.xml b/reference/stats/functions/stats-cdf-noncentral-f.xml deleted file mode 100644 index aafe29e392..0000000000 --- a/reference/stats/functions/stats-cdf-noncentral-f.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - stats_cdf_noncentral_f - Calcule un paramètre de la distribution F non-centrale en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_noncentral_f - floatpar1 - floatpar2 - floatpar3 - floatpar4 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution F non-centrale. Le type de la valeur de retour et les paramètres (par1, - par2, par3, et par4) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, nu1, nu2, et lambda désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - les degrés de liberté et le paramètre de non-centralité de la distribution F non-centrale, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - par4 - - - - - 1 - CDF - x - nu1 - nu2 - lambda - - - 2 - x - CDF - nu1 - nu2 - lambda - - - 3 - nu1 - x - CDF - nu2 - lambda - - - 4 - nu2 - x - CDF - nu1 - lambda - - - 5 - lambda - x - CDF - nu1 - nu2 - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - par4 - - - Le quatrième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, nu1, nu2, ou lambda, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-noncentral-t.xml b/reference/stats/functions/stats-cdf-noncentral-t.xml deleted file mode 100644 index dfd4f8cbda..0000000000 --- a/reference/stats/functions/stats-cdf-noncentral-t.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - stats_cdf_noncentral_t - Calcule un paramètre de la distribution t non-centrale en fonction des autres valeurs - - - - &reftitle.description; - - floatstats_cdf_noncentral_t - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution t non-centrale. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, nu, et mu désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - les degrés de liberté et le paramètre de non-centralité de la distribution, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - - - - - 1 - CDF - x - nu - mu - - - 2 - x - CDF - nu - mu - - - 3 - nu - x - CDF - mu - - - 4 - mu - x - CDF - nu - - - -
    -     -     - - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, nu, ou mu, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-normal.xml b/reference/stats/functions/stats-cdf-normal.xml deleted file mode 100644 index d4b93acdff..0000000000 --- a/reference/stats/functions/stats-cdf-normal.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - stats_cdf_normal - Calcule un paramètre de la distribution normale en fonction des autres valeurs - - - - &reftitle.description; - - floatstats_cdf_normal - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution normale. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, mu, et sigma désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - la moyenne et l'écart-type de la distribution normale, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - - - - - 1 - CDF - x - mu - sigma - - - 2 - x - CDF - mu - sigma - - - 3 - mu - x - CDF - sigma - - - 4 - sigma - x - CDF - mu - - - -
    -     -     - - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, mu, ou sigma, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-poisson.xml b/reference/stats/functions/stats-cdf-poisson.xml deleted file mode 100644 index c6a4a1ab0d..0000000000 --- a/reference/stats/functions/stats-cdf-poisson.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - stats_cdf_poisson - Calcule un paramètre de la distribution de Poisson en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_poisson - floatpar1 - floatpar2 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, de la distribution de Poisson. - Le type de la valeur de retour et les paramètres (par1 et par2) sont - déterminés par which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, et lambda désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - et le paramètre de la distribution de Poisson, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - - - - - 1 - CDF - x - lambda - - - 2 - x - CDF - lambda - - - 3 - lambda - x - CDF - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, ou lambda, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-t.xml b/reference/stats/functions/stats-cdf-t.xml deleted file mode 100644 index 0ab2d63085..0000000000 --- a/reference/stats/functions/stats-cdf-t.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - stats_cdf_t - Calcule un paramètre de la distribution t en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_t - floatpar1 - floatpar2 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution t. Le type de la valeur de retour et les paramètres (par1 - et par2) sont déterminés par which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, et nu désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - et les degrés de liberté de la distribution t, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - - - - - 1 - CDF - x - nu - - - 2 - x - CDF - nu - - - 3 - nu - x - CDF - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, ou nu, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-uniform.xml b/reference/stats/functions/stats-cdf-uniform.xml deleted file mode 100644 index 61f48c182c..0000000000 --- a/reference/stats/functions/stats-cdf-uniform.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_uniform - Calcule un paramètre de la distribution uniforme en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_uniform - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution uniforme. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, a, et b désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - et les bornes inférieure et supérieure de la distribution uniforme, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - - - - - 1 - CDF - x - a - b - - - 2 - x - CDF - a - b - - - 3 - a - x - CDF - b - - - 4 - b - x - CDF - a - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, a, ou b, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-cdf-weibull.xml b/reference/stats/functions/stats-cdf-weibull.xml deleted file mode 100644 index 0f0c69ad63..0000000000 --- a/reference/stats/functions/stats-cdf-weibull.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_weibull - Calcule un paramètre de la distribution de Weibull en fonction des autres valeurs - - - &reftitle.description; - - floatstats_cdf_weibull - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Renvoie la fonction de distribution cumulative, son inverse, ou un des paramètres, - de la distribution de Weibull. Le type de la valeur de retour et les paramètres (par1, - par2, et par3) sont déterminés par - which. - - - La table suivante liste la valeur de retour et les paramètres par which. - CDF, x, k, et lambda désignent la fonction de distribution cumulative, la valeur de la variable aléatoire, - et les paramètres de forme et d'échelle de la distribution de Weibull, respectivement. - - Valeur de retour et paramètres - - - - which - Valeur de retour - par1 - par2 - par3 - - - - - 1 - CDF - x - k - lambda - - - 2 - x - CDF - k - lambda - - - 3 - k - x - CDF - lambda - - - 4 - lambda - x - CDF - k - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - Le premier paramètre - - - - - par2 - - - Le second paramètre - - - - - par3 - - - Le troisième paramètre - - - - - which - - - Le drapeau pour déterminer ce qui doit être calculé - - - - - - - - - &reftitle.returnvalues; - - Renvoie CDF, x, k, ou lambda, déterminé par which. - - - -     - - diff --git a/reference/stats/functions/stats-covariance.xml b/reference/stats/functions/stats-covariance.xml deleted file mode 100644 index bd08399f3b..0000000000 --- a/reference/stats/functions/stats-covariance.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_covariance - Calcule la covariance de deux ensembles de données - - - &reftitle.description; - - floatstats_covariance - arraya - arrayb - - - Renvoie la covariance de a et b. - - - - &reftitle.parameters; - - - - a - - - Le premier tableau - - - - - b - - - Le second tableau - - - - - - - - - &reftitle.returnvalues; - - Renvoie la covariance de a et b, - ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-beta.xml b/reference/stats/functions/stats-dens-beta.xml deleted file mode 100644 index 4205e21550..0000000000 --- a/reference/stats/functions/stats-dens-beta.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - stats_dens_beta - La fonction de densité de probabilité de la distribution bêta - - - &reftitle.description; - - floatstats_dens_beta - floatx - floata - floatb - - - Renvoie la densité de probabilité à x, où la - variable aléatoire suit la distribution bêta dont les paramètres de forme - sont a et b. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la densité de probabilité est calculée - - - - - a - - - Le paramètre de forme de la distribution - - - - - b - - - Le paramètre de forme de la distribution - - - - - - - - - &reftitle.returnvalues; - - La densité de probabilité à x ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-cauchy.xml b/reference/stats/functions/stats-dens-cauchy.xml deleted file mode 100644 index 1eef05e0bf..0000000000 --- a/reference/stats/functions/stats-dens-cauchy.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - stats_dens_cauchy - La fonction de densité de probabilité de la distribution de Cauchy - - - &reftitle.description; - - floatstats_dens_cauchy - floatx - floatave - floatstdev - - - Renvoie la densité de probabilité à x, où la - variable aléatoire suit la distribution de Cauchy dont les paramètres de - location et d'échelle sont ave et stdev. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la densité de probabilité est calculée - - - - - ave - - - Le paramètre de localisation de la distribution - - - - - stdev - - - Le paramètre d'échelle de la distribution - - - - - - - - - &reftitle.returnvalues; - - La densité de probabilité à x ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-chisquare.xml b/reference/stats/functions/stats-dens-chisquare.xml deleted file mode 100644 index 7d4daf65d2..0000000000 --- a/reference/stats/functions/stats-dens-chisquare.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - stats_dens_chisquare - La fonction de densité de probabilité de la distribution du chi-carré - - - &reftitle.description; - - floatstats_dens_chisquare - floatx - floatdfr - - - Renvoie la densité de probabilité à x, où la - variable aléatoire suit la distribution du chi-carré dont le degré de - liberté est dfr. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la densité de probabilité est calculée - - - - - dfr - - - Le degré de liberté de la distribution - - - - - - - - - &reftitle.returnvalues; - - La densité de probabilité à x ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-exponential.xml b/reference/stats/functions/stats-dens-exponential.xml deleted file mode 100644 index 6a0081eca9..0000000000 --- a/reference/stats/functions/stats-dens-exponential.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - stats_dens_exponential - La fonction de densité de probabilité de la distribution exponentielle - - - &reftitle.description; - - floatstats_dens_exponential - floatx - floatscale - - - Renvoie la densité de probabilité à x, où la - variable aléatoire suit la distribution exponentielle dont l'échelle est - scale. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la densité de probabilité est calculée - - - - - scale - - - L'échelle de la distribution - - - - - - - - - &reftitle.returnvalues; - - La densité de probabilité à x ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-f.xml b/reference/stats/functions/stats-dens-f.xml deleted file mode 100644 index d2e91782e4..0000000000 --- a/reference/stats/functions/stats-dens-f.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - stats_dens_f - La fonction de densité de probabilité de la distribution F - - - &reftitle.description; - - floatstats_dens_f - floatx - floatdfr1 - floatdfr2 - - - Renvoie la densité de probabilité à x, où la - variable aléatoire suit la distribution F dont les degrés de liberté sont - dfr1 et dfr2. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la densité de probabilité est calculée - - - - - dfr1 - - - Le degré de liberté de la distribution - - - - - dfr2 - - - Le degré de liberté de la distribution - - - - - - - - - &reftitle.returnvalues; - - La densité de probabilité à x ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-gamma.xml b/reference/stats/functions/stats-dens-gamma.xml deleted file mode 100644 index 2d5101dc59..0000000000 --- a/reference/stats/functions/stats-dens-gamma.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - stats_dens_gamma - La fonction de densité de probabilité de la distribution gamma - - - &reftitle.description; - - floatstats_dens_gamma - floatx - floatshape - floatscale - - - Renvoie la densité de probabilité à x, où la - variable aléatoire suit la distribution gamma dont le paramètre de forme - est shape et le paramètre d'échelle est scale. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la densité de probabilité est calculée - - - - - shape - - - Le paramètre de forme de la distribution - - - - - scale - - - Le paramètre d'échelle de la distribution - - - - - - - - - &reftitle.returnvalues; - - La densité de probabilité à x ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-laplace.xml b/reference/stats/functions/stats-dens-laplace.xml deleted file mode 100644 index 829908f73e..0000000000 --- a/reference/stats/functions/stats-dens-laplace.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - stats_dens_laplace - La fonction de densité de probabilité de la distribution de Laplace - - - &reftitle.description; - - floatstats_dens_laplace - floatx - floatave - floatstdev - - - Renvoie la densité de probabilité à x, où la - variable aléatoire suit la distribution de Laplace dont le paramètre de - localisation est ave et le paramètre d'échelle est - stdev. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la densité de probabilité est calculée - - - - - ave - - - Le paramètre de localisation de la distribution - - - - - stdev - - - Le paramètre d'échelle de la distribution - - - - - - - - - &reftitle.returnvalues; - - La densité de probabilité à x ou &false; en cas d'échec. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-logistic.xml b/reference/stats/functions/stats-dens-logistic.xml deleted file mode 100644 index 8c122adbc5..0000000000 --- a/reference/stats/functions/stats-dens-logistic.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - stats_dens_logistic - La fonction de densité de probabilité de la distribution logistique - - - &reftitle.description; - - floatstats_dens_logistic - floatx - floatave - floatstdev - - - Renvoie la densité de probabilité à x, où la - variable aléatoire suit la distribution logistique dont le paramètre de - localisation est ave et le paramètre d'échelle est - stdev. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la densité de probabilité est calculée - - - - - ave - - - Le paramètre de localisation de la distribution - - - - - stdev - - - Le paramètre d'échelle de la distribution - - - - - - - - - &reftitle.returnvalues; - - La densité de probabilité à x ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-normal.xml b/reference/stats/functions/stats-dens-normal.xml deleted file mode 100644 index ad7f0897f2..0000000000 --- a/reference/stats/functions/stats-dens-normal.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - stats_dens_normal - La fonction de densité de probabilité de la distribution normale - - - &reftitle.description; - - floatstats_dens_normal - floatx - floatave - floatstdev - - - Renvoie la densité de probabilité à x, où la - variable aléatoire suit la distribution normale dont la moyenne est - ave et l'écart-type est - stdev. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la densité de probabilité est calculée - - - - - ave - - - La moyenne de la distribution - - - - - stdev - - - La déviation standard de la distribution - - - - - - - - - &reftitle.returnvalues; - - La densité de probabilité à x ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-binomial.xml b/reference/stats/functions/stats-dens-pmf-binomial.xml deleted file mode 100644 index cbfc8f3716..0000000000 --- a/reference/stats/functions/stats-dens-pmf-binomial.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - stats_dens_pmf_binomial - La fonction de masse de probabilité de la distribution binomiale - - - &reftitle.description; - - floatstats_dens_pmf_binomial - floatx - floatn - floatpi - - - Renvoie la masse de probabilité à x, où la variable aléatoire - suit la distribution binomiale dont le nombre d'essais est n - et le taux de succès est pi. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la masse de probabilité est calculée - - - - - n - - - Le nombre d'essais de la distribution - - - - - pi - - - Le taux de succès de la distribution - - - - - - - - - &reftitle.returnvalues; - - La masse de probabilité à x ou &false; en cas d'échec. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-hypergeometric.xml b/reference/stats/functions/stats-dens-pmf-hypergeometric.xml deleted file mode 100644 index f02f8e9661..0000000000 --- a/reference/stats/functions/stats-dens-pmf-hypergeometric.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - stats_dens_pmf_hypergeometric - La fonction de masse de probabilité de la distribution hypergéométrique - - - &reftitle.description; - - floatstats_dens_pmf_hypergeometric - floatn1 - floatn2 - floatN1 - floatN2 - - - Renvoie la masse de probabilité à n1, où la variable aléatoire - suit la distribution hypergéométrique dont le nombre d'échecs est - n2, le nombre d'échantillons de succès est N1, - et le nombre d'échantillons d'échecs est N2. - - - - &reftitle.parameters; - - - - n1 - - - Le nombre de succès, à partir duquel la masse de probabilité est calculée - - - - - n2 - - - Le nombre d'échecs de la distribution - - - - - N1 - - - Le nombre d'échantillons de succès de la distribution - - - - - N2 - - - Le nombre d'échantillons d'échecs de la distribution - - - - - - - - - &reftitle.returnvalues; - - La masse de probabilité à n1 ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-negative-binomial.xml b/reference/stats/functions/stats-dens-pmf-negative-binomial.xml deleted file mode 100644 index 41901dcd2b..0000000000 --- a/reference/stats/functions/stats-dens-pmf-negative-binomial.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - stats_dens_pmf_negative_binomial - La fonction de masse de probabilité de la distribution binomiale négative - - - - &reftitle.description; - - floatstats_dens_pmf_negative_binomial - floatx - floatn - floatpi - - - Renvoie la masse de probabilité à x, où la - variable aléatoire suit la distribution binomiale négative dont le - nombre de succès est n et le taux de succès est - pi. - - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la masse de probabilité est calculée - - - - - n - - - Le nombre de succès de la distribution - - - - - pi - - - le taux de succès de la distribution - - - - - - - - - &reftitle.returnvalues; - - La masse de probabilité à x ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-poisson.xml b/reference/stats/functions/stats-dens-pmf-poisson.xml deleted file mode 100644 index 37f0886222..0000000000 --- a/reference/stats/functions/stats-dens-pmf-poisson.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_dens_pmf_poisson - La fonction de masse de probabilité de la distribution de Poisson - - - &reftitle.description; - - floatstats_dens_pmf_poisson - floatx - floatlb - - - Renvoie la masse de probabilité à x, où la variable aléatoire - suit la distribution de Poisson dont le paramètre est lb. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la masse de probabilité est calculée - - - - - lb - - - Le paramètre de la distribution de Poisson - - - - - - - - - &reftitle.returnvalues; - - La masse de probabilité à x ou &false; pour l'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-t.xml b/reference/stats/functions/stats-dens-t.xml deleted file mode 100644 index b4452c2db3..0000000000 --- a/reference/stats/functions/stats-dens-t.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_dens_t - La fonction de densité de probabilité de la distribution t - - - &reftitle.description; - - floatstats_dens_t - floatx - floatdfr - - - Renvoie la densité de probabilité à x, où la variable - aléatoire suit la distribution t dont le degré de liberté est dfr. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la densité de probabilité est calculée - - - - - dfr - - - Le degré de liberté de la distribution - - - - - - - - - &reftitle.returnvalues; - - La densité de probabilité à x ou &false; pour l'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-uniform.xml b/reference/stats/functions/stats-dens-uniform.xml deleted file mode 100644 index 01b8b4cb2d..0000000000 --- a/reference/stats/functions/stats-dens-uniform.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - stats_dens_uniform - La fonction de densité de probabilité de la distribution uniforme - - - - &reftitle.description; - - floatstats_dens_uniform - floatx - floata - floatb - - - Renvoie la densité de probabilité à x, où la variable - aléatoire suit la distribution uniforme dont la borne inférieure est - a et la borne supérieure est b. - - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la densité de probabilité est calculée - - - - - a - - - Le seuil inférieur de la distribution - - - - - b - - - Le seuil supérieur de la distribution - - - - - - - - - &reftitle.returnvalues; - - La densité de probabilité à x ou &false; pour l'échec. - - - - - - diff --git a/reference/stats/functions/stats-dens-weibull.xml b/reference/stats/functions/stats-dens-weibull.xml deleted file mode 100644 index 2e9d0b3a2b..0000000000 --- a/reference/stats/functions/stats-dens-weibull.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - stats_dens_weibull - La fonction de densité de probabilité de la distribution de Weibull - - - &reftitle.description; - - floatstats_dens_weibull - floatx - floata - floatb - - - Renvoie la densité de probabilité à x, où la variable - aléatoire suit la distribution de Weibull dont le paramètre de forme est - a et le paramètre d'échelle est b. - - - - &reftitle.parameters; - - - - x - - - La valeur à laquelle la densité de probabilité est calculée - - - - - a - - - Le paramètre de forme de la distribution - - - - - b - - - Le paramètre d'échelle de la distribution - - - - - - - - - &reftitle.returnvalues; - - La densité de probabilité à x ou &false; pour l'échec. - - - - - - diff --git a/reference/stats/functions/stats-harmonic-mean.xml b/reference/stats/functions/stats-harmonic-mean.xml deleted file mode 100644 index de4d51e2d2..0000000000 --- a/reference/stats/functions/stats-harmonic-mean.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_harmonic_mean - Renvoie la moyenne harmonique d'un tableau de valeurs - - - &reftitle.description; - - numberstats_harmonic_mean - arraya - - - Renvoie la moyenne harmonique des valeurs de a. - - - - &reftitle.parameters; - - - - a - - - Le tableau d'entrée - - - - - - - - - &reftitle.returnvalues; - - Renvoie la moyenne harmonique des valeurs de a, - ou &false; si a est vide ou n'est pas un tableau. - - - - - - diff --git a/reference/stats/functions/stats-kurtosis.xml b/reference/stats/functions/stats-kurtosis.xml deleted file mode 100644 index 74dd317737..0000000000 --- a/reference/stats/functions/stats-kurtosis.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_kurtosis - Calcule le kurtosis des données dans le tableau - - - &reftitle.description; - - floatstats_kurtosis - arraya - - - Renvoie le kurtosis des valeurs dans a. - - - - &reftitle.parameters; - - - - a - - - Le tableau d'entrée - - - - - - - - - &reftitle.returnvalues; - - Renvoie le kurtosis des valeurs dans a, - ou &false; si a est vide ou n'est pas un tableau. - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-beta.xml b/reference/stats/functions/stats-rand-gen-beta.xml deleted file mode 100644 index 384c93b37a..0000000000 --- a/reference/stats/functions/stats-rand-gen-beta.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - stats_rand_gen_beta - Génère une déviation aléatoire de la distribution beta - - - &reftitle.description; - - floatstats_rand_gen_beta - floata - floatb - - - Renvoie une déviation aléatoire de la distribution beta avec les paramètres A et - B. La densité de la beta est x^(a-1) * (1-x)^(b-1) / B(a, b) pour 0 < x - <. Méthode R. C. H. Cheng. - - - - - &reftitle.parameters; - - - - a - - - Le paramètre de forme de la distribution beta - - - - - b - - - Le paramètre de forme de la distribution beta - - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-chisquare.xml b/reference/stats/functions/stats-rand-gen-chisquare.xml deleted file mode 100644 index 280e6b989e..0000000000 --- a/reference/stats/functions/stats-rand-gen-chisquare.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_rand_gen_chisquare - Génère une déviation aléatoire de la distribution chi-carré - - - &reftitle.description; - - floatstats_rand_gen_chisquare - floatdf - - - Renvoie une déviation aléatoire de la distribution chi-carré où les degrés de - liberté sont df. - - - - &reftitle.parameters; - - - - df - - - Les degrés de liberté - - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-exponential.xml b/reference/stats/functions/stats-rand-gen-exponential.xml deleted file mode 100644 index 801988859b..0000000000 --- a/reference/stats/functions/stats-rand-gen-exponential.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_rand_gen_exponential - Génère une déviation aléatoire de la distribution exponentielle - - - &reftitle.description; - - floatstats_rand_gen_exponential - floatav - - - Renvoie une déviation aléatoire de la distribution exponentielle dont l'échelle est - av. - - - - &reftitle.parameters; - - - - av - - - Le paramètre d'échelle - - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-f.xml b/reference/stats/functions/stats-rand-gen-f.xml deleted file mode 100644 index 69c22e54e0..0000000000 --- a/reference/stats/functions/stats-rand-gen-f.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - stats_rand_gen_f - Génère une déviation aléatoire de la distribution F - - - &reftitle.description; - - floatstats_rand_gen_f - floatdfn - floatdfd - - - Génère une déviation aléatoire de la distribution F (ratio de variance) avec - "dfn" degrés de liberté dans le numérateur et "dfd" degrés de liberté dans - le dénominateur. Méthode : génère directement le ratio de variables chi-carré. - - - - &reftitle.parameters; - - - - dfn - - - Le degré de liberté dans le numérateur - - - - - dfd - - - Le degré de liberté dans le dénominateur - - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-funiform.xml b/reference/stats/functions/stats-rand-gen-funiform.xml deleted file mode 100644 index 7fd309f5e8..0000000000 --- a/reference/stats/functions/stats-rand-gen-funiform.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_gen_funiform - Génère un flottant uniforme entre low (exclusif) et high (exclusif) - - - &reftitle.description; - - floatstats_rand_gen_funiform - floatlow - floathigh - - - Renvoie une déviation aléatoire de la distribution uniforme entre - low et high. - - - - &reftitle.parameters; - - - - low - - - Le seuil inférieur (exclusif) - - - - - high - - - Le seuil supérieur (exclusif) - - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-gamma.xml b/reference/stats/functions/stats-rand-gen-gamma.xml deleted file mode 100644 index 7be2d68a10..0000000000 --- a/reference/stats/functions/stats-rand-gen-gamma.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - stats_rand_gen_gamma - Génère une déviation aléatoire de la distribution gamma - - - &reftitle.description; - - floatstats_rand_gen_gamma - floata - floatr - - - Génère une déviation aléatoire de la distribution gamma dont la densité est - (A**R)/Gamma(R) * X**(R-1) * Exp(-A*X). - - - - - &reftitle.parameters; - - - - a - - - Le paramètre de localisation de la distribution gamma (a - > 0). - - - - - r - - - Le paramètre de forme de la distribution gamma (r > - 0). - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml b/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml deleted file mode 100644 index a136f717f7..0000000000 --- a/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_gen_ibinomial_negative - Génère une déviation aléatoire de la distribution binomiale négative - - - &reftitle.description; - - intstats_rand_gen_ibinomial_negative - intn - floatp - - - Renvoie une déviation aléatoire de la distribution binomiale négative où le nombre de succès est - n et le taux de succès est p. - - - - &reftitle.parameters; - - - - n - - - Le nombre de succès. - - - - - p - - - Le taux de succès. - - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire, qui est le nombre d'échecs. - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ibinomial.xml b/reference/stats/functions/stats-rand-gen-ibinomial.xml deleted file mode 100644 index 920311eecb..0000000000 --- a/reference/stats/functions/stats-rand-gen-ibinomial.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_gen_ibinomial - Génère une déviation aléatoire de la distribution binomiale - - - &reftitle.description; - - intstats_rand_gen_ibinomial - intn - floatpp - - - Renvoie une déviation aléatoire de la distribution binomiale où le nombre d'essai est n - et la probabilité d'évènement dans chaque essai est pp. - - - - &reftitle.parameters; - - - - n - - - Le nombre d'essais - - - - - pp - - - La probabilité d'un événement dans chaque essai - - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-int.xml b/reference/stats/functions/stats-rand-gen-int.xml deleted file mode 100644 index 5f61123dbf..0000000000 --- a/reference/stats/functions/stats-rand-gen-int.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - stats_rand_gen_int - Génère un entier aléatoire entre 1 et 2147483562 - - - &reftitle.description; - - intstats_rand_gen_int - - - - Renvoie un entier aléatoire entre 1 et 2147483562 - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un entier aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ipoisson.xml b/reference/stats/functions/stats-rand-gen-ipoisson.xml deleted file mode 100644 index bed49ef2a5..0000000000 --- a/reference/stats/functions/stats-rand-gen-ipoisson.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - stats_rand_gen_ipoisson - Génère une seule déviation aléatoire de la distribution de Poisson - - - &reftitle.description; - - intstats_rand_gen_ipoisson - floatmu - - - Renvoie une déviation aléatoire de la distribution de Poisson avec le paramètre mu. - - - - &reftitle.parameters; - - - - mu - - - Le paramètre de la distribution de Poisson - - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-iuniform.xml b/reference/stats/functions/stats-rand-gen-iuniform.xml deleted file mode 100644 index 537da43e70..0000000000 --- a/reference/stats/functions/stats-rand-gen-iuniform.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_gen_iuniform - Renvoie un entier aléatoire uniformément distribué entre LOW (inclus) et HIGH (inclus) - - - &reftitle.description; - - intstats_rand_gen_iuniform - intlow - inthigh - - - Renvoie un entier aléatoire uniformément distribué entre low (inclus) et - high (inclus). - - - - &reftitle.parameters; - - - - low - - - Le seuil inférieur - - - - - high - - - Le seuil supérieur - - - - - - - - - &reftitle.returnvalues; - - Un entier aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml b/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml deleted file mode 100644 index ba859944d0..0000000000 --- a/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - stats_rand_gen_noncentral_chisquare - Génère une déviation aléatoire de la distribution chi-carré non-centrale - - - - &reftitle.description; - - floatstats_rand_gen_noncentral_chisquare - floatdf - floatxnonc - - - Renvoie une déviation aléatoire de la distribution chi-carré non-centrale avec les degrés de liberté, - df, et le paramètre de non-centralité, xnonc. - - - - - &reftitle.parameters; - - - - df - - - Les degrés de liberté - - - - - xnonc - - - Le paramètre de non-centralité - - - - - - - - - &reftitle.returnvalues; - - Une valeur aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-f.xml b/reference/stats/functions/stats-rand-gen-noncentral-f.xml deleted file mode 100644 index 8c63e01574..0000000000 --- a/reference/stats/functions/stats-rand-gen-noncentral-f.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - stats_rand_gen_noncentral_f - Génère une déviation aléatoire de la distribution F non-centrale - - - &reftitle.description; - - floatstats_rand_gen_noncentral_f - floatdfn - floatdfd - floatxnonc - - - Renvoie une déviation aléatoire de la distribution F non-centrale avec les degrés de liberté, - dfn (numérateur) et dfd (dénominateur), et le paramètre de non-centralité, - xnonc. - - - - &reftitle.parameters; - - - - dfn - - - Les degrés de liberté du numérateur - - - - - dfd - - - Les degrés de liberté du dénominateur - - - - - xnonc - - - Le paramètre de non-centralité - - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-t.xml b/reference/stats/functions/stats-rand-gen-noncentral-t.xml deleted file mode 100644 index 9b70fbcec3..0000000000 --- a/reference/stats/functions/stats-rand-gen-noncentral-t.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_gen_noncentral_t - Génère une seule déviation aléatoire de la distribution t non-centrale - - - &reftitle.description; - - floatstats_rand_gen_noncentral_t - floatdf - floatxnonc - - - Renvoie une déviation aléatoire de la distribution t non-centrale avec les degrés de liberté, - df, et le paramètre de non-centralité, xnonc. - - - - &reftitle.parameters; - - - - df - - - Les degrés de liberté - - - - - xnonc - - - Le paramètre de non-centralité - - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-normal.xml b/reference/stats/functions/stats-rand-gen-normal.xml deleted file mode 100644 index 5c5408dcb7..0000000000 --- a/reference/stats/functions/stats-rand-gen-normal.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_gen_normal - Génère une déviation aléatoire de la distribution normale - - - &reftitle.description; - - floatstats_rand_gen_normal - floatav - floatsd - - - Renvoie une déviation aléatoire de la distribution normale avec la moyenne, av, et l'écart-type, - sd. - - - - &reftitle.parameters; - - - - av - - - La moyenne de la distribution normale - - - - - sd - - - L'écart-type de la distribution normale - - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-t.xml b/reference/stats/functions/stats-rand-gen-t.xml deleted file mode 100644 index 31adea353f..0000000000 --- a/reference/stats/functions/stats-rand-gen-t.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - stats_rand_gen_t - Génère une seule déviation aléatoire de la distribution t - - - &reftitle.description; - - floatstats_rand_gen_t - floatdf - - - Renvoie une déviation aléatoire de la distribution t avec les degrés de liberté, df. - - - - &reftitle.parameters; - - - - df - - - Les degrés de liberté - - - - - - - - - &reftitle.returnvalues; - - Une déviation aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-get-seeds.xml b/reference/stats/functions/stats-rand-get-seeds.xml deleted file mode 100644 index 12d9c18647..0000000000 --- a/reference/stats/functions/stats-rand-get-seeds.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - stats_rand_get_seeds - Renvoie les valeurs de la graine du générateur de nombres aléatoires - - - &reftitle.description; - - arraystats_rand_get_seeds - - - - Renvoie les graines actuelles du générateur de nombres aléatoires - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie un tableau de deux entiers. - - - - - - diff --git a/reference/stats/functions/stats-rand-phrase-to-seeds.xml b/reference/stats/functions/stats-rand-phrase-to-seeds.xml deleted file mode 100644 index 765be35462..0000000000 --- a/reference/stats/functions/stats-rand-phrase-to-seeds.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - stats_rand_phrase_to_seeds - Génère deux graines pour le générateur de nombres aléatoires RGN - - - &reftitle.description; - - arraystats_rand_phrase_to_seeds - stringphrase - - - Génère deux graines pour le générateur de nombres aléatoires à partir d'une phrase. - - - - &reftitle.parameters; - - - - phrase - - - La phrase d'entrée - - - - - - - - - &reftitle.returnvalues; - - Renvoie un tableau de deux entiers. - - - - - - diff --git a/reference/stats/functions/stats-rand-ranf.xml b/reference/stats/functions/stats-rand-ranf.xml deleted file mode 100644 index 6fd0f48163..0000000000 --- a/reference/stats/functions/stats-rand-ranf.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - stats_rand_ranf - Génère un nombre flottant aléatoire entre 0 et 1 - - - &reftitle.description; - - floatstats_rand_ranf - - - - Renvoie un nombre flottant aléatoire issu d'une distribution uniforme entre 0 (exclus) et 1 (exclus). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un nombre flottant aléatoire - - - - - - diff --git a/reference/stats/functions/stats-rand-setall.xml b/reference/stats/functions/stats-rand-setall.xml deleted file mode 100644 index 7f89ed4b66..0000000000 --- a/reference/stats/functions/stats-rand-setall.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_setall - Définit les valeurs de la graine pour le générateur aléatoire - - - &reftitle.description; - - voidstats_rand_setall - intiseed1 - intiseed2 - - - Définit iseed1 et iseed2 comme valeurs de la graine pour le générateur aléatoire - utilisé dans les fonctions statistiques. - - - - &reftitle.parameters; - - - - iseed1 - - - La valeur utilisée comme graine aléatoire - - - - - iseed2 - - - La valeur utilisée comme graine aléatoire - - - - - - - - - &reftitle.returnvalues; - - Aucune valeur n'est retournée. - - - - - - diff --git a/reference/stats/functions/stats-skew.xml b/reference/stats/functions/stats-skew.xml deleted file mode 100644 index ece9588c55..0000000000 --- a/reference/stats/functions/stats-skew.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_skew - Calcule l'asymétrie des données dans un tableau - - - &reftitle.description; - - floatstats_skew - arraya - - - Renvoie l'asymétrie des valeurs dans a. - - - - &reftitle.parameters; - - - - a - - - Le tableau d'entrées - - - - - - - - - &reftitle.returnvalues; - - Renvoie l'asymétrie des valeurs dans a, - ou &false; si a est vide ou n'est pas un tableau. - - - - - - diff --git a/reference/stats/functions/stats-standard-deviation.xml b/reference/stats/functions/stats-standard-deviation.xml deleted file mode 100644 index 258320ea6c..0000000000 --- a/reference/stats/functions/stats-standard-deviation.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - stats_standard_deviation - Renvoie la déviation standard - - - &reftitle.description; - - floatstats_standard_deviation - arraya - boolsample&false; - - - Renvoie la déviation standard des valeurs dans a. - - - - &reftitle.parameters; - - - - a - - - Le tableau de données pour lequel calculer la déviation standard. Il est à noter que toutes - les valeurs du tableau seront converties en float. - - - - - sample - - - Indique si a représente un échantillon de la - population; par défaut à &false;. - - - - - - - - - &reftitle.returnvalues; - - Renvoie la déviation standard en cas de succès; &false; en cas d'échec. - - - - - &reftitle.errors; - - Lance une E_WARNING lorsqu'il y a moins de 2 - valeurs dans a. - - - - - - diff --git a/reference/stats/functions/stats-stat-binomial-coef.xml b/reference/stats/functions/stats-stat-binomial-coef.xml deleted file mode 100644 index 5c51688bb9..0000000000 --- a/reference/stats/functions/stats-stat-binomial-coef.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - stats_stat_binomial_coef - Renvoie un coefficient binomial - - - &reftitle.description; - - floatstats_stat_binomial_coef - intx - intn - - - Renvoie le coefficient binomial de n choisi x. - - - - &reftitle.parameters; - - - - x - - - Le nombre de choix dans l'ensemble - - - - - n - - - Le nombre d'éléments dans l'ensemble - - - - - - - - - &reftitle.returnvalues; - - Renvoie le coefficient binomial - - - - - - diff --git a/reference/stats/functions/stats-stat-correlation.xml b/reference/stats/functions/stats-stat-correlation.xml deleted file mode 100644 index dbe6ae4386..0000000000 --- a/reference/stats/functions/stats-stat-correlation.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_stat_correlation - Renvoie le coefficient de corrélation de Pearson de deux ensembles de données - - - &reftitle.description; - - floatstats_stat_correlation - arrayarr1 - arrayarr2 - - - Renvoie le coefficient de corrélation de Pearson entre arr1 et arr2. - - - - &reftitle.parameters; - - - - arr1 - - - Le premier tableau - - - - - arr2 - - - Le second tableau - - - - - - - - - &reftitle.returnvalues; - - Renvoie le coefficient de corrélation de Pearson entre arr1 et arr2, - ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-stat-factorial.xml b/reference/stats/functions/stats-stat-factorial.xml deleted file mode 100644 index 4c898c5ccb..0000000000 --- a/reference/stats/functions/stats-stat-factorial.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - stats_stat_factorial - Renvoie la factorielle d'un entier - - - - &reftitle.description; - - floatstats_stat_factorial - intn - - - Renvoie la factorielle d'un entier, n. - - - - - &reftitle.parameters; - - - n - - - Un entier - - - - - - - - &reftitle.returnvalues; - - La factorielle de n. - - - - - - diff --git a/reference/stats/functions/stats-stat-independent-t.xml b/reference/stats/functions/stats-stat-independent-t.xml deleted file mode 100644 index 59fd259fb6..0000000000 --- a/reference/stats/functions/stats-stat-independent-t.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - stats_stat_independent_t - Renvoie la valeur t du test t à deux échantillons indépendants - - - &reftitle.description; - - floatstats_stat_independent_t - arrayarr1 - arrayarr2 - - - Renvoie la valeur t du test t à deux échantillons indépendants entre - arr1 et arr2. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - arr1 - - - Le premier ensemble de valeurs - - - - - arr2 - - - Le second ensemble de valeurs - - - - - - - - - &reftitle.returnvalues; - - Renvoie la valeur t, ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-stat-innerproduct.xml b/reference/stats/functions/stats-stat-innerproduct.xml deleted file mode 100644 index 5a0109f335..0000000000 --- a/reference/stats/functions/stats-stat-innerproduct.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_stat_innerproduct - Renvoie le produit interne de deux vecteurs - - - &reftitle.description; - - floatstats_stat_innerproduct - arrayarr1 - arrayarr2 - - - Renvoie le produit interne de arr1 et arr2. - - - - &reftitle.parameters; - - - - arr1 - - - Le premier tableau - - - - - arr2 - - - Le second tableau - - - - - - - - - &reftitle.returnvalues; - - Renvoie le produit interne de arr1 et arr2, - ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-stat-paired-t.xml b/reference/stats/functions/stats-stat-paired-t.xml deleted file mode 100644 index 742076cb04..0000000000 --- a/reference/stats/functions/stats-stat-paired-t.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_stat_paired_t - Renvoie la valeur t du test t dépendant à deux échantillons appariés - - - &reftitle.description; - - floatstats_stat_paired_t - arrayarr1 - arrayarr2 - - - Renvoie la valeur t du test t dépendant à deux échantillons appariés pour les échantillons - arr1 et arr2. - - - - &reftitle.parameters; - - - - arr1 - - - Le premier échantillon - - - - - arr2 - - - Le second échantillon - - - - - - - - - &reftitle.returnvalues; - - Renvoie la valeur t, ou &false; en cas d'échec. - - - - - - diff --git a/reference/stats/functions/stats-stat-percentile.xml b/reference/stats/functions/stats-stat-percentile.xml deleted file mode 100644 index 922304ac56..0000000000 --- a/reference/stats/functions/stats-stat-percentile.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - stats_stat_percentile - Renvoie la valeur du centile - - - &reftitle.description; - - floatstats_stat_percentile - arrayarr - floatperc - - - Renvoie la valeur du perc-ième centile de l'ensemble de données arr. - - - - &reftitle.parameters; - - - - arr - - - Le tableau d'entrée - - - - - perc - - - Le centile - - - - - - - - - &reftitle.returnvalues; - - Renvoie le centile de l'ensemble de données. - - - - - - diff --git a/reference/stats/functions/stats-stat-powersum.xml b/reference/stats/functions/stats-stat-powersum.xml deleted file mode 100644 index a2ce20ff4e..0000000000 --- a/reference/stats/functions/stats-stat-powersum.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - stats_stat_powersum - Renvoie la somme des puissances d'un vecteur - - - &reftitle.description; - - floatstats_stat_powersum - arrayarr - floatpower - - - Renvoie la somme de la power-ième puissance d'un vecteur représenté sous forme de tableau arr. - - - - &reftitle.parameters; - - - - arr - - - Le tableau d'entrée - - - - - power - - - La puissance - - - - - - - - - &reftitle.returnvalues; - - Renvoie la somme des puissances de l'ensemble de données. - - - - - - diff --git a/reference/stats/functions/stats-variance.xml b/reference/stats/functions/stats-variance.xml deleted file mode 100644 index 2adf1424e9..0000000000 --- a/reference/stats/functions/stats-variance.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - stats_variance - Renvoie la variance - - - &reftitle.description; - - floatstats_variance - arraya - boolsample&false; - - - Renvoie la variance des valeurs dans a. - - - - &reftitle.parameters; - - - - a - - - Le tableau de données pour lequel calculer la variance. Il est à noter que toutes - les valeurs du tableau seront converties en float. - - - - - sample - - - Indique si a représente un échantillon de la - population; par défaut à &false;. - - - - - - - - - &reftitle.returnvalues; - - Renvoie la variance en cas de succès; &false; en cas d'échec. - - - - - - diff --git a/reference/stats/reference.xml b/reference/stats/reference.xml deleted file mode 100644 index 4425d4360b..0000000000 --- a/reference/stats/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; de Statistic - - &reference.stats.entities.functions; - - - - diff --git a/reference/stats/setup.xml b/reference/stats/setup.xml deleted file mode 100644 index 6921deb697..0000000000 --- a/reference/stats/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Aucune bibliothèque externe n'est nécessaire. L'extension est livrée avec les bibliothèques utilisées. - -
    - - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info.dead; - &url.pecl.package;stats. - - - &pecl.windows.download.avail; - -
    - - -     - - diff --git a/reference/stomp/book.xml b/reference/stomp/book.xml deleted file mode 100644 index 00fb67e077..0000000000 --- a/reference/stomp/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - Client Stomp - Stomp - - - &reftitle.intro; - - Cette extension permet aux applications PHP de communiquer avec tous les brokers de message compatibles Stomp à travers une API objet ou procédurale simple. Site officiel de Stomp - - - - &reference.stomp.setup; - &reference.stomp.examples; - &reference.stomp.reference; - &reference.stomp.stomp; - &reference.stomp.stompframe; - &reference.stomp.stompexception; - - diff --git a/reference/stomp/examples.xml b/reference/stomp/examples.xml deleted file mode 100644 index f5edd1cfd8..0000000000 --- a/reference/stomp/examples.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - &reftitle.examples; - - - &style.oop; - -getMessage()); -} - -/* envoi d'un message à la file 'foo' */ -$stomp->send($queue, $msg); - -/* souscription aux messages de la file 'foo' */ -$stomp->subscribe($queue); - -/* lecture d'un message */ -$frame = $stomp->readFrame(); - -if ($frame->body === $msg) { - var_dump($frame); - - /* confirmation de la réception du message */ - $stomp->ack($frame); -} - -/* fermeture de la connexion */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - string(7) "MESSAGE" - ["headers"]=> - array(5) { - ["message-id"]=> - string(41) "ID:php.net-55293-1257226743606-4:2:-1:1:1" - ["destination"]=> - string(10) "/queue/foo" - ["timestamp"]=> - string(13) "1257226805828" - ["expires"]=> - string(1) "0" - ["priority"]=> - string(1) "0" - } - ["body"]=> - string(3) "bar" -} -]]> - - - - &style.procedural; - - 't1')); - -/* validation de la transaction */ -stomp_commit($link, 't1'); - -/* souscription aux messages de la file 'foo' */ -stomp_subscribe($link, $queue); - -/* lecture d'un message */ -$frame = stomp_read_frame($link); - -if ($frame['body'] === $msg) { - var_dump($frame); - - /* confirmation de la réception du message */ - stomp_ack($link, $frame['headers']['message-id']); -} - -/* fermeture de la connexion */ -stomp_close($link); - -?> -]]> - - &example.outputs.similar; - - - string(7) "MESSAGE" - ["body"]=> - string(3) "bar" - ["headers"]=> - array(6) { - ["transaction"]=> - string(2) "t1" - ["message-id"]=> - string(41) "ID:php.net-55293-1257226743606-4:3:-1:1:1" - ["destination"]=> - string(10) "/queue/foo" - ["timestamp"]=> - string(13) "1257227037059" - ["expires"]=> - string(1) "0" - ["priority"]=> - string(1) "0" - } -} -]]> - - - - - diff --git a/reference/stomp/functions/stomp-connect-error.xml b/reference/stomp/functions/stomp-connect-error.xml deleted file mode 100644 index 3ddb1dfa91..0000000000 --- a/reference/stomp/functions/stomp-connect-error.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - stomp_connect_error - Retourne une chaîne décrivant la dernière erreur de connexion - - - - &reftitle.description; - - stringstomp_connect_error - - - - Retourne une chaîne décrivant la dernière erreur de connexion. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une chaîne décrivant l'erreur, ou &null; si aucune erreur n'est survenue. - - - - - &reftitle.examples; - - Exemple avec <function>stomp_connect_error</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/stomp/functions/stomp-version.xml b/reference/stomp/functions/stomp-version.xml deleted file mode 100644 index 975d805507..0000000000 --- a/reference/stomp/functions/stomp-version.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - stomp_version - Récupère la version de l'extension Stomp - - - - &reftitle.description; - - stringstomp_version - - - - Retourne une chaîne contenant la version de l'extension Stomp. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Version de l'extension Stomp. - - - - - &reftitle.examples; - - Exemple avec <function>stomp_version</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/stomp/ini.xml b/reference/stomp/ini.xml deleted file mode 100644 index 71af537fcd..0000000000 --- a/reference/stomp/ini.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - -
    - &reftitle.runtime; - &extension.runtime; - - Stomp &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - stomp.default_broker - tcp://localhost:61613 - INI_ALL - - - - stomp.default_connection_timeout_sec - 2 - INI_ALL - - - - stomp.default_connection_timeout_usec - 0 - INI_ALL - - - - - stomp.default_read_timeout_sec - 2 - INI_ALL - - - - stomp.default_read_timeout_usec - 0 - INI_ALL - - - - -
    - - &ini.descriptions.title; - - - - - stomp.default_broker - string - - - - URI par défaut du Broker de message utilisé à la connexion si aucun autre URI n'est spécifié. - - - - - - stomp.default_connection_timeout_sec - int - - - - Le nombre de secondes entières du délai d'expiration de connexion. - - - - - - stomp.default_connection_timeout_usec - int - - - - Le nombre de microsecondes entières du délai d'expiration de connexion. - - - - - - - stomp.default_read_timeout_sec - int - - - - Le nombre de secondes entières du délai d'expiration de lecture. - - - - - - stomp.default_read_timeout_usec - int - - - - Le nombre de microsecondes entières du délai d'expiration de lecture. - - - - - -
    diff --git a/reference/stomp/reference.xml b/reference/stomp/reference.xml deleted file mode 100644 index f16cc482ed..0000000000 --- a/reference/stomp/reference.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - &Functions; Stomp - - &reference.stomp.entities.functions; - - - - - diff --git a/reference/stomp/setup.xml b/reference/stomp/setup.xml deleted file mode 100644 index 43c3050e3f..0000000000 --- a/reference/stomp/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - Le paquet OpenSSL >= 0.9.6. L'extension openssl est aussi requise si l'on désire utiliser stomp à travers SSL. -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;stomp - -
    - - - &reference.stomp.ini; - - - -
    - &reftitle.resources; - - Il n'y a qu'une seule ressource utilisée par l'extension stomp : - c'est le lien identifiant représentant la connexion stomp. - -
    - - -     - diff --git a/reference/stomp/stomp.xml b/reference/stomp/stomp.xml deleted file mode 100644 index 63784d851e..0000000000 --- a/reference/stomp/stomp.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - &class.theclass; Stomp - Stomp - - - - -
    - &reftitle.intro; - - Représente une connexion entre PHP et un Broker de message compatible Stomp. - -
    - - -
    - &reftitle.classsynopsis; - - - - Stomp - - - - - Stomp - - - - - &Methods; - - - - - - -
    - -     - - &reference.stomp.entities.stomp; - -     - diff --git a/reference/stomp/stomp/abort.xml b/reference/stomp/stomp/abort.xml deleted file mode 100644 index f7025e61a7..0000000000 --- a/reference/stomp/stomp/abort.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - Stomp::abort - stomp_abort - Annule une transaction en cours - - - - &reftitle.description; - &style.oop; (méthode) : - - public boolStomp::abort - stringtransaction_id - arrayheaders - - &style.procedural; : - - boolstomp_abort - resourcelink - stringtransaction_id - arrayheaders - - - Annule une transaction en cours. - - - - - &reftitle.parameters; - - &stomp.param.link; - - transaction_id - - - ID de la transaction à annuler. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* début de la transaction */ -$stomp->begin('t1'); - -/* envoi d'un message à la file 'foo' */ -$stomp->send('/queue/foo', 'bar', array('transaction' => 't1')); - -/* annulation de la transaction */ -$stomp->abort('t1'); - -/* fermeture de la connexion */ -unset($stomp); -?> -]]> - - - - &style.procedural; - - 't1')); - -/* annulation de la transaction */ -stomp_abort($link, 't1'); - -/* fermeture de la connexion */ -stomp_close($link); - -?> -]]> - - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/ack.xml b/reference/stomp/stomp/ack.xml deleted file mode 100644 index eec3e7f2ef..0000000000 --- a/reference/stomp/stomp/ack.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - Stomp::ack - stomp_ack - Valide la réception d'un message - - - - &reftitle.description; - &style.oop; (méthode) : - - public boolStomp::ack - mixedmsg - arrayheaders - - &style.procedural; : - - boolstomp_ack - resourcelink - mixedmsg - arrayheaders - - - Valide la réception d'un message par une souscription. - - - - - &reftitle.parameters; - - &stomp.param.link; - - msg - - - Le message ou l'identifiant du message à valider. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* envoi d'un message à la file 'foo' */ -$stomp->send($queue, $msg); - -/* souscription aux messages de la file 'foo' */ -$stomp->subscribe($queue); - -/* lecture d'un message */ -$frame = $stomp->readFrame(); - -if ($frame->body === $msg) { - /* confirmation de la réception du message */ - $stomp->ack($frame); -} - -/* supprime la souscription à la file 'foo' */ -$stomp->unsubscribe($queue); - -/* fermeture de la connexion */ -unset($stomp); - -?> -]]> - - - - &style.procedural; - - 't1')); - -/* validation de la transaction */ -stomp_commit($link, 't1'); - -/* souscription aux messages de la file 'foo' */ -stomp_subscribe($link, $queue); - -/* lecture d'un message */ -$frame = stomp_read_frame($link); - -if ($frame['body'] === $msg) { - /* confirmation de la réception du message */ - stomp_ack($link, $frame['headers']['message-id']); -} - -/* supprime la souscription à la file 'foo' */ -stomp_unsubscribe($link, $queue); - -/* fermeture de la connexion */ -stomp_close($link); - -?> -]]> - - - - - - &reftitle.notes; - &stomp.note.transaction; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/begin.xml b/reference/stomp/stomp/begin.xml deleted file mode 100644 index d5b47af60c..0000000000 --- a/reference/stomp/stomp/begin.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - Stomp::begin - stomp_begin - Débute une transaction - - - - &reftitle.description; - &style.oop; (méthode) : - - public boolStomp::begin - stringtransaction_id - arrayheaders - - &style.procedural; : - - boolstomp_begin - resourcelink - stringtransaction_id - arrayheaders - - - Débute une transaction. - - - - - &reftitle.parameters; - - &stomp.param.link; - - transaction_id - - - Identifiant de la transaction. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Voir stomp_commit ou stomp_abort. - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/commit.xml b/reference/stomp/stomp/commit.xml deleted file mode 100644 index ef654ecf80..0000000000 --- a/reference/stomp/stomp/commit.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - Stomp::commit - stomp_commit - Valide une transaction en cours - - - - &reftitle.description; - &style.oop; (méthode) : - - public boolStomp::commit - stringtransaction_id - arrayheaders - - &style.procedural; : - - boolstomp_commit - resourcelink - stringtransaction_id - arrayheaders - - - Valide une transaction en cours. - - - - - &reftitle.parameters; - - &stomp.param.link; - - transaction_id - - - Identifiant de la transaction. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* début de la transaction */ -$stomp->begin('t1'); - -/* envoi d'un message à la file 'foo' */ -$stomp->send('/queue/foo', 'bar', array('transaction' => 't1')); - -/* validation de la transaction */ -$stomp->commit('t1'); - -/* fermeture de la connexion */ -unset($stomp); - -?> -]]> - - - - &style.procedural; - - 't1')); - -/* validation de la transaction */ -stomp_commit($link, 't1'); - -/* fermeture de la connexion */ -stomp_close($link); - -?> -]]> - - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/construct.xml b/reference/stomp/stomp/construct.xml deleted file mode 100644 index 0d67087af6..0000000000 --- a/reference/stomp/stomp/construct.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - - Stomp::__construct - stomp_connect - Ouvre une connexion - - - - &reftitle.description; - &style.oop; (constructeur) : - - public Stomp::__construct - stringbrokerini_get("stomp.default_broker_uri") - stringusername - stringpassword - arrayheaders - - &style.procedural; : - - resourcestomp_connect - stringbrokerini_get("stomp.default_broker_uri") - stringusername - stringpassword - arrayheaders - - - Ouvre une connexion à un Broker de message compatible Stomp. - - - - - &reftitle.parameters; - - - broker - - - URI du Broker. - - - - - username - - - Nom d'utilisateur. - - - - - password - - - Mot de passe. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - &stomp.note.transaction; - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL stomp 1.0.1 - - Le paramètre headers a été ajouté - - - - - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* fermeture de la connexion */ -unset($stomp); - -?> -]]> - - - - &style.procedural; - - -]]> - - - - - - diff --git a/reference/stomp/stomp/destruct.xml b/reference/stomp/stomp/destruct.xml deleted file mode 100644 index 9ac7c5beb1..0000000000 --- a/reference/stomp/stomp/destruct.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Stomp::__destruct - stomp_close - Ferme une connexion - - - - &reftitle.description; - &style.oop; (destructeur) : - - public Stomp::__destruct - - - &style.procedural; : - - boolstomp_close - resourcelink - - - Ferme une connexion préalablement ouverte. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Voir stomp_connect. - - - - diff --git a/reference/stomp/stomp/error.xml b/reference/stomp/stomp/error.xml deleted file mode 100644 index 9a3e6bddcf..0000000000 --- a/reference/stomp/stomp/error.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - Stomp::error - stomp_error - Récupère la dernière erreur stomp - - - - &reftitle.description; - &style.oop; (méthode) : - - public stringStomp::error - - - &style.procedural; : - - stringstomp_error - resourcelink - - - Récupère la dernière erreur stomp. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - Retourne une chaîne décrivant la dernière erreur ou &false; si aucune erreur n'est survenue. - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -var_dump($stomp->error()); - -if (!$stomp->abort('unknown-transaction', array('receipt' => 'foo'))) { - var_dump($stomp->error()); -} - -/* fermeture de la connexion */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - 'foo'))) { - var_dump(stomp_error($link)); -} - -/* fermeture de la connexion */ -stomp_close($link); - -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/stomp/stomp/getreadtimeout.xml b/reference/stomp/stomp/getreadtimeout.xml deleted file mode 100644 index 5511c05c88..0000000000 --- a/reference/stomp/stomp/getreadtimeout.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - Stomp::getReadTimeout - stomp_get_read_timeout - Récupère le délai d'expiration de lecture - - - - &reftitle.description; - &style.oop; (méthode) : - - public arrayStomp::getReadTimeout - - - &style.procedural; : - - arraystomp_get_read_timeout - resourcelink - - - Récupère le délai d'expiration de lecture. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - Retourne un tableau associatif avec 2 éléments : sec et usec. - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -var_dump($stomp->getReadTimeout()); - -/* fermeture de la connexion */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - int(2) - ["usec"]=> - int(0) -} -]]> - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - int(2) - ["usec"]=> - int(0) -} -]]> - - - - - - diff --git a/reference/stomp/stomp/getsessionid.xml b/reference/stomp/stomp/getsessionid.xml deleted file mode 100644 index 38dc65d0de..0000000000 --- a/reference/stomp/stomp/getsessionid.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - Stomp::getSessionId - stomp_get_session_id - Retourne l'identifiant de la session courante - - - - &reftitle.description; - &style.oop; (méthode) : - - public stringfalseStomp::getSessionId - - - &style.procedural; : - - stringfalsestomp_get_session_id - resourcelink - - - Retourne l'identifiant de la session courante. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant l'identifiant de la session&return.falseforfailure;. - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -var_dump($stomp->getSessionId()); - -/* fermeture de la connexion */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/stomp/stomp/hasframe.xml b/reference/stomp/stomp/hasframe.xml deleted file mode 100644 index 9cd0f86cec..0000000000 --- a/reference/stomp/stomp/hasframe.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Stomp::hasFrame - stomp_has_frame - Indique si un message est en attente de lecture ou non - - - - &reftitle.description; - &style.oop; (méthode) : - - public boolStomp::hasFrame - - - &style.procedural; : - - boolstomp_has_frame - resourcelink - - - Indique si un message est en attente de lecture ou non. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - Retourne &true; si un message est en attente de lecture, ou &false; dans le cas contraire. - - - - - diff --git a/reference/stomp/stomp/readframe.xml b/reference/stomp/stomp/readframe.xml deleted file mode 100644 index 196d6dd2d6..0000000000 --- a/reference/stomp/stomp/readframe.xml +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - - Stomp::readFrame - stomp_read_frame - Lit le prochain message - - - - &reftitle.description; - &style.oop; (méthode) : - - public stompframeStomp::readFrame - stringclass_name"stompFrame" - - &style.procedural; : - - arraystomp_read_frame - resourcelink - - - Lit le prochain message. Il est possible d'instancier un objet d'une classe spécifique, et de passer les paramètres au constructeur de cette classe. - - - - - &reftitle.parameters; - - &stomp.param.link; - - class_name - - - Le nom de la classe à instancier. Si ce paramètre n'est pas spécifié, un objet stompFrame est retourné. - - - - - - - - &reftitle.returnvalues; - &stomp.note.transaction; - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL stomp 0.4.0 - - Le paramètre class_name a été ajouté. - - - - - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* souscription aux messages de la file 'foo' */ -$stomp->subscribe('/queue/foo'); - -/* lecture d'un message */ -var_dump($stomp->readFrame()); - -/* fermeture de la connexion */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - string(7) "MESSAGE" - ["headers"]=> - array(5) { - ["message-id"]=> - string(41) "ID:php.net-55293-1257226743606-4:2:-1:1:1" - ["destination"]=> - string(10) "/queue/foo" - ["timestamp"]=> - string(13) "1257226805828" - ["expires"]=> - string(1) "0" - ["priority"]=> - string(1) "0" - } - ["body"]=> - string(3) "bar" -} -]]> - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - string(7) "MESSAGE" - ["body"]=> - string(3) "bar" - ["headers"]=> - array(6) { - ["transaction"]=> - string(2) "t1" - ["message-id"]=> - string(41) "ID:php.net-55293-1257226743606-4:3:-1:1:1" - ["destination"]=> - string(10) "/queue/foo" - ["timestamp"]=> - string(13) "1257227037059" - ["expires"]=> - string(1) "0" - ["priority"]=> - string(1) "0" - } -} -]]> - - - - - - diff --git a/reference/stomp/stomp/send.xml b/reference/stomp/stomp/send.xml deleted file mode 100644 index f0a5a8cdd9..0000000000 --- a/reference/stomp/stomp/send.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - Stomp::send - stomp_send - Envoie un message - - - - &reftitle.description; - &style.oop; (méthode) : - - public boolStomp::send - stringdestination - mixedmsg - arrayheaders - - &style.procedural; : - - boolstomp_send - resourcelink - stringdestination - mixedmsg - arrayheaders - - - Envoie un message au Broker de message. - - - - - &reftitle.parameters; - - &stomp.param.link; - - destination - - - Destination du message. - - - - - msg - - - Message à envoyer. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Voir stomp_ack. - - - - - &reftitle.notes; - &stomp.note.transaction; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/setreadtimeout.xml b/reference/stomp/stomp/setreadtimeout.xml deleted file mode 100644 index c69cc6512a..0000000000 --- a/reference/stomp/stomp/setreadtimeout.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - Stomp::setReadTimeout - stomp_set_read_timeout - Définit le délai d'expiration de lecture - - - - &reftitle.description; - &style.oop; (méthode) : - - public voidStomp::setReadTimeout - intseconds - intmicroseconds - - &style.procedural;: - - voidstomp_set_read_timeout - resourcelink - intseconds - intmicroseconds - - - Définit le délai d'expiration de lecture pour une connexion stomp. - - - - - &reftitle.parameters; - - &stomp.param.link; - - seconds - - - Le nombre de secondes entières du délai d'expiration de lecture à définir. - - - - - microseconds - - - Le nombre de microsecondes entières du délai d'expiration de lecture à définir. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -$stomp->setReadTimeout(10); - -/* fermeture de la connexion */ -unset($stomp); - -?> -]]> - - - - &style.procedural; - - -]]> - - - - - - diff --git a/reference/stomp/stomp/subscribe.xml b/reference/stomp/stomp/subscribe.xml deleted file mode 100644 index 7a4ec081c7..0000000000 --- a/reference/stomp/stomp/subscribe.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - Stomp::subscribe - stomp_subscribe - Souscrit à l'écoute d'une destination donnée - - - - &reftitle.description; - &style.oop; (méthode) : - - public boolStomp::subscribe - stringdestination - arrayheaders - - &style.procedural; : - - boolstomp_subscribe - resourcelink - stringdestination - arrayheaders - - - Souscrit à l'écoute d'une destination donnée. - - - - - &reftitle.parameters; - - &stomp.param.link; - - destination - - - Destination à écouter. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Voir stomp_ack. - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/unsubscribe.xml b/reference/stomp/stomp/unsubscribe.xml deleted file mode 100644 index 4dc9be5d9a..0000000000 --- a/reference/stomp/stomp/unsubscribe.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - Stomp::unsubscribe - stomp_unsubscribe - Supprime une souscription existante - - - - &reftitle.description; - &style.oop; (méthode): - - public boolStomp::unsubscribe - stringdestination - arrayheaders - - &style.procedural; : - - boolstomp_unsubscribe - resourcelink - stringdestination - arrayheaders - - - Supprime une souscription existante. - - - - - &reftitle.parameters; - - &stomp.param.link; - - destination - - - Souscription à supprimer. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Voir stomp_ack. - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stompexception.xml b/reference/stomp/stompexception.xml deleted file mode 100644 index 4ec1fbfc07..0000000000 --- a/reference/stomp/stompexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - &class.theclass; StompException - StompException - - - - -
    - &reftitle.intro; - - Représente une erreur émise par l'extension stomp. - Voir le chapitre sur les Exceptions - pour plus d'informations sur les exceptions en PHP. - -
    - - -
    - &reftitle.classsynopsis; - - - - StompException - - - - - StompException - - - - étend - Exception - - - - - &InheritedMethods; - - - &Methods; - - - - -
    -     - - &reference.stomp.entities.stompexception; - -     - diff --git a/reference/stomp/stompexception/getdetails.xml b/reference/stomp/stompexception/getdetails.xml deleted file mode 100644 index d10fe78586..0000000000 --- a/reference/stomp/stompexception/getdetails.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - StompException::getDetails - Récupère les détails de l'exception - - - - &reftitle.description; - - public stringStompException::getDetails - - - - Récupère les détails de l'exception. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &string; contenant les détails de l'exception. - - - - - diff --git a/reference/stomp/stompframe.xml b/reference/stomp/stompframe.xml deleted file mode 100644 index 4b8e9adb9a..0000000000 --- a/reference/stomp/stompframe.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - &class.theclass; StompFrame - StompFrame - - - - -
    - &reftitle.intro; - - Représente un message envoyé ou reçu par un Broker de message compatible stomp. - -
    - - -
    - &reftitle.classsynopsis; - - - - StompFrame - - - - - StompFrame - - - - &Properties; - - public - command - - - public - headers - - - public - body - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - command - - Commande du message. - - - - headers - - En-têtes du message (&array;). - - - - body - - Corps du message. - - - -
    - - - -     - - &reference.stomp.entities.stompframe; - -     - diff --git a/reference/stomp/stompframe/construct.xml b/reference/stomp/stompframe/construct.xml deleted file mode 100644 index 03003f00d1..0000000000 --- a/reference/stomp/stompframe/construct.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - StompFrame::__construct - Constructeur - - - - &reftitle.description; - - StompFrame::__construct - stringcommand - arrayheaders - stringbody - - - Constructeur. - - - - - &reftitle.parameters; - - - command - - - Commande du message. - - - - - headers - - - En-têtes du message (&array;). - - - - - body - - - Corps du message. - - - - - - - diff --git a/reference/svm/book.xml b/reference/svm/book.xml deleted file mode 100644 index dc2019f897..0000000000 --- a/reference/svm/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - Support Vector Machine - SVM - - - &reftitle.intro; - &warn.experimental; - - LibSVM est un solveur efficace pour les problèmes de classification et de - régression SVM. L'extension SVM se présente comme une interface PHP simple à - utiliser dans des scripts PHP. - - - - &reference.svm.setup; - &reference.svm.examples; - - &reference.svm.svm; - &reference.svm.svmmodel; - &reference.svm.svmexception; - - - diff --git a/reference/svm/configure.xml b/reference/svm/configure.xml deleted file mode 100644 index acc9517610..0000000000 --- a/reference/svm/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;svm - - -
    - diff --git a/reference/svm/examples.xml b/reference/svm/examples.xml deleted file mode 100644 index 624eb2dd92..0000000000 --- a/reference/svm/examples.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - &reftitle.examples; - - - Le processus basique consiste à définir des paramètres, soumettre des données - d'entraînement pour la génération d'un modèle, puis, faire des prédictions basées - sur ce modèle. Il y a un jeu par défaut de paramètres qui doivent donner des - résultats avec la plupart des entrées, aussi, nous allons commencer par - regarder du côté de ces données. - - - Les données sont soumises via un fichier, un flux ou un tableau. Si elles - sont fournies via un fichier ou un flux, elles doivent contenir une ligne - par exemple d’entraînement, ligne devant être formatée sous la forme d'une - classe entière (habituellement 1 et -1), suivi par une série de paires - clés/fonctionnalités, dans un ordre croissant des fonctionnalités. Les - fonctionnalités sont des entiers, et les valeurs, des nombres à virgule - flottante dans l'intervalle 0-1. Par exemple : - - - -1 1:0.43 3:0.12 9284:0.2 - - - Dans un problème de classification de document, par exemple concernant le - spam, chaque ligne doit représenter un document. Il doit y avoir 2 classes, - -1 pour les spam, 1 pour les ham. Chaque fonctionnalité représente des mots, - et les valeurs représentent l'importance de ces mots dans le document (par - exemple la fréquence de rencontre de ces mots dans le document, avec le total - dans le bon intervalle). Les fonctionnalités présentant la valeur 0 (c.-à-d. - le mot n'apparaît pas du tout dans le document) ne seront tout simplement - pas incluses. - - - En mode tableau, les données doivent être passées sous la forme de tableaux - de tableaux. Chaque sous-tableau doit avoir la classe comme premier élément, - plus, clés => jeux de valeurs pour les paires de fonctionnalité/valeur. - - - Ces données sont passées à la fonction d’entraînement de la classe SVM, - qui retournera un modèle SVM en cas de succès. - - - Une fois le modèle généré, il peut être utilisé pour faire des prédictions - sur les données précédentes non vues. Elles peuvent être passées sous forme - de tableau à la fonction de prédiction du modèle, dans le même format que - précédemment, mais sans le libellé. La réponse sera la classe. - - - Les modèles peuvent être sauvegardés et restaurés à la demande, en utilisant - les fonctions de sauvegarde et de chargement, qui prennent toutes les 2 comme - argument le chemin vers le fichier correspondant. - - - - Entraînement depuis un tableau - - 0.43, 3 => 0.12, 9284 => 0.2), - array(1, 1 => 0.22, 5 => 0.01, 94 => 0.11), -); - -$svm = new SVM(); -$model = $svm->train($data); - -$data = array(1 => 0.43, 3 => 0.12, 9284 => 0.2); -$result = $model->predict($data); -var_dump($result); -$model->save('model.svm'); -?> -]]> - - &example.outputs.similar; - - - - - - Entraînement depuis un fichier - -train("traindata.txt"); -?> -]]> - - - - - diff --git a/reference/svm/setup.xml b/reference/svm/setup.xml deleted file mode 100644 index 716fcbd52d..0000000000 --- a/reference/svm/setup.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - La bibliothèque Libsvm est requise, et est disponible depuis la plupart - des gestionnaires de paquets - libsvm-devel pour les systèmes basés sur - RPM ou libsvm-dev pour ceux basés sur Debian. Il est possible d'également la - trouver directement depuis le site web du projet. Si on l'installe depuis - le site web officiel, alors quelques étapes - seront nécessaires sachant que le paquet ne s'installe pas seul. Par exemple, - si nous partons du principe que la dernière version est la 3.1 : - - - - - - - Cette dernière étape doit montrer que la bibliothèque libsvm - est installée. - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;svm - -
    - -     - diff --git a/reference/svm/svm.xml b/reference/svm/svm.xml deleted file mode 100644 index 2ff3e86931..0000000000 --- a/reference/svm/svm.xml +++ /dev/null @@ -1,424 +0,0 @@ - - - - - - La classe SVM - SVM - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SVM - - - - - SVM - - - - &Constants; - - const - int - SVM::C_SVC - 0 - - - const - int - SVM::NU_SVC - 1 - - - const - int - SVM::ONE_CLASS - 2 - - - const - int - SVM::EPSILON_SVR - 3 - - - const - int - SVM::NU_SVR - 4 - - - const - int - SVM::KERNEL_LINEAR - 0 - - - const - int - SVM::KERNEL_POLY - 1 - - - const - int - SVM::KERNEL_RBF - 2 - - - const - int - SVM::KERNEL_SIGMOID - 3 - - - const - int - SVM::KERNEL_PRECOMPUTED - 4 - - - const - int - SVM::OPT_TYPE - 101 - - - const - int - SVM::OPT_KERNEL_TYPE - 102 - - - const - int - SVM::OPT_DEGREE - 103 - - - const - int - SVM::OPT_SHRINKING - 104 - - - const - int - SVM::OPT_PROBABILITY - 105 - - - const - int - SVM::OPT_GAMMA - 201 - - - const - int - SVM::OPT_NU - 202 - - - const - int - SVM::OPT_EPS - 203 - - - const - int - SVM::OPT_P - 204 - - - const - int - SVM::OPT_COEF_ZERO - 205 - - - const - int - SVM::OPT_C - 206 - - - const - int - SVM::OPT_CACHE_SIZE - 207 - - - &Methods; - - - - - - - - - -
    - - -
    - &reftitle.constants; -
    - Constantes SVM - - - - SVM::C_SVC - - - Le type SVM C_SVC basique. C'est le type par défaut, et un bon - point de départ. - - - - - SVM::NU_SVC - - - Le type NU_SVC utilise une pondération différente, plus souple des - erreurs. - - - - - - SVM::ONE_CLASS - - - Un type de classe SVM. S'entraîne sur une seule classe, en utilisant - les valeurs aberrantes comme des exemples négatifs. - - - - - - SVM::EPSILON_SVR - - - Un type SVM pour la régression (prédiction d'une valeur plutôt - que seulement une classe). - - - - - - SVM::NU_SVR - - - Un type NU de régression SVM. - - - - - - SVM::KERNEL_LINEAR - - - Un noyau très simple, pouvant fonctionner correctement sur un large - nombre de problèmes de classification. - - - - - - SVM::KERNEL_POLY - - - Un noyau polynôme. - - - - - - SVM::KERNEL_RBF - - - Un noyau Gaussien RBF commun. Gère parfaitement les problèmes non linéaires, et est - un bon noyau par défaut pour la classification. - - - - - - SVM::KERNEL_SIGMOID - - - Un noyau basé sur la fonction sigmoïde. Son utilisation rend SVM très similaire à une - interface sigmoïde basée sur un réseau neuronal. - - - - - - SVM::KERNEL_PRECOMPUTED - - - Un noyau pré-calculé - actuellement non supporté. - - - - - - SVM::OPT_TYPE - - - Les clés en option pour le type SVM. - - - - - - SVM::OPT_KERNEL_TYPE - - - Les clés en option pour le type de noyau. - - - - - - SVM::OPT_DEGREE - - - - - - - SVM::OPT_SHRINKING - - - Paramètre d’entraînement, booléen, pour indiquer d'utiliser les heuristiques - rétrécis. - - - - - - SVM::OPT_PROBABILITY - - - Paramètre d’entraînement, booléen, pour indiquer d'utiliser des estimations - des probabilités. - - - - - - SVM::OPT_GAMMA - - - Paramètre de l'algorithme pour les types de noyau - Poly, RBF et sigmoïde. - - - - - SVM::OPT_NU - - - La clé optionnelle pour le paramètre NU, uniquement utilisée - pour les types NU_ SVM. - - - - - - SVM::OPT_EPS - - - La clé optionnelle pour le paramètre Epsilon, utilisé pour la - régression epsilon. - - - - - - SVM::OPT_P - - - Paramètre d'entraînement utilisé par la régression Epsilon SVR. - - - - - - SVM::OPT_COEF_ZERO - - - Paramètre d'algorithme pour les noyaux poly et sigmoïde. - - - - - - SVM::OPT_C - - - L'option pour le paramètre cost qui contrôle les compromis entre les erreurs - et la généralisation - effectivement, la pénalité pour mauvaise classification - des exemples d'entraînement. - - - - - - SVM::OPT_CACHE_SIZE - - - Taille de la mémoire cache, en Mo. - - - - -
    -
    - - - -     - - &reference.svm.entities.svm; - -     - diff --git a/reference/svm/svm/construct.xml b/reference/svm/svm/construct.xml deleted file mode 100644 index 26bcf06bf4..0000000000 --- a/reference/svm/svm/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SVM::__construct - Construit un nouvel objet SVM - - - - &reftitle.description; - - public SVM::__construct - - - - Construit un nouvel objet SVM prêt à accepter des données - d'entrainement. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.errors; - - Lance une exception SVMException si la bibliothèque - libsvm n'a pu être chargée. - - - - - diff --git a/reference/svm/svm/crossvalidate.xml b/reference/svm/svm/crossvalidate.xml deleted file mode 100644 index 557edc08d5..0000000000 --- a/reference/svm/svm/crossvalidate.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - SVM::crossvalidate - Test les paramètres d'entraînement sur les sous-jeux de données d’entraînement - - - - &reftitle.description; - - public floatsvm::crossvalidate - arrayproblem - intnumber_of_folds - - - 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 - suffisamment utile pour être utilisé pour tester différents paramètres - d'entraînement. - - - - - - &reftitle.parameters; - - - problem - - - 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. - - - - - number_of_folds - - - 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. - - - - - - - - &reftitle.returnvalues; - - 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. - - - - - &reftitle.seealso; - - SVM::train - - - - - diff --git a/reference/svm/svm/getoptions.xml b/reference/svm/svm/getoptions.xml deleted file mode 100644 index d4c624bf94..0000000000 --- a/reference/svm/svm/getoptions.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SVM::getOptions - Retourne les paramètres courants d’entraînement - - - - &reftitle.description; - - public arraySVM::getOptions - - - - 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. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les paramètres de configuration. - - - - - diff --git a/reference/svm/svm/setoptions.xml b/reference/svm/svm/setoptions.xml deleted file mode 100644 index 0ee1a3cd23..0000000000 --- a/reference/svm/svm/setoptions.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - SVM::setOptions - Définit des paramètres d'entraînement - - - - &reftitle.description; - - public boolSVM::setOptions - arrayparams - - - Définit un ou plusieurs paramètres d'entraînement. - - - - - - &reftitle.parameters; - - - params - - - Un tableau de paramètres d'entraînement, dont les - clés sont les constantes SVM. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, et lance une exception - SVMException si une erreur survient. - - - - diff --git a/reference/svm/svm/train.xml b/reference/svm/svm/train.xml deleted file mode 100644 index 52b6237b90..0000000000 --- a/reference/svm/svm/train.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - SVM::train - Crée un modèle SVMModel suivant les données d'entraînement - - - - &reftitle.description; - - public SVMModelsvm::train - arrayproblem - arrayweights - - - Entraîne une machine vectorielle basée sur les données d'entraînement - fournies. - - - - - - &reftitle.parameters; - - - problem - - - 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. - - - - - weights - - - 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. - - - - - - - - &reftitle.returnvalues; - - Retourne un modèle SVMModel qui peut être utilisé pour classifier - les données précédemment non vues. - Lance une exception SVMException si une erreur survient. - - - - - diff --git a/reference/svm/svmexception.xml b/reference/svm/svmexception.xml deleted file mode 100644 index a632866c87..0000000000 --- a/reference/svm/svmexception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - La classe SVMException - SVMException - - - - -
    - &reftitle.intro; - - Cet objet gère les erreurs depuis les classes SVM et SVMModel. - -
    - - -
    - &reftitle.classsynopsis; - - - - SVMException - - - - - SVMException - - - - extends - Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - -
    - - -     - - -     - diff --git a/reference/svm/svmmodel.xml b/reference/svm/svmmodel.xml deleted file mode 100644 index fb62a6415a..0000000000 --- a/reference/svm/svmmodel.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La classe SVMModel - SVMModel - - - - -
    - &reftitle.intro; - - 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. - -
    - - -
    - &reftitle.classsynopsis; - - - - SVMModel - - - - - SVMModel - - - - - &Methods; - - - - - - - - - -
    - -     - - &reference.svm.entities.svmmodel; - -     - diff --git a/reference/svm/svmmodel/checkprobabilitymodel.xml b/reference/svm/svmmodel/checkprobabilitymodel.xml deleted file mode 100644 index e5a78b6b4e..0000000000 --- a/reference/svm/svmmodel/checkprobabilitymodel.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SVMModel::checkProbabilityModel - Retourne &true; si le modèle a des informations probabilistes - - - - &reftitle.description; - - public boolSVMModel::checkProbabilityModel - - - - Retourne &true; si le modèle contient des informations probabilistes. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un booléen. - - - - - diff --git a/reference/svm/svmmodel/construct.xml b/reference/svm/svmmodel/construct.xml deleted file mode 100644 index 19e0d42048..0000000000 --- a/reference/svm/svmmodel/construct.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - SVMModel::__construct - Construit un nouvel objet SVMModel - - - - &reftitle.description; - - public SVMModel::__construct - stringfilename - - - 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. - - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier pour le modèle sauvegardé à charger. - - - - - - - - &reftitle.errors; - - Lance une exception SVMException si une erreur survient. - - - - - &reftitle.seealso; - - SVMModel::load - - - - - diff --git a/reference/svm/svmmodel/getlabels.xml b/reference/svm/svmmodel/getlabels.xml deleted file mode 100644 index 217c0c57de..0000000000 --- a/reference/svm/svmmodel/getlabels.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - SVMModel::getLabels - Récupère les labels utilisés pour entraîner le modèle - - - - &reftitle.description; - - public arraySVMModel::getLabels - - - - Retourne un tableau de labels utilisés pour entraîner le modèle. - Pour les cas de régression et pour les classes modèles seules, - un tableau vide est retourné. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau de labels. - - - - - &reftitle.seealso; - - SVMModel::getNrClass - - - - - diff --git a/reference/svm/svmmodel/getnrclass.xml b/reference/svm/svmmodel/getnrclass.xml deleted file mode 100644 index 87db0ed24e..0000000000 --- a/reference/svm/svmmodel/getnrclass.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SVMModel::getNrClass - Retourne le nombre de classes utilisées pour entraîner le modèle - - - - &reftitle.description; - - public intSVMModel::getNrClass - - - - 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. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le nombre de classes, sous la forme d'un entier. - - - - - diff --git a/reference/svm/svmmodel/getsvmtype.xml b/reference/svm/svmmodel/getsvmtype.xml deleted file mode 100644 index d30499fe41..0000000000 --- a/reference/svm/svmmodel/getsvmtype.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SVMModel::getSvmType - Récupère le type SVM utilisé pour entraîner le modèle - - - - &reftitle.description; - - public intSVMModel::getSvmType - - - - Retourne un entier représentant le type du modèle SVM utilisé, c.-à-d. SVM::C_SVC. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le type SVM sous la forme d'un entier. - - - - - diff --git a/reference/svm/svmmodel/getsvrprobability.xml b/reference/svm/svmmodel/getsvrprobability.xml deleted file mode 100644 index 254d21f2fb..0000000000 --- a/reference/svm/svmmodel/getsvrprobability.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SVMModel::getSvrProbability - Récupère la valeur sigma pour les types de régression - - - - &reftitle.description; - - public floatSVMModel::getSvrProbability - - - - 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é. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une valeur sigma. - - - - - diff --git a/reference/svm/svmmodel/load.xml b/reference/svm/svmmodel/load.xml deleted file mode 100644 index c5e986b751..0000000000 --- a/reference/svm/svmmodel/load.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - SVMModel::load - Charge un modèle SVM sauvegardé - - - - &reftitle.description; - - public boolSVMModel::load - stringfilename - - - Charge un fichier de modèle prêt pour une classification - ou une régression. - - - - - - &reftitle.parameters; - - - filename - - - Le nom de fichier du modèle. - - - - - - - - &reftitle.returnvalues; - - Lance une exception SVMException en cas d'erreur. - Retourne &true; en cas de succès. - - - - - &reftitle.seealso; - - SVMModel::save - - - - - diff --git a/reference/svm/svmmodel/predict-probability.xml b/reference/svm/svmmodel/predict-probability.xml deleted file mode 100644 index 00cfa52c52..0000000000 --- a/reference/svm/svmmodel/predict-probability.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - SVMModel::predict_probability - Retourne les probabilités pour les données précédentes non présentées - - - - &reftitle.description; - - public floatSVMModel::predict_probability - arraydata - - - Cette fonction accepte un 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 chance 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é à &true;. - - - - - - &reftitle.parameters; - - - data - - - Le tableau à classifier. Ce doit être une série de paires clé=>valeur - dont les clés sont en ordre croissant, mais pas nécessairement continue. - - - - - probabilities - - - La valeur fournie sera complétée avec les probabilités. - Ce peut être soit &null; dans le cas où le modèle ne contient - aucune information de probabilité, ou un tableau dont les - index sont les noms de classe, et les valeurs, la probabilité. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur prédite. Ce sera un libellé 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. - - - - - &reftitle.seealso; - - SVM::predict - - - - - - diff --git a/reference/svm/svmmodel/predict.xml b/reference/svm/svmmodel/predict.xml deleted file mode 100644 index 4afadf08d5..0000000000 --- a/reference/svm/svmmodel/predict.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - SVMModel::predict - Prédit une valeur pour des précédentes données non vues - - - - &reftitle.description; - - public floatSVMModel::predict - arraydata - - - 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. - - - - - - &reftitle.parameters; - - - data - - - Le tableau à classifier. Ce peut être une série de paires clé => valeur - dans l'ordre croissant des clés, mais non nécessairement continue. - - - - - - - - &reftitle.returnvalues; - - 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. - - - - - &reftitle.seealso; - - SVM::train - - - - - - diff --git a/reference/svm/svmmodel/save.xml b/reference/svm/svmmodel/save.xml deleted file mode 100644 index 08ad0d2d1f..0000000000 --- a/reference/svm/svmmodel/save.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - SVMModel::save - Sauvegarde un modèle dans un fichier - - - - &reftitle.description; - - public boolSVMModel::save - stringfilename - - - Sauvegarde le modèle de données dans un fichier, pour une - utilisation ultérieure. - - - - - - &reftitle.parameters; - - - filename - - - Le fichier dans lequel nous souhaitons sauvegarder le modèle. - - - - - - - - &reftitle.returnvalues; - - Lance une exception SVMException si une erreur survient. - Retourne &true; en cas de succès. - - - - - &reftitle.seealso; - - SVMModel::load - - - - - diff --git a/reference/svn/book.xml b/reference/svn/book.xml deleted file mode 100644 index 6ba1c67c72..0000000000 --- a/reference/svn/book.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - - Subversion - SVN - - - - &reftitle.intro; - - Cette extension implémente les fonctions PHP pour - Subversion (SVN), un système de contrôle - de versions, permettant aux scripts PHP de communiquer avec les référentiels SVN - et les copies de travail, sans utiliser directement des appels aux exécutables - svn. - - &warn.experimental; - - - - &reference.svn.setup; - &reference.svn.constants; - &reference.svn.reference; - - - diff --git a/reference/svn/configure.xml b/reference/svn/configure.xml deleted file mode 100644 index 6d5b9f07e2..0000000000 --- a/reference/svn/configure.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - -
    - &reftitle.install; - - &pecl.info; - - - - Si ./configure n'arrive pas à trouver les fichiers - SVN (par exemple, Subversion a été installé avec un préfixe de dossier - personnalisé), utiliser la commande - ./configure --with-svn=$USR_PATH - pour spécifier le dossier où - include/subversion-1/ se trouve. - - - &pecl.windows.download; - - - - Si cette extension est compilée avec la bibliothèque libsvn 1.3, - les fonctions qui fonctionnent avec les copies de travail - échoueront sur les copies de travail créées par - Subversion 1.4. - - -
    - diff --git a/reference/svn/constants.xml b/reference/svn/constants.xml deleted file mode 100644 index 4994c0136b..0000000000 --- a/reference/svn/constants.xml +++ /dev/null @@ -1,427 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - SVN_REVISION_HEAD - (int) - - - - Nombre magique (-1) spécifiant la révision HEAD - - - - - - Constantes utilisables avec <function>svn_auth_set_parameter</function> - - - SVN_AUTH_PARAM_DEFAULT_USERNAME - (string) - - - - Propriété pour le nom d'utilisateur par défaut, à utiliser lors de - l'identification de base - - - - - - SVN_AUTH_PARAM_DEFAULT_PASSWORD - (string) - - - - Propriété pour le mot de passe par défaut, à utiliser lors de - l'identification de base - - - - - - SVN_AUTH_PARAM_NON_INTERACTIVE - (string) - - - - - - SVN_AUTH_PARAM_DONT_STORE_PASSWORDS - (string) - - - - - - SVN_AUTH_PARAM_NO_AUTH_CACHE - (string) - - - - - - SVN_AUTH_PARAM_SSL_SERVER_FAILURES - (string) - - - - - - SVN_AUTH_PARAM_SSL_SERVER_CERT_INFO - (string) - - - - - - SVN_AUTH_PARAM_CONFIG - (string) - - - - - - SVN_AUTH_PARAM_SERVER_GROUP - (string) - - - - - - SVN_AUTH_PARAM_CONFIG_DIR - (string) - - - - - - PHP_SVN_AUTH_PARAM_IGNORE_SSL_VERIFY_ERRORS - (string) - - - - Propriété personnalisée pour ignorer les erreurs de vérification - du certificat SSL - - - - - - Constantes de système de fichiers - - - SVN_FS_CONFIG_FS_TYPE - (string) - - - - Clé de configuration qui détermine le type de système de fichiers - - - - - - SVN_FS_TYPE_BDB - (string) - - - - Le système de fichiers est Berkeley-DB - - - - - - SVN_FS_TYPE_FSFS - (string) - - - - Le système de fichiers est "système de fichiers natifs" - - - - - - Constantes de propriétés réservées - - - SVN_PROP_REVISION_DATE - (string) - - - - svn:date - - - - - - SVN_PROP_REVISION_ORIG_DATE - (string) - - - - svn:original-date - - - - - - SVN_PROP_REVISION_AUTHOR - (string) - - - - svn:author - - - - - - SVN_PROP_REVISION_LOG - (string) - - - - svn:log - - - - - - Constantes de statut des copies de travail - - - SVN_WC_STATUS_NONE - (int) - - - - Le statut n'existe pas - - - - - - SVN_WC_STATUS_UNVERSIONED - (int) - - - - L'élément n'est pas versionné dans la copie de travail - - - - - - SVN_WC_STATUS_NORMAL - (int) - - - - L'élément existe, rien d'autre n'intervient - - - - - - SVN_WC_STATUS_ADDED - (int) - - - - L'élément est programmé pour être ajouté - - - - - - SVN_WC_STATUS_MISSING - (int) - - - - L'élément est versionné mais est absent de la copie de travail - - - - - - SVN_WC_STATUS_DELETED - (int) - - - - L'élément est marqué pour effacement - - - - - - SVN_WC_STATUS_REPLACED - (int) - - - - L'élément a été supprimé, puis, ajouté à nouveau - - - - - - SVN_WC_STATUS_MODIFIED - (int) - - - - L'élément (texte ou propriété) a été modifié - - - - - - SVN_WC_STATUS_MERGED - (int) - - - - Les modifications de l'élément local ont été fusionnées avec les modifications - du référentiel - - - - - - SVN_WC_STATUS_CONFLICTED - (int) - - - - Les modifications de l'élément local entrent en conflit avec les modifications - du référentiel - - - - - - SVN_WC_STATUS_IGNORED - (int) - - - - L'élément n'est pas versionné mais est configuré pour être ignoré - - - - - - SVN_WC_STATUS_OBSTRUCTED - (int) - - - - L'élément non versionné s'apprête à être une ressource versionnée - - - - - - SVN_WC_STATUS_EXTERNAL - (int) - - - - Le chemin non versionné a été rempli en utilisant svn:externals - - - - - - SVN_WC_STATUS_INCOMPLETE - (int) - - - - Le dossier ne contient pas une liste complète d'entrées - - - - - - Constantes de type de nœud - - - SVN_NODE_NONE - (int) - - - - Absent - - - - - - SVN_NODE_FILE - (int) - - - - Fichier - - - - - - SVN_NODE_DIR - (int) - - - - Dossier - - - - - - SVN_NODE_UNKNOWN - (int) - - - - Quelque chose que Subversion n'arrive pas à identifier - - - - - - - diff --git a/reference/svn/functions/svn-add.xml b/reference/svn/functions/svn-add.xml deleted file mode 100644 index 2117e005c9..0000000000 --- a/reference/svn/functions/svn-add.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - svn_add - Prévoit l'ajout d'un élément dans le dossier de travail - - - - &reftitle.description; - - boolsvn_add - stringpath - boolrecursive&true; - boolforce&false; - - - Ajoute un fichier, un dossier ou un lien symbolique, en utilisant - le chemin path dans le dossier de travail. - L'élément sera ajouté au référentiel au prochain appel de la fonction - svn_commit sur la copie de travail. - - - - - &reftitle.parameters; - - - path - - - Chemin de l'élément à ajouter. - - &svn.relativepath; - - - - recursive - - - Si l'élément est un dossier, si l'on doit ou non ajouter - récursivement tout son contenu. Par défaut, vaut &true; - - - - - force - - - Si vaut &true;, Subversion cherchera récursivement dans les dossiers - versionnés existants afin d'ajouter tous les fichiers qui ne - sont actuellement pas versionnés. Par défaut, vaut &false; - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>svn_add</function> - - Dans un dossier de travail où la commande svn status - retourne : - - - - - ...ce code: - - -]]> - - - ...marquera le fichier foobar.txt comme fichier à ajouter - dans le dossier. - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - Documentation SVN sur la commande "svn add" - - - - - diff --git a/reference/svn/functions/svn-auth-get-parameter.xml b/reference/svn/functions/svn-auth-get-parameter.xml deleted file mode 100644 index ae0c832741..0000000000 --- a/reference/svn/functions/svn-auth-get-parameter.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - svn_auth_get_parameter - Récupère un paramètre d'identification - - - - &reftitle.description; - - stringsvn_auth_get_parameter - stringkey - - - Récupère le paramètre d'identification dont la clé est - key. - Pour une liste de clés valides ainsi que leurs significations, consulter - la liste des constantes d'identification. - - - - - &reftitle.parameters; - - - key - - - Nom de la clé. Utiliser une constante d'identification définie - par cette extension pour spécifier une clé. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur du paramètre dont la clé est key ; - retourne &null; si le paramètre n'existe pas. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_auth_set_parameter - Constantes d'identification - - - - - diff --git a/reference/svn/functions/svn-auth-set-parameter.xml b/reference/svn/functions/svn-auth-set-parameter.xml deleted file mode 100644 index d06b91b7fb..0000000000 --- a/reference/svn/functions/svn-auth-set-parameter.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - svn_auth_set_parameter - Spécifie un paramètre d'identification - - - - &reftitle.description; - - voidsvn_auth_set_parameter - stringkey - stringvalue - - - Spécifie le paramètre d'identification key à - la valeur value. - Pour une liste de clés valides ainsi que leurs significations, - se reporter à la liste des - constantes d'identification. - - - - - &reftitle.parameters; - - - key - - - Nom de la clé. Utiliser une constante d'identification - définie par cette extension pour spécifier la clé. - - - - - value - - - Valeur à définir pour la nouvelle clé. Le format de la valeur - varie avec le paramètre. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple d'identification - - Cet exemple configure SVN avec, comme nom d'utilisateur "Bob" et - comme mot de passe "abc123" : - - - -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_auth_get_parameter - Constantes d'identification - - - - - diff --git a/reference/svn/functions/svn-blame.xml b/reference/svn/functions/svn-blame.xml deleted file mode 100644 index 775e483284..0000000000 --- a/reference/svn/functions/svn-blame.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - svn_blame - Récupère les condamnations SVN pour un fichier - - - - &reftitle.description; - - arraysvn_blame - stringrepository_url - intrevision_noSVN_REVISION_HEAD - - - Récupère les condamnations SVN pour un fichier à partir d'une URL du référentiel. - - - - - &reftitle.parameters; - - - repository_url - - - L'URL du référentiel. - - - - - revision_no - - - Le numéro de révision. - - - - - - - - &reftitle.returnvalues; - - Un tableau des informations de condamnation SVN séparées par ligne - qui incluent le numéro de révision, le numéro de ligne, la ligne de code, - l'auteur et la date. - - - - - &reftitle.examples; - - Exemple d'utilisation de <function>svn_blame</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - svn_diff - svn_logs - svn_status - - - - - diff --git a/reference/svn/functions/svn-cat.xml b/reference/svn/functions/svn-cat.xml deleted file mode 100644 index b72d3d7607..0000000000 --- a/reference/svn/functions/svn-cat.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - svn_cat - Récupère le contenu d'un fichier du référentiel - - - - &reftitle.description; - - stringsvn_cat - stringrepos_url - intrevision_no - - - Récupère le contenu du fichier pointé par l'URL repos_url - du référentiel, optionnellement, à la révision revision_no. - - - - - &reftitle.parameters; - - - repos_url - - - URL de l'élément du référentiel. - - - - - revision_no - - - Numéro de révision de l'élément à récupérer ; par défaut, vaut HEAD. - - - - - - - - &reftitle.returnvalues; - - Retourne le contenu de l'élément depuis le référentiel en cas de succès, - et &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple d'utilisation - - Cet exemple récupère le contenu d'un fichier, à la révision 28 : - - - -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_list - Documentation SVN sur la commande "svn cat" - - - - - diff --git a/reference/svn/functions/svn-checkout.xml b/reference/svn/functions/svn-checkout.xml deleted file mode 100644 index ebc5a3a496..0000000000 --- a/reference/svn/functions/svn-checkout.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - svn_checkout - Extrait une copie de travail depuis un référentiel - - - - &reftitle.description; - - boolsvn_checkout - stringrepos - stringtargetpath - intrevision - intflags0 - - - Extrait une copie de travail depuis le référentiel repos - vers targetpath à la révision revision. - - - - - &reftitle.parameters; - - - repos - - - URL du dossier dans le référentiel à extraire. - - - - - targetpath - - - Chemin local du dossier dans lequel on effectue l'extraction - - &svn.relativepath; - - - - revision - - - Numéro de révision du référentiel à extraire. Par défaut, vaut - HEAD, la révision la plus récente. - - - - - flags - - - Toute combinaison de SVN_NON_RECURSIVE et - SVN_IGNORE_EXTERNALS. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple d'utilisation - - Cet exemple montre comment extraire un dossier depuis un - référentiel vers un dossier nommé "calc" : - - - -]]> - - - L'utilisation de dirname(__FILE__) est nécessaire - afin de convertir le chemin relatif du dossier calc en un chemin absolu. - Si calc existe, il est possible d'également utiliser realpath - pour récupérer un chemin absolu. - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_add - svn_commit - svn_status - svn_update - Documentation SVN sur la commande "svn checkout" - - - - - diff --git a/reference/svn/functions/svn-cleanup.xml b/reference/svn/functions/svn-cleanup.xml deleted file mode 100644 index 99b4e5d8c1..0000000000 --- a/reference/svn/functions/svn-cleanup.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - svn_cleanup - Nettoie, récursivement, un dossier de travail, en finissant les opérations - incomplètes et en supprimant les verrous - - - - &reftitle.description; - - boolsvn_cleanup - stringworkingdir - - - Nettoie, récursivement, un dossier de travail workingdir, - en finissant les opérations incomplètes et en supprimant les verrous. À utiliser - lorsque la copie de travail n'est plus fonctionnelle. - - - - - &reftitle.parameters; - - - workingdir - - - Chemin vers le dossier local de travail, à nettoyer. - - &svn.relativepath; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple d'utilisation - - Cet exemple montre comment nettoyer une copie de travail d'un - dossier nommé "help-me" : - - - -]]> - - - La fonction realpath doit être appelée, vu - la mauvaise gestion des chemins relatifs par SVN. - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - update - Documentation SVN sur la commande "svn cleanup" - - - - - diff --git a/reference/svn/functions/svn-client-version.xml b/reference/svn/functions/svn-client-version.xml deleted file mode 100644 index bb7ce5d07a..0000000000 --- a/reference/svn/functions/svn-client-version.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - svn_client_version - Récupère la version des bibliothèques clientes SVN - - - - &reftitle.description; - - stringsvn_client_version - - - - Récupère la version des bibliothèques clientes SVN. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Numéro de la version, habituellement sous la forme x.y.z. - - - - - &reftitle.examples; - - Exemple d'utilisation - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-commit.xml b/reference/svn/functions/svn-commit.xml deleted file mode 100644 index 1297996df9..0000000000 --- a/reference/svn/functions/svn-commit.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - svn_commit - Envoie les modifications depuis la copie locale vers le référentiel - - - - &reftitle.description; - - arraysvn_commit - stringlog - arraytargets - boolrecursive&true; - - - Livre les modifications effectuées sur les fichiers locaux énumérés - par le tableau targets dans le référentiel, avec le message - log. Les dossiers contenus dans le tableau - targets seront livrés récursivement tant que le - paramètre recursive n'a pas été défini à &false;. - - - - Cette fonction ne contient aucun paramètre spécifique à l'identification, - aussi, le nom d'utilisateur et le mot de passe doivent être définis - en utilisant la fonction svn_auth_set_parameter - - - - - - &reftitle.parameters; - - - log - - - Message d'historisation à utiliser lors de la livraison. - - - - - targets - - - Tableau de chemins locaux des fichiers à livrer. - - - - Ce paramètre doit être un tableau ; une chaîne pour une - cible unique n'est pas acceptée. - - - &svn.relativepath; - - - - recursive - - - Drapeau de type booléen pour désactiver la récursivité - lors de la livraison de dossiers dans le tableau targets. - Par défaut, vaut &true;. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau, sous la forme : - - - numéro (entier) de révision de la livraison - 1 => Date et heure (format ISO 8601) de la livraison - 2 => nom d'utilisateur de la personne ayant livré -) -]]> - - - Retourne &false; si une erreur survient. - - - - - &reftitle.examples; - - Exemple d'utilisation - - Cet exemple livre le dossier "calculator" dans le référentiel, en utilisant - comme nom d'utilisateur "Bob" et comme mot de passe "abc123" : - - - -]]> - - &example.outputs; - - 1415, - 1 => '2007-05-26T01:44:28.453125Z', - 2 => 'Bob' -) -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_auth_set_parameter - Documentation SVN sur la commande "svn commit" - - - - - diff --git a/reference/svn/functions/svn-delete.xml b/reference/svn/functions/svn-delete.xml deleted file mode 100644 index fd630764fa..0000000000 --- a/reference/svn/functions/svn-delete.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - svn_delete - Efface un élément d'un dossier de travail ou d'un dépôt - - - - &reftitle.description; - - boolsvn_delete - stringpath - boolforce&false; - - - Efface un fichier, un dossier ou un lien symbolique, suivant le - path utilisé, depuis un dossier de travail. - L'élément sera effacé depuis le dépôt au prochain appel à la fonction - svn_commit sur le dossier de travail. - - - - - &reftitle.parameters; - - - path - - - Chemin vers l'élément à effacer. - - &svn.relativepath; - - - - force - - - Si vaut &true;, le fichier sera effacé même s'il a des modifications locales. - Sinon, les modifications locales feront échouer la fonction. - Par défaut, vaut &false;. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - Documentation SVN sur l'effacement - - - - - diff --git a/reference/svn/functions/svn-diff.xml b/reference/svn/functions/svn-diff.xml deleted file mode 100644 index e197f24db3..0000000000 --- a/reference/svn/functions/svn-diff.xml +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - - svn_diff - Compare deux chemins, récursivement - - - - &reftitle.description; - - arraysvn_diff - stringpath1 - intrev1 - stringpath2 - intrev2 - - - Compare deux chemins, path1 et - path2, récursivement. - - - - Ce n'est pas un véritable utilitaire de comparaison. Seuls les fichiers - locaux qui sont versionnés peuvent être comparés : les autres fichiers - échoueront. - - - - - - &reftitle.parameters; - - - path1 - - - Premier chemin. Peut être une URL vers un fichier/dossier d'un - référentiel SVN ou un chemin vers un fichier/dossier local. - - &svn.relativepath; - - - Si un chemin vers un fichier local n'a que des antislashs et aucun - slashs, cette extension échouera. Remplacer toujours tous les - antislashs avec des slashs lors de l'utilisation de cette fonction. - - - - - - rev1 - - - Numéro de révision du premier chemin. Utiliser la constante - SVN_REVISION_HEAD pour spécifier la révision - la plus récente. - - - - - path2 - - - Deuxième chemin à comparer. Voir le paramètre - path1 pour la description. - - - - - rev2 - - - Numéro de révision du second chemin. Voir le paramètre - rev1 pour la description. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant 2 flux : le premier représente la sortie - de la comparaison, et le second contient les erreurs. Les flux peuvent - être lus en utilisant la fonction fread. Retourne - &false; ou &null; si une erreur survient. - - - La sortie du comparateur peut, par défaut, être au format de comparaison - unifié Subversion, mais un - moteur externe de - comparaison peut être utilisé, suivant la configuration SVN. - - - - - &reftitle.examples; - - Exemple d'utilisation - - Cet exemple montre une utilisation basique de cette fonction et récupère - le contenu depuis les flux : - - - -]]> - - &example.outputs; - - - - - - Comparaison de deux révisions d'un chemin du référentiel - - Cet exemple implémente un gestionnaire permettant - à un utilisateur de comparer facilement deux révisions d'un élément - en utilisant un chemin de référentiel externe (la syntaxe par défaut est verbeuse) : - - - -]]> - - - - Comparaison, plus portable, de deux fichiers locaux - - Cet exemple implémente un gestionnaire permettant de comparer - deux fichiers locaux, de façon plus portable en gérant le problème de - realpath et le bogue sur les antislashs : - - - -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - Documentation SVN sur la commande "svn diff" - - - - - diff --git a/reference/svn/functions/svn-export.xml b/reference/svn/functions/svn-export.xml deleted file mode 100644 index cd93e30104..0000000000 --- a/reference/svn/functions/svn-export.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - svn_export - Exporte le contenu d'un dossier SVN - - - - &reftitle.description; - - boolsvn_export - stringfrompath - stringtopath - boolworking_copy&true; - intrevision_no-1 - - - Exporte le contenu soit d'une copie de travail, soit d'un référentiel - dans un dossier "propre". - - - - - &reftitle.parameters; - - - frompath - - - Le chemin du dossier à exporter. - - - - - topath - - - Le chemin du nouveau dossier. - - - - - working_copy - - - Si &true;, ceci exportera aussi les fichiers non-livrés de la copie de travail. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple d'utilisation de <function>svn_export</function> - - -]]> - - - - - - &reftitle.seealso; - - svn_import - - - - - diff --git a/reference/svn/functions/svn-fs-abort-txn.xml b/reference/svn/functions/svn-fs-abort-txn.xml deleted file mode 100644 index 34e15aa4d3..0000000000 --- a/reference/svn/functions/svn-fs-abort-txn.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - svn_fs_abort_txn - Interrompre une transaction - - - - &reftitle.description; - - boolsvn_fs_abort_txn - resourcetxn - - &warn.undocumented.func; - - Stoppe une transaction, retourne &true; si tout est Ok, &false; sinon. - - - - - &reftitle.parameters; - - - txn - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-apply-text.xml b/reference/svn/functions/svn-fs-apply-text.xml deleted file mode 100644 index 4132107a8e..0000000000 --- a/reference/svn/functions/svn-fs-apply-text.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - svn_fs_apply_text - Crée et retourne un flux à utiliser pour remplacer le contenu d'un fichier - - - - &reftitle.description; - - resourcesvn_fs_apply_text - resourceroot - stringpath - - &warn.undocumented.func; - - Crée et retourne un flux à utiliser pour remplacer le contenu d'un fichier. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-begin-txn2.xml b/reference/svn/functions/svn-fs-begin-txn2.xml deleted file mode 100644 index 9276cae1f4..0000000000 --- a/reference/svn/functions/svn-fs-begin-txn2.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - svn_fs_begin_txn2 - Crée une nouvelle transaction - - - - &reftitle.description; - - resourcesvn_fs_begin_txn2 - resourcerepos - intrev - - &warn.undocumented.func; - - Crée une nouvelle transaction. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-change-node-prop.xml b/reference/svn/functions/svn-fs-change-node-prop.xml deleted file mode 100644 index 9f53955dcd..0000000000 --- a/reference/svn/functions/svn-fs-change-node-prop.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - svn_fs_change_node_prop - Retourne &true; si tout est Ok, &false; sinon - - - - &reftitle.description; - - boolsvn_fs_change_node_prop - resourceroot - stringpath - stringname - stringvalue - - &warn.undocumented.func; - - Retourne &true; si tout est Ok, &false; sinon. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-check-path.xml b/reference/svn/functions/svn-fs-check-path.xml deleted file mode 100644 index 827c75571c..0000000000 --- a/reference/svn/functions/svn-fs-check-path.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - svn_fs_check_path - Détermine quel type d'élément est pointé par un chemin donné - - - - &reftitle.description; - - intsvn_fs_check_path - resourcefsroot - stringpath - - &warn.undocumented.func; - - Détermine quel type d'élément est pointé par un chemin donné. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-contents-changed.xml b/reference/svn/functions/svn-fs-contents-changed.xml deleted file mode 100644 index a27cfb3612..0000000000 --- a/reference/svn/functions/svn-fs-contents-changed.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - svn_fs_contents_changed - Retourne &true; si le contenu est différent, &false; sinon - - - - &reftitle.description; - - boolsvn_fs_contents_changed - resourceroot1 - stringpath1 - resourceroot2 - stringpath2 - - &warn.undocumented.func; - - Retourne &true; si le contenu est différent, &false; sinon - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-copy.xml b/reference/svn/functions/svn-fs-copy.xml deleted file mode 100644 index e1be28ef37..0000000000 --- a/reference/svn/functions/svn-fs-copy.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - svn_fs_copy - Copie un fichier ou un dossier - - - - &reftitle.description; - - boolsvn_fs_copy - resourcefrom_root - stringfrom_path - resourceto_root - stringto_path - - &warn.undocumented.func; - - Copie un fichier ou un dossier. - - - - - &reftitle.parameters; - - - from_root - - - - - - - - from_path - - - - - - - - to_root - - - - - - - - to_path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-delete.xml b/reference/svn/functions/svn-fs-delete.xml deleted file mode 100644 index 13f54174d7..0000000000 --- a/reference/svn/functions/svn-fs-delete.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - svn_fs_delete - Supprime un fichier ou un dossier - - - - &reftitle.description; - - boolsvn_fs_delete - resourceroot - stringpath - - &warn.undocumented.func; - - Supprime un fichier ou un dossier. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-dir-entries.xml b/reference/svn/functions/svn-fs-dir-entries.xml deleted file mode 100644 index fd8996ac9b..0000000000 --- a/reference/svn/functions/svn-fs-dir-entries.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - svn_fs_dir_entries - Énumère les éléments d'un dossier - - - - &reftitle.description; - - arraysvn_fs_dir_entries - resourcefsroot - stringpath - - &warn.undocumented.func; - - Énumère les éléments d'un dossier. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-file-contents.xml b/reference/svn/functions/svn-fs-file-contents.xml deleted file mode 100644 index ce2db01dbc..0000000000 --- a/reference/svn/functions/svn-fs-file-contents.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - svn_fs_file_contents - Retourne un flux afin d'accéder au contenu d'un fichier pour une révision donnée - - - - &reftitle.description; - - resourcesvn_fs_file_contents - resourcefsroot - stringpath - - &warn.undocumented.func; - - Retourne un flux afin d'accéder au contenu d'un fichier pour une révision donnée. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-file-length.xml b/reference/svn/functions/svn-fs-file-length.xml deleted file mode 100644 index 2b15f351aa..0000000000 --- a/reference/svn/functions/svn-fs-file-length.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - svn_fs_file_length - Retourne la taille d'un fichier pour une révision donnée - - - - &reftitle.description; - - intsvn_fs_file_length - resourcefsroot - stringpath - - &warn.undocumented.func; - - Retourne la taille d'un fichier pour une révision donnée. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-is-dir.xml b/reference/svn/functions/svn-fs-is-dir.xml deleted file mode 100644 index dd9970684c..0000000000 --- a/reference/svn/functions/svn-fs-is-dir.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - svn_fs_is_dir - Détermine si un chemin donné pointe vers un dossier - - - - &reftitle.description; - - boolsvn_fs_is_dir - resourceroot - stringpath - - &warn.undocumented.func; - - Détermine si un chemin donné pointe vers un dossier. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si le chemin pointe vers un dossier, &false; sinon. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-is-file.xml b/reference/svn/functions/svn-fs-is-file.xml deleted file mode 100644 index de8184562c..0000000000 --- a/reference/svn/functions/svn-fs-is-file.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - svn_fs_is_file - Détermine si un chemin donné pointe vers un fichier - - - - &reftitle.description; - - boolsvn_fs_is_file - resourceroot - stringpath - - &warn.undocumented.func; - - Détermine si un chemin donné pointe vers un fichier. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si le chemin pointe vers un fichier, &false; sinon. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-make-dir.xml b/reference/svn/functions/svn-fs-make-dir.xml deleted file mode 100644 index 268348a96d..0000000000 --- a/reference/svn/functions/svn-fs-make-dir.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - svn_fs_make_dir - Crée un nouveau dossier vide - - - - &reftitle.description; - - boolsvn_fs_make_dir - resourceroot - stringpath - - &warn.undocumented.func; - - Crée un nouveau dossier. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-make-file.xml b/reference/svn/functions/svn-fs-make-file.xml deleted file mode 100644 index 701656dafb..0000000000 --- a/reference/svn/functions/svn-fs-make-file.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - svn_fs_make_file - Crée un nouveau fichier vide - - - - &reftitle.description; - - boolsvn_fs_make_file - resourceroot - stringpath - - &warn.undocumented.func; - - Crée un nouveau fichier vide. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-node-created-rev.xml b/reference/svn/functions/svn-fs-node-created-rev.xml deleted file mode 100644 index 40cbd5528b..0000000000 --- a/reference/svn/functions/svn-fs-node-created-rev.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - svn_fs_node_created_rev - Retourne la révision dans laquelle le chemin, sous fsroot, a été créé - - - - &reftitle.description; - - intsvn_fs_node_created_rev - resourcefsroot - stringpath - - &warn.undocumented.func; - - Retourne la révision dans laquelle le chemin, sous fsroot, a été créé. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-node-prop.xml b/reference/svn/functions/svn-fs-node-prop.xml deleted file mode 100644 index 1114f15da9..0000000000 --- a/reference/svn/functions/svn-fs-node-prop.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - svn_fs_node_prop - Retourne la valeur d'une propriété d'un nœud - - - - &reftitle.description; - - stringsvn_fs_node_prop - resourcefsroot - stringpath - stringpropname - - &warn.undocumented.func; - - Retourne la valeur d'une propriété d'un nœud. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-props-changed.xml b/reference/svn/functions/svn-fs-props-changed.xml deleted file mode 100644 index 4a723c646c..0000000000 --- a/reference/svn/functions/svn-fs-props-changed.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - svn_fs_props_changed - Retourne &true; si les propriétés sont différentes, &false; sinon - - - - &reftitle.description; - - boolsvn_fs_props_changed - resourceroot1 - stringpath1 - resourceroot2 - stringpath2 - - &warn.undocumented.func; - - Retourne &true; si les propriétés sont différentes, &false; sinon. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-revision-prop.xml b/reference/svn/functions/svn-fs-revision-prop.xml deleted file mode 100644 index cb67883d97..0000000000 --- a/reference/svn/functions/svn-fs-revision-prop.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - svn_fs_revision_prop - Récupère la valeur d'une propriété nommée - - - - &reftitle.description; - - stringsvn_fs_revision_prop - resourcefs - intrevnum - stringpropname - - &warn.undocumented.func; - - Récupère la valeur d'une propriété nommée. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-revision-root.xml b/reference/svn/functions/svn-fs-revision-root.xml deleted file mode 100644 index 65a326c612..0000000000 --- a/reference/svn/functions/svn-fs-revision-root.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - svn_fs_revision_root - Récupère un gestionnaire sur une révision spécifique sur la racine du référentiel - - - - &reftitle.description; - - resourcesvn_fs_revision_root - resourcefs - intrevnum - - &warn.undocumented.func; - - Récupère un gestionnaire sur une révision spécifique de la racine du référentiel. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-txn-root.xml b/reference/svn/functions/svn-fs-txn-root.xml deleted file mode 100644 index ed62223c17..0000000000 --- a/reference/svn/functions/svn-fs-txn-root.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - svn_fs_txn_root - Crée et retourne une racine de transaction - - - - &reftitle.description; - - resourcesvn_fs_txn_root - resourcetxn - - &warn.undocumented.func; - - Crée et retourne une racine de transaction. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-youngest-rev.xml b/reference/svn/functions/svn-fs-youngest-rev.xml deleted file mode 100644 index 7f087aae47..0000000000 --- a/reference/svn/functions/svn-fs-youngest-rev.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - svn_fs_youngest_rev - Retourne le numéro de la révision la plus récente du système de fichiers - - - - &reftitle.description; - - intsvn_fs_youngest_rev - resourcefs - - &warn.undocumented.func; - - Retourne le numéro de la révision la plus récente du système de fichiers. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-import.xml b/reference/svn/functions/svn-import.xml deleted file mode 100644 index b95f947126..0000000000 --- a/reference/svn/functions/svn-import.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - svn_import - Importe un chemin non-versionné dans un référentiel - - - - &reftitle.description; - - boolsvn_import - stringpath - stringurl - boolnonrecursive - - - Livre un chemin path non-versionné dans le - référentiel à l'URL url. Si path - est un dossier et nonrecursive vaut &false;, - le dossier sera importé récursivement. - - - - - &reftitle.parameters; - - - path - - - Chemin vers le fichier ou le dossier à importer. - - &svn.relativepath; - - - - url - - - URL du référentiel dans lequel on importe. - - - - - nonrecursive - - - Si l'on doit ou non effectuer une importation récursive. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple d'utilisation - - Cet exemple montre un usage classique de cette fonction. Pour importer - un dossier nommé "new-files" dans le référentiel à l'URL - "http://www.example.com/svnroot/incoming/abc", utiliser : - - - -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_add - Documentation SVN sur la commande "svn import" - - - - - diff --git a/reference/svn/functions/svn-log.xml b/reference/svn/functions/svn-log.xml deleted file mode 100644 index 92a60c5373..0000000000 --- a/reference/svn/functions/svn-log.xml +++ /dev/null @@ -1,225 +0,0 @@ - - - - - - - svn_log - Récupère le message d'historisation d'une URL du référentiel - - - - &reftitle.description; - - arraysvn_log - stringrepos_url - intstart_revision - intend_revision - intlimit0 - intflagsSVN_DISCOVER_CHANGED_PATHS | SVN_STOP_ON_COPY - - - svn_log récupère l'historique complet de l'élément - correspondant à l'URL repos_url, ou l'historique d'une révision spécifique - si start_revision est spécifié. Cette fonction est équivalente - à la commande svn log --verbose -r $start_revision $repos_url. - - - - - &reftitle.parameters; - - - repos_url - - - URL dans le référentiel de l'élément dont on doit récupérer l'historique. - - - - - start_revision - - - Numéro de révision de la première historisation à récupérer. Utiliser - la constante SVN_REVISION_HEAD pour récupérer - l'historisation de la révision la plus récente. - - - - - end_revision - - - Numéro de révision de la dernière historisation à récupérer. Par défaut vaut - start_revision si elle est spécifiée sinon vaut la - constante SVN_REVISION_INITIAL. - - - - - limit - - - Nombre d'historisations à récupérer. - - - - - flags - - - Toutes combinaisons de SVN_OMIT_MESSAGES, - SVN_DISCOVER_CHANGED_PATHS et - SVN_STOP_ON_COPY. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette fonction retourne un tableau de fichiers - au format : - - Tableau, ordonné du numéro de révision le plus grand, au plus petit -( - [rev] => numéro de révision - [author] => nom de l'auteur - [msg] => message d'historisation - [date] => date, au format ISO 8601, i.e. date('c') - [paths] => Tableau, décrivant les fichiers modifiés - ( - [0] => Array - ( - [action] => lettre, spécifiant la modification - [path] => chemin absolu du référentiel vers le fichier modifié - ) - [1] => ... - ) -) -[1] => ... -]]> - - - - - La sortie sera toujours un tableau indexé numériquement de tableaux, - même s'il n'y en a aucun, ou seulement un seul message d'historisation. - - - - La valeur de action est une sous-partie de - la sortie de statut - dans la première colonne, où les valeurs possibles sont : - - - Actions - - - - Lettre - Description - - - - - M - L'élément a été modifié - - - A - L'élément a été ajouté - - - D - L'élément a été effacé - - - R - L'élément a été remplacé - - - -
    - - Si aucune modification n'a été effectuée à l'élément, un tableau - vide sera retourné. - -     - - - &reftitle.examples; - - Exemple avec <function>svn_log</function> - - -]]> - - &example.outputs.similar; - - Array - ( - [rev] => 23 - [author] => 'joe' - [msg] => 'Add cheese and salami to our sandwich.' - [date] => '2007-04-06T16:00:27-04:00' - [paths] => Array - ( - [0] => Array - ( - [action] => 'M' - [path] => '/sandwich.txt' - ) - ) - ) -) -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - Documentation SVN pour la commande "svn log" - - - - -     - diff --git a/reference/svn/functions/svn-ls.xml b/reference/svn/functions/svn-ls.xml deleted file mode 100644 index bba6c3fbd7..0000000000 --- a/reference/svn/functions/svn-ls.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - svn_ls - Retourne la liste du contenu d'un dossier d'un référentiel, optionnellement à la révision fournie - - - &reftitle.description; - - arraysvn_ls - stringrepos_url - intrevision_noSVN_REVISION_HEAD - boolrecurse&false; - boolpeg&false; - - - Cette fonction interroge l'URL du référentiel et retourne une liste - des fichiers et dossiers, optionnellement depuis une révision - spécifique. C'est l'équivalent de la commande - svn list $repos_url[@$revision_no] - - - - Cette fonction ne fonctionne pas avec les copies de travail. - repos_url DOIT être une URL de référentiel. - - - - - - &reftitle.parameters; - - - url - - - URL du référentiel, e.g. http://www.example.com/svnroot. - Pour accéder à un référentiel local Subversion via le système de fichiers, - utiliser l'URI suivant : file:///home/user/svn-repos - - - - - revision - - - Numéro de révision à utiliser. S'il est omis, HEAD sera utilisé. - - - - - recurse - - - Active la récursivité. - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette fonction retourne un tableau de fichiers, - listés sous la forme : - - Array - ( - [created_rev] => numéro de révision de la dernière édition - [last_author] => nom de l'auteur de la dernière édition - [size] => taille du fichier - [time] => date et heure de la dernière édition, au format 'M d H:i' - ou 'M d Y', suivant l'âge du fichier - [time_t] => timestamp Unix de la dernière édition - [name] => nom du fichier ou du dossier - [type] => type, peut être 'file' ou 'dir' - ) -[1] => ... -]]> - - - - - - &reftitle.examples; - - Exemple avec <function>svn_ls</function> - - -]]> - - &example.outputs.similar; - - Array - ( - [created_rev] => 20 - [last_author] => Joe - [size] => 0 - [time] => Apr 02 09:28 - [time_t] => 1175520529 - [name] => tags - [type] => dir - ) - [1] => Array - ( - [created_rev] => 23 - [last_author] => Bob - [size] => 0 - [time] => Apr 02 15:15 - [time_t] => 1175541322 - [name] => trunk - [type] => dir - ) -) -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - Documentation SVN sur la commande "svn list" - - - - - diff --git a/reference/svn/functions/svn-mkdir.xml b/reference/svn/functions/svn-mkdir.xml deleted file mode 100644 index e65e274228..0000000000 --- a/reference/svn/functions/svn-mkdir.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - svn_mkdir - Crée un dossier dans la copie de travail ou dans le référentiel - - - - &reftitle.description; - - boolsvn_mkdir - stringpath - stringlog_message - - - Crée un dossier dans la copie de travail ou dans le référentiel. - - - - - &reftitle.parameters; - - - path - - - Le chemin vers la copie de travail ou le référentiel. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - svn_add - svn_copy - - - - - diff --git a/reference/svn/functions/svn-repos-create.xml b/reference/svn/functions/svn-repos-create.xml deleted file mode 100644 index df18c55aad..0000000000 --- a/reference/svn/functions/svn-repos-create.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - svn_repos_create - Crée un nouveau référentiel Subversion - - - - &reftitle.description; - - resourcesvn_repos_create - stringpath - arrayconfig - arrayfsconfig - - &warn.undocumented.func; - - Crée un nouveau référentiel Subversion dans le chemin fourni. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml b/reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml deleted file mode 100644 index 30a85a05f6..0000000000 --- a/reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - svn_repos_fs_begin_txn_for_commit - Crée une nouvelle transaction - - - - &reftitle.description; - - resourcesvn_repos_fs_begin_txn_for_commit - resourcerepos - intrev - stringauthor - stringlog_msg - - &warn.undocumented.func; - - Crée une nouvelle transaction. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-repos-fs-commit-txn.xml b/reference/svn/functions/svn-repos-fs-commit-txn.xml deleted file mode 100644 index f0b43e46c8..0000000000 --- a/reference/svn/functions/svn-repos-fs-commit-txn.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - svn_repos_fs_commit_txn - Livre une transaction et retourne la nouvelle révision - - - - &reftitle.description; - - intsvn_repos_fs_commit_txn - resourcetxn - - &warn.undocumented.func; - - Livre une transaction et retourne la nouvelle révision. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-repos-fs.xml b/reference/svn/functions/svn-repos-fs.xml deleted file mode 100644 index cf7d0134c0..0000000000 --- a/reference/svn/functions/svn-repos-fs.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - svn_repos_fs - Récupère un gestionnaire du système de fichiers - - - - &reftitle.description; - - resourcesvn_repos_fs - resourcerepos - - &warn.undocumented.func; - - Récupère un gestionnaire du système de fichiers. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-repos-hotcopy.xml b/reference/svn/functions/svn-repos-hotcopy.xml deleted file mode 100644 index c316d05b57..0000000000 --- a/reference/svn/functions/svn-repos-hotcopy.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - svn_repos_hotcopy - Effectue une copie à chaud du référentiel - - - - &reftitle.description; - - boolsvn_repos_hotcopy - stringrepospath - stringdestpath - boolcleanlogs - - &warn.undocumented.func; - - Effectue une copie à chaud du référentiel situé dans repospath vers destpath. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-repos-open.xml b/reference/svn/functions/svn-repos-open.xml deleted file mode 100644 index d0d347f8bb..0000000000 --- a/reference/svn/functions/svn-repos-open.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - svn_repos_open - Ouvre un verrou partagé sur un référentiel - - - - &reftitle.description; - - resourcesvn_repos_open - stringpath - - &warn.undocumented.func; - - Ouvre un verrou partagé sur un référentiel. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-repos-recover.xml b/reference/svn/functions/svn-repos-recover.xml deleted file mode 100644 index 42894dbdea..0000000000 --- a/reference/svn/functions/svn-repos-recover.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - svn_repos_recover - Exécute les procédures de récupération du référentiel - - - - &reftitle.description; - - boolsvn_repos_recover - stringpath - - &warn.undocumented.func; - - Exécute les procédures de récupération du référentiel. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-revert.xml b/reference/svn/functions/svn-revert.xml deleted file mode 100644 index 7788f00502..0000000000 --- a/reference/svn/functions/svn-revert.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - svn_revert - Revenir en arrière sur les changements de la copie de travail - - - - &reftitle.description; - - boolsvn_revert - stringpath - boolrecursive&false; - - - Revient en arrière sur tout changement local du chemin dans la copie de travail. - - - - - &reftitle.parameters; - - - path - - - Le chemin vers l'élément dans la copie de travail. - - - - - recursive - - - Optionnellement applique ceci récursivement. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - svn_delete - svn_export - - - - - diff --git a/reference/svn/functions/svn-status.xml b/reference/svn/functions/svn-status.xml deleted file mode 100644 index bc22cea74b..0000000000 --- a/reference/svn/functions/svn-status.xml +++ /dev/null @@ -1,363 +0,0 @@ - - - - - - - svn_status - Récupère le statut des fichiers et des dossiers de la copie de travail - - - - &reftitle.description; - - arraysvn_status - stringpath - intflags0 - - - Retourne le statut des fichiers et des dossiers de la copie de travail, en fournissant - les modifications, les ajouts, les suppressions, ainsi que les autres modifications - des éléments de la copie de travail. - - - - - &reftitle.parameters; - - - path - - - Chemin local vers le fichier ou le dossier dont on souhaite récupérer le statut. - - &svn.relativepath; - - - - flags - - - Toute combinaison de Svn::NON_RECURSIVE, - Svn::ALL (indépendamment du statut de modification), - Svn::SHOW_UPDATES (les entrées seront ajoutées pour les éléments - qui ne sont pas à jour), Svn::NO_IGNORE (néglige les propriétés - svn:ignore lors de l'analyse des nouveaux fichiers) - et Svn::IGNORE_EXTERNALS. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau indexé numériquement de tableaux associatifs - détaillant le statut des éléments du référentiel : - - - Array ( - // information sur l'élément - ) - [1] => ... -) -]]> - - - L'information sur un élément est un tableau associatif qui peut contenir - les clés suivantes : - - - - path - - - Chemin vers le fichier/dossier de cette entrée sur le système de fichiers - local. - - - - - text_status - - - Statut du texte de l'élément. &svn.referto.status; - - - - - repos_text_status - - - Statut du texte de l'élément dans le référentiel. Ne survient que si - update est défini à &true;. - &svn.referto.status; - - - - - prop_status - - - Statut de la propriété de l'élément. &svn.referto.status; - - - - - repos_prop_status - - - Statut de la propriété de l'élément dans le référentiel. Ne survient que si - update est défini à &true;. &svn.referto.status; - - - - - locked - - - Si l'élément est verrouillé. (Défini que si &true;.) - - - - - copied - - - Si l'élément a été copié ou non (prévu pour l'ajout avec la journalisation). - (Défini que si &true;.) - - - - - switched - - - Si l'élément a changé de référentiel de référence, - en utilisant la commande switch. - (Défini que si &true;) - - - - - - Ces clés ne sont définies que si l'élément est versionné : - - - - name - - - Nom de base de l'élément dans le référentiel. - - - - - url - - - URL de l'élément dans le référentiel. - - - - - repos - - - URL de base du référentiel. - - - - - revision - - - Révision de l'élément dans la copie de travail. - - - - - kind - - - Type de l'élément, c.-à-d. fichier ou dossier. &svn.referto.type; - - - - - schedule - - - Action prévue pour l'élément, c.-à-d. ajout ou suppression. - Les constantes pour ces nombres magiques ne sont pas disponibles, - elles peuvent être émulées en utilisant : - - - -]]> - - - - - deleted - - - Si l'élément a été supprimé, mais les révisions parentes existent toujours - (Défini que si &true;.) - - - - - absent - - - Si l'élément est absent, mais que Subversion sait qu'il devrait se - trouver ici. (Défini que si &true;.) - - - - - incomplete - - - Si l'entrée du fichier pour un dossier est incomplète. - (Défini que si &true;.) - - - - - cmt_date - - - Timestamp Unix de la date de la dernière validation. - (Non-Affecté par le paramètre update). - - - - - cmt_rev - - - Révision de la dernière livraison. (Non-Affecté par le paramètre - update). - - - - - cmt_author - - - Nom de l'auteur de la dernière livraison. (Non-Affecté par le - paramètre update). - - - - - prop_time - - - Timestamp Unix représentant la date/heure de la dernière mise à jour - des propriétés. - - - - - text_time - - - Timestamp Unix représentant la date/heure de la dernière mise à jour - du texte. - - - - - - - - &reftitle.examples; - - Exemple d'utilisation - - Cet exemple montre une utilisation basique de cette fonction. - - - -]]> - - &example.outputs.similar; - - Array ( - [path] => /home/bob/wc/sandwich.txt - [text_status] => 8 // l'élément a été modifié - [repos_text_status] => 1 // Aucune information disponible, utiliser update - [prop_status] => 3 // aucun changement - [repos_prop_status] => 1 // Aucune information disponible, utiliser update - [name] => sandwich.txt - [url] => http://www.example.com/svnroot/deli/trunk/sandwich.txt - [repos] => http://www.example.com/svnroot/ - [revision] => 123 - [kind] => 1 // fichier - [schedule] => 0 // aucune action de prévue - [cmt_date] => 1165543135 - [cmt_rev] => 120 - [cmt_author] => Alice - [prop_time] => 1180201728 - [text_time] => 1180201729 - ) -) -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_update - svn_log - Documentation SVN de la commande "svn status" - - - - - diff --git a/reference/svn/functions/svn-update.xml b/reference/svn/functions/svn-update.xml deleted file mode 100644 index 600c8cd254..0000000000 --- a/reference/svn/functions/svn-update.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - svn_update - Met à jour la copie de travail - - - - &reftitle.description; - - intsvn_update - stringpath - intrevnoSVN_REVISION_HEAD - boolrecurse&true; - - - Met à jour la copie de travail pointée par le chemin - path à la révision - revno. Si recurse vaut &true;, - les dossiers seront mis à jour récursivement. - - - - - &reftitle.parameters; - - - path - - - Chemin vers la copie de travail locale. - - &svn.relativepath; - - - - revno - - - Numéro de révision vers lequel mettre à jour ; vaut par défaut SVN_REVISION_HEAD. - - - - - recurse - - - Si l'on doit ou non mettre à jour les dossiers récursivement. - - - - - - - - &reftitle.returnvalues; - - Retourne le nouveau numéro de révision en cas de succès, ou &false; - si une erreur survient. - - - - - &reftitle.examples; - - Exemple d'utilisation - - Cet exemple montre une utilisation basique de cette fonction : - - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_checkout - svn_commit - Documentation SVN pour la commande "svn update" - - - - - diff --git a/reference/svn/reference.xml b/reference/svn/reference.xml deleted file mode 100644 index 948eadb4b5..0000000000 --- a/reference/svn/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; SVN - - &reference.svn.entities.functions; - - - - diff --git a/reference/svn/setup.xml b/reference/svn/setup.xml deleted file mode 100644 index 78e3d72ea1..0000000000 --- a/reference/svn/setup.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Les binaires Subversion ne sont pas nécessaires pour utiliser cette - extension. Cependant, lors de la compilation de l'extension, - libsvn (les en-têtes Subversion) doit être disponible. - -
    - - - - &reference.svn.configure; - - -     - diff --git a/reference/swoole/book.xml b/reference/swoole/book.xml deleted file mode 100644 index 4252cae381..0000000000 --- a/reference/swoole/book.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Swoole - Swoole - - - - &reftitle.intro; - - Swoole est un moteur de communication réseau parallèle basé sur un modèle asynchrone piloté par événements et coroutines, - écrit en C++. Il fournit un support pour les coroutines ainsi qu’une programmation réseau haute performance pour PHP. - Il propose divers modules client et serveur pour plusieurs protocoles de communication, ce qui permet d’implémenter facilement - des services TCP/UDP, des services Web haute performance, WebSocket, IoT, communication en temps réel, jeux, microservices, etc., - dépassant ainsi les limites traditionnelles de PHP dans le domaine du web classique. - - Pour commencer, veuillez consulter la documentation de Swoole. - - ¬e.no-windows.extension; - - - - &reference.swoole.setup; - &reference.swoole.constants; - &reference.swoole.reference; - - &reference.swoole.swoole.async; - &reference.swoole.swoole.atomic; - &reference.swoole.swoole.buffer; - &reference.swoole.swoole.channel; - &reference.swoole.swoole.client; - &reference.swoole.swoole.connection.iterator; - &reference.swoole.swoole.coroutine; - &reference.swoole.swoole.coroutine.lock; - - - - - &reference.swoole.swoole.event; - &reference.swoole.swoole.exception; - &reference.swoole.swoole.http.client; - &reference.swoole.swoole.http.request; - &reference.swoole.swoole.http.response; - &reference.swoole.swoole.http.server; - &reference.swoole.swoole.lock; - &reference.swoole.swoole.mmap; - &reference.swoole.swoole.module; - &reference.swoole.swoole.mysql; - &reference.swoole.swoole.mysql.exception; - &reference.swoole.swoole.process; - &reference.swoole.swoole.redis.server; - &reference.swoole.swoole.runtime; - &reference.swoole.swoole.serialize; - &reference.swoole.swoole.server; - - &reference.swoole.swoole.table; - &reference.swoole.swoole.timer; - &reference.swoole.swoole.websocket.frame; - &reference.swoole.swoole.websocket.server; - - - - diff --git a/reference/swoole/configure.xml b/reference/swoole/configure.xml deleted file mode 100644 index c5d6932612..0000000000 --- a/reference/swoole/configure.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - -
    - &reftitle.install; - - - Utiliser lors de la compilation de PHP. - - - - &pecl.info; - &url.pecl.package;swoole - -
    diff --git a/reference/swoole/constants.xml b/reference/swoole/constants.xml deleted file mode 100644 index 1096d3b2be..0000000000 --- a/reference/swoole/constants.xml +++ /dev/null @@ -1,3874 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - SWOOLE_VERSION - (string) - - - - La version de Swoole. - - - - - - SWOOLE_VERSION_ID - (int) - - - - La version de Swoole. - - - - - - SWOOLE_MAJOR_VERSION - (int) - - - - La version majeure de Swoole. - - - - - - SWOOLE_MINOR_VERSION - (int) - - - - La version mineure de Swoole. - - - - - - SWOOLE_RELEASE_VERSION - (int) - - - - La version release de Swoole. - - - - - - SWOOLE_EXTRA_VERSION - (string) - - - - La version extra de Swoole. - - - - - - SWOOLE_DEBUG - (int) - - - - Le mode débogage de Swoole. - - - - - - SWOOLE_HAVE_COMPRESSION - (int) - - - - Active le mode de compression des réponses HTTP. - - - - - - SWOOLE_HAVE_ZLIB - (int) - - - - Si l'outil de compression zlib est disponible. - - - - - - SWOOLE_HAVE_BROTLI - (int) - - - - Si l'outil de compression brotli est disponible. - - - - - - SWOOLE_USE_HTTP2 - (int) - - - - Le support serveur HTTP2. - - - - - - SWOOLE_USE_SHORTNAME - (int) - - - - Active/désactive les alias courts. - - - - - - SWOOLE_SOCK_TCP - (int) - - - - Le socket TCP ipv4. - - - - - - SWOOLE_SOCK_TCP6 - (int) - - - - Le socket TCP ipv6. - - - - - - SWOOLE_SOCK_UDP - (int) - - - - Le socket UDP ipv4. - - - - - - SWOOLE_SOCK_UDP6 - (int) - - - - Le socket UDP ipv6. - - - - - - SWOOLE_SOCK_UNIX_DGRAM - (int) - - - - Le socket UNIX dgram. - - - - - - SWOOLE_SOCK_UNIX_STREAM - (int) - - - - Le socket UNIX stream. - - - - - - SWOOLE_SOCK_SYNC - (int) - - - - Le mode client synchrone. - - - - - - SWOOLE_SOCK_ASYNC - (int) - - - - Le mode client asynchrone. - - - - - - SWOOLE_KEEP - (int) - - - - Swoole\Client supporte la création d'une connexion TCP longue au serveur dans PHP-FPM/Apache. - - - - - - SWOOLE_SSL - (int) - - - - Active le chiffrement SSL. - - - - - - SWOOLE_SSLv3_METHOD - (int) - - - - Méthode SSLv3. - - - - - - SWOOLE_SSLv3_SERVER_METHOD - (int) - - - - La méthode de serveur SSLv3. - - - - - - SWOOLE_SSLv3_CLIENT_METHOD - (int) - - - - La méthode de client SSLv3. - - - - - - SWOOLE_TLSv1_METHOD - (int) - - - - La méthode TLSv1. - - - - - - SWOOLE_TLSv1_SERVER_METHOD - (int) - - - - La méthode de serveur TLSv1. - - - - - - SWOOLE_TLSv1_CLIENT_METHOD - (int) - - - - La méthode de client TLSv1. - - - - - - SWOOLE_TLSv1_1_METHOD - (int) - - - - La méthode TLSv1_1. - - - - - - SWOOLE_TLSv1_1_SERVER_METHOD - (int) - - - - La méthode de serveur TLSv1_1. - - - - - - SWOOLE_TLSv1_1_CLIENT_METHOD - (int) - - - - La méthode de client TLSv1_1. - - - - - - SWOOLE_TLSv1_2_METHOD - (int) - - - - La méthode TLSv1_2. - - - - - - SWOOLE_TLSv1_2_SERVER_METHOD - (int) - - - - La méthode de serveur TLSv1_2. - - - - - - SWOOLE_TLSv1_2_CLIENT_METHOD - (int) - - - - La méthode de client TLSv1_2. - - - - - - SWOOLE_DTLS_SERVER_METHOD - (int) - - - - La méthode de serveur DTLS. - - - - - - SWOOLE_DTLS_CLIENT_METHOD - (int) - - - - La méthode de client DTLS. - - - - - - SWOOLE_SSLv23_METHOD - (int) - - - - La méthode SSLv23. - - - - - - SWOOLE_SSLv23_SERVER_METHOD - (int) - - - - La méthode de serveur SSLv23. - - - - - - SWOOLE_SSLv23_CLIENT_METHOD - (int) - - - - La méthode de client SSLv23. - - - - - - SWOOLE_TLS_METHOD - (int) - - - - La méthode TLS. - - - - - - SWOOLE_TLS_SERVER_METHOD - (int) - - - - La méthode de serveur TLS. - - - - - - SWOOLE_TLS_CLIENT_METHOD - (int) - - - - La méthode de client TLS. - - - - - - SWOOLE_SSL_SSLv3 - (int) - - - - Le protocole SSLv3. - - - - - - SWOOLE_SSL_TLSv1 - (int) - - - - Le protocole TLSv1. - - - - - - SWOOLE_SSL_TLSv1_1 - (int) - - - - Le protocole TLSv1_1. - - - - - - SWOOLE_SSL_TLSv1_2 - (int) - - - - Le protocole TLSv1_2. - - - - - - SWOOLE_SSL_TLSv1_3 - (int) - - - - Le protocole TLSv1_3. - - - - - - SWOOLE_SSL_DTLS - (int) - - - - Le protocole DTLS. - - - - - - SWOOLE_SSL_SSLv2 - (int) - - - - Le protocole SSLv2. - - - - - - SWOOLE_EVENT_READ - (int) - - - - S'il faut écouter les événements de lecture. - - - - - - SWOOLE_EVENT_WRITE - (int) - - - - S'il faut écouter les événements d'écriture. - - - - - - SWOOLE_STRERROR_SYSTEM - (int) - - - - Convertit le système errno no en messages d'erreur. - - - - - - SWOOLE_STRERROR_GAI - (int) - - - - Convertit l'info addr errno no en messages d'erreur. - - - - - - SWOOLE_STRERROR_DNS - (int) - - - - Convertit le DNS errno no en messages d'erreur. - - - - - - SWOOLE_STRERROR_SWOOLE - (int) - - - - Convertit le swoole errno no en messages d'erreur. - - - - - - SWOOLE_ERROR_MALLOC_FAIL - (int) - - - - Échec de l'allocation de mémoire (MALLOC). - - - - - - SWOOLE_ERROR_SYSTEM_CALL_FAIL - (int) - - - - Échec de l'appel système. - - - - - - SWOOLE_ERROR_PHP_FATAL_ERROR - (int) - - - - Erreur fatale PHP. - - - - - - SWOOLE_ERROR_NAME_TOO_LONG - (int) - - - - Nom trop long. - - - - - - SWOOLE_ERROR_INVALID_PARAMS - (int) - - - - Paramètres invalides. - - - - - - SWOOLE_ERROR_QUEUE_FULL - (int) - - - - La file d'attente est pleine. - - - - - - SWOOLE_ERROR_OPERATION_NOT_SUPPORT - (int) - - - - Opération non supportée. - - - - - - SWOOLE_ERROR_PROTOCOL_ERROR - (int) - - - - Erreur de protocole. - - - - - - SWOOLE_ERROR_WRONG_OPERATION - (int) - - - - Mauvaise opération. - - - - - - SWOOLE_ERROR_PHP_RUNTIME_NOTICE - (int) - - - - Notice d'exécution PHP. - - - - - - SWOOLE_ERROR_FOR_TEST - (int) - - - - Pour tester. - - - - - - SWOOLE_ERROR_NO_PAYLOAD - (int) - - - - Aucun payload. - - - - - - SWOOLE_ERROR_UNDEFINED_BEHAVIOR - (int) - - - - Comportement indéfini. - - - - - - SWOOLE_ERROR_NOT_THREAD_SAFETY - (int) - - - - Pas sécurisé pour les threads. - - - - - - SWOOLE_ERROR_FILE_NOT_EXIST - (int) - - - - Le fichier n'existe pas. - - - - - - SWOOLE_ERROR_FILE_TOO_LARGE - (int) - - - - Fichier trop grand. - - - - - - SWOOLE_ERROR_FILE_EMPTY - (int) - - - - Fichier vide. - - - - - - SWOOLE_ERROR_DNSLOOKUP_DUPLICATE_REQUEST - (int) - - - - La requête de recherche DNS est dupliquée. - - - - - - SWOOLE_ERROR_DNSLOOKUP_RESOLVE_FAILED - (int) - - - - La recherche DNS a échoué. - - - - - - SWOOLE_ERROR_DNSLOOKUP_RESOLVE_TIMEOUT - (int) - - - - La recherche DNS a pris trop de temps. - - - - - - SWOOLE_ERROR_DNSLOOKUP_UNSUPPORTED - (int) - - - - La recherche DNS n'est pas supportée. - - - - - - SWOOLE_ERROR_DNSLOOKUP_NO_SERVER - (int) - - - - La recherche DNS n'a pas de serveur. - - - - - - SWOOLE_ERROR_BAD_IPV6_ADDRESS - (int) - - - - Mauvaise adresse ipv6. - - - - - - SWOOLE_ERROR_UNREGISTERED_SIGNAL - (int) - - - - Signal non enregistré. - - - - - - SWOOLE_ERROR_BAD_HOST_ADDR - (int) - - - - Mauvais hôte addr. - - - - - - SWOOLE_ERROR_EVENT_SOCKET_REMOVED - (int) - - - - Evénement socket supprimé. - - - - - - SWOOLE_ERROR_SESSION_CLOSED_BY_SERVER - (int) - - - - La session a été fermée par le serveur. - - - - - - SWOOLE_ERROR_SESSION_CLOSED_BY_CLIENT - (int) - - - - La session a été fermée par le client. - - - - - - SWOOLE_ERROR_SESSION_CLOSING - (int) - - - - Fermeture de session. - - - - - - SWOOLE_ERROR_SESSION_CLOSED - (int) - - - - Session fermée. - - - - - - SWOOLE_ERROR_SESSION_NOT_EXIST - (int) - - - - La session n'existe pas. - - - - - - SWOOLE_ERROR_SESSION_INVALID_ID - (int) - - - - La session a un id invalide. - - - - - - SWOOLE_ERROR_SESSION_DISCARD_TIMEOUT_DATA - (int) - - - - Données de délai d'expiration de la session. - - - - - - SWOOLE_ERROR_SESSION_DISCARD_DATA - (int) - - - - Données de suppression de session. - - - - - - SWOOLE_ERROR_OUTPUT_BUFFER_OVERFLOW - (int) - - - - Dépassement de capacité du tampon de sortie. - - - - - - SWOOLE_ERROR_OUTPUT_SEND_YIELD - (int) - - - - Rendement d'envoi de sortie - - - - - - SWOOLE_ERROR_SSL_NOT_READY - (int) - - - - SSL pas prêt. - - - - - - SWOOLE_ERROR_SSL_CANNOT_USE_SENFILE - (int) - - - - SSL ne peut utiliser senfile. - - - - - - SWOOLE_ERROR_SSL_EMPTY_PEER_CERTIFICATE - (int) - - - - SSL certificat de pair vide. - - - - - - SWOOLE_ERROR_SSL_VERIFY_FAILED - (int) - - - - SSL vérification échouée. - - - - - - SWOOLE_ERROR_SSL_BAD_CLIENT - (int) - - - - SSL mauvais client. - - - - - - SWOOLE_ERROR_SSL_BAD_PROTOCOL - (int) - - - - SSL mauvais protocole. - - - - - - SWOOLE_ERROR_SSL_RESET - (int) - - - - SSL réinitialisé. - - - - - - SWOOLE_ERROR_SSL_HANDSHAKE_FAILED - (int) - - - - Échec de la poignée de main SSL. - - - - - - SWOOLE_ERROR_PACKAGE_LENGTH_TOO_LARGE - (int) - - - - Longueur de paquet trop grande. - - - - - - SWOOLE_ERROR_PACKAGE_LENGTH_NOT_FOUND - (int) - - - - Longueur de paquet non trouvée. - - - - - - SWOOLE_ERROR_DATA_LENGTH_TOO_LARGE - (int) - - - - Les données sont trop longues. - - - - - - SWOOLE_ERROR_PACKAGE_MALFORMED_DATA - (int) - - - - Erreur de données de paquet malformées. - - - - - - SWOOLE_ERROR_TASK_PACKAGE_TOO_BIG - (int) - - - - Paquet de tâche trop grand. - - - - - - SWOOLE_ERROR_TASK_DISPATCH_FAIL - (int) - - - - Répartition de tâche échouée. - - - - - - SWOOLE_ERROR_TASK_TIMEOUT - (int) - - - - Délai d'expiration de la tâche. - - - - - - SWOOLE_ERROR_HTTP2_STREAM_ID_TOO_BIG - (int) - - - - L'identifiant du flux Http2 est trop grand. - - - - - - SWOOLE_ERROR_HTTP2_STREAM_NO_HEADER - (int) - - - - Le flux Http2 n'a pas d'en-tête. - - - - - - SWOOLE_ERROR_HTTP2_STREAM_NOT_FOUND - (int) - - - - Le flux Http2 n'a pas été trouvé. - - - - - - SWOOLE_ERROR_HTTP2_STREAM_IGNORE - (int) - - - - Le flux Http2 est ignoré. - - - - - - SWOOLE_ERROR_HTTP2_SEND_CONTROL_FRAME_FAILED - (int) - - - - L'envoi du cadre de contrôle Http2 a échoué. - - - - - - SWOOLE_ERROR_AIO_BAD_REQUEST - (int) - - - - Mauvaise requête Aio. - - - - - - SWOOLE_ERROR_AIO_CANCELED - (int) - - - - Aio annulée - - - - - - SWOOLE_ERROR_AIO_TIMEOUT - (int) - - - - Délai d'expiration Aio. - - - - - - SWOOLE_ERROR_CLIENT_NO_CONNECTION - (int) - - - - Le client n'a pas de connexion. - - - - - - SWOOLE_ERROR_SOCKET_CLOSED - (int) - - - - Le socket a été fermé. - - - - - - SWOOLE_ERROR_SOCKET_POLL_TIMEOUT - (int) - - - - Expiration du socket poll. - - - - - - SWOOLE_ERROR_SOCKS5_UNSUPPORT_VERSION - (int) - - - - Version unsupport Socks5 - - - - - - SWOOLE_ERROR_SOCKS5_UNSUPPORT_METHOD - (int) - - - - Méthode Socks5 unsupport. - - - - - - SWOOLE_ERROR_SOCKS5_AUTH_FAILED - (int) - - - - L'authentification Socks5 a échoué. - - - - - - SWOOLE_ERROR_SOCKS5_SERVER_ERROR - (int) - - - - Erreur du serveur Socks5. - - - - - - SWOOLE_ERROR_SOCKS5_HANDSHAKE_FAILED - (int) - - - - La poignée de main Socks5 a échoué. - - - - - - SWOOLE_ERROR_HTTP_PROXY_HANDSHAKE_ERROR - (int) - - - - Erreur de poignée de main du proxy HTTP. - - - - - - SWOOLE_ERROR_HTTP_INVALID_PROTOCOL - (int) - - - - Protocole HTTP invalide. - - - - - - SWOOLE_ERROR_HTTP_PROXY_HANDSHAKE_FAILED - (int) - - - - Échec de la poignée de main du proxy HTTP. - - - - - - SWOOLE_ERROR_HTTP_PROXY_BAD_RESPONSE - (int) - - - - Mauvaise réponse du proxy HTTP. - - - - - - SWOOLE_ERROR_HTTP_CONFLICT_HEADER - (int) - - - - Conflit d'en-tête HTTP. - - - - - - SWOOLE_ERROR_HTTP_CONTEXT_UNAVAILABLE - (int) - - - - Contexte HTTP non disponible. - - - - - - SWOOLE_ERROR_HTTP_COOKIE_UNAVAILABLE - (int) - - - - Cookie HTTP non disponible. - - - - - - SWOOLE_ERROR_WEBSOCKET_BAD_CLIENT - (int) - - - - Mauvais client Websocket. - - - - - - SWOOLE_ERROR_WEBSOCKET_BAD_OPCODE - (int) - - - - Mauvais opcode Websocket. - - - - - - SWOOLE_ERROR_WEBSOCKET_UNCONNECTED - (int) - - - - Websocket non connecté. - - - - - - SWOOLE_ERROR_WEBSOCKET_HANDSHAKE_FAILED - (int) - - - - La poignée de main Websocket a échoué. - - - - - - SWOOLE_ERROR_WEBSOCKET_PACK_FAILED - (int) - - - - L'emballage Websocket a échoué. - - - - - - SWOOLE_ERROR_WEBSOCKET_UNPACK_FAILED - (int) - - - - Le déballage du Websocket a échoué. - - - - - - SWOOLE_ERROR_WEBSOCKET_INCOMPLETE_PACKET - (int) - - - - Paquet Websocket incomplet. - - - - - - SWOOLE_ERROR_SERVER_MUST_CREATED_BEFORE_CLIENT - (int) - - - - Le serveur doit être créé avant le client. - - - - - - SWOOLE_ERROR_SERVER_TOO_MANY_SOCKET - (int) - - - - Le serveur a trop de sockets. - - - - - - SWOOLE_ERROR_SERVER_WORKER_TERMINATED - (int) - - - - Le serveur de travail a été terminé. - - - - - - SWOOLE_ERROR_SERVER_INVALID_LISTEN_PORT - (int) - - - - Port d'écoute du serveur invalide. - - - - - - SWOOLE_ERROR_SERVER_TOO_MANY_LISTEN_PORT - (int) - - - - Le serveur a trop de ports d'écoute. - - - - - - SWOOLE_ERROR_SERVER_PIPE_BUFFER_FULL - (int) - - - - Le tampon de pipe du serveur est plein. - - - - - - SWOOLE_ERROR_SERVER_NO_IDLE_WORKER - (int) - - - - Le serveur n'a pas de travailleur inactif. - - - - - - SWOOLE_ERROR_SERVER_ONLY_START_ONE - (int) - - - - Le serveur ne peut être démarré qu'une seule fois. - - - - - - SWOOLE_ERROR_SERVER_SEND_IN_MASTER - (int) - - - - Serveur envoyé dans le maître. - - - - - - SWOOLE_ERROR_SERVER_INVALID_REQUEST - (int) - - - - Requête invalide du serveur. - - - - - - SWOOLE_ERROR_SERVER_CONNECT_FAIL - (int) - - - - Échec de la connexion du serveur. - - - - - - SWOOLE_ERROR_SERVER_INVALID_COMMAND - (int) - - - - Commande invalide du serveur. - - - - - - SWOOLE_ERROR_SERVER_IS_NOT_REGULAR_FILE - (int) - - - - Le serveur n'est pas un fichier régulier. - - - - - - SWOOLE_ERROR_SERVER_SEND_TO_WOKER_TIMEOUT - (int) - - - - Délai d'expiration de l'envoi du serveur au woker. - - - - - - SWOOLE_ERROR_SERVER_INVALID_CALLBACK - (int) - - - - Fonction de rappel invalide du serveur. - - - - - - SWOOLE_ERROR_SERVER_UNRELATED_THREAD - (int) - - - - Le serveur n'est pas lié à un thread. - - - - - - SWOOLE_ERROR_SERVER_WORKER_EXIT_TIMEOUT - (int) - - - - Délai d'expiration de la sortie du serveur de travail. - - - - - - SWOOLE_ERROR_SERVER_WORKER_ABNORMAL_PIPE_DATA - (int) - - - - Donnée de pipe anormale du serveur de travail. - - - - - - SWOOLE_ERROR_SERVER_WORKER_UNPROCESSED_DATA - (int) - - - - Données non traitées du serveur de travail. - - - - - - SWOOLE_ERROR_CO_OUT_OF_COROUTINE - (int) - - - - Coroutine hors de coroutine. - - - - - - SWOOLE_ERROR_CO_HAS_BEEN_BOUND - (int) - - - - La coroutine a été liée. - - - - - - SWOOLE_ERROR_CO_HAS_BEEN_DISCARDED - (int) - - - - La coroutine a été abandonnée. - - - - - - SWOOLE_ERROR_CO_MUTEX_DOUBLE_UNLOCK - (int) - - - - Le mutex de coroutine a été déverrouillé deux fois. - - - - - - SWOOLE_ERROR_CO_BLOCK_OBJECT_LOCKED - (int) - - - - Le bloc d'objet de coroutine est verrouillé. - - - - - - SWOOLE_ERROR_CO_BLOCK_OBJECT_WAITING - (int) - - - - Le bloc d'objet de coroutine est en attente. - - - - - - SWOOLE_ERROR_CO_YIELD_FAILED - (int) - - - - Le rendement de la coroutine a échoué. - - - - - - SWOOLE_ERROR_CO_GETCONTEXT_FAILED - (int) - - - - Getcontext de la coroutine a échoué. - - - - - - SWOOLE_ERROR_CO_SWAPCONTEXT_FAILED - (int) - - - - Swapcontext de la coroutine a échoué. - - - - - - SWOOLE_ERROR_CO_MAKECONTEXT_FAILED - (int) - - - - Makecontext de la coroutine a échoué. - - - - - - SWOOLE_ERROR_CO_IOCPINIT_FAILED - (int) - - - - Iocpinit de la coroutine a échoué. - - - - - - SWOOLE_ERROR_CO_PROTECT_STACK_FAILED - (int) - - - - Protect stack de la coroutine a échoué. - - - - - - SWOOLE_ERROR_CO_STD_THREAD_LINK_ERROR - (int) - - - - Erreur de lien de thread std de coroutine. - - - - - - SWOOLE_ERROR_CO_DISABLED_MULTI_THREAD - (int) - - - - Désactive le multi-thread de coroutine. - - - - - - SWOOLE_ERROR_CO_CANNOT_CANCEL - (int) - - - - La coroutine ne peut pas être annulée. - - - - - - SWOOLE_ERROR_CO_NOT_EXISTS - (int) - - - - La coroutine n'existe pas. - - - - - - SWOOLE_ERROR_CO_CANCELED - (int) - - - - La coroutine a été annulée. - - - - - - SWOOLE_ERROR_CO_TIMEDOUT - (int) - - - - Coroutine a expiré. - - - - - - SWOOLE_ERROR_CO_SOCKET_CLOSE_WAIT - (int) - - - - Attente de fermeture de socket de coroutine. - - - - - - SWOOLE_TRACE_SERVER - (int) - - - - Drapeau de journalisation du serveur. - - - - - - SWOOLE_TRACE_CLIENT - (int) - - - - Drapeau de journalisation du client. - - - - - - SWOOLE_TRACE_BUFFER - (int) - - - - Drapeau de journalisation du tampon. - - - - - - SWOOLE_TRACE_CONN - (int) - - - - Drapeau de journalisation de la connexion. - - - - - - SWOOLE_TRACE_EVENT - (int) - - - - Drapeau de journalisation des événements. - - - - - - SWOOLE_TRACE_WORKER - (int) - - - - Drapeau de journalisation du travailleur. - - - - - - SWOOLE_TRACE_MEMORY - (int) - - - - Drapeau de journalisation de la mémoire. - - - - - - SWOOLE_TRACE_REACTOR - (int) - - - - Drapeau de journalisation du réacteur. - - - - - - SWOOLE_TRACE_PHP - (int) - - - - Drapeau de journalisation PHP. - - - - - - SWOOLE_TRACE_HTTP - (int) - - - - Drapeau de journalisation HTTP. - - - - - - SWOOLE_TRACE_HTTP2 - (int) - - - - Drapeau de journalisation HTTP2. - - - - - - SWOOLE_TRACE_EOF_PROTOCOL - (int) - - - - Drapeau de journalisation du protocole eof. - - - - - - SWOOLE_TRACE_LENGTH_PROTOCOL - (int) - - - - Drapeau de journalisation du protocole de longueur. - - - - - - SWOOLE_TRACE_CLOSE - (int) - - - - Drapeau de journalisation de fermeture. - - - - - - SWOOLE_TRACE_WEBSOCKET - (int) - - - - Drapeau de journalisation Websocket. - - - - - - SWOOLE_TRACE_REDIS_CLIENT - (int) - - - - Drapeau de journalisation du client Redis. - - - - - - SWOOLE_TRACE_MYSQL_CLIENT - (int) - - - - Drapeau de journalisation du client MySQL. - - - - - - SWOOLE_TRACE_HTTP_CLIENT - (int) - - - - Drapeau de journalisation du client HTTP. - - - - - - SWOOLE_TRACE_AIO - (int) - - - - Drapeau de journalisation AIO. - - - - - - SWOOLE_TRACE_SSL - (int) - - - - Drapeau de journalisation SSL. - - - - - - SWOOLE_TRACE_NORMAL - (int) - - - - Drapeau de journalisation normal. - - - - - - SWOOLE_TRACE_CHANNEL - (int) - - - - Drapeau de journalisation de canal. - - - - - - SWOOLE_TRACE_TIMER - (int) - - - - Drapeau de journalisation du minuteur. - - - - - - SWOOLE_TRACE_SOCKET - (int) - - - - Drapeau de journalisation de socket. - - - - - - SWOOLE_TRACE_COROUTINE - (int) - - - - Drapeau de journalisation de coroutine. - - - - - - SWOOLE_TRACE_CONTEXT - (int) - - - - Drapeau de journalisation de contexte. - - - - - - SWOOLE_TRACE_CO_HTTP_SERVER - (int) - - - - Drapeau de journalisation du serveur http de coroutine. - - - - - - SWOOLE_TRACE_TABLE - (int) - - - - Drapeau de journalisation de la table. - - - - - - SWOOLE_TRACE_CO_CURL - (int) - - - - Drapeau de journalisation de la coroutine curl. - - - - - - SWOOLE_TRACE_CARES - (int) - - - - Drapeau de journalisation de Cares. - - - - - - SWOOLE_TRACE_ZLIB - (int) - - - - Drapeau de journalisation zlib. - - - - - - SWOOLE_TRACE_CO_PGSQL - (int) - - - - Drapeau de journalisation de la coroutine pgsql. - - - - - - SWOOLE_TRACE_CO_ODBC - (int) - - - - Drapeau de journalisation de la coroutine odbc. - - - - - - SWOOLE_TRACE_CO_ORACLE - (int) - - - - Drapeau de journalisation de la coroutine oracle. - - - - - - SWOOLE_TRACE_CO_SQLITE - (int) - - - - Drapeau de journalisation de la coroutine sqlite. - - - - - - SWOOLE_TRACE_ALL - (int) - - - - Drapeau de journalisation de tous les niveaux. - - - - - - SWOOLE_LOG_DEBUG - (int) - - - - Drapeau de journalisation de débogage. - - - - - - SWOOLE_LOG_TRACE - (int) - - - - Drapeau de journalisation de trace. - - - - - - SWOOLE_LOG_INFO - (int) - - - - Drapeau de journalisation d'information. - - - - - - SWOOLE_LOG_NOTICE - (int) - - - - Drapeau de journalisation de notification. - - - - - - SWOOLE_LOG_WARNING - (int) - - - - Drapeau de journalisation d'avertissement. - - - - - - SWOOLE_LOG_ERROR - (int) - - - - Drapeau de journalisation d'erreur. - - - - - - SWOOLE_LOG_NONE - (int) - - - - Équivaut à désactiver les informations de journalisation, les informations de journalisation ne seront pas lancées. - - - - - - SWOOLE_LOG_ROTATION_SINGLE - (int) - - - - désactive la rotation des journaux. - - - - - - SWOOLE_LOG_ROTATION_MONTHLY - (int) - - - - Tourne les journaux mensuellement. - - - - - - SWOOLE_LOG_ROTATION_DAILY - (int) - - - - Tourne les journaux quotidiennement. - - - - - - SWOOLE_LOG_ROTATION_HOURLY - (int) - - - - Tourne les journaux toutes les heures. - - - - - - SWOOLE_LOG_ROTATION_EVERY_MINUTE - (int) - - - - Tourne les journaux toutes les minutes. - - - - - - SWOOLE_IPC_NONE - (int) - - - - Ne pas utiliser de mécanisme de communication inter-processus (IPC). - - - - - - SWOOLE_IPC_UNIXSOCK - (int) - - - - Pour la communication entre processus (IPC), l'utilisation de sockets Unix (UnixSocket) en mode coroutine - est fortement recommandée. - - - - - - SWOOLE_IPC_SOCKET - (int) - - - - Pour la communication entre processus (IPC), - la méthode listen doit être appelée pour spécifier l'adresse et le port à surveiller. - - - - - - SWOOLE_IOV_MAX - (int) - - - - La limite MAX d'iov. - - - - - - SWOOLE_IOURING_DEFAULT - (int) - - - - En mode interrupt-driven, les I/O sont soumis via le io_uring_enter syscall, - et la complétion est déterminée en vérifiant directement l'état de la file d'attente de complétion. - - - - - - SWOOLE_IOURING_SQPOLL - (int) - - - - En mode d'interrogation du noyau, le noyau crée des threads dédiés pour soumettre et récolter les requêtes I/O, - en éliminant presque les changements de contexte entre l'utilisateur et le noyau. - - - - - - SWOOLE_BASE - (int) - - - - Mode basique. - - - - - - SWOOLE_PROCESS - (int) - - - - Mode multi-processus. - - - - - - SWOOLE_THREAD - (int) - - - - Mode multi-thread. - - - - - - SWOOLE_IPC_UNSOCK - (int) - - - - Le processus de tâche communique avec le processus de travail en utilisant un socket Unix. - - - - - - SWOOLE_IPC_MSGQUEUE - (int) - - - - Le processus de tâche communique avec le processus de travail en utilisant une file de messages Sysv. - - - - - - SWOOLE_IPC_PREEMPTIVE - (int) - - - - Le processus de tâche communique avec le processus de travail en utilisant un mode préemptif sur une file de messages sysvmsg. - - - - - - SWOOLE_SERVER_COMMAND_MASTER - (int) - - - - Le processus maître accepte les requêtes. - - - - - - SWOOLE_SERVER_COMMAND_MANAGER - (int) - - - - Le processus de gestion accepte les requêtes. - - - - - - SWOOLE_SERVER_COMMAND_REACTOR_THREAD - (int) - - - - Le thread Reactor accepte les requêtes. - - - - - - SWOOLE_SERVER_COMMAND_EVENT_WORKER - (int) - - - - Le processus de travailleur d'événement accepte les requêtes. - - - - - - SWOOLE_SERVER_COMMAND_TASK_WORKER - (int) - - - - Le processus de travailleur de tâche accepte les requêtes. - - - - - - SWOOLE_DISPATCH_ROUND - (int) - - - - Mode round robin, chaque processus Worker sera alloué séquentiellement pour chaque connexion reçue. - - - - - - SWOOLE_DISPATCH_FDMOD - (int) - - - - Alloue le Worker en fonction du descripteur de fichier de la connexion. Cela garantit que les données de la même connexion - seront traitées par le même Worker uniquement. - - - - - - SWOOLE_DISPATCH_IDLE_WORKER - (int) - - - - Le processus principal choisira la livraison en fonction de l'état de charge de travail du Worker, ne livrant qu'aux Workers inactifs. - - - - - - SWOOLE_DISPATCH_IPMOD - (int) - - - - Allocation basée sur l'IP du client en utilisant un hachage modulo, assignant à un processus Worker spécifique. - Cela assure que les données de la même connexion source IP seront toujours assignées au - même processus Worker. Algorithme : inet_addr_mod(ClientIP, worker_num). - - - - - - SWOOLE_DISPATCH_UIDMOD - (int) - - - - Requiert l'attribution d'un uid unique en appelant Server->bind() dans le code utilisateur. - Puis, le système sous-jacent alloue à différents processus Worker en fonction de la valeur de l'UID. - Algorithme : UID % worker_num. Pour utiliser des chaînes comme UID, il est possible d'utiliser crc32(UID_STRING). - - - - - - SWOOLE_DISPATCH_USERFUNC - (int) - - - - Définit une fonction de rappel dispatch_func, où la valeur de retour détermine - quel processus gère la requête. - - - - - - SWOOLE_DISPATCH_CO_CONN_LB - (int) - - - - Détermine quel processus gère la requête en fonction du nombre de connexions. - - - - - - SWOOLE_DISPATCH_CO_REQ_LB - (int) - - - - Détermine quel processus gère la requête en fonction du nombre de requêtes. - - - - - - SWOOLE_DISPATCH_CONCURRENT_LB - (int) - - - - Détermine quel processus gère la requête en fonction du nombre de connexions et de requêtes. - - - - - - SWOOLE_WORKER_BUSY - (int) - - - - Le processus est occupé. - - - - - - SWOOLE_WORKER_IDLE - (int) - - - - Le processus est inactif. - - - - - - SWOOLE_WORKER_EXIT - (int) - - - - Le processus est terminé. - - - - - - SWOOLE_MUTEX - (int) - - - - Verrou Mutex. - - - - - - SWOOLE_RWLOCK - (int) - - - - Verrou RW. - - - - - - SWOOLE_SPINLOCK - (int) - - - - Verrou Spin. - - - - - - SWOOLE_CORO_MAX_NUM_LIMIT - (int) - - - - Le nombre maximum de coroutines créées(PHP_INT_MAX). - - - - - - SWOOLE_CORO_INIT - (int) - - - - Initialisation de coroutine. - - - - - - SWOOLE_CORO_WAITING - (int) - - - - Rendement de la coroutine. - - - - - - SWOOLE_CORO_RUNNING - (int) - - - - Complétion de la coroutine. - - - - - - SWOOLE_CORO_END - (int) - - - - Coroutine complétée. - - - - - - SWOOLE_EXIT_IN_COROUTINE - (int) - - - - Exécute la fonction exit() dans la coroutine. - - - - - - SWOOLE_EXIT_IN_SERVER - (int) - - - - Exécute la fonction exit() dans le serveur. - - - - - - SWOOLE_HTTP2_TYPE_DATA - (int) - - - - Trame de données HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_HEADERS - (int) - - - - Trame d'en-tête HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_PRIORITY - (int) - - - - Trame de priorité HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_RST_STREAM - (int) - - - - Trame de rst de flux HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_SETTINGS - (int) - - - - Trame de paramètres HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_PUSH_PROMISE - (int) - - - - Trame de promesse de poussée HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_PING - (int) - - - - Trame de ping HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_GOAWAY - (int) - - - - Trame de goaway HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_WINDOW_UPDATE - (int) - - - - Trame de mise à jour de fenêtre HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_CONTINUATION - (int) - - - - Trame de continuation HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_NO_ERROR - (int) - - - - Aucune erreur HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_PROTOCOL_ERROR - (int) - - - - Erreur de protocole HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_INTERNAL_ERROR - (int) - - - - Erreur interne HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_FLOW_CONTROL_ERROR - (int) - - - - Erreur de contrôle de flux HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_SETTINGS_TIMEOUT - (int) - - - - Erreur de délai d'attente des paramètres HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_STREAM_CLOSED - (int) - - - - Erreur de flux HTTP2 fermé. - - - - - - SWOOLE_HTTP2_ERROR_FRAME_SIZE_ERROR - (int) - - - - Erreur de taille de trame HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_REFUSED_STREAM - (int) - - - - Erreur de flux refusé HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_CANCEL - (int) - - - - Erreur d'annulation HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_COMPRESSION_ERROR - (int) - - - - Erreur de compression HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_CONNECT_ERROR - (int) - - - - Erreur de connexion HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_ENHANCE_YOUR_CALM - (int) - - - - Erreur enhance your calm HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_INADEQUATE_SECURITY - (int) - - - - Erreur de sécurité inadéquate HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_HTTP_1_1_REQUIRED - (int) - - - - Erreur HTTP2 requiert http1.1. - - - - - - SWOOLE_HTTP_CLIENT_ESTATUS_CONNECT_FAILED - (int) - - - - Expiration de la connexion, le serveur n'écoute pas sur le port ou il y a une défaillance réseau, - il est possible de lire $errCode pour obtenir le code d'erreur réseau spécifique. - - - - - - SWOOLE_HTTP_CLIENT_ESTATUS_REQUEST_TIMEOUT - (int) - - - - Expiration de la requête, le serveur n'a pas renvoyé de réponse dans le délai spécifié. - - - - - - SWOOLE_HTTP_CLIENT_ESTATUS_SERVER_RESET - (int) - - - - Après que la requête du client soit envoyée, le serveur a forcé la déconnexion de la connexion. - - - - - - SWOOLE_HTTP_CLIENT_ESTATUS_SEND_FAILED - (int) - - - - Échec de l'envoi au client (cette constante est disponible dans Swoole version >= v4.5.9, - auparavant, utiliser le code d'état). - - - - - - SWOOLE_MSGQUEUE_ORIENT - (int) - - - - Swoole\Process::pop() va retourner une donnée spécifique dans la queue avec le type de message comme id du processus + 1, - Swoole\Process::push() va ajouter le type de message id du processus + 1 à la donnée. - - - - - - SWOOLE_MSGQUEUE_BALANCE - (int) - - - - Swoole\Process::pop() renvoie le premier message dans la queue, - Swoole\Process::push() n'ajoute pas de type spécifique au message. - - - - - - SWOOLE_HOOK_TCP - (int) - - - - Flux basé sur coroutine de type TCP Socket, y compris les types les plus courants comme Redis, PDO, Mysqli. - - - - - - SWOOLE_HOOK_UDP - (int) - - - - Flux basé sur coroutine de type UDP Socket. - - - - - - SWOOLE_HOOK_UNIX - (int) - - - - Flux basé sur coroutine de type Unix Socket. - - - - - - SWOOLE_HOOK_UDG - (int) - - - - Flux basé sur coroutine de type UDG Stream Socket. - - - - - - SWOOLE_HOOK_SSL - (int) - - - - Flux basé sur coroutine de type SSL Stream Socket. - - - - - - SWOOLE_HOOK_TLS - (int) - - - - Flux basé sur coroutine de type TLS Stream Socket. - - - - - - SWOOLE_HOOK_STREAM_FUNCTION - (int) - - - - Flux basé sur coroutine pour les fonctions stream_*. - - - - - - SWOOLE_HOOK_FILE - (int) - - - - Fichier basé sur coroutine pour les fonctions de fichiers. - - - - - - SWOOLE_HOOK_STDIO - (int) - - - - Opérations STDIO basées sur coroutine. - - - - - - SWOOLE_HOOK_SLEEP - (int) - - - - Opérations de sommeil basées sur coroutine, y compris sleep, usleep, time_nanosleep, time_sleep_until. - - - - - - SWOOLE_HOOK_PROC - (int) - - - - Fonctions proc* basées sur coroutine, y compris: proc_open, proc_close, proc_get_status, proc_terminate. - - - - - - SWOOLE_HOOK_CURL - (int) - - - - Extension curl basée sur coroutine. - - - - - - SWOOLE_HOOK_NATIVE_CURL - (int) - - - - Extension curl native basée sur coroutine. - - - - - - SWOOLE_HOOK_BLOCKING_FUNCTION - (int) - - - - Fonction non bloquante basée sur coroutine, y compris: gethostbyname, exec, shell_exec. - - - - - - SWOOLE_HOOK_SOCKETS - (int) - - - - Extension sockets basée sur coroutine. - - - - - - SWOOLE_HOOK_PDO_PGSQL - (int) - - - - Extension pdo_pgsql basée sur coroutine. - - - - - - SWOOLE_HOOK_PDO_ODBC - (int) - - - - Extension pdo_odbc basée sur coroutine. - - - - - - SWOOLE_HOOK_PDO_ORACLE - (int) - - - - Extension pdo_oracle basée sur coroutine. - - - - - - SWOOLE_HOOK_PDO_SQLITE - (int) - - - - Extension pdo_sqlite basée sur coroutine. - - - - - - SWOOLE_HOOK_ALL - (int) - - - - Tous les blocs de fonctions et extensions basées sur coroutine. - - - - - - SOCKET_ECANCELED - (int) - - - - Erreur de socket ecanceled. - - - - - - TCP_INFO - (int) - - - - TCP_INFO. - - - - - - SWOOLE_TIMER_MIN_MS - (int) - - - - Le minimum de l'intervalle de timer supporté (en millisecondes). - - - - - - SWOOLE_TIMER_MIN_SEC - (double) - - - - Le minimum de l'intervalle de timer supporté (en secondes). - - - - - - SWOOLE_TIMER_MAX_MS - (int) - - - - Le maximum de l'intervalle de timer supporté (en millisecondes). - - - - - - SWOOLE_TIMER_MAX_SEC - (int) - - - - Le maximum de l'intervalle de timer supporté (en secondes). - - - - - - SWOOLE_WEBSOCKET_STATUS_CONNECTION - (int) - - - - WebSocket est en phase de connexion. - - - - - - SWOOLE_WEBSOCKET_STATUS_HANDSHAKE - (int) - - - - Le WebSocket est en phase de poignée de main. - - - - - - SWOOLE_WEBSOCKET_STATUS_ACTIVE - (int) - - - - Active la connexion WebSocket. - - - - - - SWOOLE_WEBSOCKET_STATUS_CLOSING - (int) - - - - La connexion WebSocket est fermée. - - - - - - SWOOLE_WEBSOCKET_OPCODE_CONTINUATION - (int) - - - - Trame de continuation WebSocket. - - - - - - SWOOLE_WEBSOCKET_OPCODE_TEXT - (int) - - - - Trame de texte WebSocket. - - - - - - SWOOLE_WEBSOCKET_OPCODE_BINARY - (int) - - - - Trame binaire WebSocket. - - - - - - SWOOLE_WEBSOCKET_OPCODE_CLOSE - (int) - - - - Trame de fermeture WebSocket. - - - - - - SWOOLE_WEBSOCKET_OPCODE_PING - (int) - - - - Trame de ping WebSocket. - - - - - - SWOOLE_WEBSOCKET_OPCODE_PONG - (int) - - - - Trame de pong WebSocket. - - - - - - SWOOLE_WEBSOCKET_FLAG_FIN - (int) - - - - Drapeau FIN WebSocket. - - - - - - SWOOLE_WEBSOCKET_FLAG_RSV1 - (int) - - - - Drapeau RSV1 WebSocket. - - - - - - SWOOLE_WEBSOCKET_FLAG_RSV2 - (int) - - - - Drapeau RSV2 WebSocket. - - - - - - SWOOLE_WEBSOCKET_FLAG_RSV3 - (int) - - - - Drapeau RSV3 WebSocket. - - - - - - SWOOLE_WEBSOCKET_FLAG_MASK - (int) - - - - Drapeau MASK WebSocket. - - - - - - SWOOLE_WEBSOCKET_FLAG_COMPRESS - (int) - - - - Drapeau COMPRESS WebSocket. - - - - - - SWOOLE_WEBSOCKET_CLOSE_NORMAL - (int) - - - - Fermeture normale (la connexion est terminée avec succès). - - - - - - SWOOLE_WEBSOCKET_CLOSE_GOING_AWAY - (int) - - - - L'endpoint est parti (par exemple, onglet navigateur fermé). - - - - - - SWOOLE_WEBSOCKET_CLOSE_PROTOCOL_ERROR - (int) - - - - Erreur de protocole (trame de données malformée). - - - - - - SWOOLE_WEBSOCKET_CLOSE_DATA_ERROR - (int) - - - - Réception de données non supportée (par exemple, binaire alors que du texte est attendu). - - - - - - SWOOLE_WEBSOCKET_CLOSE_STATUS_ERROR - (int) - - - - Aucun code d'état fourni (envoyé comme un espace réservé). - - - - - - SWOOLE_WEBSOCKET_CLOSE_ABNORMAL - (int) - - - - Fermeture anormale (aucune trame de fermeture reçue, par exemple, réinitialisation TCP). - - - - - - SWOOLE_WEBSOCKET_CLOSE_MESSAGE_ERROR - (int) - - - - Données invalides (par exemple, texte non-UTF-8 dans une trame de texte). - - - - - - SWOOLE_WEBSOCKET_CLOSE_POLICY_ERROR - (int) - - - - Violation de la politique (par exemple, action non autorisée). - - - - - - SWOOLE_WEBSOCKET_CLOSE_MESSAGE_TOO_BIG - (int) - - - - Message trop grand (dépasse la taille max du serveur). - - - - - - SWOOLE_WEBSOCKET_CLOSE_EXTENSION_MISSING - (int) - - - - Le client n'a pas négocié les extensions requises. - - - - - - SWOOLE_WEBSOCKET_CLOSE_SERVER_ERROR - (int) - - - - Le serveur a rencontré une erreur. - - - - - - SWOOLE_WEBSOCKET_CLOSE_CLOSE_SERVICE_RESTART - (int) - - - - Le service redémarre (condition temporaire). - - - - - - SWOOLE_WEBSOCKET_CLOSE_TRY_AGAIN_LATER - (int) - - - - Le serveur est temporairement surchargé (le client devrait réessayer). - - - - - - SWOOLE_WEBSOCKET_CLOSE_BAD_GATEWAY - (int) - - - - Réponse invalide du serveur en amont. - - - - - - SWOOLE_WEBSOCKET_CLOSE_TLS - (int) - - - - La poignée de main TLS a échoué (utilisé lorsque HTTPS échoue). - - - - - - - - diff --git a/reference/swoole/functions/swoole-async-dns-lookup.xml b/reference/swoole/functions/swoole-async-dns-lookup.xml deleted file mode 100644 index 815cd0c608..0000000000 --- a/reference/swoole/functions/swoole-async-dns-lookup.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - swoole_async_dns_lookup - Cherche de manière asynchrone et non bloquante l'adresse IP d'un hôte - - - - &reftitle.description; - - boolswoole_async_dns_lookup - stringhostname - callablecallback - - - - - - - - - &reftitle.parameters; - - - hostname - - - Le nom d'hôte. - - - - - callback - - - - mixedcallback - stringhostname - stringip - - - - hostname - - - Le nom d'hôte. - - - - - IP - - - L'adresse IP. - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/swoole/functions/swoole-async-read.xml b/reference/swoole/functions/swoole-async-read.xml deleted file mode 100644 index b5af59ac33..0000000000 --- a/reference/swoole/functions/swoole-async-read.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - swoole_async_read - Lit un flux de fichier de manière asynchrone - - - - &reftitle.description; - - boolswoole_async_read - stringfilename - callablecallback - intchunk_size65536 - intoffset0 - - - - - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier à lire. - - - - - callback - - - mixedcallback - stringfilename - stringcontent - - - - filename - - - Le nom du fichier. - - - - - content - - - Le contenu lu du flux de fichier. - - - - - - - - chunk_size - - - La taille du morceau. - - - - - offset - - - Le décalage. - - - - - - - - &reftitle.returnvalues; - - Si la lecture réussit. - - - - - - diff --git a/reference/swoole/functions/swoole-async-readfile.xml b/reference/swoole/functions/swoole-async-readfile.xml deleted file mode 100644 index 603dd2f8d3..0000000000 --- a/reference/swoole/functions/swoole-async-readfile.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - swoole_async_readfile - Lit un fichier de manière asynchrone - - - - &reftitle.description; - - boolswoole_async_readfile - stringfilename - callablecallback - - - - - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier à lire. - - - - - callback - - - mixedcallback - stringfilename - stringcontent - - - - filename - - - Le nom du fichier. - - - - - content - - - Le contenu lu du fichier. - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/functions/swoole-async-set.xml b/reference/swoole/functions/swoole-async-set.xml deleted file mode 100644 index 7330c22ea3..0000000000 --- a/reference/swoole/functions/swoole-async-set.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - swoole_async_set - Met à jour les options d'E/S asynchrones - - - - &reftitle.description; - - voidswoole_async_set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/swoole/functions/swoole-async-write.xml b/reference/swoole/functions/swoole-async-write.xml deleted file mode 100644 index 7daeb5d8b4..0000000000 --- a/reference/swoole/functions/swoole-async-write.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - swoole_async_write - Ecrit des données dans un flux de fichier de manière asynchrone - - - - &reftitle.description; - - boolswoole_async_write - stringfilename - stringcontent - intoffset - callablecallback - - - - - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier à écrire. - - - - - content - - - Le contenu à écrire dans le fichier. - - - - - offset - - - Le décalage. - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/functions/swoole-async-writefile.xml b/reference/swoole/functions/swoole-async-writefile.xml deleted file mode 100644 index 8e0a56e71e..0000000000 --- a/reference/swoole/functions/swoole-async-writefile.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - swoole_async_writefile - Ecrit des données dans un fichier de manière asynchrone - - - - &reftitle.description; - - boolswoole_async_writefile - stringfilename - stringcontent - callablecallback - intflags0 - - - - - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier à écrire. - - - - - content - - - Le contenu à écrire dans le fichier. - - - - - callback - - - - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/functions/swoole-clear-error.xml b/reference/swoole/functions/swoole-clear-error.xml deleted file mode 100644 index 5c5a276e62..0000000000 --- a/reference/swoole/functions/swoole-clear-error.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - swoole_clear_error - Enlève les erreurs dans le socket ou le dernier code d'erreur - - - - &reftitle.description; - - voidswoole_clear_error - - - - Enlève les erreurs dans le socket ou le dernier code d'erreur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/functions/swoole-client-select.xml b/reference/swoole/functions/swoole-client-select.xml deleted file mode 100644 index 6831dfe14a..0000000000 --- a/reference/swoole/functions/swoole-client-select.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - swoole_client_select - Renvoie la description du fichier prête à être lue/écrite ou une erreur - - - - &reftitle.description; - - intswoole_client_select - arrayread_array - arraywrite_array - arrayerror_array - floattimeout0.5 - - - - - - - - - &reftitle.parameters; - - - read_array - - - - - - - - write_array - - - - - - - - error_array - - - - - - - - timeout - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-cpu-num.xml b/reference/swoole/functions/swoole-cpu-num.xml deleted file mode 100644 index 7450bddef0..0000000000 --- a/reference/swoole/functions/swoole-cpu-num.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - swoole_cpu_num - Renvoie le nombre de CPU - - - - &reftitle.description; - - intswoole_cpu_num - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre de CPU. - - - - - - - diff --git a/reference/swoole/functions/swoole-errno.xml b/reference/swoole/functions/swoole-errno.xml deleted file mode 100644 index 9d02b8d792..0000000000 --- a/reference/swoole/functions/swoole-errno.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_errno - Renvoie le code d'erreur du dernier appel système - - - - &reftitle.description; - - intswoole_errno - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-error-log.xml b/reference/swoole/functions/swoole-error-log.xml deleted file mode 100644 index 53182740e1..0000000000 --- a/reference/swoole/functions/swoole-error-log.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - swoole_error_log - Sort les messages d'erreur dans le journal - - - - &reftitle.description; - - voidswoole_error_log - intlevel - stringmsg - - - Sort les messages d'erreur dans le journal. - - - - - &reftitle.parameters; - - - level - - - Le niveau de journalisation, les constantes suivantes peuvent être utilisées : SWOOLE_LOG_DEBUG, - SWOOLE_LOG_TRACE, - SWOOLE_LOG_INFO, - SWOOLE_LOG_NOTICE, - SWOOLE_LOG_WARNING, - SWOOLE_LOG_ERROR, - SWOOLE_LOG_NONE - - - - - msg - - - Le contenu du message à écrire dans le journal. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/functions/swoole-event-add.xml b/reference/swoole/functions/swoole-event-add.xml deleted file mode 100644 index 2da69c218c..0000000000 --- a/reference/swoole/functions/swoole-event-add.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - swoole_event_add - Ajoute une nouvelle fonction de rappel d'un socket dans l'EventLoop - - - - &reftitle.description; - - intswoole_event_add - intfd - callableread_callback - callablewrite_callback - intevents0 - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - read_callback - - - - - - - - write_callback - - - - - - - - events - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-event-defer.xml b/reference/swoole/functions/swoole-event-defer.xml deleted file mode 100644 index f278124996..0000000000 --- a/reference/swoole/functions/swoole-event-defer.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - swoole_event_defer - Ajoute une fonction de rappel à la prochaine boucle d'événement - - - - &reftitle.description; - - boolswoole_event_defer - callablecallback - - - - - - - - - &reftitle.parameters; - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/functions/swoole-event-del.xml b/reference/swoole/functions/swoole-event-del.xml deleted file mode 100644 index fda992d9e0..0000000000 --- a/reference/swoole/functions/swoole-event-del.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - swoole_event_del - Supprime toutes les fonctions de rappel d'événements d'un socket - - - - &reftitle.description; - - boolswoole_event_del - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/functions/swoole-event-exit.xml b/reference/swoole/functions/swoole-event-exit.xml deleted file mode 100644 index a148984c19..0000000000 --- a/reference/swoole/functions/swoole-event-exit.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_event_exit - Quitte la boucle d'événements, uniquement disponible côté client - - - - &reftitle.description; - - voidswoole_event_exit - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-event-set.xml b/reference/swoole/functions/swoole-event-set.xml deleted file mode 100644 index 0a464f33d4..0000000000 --- a/reference/swoole/functions/swoole-event-set.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - swoole_event_set - Met à jour les fonctions de rappel d'événements d'un socket - - - - &reftitle.description; - - boolswoole_event_set - intfd - callableread_callback - callablewrite_callback - intevents0 - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - read_callback - - - - - - - - write_callback - - - - - - - - events - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-event-wait.xml b/reference/swoole/functions/swoole-event-wait.xml deleted file mode 100644 index 56d2591f1f..0000000000 --- a/reference/swoole/functions/swoole-event-wait.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_event_wait - Commence la boucle d'événements - - - - &reftitle.description; - - voidswoole_event_wait - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-event-write.xml b/reference/swoole/functions/swoole-event-write.xml deleted file mode 100644 index ae834e1133..0000000000 --- a/reference/swoole/functions/swoole-event-write.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - swoole_event_write - Ecrit des données dans un socket - - - - &reftitle.description; - - boolswoole_event_write - intfd - stringdata - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/functions/swoole-get-local-ip.xml b/reference/swoole/functions/swoole-get-local-ip.xml deleted file mode 100644 index ae194e8a9d..0000000000 --- a/reference/swoole/functions/swoole-get-local-ip.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_get_local_ip - Renvoie les adresses IP IPv4 de chaque NIC sur la machine - - - - &reftitle.description; - - arrayswoole_get_local_ip - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-last-error.xml b/reference/swoole/functions/swoole-last-error.xml deleted file mode 100644 index d945b5d27e..0000000000 --- a/reference/swoole/functions/swoole-last-error.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_last_error - Renvoie le dernier message d'erreur - - - - &reftitle.description; - - intswoole_last_error - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-load-module.xml b/reference/swoole/functions/swoole-load-module.xml deleted file mode 100644 index cc1f36b188..0000000000 --- a/reference/swoole/functions/swoole-load-module.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_load_module - Charge une extension swoole - - - - &reftitle.description; - - mixedswoole_load_module - stringfilename - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-select.xml b/reference/swoole/functions/swoole-select.xml deleted file mode 100644 index 7d24271cae..0000000000 --- a/reference/swoole/functions/swoole-select.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - swoole_select - Sélectionne les descriptions de fichiers prêtes à lire/écrire ou en erreur dans la boucle d'événements - - - - &reftitle.description; - - intswoole_select - arrayread_array - arraywrite_array - arrayerror_array - floattimeout - - - - - - - - - &reftitle.parameters; - - - read_array - - - - - - - - write_array - - - - - - - - error_array - - - - - - - - timeout - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-set-process-name.xml b/reference/swoole/functions/swoole-set-process-name.xml deleted file mode 100644 index 6677eba77c..0000000000 --- a/reference/swoole/functions/swoole-set-process-name.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - swoole_set_process_name - Définit le nom du processus - - - - &reftitle.description; - - voidswoole_set_process_name - stringprocess_name - intsize128 - - - - - - - - - &reftitle.parameters; - - - process_name - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-strerror.xml b/reference/swoole/functions/swoole-strerror.xml deleted file mode 100644 index 66eef45f14..0000000000 --- a/reference/swoole/functions/swoole-strerror.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - swoole_strerror - Convertit l'Errno en messages d'erreur - - - - &reftitle.description; - - stringswoole_strerror - interrno - interror_type0 - - - - - - - - - &reftitle.parameters; - - - errno - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-timer-after.xml b/reference/swoole/functions/swoole-timer-after.xml deleted file mode 100644 index 5a4998a990..0000000000 --- a/reference/swoole/functions/swoole-timer-after.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - swoole_timer_after - Déclenche une fonction de rappel unique dans le futur - - - - &reftitle.description; - - intswoole_timer_after - intms - callablecallback - mixedparam - - - - - - - - - &reftitle.parameters; - - - ms - - - - - - - - callback - - - - - - - - param - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-timer-exists.xml b/reference/swoole/functions/swoole-timer-exists.xml deleted file mode 100644 index 5a8ff1a7af..0000000000 --- a/reference/swoole/functions/swoole-timer-exists.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - swoole_timer_exists - Renvoie si une fonction de rappel de minuterie existe - - - - &reftitle.description; - - boolswoole_timer_exists - inttimer_id - - - - - - - - - &reftitle.parameters; - - - timer_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-timer-tick.xml b/reference/swoole/functions/swoole-timer-tick.xml deleted file mode 100644 index 83bdf1fd9e..0000000000 --- a/reference/swoole/functions/swoole-timer-tick.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - swoole_timer_tick - Déclenche une fonction de rappel de minuterie par intervalle de temps - - - - &reftitle.description; - - intswoole_timer_tick - intms - callablecallback - mixedparam - - - - - - - - - &reftitle.parameters; - - - ms - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-version.xml b/reference/swoole/functions/swoole-version.xml deleted file mode 100644 index a50b582b9b..0000000000 --- a/reference/swoole/functions/swoole-version.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_version - Renvoie la version de Swoole - - - - &reftitle.description; - - stringswoole_version - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La version de Swoole. - - - - - - - diff --git a/reference/swoole/ini.xml b/reference/swoole/ini.xml deleted file mode 100644 index 1b5fead1ed..0000000000 --- a/reference/swoole/ini.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; de Swoole - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - swoole.enable_library - On - INI_ALL - - - - swoole.enable_fiber_mock - Off - INI_ALL - - - - swoole.enable_preemptive_scheduler - Off - INI_ALL - - - - swoole.display_errors - On - INI_ALL - - - - swoole.use_shortname - On - INI_SYSTEM - - - - swoole.unixsock_buffer_size - 8388608 - INI_ALL - - - - -
    -     - - &ini.descriptions.title; - - - - - - swoole.enable_library - string - - - - Active ou désactive la bibliothèque intégrée de l’extension. - - - - - - swoole.enable_fiber_mock - string - - - - Active ou désactive l’utilisation de l’extension xdebug pour déboguer les programmes Swoole. - - - - - - swoole.enable_preemptive_scheduler - string - - - - Empêche certaines coroutines de consommer trop de temps CPU dans une boucle serrée (10 ms de temps CPU), - ce qui pourrait empêcher la planification des autres coroutines. - - - - - - swoole.display_errors - string - - - - Active ou désactive l’affichage des messages d’erreur Swoole. - - - - - - - swoole.use_shortname - string - - - - Active ou désactive les alias courts. - - - - - - - swoole.unixsock_buffer_size - int - - - - Définit la taille du tampon Socket pour la communication inter-processus. - - - - - -
    - - diff --git a/reference/swoole/reference.xml b/reference/swoole/reference.xml deleted file mode 100644 index fd8dd1d430..0000000000 --- a/reference/swoole/reference.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - &Functions; de Swoole - - &reference.swoole.entities.functions; - - diff --git a/reference/swoole/setup.xml b/reference/swoole/setup.xml deleted file mode 100644 index e9ac8d4322..0000000000 --- a/reference/swoole/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Swoole requiert la bibliothèque libbrotli. - - - L’activation de l’option --enable-swoole-curl nécessite la bibliothèque libcurl, - et PHP ainsi que Swoole doivent être liés à la même bibliothèque partagée libcurl - et aux mêmes en-têtes, afin d’éviter un comportement indéfini. - - - L’activation de l’option --enable-iouring nécessite la bibliothèque liburing (version ≥ 2.0) - et un noyau Linux (version ≥ 5.12). - - - L’activation de l’option --enable-swoole-thread nécessite que PHP soit compilé en mode ZTS (Zend Thread Safety). - - - L’activation de l’option --enable-cares nécessite la bibliothèque libc-ares. - - - L’activation de l’option --enable-zstd nécessite la bibliothèque libzstd (version ≥ 1.4.0). - - - L’activation de l’option --enable-swoole-sqlite nécessite la bibliothèque libsqlite. - - - L’activation de l’option --enable-swoole-pgsql nécessite la bibliothèque libpq. - - - L’activation de l’option --with-swoole-odbc nécessite la bibliothèque unixodbc-dev. - - - L’activation de l’option --with-swoole-oracle nécessite les bibliothèques Oracle Instant Client. - -
    - - - &reference.swoole.configure; - - - - &reference.swoole.ini; - - -     diff --git a/reference/swoole/swoole.async.xml b/reference/swoole/swoole.async.xml deleted file mode 100644 index b22cbb931d..0000000000 --- a/reference/swoole/swoole.async.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\Async - Swoole\Async - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Async - - - - - Swoole\Async - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.async; - -     - - diff --git a/reference/swoole/swoole.atomic.xml b/reference/swoole/swoole.atomic.xml deleted file mode 100644 index 9a5e425b54..0000000000 --- a/reference/swoole/swoole.atomic.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\Atomic - Swoole\Atomic - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Atomic - - - - - Swoole\Atomic - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.atomic; - -     - - diff --git a/reference/swoole/swoole.buffer.xml b/reference/swoole/swoole.buffer.xml deleted file mode 100644 index 80bca3c5bc..0000000000 --- a/reference/swoole/swoole.buffer.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\Buffer - Swoole\Buffer - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Buffer - - - - - Swoole\Buffer - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.buffer; - -     - - diff --git a/reference/swoole/swoole.channel.xml b/reference/swoole/swoole.channel.xml deleted file mode 100644 index e2672e6fc2..0000000000 --- a/reference/swoole/swoole.channel.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\Channel - Swoole\Channel - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Channel - - - - - Swoole\Channel - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.channel; - -     - - diff --git a/reference/swoole/swoole.client.xml b/reference/swoole/swoole.client.xml deleted file mode 100644 index b24d8a866b..0000000000 --- a/reference/swoole/swoole.client.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - La classe Swoole\Client - Swoole\Client - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Client - - - - - Swoole\Client - - - - &Constants; - - const - int - Swoole\Client::MSG_OOB - 1 - - - const - int - Swoole\Client::MSG_PEEK - 2 - - - const - int - Swoole\Client::MSG_DONTWAIT - 128 - - - const - int - Swoole\Client::MSG_WAITALL - 64 - - - &Properties; - - public - errCode - - - public - sock - - - public - reuse - - - public - reuseCount - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - errCode - - - - - - sock - - - - - - reuse - - - - - - reuseCount - - - - - -
    - - - - -
    - &reftitle.constants; - - - - Swoole\Client::MSG_OOB - - - - - - - Swoole\Client::MSG_PEEK - - - - - - - Swoole\Client::MSG_DONTWAIT - - - - - - - Swoole\Client::MSG_WAITALL - - - - - - -
    - - - -     - - &reference.swoole.swoole.entities.client; - -     - - diff --git a/reference/swoole/swoole.connection.iterator.xml b/reference/swoole/swoole.connection.iterator.xml deleted file mode 100644 index b52ebaccfe..0000000000 --- a/reference/swoole/swoole.connection.iterator.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - La classe Swoole\Connection\Iterator - Swoole\Connection\Iterator - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Connection\Iterator - - - - - Swoole\Connection\Iterator - - - - Iterator - - - - Countable - - - - ArrayAccess - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.connection.entities.iterator; - -     - - diff --git a/reference/swoole/swoole.coroutine.client.xml b/reference/swoole/swoole.coroutine.client.xml deleted file mode 100644 index 418ad30a78..0000000000 --- a/reference/swoole/swoole.coroutine.client.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - La classe Swoole\Coroutine\Client - Swoole\Coroutine\Client - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\Client - - - - - Swoole\Coroutine\Client - - - - &Constants; - - const - int - Swoole\Coroutine\Client::MSG_OOB - 1 - - - const - int - Swoole\Coroutine\Client::MSG_PEEK - 2 - - - const - int - Swoole\Coroutine\Client::MSG_DONTWAIT - 128 - - - const - int - Swoole\Coroutine\Client::MSG_WAITALL - 64 - - - &Properties; - - public - errCode - - - public - sock - - - - &Methods; - - - -
    - - - -
    - &reftitle.properties; - - - errCode - - - - - - sock - - - - - -
    - - - - -
    - &reftitle.constants; - - - - Swoole\Coroutine\Client::MSG_OOB - - - - - - - Swoole\Coroutine\Client::MSG_PEEK - - - - - - - Swoole\Coroutine\Client::MSG_DONTWAIT - - - - - - - Swoole\Coroutine\Client::MSG_WAITALL - - - - - - -
    - - - -     - - &reference.swoole.swoole.coroutine.entities.client; - -     - - diff --git a/reference/swoole/swoole.coroutine.http.client.xml b/reference/swoole/swoole.coroutine.http.client.xml deleted file mode 100644 index 884e197a0e..0000000000 --- a/reference/swoole/swoole.coroutine.http.client.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - La classe Swoole\Coroutine\Http\Client - Swoole\Coroutine\Http\Client - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\Http\Client - - - - - Swoole\Coroutine\Http\Client - - - - &Properties; - - public - errCode - - - public - sock - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - errCode - - - - - - sock - - - - - -
    - - - -     - - &reference.swoole.swoole.coroutine.http.entities.client; - -     - - diff --git a/reference/swoole/swoole.coroutine.lock.xml b/reference/swoole/swoole.coroutine.lock.xml deleted file mode 100644 index 0c99fa65c0..0000000000 --- a/reference/swoole/swoole.coroutine.lock.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - La classe Swoole\Coroutine\Lock - Swoole\Coroutine\Lock - - - - -
    - &reftitle.intro; - - Swoole 6.0.1 a introduit un verrou de coroutine qui prend en charge le partage entre processus et thread. - Ce verrou est conçu pour un comportement non-bloquant et permet une synchronisation efficace des coroutines - dans des environnements multi-processus et multi-thread. - - - Lorsque compilé avec l'option --enable-iouring et que le noyau Linux prend en charge - la fonctionnalité io_uring futex, le verrou de coroutine de Swoole utilise - io_uring futex pour la synchronisation. Dans ce cas, les coroutines attendent pour la fin de verrouillage - en utilisant un mécanisme de mise en file d'attente efficace, ce qui améliore considérablement les performances. - - - Sans io_uring futex, le verrou de coroutine utilise un mécanisme de sommeil avec - un backoff exponentiel, où le temps d'attente augmente de 2^n millisecondes (n étant le nombre d'échecs) - après chaque tentative échouée d'acquérir le verrou. Bien que cette approche évite l'attente active, elle introduit - une surcharge supplémentaire de planification CPU et une latence accrue. - - - Le verrou de coroutine est conçu pour être utilisé dans des environnements où les coroutines peuvent effectuer en toute sécurité - plusieurs opérations de verrouillage. - - - - Ne pas créer de verrou dans une fonction de rappel telle que onReceive, car cela entraînera - une croissance continue de la mémoire et conduira à des fuites de mémoire. - - - - - Verrouiller et déverrouiller doivent être effectués dans la même coroutine, sinon cela rompra - les conditions statiques. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\Lock - - - - - Swoole\Coroutine\Lock - - - - - &Methods; - - - - -
    - -
    - &reftitle.examples; - - Utilisation basique - -add(); - $lock->lock(); - sleep(1); - $lock->unlock(); - $waitGroup->done(); - }); - - go(function() use ($lock, $waitGroup) { - $waitGroup->add(); - $lock->lock(); // Attend la coroutine qui détient le verrou - sleep(1); - $lock->unlock(); - $waitGroup->done(); - }); - - echo 'Lock does not block the process'; - $waitGroup->wait(); -}); -]]> - - -
    - -     - - &reference.swoole.swoole.coroutine.entities.lock; -     - - diff --git a/reference/swoole/swoole.coroutine.mysql.exception.xml b/reference/swoole/swoole.coroutine.mysql.exception.xml deleted file mode 100644 index 58786ad75f..0000000000 --- a/reference/swoole/swoole.coroutine.mysql.exception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La classe Swoole\Coroutine\MySQL\Exception - Swoole\Coroutine\MySQL\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\MySQL\Exception - - - - - Swoole\Coroutine\MySQL\Exception - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - - -
    - -     - -     - - diff --git a/reference/swoole/swoole.coroutine.mysql.xml b/reference/swoole/swoole.coroutine.mysql.xml deleted file mode 100644 index 4adfc71d70..0000000000 --- a/reference/swoole/swoole.coroutine.mysql.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - La classe Swoole\Coroutine\MySQL - Swoole\Coroutine\MySQL - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\MySQL - - - - - Swoole\Coroutine\MySQL - - - - &Properties; - - public - sock - - - public - connected - - - public - connect_error - - - public - connect_errno - - - public - affected_rows - - - public - insert_id - - - public - error - - - public - errno - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - sock - - - - - - connected - - - - - - connect_error - - - - - - connect_errno - - - - - - affected_rows - - - - - - insert_id - - - - - - error - - - - - - errno - - - - - -
    - - - -     - - &reference.swoole.swoole.coroutine.entities.mysql; - -     - - diff --git a/reference/swoole/swoole.coroutine.xml b/reference/swoole/swoole.coroutine.xml deleted file mode 100644 index 4feb238907..0000000000 --- a/reference/swoole/swoole.coroutine.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\Coroutine - Swoole\Coroutine - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine - - - - - Swoole\Coroutine - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.coroutine; - -     - - diff --git a/reference/swoole/swoole.event.xml b/reference/swoole/swoole.event.xml deleted file mode 100644 index 0cd8bffbe8..0000000000 --- a/reference/swoole/swoole.event.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - La classe Swoole\Event - Swoole\Event - - - - -
    - &reftitle.intro; - - L'extension Swoole fournit des interfaces bas niveau pour manipuler directement - la boucle d'événements epoll/kqueue/poll/select sous-jacente. - Elle permet d'ajouter à la boucle d'événements de Swoole des sockets créés par - d'autres extensions ou par les extensions stream et socket de PHP. - - - - Le module Event est de bas niveau, il s'agit d'une encapsulation élémentaire - d'epoll. Une expérience de la programmation par multiplexage d'entrées/sorties - est nécessaire pour l'utiliser. - - -
    - - -
    - Priorité des événements - - Fonctions de rappel de signal définies via Process::signal - Fonctions de rappel de minuterie définies via Timer::tick et Timer::after - Fonctions à exécution différée définies via Event::defer - Fonctions de rappel périodiques définies via Event::cycle - -
    - -
    - Types de socket des événements Swoole - - - - - fd - int - - - - Descripteurs de fichier, y compris Swoole\Client->$sock, Swoole\Process->$pipe, - ou tout autre descripteur de fichier (fd). - - - - - - stream resource - resource - - - - Ressources créées par stream_socket_client ou fsockopen. - - - - - - socket resource - resource - - - - Les ressources créées par socket_create, de l'extension sockets, nécessitent - l'option --enable-sockets lors de la compilation de Swoole. - - - - - - object - object - - - - Swoole convertit automatiquement, au niveau bas, Swoole\Process en UnixSocket - et Swoole\Client en socket client connecté. - - - - - -
    - -
    - &reftitle.classsynopsis; - - - - Swoole\Event - - - - - Swoole\Event - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.event; - -     - - diff --git a/reference/swoole/swoole.exception.xml b/reference/swoole/swoole.exception.xml deleted file mode 100644 index 3e3ddf70b2..0000000000 --- a/reference/swoole/swoole.exception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La classe Swoole\Exception - Swoole\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Exception - - - - - Swoole\Exception - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - - -
    - -     - -     - - diff --git a/reference/swoole/swoole.http.client.xml b/reference/swoole/swoole.http.client.xml deleted file mode 100644 index 6791fc7530..0000000000 --- a/reference/swoole/swoole.http.client.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - La classe Swoole\Http\Client - Swoole\Http\Client - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Http\Client - - - - - Swoole\Http\Client - - - - &Properties; - - public - errCode - - - public - sock - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - errCode - - - - - - sock - - - - - -
    - - - -     - - &reference.swoole.swoole.http.entities.client; - -     - - diff --git a/reference/swoole/swoole.http.request.xml b/reference/swoole/swoole.http.request.xml deleted file mode 100644 index 7901901bf7..0000000000 --- a/reference/swoole/swoole.http.request.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\Http\Request - Swoole\Http\Request - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Http\Request - - - - - Swoole\Http\Request - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.http.entities.request; - -     - - diff --git a/reference/swoole/swoole.http.response.xml b/reference/swoole/swoole.http.response.xml deleted file mode 100644 index 9dc00b4b10..0000000000 --- a/reference/swoole/swoole.http.response.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\Http\Response - Swoole\Http\Response - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Http\Response - - - - - Swoole\Http\Response - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.http.entities.response; - -     - - diff --git a/reference/swoole/swoole.http.server.xml b/reference/swoole/swoole.http.server.xml deleted file mode 100644 index e9e339c23d..0000000000 --- a/reference/swoole/swoole.http.server.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - La classe Swoole\Http\Server - Swoole\Http\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Http\Server - - - - - Swoole\Http\Server - - - - extends - Swoole\Server - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.swoole.swoole.http.entities.server; - -     - - diff --git a/reference/swoole/swoole.lock.xml b/reference/swoole/swoole.lock.xml deleted file mode 100644 index ddc8ab8bed..0000000000 --- a/reference/swoole/swoole.lock.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\Lock - Swoole\Lock - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Lock - - - - - Swoole\Lock - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.lock; - -     - - diff --git a/reference/swoole/swoole.mmap.xml b/reference/swoole/swoole.mmap.xml deleted file mode 100644 index 78311ff468..0000000000 --- a/reference/swoole/swoole.mmap.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\Mmap - Swoole\Mmap - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Mmap - - - - - Swoole\Mmap - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.mmap; - -     - - diff --git a/reference/swoole/swoole.module.xml b/reference/swoole/swoole.module.xml deleted file mode 100644 index c1f24de033..0000000000 --- a/reference/swoole/swoole.module.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - La classe Swoole\Module - Swoole\Module - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Module - - - - - Swoole\Module - - - - - - - -
    - -     - - -     - - diff --git a/reference/swoole/swoole.mysql.exception.xml b/reference/swoole/swoole.mysql.exception.xml deleted file mode 100644 index 55796abff9..0000000000 --- a/reference/swoole/swoole.mysql.exception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - La classe Swoole\MySQL\Exception - Swoole\MySQL\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\MySQL\Exception - - - - - Swoole\MySQL\Exception - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - - - -
    - -     - -     - - diff --git a/reference/swoole/swoole.mysql.xml b/reference/swoole/swoole.mysql.xml deleted file mode 100644 index 5f69b5c36d..0000000000 --- a/reference/swoole/swoole.mysql.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\MySQL - Swoole\MySQL - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\MySQL - - - - - Swoole\MySQL - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.mysql; - -     - - diff --git a/reference/swoole/swoole.process.xml b/reference/swoole/swoole.process.xml deleted file mode 100644 index 39f024018c..0000000000 --- a/reference/swoole/swoole.process.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - La classe Swoole\Process - Swoole\Process - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Process - - - - - Swoole\Process - - - - &Constants; - - const - int - Swoole\Process::IPC_NOWAIT - 256 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Swoole\Process::IPC_NOWAIT - - - - - - -
    - - - -     - - &reference.swoole.swoole.entities.process; - -     - - diff --git a/reference/swoole/swoole.redis.server.xml b/reference/swoole/swoole.redis.server.xml deleted file mode 100644 index be443d985f..0000000000 --- a/reference/swoole/swoole.redis.server.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - La classe Swoole\Redis\Server - Swoole\Redis\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Redis\Server - - - - - Swoole\Redis\Server - - - - extends - Swoole\Server - - - - &Constants; - - const - int - Swoole\Redis\Server::NIL - 1 - - - const - int - Swoole\Redis\Server::ERROR - 0 - - - const - int - Swoole\Redis\Server::STATUS - 2 - - - const - int - Swoole\Redis\Server::INT - 3 - - - const - int - Swoole\Redis\Server::STRING - 4 - - - const - int - Swoole\Redis\Server::SET - 5 - - - const - int - Swoole\Redis\Server::MAP - 6 - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - Swoole\Redis\Server::NIL - - - - - - - Swoole\Redis\Server::ERROR - - - - - - - Swoole\Redis\Server::STATUS - - - - - - - Swoole\Redis\Server::INT - - - - - - - Swoole\Redis\Server::STRING - - - - - - - Swoole\Redis\Server::SET - - - - - - - Swoole\Redis\Server::MAP - - - - - - -
    - - - -     - - &reference.swoole.swoole.redis.entities.server; - -     - - diff --git a/reference/swoole/swoole.runtime.xml b/reference/swoole/swoole.runtime.xml deleted file mode 100644 index 83d7c3e4cd..0000000000 --- a/reference/swoole/swoole.runtime.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - La classe Swoole\Runtime - Swoole\Runtime - - - - -
    - &reftitle.intro; - - Swoole\Runtime apporte le support des coroutines pour diverses fonctions PHP via un mécanisme de crochet, - permettant au code synchrone de fonctionner de manière asynchrone dans un environnement de coroutine. - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Runtime - - - - - Swoole\Runtime - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.runtime; - -     - - diff --git a/reference/swoole/swoole.serialize.xml b/reference/swoole/swoole.serialize.xml deleted file mode 100644 index 2c5a61dd32..0000000000 --- a/reference/swoole/swoole.serialize.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\Serialize - Swoole\Serialize - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Serialize - - - - - Swoole\Serialize - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.serialize; - -     - - diff --git a/reference/swoole/swoole.server.port.xml b/reference/swoole/swoole.server.port.xml deleted file mode 100644 index 1b03e97c63..0000000000 --- a/reference/swoole/swoole.server.port.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\Server\Port - Swoole\Server\Port - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Server\Port - - - - - Swoole\Server\Port - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.server.entities.port; - -     - - diff --git a/reference/swoole/swoole.server.xml b/reference/swoole/swoole.server.xml deleted file mode 100644 index 84986d22b4..0000000000 --- a/reference/swoole/swoole.server.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La classe Swoole\Server - Swoole\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Server - - - - - Swoole\Server - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.server; - -     - - diff --git a/reference/swoole/swoole.table.xml b/reference/swoole/swoole.table.xml deleted file mode 100644 index 3df8124769..0000000000 --- a/reference/swoole/swoole.table.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - La classe Swoole\Table - Swoole\Table - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Table - - - - - Swoole\Table - - - - Iterator - - - - Countable - - - - &Constants; - - const - int - Swoole\Table::TYPE_INT - 1 - - - const - int - Swoole\Table::TYPE_STRING - 7 - - - const - int - Swoole\Table::TYPE_FLOAT - 6 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Swoole\Table::TYPE_INT - - - - - - - Swoole\Table::TYPE_STRING - - - - - - - Swoole\Table::TYPE_FLOAT - - - - - - -
    - - - -     - - &reference.swoole.swoole.entities.table; - -     - - diff --git a/reference/swoole/swoole.timer.xml b/reference/swoole/swoole.timer.xml deleted file mode 100644 index 4d9e3587e7..0000000000 --- a/reference/swoole/swoole.timer.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - La classe Swoole\Timer - Swoole\Timer - - - - -
    - &reftitle.intro; - - Minuteur d'une précision de l'ordre de la milliseconde. L'implémentation sous-jacente - repose sur epoll_wait et setitimer, avec un tas-min qui permet d'ajouter un grand - nombre de minuteurs. - - - Dans les processus à E/S synchrones, tels que les processus Manager et TaskWorker, - elle repose sur setitimer et les signaux. - - - Dans les processus à E/S asynchrones, elle repose sur le délai d'expiration de - epoll_wait/kevent/poll/select. - - - Le système sous-jacent ne prend pas en charge les minuteurs dont le délai vaut - 0 : une valeur inférieure à 1 milliseconde - émet une E_WARNING et l'appel échoue. Cela diffère de langages - tels que Node.js. - Swoole\Event::defer - permet d'obtenir un résultat similaire. - - -]]> - - - - Correction du minuteur : la durée d'exécution de la fonction de rappel n'influe pas - sur l'instant du déclenchement suivant. Par exemple, pour un minuteur tick de 10 ms - créé à 0,002 s, le premier rappel est exécuté à 0,012 s ; si la fonction de rappel - prend 5 ms, le déclenchement suivant a tout de même lieu à 0,022 s, et non à 0,027 s. - - - En revanche, si la fonction de rappel s'exécute trop longtemps, au point de couvrir - l'instant du déclenchement suivant, le système sous-jacent corrige le temps : il - abandonne les déclenchements périmés et rappelle la fonction au prochain instant - disponible. Par exemple, si la fonction de rappel exécutée à 0,012 s prend 15 ms, ce - qui retarde le minuteur prévu à 0,022 s, le rappel est déclenché à nouveau à 0,032 s. - - - Par défaut, une coroutine est automatiquement créée pour exécuter la fonction de - rappel lorsqu'un minuteur se déclenche. Ce comportement se désactive avec - swoole_async_set. - - - - Un minuteur ne fonctionne que dans l'espace du processus courant. - - - - - Les minuteurs sont purement asynchrones et incompatibles avec les fonctions d'E/S - synchrones. - - - - - L'exécution d'un minuteur peut présenter de légers écarts de temps. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Timer - - - - - Swoole\Timer - - - - - &Methods; - - - - -
    - -     - - &reference.swoole.swoole.entities.timer; - -     - - diff --git a/reference/swoole/swoole.websocket.frame.xml b/reference/swoole/swoole.websocket.frame.xml deleted file mode 100644 index e8b86d9e26..0000000000 --- a/reference/swoole/swoole.websocket.frame.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - La classe Swoole\WebSocket\Frame - Swoole\WebSocket\Frame - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\WebSocket\Frame - - - - - Swoole\WebSocket\Frame - - - - - &Methods; - - - - -
    - -     - -     - - diff --git a/reference/swoole/swoole.websocket.server.xml b/reference/swoole/swoole.websocket.server.xml deleted file mode 100644 index ccbc5a0b0e..0000000000 --- a/reference/swoole/swoole.websocket.server.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - La classe Swoole\WebSocket\Server - Swoole\WebSocket\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\WebSocket\Server - - - - - Swoole\WebSocket\Server - - - - extends - Swoole\Http\Server - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.swoole.swoole.websocket.entities.server; - -     - - diff --git a/reference/swoole/swoole/async/dnslookup.xml b/reference/swoole/swoole/async/dnslookup.xml deleted file mode 100644 index c963c05276..0000000000 --- a/reference/swoole/swoole/async/dnslookup.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Swoole\Async::dnsLookup - Cherche de manière asynchrone et non bloquante l'adresse IP d'un hôte. - - - - &reftitle.description; - - public static voidSwoole\Async::dnsLookup - stringhostname - callablecallback - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - hostname - - - Le nom d'hôte. - - - - - callback - - - mixedcallback - stringhostname - stringip - - - - hostname - - - Le nom d'hôte. - - - - - IP - - - L'adresse IP. - - - - - - - - - - - - diff --git a/reference/swoole/swoole/async/read.xml b/reference/swoole/swoole/async/read.xml deleted file mode 100644 index 6d5cfdbd67..0000000000 --- a/reference/swoole/swoole/async/read.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Swoole\Async::read - Lit de manière asynchrone un flux de fichier. - - - - &reftitle.description; - - public static boolSwoole\Async::read - stringfilename - callablecallback - intchunk_size - intoffset - - - - - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier. - - - - - callback - - - mixedcallback - stringfilename - stringcontent - - - - filename - - - Le nom du fichier. - - - - - content - - - Le contenu lu depuis le flux de fichier. - - - - - - - - chunk_size - - - La taille du morceau. - - - - - offset - - - Le décalage. - - - - - - - - &reftitle.returnvalues; - - Si la lecture réussit. - - - - - - diff --git a/reference/swoole/swoole/async/readfile.xml b/reference/swoole/swoole/async/readfile.xml deleted file mode 100644 index 0b9dcf1d03..0000000000 --- a/reference/swoole/swoole/async/readfile.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Swoole\Async::readFile - Lit un fichier de manière asynchrone. - - - - &reftitle.description; - - public static voidSwoole\Async::readFile - stringfilename - callablecallback - - - - - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier à lire. - - - - - callback - - - mixedcallback - stringfilename - stringcontent - - - - filename - - - Le nom du fichier. - - - - - content - - - Le contenu lu depuis le fichier. - - - - - - - - - - - - diff --git a/reference/swoole/swoole/async/set.xml b/reference/swoole/swoole/async/set.xml deleted file mode 100644 index 6ba122e5a2..0000000000 --- a/reference/swoole/swoole/async/set.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Async::set - Met à jour les options d'E/S asynchrone. - - - - &reftitle.description; - - public static voidSwoole\Async::set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - - diff --git a/reference/swoole/swoole/async/write.xml b/reference/swoole/swoole/async/write.xml deleted file mode 100644 index 1820ad26c0..0000000000 --- a/reference/swoole/swoole/async/write.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Async::write - Écrit de manière asynchrone des données dans un flux de fichier. - - - - &reftitle.description; - - public static voidSwoole\Async::write - stringfilename - stringcontent - intoffset - callablecallback - - - - - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier dans lequel écrire. - - - - - content - - - Le contenu à écrire dans le fichier. - - - - - offset - - - Le décalage. - - - - - callback - - - - - - - - - - - - diff --git a/reference/swoole/swoole/async/writefile.xml b/reference/swoole/swoole/async/writefile.xml deleted file mode 100644 index c5fd32ce9a..0000000000 --- a/reference/swoole/swoole/async/writefile.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Swoole\Async::writeFile - Description - - - - &reftitle.description; - - public static voidSwoole\Async::writeFile - stringfilename - stringcontent - callablecallback - stringflags - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - filename - - - Le nom du fichier à écrire. - - - - - content - - - Le contenu à écrire dans le fichier. - - - - - callback - - - - - - - - flags - - - - - - - - - - - - diff --git a/reference/swoole/swoole/atomic/add.xml b/reference/swoole/swoole/atomic/add.xml deleted file mode 100644 index 2c49eb868b..0000000000 --- a/reference/swoole/swoole/atomic/add.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Atomic::add - Ajoute un nombre à la valeur de l'objet atomique. - - - - &reftitle.description; - - public intSwoole\Atomic::add - intadd_value - - - Ajoute un nombre à la valeur de l'objet atomique. - - - - - - &reftitle.parameters; - - - add_value - - - La valeur qui sera ajoutée à la valeur actuelle. - - - - - - - - &reftitle.returnvalues; - - La nouvelle valeur de l'objet atomique. - - - - - - - diff --git a/reference/swoole/swoole/atomic/cmpset.xml b/reference/swoole/swoole/atomic/cmpset.xml deleted file mode 100644 index fcee3f8b1e..0000000000 --- a/reference/swoole/swoole/atomic/cmpset.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Swoole\Atomic::cmpset - Compare et définit la valeur de l'objet atomique. - - - - &reftitle.description; - - public intSwoole\Atomic::cmpset - intcmp_value - intnew_value - - - - - - - - - &reftitle.parameters; - - - cmp_value - - - La valeur à comparer avec la valeur actuelle de l'objet atomique. - - - - - new_value - - - La valeur à définir à l'objet atomique si la valeur de cmp_value est la même que la valeur actuelle de - l'objet atomique. - - - - - - - - &reftitle.returnvalues; - - La nouvelle valeur de l'objet atomique. - - - - - - - diff --git a/reference/swoole/swoole/atomic/construct.xml b/reference/swoole/swoole/atomic/construct.xml deleted file mode 100644 index 69098c446b..0000000000 --- a/reference/swoole/swoole/atomic/construct.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Atomic::__construct - Construit un nouvel objet atomique Swoole. - - - - &reftitle.description; - - public Swoole\Atomic::__construct - intvalue - - - Un objet atomique Swoole est une variable entière qui permet à n'importe quel processeur de tester et de modifier atomiquement. - Il est implémenté sur la base des instructions atomiques du processeur. Les variables atomiques Swoole doivent être définies avant - que swoole_server->start ne soit appelé. - - - - Compare-and-swap (CAS) est une instruction atomique utilisée dans le multithreading pour réaliser la synchronisation. - Elle compare le contenu d'un emplacement mémoire avec une valeur donnée et, seulement si elles sont identiques, - modifie le contenu de cet emplacement mémoire en une nouvelle valeur donnée. - - - - - - &reftitle.parameters; - - - value - - - La valeur de l'objet atomique. - - - - - - - - - diff --git a/reference/swoole/swoole/atomic/get.xml b/reference/swoole/swoole/atomic/get.xml deleted file mode 100644 index 061b29eb6f..0000000000 --- a/reference/swoole/swoole/atomic/get.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Atomic::get - Renvoie la valeur actuelle de l'objet atomique. - - - - &reftitle.description; - - public intSwoole\Atomic::get - - - - Renvoie la valeur actuelle de l'objet atomique. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La valeur actuelle de l'objet atomique. - - - - - - - diff --git a/reference/swoole/swoole/atomic/set.xml b/reference/swoole/swoole/atomic/set.xml deleted file mode 100644 index 14c5c9a679..0000000000 --- a/reference/swoole/swoole/atomic/set.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Swoole\Atomic::set - Définit une nouvelle valeur à l'objet atomique. - - - - &reftitle.description; - - public intSwoole\Atomic::set - intvalue - - - Définit une nouvelle valeur à l'objet atomique. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - value - - - La valeur à définir à l'objet atomique. - - - - - - - - &reftitle.returnvalues; - - La valeur actuelle de l'objet atomique. - - - - - - - diff --git a/reference/swoole/swoole/atomic/sub.xml b/reference/swoole/swoole/atomic/sub.xml deleted file mode 100644 index 8af9f6b699..0000000000 --- a/reference/swoole/swoole/atomic/sub.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Atomic::sub - Soustrait un nombre à la valeur de l'objet atomique. - - - - &reftitle.description; - - public intSwoole\Atomic::sub - intsub_value - - - Soustrait un nombre à la valeur de l'objet atomique. - - - - - - &reftitle.parameters; - - - sub_value - - - La valeur qui sera soustraite à la valeur actuelle. - - - - - - - - &reftitle.returnvalues; - - La valeur actuelle de l'objet atomique. - - - - - - - diff --git a/reference/swoole/swoole/buffer/append.xml b/reference/swoole/swoole/buffer/append.xml deleted file mode 100644 index b4fabe4fdc..0000000000 --- a/reference/swoole/swoole/buffer/append.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Buffer::append - Ajoute la chaîne ou les données binaires à la fin du tampon mémoire et retourne la nouvelle taille de la mémoire allouée. - - - - &reftitle.description; - - public intSwoole\Buffer::append - stringdata - - - - - - - - - &reftitle.parameters; - - - data - - - La chaîne ou les données binaires à ajouter à la fin du tampon mémoire. - - - - - - - - &reftitle.returnvalues; - - La nouvelle taille du tampon mémoire. - - - - - - - diff --git a/reference/swoole/swoole/buffer/clear.xml b/reference/swoole/swoole/buffer/clear.xml deleted file mode 100644 index e171263f73..0000000000 --- a/reference/swoole/swoole/buffer/clear.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Buffer::clear - Réinitialise le tampon mémoire. - - - - &reftitle.description; - - public voidSwoole\Buffer::clear - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/buffer/construct.xml b/reference/swoole/swoole/buffer/construct.xml deleted file mode 100644 index 119a83db3c..0000000000 --- a/reference/swoole/swoole/buffer/construct.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Swoole\Buffer::__construct - Allocation de blocs de mémoire de taille fixe. - - - - &reftitle.description; - - public Swoole\Buffer::__construct - intsize - - - - - - - - - &reftitle.parameters; - - - size - - - La taille de la mémoire à allouer. - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/buffer/destruct.xml b/reference/swoole/swoole/buffer/destruct.xml deleted file mode 100644 index 24f36cae39..0000000000 --- a/reference/swoole/swoole/buffer/destruct.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - Swoole\Buffer::__destruct - Détruit le tampon mémoire Swoole. - - - - &reftitle.description; - - public voidSwoole\Buffer::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/buffer/expand.xml b/reference/swoole/swoole/buffer/expand.xml deleted file mode 100644 index 8712964408..0000000000 --- a/reference/swoole/swoole/buffer/expand.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Buffer::expand - Etend la taille du tampon mémoire. - - - - &reftitle.description; - - public intSwoole\Buffer::expand - intsize - - - - - - - - - &reftitle.parameters; - - - size - - - La nouvelle taille du tampon mémoire. - - - - - - - - &reftitle.returnvalues; - - La nouvelle taille du tampon mémoire. - - - - - - - diff --git a/reference/swoole/swoole/buffer/read.xml b/reference/swoole/swoole/buffer/read.xml deleted file mode 100644 index 327aed46d5..0000000000 --- a/reference/swoole/swoole/buffer/read.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Buffer::read - Lit les données du tampon mémoire en fonction du décalage et de la longueur. - - - - &reftitle.description; - - public stringSwoole\Buffer::read - intoffset - intlength - - - - - - - - - &reftitle.parameters; - - - offset - - - Le décalage. - - - - - length - - - La longueur. - - - - - - - - &reftitle.returnvalues; - - Les données lues du tampon mémoire. - - - - - - - diff --git a/reference/swoole/swoole/buffer/recycle.xml b/reference/swoole/swoole/buffer/recycle.xml deleted file mode 100644 index 23f94da9e4..0000000000 --- a/reference/swoole/swoole/buffer/recycle.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Buffer::recycle - Libère la mémoire à l'OS qui n'est pas utilisée par le tampon mémoire. - - - - &reftitle.description; - - public voidSwoole\Buffer::recycle - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/buffer/substr.xml b/reference/swoole/swoole/buffer/substr.xml deleted file mode 100644 index e1480cb958..0000000000 --- a/reference/swoole/swoole/buffer/substr.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Buffer::substr - Lit les données du tampon mémoire en fonction du décalage et de la longueur. Ou supprime les données du tampon mémoire. - - - - &reftitle.description; - - public stringSwoole\Buffer::substr - intoffset - intlength - boolremove - - - Si $remove est défini sur true et que $offset est défini sur 0, les données seront supprimées du tampon. - La mémoire pour stocker les données sera libérée lorsque l'objet tampon sera détruit. - - - - - - &reftitle.parameters; - - - offset - - - Le décalage. - - - - - length - - - La longueur. - - - - - remove - - - Si les données doivent être supprimées du tampon. - - - - - - - - &reftitle.returnvalues; - - Les données lues du tampon mémoire. - - - - - - - diff --git a/reference/swoole/swoole/buffer/tostring.xml b/reference/swoole/swoole/buffer/tostring.xml deleted file mode 100644 index 33046d2ee0..0000000000 --- a/reference/swoole/swoole/buffer/tostring.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Buffer::__toString - Renvoie la valeur de la chaîne du tampon mémoire. - - - - &reftitle.description; - - public stringSwoole\Buffer::__toString - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La valeur de la chaîne du tampon mémoire. - - - - - - - diff --git a/reference/swoole/swoole/buffer/write.xml b/reference/swoole/swoole/buffer/write.xml deleted file mode 100644 index 043fc9faae..0000000000 --- a/reference/swoole/swoole/buffer/write.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Buffer::write - Ecrit des données dans le tampon mémoire. La mémoire allouée pour le tampon ne sera pas modifiée. - - - - &reftitle.description; - - public voidSwoole\Buffer::write - intoffset - stringdata - - - - - - - - - &reftitle.parameters; - - - offset - - - Le décalage. - - - - - data - - - Les données à écrire dans le tampon mémoire. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/channel/construct.xml b/reference/swoole/swoole/channel/construct.xml deleted file mode 100644 index c6cd251bf3..0000000000 --- a/reference/swoole/swoole/channel/construct.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - Swoole\Channel::__construct - Construit un canal Swoole - - - - &reftitle.description; - - public Swoole\Channel::__construct - stringsize - - - Un canal Swoole est une structure de données en mémoire qui fonctionne comme Chan en Golang, implémentée sur la base de - mémoire partagée et verrous mutex. Il peut être utilisé comme une file de messages haute performance en mémoire. - Construisez un canal swoole avec une taille fixe. La taille minimale d'un canal swoole est de 64 Ko. - Des exceptions seront levées s'il n'y a pas assez de mémoire. - - - - - - &reftitle.parameters; - - - size - - - La taille du canal Swoole. - - - - - - - - - diff --git a/reference/swoole/swoole/channel/destruct.xml b/reference/swoole/swoole/channel/destruct.xml deleted file mode 100644 index 27db9ba293..0000000000 --- a/reference/swoole/swoole/channel/destruct.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Channel::__destruct - Détruit un canal Swoole. - - - - &reftitle.description; - - public voidSwoole\Channel::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/channel/pop.xml b/reference/swoole/swoole/channel/pop.xml deleted file mode 100644 index af1b9306e6..0000000000 --- a/reference/swoole/swoole/channel/pop.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Channel::pop - Lit et extrait des données du canal swoole. - - - - &reftitle.description; - - public mixedSwoole\Channel::pop - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Si le canal est vide, la fonction renverra false, ou renverra les données désérialisées. - - - - - - - diff --git a/reference/swoole/swoole/channel/push.xml b/reference/swoole/swoole/channel/push.xml deleted file mode 100644 index c35e24060d..0000000000 --- a/reference/swoole/swoole/channel/push.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Swoole\Channel::push - Ecrit et pousse des données dans le canal Swoole. - - - - &reftitle.description; - - public boolSwoole\Channel::push - stringdata - - - Les données peuvent être n'importe quelle variable PHP non vide, la variable sera sérialisée si elle n'est pas de type chaîne. - - - Si la taille des données est supérieure à 8 Ko, le canal swoole utilisera un stockage de fichiers temporaires. - - - La fonction renverra true si l'opération d'écriture est réussie, ou renverra false s'il n'y a pas assez d'espace. - - - - - - &reftitle.parameters; - - - data - - - Les données à pousser dans le canal Swoole. - - - - - - - - &reftitle.returnvalues; - - Si les données sont poussées dans le canal Swoole. - - - - - - - diff --git a/reference/swoole/swoole/channel/stats.xml b/reference/swoole/swoole/channel/stats.xml deleted file mode 100644 index 6afc0b6048..0000000000 --- a/reference/swoole/swoole/channel/stats.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Channel::stats - Renvoie les statistiques du canal Swoole. - - - - &reftitle.description; - - public arraySwoole\Channel::stats - - - - Renvoie le nombre d'éléments en attente et la taille totale de la mémoire utilisée par la file d'attente. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Les statistiques du canal Swoole. - - - - - - diff --git a/reference/swoole/swoole/client/close.xml b/reference/swoole/swoole/client/close.xml deleted file mode 100644 index 5349789b48..0000000000 --- a/reference/swoole/swoole/client/close.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Client::close - Ferme la connexion établie. - - - - &reftitle.description; - - public boolSwoole\Client::close - boolforce - - - - - - - - - &reftitle.parameters; - - - force - - - Forcer ou non la fermeture de la connexion. - - - - - - - - &reftitle.returnvalues; - - Si la connexion est fermée. - - - - - - - diff --git a/reference/swoole/swoole/client/connect.xml b/reference/swoole/swoole/client/connect.xml deleted file mode 100644 index a0f1cb7e8f..0000000000 --- a/reference/swoole/swoole/client/connect.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Swoole\Client::connect - Connecte au port TCP ou UDP distant. - - - - &reftitle.description; - - public boolSwoole\Client::connect - stringhost - intport - inttimeout - intflag - - - - - - - - - &reftitle.parameters; - - - host - - - Le nom d'hôte de l'adresse distante. - - - - - port - - - Le numéro de port de l'adresse distante. - - - - - timeout - - - Le délai (en secondes) de connexion/envoi/réception, la valeur par défaut est de 0,1 s. - - - - - flag - - - Si le type de client est UDP, le $flag signifie s'il faut activer la configuration udp_connect. - Si la configuration udp_connect est activée, le client ne recevra que les données de l'ip:port spécifié. - Si le type de client est TCP et que le $flag est défini sur 1, il doit utiliser swoole_client_select pour vérifier l'état de la connexion avant d'envoyer/recevoir. - - - - - - - - &reftitle.returnvalues; - - Si la connexion est établie. - - - - - - - diff --git a/reference/swoole/swoole/client/construct.xml b/reference/swoole/swoole/client/construct.xml deleted file mode 100644 index c9df7a841e..0000000000 --- a/reference/swoole/swoole/client/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Swoole\Client::__construct - Crée un client TCP/UDP synchrone ou asynchrone Swoole, avec ou sans SSL. - - - - &reftitle.description; - - public Swoole\Client::__construct - intsock_type - intis_async - - - - - - - - - &reftitle.parameters; - - - sock_type - - - Le type de socket: SWOOLE_TCP, SWOOLE_UDP, SWOOLE_ASYNC, SWOOLE_SSL, SWOOLE_KEEP. - - - - - is_async - - - Client synchrone ou asynchrone. - - - - - - - - - diff --git a/reference/swoole/swoole/client/destruct.xml b/reference/swoole/swoole/client/destruct.xml deleted file mode 100644 index b810fbc299..0000000000 --- a/reference/swoole/swoole/client/destruct.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - Swoole\Client::__destruct - Détruit le client Swoole. - - - - &reftitle.description; - - public voidSwoole\Client::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/swoole/swoole/client/getpeername.xml b/reference/swoole/swoole/client/getpeername.xml deleted file mode 100644 index 70732c2f29..0000000000 --- a/reference/swoole/swoole/client/getpeername.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Client::getpeername - Renvoie le nom du socket distant de la connexion. - - - - &reftitle.description; - - public arraySwoole\Client::getpeername - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'hôte et le port du socket distant. - - - - - - - diff --git a/reference/swoole/swoole/client/getsockname.xml b/reference/swoole/swoole/client/getsockname.xml deleted file mode 100644 index 2204cf7b30..0000000000 --- a/reference/swoole/swoole/client/getsockname.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Client::getsockname - Renvoie le nom du socket local de la connexion. - - - - &reftitle.description; - - public arraySwoole\Client::getsockname - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'hôte et le port du socket local. - - - - - - - diff --git a/reference/swoole/swoole/client/isconnected.xml b/reference/swoole/swoole/client/isconnected.xml deleted file mode 100644 index 0b6a0a1e35..0000000000 --- a/reference/swoole/swoole/client/isconnected.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Client::isConnected - Vérifie si la connexion est établie. - - - - &reftitle.description; - - public boolSwoole\Client::isConnected - - - - Cette méthode renvoie l'état de la connexion de la couche applicative. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Si la connexion est établie. - - - - - - - diff --git a/reference/swoole/swoole/client/on.xml b/reference/swoole/swoole/client/on.xml deleted file mode 100644 index 3e6c1b9c7b..0000000000 --- a/reference/swoole/swoole/client/on.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Swoole\Client::on - Ajoute des fonctions de rappel déclenchées par des événements. - - - - &reftitle.description; - - public voidSwoole\Client::on - stringevent - callablecallback - - - - - - - - - &reftitle.parameters; - - - event - - - - - - - - callback - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/client/pause.xml b/reference/swoole/swoole/client/pause.xml deleted file mode 100644 index 6317c9caa7..0000000000 --- a/reference/swoole/swoole/client/pause.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Client::pause - Met en pause la réception de données. - - - - &reftitle.description; - - public voidSwoole\Client::pause - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/client/pipe.xml b/reference/swoole/swoole/client/pipe.xml deleted file mode 100644 index 1329bd4ba9..0000000000 --- a/reference/swoole/swoole/client/pipe.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Client::pipe - Redirige les données vers un autre descripteur de fichier. - - - - &reftitle.description; - - public voidSwoole\Client::pipe - stringsocket - - - - - - - - - &reftitle.parameters; - - - socket - - - - - - - - - - - - diff --git a/reference/swoole/swoole/client/recv.xml b/reference/swoole/swoole/client/recv.xml deleted file mode 100644 index 87576f2885..0000000000 --- a/reference/swoole/swoole/client/recv.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Client::recv - Reçoit des données du socket distant. - - - - &reftitle.description; - - public voidSwoole\Client::recv - stringsize - stringflag - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - size - - - - - - - - flag - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/client/resume.xml b/reference/swoole/swoole/client/resume.xml deleted file mode 100644 index e87c0230a5..0000000000 --- a/reference/swoole/swoole/client/resume.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Client::resume - Reprend la réception de données. - - - - &reftitle.description; - - public voidSwoole\Client::resume - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/client/send.xml b/reference/swoole/swoole/client/send.xml deleted file mode 100644 index b9db3ea247..0000000000 --- a/reference/swoole/swoole/client/send.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Swoole\Client::send - Envoie des données au socket TCP distant. - - - - &reftitle.description; - - public intSwoole\Client::send - stringdata - stringflag - - - - - - - - - &reftitle.parameters; - - - data - - - Les données à envoyer qui peuvent être une chaîne ou binaire - - - - - flag - - - - - - - - - - - &reftitle.returnvalues; - - Si le client envoie des données avec succès, il renvoie la longueur des données envoyées. - Ou il renvoie false et définit $swoole_client->errCode. Pour le client synchrone, - il n'y a pas de limite pour les données à envoyer. Pour le client asynchrone, la limite - pour les données à envoyer est socket_buffer_size. - - - - - - - diff --git a/reference/swoole/swoole/client/sendfile.xml b/reference/swoole/swoole/client/sendfile.xml deleted file mode 100644 index f90c8b8704..0000000000 --- a/reference/swoole/swoole/client/sendfile.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Client::sendfile - Envoie un fichier au socket TCP distant. - - - - &reftitle.description; - - public boolSwoole\Client::sendfile - stringfilename - intoffset - - - Ceci est une enveloppe de l'appel système sendfile de Linux. - - - - - - &reftitle.parameters; - - - filename - - - Le chemin du fichier à envoyer. - - - - - offset - - - Le décalage du fichier à envoyer - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/client/sendto.xml b/reference/swoole/swoole/client/sendto.xml deleted file mode 100644 index 15773a1c92..0000000000 --- a/reference/swoole/swoole/client/sendto.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Client::sendto - Envoie des données à l'adresse UDP distante. - - - - &reftitle.description; - - public boolSwoole\Client::sendto - stringip - intport - stringdata - - - Le client swoole doit être de type SWOOLE_SOCK_UDP ou SWOOLE_SOCK_UDP6. - - - - - - &reftitle.parameters; - - - ip - - - L'adresse IP de l'hôte distant, IPv4 ou IPv6. - - - - - port - - - Le numéro de port de l'hôte distant. - - - - - data - - - Les données à envoyer qui doivent être inférieures à 64K. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/client/set.xml b/reference/swoole/swoole/client/set.xml deleted file mode 100644 index 1f3465348e..0000000000 --- a/reference/swoole/swoole/client/set.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Client::set - Définit les paramètres du client Swoole avant que la connexion ne soit établie. - - - - &reftitle.description; - - public voidSwoole\Client::set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/client/sleep.xml b/reference/swoole/swoole/client/sleep.xml deleted file mode 100644 index 9d9134f20b..0000000000 --- a/reference/swoole/swoole/client/sleep.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Client::sleep - Supprime le client TCP de la boucle d'événements système. - - - - &reftitle.description; - - public voidSwoole\Client::sleep - - - - Supprime le client TCP de la boucle d'événements système. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/client/wakeup.xml b/reference/swoole/swoole/client/wakeup.xml deleted file mode 100644 index ada9716bf0..0000000000 --- a/reference/swoole/swoole/client/wakeup.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Client::wakeup - Ajoute le client TCP au cycle d'événements du système. - - - - &reftitle.description; - - public voidSwoole\Client::wakeup - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/count.xml b/reference/swoole/swoole/connection/iterator/count.xml deleted file mode 100644 index 0985466790..0000000000 --- a/reference/swoole/swoole/connection/iterator/count.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Connection\Iterator::count - Compte les connexions. - - - - &reftitle.description; - - public intSwoole\Connection\Iterator::count - - - - Renvoie le nombre de connexions. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre de connexions. - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/current.xml b/reference/swoole/swoole/connection/iterator/current.xml deleted file mode 100644 index faf4b523cc..0000000000 --- a/reference/swoole/swoole/connection/iterator/current.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Connection\Iterator::current - Renvoie l'entrée de connexion actuelle. - - - - &reftitle.description; - - public ConnectionSwoole\Connection\Iterator::current - - - - Renvoie l'entrée de connexion actuelle. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'entrée de connexion actuelle. - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/key.xml b/reference/swoole/swoole/connection/iterator/key.xml deleted file mode 100644 index 8c6e6bda9b..0000000000 --- a/reference/swoole/swoole/connection/iterator/key.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Connection\Iterator::key - Renvoie la clé de la connexion actuelle. - - - - &reftitle.description; - - public intSwoole\Connection\Iterator::key - - - - Cette fonction renvoie la clé de la connexion actuelle. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La clé de la connexion actuelle. - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/next.xml b/reference/swoole/swoole/connection/iterator/next.xml deleted file mode 100644 index 35f2d8aadf..0000000000 --- a/reference/swoole/swoole/connection/iterator/next.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Connection\Iterator::next - Déplace vers la connexion suivante. - - - - &reftitle.description; - - public ConnectionSwoole\Connection\Iterator::next - - - - L'itérateur vers la prochaine connexion. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/offsetexists.xml b/reference/swoole/swoole/connection/iterator/offsetexists.xml deleted file mode 100644 index e5a47edf5e..0000000000 --- a/reference/swoole/swoole/connection/iterator/offsetexists.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Connection\Iterator::offsetExists - Vérifie si une position existe. - - - - &reftitle.description; - - public boolSwoole\Connection\Iterator::offsetExists - intindex - - - Vérifie si une position existe. - - - - - - &reftitle.parameters; - - - index - - - La position à vérifier. - - - - - - - - &reftitle.returnvalues; - - Renvoie TRUE si la position existe, sinon FALSE. - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/offsetget.xml b/reference/swoole/swoole/connection/iterator/offsetget.xml deleted file mode 100644 index fe039622e0..0000000000 --- a/reference/swoole/swoole/connection/iterator/offsetget.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Connection\Iterator::offsetGet - Position à récupérer. - - - - &reftitle.description; - - public ConnectionSwoole\Connection\Iterator::offsetGet - stringindex - - - Renvoie la connexion à la position spécifiée. - - - - - - &reftitle.parameters; - - - index - - - La position à récupérer. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/offsetset.xml b/reference/swoole/swoole/connection/iterator/offsetset.xml deleted file mode 100644 index 6899542823..0000000000 --- a/reference/swoole/swoole/connection/iterator/offsetset.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Connection\Iterator::offsetSet - Assigne une connexion à la position spécifiée. - - - - &reftitle.description; - - public voidSwoole\Connection\Iterator::offsetSet - intoffset - mixedconnection - - - Assigne une connexion à la position spécifiée. - - - - - - &reftitle.parameters; - - - offset - - - La position à laquelle assigner la connexion. - - - - - connection - - - La connexion à assigner. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/offsetunset.xml b/reference/swoole/swoole/connection/iterator/offsetunset.xml deleted file mode 100644 index f8c1b8f339..0000000000 --- a/reference/swoole/swoole/connection/iterator/offsetunset.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Connection\Iterator::offsetUnset - Supprime une position. - - - - &reftitle.description; - - public voidSwoole\Connection\Iterator::offsetUnset - intoffset - - - Supprime une position. - - - - - - &reftitle.parameters; - - - offset - - - La position à supprimer. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/rewind.xml b/reference/swoole/swoole/connection/iterator/rewind.xml deleted file mode 100644 index 5f12f9154f..0000000000 --- a/reference/swoole/swoole/connection/iterator/rewind.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Connection\Iterator::rewind - Ré-initialise l'itérateur. - - - - &reftitle.description; - - public voidSwoole\Connection\Iterator::rewind - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/valid.xml b/reference/swoole/swoole/connection/iterator/valid.xml deleted file mode 100644 index c521109664..0000000000 --- a/reference/swoole/swoole/connection/iterator/valid.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Connection\Iterator::valid - Vérifie si la position actuelle est valide. - - - - &reftitle.description; - - public boolSwoole\Connection\Iterator::valid - - - - Vérifie si la position actuelle est valide. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie TRUE si la position actuelle est valide, sinon FALSE. - - - - - - - diff --git a/reference/swoole/swoole/coroutine/call-user-func-array.xml b/reference/swoole/swoole/coroutine/call-user-func-array.xml deleted file mode 100644 index fc9f86ce17..0000000000 --- a/reference/swoole/swoole/coroutine/call-user-func-array.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Coroutine::call_user_func_array - Appelle une fonction de rappel avec un tableau de paramètres - - - - &reftitle.description; - - public static mixedSwoole\Coroutine::call_user_func_array - callablecallback - arrayparam_array - - - Appelle la fonction de rappel donnée par le premier paramètre avec les paramètres dans param_array. - - - - - - &reftitle.parameters; - - - - callback - - - Le callable à appeler. - - - - - param_array - - - Zéro ou plusieurs paramètres dans le tableau à passer à la fonction de rappel. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/call-user-func.xml b/reference/swoole/swoole/coroutine/call-user-func.xml deleted file mode 100644 index 1d24cdfc0c..0000000000 --- a/reference/swoole/swoole/coroutine/call-user-func.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Swoole\Coroutine::call_user_func - Appelle une fonction de rappel donnée par le premier paramètre - - - - &reftitle.description; - - public static mixedSwoole\Coroutine::call_user_func - callablecallback - mixedargs - - - Appelle le callback donné par le premier paramètre et passe les paramètres restants comme arguments. - - - - - - &reftitle.parameters; - - - - callback - - - Le callable à appeler. - - - - - args - - - Zéro ou plusieurs paramètres à passer à la fonction de rappel. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/cli-wait.xml b/reference/swoole/swoole/coroutine/cli-wait.xml deleted file mode 100644 index 7fecb90e09..0000000000 --- a/reference/swoole/swoole/coroutine/cli-wait.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Coroutine::cli_wait - Description - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::cli_wait - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/close.xml b/reference/swoole/swoole/coroutine/client/close.xml deleted file mode 100644 index 03c000ef78..0000000000 --- a/reference/swoole/swoole/coroutine/client/close.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::close - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::close - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/connect.xml b/reference/swoole/swoole/coroutine/client/connect.xml deleted file mode 100644 index aef706b330..0000000000 --- a/reference/swoole/swoole/coroutine/client/connect.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::connect - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::connect - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/construct.xml b/reference/swoole/swoole/coroutine/client/construct.xml deleted file mode 100644 index 6e569fe66a..0000000000 --- a/reference/swoole/swoole/coroutine/client/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Swoole\Coroutine\Client::__construct - Description - - - - &reftitle.description; - - public Swoole\Coroutine\Client::__construct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/destruct.xml b/reference/swoole/swoole/coroutine/client/destruct.xml deleted file mode 100644 index 742bb862c2..0000000000 --- a/reference/swoole/swoole/coroutine/client/destruct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::__destruct - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/getpeername.xml b/reference/swoole/swoole/coroutine/client/getpeername.xml deleted file mode 100644 index f05f382187..0000000000 --- a/reference/swoole/swoole/coroutine/client/getpeername.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::getpeername - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::getpeername - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/getsockname.xml b/reference/swoole/swoole/coroutine/client/getsockname.xml deleted file mode 100644 index 32f9ee60cd..0000000000 --- a/reference/swoole/swoole/coroutine/client/getsockname.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::getsockname - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::getsockname - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/isconnected.xml b/reference/swoole/swoole/coroutine/client/isconnected.xml deleted file mode 100644 index 480f9d2ca4..0000000000 --- a/reference/swoole/swoole/coroutine/client/isconnected.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::isConnected - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::isConnected - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/recv.xml b/reference/swoole/swoole/coroutine/client/recv.xml deleted file mode 100644 index dd3342bf47..0000000000 --- a/reference/swoole/swoole/coroutine/client/recv.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::recv - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::recv - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/send.xml b/reference/swoole/swoole/coroutine/client/send.xml deleted file mode 100644 index 0615f45fdd..0000000000 --- a/reference/swoole/swoole/coroutine/client/send.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::send - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::send - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/sendfile.xml b/reference/swoole/swoole/coroutine/client/sendfile.xml deleted file mode 100644 index e53721755c..0000000000 --- a/reference/swoole/swoole/coroutine/client/sendfile.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::sendfile - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::sendfile - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/sendto.xml b/reference/swoole/swoole/coroutine/client/sendto.xml deleted file mode 100644 index e2442d0986..0000000000 --- a/reference/swoole/swoole/coroutine/client/sendto.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::sendto - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::sendto - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/set.xml b/reference/swoole/swoole/coroutine/client/set.xml deleted file mode 100644 index 7c4025eb67..0000000000 --- a/reference/swoole/swoole/coroutine/client/set.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::set - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::set - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/create.xml b/reference/swoole/swoole/coroutine/create.xml deleted file mode 100644 index 961f76e1db..0000000000 --- a/reference/swoole/swoole/coroutine/create.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine::create - Description - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::create - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/getuid.xml b/reference/swoole/swoole/coroutine/getuid.xml deleted file mode 100644 index 813c2cbc09..0000000000 --- a/reference/swoole/swoole/coroutine/getuid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine::getuid - Description - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::getuid - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/addfile.xml b/reference/swoole/swoole/coroutine/http/client/addfile.xml deleted file mode 100644 index 1ad47dd40d..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/addfile.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::addFile - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::addFile - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/close.xml b/reference/swoole/swoole/coroutine/http/client/close.xml deleted file mode 100644 index 737b27e152..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/close.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::close - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::close - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/construct.xml b/reference/swoole/swoole/coroutine/http/client/construct.xml deleted file mode 100644 index d8474536d8..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/construct.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::__construct - Description - - - - &reftitle.description; - - public Swoole\Coroutine\Http\Client::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/destruct.xml b/reference/swoole/swoole/coroutine/http/client/destruct.xml deleted file mode 100644 index 9cb0b33d42..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/destruct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::__destruct - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/execute.xml b/reference/swoole/swoole/coroutine/http/client/execute.xml deleted file mode 100644 index 1378ec1a95..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/execute.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::execute - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::execute - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/get.xml b/reference/swoole/swoole/coroutine/http/client/get.xml deleted file mode 100644 index bea7e15e4b..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/get.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::get - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::get - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/getdefer.xml b/reference/swoole/swoole/coroutine/http/client/getdefer.xml deleted file mode 100644 index 1fd7559272..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/getdefer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::getDefer - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::getDefer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/isconnected.xml b/reference/swoole/swoole/coroutine/http/client/isconnected.xml deleted file mode 100644 index 827dddbcba..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/isconnected.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::isConnected - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::isConnected - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/post.xml b/reference/swoole/swoole/coroutine/http/client/post.xml deleted file mode 100644 index 9f19f9ab1d..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/post.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::post - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::post - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/recv.xml b/reference/swoole/swoole/coroutine/http/client/recv.xml deleted file mode 100644 index 21e7b81ea6..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/recv.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::recv - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::recv - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/set.xml b/reference/swoole/swoole/coroutine/http/client/set.xml deleted file mode 100644 index 23e38bff27..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/set.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::set - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::set - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setcookies.xml b/reference/swoole/swoole/coroutine/http/client/setcookies.xml deleted file mode 100644 index 2d3fb97049..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/setcookies.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setCookies - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setCookies - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setdata.xml b/reference/swoole/swoole/coroutine/http/client/setdata.xml deleted file mode 100644 index a1041ac232..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/setdata.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setData - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setData - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setdefer.xml b/reference/swoole/swoole/coroutine/http/client/setdefer.xml deleted file mode 100644 index cbf8b48727..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/setdefer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setDefer - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setDefer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setheaders.xml b/reference/swoole/swoole/coroutine/http/client/setheaders.xml deleted file mode 100644 index 333fcfc736..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/setheaders.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setHeaders - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setHeaders - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setmethod.xml b/reference/swoole/swoole/coroutine/http/client/setmethod.xml deleted file mode 100644 index 3b3c078780..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/setmethod.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setMethod - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setMethod - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/lock/construct.xml b/reference/swoole/swoole/coroutine/lock/construct.xml deleted file mode 100644 index 036fcd793d..0000000000 --- a/reference/swoole/swoole/coroutine/lock/construct.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - Swoole\Coroutine\Lock::__construct - Construit un nouveau verrou de coroutine - - - - &reftitle.description; - - public voidSwoole\Coroutine\Lock::__construct - - - - Construit un nouveau verrou de coroutine - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/swoole/coroutine/lock/lock.xml b/reference/swoole/swoole/coroutine/lock/lock.xml deleted file mode 100644 index af82835cc6..0000000000 --- a/reference/swoole/swoole/coroutine/lock/lock.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Lock::lock - Acquiert le verrou, en bloquant si nécessaire - - - - &reftitle.description; - - public boolSwoole\Coroutine\Lock::lock - - - - Lors de l'exécution de l'opération de verrouillage, si le verrou est déjà détenu par une autre coroutine, - la coroutine actuelle cédera activement le contrôle du CPU et entrera dans un état suspendu. - Lorsque la coroutine qui détient le verrou appelle unlock(), la coroutine en attente sera réveillée - et tentera de réacquérir le verrou. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si le verrou a été acquis avec succès, - sinon &false;. - - - - - diff --git a/reference/swoole/swoole/coroutine/lock/trylock.xml b/reference/swoole/swoole/coroutine/lock/trylock.xml deleted file mode 100644 index fb2d1047cc..0000000000 --- a/reference/swoole/swoole/coroutine/lock/trylock.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Lock::trylock - Essaie d'acquérir le verrou sans bloquer - - - - &reftitle.description; - - public boolSwoole\Coroutine\Lock::trylock - - - - Lors de l'appel de l'opération de verrouillage, si le verrou est déjà détenu par une autre coroutine, - la fonction renverra immédiatement false sans suspendre la coroutine actuelle - ou céder le contrôle du CPU. Cette conception non-bloquante permet à l'appelant de gérer de manière flexible - les situations de contention, telles que la réessayer, abandonner ou exécuter d'autres logiques. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si le verrou a été acquis avec succès, - &false; si le verrou n'est pas disponible. - - - - - diff --git a/reference/swoole/swoole/coroutine/lock/unlock.xml b/reference/swoole/swoole/coroutine/lock/unlock.xml deleted file mode 100644 index b019b675ed..0000000000 --- a/reference/swoole/swoole/coroutine/lock/unlock.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Swoole\Coroutine\Lock::unlock - Relâche le verrou - - - - &reftitle.description; - - public boolSwoole\Coroutine\Lock::unlock - - - - - - Unlock Behavior - - - - Avec io_uring futex: le système réveillera précisément une coroutine dans la file d'attente d'attente. - - - - - Sans io_uring futex: attend la fin du temps de backoff des coroutines en attente - et essaie de réacquérir le verrou. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si le verrou a été relâché avec succès, - sinon &false;. - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/close.xml b/reference/swoole/swoole/coroutine/mysql/close.xml deleted file mode 100644 index 45e3d82db9..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/close.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::close - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::close - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/connect.xml b/reference/swoole/swoole/coroutine/mysql/connect.xml deleted file mode 100644 index 924b3657f6..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/connect.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::connect - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::connect - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/construct.xml b/reference/swoole/swoole/coroutine/mysql/construct.xml deleted file mode 100644 index 44a5f6722a..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/construct.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::__construct - Description - - - - &reftitle.description; - - public Swoole\Coroutine\MySQL::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/destruct.xml b/reference/swoole/swoole/coroutine/mysql/destruct.xml deleted file mode 100644 index b4682c4e11..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/destruct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::__destruct - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/getdefer.xml b/reference/swoole/swoole/coroutine/mysql/getdefer.xml deleted file mode 100644 index 791e141250..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/getdefer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::getDefer - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::getDefer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/query.xml b/reference/swoole/swoole/coroutine/mysql/query.xml deleted file mode 100644 index b63dd18a39..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/query.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::query - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::query - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/recv.xml b/reference/swoole/swoole/coroutine/mysql/recv.xml deleted file mode 100644 index bc575eba6c..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/recv.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::recv - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::recv - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/setdefer.xml b/reference/swoole/swoole/coroutine/mysql/setdefer.xml deleted file mode 100644 index 95601f0387..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/setdefer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::setDefer - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::setDefer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/resume.xml b/reference/swoole/swoole/coroutine/resume.xml deleted file mode 100644 index 281e301191..0000000000 --- a/reference/swoole/swoole/coroutine/resume.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine::resume - Description - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::resume - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/suspend.xml b/reference/swoole/swoole/coroutine/suspend.xml deleted file mode 100644 index 80ff3c18a9..0000000000 --- a/reference/swoole/swoole/coroutine/suspend.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine::suspend - Description - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::suspend - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/event/add.xml b/reference/swoole/swoole/event/add.xml deleted file mode 100644 index ba2b6a35e4..0000000000 --- a/reference/swoole/swoole/event/add.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - Swoole\Event::add - Ajoute un socket à l'écouteur d'événements du réacteur sous-jacent - - - - &reftitle.description; - - public static boolSwoole\Event::add - mixedsock - callableread_callback - callablewrite_callback - intflags - - - Ajoute un socket à l'écouteur d'événements du réacteur sous-jacent. Cette fonction - peut être utilisée aussi bien en mode Server qu'en mode Client. - - - - Un socket déjà ajouté ne peut pas l'être une seconde fois. Il faut utiliser - swoole_event_set pour modifier les fonctions de rappel et les types d'événements - associés au socket. - - - - - - &reftitle.parameters; - - - sock - - - Descripteur de fichier, ressource de flux, ressource sockets ou objet. - - - - - read_callback - - - Fonction de rappel pour les événements de lecture. - - - - - write_callback - - - Fonction de rappel pour les événements d'écriture. - - - - - flags - - - Masque des types d'événements (par exemple SWOOLE_EVENT_READ, - SWOOLE_EVENT_WRITE ou SWOOLE_EVENT_READ | - SWOOLE_EVENT_WRITE). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Swoole\Event::add</function> - - -]]> - - - - - - - diff --git a/reference/swoole/swoole/event/cycle.xml b/reference/swoole/swoole/event/cycle.xml deleted file mode 100644 index e0510eff4a..0000000000 --- a/reference/swoole/swoole/event/cycle.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - Swoole\Event::cycle - Définit une fonction à exécuter à la fin de chaque itération de la boucle d'événements - - - - &reftitle.description; - - public static boolSwoole\Event::cycle - callablecallback - boolbeforefalse - - - Définit une fonction de rappel à exécuter à la fin de chaque itération de la - boucle d'événements (ou au début, si before vaut &true;). - - - - - &reftitle.parameters; - - - callback - - - La fonction à exécuter. Passer null supprime la fonction - définie précédemment. - - - - - before - - - Si true, la fonction de rappel est exécutée avant la - boucle d'événements ; si false, après. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Utilisation basique - - - - - - - - - diff --git a/reference/swoole/swoole/event/defer.xml b/reference/swoole/swoole/event/defer.xml deleted file mode 100644 index 47555c24f6..0000000000 --- a/reference/swoole/swoole/event/defer.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Swoole\Event::defer - Exécute une fonction au début de la prochaine boucle d'événements - - - - &reftitle.description; - - public static voidSwoole\Event::defer - callablecallback_function - - - Planifie l'exécution d'une fonction au début de la prochaine itération de la - boucle d'événements. - - - - - &reftitle.parameters; - - - callback_function - - - Fonction de rappel à exécuter (aucun paramètre n'est accepté ; il faut - utiliser use pour les variables de la fermeture). - - - - - - - - &reftitle.returnvalues; - - Aucune valeur n'est retournée. - - - - - &reftitle.examples; - - - Exemple avec <function>Swoole\Event::defer</function> - - -]]> - - - - - - - diff --git a/reference/swoole/swoole/event/del.xml b/reference/swoole/swoole/event/del.xml deleted file mode 100644 index a41063c8e3..0000000000 --- a/reference/swoole/swoole/event/del.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Swoole\Event::del - Retire un socket de l'écouteur d'événements du réacteur - - - - &reftitle.description; - - public static boolSwoole\Event::del - mixedsock - - - Retire un socket de l'écouteur d'événements du réacteur. - - - - Il faut toujours appeler Event::del pour désinscrire la surveillance des - événements avant de fermer le socket. Ne pas le faire peut provoquer des - fuites de mémoire. - - - - - - &reftitle.parameters; - - - sock - - - Descripteur de fichier du socket à retirer. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/swoole/swoole/event/dispatch.xml b/reference/swoole/swoole/event/dispatch.xml deleted file mode 100644 index 81e5fc2ca2..0000000000 --- a/reference/swoole/swoole/event/dispatch.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Swoole\Event::dispatch - Effectue une seule itération de la boucle d'événements - - - - &reftitle.description; - - public static voidSwoole\Event::dispatch - - - - Cette fonction sert à préserver la compatibilité avec certains frameworks. - Lorsqu'un framework gère lui-même sa propre boucle de réacteur, l'utilisation de - Event::wait laisserait la main à la couche basse de Swoole, empêchant le - framework de reprendre le contrôle de l'exécution. - - - - - &reftitle.returnvalues; - - Aucune valeur n'est retournée. - - - - - &reftitle.examples; - - - Contrôle manuel de la boucle d'événements - - - - - - - - - diff --git a/reference/swoole/swoole/event/isset.xml b/reference/swoole/swoole/event/isset.xml deleted file mode 100644 index aa2099a9c4..0000000000 --- a/reference/swoole/swoole/event/isset.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Swoole\Event::isset - Vérifie si un socket est surveillé dans la boucle d'événements - - - - &reftitle.description; - - public static boolSwoole\Event::isset - mixedfd - intevents - - SWOOLE_EVENT_READ | SWOOLE_EVENT_WRITE - - - - - Vérifie si le descripteur de fichier indiqué est surveillé, dans la boucle - d'événements, pour les types d'événements fournis. - - - - - &reftitle.parameters; - - - fd - - - Descripteur de fichier (ressource de flux ou de socket, entier, ou objet). - - - - - events - - - Types d'événements à vérifier (masque binaire de - SWOOLE_EVENT_READ et/ou de - SWOOLE_EVENT_WRITE). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Vérification de la surveillance des événements - - - - - - - - - diff --git a/reference/swoole/swoole/event/set.xml b/reference/swoole/swoole/event/set.xml deleted file mode 100644 index 2282e1e8da..0000000000 --- a/reference/swoole/swoole/event/set.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - Swoole\Event::set - Modifie les fonctions de rappel et le masque de l'écouteur d'événements - - - - &reftitle.description; - - public static boolSwoole\Event::set - mixedsock - callableread_callback - callablewrite_callback - intflags - - - Modifie les fonctions de rappel et le masque de l'écouteur d'événements pour le - descripteur de fichier fourni. - - - - Lorsque $read_callback n'est pas null, la fonction de rappel des événements de - lecture est remplacée par la fonction indiquée. - - - - - Lorsque $write_callback n'est pas null, la fonction de rappel des événements - d'écriture est remplacée par la fonction indiquée. - - - - - Définir SWOOLE_EVENT_READ seul désactive l'écoute des événements d'écriture, - tandis que définir SWOOLE_EVENT_WRITE seul désactive l'écoute des événements - de lecture. - - - - - Swoole\Event::set remplace les fonctions de rappel mais ne les libère pas. - Passer null pour une fonction de rappel (read_callback/write_callback par - exemple) conserve la fonction de rappel existante au lieu de l'effacer. - - - - - Écouter SWOOLE_EVENT_READ sans read_callback (ou SWOOLE_EVENT_WRITE sans - write_callback) fait échouer l'opération, qui retourne alors &false;. - - - - - - &reftitle.parameters; - - - sock - - - Descripteur de fichier, ressource de flux, ressource sockets ou objet. - - - - - read_callback - - - Fonction de rappel pour les événements de lecture. - - - - - write_callback - - - Fonction de rappel pour les événements d'écriture. - - - - - flags - - - Masque des types d'événements (par exemple SWOOLE_EVENT_READ, - SWOOLE_EVENT_WRITE ou SWOOLE_EVENT_READ | - SWOOLE_EVENT_WRITE). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/swoole/swoole/event/wait.xml b/reference/swoole/swoole/event/wait.xml deleted file mode 100644 index fe0a78f262..0000000000 --- a/reference/swoole/swoole/event/wait.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Swoole\Event::wait - Démarre la boucle d'événements - - - - &reftitle.description; - - public static voidSwoole\Event::wait - - - - Démarre la boucle d'événements. Cet appel se place à la fin du programme PHP. - - - - - &reftitle.returnvalues; - - Aucune valeur n'est retournée. - - - - - &reftitle.examples; - - - Exemple avec <function>Swoole\Event::wait</function> - - -]]> - - - - - - - diff --git a/reference/swoole/swoole/event/write.xml b/reference/swoole/swoole/event/write.xml deleted file mode 100644 index ec442dfbcc..0000000000 --- a/reference/swoole/swoole/event/write.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - Swoole\Event::write - Écrit des données sur un socket de manière asynchrone - - - - &reftitle.description; - - public static boolSwoole\Event::write - mixedfd - mixeddata - - - Rend l'envoi de données asynchrone pour les ressources de flux et de sockets. - - - - Si des données sont écrites en continu sur un socket alors que le pair ne les - lit pas assez vite, le tampon du socket finit par être saturé. Dans ce cas, la - couche basse de Swoole stocke les données excédentaires dans un tampon en - mémoire et attend le déclenchement de l'événement d'écriture avant de tenter - d'écrire à nouveau sur le socket. Cependant, si ce tampon en mémoire est lui - aussi saturé, Swoole émet l'erreur « pipe buffer overflow, reactor will block » - et bascule en mode bloquant, suspendant les écritures suivantes jusqu'à ce que - de la place se libère. - - - - - Le retour de &false; lorsque le tampon est saturé est une opération atomique : - soit la totalité des données est écrite, soit rien ne l'est. - - - - - Event::write ne peut pas être utilisée avec des flux ou des sockets chiffrés - en SSL/TLS (connexions tunnelisées). - - - - - En cas de succès, Event::write bascule automatiquement $socket en mode non - bloquant. - - - - - - &reftitle.parameters; - - - fd - - - Descripteur de fichier (ressource de flux ou de socket, entier, ou objet). - - - - - data - - - Données à envoyer (leur longueur ne doit pas dépasser la taille du tampon du - socket). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>Swoole\Event::write</function> - - -]]> - - - - - - - diff --git a/reference/swoole/swoole/http/client/addfile.xml b/reference/swoole/swoole/http/client/addfile.xml deleted file mode 100644 index 03d50dd521..0000000000 --- a/reference/swoole/swoole/http/client/addfile.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Swoole\Http\Client::addFile - Ajoute un fichier au formulaire de publication. - - - - &reftitle.description; - - public voidSwoole\Http\Client::addFile - stringpath - stringname - stringtype - stringfilename - stringoffset - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - name - - - - - - - - type - - - - - - - - filename - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/close.xml b/reference/swoole/swoole/http/client/close.xml deleted file mode 100644 index 9e6c8a3ffd..0000000000 --- a/reference/swoole/swoole/http/client/close.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Client::close - Ferme la connexion http. - - - - &reftitle.description; - - public voidSwoole\Http\Client::close - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/construct.xml b/reference/swoole/swoole/http/client/construct.xml deleted file mode 100644 index 084fbf4c3b..0000000000 --- a/reference/swoole/swoole/http/client/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Swoole\Http\Client::__construct - Construit le client HTTP asynchrone. - - - - &reftitle.description; - - public Swoole\Http\Client::__construct - stringhost - stringport - boolssl - - - - - - - - - &reftitle.parameters; - - - host - - - Le nom d'hôte de l'hôte distant. - - - - - port - - - Le numéro de port de l'hôte distant. - - - - - ssl - - - Activer ou non SSL. - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/destruct.xml b/reference/swoole/swoole/http/client/destruct.xml deleted file mode 100644 index 99ee983ac6..0000000000 --- a/reference/swoole/swoole/http/client/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Client::__destruct - Détruit le client HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Client::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/download.xml b/reference/swoole/swoole/http/client/download.xml deleted file mode 100644 index addb6cd234..0000000000 --- a/reference/swoole/swoole/http/client/download.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Swoole\Http\Client::download - Télécharge un fichier depuis le serveur distant. - - - - &reftitle.description; - - public voidSwoole\Http\Client::download - stringpath - stringfile - callablecallback - intoffset - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - file - - - - - - - - callback - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/execute.xml b/reference/swoole/swoole/http/client/execute.xml deleted file mode 100644 index 2431fd1ded..0000000000 --- a/reference/swoole/swoole/http/client/execute.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Http\Client::execute - Envoie la requête HTTP après avoir défini les paramètres. - - - - &reftitle.description; - - public voidSwoole\Http\Client::execute - stringpath - stringcallback - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/get.xml b/reference/swoole/swoole/http/client/get.xml deleted file mode 100644 index aaaad6f34a..0000000000 --- a/reference/swoole/swoole/http/client/get.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Http\Client::get - Envoie une requête HTTP GET au serveur distant. - - - - &reftitle.description; - - public voidSwoole\Http\Client::get - stringpath - callablecallback - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/isconnected.xml b/reference/swoole/swoole/http/client/isconnected.xml deleted file mode 100644 index 3062478e12..0000000000 --- a/reference/swoole/swoole/http/client/isconnected.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Client::isConnected - Vérifie si la connexion HTTP est établie. - - - - &reftitle.description; - - public boolSwoole\Http\Client::isConnected - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/on.xml b/reference/swoole/swoole/http/client/on.xml deleted file mode 100644 index d0af59d4a1..0000000000 --- a/reference/swoole/swoole/http/client/on.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Http\Client::on - Enregistre une fonction de rappel par nom d'événement. - - - - &reftitle.description; - - public voidSwoole\Http\Client::on - stringevent_name - callablecallback - - - - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/post.xml b/reference/swoole/swoole/http/client/post.xml deleted file mode 100644 index 8c03418560..0000000000 --- a/reference/swoole/swoole/http/client/post.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Http\Client::post - Envoie une requête HTTP POST au serveur distant. - - - - &reftitle.description; - - public voidSwoole\Http\Client::post - stringpath - stringdata - callablecallback - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - data - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/push.xml b/reference/swoole/swoole/http/client/push.xml deleted file mode 100644 index 82ae87c471..0000000000 --- a/reference/swoole/swoole/http/client/push.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Http\Client::push - Ajoute des données au client websocket. - - - - &reftitle.description; - - public voidSwoole\Http\Client::push - stringdata - stringopcode - stringfinish - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - opcode - - - - - - - - finish - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/set.xml b/reference/swoole/swoole/http/client/set.xml deleted file mode 100644 index 09db6db9bd..0000000000 --- a/reference/swoole/swoole/http/client/set.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Client::set - Met à jour les paramètres du client HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Client::set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/setcookies.xml b/reference/swoole/swoole/http/client/setcookies.xml deleted file mode 100644 index df61c1b22a..0000000000 --- a/reference/swoole/swoole/http/client/setcookies.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Client::setCookies - Définit les cookies de la requête HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Client::setCookies - arraycookies - - - - - - - - - &reftitle.parameters; - - - cookies - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/setdata.xml b/reference/swoole/swoole/http/client/setdata.xml deleted file mode 100644 index c47c9c2d63..0000000000 --- a/reference/swoole/swoole/http/client/setdata.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Client::setData - Définit les données du corps de la requête HTTP. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Client::setData - stringdata - - - La méthode HTTP sera modifiée pour être POST. - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/setheaders.xml b/reference/swoole/swoole/http/client/setheaders.xml deleted file mode 100644 index b848e82f26..0000000000 --- a/reference/swoole/swoole/http/client/setheaders.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Client::setHeaders - Définit les en-têtes de la requête HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Client::setHeaders - arrayheaders - - - - - - - - - &reftitle.parameters; - - - headers - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/setmethod.xml b/reference/swoole/swoole/http/client/setmethod.xml deleted file mode 100644 index b616ac81b4..0000000000 --- a/reference/swoole/swoole/http/client/setmethod.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Client::setMethod - Définit la méthode de requête HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Client::setMethod - stringmethod - - - - - - - - - &reftitle.parameters; - - - method - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/upgrade.xml b/reference/swoole/swoole/http/client/upgrade.xml deleted file mode 100644 index 815429d55d..0000000000 --- a/reference/swoole/swoole/http/client/upgrade.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Http\Client::upgrade - Met à niveau vers le protocole websocket. - - - - &reftitle.description; - - public voidSwoole\Http\Client::upgrade - stringpath - stringcallback - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/request/destruct.xml b/reference/swoole/swoole/http/request/destruct.xml deleted file mode 100644 index 37ef40d2ec..0000000000 --- a/reference/swoole/swoole/http/request/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Request::__destruct - Détruit la requête HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Request::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/request/rawcontent.xml b/reference/swoole/swoole/http/request/rawcontent.xml deleted file mode 100644 index 80c1428a96..0000000000 --- a/reference/swoole/swoole/http/request/rawcontent.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Http\Request::rawcontent - Renvoie le corps brut de la requête HTTP. - - - - &reftitle.description; - - public stringSwoole\Http\Request::rawcontent - - - - Cette méthode est utilisée pour obtenir les données POST qui ne sont pas sous la forme de `application/x-www-form-urlencoded`. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/cookie.xml b/reference/swoole/swoole/http/response/cookie.xml deleted file mode 100644 index 669b6d910e..0000000000 --- a/reference/swoole/swoole/http/response/cookie.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Swoole\Http\Response::cookie - Définit les cookies de la réponse HTTP. - - - - &reftitle.description; - - public stringSwoole\Http\Response::cookie - stringname - stringvalue - stringexpires - stringpath - stringdomain - stringsecure - stringhttponly - - - - - - - - - &reftitle.parameters; - - - name - - - - - - - - value - - - - - - - - expires - - - - - - - - path - - - - - - - - domain - - - - - - - - secure - - - - - - - - httponly - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/destruct.xml b/reference/swoole/swoole/http/response/destruct.xml deleted file mode 100644 index 365c83dcef..0000000000 --- a/reference/swoole/swoole/http/response/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Response::__destruct - Détruit la réponse HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Response::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/end.xml b/reference/swoole/swoole/http/response/end.xml deleted file mode 100644 index 4b398f1275..0000000000 --- a/reference/swoole/swoole/http/response/end.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Response::end - Envoie les données pour la requête HTTP et termine la réponse. - - - - &reftitle.description; - - public voidSwoole\Http\Response::end - stringcontent - - - - - - - - - &reftitle.parameters; - - - content - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/gzip.xml b/reference/swoole/swoole/http/response/gzip.xml deleted file mode 100644 index d237b21b96..0000000000 --- a/reference/swoole/swoole/http/response/gzip.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Response::gzip - Active la compression gzip du contenu de la réponse. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::gzip - stringcompress_level - - - Les en-têtes à propos de Content-Encoding seront ajoutés automatiquement. - - - - - - &reftitle.parameters; - - - compress_level - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/header.xml b/reference/swoole/swoole/http/response/header.xml deleted file mode 100644 index fd02f9f1d4..0000000000 --- a/reference/swoole/swoole/http/response/header.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Http\Response::header - Définit les en-têtes de réponse HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Response::header - stringkey - stringvalue - stringucwords - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - value - - - - - - - - ucwords - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/initheader.xml b/reference/swoole/swoole/http/response/initheader.xml deleted file mode 100644 index ec43615e17..0000000000 --- a/reference/swoole/swoole/http/response/initheader.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Response::initHeader - Initialise l'en-tête de réponse HTTP. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::initHeader - - - - Initialise l'en-tête de réponse HTTP. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/rawcookie.xml b/reference/swoole/swoole/http/response/rawcookie.xml deleted file mode 100644 index 83d80bdc54..0000000000 --- a/reference/swoole/swoole/http/response/rawcookie.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Swoole\Http\Response::rawcookie - Définit les cookies bruts de la réponse HTTP. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::rawcookie - stringname - stringvalue - stringexpires - stringpath - stringdomain - stringsecure - stringhttponly - - - - - - - - - &reftitle.parameters; - - - name - - - - - - - - value - - - - - - - - expires - - - - - - - - path - - - - - - - - domain - - - - - - - - secure - - - - - - - - httponly - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/sendfile.xml b/reference/swoole/swoole/http/response/sendfile.xml deleted file mode 100644 index a3cff896c0..0000000000 --- a/reference/swoole/swoole/http/response/sendfile.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Http\Response::sendfile - Envoie un fichier via la réponse HTTP. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::sendfile - stringfilename - intoffset - - - Envoie un fichier via la réponse HTTP. - - - - - - &reftitle.parameters; - - - filename - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/status.xml b/reference/swoole/swoole/http/response/status.xml deleted file mode 100644 index c535fc8dd4..0000000000 --- a/reference/swoole/swoole/http/response/status.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Response::status - Définit le code d'état de la réponse HTTP. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::status - stringhttp_code - - - Définit le code d'état de la réponse HTTP. - - - - - - &reftitle.parameters; - - - http_code - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/write.xml b/reference/swoole/swoole/http/response/write.xml deleted file mode 100644 index 6fd483b7cf..0000000000 --- a/reference/swoole/swoole/http/response/write.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Response::write - Ajoute le contenu du corps HTTP à la réponse HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Response::write - stringcontent - - - Ajoute le contenu du corps HTTP à la réponse HTTP. - - - - - - &reftitle.parameters; - - - content - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/server/on.xml b/reference/swoole/swoole/http/server/on.xml deleted file mode 100644 index f66ba6db2d..0000000000 --- a/reference/swoole/swoole/http/server/on.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Http\Server::on - Lie une fonction de rappel au serveur HTTP par nom d'événement. - - - - &reftitle.description; - - public voidSwoole\Http\Server::on - stringevent_name - callablecallback - - - Lie une fonction de rappel au serveur HTTP par nom d'événement. - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/server/start.xml b/reference/swoole/swoole/http/server/start.xml deleted file mode 100644 index 4e2b3be761..0000000000 --- a/reference/swoole/swoole/http/server/start.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Server::start - Lance le serveur HTTP swoole. - - - - &reftitle.description; - - public voidSwoole\Http\Server::start - - - - Lance le serveur HTTP swoole. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/lock/construct.xml b/reference/swoole/swoole/lock/construct.xml deleted file mode 100644 index 1bdee5965e..0000000000 --- a/reference/swoole/swoole/lock/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Swoole\Lock::__construct - Construit un verrou de mémoire. - - - - &reftitle.description; - - public Swoole\Lock::__construct - stringtype - stringfile_lock_location - - - Un verrou Swoole est utilisé pour la synchronisation des données entre plusieurs threads ou processus. - - - - - - &reftitle.parameters; - - - type - - - - - - - - file_lock_location - - - - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/lock/destruct.xml b/reference/swoole/swoole/lock/destruct.xml deleted file mode 100644 index c9700d39b6..0000000000 --- a/reference/swoole/swoole/lock/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Lock::__destruct - Détruit un verrou de mémoire Swoole. - - - - &reftitle.description; - - public voidSwoole\Lock::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/lock/lock-read.xml b/reference/swoole/swoole/lock/lock-read.xml deleted file mode 100644 index 1de5a40531..0000000000 --- a/reference/swoole/swoole/lock/lock-read.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Lock::lock_read - Verrouille un verrou en lecture-écriture pour la lecture. - - - - &reftitle.description; - - public voidSwoole\Lock::lock_read - - - - Verrouille un verrou en lecture-écriture pour la lecture. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/lock/lock.xml b/reference/swoole/swoole/lock/lock.xml deleted file mode 100644 index b7df29bbc1..0000000000 --- a/reference/swoole/swoole/lock/lock.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Lock::lock - Essaie d'acquérir le verrou. Il bloquera si le verrou n'est pas disponible. - - - - &reftitle.description; - - public voidSwoole\Lock::lock - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/lock/trylock-read.xml b/reference/swoole/swoole/lock/trylock-read.xml deleted file mode 100644 index d808789454..0000000000 --- a/reference/swoole/swoole/lock/trylock-read.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Lock::trylock_read - Essaie de verrouiller un verrou en lecture-écriture pour la lecture et retourne immédiatement même si le verrou n'est pas disponible. - - - - &reftitle.description; - - public voidSwoole\Lock::trylock_read - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/lock/trylock.xml b/reference/swoole/swoole/lock/trylock.xml deleted file mode 100644 index 233691f3b8..0000000000 --- a/reference/swoole/swoole/lock/trylock.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Lock::trylock - Essaie d'acquérir le verrou et retourne immédiatement même si le verrou n'est pas disponible. - - - - &reftitle.description; - - public voidSwoole\Lock::trylock - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/lock/unlock.xml b/reference/swoole/swoole/lock/unlock.xml deleted file mode 100644 index 2a2adeb792..0000000000 --- a/reference/swoole/swoole/lock/unlock.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Lock::unlock - Libère le verrou. - - - - &reftitle.description; - - public voidSwoole\Lock::unlock - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mmap/open.xml b/reference/swoole/swoole/mmap/open.xml deleted file mode 100644 index 946f77bca2..0000000000 --- a/reference/swoole/swoole/mmap/open.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Mmap::open - Mappe un fichier en mémoire et retourne la ressource de flux qui peut être utilisée par les opérations de flux PHP. - - - - &reftitle.description; - - public static ReturnTypeSwoole\Mmap::open - stringfilename - stringsize - stringoffset - - - - - - - - - &reftitle.parameters; - - - filename - - - - - - - - size - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/close.xml b/reference/swoole/swoole/mysql/close.xml deleted file mode 100644 index f70f145dfe..0000000000 --- a/reference/swoole/swoole/mysql/close.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\MySQL::close - Ferme la connexion MySQL asynchrone. - - - - &reftitle.description; - - public voidSwoole\MySQL::close - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/connect.xml b/reference/swoole/swoole/mysql/connect.xml deleted file mode 100644 index 24138e340f..0000000000 --- a/reference/swoole/swoole/mysql/connect.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\MySQL::connect - Connecte au serveur MySQL distant. - - - - &reftitle.description; - - public voidSwoole\MySQL::connect - arrayserver_config - callablecallback - - - Connecte au serveur MySQL distant. - - - - - - &reftitle.parameters; - - - server_config - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/construct.xml b/reference/swoole/swoole/mysql/construct.xml deleted file mode 100644 index 49ced093ce..0000000000 --- a/reference/swoole/swoole/mysql/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Swoole\MySQL::__construct - Construit un client MySQL asynchrone. - - - - &reftitle.description; - - public Swoole\MySQL::__construct - - - - Construit un client MySQL asynchrone. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/destruct.xml b/reference/swoole/swoole/mysql/destruct.xml deleted file mode 100644 index 2f28d4fde2..0000000000 --- a/reference/swoole/swoole/mysql/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\MySQL::__destruct - Détruit le client MySQL asynchrone. - - - - &reftitle.description; - - public voidSwoole\MySQL::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/getbuffer.xml b/reference/swoole/swoole/mysql/getbuffer.xml deleted file mode 100644 index 747f9c7ae7..0000000000 --- a/reference/swoole/swoole/mysql/getbuffer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\MySQL::getBuffer - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\MySQL::getBuffer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/on.xml b/reference/swoole/swoole/mysql/on.xml deleted file mode 100644 index 81c8a0cc71..0000000000 --- a/reference/swoole/swoole/mysql/on.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\MySQL::on - Enregistre une fonction de rappel basée sur le nom de l'événement. - - - - &reftitle.description; - - public voidSwoole\MySQL::on - stringevent_name - callablecallback - - - Enregistre une fonction de rappel basée sur le nom de l'événement, actuellement seul l'événement 'close' est pris en charge. - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/query.xml b/reference/swoole/swoole/mysql/query.xml deleted file mode 100644 index 3089cf3b1c..0000000000 --- a/reference/swoole/swoole/mysql/query.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\MySQL::query - Exécute la requête SQL. - - - - &reftitle.description; - - public ReturnTypeSwoole\MySQL::query - stringsql - callablecallback - - - - - - - - - &reftitle.parameters; - - - sql - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/alarm.xml b/reference/swoole/swoole/process/alarm.xml deleted file mode 100644 index f075a13dd6..0000000000 --- a/reference/swoole/swoole/process/alarm.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::alarm - Minuteur de haute précision qui déclenche un signal à intervalle fixe. - - - - &reftitle.description; - - public static voidSwoole\Process::alarm - intinterval_usec - - - - - - - - - &reftitle.parameters; - - - interval_usec - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/close.xml b/reference/swoole/swoole/process/close.xml deleted file mode 100644 index 894c312ead..0000000000 --- a/reference/swoole/swoole/process/close.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Process::close - Ferme le tube vers le processus enfant. - - - - &reftitle.description; - - public voidSwoole\Process::close - - - - Ferme le tube vers le processus enfant. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/construct.xml b/reference/swoole/swoole/process/construct.xml deleted file mode 100644 index a880910558..0000000000 --- a/reference/swoole/swoole/process/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Swoole\Process::__construct - Construit un processus. - - - - &reftitle.description; - - public Swoole\Process::__construct - callablecallback - boolredirect_stdin_and_stdout - intpipe_type - - - - - - - - - &reftitle.parameters; - - - callback - - - - - - - - redirect_stdin_and_stdout - - - - - - - - pipe_type - - - - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/process/daemon.xml b/reference/swoole/swoole/process/daemon.xml deleted file mode 100644 index 85adbae7c5..0000000000 --- a/reference/swoole/swoole/process/daemon.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Process::daemon - Change le processus en un processus daemon. - - - - &reftitle.description; - - public static voidSwoole\Process::daemon - boolnochdir - boolnoclose - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - nochdir - - - - - - - - noclose - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/destruct.xml b/reference/swoole/swoole/process/destruct.xml deleted file mode 100644 index 9d5a018e0d..0000000000 --- a/reference/swoole/swoole/process/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Process::__destruct - Détruit le processus. - - - - &reftitle.description; - - public voidSwoole\Process::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/exec.xml b/reference/swoole/swoole/process/exec.xml deleted file mode 100644 index be4fb3a724..0000000000 --- a/reference/swoole/swoole/process/exec.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Process::exec - Exécute une commande système. - - - - &reftitle.description; - - public ReturnTypeSwoole\Process::exec - stringexec_file - stringargs - - - Le processus sera remplacé par le processus de commande système, mais le tube vers le processus parent sera conservé. - - - - - - &reftitle.parameters; - - - exec_file - - - - - - - - args - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/exit.xml b/reference/swoole/swoole/process/exit.xml deleted file mode 100644 index 838086ac19..0000000000 --- a/reference/swoole/swoole/process/exit.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::exit - Arrête les processus enfants. - - - - &reftitle.description; - - public voidSwoole\Process::exit - stringexit_code - - - - - - - - - &reftitle.parameters; - - - exit_code - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/freequeue.xml b/reference/swoole/swoole/process/freequeue.xml deleted file mode 100644 index 4f58810d81..0000000000 --- a/reference/swoole/swoole/process/freequeue.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Process::freeQueue - Détruit la file de messages créée par swoole_process::useQueue. - - - - &reftitle.description; - - public voidSwoole\Process::freeQueue - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/kill.xml b/reference/swoole/swoole/process/kill.xml deleted file mode 100644 index ce4e02a50e..0000000000 --- a/reference/swoole/swoole/process/kill.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Process::kill - Envoie un signal au processus enfant. - - - - &reftitle.description; - - public static boolSwoole\Process::kill - intpid - intsignal_no - - - Envoie un signal au processus enfant. - - - - - - &reftitle.parameters; - - - pid - - - Le PID du processus - - - - - signal_no - - - Le signal à envoyer - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/swoole/process/name.xml b/reference/swoole/swoole/process/name.xml deleted file mode 100644 index c09bc8c871..0000000000 --- a/reference/swoole/swoole/process/name.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::name - Définit le nom du processus. - - - - &reftitle.description; - - public boolSwoole\Process::name - stringprocess_name - - - - - - - - - &reftitle.parameters; - - - process_name - - - Définit le nom du processus. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/swoole/process/pop.xml b/reference/swoole/swoole/process/pop.xml deleted file mode 100644 index 713f6aae76..0000000000 --- a/reference/swoole/swoole/process/pop.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::pop - Lit et extrait des données de la file de messages. - - - - &reftitle.description; - - public mixedSwoole\Process::pop - intmaxsize - - - - - - - - - &reftitle.parameters; - - - maxsize - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/push.xml b/reference/swoole/swoole/process/push.xml deleted file mode 100644 index 3489b096c0..0000000000 --- a/reference/swoole/swoole/process/push.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::push - Ecrit et pousse des données dans la file de messages. - - - - &reftitle.description; - - public boolSwoole\Process::push - stringdata - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/read.xml b/reference/swoole/swoole/process/read.xml deleted file mode 100644 index d56179bbe7..0000000000 --- a/reference/swoole/swoole/process/read.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::read - Lit les données envoyées au processus. - - - - &reftitle.description; - - public stringSwoole\Process::read - intmaxsize - - - - - - - - - &reftitle.parameters; - - - maxsize - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/signal.xml b/reference/swoole/swoole/process/signal.xml deleted file mode 100644 index 1b0d25290c..0000000000 --- a/reference/swoole/swoole/process/signal.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Process::signal - Envoie un signal aux processus enfants. - - - - &reftitle.description; - - public static voidSwoole\Process::signal - stringsignal_no - callablecallback - - - - - - - - - &reftitle.parameters; - - - signal_no - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - Si le signal est envoyé avec succès, il renvoie TRUE, sinon il renvoie FALSE. - - - - - - - diff --git a/reference/swoole/swoole/process/start.xml b/reference/swoole/swoole/process/start.xml deleted file mode 100644 index ea514362f7..0000000000 --- a/reference/swoole/swoole/process/start.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Process::start - Démarre le processus. - - - - &reftitle.description; - - public voidSwoole\Process::start - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/statqueue.xml b/reference/swoole/swoole/process/statqueue.xml deleted file mode 100644 index 026dfda096..0000000000 --- a/reference/swoole/swoole/process/statqueue.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Process::statQueue - Renvoie les statistiques de la file de messages utilisée comme méthode de communication entre les processus. - - - - &reftitle.description; - - public arraySwoole\Process::statQueue - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le tableau de statut de la file de messages. - - - - - - - - diff --git a/reference/swoole/swoole/process/usequeue.xml b/reference/swoole/swoole/process/usequeue.xml deleted file mode 100644 index 2a21cc2ec6..0000000000 --- a/reference/swoole/swoole/process/usequeue.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Process::useQueue - Créer une file de messages comme méthode de communication entre le processus parent et les processus enfants. - - - - &reftitle.description; - - public boolSwoole\Process::useQueue - intkey - intmode - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - mode - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/wait.xml b/reference/swoole/swoole/process/wait.xml deleted file mode 100644 index 215e71d2b3..0000000000 --- a/reference/swoole/swoole/process/wait.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::wait - Attend les événements des processus enfants. - - - - &reftitle.description; - - public static arraySwoole\Process::wait - boolblocking - - - - - - - - - &reftitle.parameters; - - - blocking - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/write.xml b/reference/swoole/swoole/process/write.xml deleted file mode 100644 index 64737ac56c..0000000000 --- a/reference/swoole/swoole/process/write.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::write - Ecrit des données dans le tube et communique avec le processus parent ou les processus enfants. - - - - &reftitle.description; - - public intSwoole\Process::write - stringdata - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/redis/server/format.xml b/reference/swoole/swoole/redis/server/format.xml deleted file mode 100644 index c4cce09ea9..0000000000 --- a/reference/swoole/swoole/redis/server/format.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Redis\Server::format - Description - - - - &reftitle.description; - - public static ReturnTypeSwoole\Redis\Server::format - stringtype - stringvalue - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - type - - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/redis/server/sethandler.xml b/reference/swoole/swoole/redis/server/sethandler.xml deleted file mode 100644 index 082d19fce8..0000000000 --- a/reference/swoole/swoole/redis/server/sethandler.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Swoole\Redis\Server::setHandler - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Redis\Server::setHandler - stringcommand - stringcallback - stringnumber_of_string_param - stringtype_of_array_param - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - command - - - - - - - - callback - - - - - - - - number_of_string_param - - - - - - - - type_of_array_param - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/redis/server/start.xml b/reference/swoole/swoole/redis/server/start.xml deleted file mode 100644 index e530430c74..0000000000 --- a/reference/swoole/swoole/redis/server/start.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Redis\Server::start - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Redis\Server::start - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/runtime/enableCoroutine.xml b/reference/swoole/swoole/runtime/enableCoroutine.xml deleted file mode 100644 index 09a3458e59..0000000000 --- a/reference/swoole/swoole/runtime/enableCoroutine.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - Swoole\Runtime::enableCoroutine - Active la coroutine pour les fonctions spécifiées - - - - &reftitle.description; - - public static voidSwoole\Runtime::enableCoroutine - intflagsSWOOLE_HOOK_ALL - - - Cette méthode permet le support des coroutines pour les fonctions PHP spécifiées en fonction des drapeaux donnés. - Elle doit être appelée une fois au début de l'application. - - - - - &reftitle.parameters; - - - flags - - - Un masque de bits spécifiant sur quelles fonctions utiliser les crochets. Peut être combiné en utilisant l'opérateur |. - Drapeaux disponibles : - SWOOLE_HOOK_TCP, - SWOOLE_HOOK_UDP, - SWOOLE_HOOK_UNIX, - SWOOLE_HOOK_UDG, - SWOOLE_HOOK_SSL, - SWOOLE_HOOK_TLS, - SWOOLE_HOOK_SLEEP, - SWOOLE_HOOK_FILE, - SWOOLE_HOOK_STREAM_FUNCTION, - SWOOLE_HOOK_BLOCKING_FUNCTION, - SWOOLE_HOOK_PROC, - SWOOLE_HOOK_CURL, - SWOOLE_HOOK_NATIVE_CURL, - SWOOLE_HOOK_SOCKETS, - SWOOLE_HOOK_STDIO, - SWOOLE_HOOK_PDO_PGSQL, - SWOOLE_HOOK_PDO_ODBC, - SWOOLE_HOOK_PDO_ORACLE, - SWOOLE_HOOK_PDO_SQLITE, - ou SWOOLE_HOOK_ALL pour tous les drapeaux. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/swoole/runtime/getHookFlags.xml b/reference/swoole/swoole/runtime/getHookFlags.xml deleted file mode 100644 index 2eddd1f4d7..0000000000 --- a/reference/swoole/swoole/runtime/getHookFlags.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - Swoole\Runtime::getHookFlags - Renvoie les drapeaux du crochet actuel - - - - &reftitle.description; - - public static intSwoole\Runtime::getHookFlags - - - - Renvoie les drapeaux du crochet actuel. - Il est à noter que les drapeaux retournés peuvent différer de ceux qui ont été définis si certains crochets ont échoué. - - - - - &reftitle.parameters; - - Cette fonction n'a pas de paramètres. - - - - - &reftitle.returnvalues; - - Renvoie le masque de bits des drapeaux du crochet actuel. - - - - - diff --git a/reference/swoole/swoole/runtime/setHookFlags.xml b/reference/swoole/swoole/runtime/setHookFlags.xml deleted file mode 100644 index 3988b69b82..0000000000 --- a/reference/swoole/swoole/runtime/setHookFlags.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - Swoole\Runtime::setHookFlags - Définit les drapeaux de crochet pour la coroutine - - - - &reftitle.description; - - public static boolSwoole\Runtime::setHookFlags - intflags - - - Définit les drapeaux de crochet pour le support des coroutines. - Ceci change dynamiquement les drapeaux de crochet à l'exécution. - - - - - &reftitle.parameters; - - - flags - - - Un masque de bits spécifiant les fonctions à utiliser pour les crochets. Même drapeaux que pour enableCoroutine. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/swoole/swoole/serialize/pack.xml b/reference/swoole/swoole/serialize/pack.xml deleted file mode 100644 index 32c53cab81..0000000000 --- a/reference/swoole/swoole/serialize/pack.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Serialize::pack - Sérialise les données. - - - - &reftitle.description; - - public static ReturnTypeSwoole\Serialize::pack - stringdata - intis_fast - - - Swoole apporte un module de sérialisation rapide et performant. - - - - - - &reftitle.parameters; - - - data - - - - - - - - is_fast - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/serialize/unpack.xml b/reference/swoole/swoole/serialize/unpack.xml deleted file mode 100644 index c16b2e164a..0000000000 --- a/reference/swoole/swoole/serialize/unpack.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Serialize::unpack - Désérialise les données. - - - - &reftitle.description; - - public static ReturnTypeSwoole\Serialize::unpack - stringdata - stringargs - - - Désérialise les données. - - - - - - &reftitle.parameters; - - - string - - - - - - - - args - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/addlistener.xml b/reference/swoole/swoole/server/addlistener.xml deleted file mode 100644 index 170e9f92ed..0000000000 --- a/reference/swoole/swoole/server/addlistener.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Server::addlistener - Ajoute un nouvel observateur au serveur. - - - - &reftitle.description; - - public voidSwoole\Server::addlistener - stringhost - intport - stringsocket_type - - - - - - - - - &reftitle.parameters; - - - host - - - - - - - - port - - - - - - - - socket_type - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/addprocess.xml b/reference/swoole/swoole/server/addprocess.xml deleted file mode 100644 index 0a318cda63..0000000000 --- a/reference/swoole/swoole/server/addprocess.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::addProcess - Ajoute un swoole_process défini par l'utilisateur au serveur. - - - - &reftitle.description; - - public boolSwoole\Server::addProcess - swoole_processprocess - - - - - - - - - &reftitle.parameters; - - - process - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/after.xml b/reference/swoole/swoole/server/after.xml deleted file mode 100644 index 50278d348e..0000000000 --- a/reference/swoole/swoole/server/after.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Server::after - Déclenche une fonction de rappel après une période de temps. - - - - &reftitle.description; - - public ReturnTypeSwoole\Server::after - intafter_time_ms - callablecallback - stringparam - - - - - - - - - &reftitle.parameters; - - - after_time_ms - - - - - - - - callback - - - - - - - - param - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/bind.xml b/reference/swoole/swoole/server/bind.xml deleted file mode 100644 index 3dcf1e83fc..0000000000 --- a/reference/swoole/swoole/server/bind.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::bind - Lie la connexion à un identifiant d'utilisateur défini par l'utilisateur. - - - - &reftitle.description; - - public boolSwoole\Server::bind - intfd - intuid - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - uid - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/cleartimer.xml b/reference/swoole/swoole/server/cleartimer.xml deleted file mode 100644 index d63f637573..0000000000 --- a/reference/swoole/swoole/server/cleartimer.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::clearTimer - swoole_timer_clear - Détruit et arrête un minuteur. - - - - &reftitle.description; - &style.oop; (méthode): - - public voidSwoole\Server::clearTimer - inttimer_id - - &style.procedural;: - - voidswoole_timer_clear - inttimer_id - - - Arrête et détruit un minuteur - - - - - - &reftitle.parameters; - - - - timer_id - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/close.xml b/reference/swoole/swoole/server/close.xml deleted file mode 100644 index d94a740d9b..0000000000 --- a/reference/swoole/swoole/server/close.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::close - Ferme une connexion avec le client. - - - - &reftitle.description; - - public boolSwoole\Server::close - intfd - boolreset - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - reset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/confirm.xml b/reference/swoole/swoole/server/confirm.xml deleted file mode 100644 index aa9c06486d..0000000000 --- a/reference/swoole/swoole/server/confirm.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::confirm - Vérifie l'état de la connexion. - - - - &reftitle.description; - - public boolSwoole\Server::confirm - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/connection-info.xml b/reference/swoole/swoole/server/connection-info.xml deleted file mode 100644 index 5af0422389..0000000000 --- a/reference/swoole/swoole/server/connection-info.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::connection_info - Renvoie les informations de connexion par la description du fichier. - - - - &reftitle.description; - - public arraySwoole\Server::connection_info - intfd - intreactor_id - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - reactor_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/connection-list.xml b/reference/swoole/swoole/server/connection-list.xml deleted file mode 100644 index c3a97dd092..0000000000 --- a/reference/swoole/swoole/server/connection-list.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::connection_list - Renvoie toutes les connexions établies. - - - - &reftitle.description; - - public arraySwoole\Server::connection_list - intstart_fd - intpagesize - - - - - - - - - &reftitle.parameters; - - - start_fd - - - - - - - - pagesize - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/construct.xml b/reference/swoole/swoole/server/construct.xml deleted file mode 100644 index 88e3058ebe..0000000000 --- a/reference/swoole/swoole/server/construct.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Swoole\Server::__construct - Construit un serveur Swoole. - - - - &reftitle.description; - - public Swoole\Server::__construct - stringhost - intport - intmode - intsock_type - - - - - - - - - &reftitle.parameters; - - - host - - - - - - - - port - - - - - - - - mode - - - - - - - - sock_type - - - - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/server/defer.xml b/reference/swoole/swoole/server/defer.xml deleted file mode 100644 index b7889bb936..0000000000 --- a/reference/swoole/swoole/server/defer.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::defer - Décale l'exécution de la fonction de rappel à la fin de la boucle d'événements actuelle. - - - - &reftitle.description; - - public voidSwoole\Server::defer - callablecallback - - - - - - - - - &reftitle.parameters; - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/exist.xml b/reference/swoole/swoole/server/exist.xml deleted file mode 100644 index 57b39c9f06..0000000000 --- a/reference/swoole/swoole/server/exist.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::exist - Vérifie si la connexion existe. - - - - &reftitle.description; - - public boolSwoole\Server::exist - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/finish.xml b/reference/swoole/swoole/server/finish.xml deleted file mode 100644 index 46c6fde9a5..0000000000 --- a/reference/swoole/swoole/server/finish.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::finish - Utilisé dans le processus de tâche pour envoyer le résultat au processus de travail lorsque la tâche est terminée. - - - - &reftitle.description; - - public voidSwoole\Server::finish - stringdata - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/getclientinfo.xml b/reference/swoole/swoole/server/getclientinfo.xml deleted file mode 100644 index f2cf35d694..0000000000 --- a/reference/swoole/swoole/server/getclientinfo.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Server::getClientInfo - Renvoie les informations de connexion par la description du fichier. - - - - &reftitle.description; - - public arraySwoole\Server::getClientInfo - intfd - intreactor_id - boolignore_error - - - - - - - - - &reftitle.parameters; - - - fd - - - Les descripteurs de fichiers. - - - - - reactor_id - - - L'identifiant du thread Reactor où la connexion est établie. - - - - - ignore_error - - - Ignorer les erreurs ou non, si défini sur true, - les informations de connexion seront renvoyées même si la connexion est fermée. - - - - - - - - &reftitle.returnvalues; - - Renvoie les informations sur la connexion client. - - - - - - - diff --git a/reference/swoole/swoole/server/getclientlist.xml b/reference/swoole/swoole/server/getclientlist.xml deleted file mode 100644 index 86cba6575e..0000000000 --- a/reference/swoole/swoole/server/getclientlist.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Server::getClientList - Renvoie toutes les connexions établies. - - - - &reftitle.description; - - public arraySwoole\Server::getClientList - intstart_fd - intpagesize - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - start_fd - - - - - - - - pagesize - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/getlasterror.xml b/reference/swoole/swoole/server/getlasterror.xml deleted file mode 100644 index ae4e35b057..0000000000 --- a/reference/swoole/swoole/server/getlasterror.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Server::getLastError - Renvoie le code d'erreur de la dernière erreur. - - - - &reftitle.description; - - public intSwoole\Server::getLastError - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/heartbeat.xml b/reference/swoole/swoole/server/heartbeat.xml deleted file mode 100644 index 6314011938..0000000000 --- a/reference/swoole/swoole/server/heartbeat.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::heartbeat - Vérifie toutes les connexions sur le serveur. - - - - &reftitle.description; - - public mixedSwoole\Server::heartbeat - boolif_close_connection - - - - - - - - - &reftitle.parameters; - - - if_close_connection - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/listen.xml b/reference/swoole/swoole/server/listen.xml deleted file mode 100644 index 5581cdef00..0000000000 --- a/reference/swoole/swoole/server/listen.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Server::listen - Ecoute sur l'IP et le port donnés, type de socket. - - - - &reftitle.description; - - public boolSwoole\Server::listen - stringhost - intport - stringsocket_type - - - - - - - - - &reftitle.parameters; - - - host - - - - - - - - port - - - - - - - - socket_type - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/on.xml b/reference/swoole/swoole/server/on.xml deleted file mode 100644 index cd6324afdf..0000000000 --- a/reference/swoole/swoole/server/on.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::on - Enregistre une fonction de rappel par nom d'événement. - - - - &reftitle.description; - - public voidSwoole\Server::on - stringevent_name - callablecallback - - - - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/pause.xml b/reference/swoole/swoole/server/pause.xml deleted file mode 100644 index 194aec4a48..0000000000 --- a/reference/swoole/swoole/server/pause.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::pause - Arrête de recevoir des données de la connexion. - - - - &reftitle.description; - - public voidSwoole\Server::pause - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/port/construct.xml b/reference/swoole/swoole/server/port/construct.xml deleted file mode 100644 index d441dce52a..0000000000 --- a/reference/swoole/swoole/server/port/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Swoole\Server\Port::__construct - Construit un port de serveur - - - - &reftitle.description; - - private Swoole\Server\Port::__construct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - - diff --git a/reference/swoole/swoole/server/port/destruct.xml b/reference/swoole/swoole/server/port/destruct.xml deleted file mode 100644 index de0a5edbbc..0000000000 --- a/reference/swoole/swoole/server/port/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Server\Port::__destruct - Détruit le port du serveur - - - - &reftitle.description; - - public voidSwoole\Server\Port::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/port/on.xml b/reference/swoole/swoole/server/port/on.xml deleted file mode 100644 index 0b580095b6..0000000000 --- a/reference/swoole/swoole/server/port/on.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server\Port::on - Enregistre une fonction de rappel par nom d'événement. - - - - &reftitle.description; - - public ReturnTypeSwoole\Server\Port::on - stringevent_name - callablecallback - - - - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/port/set.xml b/reference/swoole/swoole/server/port/set.xml deleted file mode 100644 index 11da1d3aa1..0000000000 --- a/reference/swoole/swoole/server/port/set.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server\Port::set - Définit le protocole du port du serveur. - - - - &reftitle.description; - - public voidSwoole\Server\Port::set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/protect.xml b/reference/swoole/swoole/server/protect.xml deleted file mode 100644 index b67a254069..0000000000 --- a/reference/swoole/swoole/server/protect.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::protect - Met la connexion en mode protégé. - - - - &reftitle.description; - - public voidSwoole\Server::protect - intfd - boolis_protected - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - is_protected - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/reload.xml b/reference/swoole/swoole/server/reload.xml deleted file mode 100644 index 411bd1231c..0000000000 --- a/reference/swoole/swoole/server/reload.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Server::reload - Relance tous les processus de travail. - - - - &reftitle.description; - - public boolSwoole\Server::reload - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/resume.xml b/reference/swoole/swoole/server/resume.xml deleted file mode 100644 index 8da522b629..0000000000 --- a/reference/swoole/swoole/server/resume.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::resume - Lance la réception de données depuis la connexion. - - - - &reftitle.description; - - public voidSwoole\Server::resume - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/send.xml b/reference/swoole/swoole/server/send.xml deleted file mode 100644 index 5beb3da3bf..0000000000 --- a/reference/swoole/swoole/server/send.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Swoole\Server::send - Envoie des données au client. - - - - &reftitle.description; - - public boolSwoole\Server::send - intfd - stringdata - intreactor_id - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fd - - - - - - - - data - - - - - - - - reactor_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/sendfile.xml b/reference/swoole/swoole/server/sendfile.xml deleted file mode 100644 index 62435a5fa5..0000000000 --- a/reference/swoole/swoole/server/sendfile.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Swoole\Server::sendfile - Envoie un fichier à la connexion. - - - - &reftitle.description; - - public boolSwoole\Server::sendfile - intfd - stringfilename - intoffset - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fd - - - - - - - - filename - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/sendmessage.xml b/reference/swoole/swoole/server/sendmessage.xml deleted file mode 100644 index 8d16030eca..0000000000 --- a/reference/swoole/swoole/server/sendmessage.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::sendMessage - Envoie un message aux processus de travail par ID. - - - - &reftitle.description; - - public boolSwoole\Server::sendMessage - intworker_id - stringdata - - - - - - - - - &reftitle.parameters; - - - dst_worker_id - - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/sendto.xml b/reference/swoole/swoole/server/sendto.xml deleted file mode 100644 index f1c8e81c9a..0000000000 --- a/reference/swoole/swoole/server/sendto.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Swoole\Server::sendto - Envoie des données à l'adresse UDP distante. - - - - &reftitle.description; - - public boolSwoole\Server::sendto - stringip - intport - stringdata - stringserver_socket - - - - - - - - - &reftitle.parameters; - - - ip - - - - - - - - port - - - - - - - - data - - - - - - - - server_socket - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/sendwait.xml b/reference/swoole/swoole/server/sendwait.xml deleted file mode 100644 index bd33d5c0a5..0000000000 --- a/reference/swoole/swoole/server/sendwait.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Server::sendwait - Envoie des données au socket distant de manière bloquante. - - - - &reftitle.description; - - public boolSwoole\Server::sendwait - intfd - stringdata - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fd - - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/set.xml b/reference/swoole/swoole/server/set.xml deleted file mode 100644 index 7bd4f12f80..0000000000 --- a/reference/swoole/swoole/server/set.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::set - Définit les paramètres d'exécution du serveur swoole. - - - - &reftitle.description; - - public ReturnTypeSwoole\Server::set - arraysettings - - - Définit les paramètres d'exécution du serveur swoole. Les paramètres peuvent être accédés par $server->setting lorsque le serveur swoole a démarré. - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/shutdown.xml b/reference/swoole/swoole/server/shutdown.xml deleted file mode 100644 index 31b3683264..0000000000 --- a/reference/swoole/swoole/server/shutdown.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Server::shutdown - Arrête le processus du serveur maître, cette fonction peut être appelée dans les processus de travail. - - - - &reftitle.description; - - public voidSwoole\Server::shutdown - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/start.xml b/reference/swoole/swoole/server/start.xml deleted file mode 100644 index 9edc8afdb0..0000000000 --- a/reference/swoole/swoole/server/start.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Server::start - Démarre le serveur Swoole. - - - - &reftitle.description; - - public voidSwoole\Server::start - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/stats.xml b/reference/swoole/swoole/server/stats.xml deleted file mode 100644 index fb15295679..0000000000 --- a/reference/swoole/swoole/server/stats.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Server::stats - Renvoie les statistiques du serveur Swoole. - - - - &reftitle.description; - - public arraySwoole\Server::stats - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/stop.xml b/reference/swoole/swoole/server/stop.xml deleted file mode 100644 index 76c8832d32..0000000000 --- a/reference/swoole/swoole/server/stop.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::stop - Arrête le serveur Swoole. - - - - &reftitle.description; - - public boolSwoole\Server::stop - intworker_id - - - - - - - - - &reftitle.parameters; - - - worker_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/task.xml b/reference/swoole/swoole/server/task.xml deleted file mode 100644 index 8b6ff16443..0000000000 --- a/reference/swoole/swoole/server/task.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Swoole\Server::task - Envoie des données aux processus de travail de tâche. - - - - &reftitle.description; - - public mixedSwoole\Server::task - stringdata - intdst_worker_id - callablecallback - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - data - - - - - - - - dst_worker_id - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/taskwait.xml b/reference/swoole/swoole/server/taskwait.xml deleted file mode 100644 index fa41b1cf0c..0000000000 --- a/reference/swoole/swoole/server/taskwait.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Swoole\Server::taskwait - Envoie des données aux processus de travail de tâche de manière bloquante. - - - - &reftitle.description; - - public voidSwoole\Server::taskwait - stringdata - floattimeout - intworker_id - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - data - - - - - - - - timeout - - - - - - - - worker_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/taskwaitmulti.xml b/reference/swoole/swoole/server/taskwaitmulti.xml deleted file mode 100644 index 9a7958d540..0000000000 --- a/reference/swoole/swoole/server/taskwaitmulti.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::taskWaitMulti - Exécute plusieurs tâches en parallèle. - - - - &reftitle.description; - - public voidSwoole\Server::taskWaitMulti - arraytasks - floattimeout_ms - - - - - - - - - &reftitle.parameters; - - - tasks - - - - - - - - timeout_ms - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/tick.xml b/reference/swoole/swoole/server/tick.xml deleted file mode 100644 index 6b12a1cd66..0000000000 --- a/reference/swoole/swoole/server/tick.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::tick - Répète une fonction donnée à chaque intervalle de temps donné. - - - - &reftitle.description; - - public voidSwoole\Server::tick - intinterval_ms - callablecallback - - - - - - - - - &reftitle.parameters; - - - interval_ms - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/column.xml b/reference/swoole/swoole/table/column.xml deleted file mode 100644 index 8a49860ddb..0000000000 --- a/reference/swoole/swoole/table/column.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Table::column - Définit le type de données et la taille des colonnes. - - - - &reftitle.description; - - public boolSwoole\Table::column - stringname - stringtype - intsize - - - - - - - - - &reftitle.parameters; - - - name - - - Spécifie le nom du champ. - - - - - - type - - - Spécifie le type du champ - - - - - size - - - Spécifie la taille du champ. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/construct.xml b/reference/swoole/swoole/table/construct.xml deleted file mode 100644 index e2ec7691a8..0000000000 --- a/reference/swoole/swoole/table/construct.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Swoole\Table::__construct - Construit une table de mémoire Swoole de taille fixe. - - - - &reftitle.description; - - public Swoole\Table::__construct - inttable_size - - - - - - - - - &reftitle.parameters; - - - table_size - - - - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/table/count.xml b/reference/swoole/swoole/table/count.xml deleted file mode 100644 index 4fe1e167b1..0000000000 --- a/reference/swoole/swoole/table/count.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::count - Compte les lignes dans la table, ou compte tous les éléments dans la table si $mode = 1. - - - - &reftitle.description; - - public intSwoole\Table::count - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/create.xml b/reference/swoole/swoole/table/create.xml deleted file mode 100644 index 8a3f415b1a..0000000000 --- a/reference/swoole/swoole/table/create.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::create - Créer la table de mémoire swoole. - - - - &reftitle.description; - - public boolSwoole\Table::create - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/current.xml b/reference/swoole/swoole/table/current.xml deleted file mode 100644 index 7231f828ba..0000000000 --- a/reference/swoole/swoole/table/current.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::current - Renvoie la ligne actuelle. - - - - &reftitle.description; - - public arraySwoole\Table::current - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/decr.xml b/reference/swoole/swoole/table/decr.xml deleted file mode 100644 index 9c03c8b12f..0000000000 --- a/reference/swoole/swoole/table/decr.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Table::decr - Décrémente la valeur dans la table Swoole par $key et $column. - - - - &reftitle.description; - - public intSwoole\Table::decr - stringkey - stringcolumn - intdecrby - - - - - - - - - &reftitle.parameters; - - - key - - - La clé de la donnée. - - - - - column - - - Spécifie le nom de la colonne. - - - - - decrby - - - La valeur de décrémentation. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/del.xml b/reference/swoole/swoole/table/del.xml deleted file mode 100644 index 3b9013d918..0000000000 --- a/reference/swoole/swoole/table/del.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Table::del - Supprime une ligne dans la table Swoole par $key. - - - - &reftitle.description; - - public boolSwoole\Table::del - stringkey - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/destroy.xml b/reference/swoole/swoole/table/destroy.xml deleted file mode 100644 index 04fa40506d..0000000000 --- a/reference/swoole/swoole/table/destroy.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::destroy - Détruit la table Swoole. - - - - &reftitle.description; - - public boolSwoole\Table::destroy - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/exist.xml b/reference/swoole/swoole/table/exist.xml deleted file mode 100644 index 9d601fac2f..0000000000 --- a/reference/swoole/swoole/table/exist.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Table::exist - Vérifie si une ligne existe par $row_key. - - - - &reftitle.description; - - public boolSwoole\Table::exist - stringkey - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/get.xml b/reference/swoole/swoole/table/get.xml deleted file mode 100644 index 29069b4b81..0000000000 --- a/reference/swoole/swoole/table/get.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Table::get - Renvoie la valeur dans la table Swoole par $key et $field. - - - - &reftitle.description; - - public mixedSwoole\Table::get - stringkey - stringfield - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - field - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/incr.xml b/reference/swoole/swoole/table/incr.xml deleted file mode 100644 index fcec4df011..0000000000 --- a/reference/swoole/swoole/table/incr.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Table::incr - Incrémente la valeur Swoole par $key et $column. - - - - &reftitle.description; - - public intSwoole\Table::incr - stringkey - stringcolumn - intincrby - - - - - - - - - &reftitle.parameters; - - - key - - - La clé pour la donnée. - - - - - column - - - Spécifie le nom de la colonne. - - - - - incrby - - - Valeur d'incrémentation. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/key.xml b/reference/swoole/swoole/table/key.xml deleted file mode 100644 index bd5ac660b0..0000000000 --- a/reference/swoole/swoole/table/key.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::key - Renvoie la clé de la ligne actuelle. - - - - &reftitle.description; - - public mixedSwoole\Table::key - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/next.xml b/reference/swoole/swoole/table/next.xml deleted file mode 100644 index 39d71e6060..0000000000 --- a/reference/swoole/swoole/table/next.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::next - Avance l'itérateur sur la prochaine ligne - - - - &reftitle.description; - - public voidSwoole\Table::next - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/rewind.xml b/reference/swoole/swoole/table/rewind.xml deleted file mode 100644 index a401b5d7c4..0000000000 --- a/reference/swoole/swoole/table/rewind.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::rewind - Ré-initialise l'itérateur. - - - - &reftitle.description; - - public voidSwoole\Table::rewind - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/set.xml b/reference/swoole/swoole/table/set.xml deleted file mode 100644 index 3df183834b..0000000000 --- a/reference/swoole/swoole/table/set.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Table::set - Met à jour une ligne de la table par $key. - - - - &reftitle.description; - - public boolSwoole\Table::set - stringkey - arrayvalue - - - - - - - - - &reftitle.parameters; - - - key - - - La clé de la donnée. - - - - - value - - - La valeur de la donnée. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/valid.xml b/reference/swoole/swoole/table/valid.xml deleted file mode 100644 index 1ef06e7650..0000000000 --- a/reference/swoole/swoole/table/valid.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::valid - Vérifie si la ligne actuelle est valide. - - - - &reftitle.description; - - public boolSwoole\Table::valid - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/timer/after.xml b/reference/swoole/swoole/timer/after.xml deleted file mode 100644 index cf475c061c..0000000000 --- a/reference/swoole/swoole/timer/after.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Swoole\Timer::after - Exécute une fonction après un temps donné - - - - &reftitle.description; - - public static intfalseSwoole\Timer::after - intms - callablecallback - mixedparams - - - Crée un minuteur à usage unique, détruit dès que sa fonction de rappel a été - exécutée. Contrairement à sleep, il ne bloque pas le - processus courant. - - - - - &reftitle.parameters; - - - ms - - - Le délai, en millisecondes. Doit être supérieur ou égal à - 1 ; une valeur inférieure émet une - E_WARNING et l'appel échoue. - - - - - callback - - - La fonction à exécuter une fois le délai écoulé. Elle est appelée sous la - forme callback(mixed ...$params). Contrairement à - Swoole\Timer::tick, l'identifiant du minuteur - n'est pas transmis à la fonction de rappel. - - - - - params - - - Valeurs supplémentaires transmises à callback. - - - - - - - - &reftitle.returnvalues; - - Retourne l'identifiant du minuteur, qui peut être transmis à - Swoole\Timer::clear pour annuler le minuteur avant - son déclenchement. Retourne &false; si le minuteur n'a pas pu être créé, en - particulier lorsque ms est inférieur à - 1. - - - - - &reftitle.examples; - - Exemple avec <function>Swoole\Timer::after</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/swoole/swoole/timer/clear.xml b/reference/swoole/swoole/timer/clear.xml deleted file mode 100644 index 23ee45fc2b..0000000000 --- a/reference/swoole/swoole/timer/clear.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Swoole\Timer::clear - Supprime un minuteur par son identifiant - - - - &reftitle.description; - - public static boolSwoole\Timer::clear - inttimer_id - - - Supprime le minuteur portant l'identifiant donné. Seuls les minuteurs créés - par le processus courant peuvent être supprimés ; ceux qui appartiennent à - d'autres processus ne sont pas visibles ici. - - - - - &reftitle.parameters; - - - timer_id - - - L'identifiant de minuteur retourné par - Swoole\Timer::tick ou - Swoole\Timer::after. - - - - - - - - &reftitle.returnvalues; - - &return.success; - &false; est retourné lorsqu'aucun minuteur ne porte cet identifiant dans le - processus courant, ou lorsque l'identifiant désigne un minuteur interne. - - - - - &reftitle.examples; - - Exemple avec <function>Swoole\Timer::clear</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/swoole/swoole/timer/clearAll.xml b/reference/swoole/swoole/timer/clearAll.xml deleted file mode 100644 index e7ee7f0074..0000000000 --- a/reference/swoole/swoole/timer/clearAll.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - Swoole\Timer::clearAll - Supprime tous les minuteurs du processus courant - - - - &reftitle.description; - - public static boolSwoole\Timer::clearAll - - - - Supprime tous les minuteurs du processus courant. À partir de Swoole 4.4.0. - - - - - &reftitle.returnvalues; - - &return.success; - &false; est retourné lorsqu'aucun minuteur n'a encore été créé dans ce - processus. Seuls les minuteurs créés depuis PHP sont supprimés ; les - minuteurs internes sont laissés en place. - - - - - diff --git a/reference/swoole/swoole/timer/exists.xml b/reference/swoole/swoole/timer/exists.xml deleted file mode 100644 index 68eb017ca0..0000000000 --- a/reference/swoole/swoole/timer/exists.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - Swoole\Timer::exists - Vérifie si un minuteur existe - - - - &reftitle.description; - - public static boolSwoole\Timer::exists - inttimer_id - - - Vérifie si un minuteur portant l'identifiant donné existe dans le processus - courant. - - - - - - &reftitle.parameters; - - - timer_id - - - L'identifiant de minuteur retourné par - Swoole\Timer::tick ou - Swoole\Timer::after. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si un minuteur portant cet identifiant existe dans le - processus courant, &false; sinon. - - - - - - - diff --git a/reference/swoole/swoole/timer/info.xml b/reference/swoole/swoole/timer/info.xml deleted file mode 100644 index fb5f6a12a0..0000000000 --- a/reference/swoole/swoole/timer/info.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - Swoole\Timer::info - Retourne les informations d'un minuteur - - - - &reftitle.description; - - public static arraynullSwoole\Timer::info - inttimer_id - - - Retourne les informations d'un minuteur. À partir de Swoole 4.4.0. - - - - - &reftitle.parameters; - - - timer_id - - - L'identifiant de minuteur retourné par - Swoole\Timer::tick ou - Swoole\Timer::after. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau décrivant le minuteur, ou &null; si aucun minuteur ne - porte cet identifiant dans le processus courant. Le tableau contient les - clés suivantes : - - - - exec_msec - - - L'instant de la prochaine exécution, en millisecondes, compté depuis le - démarrage du sous-système de minuteurs. Ce n'est pas une durée. - - - - - exec_count - - - Le nombre de fois où la fonction de rappel a été exécutée. - Disponible à partir de Swoole 4.8.0. - - - - - interval - - - L'intervalle du minuteur, en millisecondes. - - - - - round - - - Le numéro du tour de la boucle de minuteurs durant lequel le minuteur a - été créé. - - - - - removed - - - Indique si le minuteur a été supprimé. - - - - - - - - &reftitle.examples; - - Exemple avec <function>Swoole\Timer::info</function> - - -]]> - - &example.outputs.similar; - - - int(1000) - ["exec_count"]=> - int(0) - ["interval"]=> - int(1000) - ["round"]=> - int(0) - ["removed"]=> - bool(false) -} -]]> - - - - - - diff --git a/reference/swoole/swoole/timer/list.xml b/reference/swoole/swoole/timer/list.xml deleted file mode 100644 index 249a6ad571..0000000000 --- a/reference/swoole/swoole/timer/list.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Swoole\Timer::list - Retourne un itérateur sur les minuteurs du processus courant - - - - &reftitle.description; - - public static Swoole\Timer\IteratorSwoole\Timer::list - - - - Retourne un itérateur sur les identifiants des minuteurs créés depuis PHP - dans le processus courant. Les minuteurs créés en interne par Swoole n'y - figurent pas. À partir de Swoole 4.4.0. - - - - - &reftitle.returnvalues; - - Retourne un objet Swoole\Timer\Iterator, qui étend - ArrayIterator et fournit les identifiants de minuteur - sous forme de valeurs int. L'itérateur est un instantané pris - au moment de l'appel ; il est vide lorsqu'aucun minuteur n'existe. - - - - - &reftitle.examples; - - Exemple avec <function>Swoole\Timer::list</function> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/swoole/swoole/timer/set.xml b/reference/swoole/swoole/timer/set.xml deleted file mode 100644 index 7d24a63d9c..0000000000 --- a/reference/swoole/swoole/timer/set.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Swoole\Timer::set - Définit les paramètres liés aux minuteurs - - - - &reftitle.description; - - public static voidSwoole\Timer::set - arraysettings - - - Définit les options utilisées par les minuteurs du processus courant. - - - - - Cette méthode a été dépréciée en Swoole 4.6.0 et supprimée en Swoole 6.0.0. - Utiliser swoole_async_set à la place. - - - - - - &reftitle.parameters; - - - settings - - - Un tableau associatif d'options. Seule enable_coroutine - est reconnue : lorsqu'elle vaut &false;, les fonctions de rappel des - minuteurs sont exécutées directement, et non dans une coroutine - nouvellement créée. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/swoole/timer/stats.xml b/reference/swoole/swoole/timer/stats.xml deleted file mode 100644 index 5ac5f8bff2..0000000000 --- a/reference/swoole/swoole/timer/stats.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Swoole\Timer::stats - Retourne les statistiques des minuteurs - - - - &reftitle.description; - - public static arraySwoole\Timer::stats - - - - Retourne les statistiques des minuteurs. À partir de Swoole 4.4.0. - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les clés suivantes : - - - - initialized - - - Indique si le sous-système de minuteurs a été démarré. Vaut &false; tant - que le premier minuteur n'a pas été créé. - - - - - num - - - Le nombre de minuteurs actuellement enregistrés dans le processus. - - - - - round - - - Le tour courant de la boucle de minuteurs. - - - - - - - - &reftitle.examples; - - Exemple avec <function>Swoole\Timer::stats</function> - - -]]> - - &example.outputs.similar; - - - bool(true) - ["num"]=> - int(1) - ["round"]=> - int(0) -} -]]> - - - - - - diff --git a/reference/swoole/swoole/timer/tick.xml b/reference/swoole/swoole/timer/tick.xml deleted file mode 100644 index d90454d996..0000000000 --- a/reference/swoole/swoole/timer/tick.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Swoole\Timer::tick - Définit un minuteur répétitif - - - - &reftitle.description; - - public static intfalseSwoole\Timer::tick - intms - callablecallback - mixedparams - - - Définit un minuteur qui se déclenche toutes les ms - millisecondes. Contrairement à un minuteur créé avec - Swoole\Timer::after, il continue de se déclencher - jusqu'à sa suppression avec Swoole\Timer::clear. - - - - - &reftitle.parameters; - - - ms - - - L'intervalle, en millisecondes. Doit être supérieur ou égal à - 1 ; une valeur inférieure émet une - E_WARNING et l'appel échoue. - - - - - callback - - - La fonction à exécuter à chaque déclenchement. Elle est appelée sous la - forme callback(int $timer_id, mixed ...$params) : - l'identifiant du minuteur est transmis comme premier argument, suivi des - valeurs données dans params. - - - - - params - - - Valeurs supplémentaires transmises à callback - après l'identifiant du minuteur. - - - - - - - - &reftitle.returnvalues; - - Retourne l'identifiant du minuteur, qui peut être transmis à - Swoole\Timer::clear. Retourne &false; si le minuteur - n'a pas pu être créé, en particulier lorsque ms est - inférieur à 1. - - - - - &reftitle.examples; - - Exemple avec <function>Swoole\Timer::tick</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/exist.xml b/reference/swoole/swoole/websocket/server/exist.xml deleted file mode 100644 index 5981ac34e7..0000000000 --- a/reference/swoole/swoole/websocket/server/exist.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\WebSocket\Server::exist - Vérifie si le descripteur de fichier existe. - - - - &reftitle.description; - - public boolSwoole\WebSocket\Server::exist - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/on.xml b/reference/swoole/swoole/websocket/server/on.xml deleted file mode 100644 index 16489baf2d..0000000000 --- a/reference/swoole/swoole/websocket/server/on.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\WebSocket\Server::on - Enregistre la fonction de rappel de l'événement - - - - &reftitle.description; - - public ReturnTypeSwoole\WebSocket\Server::on - stringevent_name - callablecallback - - - Enregistre la fonction de rappel de l'événement - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/pack.xml b/reference/swoole/swoole/websocket/server/pack.xml deleted file mode 100644 index ef84ba7787..0000000000 --- a/reference/swoole/swoole/websocket/server/pack.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Swoole\WebSocket\Server::pack - Renvoie un paquet de données binaires à envoyer dans une seule trame. - - - - &reftitle.description; - - public static binarySwoole\WebSocket\Server::pack - stringdata - stringopcode - stringfinish - stringmask - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - opcode - - - - - - - - finish - - - - - - - - mask - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/push.xml b/reference/swoole/swoole/websocket/server/push.xml deleted file mode 100644 index 62d7ee3667..0000000000 --- a/reference/swoole/swoole/websocket/server/push.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Swoole\WebSocket\Server::push - Pousse les données vers le client distant. - - - - &reftitle.description; - - public voidSwoole\WebSocket\Server::push - stringfd - stringdata - stringopcode - stringfinish - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - data - - - - - - - - opcode - - - - - - - - finish - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/unpack.xml b/reference/swoole/swoole/websocket/server/unpack.xml deleted file mode 100644 index 09b6b2dccc..0000000000 --- a/reference/swoole/swoole/websocket/server/unpack.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\WebSocket\Server::unpack - Décompresse les données binaires reçues du client. - - - - &reftitle.description; - - public static stringSwoole\WebSocket\Server::unpack - binarydata - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/sync/book.xml b/reference/sync/book.xml deleted file mode 100644 index cfb5f52b8a..0000000000 --- a/reference/sync/book.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - Sync - Sync - - - &reftitle.intro; - - L'extension sync introduit la synchronisation d'objets cross-plateforme en PHP. - Les Mutex nommés ou non, les sémaphores, les événements, les objets de - lecture-écriture et la mémoire partagée profiteront d'une synchronisation au niveau de l'OS autant sur - les systèmes POSIX (c.-à-d. Linux) et sur les systèmes Windows. - - - Un nettoyage automatique des objets ayant obtenu une synchronisation - a lieu lors du démontage de l'extension. Cela signifie que si PHP termine prématurément - un script (c.-à-d. le script dépasse sa durée maximale d'exécution), les objets - ne seront pas laissés dans un état inconnu. La seule exception à ce mécanisme - est si PHP lui-même crash (c.-à-d. un dépassement de buffer interne). - - - La synchronisation des objets non nommés n'a pas d'utilité en dehors d'un - scénario multithreadé. Les objets non nommés sont plus utiles en conjonction - de l'extension PECL pthreads. - - - - Les objets nommés requièrent une attention supplémentaire pour être utilisés - sur tous les systèmes. Si un objet est instancié avec un jeu spécifique de - paramètres, il doit toujours être instancié avec ces paramètres ou l'objet - se terminera probablement dans un statut incohérent jusqu'au prochain - redémarrage ou jusqu'à ce qu'un administrateur ne les nettoie. - - - - - &reference.sync.setup; - &reference.sync.syncmutex; - &reference.sync.syncsemaphore; - &reference.sync.syncevent; - &reference.sync.syncreaderwriter; - &reference.sync.syncsharedmemory; - - - diff --git a/reference/sync/configure.xml b/reference/sync/configure.xml deleted file mode 100644 index c452614e77..0000000000 --- a/reference/sync/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;sync - - - -
    - diff --git a/reference/sync/setup.xml b/reference/sync/setup.xml deleted file mode 100644 index 76ba2a52ae..0000000000 --- a/reference/sync/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Un système avec le support POSIX de la mémoire - partagée (shm_open()) ou fonctionnant sous Windows. - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;sync. - -
    - -     - diff --git a/reference/sync/syncevent.xml b/reference/sync/syncevent.xml deleted file mode 100644 index f5967ba346..0000000000 --- a/reference/sync/syncevent.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - La classe SyncEvent - SyncEvent - - - - -
    - &reftitle.intro; - - Une implémentation cross-plateforme, native des objets d'événements nommés ou non. - Les objets d'événements à la fois automatiques et manuels sont supportés. - - - Un objet d'événement attend, sans mise en file, que les objets soient - lancés/définis. Une instance attend sur l'objet d'événement tandis qu'une - autre lance/définit l'événement. Les objets d'événements sont utiles - tout au long d'un processus long (c.-à-d. vérifier pour voir si un téléchargement - de données doit être analysé). - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncEvent - - - - - SyncEvent - - - - - &Methods; - - - - -
    - -     - - &reference.sync.entities.syncevent; - -     - diff --git a/reference/sync/syncevent/construct.xml b/reference/sync/syncevent/construct.xml deleted file mode 100644 index 3f05fcac1c..0000000000 --- a/reference/sync/syncevent/construct.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - SyncEvent::__construct - Construit un nouvel objet SyncEvent - - - - &reftitle.description; - - public SyncEvent::__construct - stringname - boolmanual&false; - boolprefire&false; - - - Construit un objet d'événement nommé ou non. - - - - - &reftitle.parameters; - - - name - - - Le nom de l'événement si c'est un objet d'événement nommé. - - - - Si le nom existe déjà, on doit être capable de l'ouvrir avec l'utilisateur - courant qui exécute le processus, ou une exception sera émise - avec le contenu du message d'erreur. - - - - - - manual - - - Spécifie si l'objet d'événement doit être ou non réinitialisé manuellement. - - - - La réinitialisation manuelle des objets d'événements permet la - mise en attente des processus tant que l'objet n'est pas réinitialisé. - - - - - - prefire - - - Spécifie s'il faut ou non pré-envoyer (le signal) - à l'objet event. - - - - N'a d'impact que si l'appel au processus/thread - est le premier à créer l'objet. - - - - - - - - - &reftitle.returnvalues; - - Le nouvel objet SyncEvent. - - - - - &reftitle.errors; - - Une exception est lancée si l'objet d'événement - ne peut être créé ou ouvert. - - - - - &reftitle.examples; - - Exemple avec <function>SyncEvent::__construct</function> - -fire(); - -// Dans un cron : -$event = new SyncEvent("GetAppReport"); -$event->wait(); -?> -]]> - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL sync 1.1.0 - - - Ajout du paramètre prefire. - - - - - - - - - - &reftitle.seealso; - - SyncEvent::fire - SyncEvent::reset - SyncEvent::wait - - - - - diff --git a/reference/sync/syncevent/fire.xml b/reference/sync/syncevent/fire.xml deleted file mode 100644 index a7e66ae552..0000000000 --- a/reference/sync/syncevent/fire.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - SyncEvent::fire - Lance/définit l'événement - - - - &reftitle.description; - - public boolSyncEvent::fire - - - - Lance/définit un objet SyncEvent. Laisse passer plusieurs threads en attente - si l'objet d'événement a été créé avec une valeur manuelle à &true;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>SyncEvent::fire</function> - -fire(); - -// Dans un cron : -$event = new SyncEvent("GetAppReport"); -$event->wait(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncEvent::reset - SyncEvent::wait - - - - - diff --git a/reference/sync/syncevent/reset.xml b/reference/sync/syncevent/reset.xml deleted file mode 100644 index 056907bbb6..0000000000 --- a/reference/sync/syncevent/reset.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - SyncEvent::reset - Réinitialise manuellement un événement - - - - &reftitle.description; - - public boolSyncEvent::reset - - - - Réinitialise un objet SyncEvent qui a été lancé/défini. Seulement valide pour - les objets d'événement manuels. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>SyncEvent::reset</function> - -wait(); - -// Dans un cron : -$event = new SyncEvent("DemoApplication", true); -$event->reset(); -/* ... Effectuer quelques tâches de maintenance ... */ -$event->fire(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncEvent::fire - SyncEvent::reset - SyncEvent::wait - - - - - diff --git a/reference/sync/syncevent/wait.xml b/reference/sync/syncevent/wait.xml deleted file mode 100644 index 33d13de95d..0000000000 --- a/reference/sync/syncevent/wait.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - SyncEvent::wait - Attend que l'objet SyncEvent ne soit lancé - - - - &reftitle.description; - - public boolSyncEvent::wait - intwait-1 - - - Attend que l'objet SyncEvent ne soit lancé. - - - - - &reftitle.parameters; - - - wait - - - Le nombre de millisecondes à attendre que l'événement ne soit lancé. - Une valeur de -1 signifie que l'on attend indéfiniment. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>SyncEvent::wait</function> - -fire(); - -// Dans un cron : -$event = new SyncEvent("GetAppReport"); -$event->wait(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncEvent::fire - - - - - diff --git a/reference/sync/syncmutex.xml b/reference/sync/syncmutex.xml deleted file mode 100644 index b042c3e598..0000000000 --- a/reference/sync/syncmutex.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - La classe SyncMutex - SyncMutex - - - - -
    - &reftitle.intro; - - Une implémentation cross-plateforme, native des objets Mutex nommés ou non. - - - Un Mutex est un objet d'exclusion mutuelle qui restreint l'accès à une ressource partagée - (c.-à-d. un fichier) à une seule instance. Les Mutex comptables acquièrent le mutex une - seule fois et, en interne, traquent le nombre de fois que le mutex est verrouillé. - Le Mutex est déverrouillé dès qu'il sort du scope ou s'il est déverrouillé le - même nombre de fois qu'il n'a été verrouillé. - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncMutex - - - - - SyncMutex - - - - - &Methods; - - - - -
    - -     - - &reference.sync.entities.syncmutex; - -     - diff --git a/reference/sync/syncmutex/construct.xml b/reference/sync/syncmutex/construct.xml deleted file mode 100644 index fcc5709606..0000000000 --- a/reference/sync/syncmutex/construct.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - SyncMutex::__construct - Construit un nouvel objet SyncMutex - - - - &reftitle.description; - - public SyncMutex::__construct - stringname - - - Construit un objet comptable nommé ou non. - - - - - &reftitle.parameters; - - - name - - - Le nom du mutex s'il s'agit d'un objet mutex nommé. - - - - Si le nom existe déjà, il doit être capable d'être ouvert par l'utilisateur - courant exécutant le processus, ou bien une exception sera lancée - avec le message d'erreur correspondant. - - - - - - - - - &reftitle.returnvalues; - - Le nouvel objet SyncMutex. - - - - - &reftitle.errors; - - Une exception est lancée si le mutex ne peut - être créé ou ouvert. - - - - - &reftitle.examples; - - Exemple avec <function>SyncMutex::__construct</function> - et un mutex nommé avec un délai d'attente maximal pour le verrou - -lock(3000)) -{ - echo "Impossible de verrouiller le mutex."; - - exit(); -} - -/* ... */ - -$mutex->unlock(); -?> -]]> - - - - Exemple avec <function>SyncMutex::__construct</function> - et un mutex non nommé - -lock(); - -/* ... */ - -$mutex->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncMutex::lock - SyncMutex::unlock - - - - - diff --git a/reference/sync/syncmutex/lock.xml b/reference/sync/syncmutex/lock.xml deleted file mode 100644 index 43821bea37..0000000000 --- a/reference/sync/syncmutex/lock.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - SyncMutex::lock - Obtient un verrou exclusif - - - - &reftitle.description; - - public boolSyncMutex::lock - intwait-1 - - - Obtient un verrou exclusif sur un objet SyncMutex. - Si le verrou est déjà acquis, alors cette méthode va incrémenter le - compteur interne. - - - - - &reftitle.parameters; - - - wait - - - Le nombre de millisecondes à attendre pour l'obtention du verrou - exclusif. Une valeur -1 signifie que l'on attend indéfiniment. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>SyncMutex::lock</function> - -lock(3000)) -{ - echo "Impossible de verrouiller le mutex."; - - exit(); -} - -/* ... */ - -$mutex->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncMutex::unlock - - - - - diff --git a/reference/sync/syncmutex/unlock.xml b/reference/sync/syncmutex/unlock.xml deleted file mode 100644 index bb6a3e073a..0000000000 --- a/reference/sync/syncmutex/unlock.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - SyncMutex::unlock - Déverrouille le mutex - - - - &reftitle.description; - - public boolSyncMutex::unlock - boolall&false; - - - Décrémente le compteur interne d'un objet SyncMutex. - Lorsque le compteur interne atteint zéro, le verrou actuel - de l'objet est libéré. - - - - - &reftitle.parameters; - - - all - - - Spécifie si l'on doit ou non définir le compteur interne à zéro - et donc, libérer le verrou. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>SyncMutex::unlock</function> - -lock(); - -/* ... */ - -$mutex->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncMutex::lock - - - - - diff --git a/reference/sync/syncreaderwriter.xml b/reference/sync/syncreaderwriter.xml deleted file mode 100644 index c08ec0a120..0000000000 --- a/reference/sync/syncreaderwriter.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La classe SyncReaderWriter - SyncReaderWriter - - - - -
    - &reftitle.intro; - - Une implémentation cross-plateforme, native des objets lecture-écriture nommés ou non. - - - Un objet lecture-écriture autorise plusieurs lectures, ou une écriture à accéder - à une ressource. C'est une solution efficace pour gérer les ressources - où l'accès est principalement en lecture seule mais qu'un accès en écriture est - occasionnellement nécessaire. - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncReaderWriter - - - - - SyncReaderWriter - - - - - &Methods; - - - - -
    - -     - - &reference.sync.entities.syncreaderwriter; - -     - diff --git a/reference/sync/syncreaderwriter/construct.xml b/reference/sync/syncreaderwriter/construct.xml deleted file mode 100644 index d347bd5257..0000000000 --- a/reference/sync/syncreaderwriter/construct.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - SyncReaderWriter::__construct - Construit un nouvel objet SyncReaderWriter - - - - &reftitle.description; - - public SyncReaderWriter::__construct - stringname - intautounlock1 - - - Construit un objet de lecture/écriture nommé ou non. - - - - - &reftitle.parameters; - - - name - - - Le nom de l'objet s'il est nommé. - - - - Si le nom existe déjà, l'objet doit pouvoir être ouvert avec l'utilisateur - courant qui exécute le processus, ou une exception sera émise contenant - le message d'erreur. - - - - - Sous Windows, name ne doit pas contenir de barres obliques inverses. - - - - - - autounlock - - - Spécifie si l'on doit déverrouiller automatiquement l'objet à la fin du - script PHP. - - - - Si l'objet est un objet de lecture/écriture avec l'autounlock à &false;, - l'objet est verrouillé en lecture ou en écriture, et le script PHP - va se terminer avant le déverrouillage de l'objet, et donc, l'objet - sous-jacent se terminera dans un statut incohérent. - - - - - - - - - &reftitle.returnvalues; - - Le nouvel objet SyncReaderWriter. - - - - - &reftitle.errors; - - Une exception est émise si l'objet de - lecture/écriture ne peut être créé ou ouvert. - - - - - &reftitle.examples; - - Exemple avec <function>SyncReaderWriter::__construct</function> - -readlock(); -/* ... */ -$readwrite->readunlock(); - -$readwrite->writelock(); -/* ... */ -$readwrite->writeunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::readlock - SyncReaderWriter::readunlock - SyncReaderWriter::writelock - SyncReaderWriter::writeunlock - - - - - diff --git a/reference/sync/syncreaderwriter/readlock.xml b/reference/sync/syncreaderwriter/readlock.xml deleted file mode 100644 index d5ad6e2946..0000000000 --- a/reference/sync/syncreaderwriter/readlock.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - SyncReaderWriter::readlock - Obtient un verrou de lecture - - - - &reftitle.description; - - public boolSyncReaderWriter::readlock - intwait-1 - - - Obtient un verrou de lecture sur un objet SyncReaderWriter. - - - - - &reftitle.parameters; - - - wait - - - Le nombre de millisecondes à attendre un verrou. Une valeur de -1 signifie - que l'on attend indéfiniment. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>SyncReaderWriter::readlock</function> - -readlock(); -/* ... */ -$readwrite->readunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::readunlock - - - - - diff --git a/reference/sync/syncreaderwriter/readunlock.xml b/reference/sync/syncreaderwriter/readunlock.xml deleted file mode 100644 index 90298e3718..0000000000 --- a/reference/sync/syncreaderwriter/readunlock.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - SyncReaderWriter::readunlock - Libère un verrou de lecture - - - - &reftitle.description; - - public boolSyncReaderWriter::readunlock - - - - Libère un verrou de lecture sur un objet SyncReaderWriter. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>SyncReaderWriter::readunlock</function> - -readlock(); -/* ... */ -$readwrite->readunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::readlock - - - - - diff --git a/reference/sync/syncreaderwriter/writelock.xml b/reference/sync/syncreaderwriter/writelock.xml deleted file mode 100644 index 72829e5ce3..0000000000 --- a/reference/sync/syncreaderwriter/writelock.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - SyncReaderWriter::writelock - Obtient un verrou d'écriture exclusif - - - - &reftitle.description; - - public boolSyncReaderWriter::writelock - intwait-1 - - - Obtient un verrou d'écriture exclusif sur un objet SyncReaderWriter. - - - - - &reftitle.parameters; - - - wait - - - Le nombre de millisecondes à attendre le verrou. Une valeur de -1 signifie - que l'on attend indéfiniment. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>SyncReaderWriter::writelock</function> - -writelock(); -/* ... */ -$readwrite->writeunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::writeunlock - - - - - diff --git a/reference/sync/syncreaderwriter/writeunlock.xml b/reference/sync/syncreaderwriter/writeunlock.xml deleted file mode 100644 index 9f26076ee2..0000000000 --- a/reference/sync/syncreaderwriter/writeunlock.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - SyncReaderWriter::writeunlock - Libère un verrou d'écriture - - - - &reftitle.description; - - public boolSyncReaderWriter::writeunlock - - - - Libère un verrou d'écriture sur un objet SyncReaderWriter. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>SyncReaderWriter::writeunlock</function> - -writelock(); -/* ... */ -$readwrite->writeunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::writelock - - - - - diff --git a/reference/sync/syncsemaphore.xml b/reference/sync/syncsemaphore.xml deleted file mode 100644 index 7992d39ced..0000000000 --- a/reference/sync/syncsemaphore.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La classe SyncSemaphore - SyncSemaphore - - - - -
    - &reftitle.intro; - - Une implémentation cross-plateforme, native des objets Sémaphore nommés ou non. - - - Un sémaphore restreint l'accès à une ressource limitée à un nombre limité - d'instances. Les sémaphores diffèrent des mutexes dans le sens où ils permettent - à plus d'une instance d'accéder à une ressource en même temps, alors que le mutex - ne permet qu'une seule instance à la fois. - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncSemaphore - - - - - SyncSemaphore - - - - - &Methods; - - - - -
    - -     - - &reference.sync.entities.syncsemaphore; - -     - diff --git a/reference/sync/syncsemaphore/construct.xml b/reference/sync/syncsemaphore/construct.xml deleted file mode 100644 index e3abc67c7e..0000000000 --- a/reference/sync/syncsemaphore/construct.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - SyncSemaphore::__construct - Construit un nouvel objet SyncSemaphore - - - - &reftitle.description; - - public SyncSemaphore::__construct - stringname - intinitialval1 - boolautounlock&true; - - - Construit un sémaphore nommé ou non. - - - - - &reftitle.parameters; - - - name - - - Le nom du sémaphore s'il est nommé. - - - - Si le nom existe déjà, l'objet doit pouvoir être ouvert par l'utilisateur - courant qui exécute le processus, ou une exception sera émise contenant - le message d'erreur. - - - - - - initialval - - - La valeur initiale du sémaphore. Ce sera le nombre de verrous qui peuvent - être obtenus. - - - - - autounlock - - - Spécifie si l'on doit ou non déverrouiller automatiquement le sémaphore - à la fin du script PHP. - - - - Si l'objet est un sémaphore nommé dont l'autounlock vaut &false;, l'objet - est verrouillé, et le script PHP se termine avant que l'objet ne soit - déverrouillé, alors le sémaphore sous-jacent se terminera dans un statut - incohérent. - - - - - - - - - &reftitle.returnvalues; - - Le nouvel objet SyncSemaphore. - - - - - &reftitle.errors; - - Une exception sera émise si le sémaphore ne peut - être créé ou ouvert. - - - - - &reftitle.examples; - - Exemple avec <function>SyncSemaphore::__construct</function> - -lock(3000)) -{ - echo "Impossible de verrouiller le sémaphore."; - - exit(); -} - -/* ... */ - -$semaphore->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncSemaphore::lock - SyncSemaphore::unlock - - - - - diff --git a/reference/sync/syncsemaphore/lock.xml b/reference/sync/syncsemaphore/lock.xml deleted file mode 100644 index 60543c9a6b..0000000000 --- a/reference/sync/syncsemaphore/lock.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - SyncSemaphore::lock - Décrémente le compteur de l'objet SyncSemaphore ou attend - - - - &reftitle.description; - - public boolSyncSemaphore::lock - intwait-1 - - - Décrémente le compteur de l'objet SyncSemaphore ou attend que le sémaphore - soit à une valeur différente de zéro. - - - - - &reftitle.parameters; - - - wait - - - Le nombre de millisecondes à attendre le sémaphore. Une valeur de -1 signifie que - l'on attend indéfiniment. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>SyncSemaphore::lock</function> - -lock(3000)) -{ - echo "Impossible de verrouiller le sémaphore."; - - exit(); -} - -/* ... */ - -$semaphore->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncSemaphore::unlock - - - - - diff --git a/reference/sync/syncsemaphore/unlock.xml b/reference/sync/syncsemaphore/unlock.xml deleted file mode 100644 index c9bba020b1..0000000000 --- a/reference/sync/syncsemaphore/unlock.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - SyncSemaphore::unlock - Incrémente le compteur de l'objet SyncSemaphore - - - - &reftitle.description; - - public boolSyncSemaphore::unlock - intprevcount - - - Incrémente le compteur de l'objet SyncSemaphore. - - - - - &reftitle.parameters; - - - prevcount - - - Retourne le compteur précédent du sémaphore. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>SyncSemaphore::unlock</function> - -lock(3000)) -{ - echo "Impossible de verrouiller le sémaphore."; - - exit(); -} - -/* ... */ - -$semaphore->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncSemaphore::lock - - - - - diff --git a/reference/sync/syncsharedmemory.xml b/reference/sync/syncsharedmemory.xml deleted file mode 100644 index 2c1064623e..0000000000 --- a/reference/sync/syncsharedmemory.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - La classe SyncSharedMemory - SyncSharedMemory - - - - -
    - &reftitle.intro; - - Une implémentation native, cohérente et multi-plateforme d'objets de mémoire partagée nommée. - - - La mémoire partagée permet à deux processus distincts de communiquer sans avoir besoin de - tuyaux ou de sockets complexes. Il existe plusieurs implémentations de mémoire partagée - basées sur des entiers pour PHP. La mémoire partagée nommée est une alternative. - - - Les objets de synchronisation (par exemple, SyncMutex) sont toujours nécessaires pour protéger la plupart - des utilisations de la mémoire partagée. - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncSharedMemory - - - - - SyncSharedMemory - - - - - &Methods; - - - - -
    - -     - - &reference.sync.entities.syncsharedmemory; - -     - diff --git a/reference/sync/syncsharedmemory/construct.xml b/reference/sync/syncsharedmemory/construct.xml deleted file mode 100644 index 6bab362268..0000000000 --- a/reference/sync/syncsharedmemory/construct.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - SyncSharedMemory::__construct - Construit un nouvel objet SyncSharedMemory - - - - &reftitle.description; - - public SyncSharedMemory::__construct - stringname - intsize - - - Construit un objet de mémoire partagée nommé. - - - - - &reftitle.parameters; - - - name - - - Le nom de l'objet de mémoire partagée. - - - - Si le nom existe déjà, il doit pouvoir être ouvert par l'utilisateur actuel - que le processus est en cours d'exécution ou une exception sera levée avec un message d'erreur - sans signification. - - - - - - size - - - La taille, en octets, de la mémoire partagée à réserver. - - - - La quantité de mémoire ne peut pas être redimensionnée ultérieurement. Demandez suffisamment de stockage à l'avance. - - - - - - - - - &reftitle.returnvalues; - - Le nouvel objet SyncSharedMemory. - - - - - &reftitle.errors; - - Une exception est levée si l'objet de mémoire partagée ne peut pas être créé ou ouvert. - - - - - &reftitle.examples; - - Exemple de <function>SyncSharedMemory::__construct</function> - -first()) -{ - // Faire le travail d'initialisation la première fois ici. -} - -$result = $mem->write(json_encode(array("name" => "my_report.txt"))); -?> -]]> - - - - - - &reftitle.seealso; - - SyncSharedMemory::first - SyncSharedMemory::size - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/syncsharedmemory/first.xml b/reference/sync/syncsharedmemory/first.xml deleted file mode 100644 index ceee938f87..0000000000 --- a/reference/sync/syncsharedmemory/first.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - SyncSharedMemory::first - Vérifie si l'objet est la première instance dans tout le système de la mémoire partagée nommée - - - - &reftitle.description; - - public boolSyncSharedMemory::first - - - - Récupère l'état de première instance de l'objet SyncSharedMemory dans tout le système. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple de <function>SyncSharedMemory::first</function> - -first()) -{ - // Faire le travail d'initialisation la première fois ici. -} - -var_dump($mem->first()); - -$mem2 = new SyncSharedMemory("AppReportName", 1024); - -var_dump($mem2->first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/syncsharedmemory/read.xml b/reference/sync/syncsharedmemory/read.xml deleted file mode 100644 index 0a4c5e4a07..0000000000 --- a/reference/sync/syncsharedmemory/read.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - SyncSharedMemory::read - Copie des données de la mémoire partagée nommée - - - - &reftitle.description; - - public SyncSharedMemory::read - intstart0 - intlength - - - Copie des données de la mémoire partagée nommée. - - - - - &reftitle.parameters; - - - start - - - Le début/décalage, en octets, pour commencer la lecture. - - - - Si la valeur est négative, la position de départ commencera au nombre spécifié - d'octets à partir de la fin du segment de mémoire partagée. - - - - - - length - - - Le nombre d'octets à lire. - - - - Si non spécifié, la lecture s'arrêtera à la fin du segment de mémoire partagée. - - - Si la valeur est négative, la lecture s'arrêtera au nombre spécifié d'octets - à partir de la fin du segment de mémoire partagée. - - - - - - - - - &reftitle.returnvalues; - - Une chaîne contenant les données lues de la mémoire partagée. - - - - - &reftitle.examples; - - Exemple de <function>SyncSharedMemory::__construct</function> - -first()) -{ - // Faire le travail d'initialisation la première fois ici. -} - -$result = $mem->write("report.txt"); - -$result = $mem->read(3, -4); -var_dump($result); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SyncSharedMemory::__construct - SyncSharedMemory::first - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/syncsharedmemory/size.xml b/reference/sync/syncsharedmemory/size.xml deleted file mode 100644 index 0b11ceb97e..0000000000 --- a/reference/sync/syncsharedmemory/size.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - SyncSharedMemory::size - Renvoie la taille de la mémoire partagée nommée - - - - &reftitle.description; - - public intSyncSharedMemory::size - - - - Récupère la taille de la mémoire partagée d'un objet SyncSharedMemory. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un entier contenant la taille de la mémoire partagée. Cela sera la même taille qui a été passée au constructeur. - - - - - &reftitle.examples; - - Exemple de <function>SyncSharedMemory::size</function> - -size()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SyncSharedMemory::__construct - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/syncsharedmemory/write.xml b/reference/sync/syncsharedmemory/write.xml deleted file mode 100644 index 0cb71dcb38..0000000000 --- a/reference/sync/syncsharedmemory/write.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - SyncSharedMemory::write - Copie les données dans la mémoire partagée nommée - - - - &reftitle.description; - - public SyncSharedMemory::write - stringstring - intstart0 - - - Copie les données dans la mémoire partagée nommée. - - - - - &reftitle.parameters; - - - string - - - Les données à écrire dans la mémoire partagée. - - - - Si la taille des données dépasse la taille de la mémoire partagée, le nombre - d'octets écrits retourné sera inférieur à la longueur de l'entrée. - - - - - - start - - - Le début/décalage, en octets, pour commencer l'écriture. - - - - Si la valeur est négative, la position de départ commencera au nombre spécifié - d'octets à partir de la fin du segment de mémoire partagée. - - - - - - - - - &reftitle.returnvalues; - - Un entier contenant le nombre d'octets écrits dans la mémoire partagée. - - - - - &reftitle.examples; - - Exemple de <function>SyncSharedMemory::write</function> - -first()) -{ - // Faire le travail d'initialisation la première fois ici. -} - -$result = $mem->write("report.txt"); -var_dump($result); - -$result = $mem->write("report.txt", -3); -var_dump($result); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SyncSharedMemory::__construct - SyncSharedMemory::first - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/taint/book.xml b/reference/taint/book.xml deleted file mode 100644 index 7b4c650233..0000000000 --- a/reference/taint/book.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Taint - Taint - - - &reftitle.intro; - - Taint est une extension permettant de détecter des codes XSS (chaînes - corrompues). Elle peut également être utilisée pour repérer des injections - SQL, des injections de commandes, des injections de chemins de fichiers et - des vulnérabilités similaires. - - - Lorsque taint est activé, les chaînes reçues de l'entrée utilisateur — - $_GET, $_POST et - $_COOKIE — sont marquées comme corrompues au démarrage - de la requête, et la marque est propagée à travers les opérations sur les - chaînes. Lorsqu'une chaîne corrompue atteint un point de sortie dangereux - (affichage, requête SQL, commande shell, chemin de fichier...), taint émet - un avertissement pointant vers cet endroit. Voir - Propagation et vérifications pour les - listes complètes. - - - Taint est un outil de développement et d'audit, non une défense à - l'exécution : il ne fait que signaler des problèmes possibles et ne bloque - ni n'altère jamais les données. Il est délibérément conservateur et peut - sur-rapporter, donc un passage sans erreur signifie uniquement « rien que - taint ne pouvait voir », jamais « prouvablement sécurisé ». Ne pas - l'activer dans les environnements de production. - - - Exemple avec Taint - - -]]> - - &example.outputs.similar; - - - - - - - &reference.taint.setup; - &reference.taint.detail; - &reference.taint.reference; - - - - diff --git a/reference/taint/configure.xml b/reference/taint/configure.xml deleted file mode 100644 index 8a347ccf20..0000000000 --- a/reference/taint/configure.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;taint. - - - - Installation via PECL : - - - - - - - - - Le code source est hébergé sur - GitHub. Pour compiler - l'extension depuis les sources : - - - - - - - Ensuite activer l'extension en ajoutant - extension=taint.so (ou extension=php_taint.dll - sous Windows) dans &php.ini;, et mettre - taint.enable à - 1. - - - - - Taint est un outil de développement et d'audit. Ne pas l'activer dans - les environnements de production : l'instrumentation ralentit chaque - requête, désactive le JIT d'OPcache, et les avertissements peuvent faire - fuiter des données de requête dans les journaux. - - -
    - - diff --git a/reference/taint/detail.xml b/reference/taint/detail.xml deleted file mode 100644 index 5b3df8e4b3..0000000000 --- a/reference/taint/detail.xml +++ /dev/null @@ -1,298 +0,0 @@ - - - - - Propagation et vérifications - -
    - Comment la marque de corruption se propage - - La marque de corruption est un bit unique stocké sur la chaîne elle-même, - pas sur la variable qui la contient. Assigner, passer ou partager une - chaîne corrompue conserve la marque. La concaténation et l'interpolation - de chaînes la propagent également : - - - - Opérateurs qui propagent la marque de corruption - - - - = (assignement, y compris list()/déstructuration de tableau) - - - . (concaténation) - - - .= (assignement de concaténation) - - - "{$var}" (interpolation de chaîne, y compris le chemin rapide ROPE) - - - -
    -     - - De plus, taint comprend un ensemble fixe de fonctions de chaînes : lorsque - l'un des arguments de chaîne concernés est corrompu, la chaîne retournée - est également marquée comme corrompue. L'appel normal et, sur PHP 8.4+, - l'appel rapide sans cadre (frameless) sont tous deux couverts. - - - - Fonctions qui propagent la marque de corruption - - - - trim, rtrim, ltrim - - - substr, strstr - - - str_replace, str_ireplace - - - str_pad, strtolower, strtoupper, strval - - - explode (chaque élément du tableau résultant) - - - implode/join (un séparateur corrompu corrompt également le résultat) - - - sprintf, vsprintf (seul le spécificateur %s transporte la marque ; sprintf("%d", $t) retourne une chaîne propre) - - - dirname, basename, pathinfo - - - -
    -     - - Toute fonction que taint ne comprend pas explicitement retourne une - chaîne neuve et non marquée -- y compris les fonctions d'échappement - telles que htmlspecialchars, - htmlentities ou - mysqli_real_escape_string. C'est délibéré : taint - sur-rapporte plutôt que d'essayer de décider si une valeur est - sûre pour un contexte de sortie particulier. Utiliser - untaint pour effacer la marque sur des valeurs que - l'on a validées soi-même. - -
    - -
    - Où taint déclenche des avertissements - - Lorsqu'une chaîne corrompue atteint l'un des points de sortie ci-dessous, - taint émet un avertissement (par défaut un - E_USER_WARNING ; le niveau est configurable via - taint.error_level). Seuls - les arguments de chaîne de premier niveau sont inspectés ; vider un - tableau qui contient simplement des valeurs corrompues n'émet pas - d'avertissement. - - - - Points de sortie d'affichage - - - Point de sortieVérifié - - - - echo, print - l'expression affichée - - - printf, vprintf - la chaîne de format et les valeurs substituées - - - print_r, var_dump, var_export - la valeur vidée, quand c'est une chaîne - - - exit/die avec un message - le message - - - file_put_contents, fwrite, fputs vers php://output - les données écrites - - - -
    -     - - - Points de sortie du système de fichiers - - - Point de sortieVérifié - - - - fopen, opendir, unlink - le chemin - - - file, readfile, file_get_contents, highlight_file/show_source - le chemin - - - copy, rename, move_uploaded_file - les chemins source et destination - - - mkdir, rmdir, touch - le chemin - - - include, include_once, require, require_once - le chemin du fichier - - - -
    -     - - - Points de sortie SQL - - - Point de sortieVérifié - - - - mysqli_query, mysqli_prepare, mysqli_real_query, mysqli_multi_query - la chaîne de requête - - - mysql_query, sqlite_query, sqlite_single_query, oci_parse, pg_query, pg_send_query - la chaîne de requête - - - mysqli::query, mysqli::prepare, mysqli::real_query, mysqli::multi_query - la chaîne de requête - - - PDO::query, PDO::prepare, PDO::exec - la chaîne de requête - - - SQLite3::query, SQLite3::prepare, SQLite3::exec, SQLiteDatabase::query, SQLiteDatabase::singleQuery - la chaîne de requête - - - -
    -     - - - Points de sortie d'exécution de commandes - - - Point de sortieVérifié - - - - exec, system, passthru, shell_exec (y compris l'opérateur backtick) - la chaîne de commande - - - proc_open, popen - la chaîne de commande - - - eval - le code évalué - - - les appels dynamiques tels que $func(), $obj->$method(), call_user_func, les callables tableaux - le nom de fonction/méthode/classe en cours de résolution - - - preg_match, preg_match_all, preg_replace, preg_split, preg_grep, preg_replace_callback - le motif (et le nom du callback pour preg_replace_callback) - - - -
    -     - - - Points de sortie d'en-têtes et cookies - - - Point de sortieVérifié - - - - header - la chaîne d'en-tête - - - setcookie, setrawcookie - le nom et la valeur du cookie - - - -
    -     - - - Autres points de sortie - - - Point de sortieVérifié - - - - unserialize - la chaîne sérialisée - - - mail - le destinataire, le sujet, les paramètres supplémentaires et les en-têtes supplémentaires (le corps du message est du contenu et n'est pas vérifié) - - - -
    -     - - Les avertissements suivent le format - function_name() [sink]: message, où - sink identifie l'opération vérifiée (par exemple - echo, include ou le nom de la - fonction) et le message décrit ce qui a été trouvé comme potentiellement - corrompu. - -
    - -     - - diff --git a/reference/taint/functions/is-tainted.xml b/reference/taint/functions/is-tainted.xml deleted file mode 100644 index ceec90ed6f..0000000000 --- a/reference/taint/functions/is-tainted.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - is_tainted - Vérifie si une chaîne est corrompue - - - - &reftitle.description; - - boolis_tainted - stringstring - - - Vérifie si la valeur donnée porte la marque de corruption. Seules les - chaînes peuvent être corrompues ; tout autre type retourne &false;. - - - - - &reftitle.parameters; - - - string - - - La valeur à vérifier. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si la valeur est une chaîne corrompue, &false; sinon. - Retourne toujours &false; lorsque - taint.enable est désactivé. - - - - - &reftitle.examples; - - Exemple avec <function>is_tainted</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - taint - untaint - - - - - - - diff --git a/reference/taint/functions/taint.xml b/reference/taint/functions/taint.xml deleted file mode 100644 index c1342cde35..0000000000 --- a/reference/taint/functions/taint.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - taint - Marque des chaînes comme corrompues - - - - &reftitle.description; - - booltaint - stringstring - stringstrings - - - Marque manuellement les chaînes données comme corrompues, comme si elles - provenaient d'une entrée utilisateur. Les variables sont passées par - référence, mais la marque elle-même est stockée sur la chaîne plutôt que - sur la variable : chaque variable partageant la même chaîne devient - corrompue à la fois. - - - Ceci est principalement utile pour les tests et pour simuler des entrées - utilisateur dans des scripts CLI où les superglobales - $_GET, - $_POST et - $_COOKIE - ne sont pas peuplées. - - - - - &reftitle.parameters; - - - string - - - Une variable contenant la chaîne à marquer. - - - - - strings - - - D'autres variables à marquer. - - - - - - - - &reftitle.returnvalues; - - Retourne toujours &true;. Lorsque - taint.enable est désactivé, la - fonction ne fait rien et retourne quand même &true;. - - - - - &reftitle.examples; - - Exemple avec <function>taint</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - Seules les chaînes non vides sont marquées ; les variables contenant - d'autres types, ou des chaînes vides, sont silencieusement ignorées. - - - - - Les chaînes internées, persistantes et permanentes (littéraux de - chaînes, chaînes partagées d'opcache) ne peuvent jamais porter la - marque et sont silencieusement ignorées. - - - - - - &reftitle.seealso; - - - untaint - is_tainted - - - - - - - diff --git a/reference/taint/functions/untaint.xml b/reference/taint/functions/untaint.xml deleted file mode 100644 index 7ccfb93f8a..0000000000 --- a/reference/taint/functions/untaint.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - untaint - Retire la marque de corruption des chaînes - - - - &reftitle.description; - - booluntaint - stringstring - stringstrings - - - Efface la marque de corruption sur les chaînes données. - - - La marque est stockée sur la chaîne elle-même, pas sur la variable, donc - cela l'efface pour chaque variable partageant la même chaîne à la fois. - Utiliser cette fonction pour autoriser des valeurs que l'on a validées - soi-même, par exemple après une vérification stricte par liste blanche. - - - - - &reftitle.parameters; - - - string - - - Une variable contenant la chaîne à nettoyer. - - - - - strings - - - D'autres variables à nettoyer. - - - - - - - - &reftitle.returnvalues; - - Retourne toujours &true;. Lorsque - taint.enable est désactivé, la - fonction ne fait rien et retourne quand même &true;. - - - - - &reftitle.examples; - - Exemple avec <function>untaint</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - Seules les valeurs de type chaîne peuvent porter la marque ; passer - un type non-chaîne est sans effet. - - - - - - &reftitle.seealso; - - - taint - is_tainted - - - - - - - diff --git a/reference/taint/ini.xml b/reference/taint/ini.xml deleted file mode 100644 index ceed4060d4..0000000000 --- a/reference/taint/ini.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Taint &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - taint.enable - 0 - INI_SYSTEM - - - - taint.error_level - 512 (E_USER_WARNING) - INI_ALL - - - - -
    -     - - &ini.descriptions.title; - - - - - - taint.enable - bool - - - - Interrupteur principal. Lorsqu'il est activé, taint accroche - l'exécuteur et marque les chaînes issues de - $_GET, $_POST et - $_COOKIE comme corrompues au démarrage de la - requête. - - - C'est une directive &php.ini; uniquement : son activation requiert un - redémarrage du processus, elle ne peut donc pas être activée ou - désactivée par requête ou par répertoire. - - - - Ne pas activer cette directive dans les environnements de production : - l'instrumentation ralentit chaque requête et est incompatible avec - le JIT d'OPcache. - - - - - - - taint.error_level - int - - - - Le niveau d'erreur utilisé lorsque taint signale une chaîne - potentiellement corrompue. La valeur par défaut est - E_USER_WARNING (512). - - - Cette directive étant INI_ALL, elle peut être - modifiée à l'exécution. Par exemple, pour silencer les avertissements - taint pour le script courant : - - - - -]]> - - - - - - - -
    - - diff --git a/reference/taint/reference.xml b/reference/taint/reference.xml deleted file mode 100644 index 1bea66e933..0000000000 --- a/reference/taint/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; Taint - - &reference.taint.entities.functions; - - - - diff --git a/reference/taint/setup.xml b/reference/taint/setup.xml deleted file mode 100644 index 4b76f79e1f..0000000000 --- a/reference/taint/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Taint 3.x requiert PHP 8.0 ou supérieur. Pour PHP 7.x utiliser les - versions taint 2.1.x, et pour PHP 5.x les versions taint 1.x. - -
    - - - &reference.taint.configure; - - - - &reference.taint.ini; - - -
    - &reftitle.resources; - - Taint ne définit aucun type de ressource. La marque de corruption est - stockée dans la structure interne zend_string, pas - dans une ressource visible par l'utilisateur. - -
    - -     - - diff --git a/reference/tcpwrap/book.xml b/reference/tcpwrap/book.xml deleted file mode 100644 index 925978344d..0000000000 --- a/reference/tcpwrap/book.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - TCP Wrappers - TCP - - - - &reftitle.intro; - - L'extension d'enveloppes TCP fournit un mécanisme classique Unix conçu pour - vérifier si le client est capable de se connecter à partir d'une IP - donnée. - - - - - &reference.tcpwrap.setup; - &reference.tcpwrap.reference; - - - - - diff --git a/reference/tcpwrap/configure.xml b/reference/tcpwrap/configure.xml deleted file mode 100644 index 8b0c0abb8a..0000000000 --- a/reference/tcpwrap/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;tcpwrap. - - - &pecl.windows.download; - -
    - - diff --git a/reference/tcpwrap/functions/tcpwrap-check.xml b/reference/tcpwrap/functions/tcpwrap-check.xml deleted file mode 100644 index c51ac4c5d8..0000000000 --- a/reference/tcpwrap/functions/tcpwrap-check.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - - tcpwrap_check - Vérification Tcpwrap - - - &reftitle.description; - - booltcpwrap_check - stringdaemon - stringaddress - stringuser - boolnodns&false; - - - tcpwrap_check consulte les fichiers /etc/hosts.allow - et /etc/hosts.deny pour vérifier si l'accès au service - daemon est permis ou pas pour un client. - - - - &reftitle.parameters; - - - - daemon - - - Le nom du service. - - - - - address - - - L'adresse distante du client. Peut être soit une adresse IP, soit un nom de - domaine. - - - - - user - - - Un nom d'utilisateur, optionnel. - - - - - nodns - - - Si address ressemble à un nom de domaine, - DNS est utilisé pour le résoudre en adresse IP ; définissez - nodns à &true; pour éviter ce comportement. - - - - - - - - &reftitle.returnvalues; - - Cette fonction retourne &true; si l'accès doit être autorisé, &false; sinon. - - - - &reftitle.examples; - - Refuser toutes les connexions depuis localhost - - Si le fichier /etc/hosts.deny contient : - - - - - - Et le code ressemble à : - - - - ]]> - - - - - &reftitle.seealso; - - Pour plus de détails, consulter la page man de hosts_access(3). - - - - - diff --git a/reference/tcpwrap/reference.xml b/reference/tcpwrap/reference.xml deleted file mode 100644 index 5d550eca06..0000000000 --- a/reference/tcpwrap/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; TCP - - &reference.tcpwrap.entities.functions; - - - - diff --git a/reference/tcpwrap/setup.xml b/reference/tcpwrap/setup.xml deleted file mode 100644 index a27965c338..0000000000 --- a/reference/tcpwrap/setup.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.tcpwrap.configure; - - - - - - diff --git a/reference/trader/book.xml b/reference/trader/book.xml deleted file mode 100644 index afca82ad3d..0000000000 --- a/reference/trader/book.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - Analyse technique pour les marchands - Trader - - - &reftitle.intro; - - L'extension Trader est une bibliothèque open source libre, basée sur TA-Lib. - Elle est dédiée aux développeurs de logiciels commerciaux qui nécessitent - d'effectuer une analyse technique des données sur les marchés financiers. - En plus de cela, plusieurs indicateurs comme ADX, MACD, RSI, Stochastic, - TRIX, le chandelier à reconnaissance de motif, mais aussi diverses fonctions - arithmétiques et algébriques sont présents. - - - Les calculs peuvent être réalisés en 2 modes : TA-Lib et Metastock. - La modification de ces modes en utilisant la fonction - trader_set_compat() - affectera la façon dont réagissent quelques fonctions Trader. - - - Quelques fonctions Trader fournissent différents résultats suivant - le "point de départ" des données à utiliser. Ce peut être comparé - à l'allocation mémoire d'une fonction. Un exemple d'une telle fonction est - la moyenne de déplacement exponentiel. Il est possible de contrôler la période - instable (la quantité de données à retirer) en utilisant la fonction - trader_set_unstable_period(). - - - Une documentation plus complète à propos - des indicateurs, des formules et son implémentation - dans d'autres langages de programmation peut être - trouvée sur le site &url.trader.lib;. - - - - &reference.trader.setup; - &reference.trader.constants; - - &reference.trader.reference; - - - - diff --git a/reference/trader/configure.xml b/reference/trader/configure.xml deleted file mode 100644 index 66548d5c8d..0000000000 --- a/reference/trader/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;trader - - - -
    - - - diff --git a/reference/trader/constants.xml b/reference/trader/constants.xml deleted file mode 100644 index 6e57871661..0000000000 --- a/reference/trader/constants.xml +++ /dev/null @@ -1,604 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - - TRADER_MA_TYPE_SMA - (int) - - - - - - - - - TRADER_MA_TYPE_EMA - (int) - - - - - - - - - TRADER_MA_TYPE_WMA - (int) - - - - - - - - - TRADER_MA_TYPE_DEMA - (int) - - - - - - - - - TRADER_MA_TYPE_TEMA - (int) - - - - - - - - - TRADER_MA_TYPE_TRIMA - (int) - - - - - - - - - TRADER_MA_TYPE_KAMA - (int) - - - - - - - - - TRADER_MA_TYPE_MAMA - (int) - - - - - - - - - TRADER_MA_TYPE_T3 - (int) - - - - - - - - - TRADER_REAL_MIN - (float) - - - - - - - - - TRADER_REAL_MAX - (float) - - - - - - - - - TRADER_FUNC_UNST_ADX - (int) - - - - - - - - - TRADER_FUNC_UNST_ADXR - (int) - - - - - - - - - TRADER_FUNC_UNST_ATR - (int) - - - - - - - - - TRADER_FUNC_UNST_CMO - (int) - - - - - - - - - TRADER_FUNC_UNST_DX - (int) - - - - - - - - - TRADER_FUNC_UNST_EMA - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_DCPERIOD - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_DCPHASE - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_PHASOR - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_SINE - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_TRENDLINE - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_TRENDMODE - (int) - - - - - - - - - TRADER_FUNC_UNST_KAMA - (int) - - - - - - - - - TRADER_FUNC_UNST_MAMA - (int) - - - - - - - - - TRADER_FUNC_UNST_MFI - (int) - - - - - - - - - TRADER_FUNC_UNST_MINUS_DI - (int) - - - - - - - - - TRADER_FUNC_UNST_MINUS_DM - (int) - - - - - - - - - TRADER_FUNC_UNST_NATR - (int) - - - - - - - - - TRADER_FUNC_UNST_PLUS_DI - (int) - - - - - - - - - TRADER_FUNC_UNST_PLUS_DM - (int) - - - - - - - - - TRADER_FUNC_UNST_RSI - (int) - - - - - - - - - TRADER_FUNC_UNST_STOCHRSI - (int) - - - - - - - - - TRADER_FUNC_UNST_T3 - (int) - - - - - - - - - TRADER_FUNC_UNST_ALL - (int) - - - - - - - - - TRADER_FUNC_UNST_NONE - (int) - - - - - - - - - TRADER_COMPATIBILITY_DEFAULT - (int) - - - - - - - - - TRADER_COMPATIBILITY_METASTOCK - (int) - - - - - - - - - TRADER_ERR_SUCCESS - (int) - - - - - - - - - TRADER_ERR_LIB_NOT_INITIALIZE - (int) - - - - - - - - - TRADER_ERR_BAD_PARAM - (int) - - - - - - - - - TRADER_ERR_ALLOC_ERR - (int) - - - - - - - - - TRADER_ERR_GROUP_NOT_FOUND - (int) - - - - - - - - - TRADER_ERR_FUNC_NOT_FOUND - (int) - - - - - - - - - TRADER_ERR_INVALID_HANDLE - (int) - - - - - - - - - TRADER_ERR_INVALID_PARAM_HOLDER - (int) - - - - - - - - - TRADER_ERR_INVALID_PARAM_HOLDER_TYPE - (int) - - - - - - - - - TRADER_ERR_INVALID_PARAM_FUNCTION - (int) - - - - - - - - - TRADER_ERR_INPUT_NOT_ALL_INITIALIZE - (int) - - - - - - - - - TRADER_ERR_OUTPUT_NOT_ALL_INITIALIZE - (int) - - - - - - - - - TRADER_ERR_OUT_OF_RANGE_START_INDEX - (int) - - - - - - - - - TRADER_ERR_OUT_OF_RANGE_END_INDEX - (int) - - - - - - - - - TRADER_ERR_INVALID_LIST_TYPE - (int) - - - - - - - - - TRADER_ERR_BAD_OBJECT - (int) - - - - - - - - - TRADER_ERR_NOT_SUPPORTED - (int) - - - - - - - - - TRADER_ERR_INTERNAL_ERROR - (int) - - - - - - - - - TRADER_ERR_UNKNOWN_ERROR - (int) - - - - - - - - - - - diff --git a/reference/trader/functions/trader-acos.xml b/reference/trader/functions/trader-acos.xml deleted file mode 100644 index 6f808ad828..0000000000 --- a/reference/trader/functions/trader-acos.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_acos - Vector Trigonometric ACos - - - - &reftitle.description; - - arraytrader_acos - arrayreal - - - Calcule l'arc cosinus de chaque valeur de real - et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-ad.xml b/reference/trader/functions/trader-ad.xml deleted file mode 100644 index 6a8cf863b9..0000000000 --- a/reference/trader/functions/trader-ad.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - trader_ad - Chaikin A/D Line - - - - &reftitle.description; - - arraytrader_ad - arrayhigh - arraylow - arrayclose - arrayvolume - - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - volume - - - &trader.arg.array.of.real.volume; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-add.xml b/reference/trader/functions/trader-add.xml deleted file mode 100644 index 8635e8ab1c..0000000000 --- a/reference/trader/functions/trader-add.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - trader_add - Ajoute un vecteur arithmétique - - - - &reftitle.description; - - arraytrader_add - arrayreal0 - arrayreal1 - - - Calcule l'addition vectorielle de real0 - à real1 et retourne le vecteur résultant. - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-adosc.xml b/reference/trader/functions/trader-adosc.xml deleted file mode 100644 index f4127a95fe..0000000000 --- a/reference/trader/functions/trader-adosc.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - trader_adosc - Chaikin A/D Oscillator - - - - &reftitle.description; - - arraytrader_adosc - arrayhigh - arraylow - arrayclose - arrayvolume - intfastPeriod - intslowPeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - volume - - - &trader.arg.array.of.real.volume; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-adx.xml b/reference/trader/functions/trader-adx.xml deleted file mode 100644 index 03331c52e0..0000000000 --- a/reference/trader/functions/trader-adx.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_adx - Average Directional Movement Index - - - - &reftitle.description; - - arraytrader_adx - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-adxr.xml b/reference/trader/functions/trader-adxr.xml deleted file mode 100644 index a3c2954ba5..0000000000 --- a/reference/trader/functions/trader-adxr.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_adxr - Average Directional Movement Index Rating - - - - &reftitle.description; - - arraytrader_adxr - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-apo.xml b/reference/trader/functions/trader-apo.xml deleted file mode 100644 index 9b760d86fe..0000000000 --- a/reference/trader/functions/trader-apo.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_apo - Absolute Price Oscillator - - - - &reftitle.description; - - arraytrader_apo - arrayreal - intfastPeriod - intslowPeriod - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-aroon.xml b/reference/trader/functions/trader-aroon.xml deleted file mode 100644 index 0a893ef919..0000000000 --- a/reference/trader/functions/trader-aroon.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_aroon - Aroon - - - - &reftitle.description; - - arraytrader_aroon - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-aroonosc.xml b/reference/trader/functions/trader-aroonosc.xml deleted file mode 100644 index 603b9883c7..0000000000 --- a/reference/trader/functions/trader-aroonosc.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_aroonosc - Aroon Oscillator - - - - &reftitle.description; - - arraytrader_aroonosc - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-asin.xml b/reference/trader/functions/trader-asin.xml deleted file mode 100644 index fa9a408c7b..0000000000 --- a/reference/trader/functions/trader-asin.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_asin - Vector Trigonometric ASin - - - - &reftitle.description; - - arraytrader_asin - arrayreal - - - Calcule l'arc sinus de chaque valeur de real - et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-atan.xml b/reference/trader/functions/trader-atan.xml deleted file mode 100644 index 43f460ebde..0000000000 --- a/reference/trader/functions/trader-atan.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_atan - Calcule l'arc tangente - - - - &reftitle.description; - - arraytrader_atan - arrayreal - - - Calcule l'arc tangente de chaque valeur de real - et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-atr.xml b/reference/trader/functions/trader-atr.xml deleted file mode 100644 index 0e59c12109..0000000000 --- a/reference/trader/functions/trader-atr.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_atr - Average True Range - - - - &reftitle.description; - - arraytrader_atr - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-avgprice.xml b/reference/trader/functions/trader-avgprice.xml deleted file mode 100644 index 90a21e8876..0000000000 --- a/reference/trader/functions/trader-avgprice.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_avgprice - Average Price - - - - &reftitle.description; - - arraytrader_avgprice - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-bbands.xml b/reference/trader/functions/trader-bbands.xml deleted file mode 100644 index 7a74a673eb..0000000000 --- a/reference/trader/functions/trader-bbands.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - trader_bbands - Bollinger Bands - - - - &reftitle.description; - - arraytrader_bbands - arrayreal - inttimePeriod - floatnbDevUp - floatnbDevDn - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - nbDevUp - - - &trader.arg.nbdevup; - - - - - nbDevDn - - - &trader.arg.nbdevdn; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-beta.xml b/reference/trader/functions/trader-beta.xml deleted file mode 100644 index 52e55f4049..0000000000 --- a/reference/trader/functions/trader-beta.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_beta - Beta - - - - &reftitle.description; - - arraytrader_beta - arrayreal0 - arrayreal1 - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-bop.xml b/reference/trader/functions/trader-bop.xml deleted file mode 100644 index 3568e98442..0000000000 --- a/reference/trader/functions/trader-bop.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_bop - Balance Of Power - - - - &reftitle.description; - - arraytrader_bop - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cci.xml b/reference/trader/functions/trader-cci.xml deleted file mode 100644 index 88d72b9b13..0000000000 --- a/reference/trader/functions/trader-cci.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cci - Commodity Channel Index - - - - &reftitle.description; - - arraytrader_cci - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdl2crows.xml b/reference/trader/functions/trader-cdl2crows.xml deleted file mode 100644 index 9d8b9de851..0000000000 --- a/reference/trader/functions/trader-cdl2crows.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdl2crows - Two Crows - - - - &reftitle.description; - - arraytrader_cdl2crows - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdl3blackcrows.xml b/reference/trader/functions/trader-cdl3blackcrows.xml deleted file mode 100644 index c03867cbd5..0000000000 --- a/reference/trader/functions/trader-cdl3blackcrows.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdl3blackcrows - Three Black Crows - - - - &reftitle.description; - - arraytrader_cdl3blackcrows - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdl3inside.xml b/reference/trader/functions/trader-cdl3inside.xml deleted file mode 100644 index 5257305a1c..0000000000 --- a/reference/trader/functions/trader-cdl3inside.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - trader_cdl3inside - Three Inside Up/Down - - - - &reftitle.description; - - arraytrader_cdl3inside - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdl3linestrike.xml b/reference/trader/functions/trader-cdl3linestrike.xml deleted file mode 100644 index c42ab78c7d..0000000000 --- a/reference/trader/functions/trader-cdl3linestrike.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdl3linestrike - Three-Line Strike - - - - &reftitle.description; - - arraytrader_cdl3linestrike - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdl3outside.xml b/reference/trader/functions/trader-cdl3outside.xml deleted file mode 100644 index 641fd11f04..0000000000 --- a/reference/trader/functions/trader-cdl3outside.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdl3outside - Three Outside Up/Down - - - - &reftitle.description; - - arraytrader_cdl3outside - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdl3starsinsouth.xml b/reference/trader/functions/trader-cdl3starsinsouth.xml deleted file mode 100644 index 890b41e756..0000000000 --- a/reference/trader/functions/trader-cdl3starsinsouth.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdl3starsinsouth - Three Stars In The South - - - - &reftitle.description; - - arraytrader_cdl3starsinsouth - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdl3whitesoldiers.xml b/reference/trader/functions/trader-cdl3whitesoldiers.xml deleted file mode 100644 index 632de6e459..0000000000 --- a/reference/trader/functions/trader-cdl3whitesoldiers.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdl3whitesoldiers - Three Advancing White Soldiers - - - - &reftitle.description; - - arraytrader_cdl3whitesoldiers - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlabandonedbaby.xml b/reference/trader/functions/trader-cdlabandonedbaby.xml deleted file mode 100644 index cdb9d03c1b..0000000000 --- a/reference/trader/functions/trader-cdlabandonedbaby.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - trader_cdlabandonedbaby - Abandoned Baby - - - - &reftitle.description; - - arraytrader_cdlabandonedbaby - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdladvanceblock.xml b/reference/trader/functions/trader-cdladvanceblock.xml deleted file mode 100644 index d8618e9be3..0000000000 --- a/reference/trader/functions/trader-cdladvanceblock.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdladvanceblock - Advance Block - - - - &reftitle.description; - - arraytrader_cdladvanceblock - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlbelthold.xml b/reference/trader/functions/trader-cdlbelthold.xml deleted file mode 100644 index 865656f833..0000000000 --- a/reference/trader/functions/trader-cdlbelthold.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlbelthold - Belt-hold - - - - &reftitle.description; - - arraytrader_cdlbelthold - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlbreakaway.xml b/reference/trader/functions/trader-cdlbreakaway.xml deleted file mode 100644 index 70137f0d0e..0000000000 --- a/reference/trader/functions/trader-cdlbreakaway.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlbreakaway - Breakaway - - - - &reftitle.description; - - arraytrader_cdlbreakaway - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlclosingmarubozu.xml b/reference/trader/functions/trader-cdlclosingmarubozu.xml deleted file mode 100644 index 73cbba641b..0000000000 --- a/reference/trader/functions/trader-cdlclosingmarubozu.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlclosingmarubozu - Closing Marubozu - - - - &reftitle.description; - - arraytrader_cdlclosingmarubozu - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlconcealbabyswall.xml b/reference/trader/functions/trader-cdlconcealbabyswall.xml deleted file mode 100644 index 621efb50d6..0000000000 --- a/reference/trader/functions/trader-cdlconcealbabyswall.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlconcealbabyswall - Concealing Baby Swallow - - - - &reftitle.description; - - arraytrader_cdlconcealbabyswall - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlcounterattack.xml b/reference/trader/functions/trader-cdlcounterattack.xml deleted file mode 100644 index 459b069bdc..0000000000 --- a/reference/trader/functions/trader-cdlcounterattack.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlcounterattack - Counterattack - - - - &reftitle.description; - - arraytrader_cdlcounterattack - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdldarkcloudcover.xml b/reference/trader/functions/trader-cdldarkcloudcover.xml deleted file mode 100644 index 12ee0060c0..0000000000 --- a/reference/trader/functions/trader-cdldarkcloudcover.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - trader_cdldarkcloudcover - Dark Cloud Cover - - - - &reftitle.description; - - arraytrader_cdldarkcloudcover - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdldoji.xml b/reference/trader/functions/trader-cdldoji.xml deleted file mode 100644 index 6818e7d02c..0000000000 --- a/reference/trader/functions/trader-cdldoji.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdldoji - Doji - - - - &reftitle.description; - - arraytrader_cdldoji - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdldojistar.xml b/reference/trader/functions/trader-cdldojistar.xml deleted file mode 100644 index fa77fdeaa5..0000000000 --- a/reference/trader/functions/trader-cdldojistar.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdldojistar - Doji Star - - - - &reftitle.description; - - arraytrader_cdldojistar - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdldragonflydoji.xml b/reference/trader/functions/trader-cdldragonflydoji.xml deleted file mode 100644 index bfeb73a899..0000000000 --- a/reference/trader/functions/trader-cdldragonflydoji.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdldragonflydoji - Dragonfly Doji - - - - &reftitle.description; - - arraytrader_cdldragonflydoji - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlengulfing.xml b/reference/trader/functions/trader-cdlengulfing.xml deleted file mode 100644 index a22f70d39d..0000000000 --- a/reference/trader/functions/trader-cdlengulfing.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlengulfing - Engulfing Pattern - - - - &reftitle.description; - - arraytrader_cdlengulfing - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdleveningdojistar.xml b/reference/trader/functions/trader-cdleveningdojistar.xml deleted file mode 100644 index 7ecfa109e6..0000000000 --- a/reference/trader/functions/trader-cdleveningdojistar.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - trader_cdleveningdojistar - Evening Doji Star - - - - &reftitle.description; - - arraytrader_cdleveningdojistar - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdleveningstar.xml b/reference/trader/functions/trader-cdleveningstar.xml deleted file mode 100644 index 9565b0e265..0000000000 --- a/reference/trader/functions/trader-cdleveningstar.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - trader_cdleveningstar - Evening Star - - - - &reftitle.description; - - arraytrader_cdleveningstar - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlgapsidesidewhite.xml b/reference/trader/functions/trader-cdlgapsidesidewhite.xml deleted file mode 100644 index 1f0433c9f3..0000000000 --- a/reference/trader/functions/trader-cdlgapsidesidewhite.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlgapsidesidewhite - Up/Down-gap side-by-side white lines - - - - &reftitle.description; - - arraytrader_cdlgapsidesidewhite - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlgravestonedoji.xml b/reference/trader/functions/trader-cdlgravestonedoji.xml deleted file mode 100644 index 7a9cbd2b6c..0000000000 --- a/reference/trader/functions/trader-cdlgravestonedoji.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlgravestonedoji - Gravestone Doji - - - - &reftitle.description; - - arraytrader_cdlgravestonedoji - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlhammer.xml b/reference/trader/functions/trader-cdlhammer.xml deleted file mode 100644 index 85809c38d4..0000000000 --- a/reference/trader/functions/trader-cdlhammer.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlhammer - Hammer - - - - &reftitle.description; - - arraytrader_cdlhammer - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlhangingman.xml b/reference/trader/functions/trader-cdlhangingman.xml deleted file mode 100644 index 924ee4bcc7..0000000000 --- a/reference/trader/functions/trader-cdlhangingman.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlhangingman - Hanging Man - - - - &reftitle.description; - - arraytrader_cdlhangingman - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlharami.xml b/reference/trader/functions/trader-cdlharami.xml deleted file mode 100644 index c64ca05669..0000000000 --- a/reference/trader/functions/trader-cdlharami.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlharami - Harami Pattern - - - - &reftitle.description; - - arraytrader_cdlharami - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlharamicross.xml b/reference/trader/functions/trader-cdlharamicross.xml deleted file mode 100644 index e3425f9620..0000000000 --- a/reference/trader/functions/trader-cdlharamicross.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlharamicross - Harami Cross Pattern - - - - &reftitle.description; - - arraytrader_cdlharamicross - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlhighwave.xml b/reference/trader/functions/trader-cdlhighwave.xml deleted file mode 100644 index 999522fa4e..0000000000 --- a/reference/trader/functions/trader-cdlhighwave.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlhighwave - High-Wave Candle - - - - &reftitle.description; - - arraytrader_cdlhighwave - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlhikkake.xml b/reference/trader/functions/trader-cdlhikkake.xml deleted file mode 100644 index 4d61c79511..0000000000 --- a/reference/trader/functions/trader-cdlhikkake.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlhikkake - Hikkake Pattern - - - - &reftitle.description; - - arraytrader_cdlhikkake - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlhikkakemod.xml b/reference/trader/functions/trader-cdlhikkakemod.xml deleted file mode 100644 index 34824ba9a4..0000000000 --- a/reference/trader/functions/trader-cdlhikkakemod.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlhikkakemod - Modified Hikkake Pattern - - - - &reftitle.description; - - arraytrader_cdlhikkakemod - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlhomingpigeon.xml b/reference/trader/functions/trader-cdlhomingpigeon.xml deleted file mode 100644 index 20540e7b08..0000000000 --- a/reference/trader/functions/trader-cdlhomingpigeon.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlhomingpigeon - Homing Pigeon - - - - &reftitle.description; - - arraytrader_cdlhomingpigeon - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlidentical3crows.xml b/reference/trader/functions/trader-cdlidentical3crows.xml deleted file mode 100644 index e6e5960f02..0000000000 --- a/reference/trader/functions/trader-cdlidentical3crows.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlidentical3crows - Identical Three Crows - - - - &reftitle.description; - - arraytrader_cdlidentical3crows - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlinneck.xml b/reference/trader/functions/trader-cdlinneck.xml deleted file mode 100644 index 40830be668..0000000000 --- a/reference/trader/functions/trader-cdlinneck.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlinneck - In-Neck Pattern - - - - &reftitle.description; - - arraytrader_cdlinneck - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlinvertedhammer.xml b/reference/trader/functions/trader-cdlinvertedhammer.xml deleted file mode 100644 index 8c08d7128e..0000000000 --- a/reference/trader/functions/trader-cdlinvertedhammer.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlinvertedhammer - Marteau inversé - - - - &reftitle.description; - - arraytrader_cdlinvertedhammer - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlkicking.xml b/reference/trader/functions/trader-cdlkicking.xml deleted file mode 100644 index 6b1f5856b0..0000000000 --- a/reference/trader/functions/trader-cdlkicking.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlkicking - Kicking - - - - &reftitle.description; - - arraytrader_cdlkicking - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlkickingbylength.xml b/reference/trader/functions/trader-cdlkickingbylength.xml deleted file mode 100644 index 2c1687ce2e..0000000000 --- a/reference/trader/functions/trader-cdlkickingbylength.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlkickingbylength - Kicking - bull/bear déterminé par le plus long marubozu - - - - &reftitle.description; - - arraytrader_cdlkickingbylength - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlladderbottom.xml b/reference/trader/functions/trader-cdlladderbottom.xml deleted file mode 100644 index 26ea595f4c..0000000000 --- a/reference/trader/functions/trader-cdlladderbottom.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlladderbottom - Bas de l'échelle - - - - &reftitle.description; - - arraytrader_cdlladderbottom - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdllongleggeddoji.xml b/reference/trader/functions/trader-cdllongleggeddoji.xml deleted file mode 100644 index 573c2d7fc2..0000000000 --- a/reference/trader/functions/trader-cdllongleggeddoji.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdllongleggeddoji - Doji : longueur des jambes - - - - &reftitle.description; - - arraytrader_cdllongleggeddoji - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdllongline.xml b/reference/trader/functions/trader-cdllongline.xml deleted file mode 100644 index 96189b7bc4..0000000000 --- a/reference/trader/functions/trader-cdllongline.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdllongline - Long Line Candle - - - - &reftitle.description; - - arraytrader_cdllongline - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlmarubozu.xml b/reference/trader/functions/trader-cdlmarubozu.xml deleted file mode 100644 index 74d142d115..0000000000 --- a/reference/trader/functions/trader-cdlmarubozu.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlmarubozu - Marubozu - - - - &reftitle.description; - - arraytrader_cdlmarubozu - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlmatchinglow.xml b/reference/trader/functions/trader-cdlmatchinglow.xml deleted file mode 100644 index 350d0ba514..0000000000 --- a/reference/trader/functions/trader-cdlmatchinglow.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlmatchinglow - Matching Low - - - - &reftitle.description; - - arraytrader_cdlmatchinglow - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlmathold.xml b/reference/trader/functions/trader-cdlmathold.xml deleted file mode 100644 index 1a6a8f33a7..0000000000 --- a/reference/trader/functions/trader-cdlmathold.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - trader_cdlmathold - Mat Hold - - - - &reftitle.description; - - arraytrader_cdlmathold - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlmorningdojistar.xml b/reference/trader/functions/trader-cdlmorningdojistar.xml deleted file mode 100644 index 763a99f677..0000000000 --- a/reference/trader/functions/trader-cdlmorningdojistar.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - trader_cdlmorningdojistar - Etoile Doji du matin - - - - &reftitle.description; - - arraytrader_cdlmorningdojistar - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlmorningstar.xml b/reference/trader/functions/trader-cdlmorningstar.xml deleted file mode 100644 index 995d56b1e0..0000000000 --- a/reference/trader/functions/trader-cdlmorningstar.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - trader_cdlmorningstar - Etoile du matin - - - - &reftitle.description; - - arraytrader_cdlmorningstar - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlonneck.xml b/reference/trader/functions/trader-cdlonneck.xml deleted file mode 100644 index 286a93fddf..0000000000 --- a/reference/trader/functions/trader-cdlonneck.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlonneck - On-Neck Pattern - - - - &reftitle.description; - - arraytrader_cdlonneck - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlpiercing.xml b/reference/trader/functions/trader-cdlpiercing.xml deleted file mode 100644 index 256281c7db..0000000000 --- a/reference/trader/functions/trader-cdlpiercing.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlpiercing - Piercing Pattern - - - - &reftitle.description; - - arraytrader_cdlpiercing - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlrickshawman.xml b/reference/trader/functions/trader-cdlrickshawman.xml deleted file mode 100644 index 4f3bca96d4..0000000000 --- a/reference/trader/functions/trader-cdlrickshawman.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlrickshawman - Rickshaw Man - - - - &reftitle.description; - - arraytrader_cdlrickshawman - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlrisefall3methods.xml b/reference/trader/functions/trader-cdlrisefall3methods.xml deleted file mode 100644 index eda8cdeb50..0000000000 --- a/reference/trader/functions/trader-cdlrisefall3methods.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlrisefall3methods - Hausse / Baisse - 3 méthodes - - - - &reftitle.description; - - arraytrader_cdlrisefall3methods - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlseparatinglines.xml b/reference/trader/functions/trader-cdlseparatinglines.xml deleted file mode 100644 index f4c5b8a501..0000000000 --- a/reference/trader/functions/trader-cdlseparatinglines.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlseparatinglines - Lignes séparées - - - - &reftitle.description; - - arraytrader_cdlseparatinglines - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlshootingstar.xml b/reference/trader/functions/trader-cdlshootingstar.xml deleted file mode 100644 index 530b37d8a2..0000000000 --- a/reference/trader/functions/trader-cdlshootingstar.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlshootingstar - Etoile filante - - - - &reftitle.description; - - arraytrader_cdlshootingstar - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlshortline.xml b/reference/trader/functions/trader-cdlshortline.xml deleted file mode 100644 index a614515a8f..0000000000 --- a/reference/trader/functions/trader-cdlshortline.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlshortline - Ligne courte de bougie - - - - &reftitle.description; - - arraytrader_cdlshortline - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlspinningtop.xml b/reference/trader/functions/trader-cdlspinningtop.xml deleted file mode 100644 index fcc3cda65b..0000000000 --- a/reference/trader/functions/trader-cdlspinningtop.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlspinningtop - Toupie - - - - &reftitle.description; - - arraytrader_cdlspinningtop - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlstalledpattern.xml b/reference/trader/functions/trader-cdlstalledpattern.xml deleted file mode 100644 index b85ca7a1c7..0000000000 --- a/reference/trader/functions/trader-cdlstalledpattern.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlstalledpattern - Stalled Pattern - - - - &reftitle.description; - - arraytrader_cdlstalledpattern - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlsticksandwich.xml b/reference/trader/functions/trader-cdlsticksandwich.xml deleted file mode 100644 index a0c1a77263..0000000000 --- a/reference/trader/functions/trader-cdlsticksandwich.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlsticksandwich - Sandwich épinglé - - - - &reftitle.description; - - arraytrader_cdlsticksandwich - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdltakuri.xml b/reference/trader/functions/trader-cdltakuri.xml deleted file mode 100644 index 2057245f71..0000000000 --- a/reference/trader/functions/trader-cdltakuri.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdltakuri - Takuri (Dragonfly Doji avec une ombre inférieure très longue) - - - - &reftitle.description; - - arraytrader_cdltakuri - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdltasukigap.xml b/reference/trader/functions/trader-cdltasukigap.xml deleted file mode 100644 index fec77f2dcd..0000000000 --- a/reference/trader/functions/trader-cdltasukigap.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdltasukigap - Ecart Tasuki - - - - &reftitle.description; - - arraytrader_cdltasukigap - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlthrusting.xml b/reference/trader/functions/trader-cdlthrusting.xml deleted file mode 100644 index eef1836f87..0000000000 --- a/reference/trader/functions/trader-cdlthrusting.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlthrusting - Thrusting Pattern - - - - &reftitle.description; - - arraytrader_cdlthrusting - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdltristar.xml b/reference/trader/functions/trader-cdltristar.xml deleted file mode 100644 index f4fb7462f5..0000000000 --- a/reference/trader/functions/trader-cdltristar.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdltristar - Tristar Pattern - - - - &reftitle.description; - - arraytrader_cdltristar - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlunique3river.xml b/reference/trader/functions/trader-cdlunique3river.xml deleted file mode 100644 index ebcee2f283..0000000000 --- a/reference/trader/functions/trader-cdlunique3river.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlunique3river - Unique 3 River - - - - &reftitle.description; - - arraytrader_cdlunique3river - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlupsidegap2crows.xml b/reference/trader/functions/trader-cdlupsidegap2crows.xml deleted file mode 100644 index f8591b7aad..0000000000 --- a/reference/trader/functions/trader-cdlupsidegap2crows.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlupsidegap2crows - Upside Gap Two Crows - - - - &reftitle.description; - - arraytrader_cdlupsidegap2crows - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cdlxsidegap3methods.xml b/reference/trader/functions/trader-cdlxsidegap3methods.xml deleted file mode 100644 index a4f0db84b4..0000000000 --- a/reference/trader/functions/trader-cdlxsidegap3methods.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_cdlxsidegap3methods - Ecart supérieur/inférieur trois méthodes - - - - &reftitle.description; - - arraytrader_cdlxsidegap3methods - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-ceil.xml b/reference/trader/functions/trader-ceil.xml deleted file mode 100644 index 9fa9ac6b69..0000000000 --- a/reference/trader/functions/trader-ceil.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_ceil - Vecteur plafonné - - - - &reftitle.description; - - arraytrader_ceil - arrayreal - - - Calcule l'entier supérieur suivant, pour chaque valeur du paramètre - real et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cmo.xml b/reference/trader/functions/trader-cmo.xml deleted file mode 100644 index 1bd613d28c..0000000000 --- a/reference/trader/functions/trader-cmo.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_cmo - Oscillateur dynamique Chande - - - - &reftitle.description; - - arraytrader_cmo - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-correl.xml b/reference/trader/functions/trader-correl.xml deleted file mode 100644 index 480b6dca94..0000000000 --- a/reference/trader/functions/trader-correl.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_correl - Coefficient de corrélation de Pearson (r) - - - - &reftitle.description; - - arraytrader_correl - arrayreal0 - arrayreal1 - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cos.xml b/reference/trader/functions/trader-cos.xml deleted file mode 100644 index 15693bdba1..0000000000 --- a/reference/trader/functions/trader-cos.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_cos - Vecteur trigonométrique Cos - - - - &reftitle.description; - - arraytrader_cos - arrayreal - - - Calcule le cosinus pour chaque valeur du paramètre - real et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-cosh.xml b/reference/trader/functions/trader-cosh.xml deleted file mode 100644 index bc2a449b4f..0000000000 --- a/reference/trader/functions/trader-cosh.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_cosh - Vecteur trigonométrique Cosh - - - - &reftitle.description; - - arraytrader_cosh - arrayreal - - - Calcule le cosinus hyperbolique pour chaque valeur du paramètre - real et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-dema.xml b/reference/trader/functions/trader-dema.xml deleted file mode 100644 index 3a4e9b5a4b..0000000000 --- a/reference/trader/functions/trader-dema.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_dema - Moyenne mobile exponentielle double - - - - &reftitle.description; - - arraytrader_dema - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-div.xml b/reference/trader/functions/trader-div.xml deleted file mode 100644 index c4a8a8c918..0000000000 --- a/reference/trader/functions/trader-div.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - trader_div - Vecteur arithmétique Div - - - - &reftitle.description; - - arraytrader_div - arrayreal0 - arrayreal1 - - - Divise chaque valeur du paramètre real0 - par la valeur correspondante du paramètre real1 - et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-dx.xml b/reference/trader/functions/trader-dx.xml deleted file mode 100644 index 05b4b70391..0000000000 --- a/reference/trader/functions/trader-dx.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - trader_dx - Indice de mouvement directionnel - - - - &reftitle.description; - - arraytrader_dx - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-ema.xml b/reference/trader/functions/trader-ema.xml deleted file mode 100644 index 53360a31e1..0000000000 --- a/reference/trader/functions/trader-ema.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_ema - Moyenne mobile exponentielle - - - - &reftitle.description; - - arraytrader_ema - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-errno.xml b/reference/trader/functions/trader-errno.xml deleted file mode 100644 index 9312422e74..0000000000 --- a/reference/trader/functions/trader-errno.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - trader_errno - Récupère le code erreur - - - - &reftitle.description; - - inttrader_errno - - - - Récupère le code erreur de la dernière opération. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le code erreur identifié par une des constantes - TRADER_ERR_*. - - - - - diff --git a/reference/trader/functions/trader-exp.xml b/reference/trader/functions/trader-exp.xml deleted file mode 100644 index ed3cd1af3b..0000000000 --- a/reference/trader/functions/trader-exp.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - trader_exp - Vecteur arithmétique Exp - - - - &reftitle.description; - - arraytrader_exp - arrayreal - - - Calcule la constante e élevée à la - puissance de chaque valeur du paramètre real. - Retourne un tableau contenant les données calculées. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-floor.xml b/reference/trader/functions/trader-floor.xml deleted file mode 100644 index adf301525f..0000000000 --- a/reference/trader/functions/trader-floor.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_floor - Niveau du vecteur - - - - &reftitle.description; - - arraytrader_floor - arrayreal - - - Calcule l'entier le plus petit suivant, pour chaque valeur du paramètre - real et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-get-compat.xml b/reference/trader/functions/trader-get-compat.xml deleted file mode 100644 index f223af2521..0000000000 --- a/reference/trader/functions/trader-get-compat.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - trader_get_compat - Récupère le mode de compatibilité - - - - &reftitle.description; - - inttrader_get_compat - - - - Récupère le mode de compatibilité qui affecte la façon dont les - calculs sont effectués par toutes les fonctions de l'extension. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'identifiant du mode de compatibilité, - qui peut être identifié par une série de constantes - TRADER_COMPATIBILITY_*. - - - - - diff --git a/reference/trader/functions/trader-get-unstable-period.xml b/reference/trader/functions/trader-get-unstable-period.xml deleted file mode 100644 index 08d56fddb4..0000000000 --- a/reference/trader/functions/trader-get-unstable-period.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - trader_get_unstable_period - Récupère la période d'instabilité - - - - &reftitle.description; - - inttrader_get_unstable_period - intfunctionId - - - Récupère le facteur d'instabilité de la période pour une fonction - en particulier. - - - - - &reftitle.parameters; - - - functionId - - - Identifiant de la fonction du facteur à lire. - Les constantes de la série - TRADER_FUNC_UNST_* - devraient être utilisées. - - - - - - - - &reftitle.returnvalues; - - Retourne le facteur d'instabilité de la période pour la fonction - correspondante. - - - - - - - diff --git a/reference/trader/functions/trader-ht-dcperiod.xml b/reference/trader/functions/trader-ht-dcperiod.xml deleted file mode 100644 index 17a7b7daeb..0000000000 --- a/reference/trader/functions/trader-ht-dcperiod.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - trader_ht_dcperiod - Transformation de Hilbert - Période de cycle dominant - - - - &reftitle.description; - - arraytrader_ht_dcperiod - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-ht-dcphase.xml b/reference/trader/functions/trader-ht-dcphase.xml deleted file mode 100644 index 794f74e550..0000000000 --- a/reference/trader/functions/trader-ht-dcphase.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - trader_ht_dcphase - Transformation de Hilbert - Phase de cycle dominant - - - - &reftitle.description; - - arraytrader_ht_dcphase - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-ht-phasor.xml b/reference/trader/functions/trader-ht-phasor.xml deleted file mode 100644 index 87d43a0c6b..0000000000 --- a/reference/trader/functions/trader-ht-phasor.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - trader_ht_phasor - Transformation de Hilbert - Composants de la phase - - - - &reftitle.description; - - arraytrader_ht_phasor - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-ht-sine.xml b/reference/trader/functions/trader-ht-sine.xml deleted file mode 100644 index 0902c146c8..0000000000 --- a/reference/trader/functions/trader-ht-sine.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - trader_ht_sine - Transformation de Hilbert - Onde sinusoïdale - - - - &reftitle.description; - - arraytrader_ht_sine - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-ht-trendline.xml b/reference/trader/functions/trader-ht-trendline.xml deleted file mode 100644 index 4ebd4f0889..0000000000 --- a/reference/trader/functions/trader-ht-trendline.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - trader_ht_trendline - Transformation de Hilbert - Tendance instantanée - - - - &reftitle.description; - - arraytrader_ht_trendline - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-ht-trendmode.xml b/reference/trader/functions/trader-ht-trendmode.xml deleted file mode 100644 index 45ade8115b..0000000000 --- a/reference/trader/functions/trader-ht-trendmode.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - trader_ht_trendmode - Transformation de Hilbert - Mode tendance vs mode cycle - - - - &reftitle.description; - - arraytrader_ht_trendmode - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-kama.xml b/reference/trader/functions/trader-kama.xml deleted file mode 100644 index 57341d9cdc..0000000000 --- a/reference/trader/functions/trader-kama.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_kama - Moyenne mobile adaptative Kaufman - - - - &reftitle.description; - - arraytrader_kama - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-linearreg-angle.xml b/reference/trader/functions/trader-linearreg-angle.xml deleted file mode 100644 index 08cd2c8a82..0000000000 --- a/reference/trader/functions/trader-linearreg-angle.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_linearreg_angle - Angle de régression linéaire - - - - &reftitle.description; - - arraytrader_linearreg_angle - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-linearreg-intercept.xml b/reference/trader/functions/trader-linearreg-intercept.xml deleted file mode 100644 index ede5492621..0000000000 --- a/reference/trader/functions/trader-linearreg-intercept.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_linearreg_intercept - Interception de régression linéaire - - - - &reftitle.description; - - arraytrader_linearreg_intercept - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-linearreg-slope.xml b/reference/trader/functions/trader-linearreg-slope.xml deleted file mode 100644 index b3656fc944..0000000000 --- a/reference/trader/functions/trader-linearreg-slope.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_linearreg_slope - Pente de régression linéaire - - - - &reftitle.description; - - arraytrader_linearreg_slope - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-linearreg.xml b/reference/trader/functions/trader-linearreg.xml deleted file mode 100644 index 5b7dfecd53..0000000000 --- a/reference/trader/functions/trader-linearreg.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_linearreg - Régression linéaire - - - - &reftitle.description; - - arraytrader_linearreg - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-ln.xml b/reference/trader/functions/trader-ln.xml deleted file mode 100644 index 765da58401..0000000000 --- a/reference/trader/functions/trader-ln.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_ln - Vecteur de Log naturel - - - - &reftitle.description; - - arraytrader_ln - arrayreal - - - Calcule le logarithme naturel pour chaque valeur du paramètre - real et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-log10.xml b/reference/trader/functions/trader-log10.xml deleted file mode 100644 index 60c591a738..0000000000 --- a/reference/trader/functions/trader-log10.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_log10 - Vecteur Log10 - - - - &reftitle.description; - - arraytrader_log10 - arrayreal - - - Calcule le logarithme base-10 pour chaque valeur du paramètre - real et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-ma.xml b/reference/trader/functions/trader-ma.xml deleted file mode 100644 index 9d9e391058..0000000000 --- a/reference/trader/functions/trader-ma.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_ma - Moyenne mobile - - - - &reftitle.description; - - arraytrader_ma - arrayreal - inttimePeriod - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-macd.xml b/reference/trader/functions/trader-macd.xml deleted file mode 100644 index 552fbd4bf2..0000000000 --- a/reference/trader/functions/trader-macd.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_macd - Moyenne du déplacement Convergence/Divergence - - - - &reftitle.description; - - arraytrader_macd - arrayreal - intfastPeriod - intslowPeriod - intsignalPeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - signalPeriod - - - &trader.arg.signal.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-macdext.xml b/reference/trader/functions/trader-macdext.xml deleted file mode 100644 index 92093523bd..0000000000 --- a/reference/trader/functions/trader-macdext.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - trader_macdext - MACD avec un type MA réglable - - - - &reftitle.description; - - arraytrader_macdext - arrayreal - intfastPeriod - intfastMAType - intslowPeriod - intslowMAType - intsignalPeriod - intsignalMAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - fastMAType - - - &trader.arg.fast.ma.type; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - slowMAType - - - &trader.arg.slow.ma.type; - - - - - signalPeriod - - - &trader.arg.signal.period; - - - - - signalMAType - - - &trader.arg.signal.ma.type; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-macdfix.xml b/reference/trader/functions/trader-macdfix.xml deleted file mode 100644 index 066a8399da..0000000000 --- a/reference/trader/functions/trader-macdfix.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_macdfix - Moyen de déplacement Convergence/Divergence fixé à 12/26 - - - - &reftitle.description; - - arraytrader_macdfix - arrayreal - intsignalPeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - signalPeriod - - - &trader.arg.signal.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-mama.xml b/reference/trader/functions/trader-mama.xml deleted file mode 100644 index d36b54101d..0000000000 --- a/reference/trader/functions/trader-mama.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_mama - MESA moyenne mobile adaptative - - - - &reftitle.description; - - arraytrader_mama - arrayreal - floatfastLimit - floatslowLimit - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastLimit - - - &trader.arg.fast.limit; - - - - - slowLimit - - - &trader.arg.slow.limit; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-mavp.xml b/reference/trader/functions/trader-mavp.xml deleted file mode 100644 index 05e00acb83..0000000000 --- a/reference/trader/functions/trader-mavp.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - trader_mavp - Moyenne mobile avec durée variable - - - - &reftitle.description; - - arraytrader_mavp - arrayreal - arrayperiods - intminPeriod - intmaxPeriod - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - periods - - - &trader.arg.array.of.real.periods; - - - - - minPeriod - - - &trader.arg.min.period; - - - - - maxPeriod - - - &trader.arg.max.period; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-max.xml b/reference/trader/functions/trader-max.xml deleted file mode 100644 index 16cdab55d9..0000000000 --- a/reference/trader/functions/trader-max.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_max - Valeur la plus élevée sur une période déterminée - - - - &reftitle.description; - - arraytrader_max - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-maxindex.xml b/reference/trader/functions/trader-maxindex.xml deleted file mode 100644 index 88863318d0..0000000000 --- a/reference/trader/functions/trader-maxindex.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_maxindex - Indice de la valeur la plus élevée sur une période déterminée - - - - &reftitle.description; - - arraytrader_maxindex - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-medprice.xml b/reference/trader/functions/trader-medprice.xml deleted file mode 100644 index 0b8686eea0..0000000000 --- a/reference/trader/functions/trader-medprice.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_medprice - Prix médian - - - - &reftitle.description; - - arraytrader_medprice - arrayhigh - arraylow - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-mfi.xml b/reference/trader/functions/trader-mfi.xml deleted file mode 100644 index e9a339c73c..0000000000 --- a/reference/trader/functions/trader-mfi.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - trader_mfi - Indice de fluidité de l'argent - - - - &reftitle.description; - - arraytrader_mfi - arrayhigh - arraylow - arrayclose - arrayvolume - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - volume - - - &trader.arg.array.of.real.volume; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-midpoint.xml b/reference/trader/functions/trader-midpoint.xml deleted file mode 100644 index 5e956410ea..0000000000 --- a/reference/trader/functions/trader-midpoint.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_midpoint - Milieu sur la période - - - - &reftitle.description; - - arraytrader_midpoint - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-midprice.xml b/reference/trader/functions/trader-midprice.xml deleted file mode 100644 index eb833ec1fc..0000000000 --- a/reference/trader/functions/trader-midprice.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_midprice - Prix moyen sur la période - - - - &reftitle.description; - - arraytrader_midprice - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-min.xml b/reference/trader/functions/trader-min.xml deleted file mode 100644 index 86a4d771a9..0000000000 --- a/reference/trader/functions/trader-min.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_min - Valeur la plus basse sur une période spécifique - - - - &reftitle.description; - - arraytrader_min - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-minindex.xml b/reference/trader/functions/trader-minindex.xml deleted file mode 100644 index 94b73fda1d..0000000000 --- a/reference/trader/functions/trader-minindex.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_minindex - Indice de la valeur la plus basse sur une période déterminée - - - - &reftitle.description; - - arraytrader_minindex - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-minmax.xml b/reference/trader/functions/trader-minmax.xml deleted file mode 100644 index f4872edfb1..0000000000 --- a/reference/trader/functions/trader-minmax.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_minmax - Valeurs minimales et maximales sur une période donnée - - - - &reftitle.description; - - arraytrader_minmax - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-minmaxindex.xml b/reference/trader/functions/trader-minmaxindex.xml deleted file mode 100644 index cb6532ec2b..0000000000 --- a/reference/trader/functions/trader-minmaxindex.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_minmaxindex - Indices des valeurs minimales et maximales sur une période donnée - - - - &reftitle.description; - - arraytrader_minmaxindex - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-minus-di.xml b/reference/trader/functions/trader-minus-di.xml deleted file mode 100644 index cb8ad4e12c..0000000000 --- a/reference/trader/functions/trader-minus-di.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_minus_di - Indicateur négatif de direction - - - - &reftitle.description; - - arraytrader_minus_di - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-minus-dm.xml b/reference/trader/functions/trader-minus-dm.xml deleted file mode 100644 index ab0ba6bfd6..0000000000 --- a/reference/trader/functions/trader-minus-dm.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_minus_dm - Mouvement directionnel négatif - - - - &reftitle.description; - - arraytrader_minus_dm - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-mom.xml b/reference/trader/functions/trader-mom.xml deleted file mode 100644 index 55dba99e40..0000000000 --- a/reference/trader/functions/trader-mom.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_mom - Elan - - - - &reftitle.description; - - arraytrader_mom - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-mult.xml b/reference/trader/functions/trader-mult.xml deleted file mode 100644 index 05428f7721..0000000000 --- a/reference/trader/functions/trader-mult.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - trader_mult - Vecteur arithmétique mult - - - - &reftitle.description; - - arraytrader_mult - arrayreal0 - arrayreal1 - - - Calcule le produit scalaire vecteur de real0 avec - real1 et retourne le vecteur résultant. - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-natr.xml b/reference/trader/functions/trader-natr.xml deleted file mode 100644 index 902b44fc6a..0000000000 --- a/reference/trader/functions/trader-natr.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_natr - Intervalle réel normalisé moyen - - - - &reftitle.description; - - arraytrader_natr - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-obv.xml b/reference/trader/functions/trader-obv.xml deleted file mode 100644 index 29c2169d25..0000000000 --- a/reference/trader/functions/trader-obv.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - trader_obv - Volume de l'équilibre - - - - &reftitle.description; - - arraytrader_obv - arrayreal - arrayvolume - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - volume - - - &trader.arg.array.of.real.volume; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - diff --git a/reference/trader/functions/trader-plus-di.xml b/reference/trader/functions/trader-plus-di.xml deleted file mode 100644 index dfa168b846..0000000000 --- a/reference/trader/functions/trader-plus-di.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - trader_plus_di - Indicateur positif de direction - - - - &reftitle.description; - - arraytrader_plus_di - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - diff --git a/reference/trader/functions/trader-plus-dm.xml b/reference/trader/functions/trader-plus-dm.xml deleted file mode 100644 index 549a8662c4..0000000000 --- a/reference/trader/functions/trader-plus-dm.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - trader_plus_dm - Mouvement directionnel positif - - - - &reftitle.description; - - arraytrader_plus_dm - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - diff --git a/reference/trader/functions/trader-ppo.xml b/reference/trader/functions/trader-ppo.xml deleted file mode 100644 index c70b2dfd7f..0000000000 --- a/reference/trader/functions/trader-ppo.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - trader_ppo - Oscillateur de prix en pourcentage - - - - &reftitle.description; - - arraytrader_ppo - arrayreal - intfastPeriod - intslowPeriod - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - diff --git a/reference/trader/functions/trader-roc.xml b/reference/trader/functions/trader-roc.xml deleted file mode 100644 index 53ae384bbf..0000000000 --- a/reference/trader/functions/trader-roc.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - trader_roc - Taux de variation : ((price/prevPrice)-1)*100 - - - - &reftitle.description; - - arraytrader_roc - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - diff --git a/reference/trader/functions/trader-rocp.xml b/reference/trader/functions/trader-rocp.xml deleted file mode 100644 index 0698e4dbe9..0000000000 --- a/reference/trader/functions/trader-rocp.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - trader_rocp - Taux de variation en pourcentage : (price-prevPrice)/prevPrice - - - - &reftitle.description; - - arraytrader_rocp - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - diff --git a/reference/trader/functions/trader-rocr.xml b/reference/trader/functions/trader-rocr.xml deleted file mode 100644 index a44b6fddb4..0000000000 --- a/reference/trader/functions/trader-rocr.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - trader_rocr - Taux de rapport de changement : (price/prevPrice) - - - - &reftitle.description; - - arraytrader_rocr - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - diff --git a/reference/trader/functions/trader-rocr100.xml b/reference/trader/functions/trader-rocr100.xml deleted file mode 100644 index eb32f78a26..0000000000 --- a/reference/trader/functions/trader-rocr100.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - trader_rocr100 - Taux de taux de variation de l'échelle de 100 : (price/prevPrice)*100 - - - - &reftitle.description; - - arraytrader_rocr100 - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - diff --git a/reference/trader/functions/trader-rsi.xml b/reference/trader/functions/trader-rsi.xml deleted file mode 100644 index fad2f51791..0000000000 --- a/reference/trader/functions/trader-rsi.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_rsi - Indice de force relative - - - - &reftitle.description; - - arraytrader_rsi - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-sar.xml b/reference/trader/functions/trader-sar.xml deleted file mode 100644 index 9c56a6f24a..0000000000 --- a/reference/trader/functions/trader-sar.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - trader_sar - Parabolique SAR - - - - &reftitle.description; - - arraytrader_sar - arrayhigh - arraylow - floatacceleration - floatmaximum - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - acceleration - - - Facteur d'accélération utilisé sur la valeur maximale. - Intervalle valide : de 0 à TRADER_REAL_MAX. - - - - - maximum - - - Valeur maximale du facteur d'accélération. - Intervalle valide : de 0 à TRADER_REAL_MAX. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-sarext.xml b/reference/trader/functions/trader-sarext.xml deleted file mode 100644 index b1fd1d703a..0000000000 --- a/reference/trader/functions/trader-sarext.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - - trader_sarext - Parabolique SAR - Etendu - - - - &reftitle.description; - - arraytrader_sarext - arrayhigh - arraylow - floatstartValue - floatoffsetOnReverse - floataccelerationInitLong - floataccelerationLong - floataccelerationMaxLong - floataccelerationInitShort - floataccelerationShort - floataccelerationMaxShort - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - startValue - - - Valeur et direction de départ. 0 pour Auto, >0 pour Long, - <0 pour Short. - Intervalle valide : de TRADER_REAL_MIN - à TRADER_REAL_MAX. - - - - - offsetOnReverse - - - Pourcentage de décalage ajouté/retiré de l'arrêt initial - lors d'une inversion courte/longue. - Intervalle valide : de 0 à TRADER_REAL_MAX. - - - - - accelerationInitLong - - - Valeur initiale du facteur d'accélération pour la direction Long. - Intervalle valide : de 0 à TRADER_REAL_MAX. - - - - - accelerationLong - - - Facteur d'accélération pour la direction Long. - Intervalle valide : de 0 à TRADER_REAL_MAX. - - - - - accelerationMaxLong - - - Valeur maximale du facteur d'accélération pour la direction Long. - Intervalle valide : de 0 à TRADER_REAL_MAX. - - - - - accelerationInitShort - - - Valeur initiale du facteur d'accélération pour la direction Short. - Intervalle valide : de 0 à TRADER_REAL_MAX. - - - - - accelerationShort - - - Facteur d'accélération pour la direction Short. - Intervalle valide : de 0 à TRADER_REAL_MAX. - - - - - accelerationMaxShort - - - Valeur maximale du facteur d'accélération pour la direction Short. - Intervalle valide : de 0 à TRADER_REAL_MAX. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-set-compat.xml b/reference/trader/functions/trader-set-compat.xml deleted file mode 100644 index 2ae5fe69a1..0000000000 --- a/reference/trader/functions/trader-set-compat.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - trader_set_compat - Définit le mode de compatibilité - - - - &reftitle.description; - - voidtrader_set_compat - intcompatId - - - Définit le mode de compatibilité qui va affecter la façon dont les - calculs vont être effectués par toutes les fonctions de l'extension. - - - - - &reftitle.parameters; - - - compatId - - - Identifiant de compatibilité. - Les constantes de la série - TRADER_COMPATIBILITY_* - devraient être utilisées. - - - - - - - - &reftitle.returnvalues; - &return.void; - - - - - - diff --git a/reference/trader/functions/trader-set-unstable-period.xml b/reference/trader/functions/trader-set-unstable-period.xml deleted file mode 100644 index 12d44ad7ba..0000000000 --- a/reference/trader/functions/trader-set-unstable-period.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - trader_set_unstable_period - Définit une période instable - - - - &reftitle.description; - - voidtrader_set_unstable_period - intfunctionId - inttimePeriod - - - Influence le facteur instable d'une période pour les fonctions qui - en sont sensibles. Plus d'informations concernant les périodes instables - peuvent être trouvées sur la page de la documentation de l'API - TA-Lib. - - - - - &reftitle.parameters; - - - functionId - - - Identifiant de la fonction du facteur à définir. - Les constantes de la série - TRADER_FUNC_UNST_* - peuvent être utilisées pour affecter la fonction correspondante. - - - - - timePeriod - - - Valeur d'instabilité de la période. - - - - - - - - &reftitle.returnvalues; - &return.void; - - - - - - diff --git a/reference/trader/functions/trader-sin.xml b/reference/trader/functions/trader-sin.xml deleted file mode 100644 index 7e064043e2..0000000000 --- a/reference/trader/functions/trader-sin.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_sin - Vecteur trigonométrique sin - - - - &reftitle.description; - - arraytrader_sin - arrayreal - - - Calcule le sinus de chaque valeur de - real et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-sinh.xml b/reference/trader/functions/trader-sinh.xml deleted file mode 100644 index 7e46c43517..0000000000 --- a/reference/trader/functions/trader-sinh.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_sinh - Vecteur trigonométrique sinh - - - - &reftitle.description; - - arraytrader_sinh - arrayreal - - - Calcule le sinus hyperbolique pour chaque valeur de - real et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-sma.xml b/reference/trader/functions/trader-sma.xml deleted file mode 100644 index f1322f3c03..0000000000 --- a/reference/trader/functions/trader-sma.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_sma - Moyenne mobile simple - - - - &reftitle.description; - - arraytrader_sma - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-sqrt.xml b/reference/trader/functions/trader-sqrt.xml deleted file mode 100644 index 972ea27072..0000000000 --- a/reference/trader/functions/trader-sqrt.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_sqrt - Vecteur de racine carrée - - - - &reftitle.description; - - arraytrader_sqrt - arrayreal - - - Calcule la racine carrée de chaque valeur de - real et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-stddev.xml b/reference/trader/functions/trader-stddev.xml deleted file mode 100644 index be347840a0..0000000000 --- a/reference/trader/functions/trader-stddev.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_stddev - Déviation standard - - - - &reftitle.description; - - arraytrader_stddev - arrayreal - inttimePeriod - floatnbDev - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - nbDev - - - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-stoch.xml b/reference/trader/functions/trader-stoch.xml deleted file mode 100644 index a1f600c7fb..0000000000 --- a/reference/trader/functions/trader-stoch.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - trader_stoch - Stochastique - - - - &reftitle.description; - - arraytrader_stoch - arrayhigh - arraylow - arrayclose - intfastK_Period - intslowK_Period - intslowK_MAType - intslowD_Period - intslowD_MAType - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - fastK_Period - - - &trader.arg.fastk.period; - - - - - slowK_Period - - - &trader.arg.slowk.period; - - - - - slowK_MAType - - - &trader.arg.slowk.ma.type; - - - - - slowD_Period - - - &trader.arg.slowd.period; - - - - - slowD_MAType - - - &trader.arg.slowd.ma.type; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-stochf.xml b/reference/trader/functions/trader-stochf.xml deleted file mode 100644 index 64e8eee7fd..0000000000 --- a/reference/trader/functions/trader-stochf.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - trader_stochf - Rapidité stochastique - - - - &reftitle.description; - - arraytrader_stochf - arrayhigh - arraylow - arrayclose - intfastK_Period - intfastD_Period - intfastD_MAType - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - fastK_Period - - - &trader.arg.fastk.period; - - - - - fastD_Period - - - &trader.arg.fastd.period; - - - - - fastD_MAType - - - &trader.arg.fastd.ma.type; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-stochrsi.xml b/reference/trader/functions/trader-stochrsi.xml deleted file mode 100644 index e4c178b07b..0000000000 --- a/reference/trader/functions/trader-stochrsi.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - trader_stochrsi - Index stochastique relatif fort - - - - &reftitle.description; - - arraytrader_stochrsi - arrayreal - inttimePeriod - intfastK_Period - intfastD_Period - intfastD_MAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - fastK_Period - - - &trader.arg.fastk.period; - - - - - fastD_Period - - - &trader.arg.fastd.period; - - - - - fastD_MAType - - - &trader.arg.fastd.ma.type; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-sub.xml b/reference/trader/functions/trader-sub.xml deleted file mode 100644 index 79b6dffdc4..0000000000 --- a/reference/trader/functions/trader-sub.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - trader_sub - Vecteur de soustraction arithmétique - - - - &reftitle.description; - - arraytrader_sub - arrayreal0 - arrayreal1 - - - Calcule la soustraction vectorielle de real1 depuis - real0 et retourne le vecteur résultant. - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-sum.xml b/reference/trader/functions/trader-sum.xml deleted file mode 100644 index 89e5b68e73..0000000000 --- a/reference/trader/functions/trader-sum.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_sum - Sommation - - - - &reftitle.description; - - arraytrader_sum - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-t3.xml b/reference/trader/functions/trader-t3.xml deleted file mode 100644 index dacf2ec873..0000000000 --- a/reference/trader/functions/trader-t3.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_t3 - Triple moyenne mobile exponentielle (T3) - - - - &reftitle.description; - - arraytrader_t3 - arrayreal - inttimePeriod - floatvFactor - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - vFactor - - - &trader.arg.vfactor; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-tan.xml b/reference/trader/functions/trader-tan.xml deleted file mode 100644 index 314870dd98..0000000000 --- a/reference/trader/functions/trader-tan.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_tan - Vecteur trigonométrique Tan - - - - &reftitle.description; - - arraytrader_tan - arrayreal - - - Calcule la tangente pour chaque valeur du paramètre - real et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-tanh.xml b/reference/trader/functions/trader-tanh.xml deleted file mode 100644 index 50f31e870e..0000000000 --- a/reference/trader/functions/trader-tanh.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - trader_tanh - Vecteur trigonométrique Tanh - - - - &reftitle.description; - - arraytrader_tanh - arrayreal - - - Calcule la tangente hyperbolique pour chaque valeur du paramètre - real et retourne le tableau résultant. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-tema.xml b/reference/trader/functions/trader-tema.xml deleted file mode 100644 index 572d036de2..0000000000 --- a/reference/trader/functions/trader-tema.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_tema - Triple moyenne mobile exponentielle - - - - &reftitle.description; - - arraytrader_tema - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-trange.xml b/reference/trader/functions/trader-trange.xml deleted file mode 100644 index c3519125e7..0000000000 --- a/reference/trader/functions/trader-trange.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_trange - Intervalle réel - - - - &reftitle.description; - - arraytrader_trange - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-trima.xml b/reference/trader/functions/trader-trima.xml deleted file mode 100644 index b31d6d3cb5..0000000000 --- a/reference/trader/functions/trader-trima.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_trima - Moyenne mobile triangulaire - - - - &reftitle.description; - - arraytrader_trima - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-trix.xml b/reference/trader/functions/trader-trix.xml deleted file mode 100644 index 0ab284df21..0000000000 --- a/reference/trader/functions/trader-trix.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_trix - Taux de variation sur une journée (ROC) d'un triple EMA lissé - - - - &reftitle.description; - - arraytrader_trix - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-tsf.xml b/reference/trader/functions/trader-tsf.xml deleted file mode 100644 index ebb8fb40a4..0000000000 --- a/reference/trader/functions/trader-tsf.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_tsf - Prévisions des séries chronologiques - - - - &reftitle.description; - - arraytrader_tsf - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-typprice.xml b/reference/trader/functions/trader-typprice.xml deleted file mode 100644 index 004b0e7097..0000000000 --- a/reference/trader/functions/trader-typprice.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_typprice - Prix typique - - - - &reftitle.description; - - arraytrader_typprice - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-ultosc.xml b/reference/trader/functions/trader-ultosc.xml deleted file mode 100644 index 949c76d3be..0000000000 --- a/reference/trader/functions/trader-ultosc.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - - trader_ultosc - Oscillateur ultime - - - - &reftitle.description; - - arraytrader_ultosc - arrayhigh - arraylow - arrayclose - inttimePeriod1 - inttimePeriod2 - inttimePeriod3 - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod1 - - - Nombres de barres pour la première période. - Intervalle valide : de 1 à 100000. - - - - - timePeriod2 - - - Nombres de barres pour la seconde période. - Intervalle valide : de 1 à 100000. - - - - - timePeriod3 - - - Nombres de barres pour la troisième période. - Intervalle valide : de 1 à 100000. - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-var.xml b/reference/trader/functions/trader-var.xml deleted file mode 100644 index 963fdc605c..0000000000 --- a/reference/trader/functions/trader-var.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_var - Variance - - - - &reftitle.description; - - arraytrader_var - arrayreal - inttimePeriod - floatnbDev - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - nbDev - - - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-wclprice.xml b/reference/trader/functions/trader-wclprice.xml deleted file mode 100644 index 8f05e9f030..0000000000 --- a/reference/trader/functions/trader-wclprice.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - trader_wclprice - Prix clos pondéré - - - - &reftitle.description; - - arraytrader_wclprice - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-willr.xml b/reference/trader/functions/trader-willr.xml deleted file mode 100644 index a124313f59..0000000000 --- a/reference/trader/functions/trader-willr.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - trader_willr - Williams' %R - - - - &reftitle.description; - - arraytrader_willr - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/functions/trader-wma.xml b/reference/trader/functions/trader-wma.xml deleted file mode 100644 index c7deec9c66..0000000000 --- a/reference/trader/functions/trader-wma.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - trader_wma - Moyenne mobile pondérée - - - - &reftitle.description; - - arraytrader_wma - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec les données calculées, - ou &false; si une erreur survient. - - - - - - - diff --git a/reference/trader/ini.xml b/reference/trader/ini.xml deleted file mode 100644 index c5d06614ac..0000000000 --- a/reference/trader/ini.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; Trader - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - trader.real_precision - 3 - INI_ALL - Depuis trader 0.2.1 - - - trader.real_round_mode - HALF_DOWN - INI_ALL - Depuis trader 0.3.0 - - - -
    -     - - &ini.descriptions.title; - - - - - - trader.real_precision - int - - - - Toutes les valeurs des tableaux retournés seront arrondies à cette précision. - Cependant, les calculs dans la TA-Lib sont effectués avec des valeurs non-arrondies. - - - - - - trader.real_round_mode - string - - - - Contrôle la politique d'arrondissement des réels trader. - Les valeurs valides sont HALF_UP, - HALF_DOWN, HALF_EVEN - et HALF_ODD. - Le comportement est identique à la fonction - round() utilisée avec l'argument - mode. - - - - - - -
    - - diff --git a/reference/trader/reference.xml b/reference/trader/reference.xml deleted file mode 100644 index 9ae9af7ec3..0000000000 --- a/reference/trader/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; Trader - - &reference.trader.entities.functions; - - - - diff --git a/reference/trader/setup.xml b/reference/trader/setup.xml deleted file mode 100644 index 5b62906ebf..0000000000 --- a/reference/trader/setup.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - L'extension trader est basée sur - TA-Lib. - TA-Lib est totalement intégré dans l'extension, aussi, aucune - bibliothèque externe n'est nécessaire. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;trader. - -
    - - - &reference.trader.ini; - - - - -     - - diff --git a/reference/ui/book.xml b/reference/ui/book.xml deleted file mode 100644 index 150a1516f4..0000000000 --- a/reference/ui/book.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - - UI - UI - - - &reftitle.intro; - - &warn.experimental; - Cette extension encapsule libui - pour fournir une API orientée objet destinée au développement multiplateforme - d'interfaces utilisateur natives avec un look-and-feel authentique. - - - - &reference.ui.setup; - - - &reference.ui.ui.point; - &reference.ui.ui.size; - - &reference.ui.ui.window; - &reference.ui.ui.control; - &reference.ui.ui.menu; - &reference.ui.ui.menuitem; - &reference.ui.ui.area; - &reference.ui.ui.executor; - - &reference.ui.ui.controls.tab; - &reference.ui.ui.controls.check; - &reference.ui.ui.controls.button; - &reference.ui.ui.controls.colorbutton; - &reference.ui.ui.controls.label; - &reference.ui.ui.controls.entry; - &reference.ui.ui.controls.multilineentry; - &reference.ui.ui.controls.spin; - &reference.ui.ui.controls.slider; - &reference.ui.ui.controls.progress; - &reference.ui.ui.controls.separator; - &reference.ui.ui.controls.combo; - &reference.ui.ui.controls.editablecombo; - &reference.ui.ui.controls.radio; - &reference.ui.ui.controls.picker; - - &reference.ui.ui.controls.form; - &reference.ui.ui.controls.grid; - &reference.ui.ui.controls.group; - &reference.ui.ui.controls.box; - - &reference.ui.ui.draw.pen; - &reference.ui.ui.draw.path; - &reference.ui.ui.draw.matrix; - &reference.ui.ui.draw.color; - &reference.ui.ui.draw.stroke; - &reference.ui.ui.draw.brush; - &reference.ui.ui.draw.brush.gradient; - &reference.ui.ui.draw.brush.lineargradient; - &reference.ui.ui.draw.brush.radialgradient; - - &reference.ui.ui.draw.text.layout; - &reference.ui.ui.draw.text.font; - &reference.ui.ui.draw.text.font.descriptor; - - &reference.ui.reference; - - &reference.ui.ui.draw.text.font.weight; - &reference.ui.ui.draw.text.font.italic; - &reference.ui.ui.draw.text.font.stretch; - &reference.ui.ui.draw.line.cap; - &reference.ui.ui.draw.line.join; - &reference.ui.ui.key; - - &reference.ui.ui.exception.invalidargumentexception; - &reference.ui.ui.exception.runtimeexception; - - - diff --git a/reference/ui/configure.xml b/reference/ui/configure.xml deleted file mode 100644 index 38ae32d39d..0000000000 --- a/reference/ui/configure.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - -
    - &reftitle.install; - - - Utiliser l'option lors de la compilation PHP. - - - - Les utilisateurs de Windows doivent inclure php_ui.dll dans le fichier &php.ini; - - -
    - - - diff --git a/reference/ui/functions/ui.draw.text.font.fontfamilies.xml b/reference/ui/functions/ui.draw.text.font.fontfamilies.xml deleted file mode 100644 index 34b1ac6716..0000000000 --- a/reference/ui/functions/ui.draw.text.font.fontfamilies.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - UI\Draw\Text\Font\fontFamilies - Récupère les familles de polices - - - - &reftitle.description; - - arrayUI\Draw\Text\Font\fontFamilies - - - - Retourne un tableau des familles de polices valides pour le système actuel - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &array; des familles de polices valides pour le système actuel. - - - - - - diff --git a/reference/ui/functions/ui.quit.xml b/reference/ui/functions/ui.quit.xml deleted file mode 100644 index 10e4a63156..0000000000 --- a/reference/ui/functions/ui.quit.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\quit - Quitte la boucle UI - - - - &reftitle.description; - - voidUI\quit - - - - Doit faire arrêter la boucle principale - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/functions/ui.run.xml b/reference/ui/functions/ui.run.xml deleted file mode 100644 index eb7588e28f..0000000000 --- a/reference/ui/functions/ui.run.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - UI\run - Entre dans la boucle UI - - - - &reftitle.description; - - voidUI\run - intflags - - - Doit pousser PHP à entrer dans la boucle principale. Par défaut, le contrôle ne sera pas retourné à la fonction appelante. - - - - - - &reftitle.parameters; - - - flags - - - Mettre UI\Loop pour retourner le contrôle et UI\Wait pour retourner le contrôle après l'attente. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/reference.xml b/reference/ui/reference.xml deleted file mode 100644 index d832fbe6d9..0000000000 --- a/reference/ui/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - UI &Functions; - - &reference.ui.entities.functions; - - - - diff --git a/reference/ui/setup.xml b/reference/ui/setup.xml deleted file mode 100644 index f533fb489a..0000000000 --- a/reference/ui/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - L'installation nécessite la bibliothèque libui et PHP 7 ou une version plus récente. - - - Cette extension nécessite l'installation de la bibliothèque libui - version 0.1.0 ou une version plus récente. Consulter la documentation libui pour obtenir une liste des prérequis. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;ui. - - - &pecl.windows.download.avail; - -
    - -     - - diff --git a/reference/ui/ui.area.xml b/reference/ui/ui.area.xml deleted file mode 100644 index a3b0afce69..0000000000 --- a/reference/ui/ui.area.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - Area - UI\Area - - - - -
    - &reftitle.intro; - - Une aire (Area) représente un canevas sur lequel on peut dessiner et répondre aux événements de souris et de clavier. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Area - - - - - UI\Area - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Area::Ctrl - - - const - int - UI\Area::Alt - - - const - int - UI\Area::Shift - - - const - int - UI\Area::Super - - - const - int - UI\Area::Down - - - const - int - UI\Area::Up - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Area::Ctrl - - - Doit être défini dans les modificateurs passés aux événements - de clavier et de souris lorsque la touche CTRL est active - - - - - - UI\Area::Alt - - - Doit être défini dans les modificateurs passés aux événements - de clavier et de souris lorsque la touche ALT est active - - - - - - UI\Area::Shift - - - Doit être défini dans les modificateurs passés aux événements - de clavier et de souris lorsque la touche SHIFT est active - - - - - - UI\Area::Super - - - - - - - UI\Area::Down - - Doit être défini dans les modificateurs passés aux événements de clavier et de souris - - - - - UI\Area::Up - - Doit être défini dans les modificateurs passés aux événements de clavier et de souris - - - - -
    - - - -     - - &reference.ui.ui.entities.area; - -     - - diff --git a/reference/ui/ui.control.xml b/reference/ui/ui.control.xml deleted file mode 100644 index dc770c1088..0000000000 --- a/reference/ui/ui.control.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Contrôle - UI\Control - - - - -
    - &reftitle.intro; - - Cette classe est la classe de base fermée pour tous les contrôles UI. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Control - - - - - final - UI\Control - - - - - &Methods; - - - - -
    - -     - - &reference.ui.ui.entities.control; - -     - - diff --git a/reference/ui/ui.controls.box.xml b/reference/ui/ui.controls.box.xml deleted file mode 100644 index 7eb2e5e849..0000000000 --- a/reference/ui/ui.controls.box.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - Boîte de Contrôle (Arrangement) - UI\Controls\Box - - - - -
    - &reftitle.intro; - - Une boîte (Box) permet l'arrangement d'autres contrôles - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Box - - - - - UI\Controls\Box - - - - extends - UI\Control - - - - - &Constants; - - const - int - UI\Controls\Box::Vertical - - - const - int - UI\Controls\Box::Horizontal - - - &Properties; - - protected - controls - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - controls - - - Contient les contrôles, ne doit pas être manipulé directement - - - - -
    - - - -
    - &reftitle.constants; - - - - UI\Controls\Box::Vertical - - - - - - - UI\Controls\Box::Horizontal - - - - - - -
    - - - -     - - &reference.ui.ui.controls.entities.box; - -     - - diff --git a/reference/ui/ui.controls.button.xml b/reference/ui/ui.controls.button.xml deleted file mode 100644 index e74f2fc3f4..0000000000 --- a/reference/ui/ui.controls.button.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Bouton de Contrôle - UI\Controls\Button - - - - -
    - &reftitle.intro; - - Représente un bouton (Button) cliquable étiqueté - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Button - - - - - UI\Controls\Button - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.controls.entities.button; - -     - - diff --git a/reference/ui/ui.controls.check.xml b/reference/ui/ui.controls.check.xml deleted file mode 100644 index 37107e6811..0000000000 --- a/reference/ui/ui.controls.check.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Case à cocher de Contrôle - UI\Controls\Check - - - - -
    - &reftitle.intro; - - Une Case à cocher (Check) est une boîte à cocher étiquetée - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Check - - - - - UI\Controls\Check - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.controls.entities.check; - -     - - diff --git a/reference/ui/ui.controls.colorbutton.xml b/reference/ui/ui.controls.colorbutton.xml deleted file mode 100644 index a95ad0fd1f..0000000000 --- a/reference/ui/ui.controls.colorbutton.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Bouton de couleur de Contrôle - UI\Controls\ColorButton - - - - -
    - &reftitle.intro; - - Un bouton de couleur (ColorButton) est un bouton qui affiche un sélecteur de couleur lorsqu'il est cliqué - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\ColorButton - - - - - UI\Controls\ColorButton - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.controls.entities.colorbutton; - -     - - diff --git a/reference/ui/ui.controls.combo.xml b/reference/ui/ui.controls.combo.xml deleted file mode 100644 index b867181afa..0000000000 --- a/reference/ui/ui.controls.combo.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Boîte de combinaison de Contrôle - UI\Controls\Combo - - - - -
    - &reftitle.intro; - - Une boîte de combinaison (Combo) représente une liste d'options, comme l'élément select HTML familier. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Combo - - - - - UI\Controls\Combo - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.controls.entities.combo; - -     - - diff --git a/reference/ui/ui.controls.editablecombo.xml b/reference/ui/ui.controls.editablecombo.xml deleted file mode 100644 index 5fc7cac767..0000000000 --- a/reference/ui/ui.controls.editablecombo.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Boîte de combinaison éditable de Contrôle - UI\Controls\EditableCombo - - - - -
    - &reftitle.intro; - - Une boîte de combinaison éditable (Editable Combo) est un Combo qui permet à l'utilisateur de saisir des options personnalisées - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\EditableCombo - - - - - UI\Controls\EditableCombo - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.controls.entities.editablecombo; - -     - - diff --git a/reference/ui/ui.controls.entry.xml b/reference/ui/ui.controls.entry.xml deleted file mode 100644 index c52c9566df..0000000000 --- a/reference/ui/ui.controls.entry.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - Entrée de Contrôle - UI\Controls\Entry - - - - -
    - &reftitle.intro; - - Une entrée (Entry) est un contrôle de saisie de texte, adapté pour entrer du texte brut, des mots de passe, ou des termes de recherche. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Entry - - - - - UI\Controls\Entry - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\Entry::Normal - - - const - int - UI\Controls\Entry::Password - - - const - int - UI\Controls\Entry::Search - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\Entry::Normal - - Une entrée normale simple - - - - - UI\Controls\Entry::Password - - Une entrée de mot de passe - - - - - UI\Controls\Entry::Search - - Une entrée de recherche - - - - -
    - - - -     - - &reference.ui.ui.controls.entities.entry; - -     - - diff --git a/reference/ui/ui.controls.form.xml b/reference/ui/ui.controls.form.xml deleted file mode 100644 index 071f0bffe0..0000000000 --- a/reference/ui/ui.controls.form.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Formulaire de Contrôle (Arrangement) - UI\Controls\Form - - - - -
    - &reftitle.intro; - - Un formulaire (Form) est un contrôle qui permet l'arrangement d'autres contrôles dans une disposition familière (le formulaire). - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Form - - - - - UI\Controls\Form - - - - extends - UI\Control - - - - - &Properties; - - protected - controls - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - &reftitle.properties; - - - controls - - - Contient des contrôles, ne doit pas être manipulé directement - - - - -
    - - -
    - -     - - &reference.ui.ui.controls.entities.form; - -     - - diff --git a/reference/ui/ui.controls.grid.xml b/reference/ui/ui.controls.grid.xml deleted file mode 100644 index 9649282dd2..0000000000 --- a/reference/ui/ui.controls.grid.xml +++ /dev/null @@ -1,204 +0,0 @@ - - - - - Grille de Contrôle (Arrangement) - UI\Controls\Grid - - - - -
    - &reftitle.intro; - - Une grille (Grid) est un contrôle qui permet l'arrangement des enfants dans une grille - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Grid - - - - - UI\Controls\Grid - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\Grid::Fill - - - const - int - UI\Controls\Grid::Start - - - const - int - UI\Controls\Grid::Center - - - const - int - UI\Controls\Grid::End - - - const - int - UI\Controls\Grid::Leading - - - const - int - UI\Controls\Grid::Top - - - const - int - UI\Controls\Grid::Trailing - - - const - int - UI\Controls\Grid::Bottom - - - &Properties; - - protected - controls - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\Grid::Fill - - - - - - - UI\Controls\Grid::Start - - - - - - - UI\Controls\Grid::Center - - - - - - - UI\Controls\Grid::End - - - - - - - UI\Controls\Grid::Leading - - - - - - - UI\Controls\Grid::Top - - - - - - - UI\Controls\Grid::Trailing - - - - - - - UI\Controls\Grid::Bottom - - - - - - -
    - - - -
    - &reftitle.properties; - - - controls - - - Contient des contrôles, ne doit pas être manipulé directement - - - - -
    - - - -     - - &reference.ui.ui.controls.entities.grid; - -     - - diff --git a/reference/ui/ui.controls.group.xml b/reference/ui/ui.controls.group.xml deleted file mode 100644 index bb7cda72a1..0000000000 --- a/reference/ui/ui.controls.group.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - Groupe de Contrôle (Arrangement) - UI\Controls\Group - - - - -
    - &reftitle.intro; - - Un groupe (Group) est un conteneur titré pour les contrôles enfants - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Group - - - - - UI\Controls\Group - - - - extends - UI\Control - - - - - &Properties; - - protected - controls - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - controls - - - Contient des contrôles, ne doit pas être manipulé directement - - - - -
    - - -     - - &reference.ui.ui.controls.entities.group; - -     - - diff --git a/reference/ui/ui.controls.label.xml b/reference/ui/ui.controls.label.xml deleted file mode 100644 index add7a7ff29..0000000000 --- a/reference/ui/ui.controls.label.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Etiquette de Contrôle - UI\Controls\Label - - - - -
    - &reftitle.intro; - - Une étiquette (Label) est une ligne de texte unique, destinée à identifier, pour l'utilisateur, un élément de l'interface. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Label - - - - - UI\Controls\Label - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.controls.entities.label; - -     - - diff --git a/reference/ui/ui.controls.multilineentry.xml b/reference/ui/ui.controls.multilineentry.xml deleted file mode 100644 index b1c22a6474..0000000000 --- a/reference/ui/ui.controls.multilineentry.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - Une entrée multiligne de Contrôle - UI\Controls\MultilineEntry - - - - -
    - &reftitle.intro; - - Une entrée multiligne (Multiline Entry) est un contrôle d'entrée de texte capable de contenir plusieurs lignes de texte, avec ou sans retour à la ligne. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\MultilineEntry - - - - - UI\Controls\MultilineEntry - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\MultilineEntry::Wrap - - - const - int - UI\Controls\MultilineEntry::NoWrap - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\MultilineEntry::Wrap - - Permettre aux lignes de se retourner - - - - - UI\Controls\MultilineEntry::NoWrap - - Ne pas permettre aux lignes de se retourner - - - - -
    - - - -     - - &reference.ui.ui.controls.entities.multilineentry; - -     - - diff --git a/reference/ui/ui.controls.picker.xml b/reference/ui/ui.controls.picker.xml deleted file mode 100644 index cbe38ede57..0000000000 --- a/reference/ui/ui.controls.picker.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - Selecteur de Contrôle - UI\Controls\Picker - - - - -
    - &reftitle.intro; - - Un selecteur (Picker) représente un bouton qui, lorsqu'il est cliqué, présente une interface native de sélection de Date/Heure/DateHeure à l'utilisateur. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Picker - - - - - UI\Controls\Picker - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\Picker::Date - - - const - int - UI\Controls\Picker::Time - - - const - int - UI\Controls\Picker::DateTime - - - Constructor - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\Picker::Date - - Un selecteur de Date - - - - - UI\Controls\Picker::Time - - Un selecteur de Temps - - - - - UI\Controls\Picker::DateTime - - Un selecteur de Date et Temps - - - - -
    - - - -     - - &reference.ui.ui.controls.entities.picker; - -     - - diff --git a/reference/ui/ui.controls.progress.xml b/reference/ui/ui.controls.progress.xml deleted file mode 100644 index fa3e93a8bc..0000000000 --- a/reference/ui/ui.controls.progress.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Contrôle de Progression - UI\Controls\Progress - - - - -
    - &reftitle.intro; - - Un contrôle de Progression (Progress Control) est une barre de progression familière : elle représente la progression en pourcentage, avec une plage possible de 0 à 100 (inclus). - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Progress - - - - - UI\Controls\Progress - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.controls.entities.progress; - -     - - diff --git a/reference/ui/ui.controls.radio.xml b/reference/ui/ui.controls.radio.xml deleted file mode 100644 index c2ca437434..0000000000 --- a/reference/ui/ui.controls.radio.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Radio de Contrôle - UI\Controls\Radio - - - - -
    - &reftitle.intro; - - Une radio est un contrôle d'entrée de type bouton radio, familier des entrées de type radio en HTML. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Radio - - - - - UI\Controls\Radio - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.controls.entities.radio; - -     - - diff --git a/reference/ui/ui.controls.separator.xml b/reference/ui/ui.controls.separator.xml deleted file mode 100644 index 7f730d43c5..0000000000 --- a/reference/ui/ui.controls.separator.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - Séparateur de Contrôle - UI\Controls\Separator - - - - -
    - &reftitle.intro; - - Un séparateur (Separator) représente un contrôle séparateur, il n'a pas d'autre fonction. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Separator - - - - - UI\Controls\Separator - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\Separator::Horizontal - - - const - int - UI\Controls\Separator::Vertical - - - Constructor - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\Separator::Horizontal - - Un Séparateur Horizontal - - - - - UI\Controls\Separator::Vertical - - Un Séparateur Vertical - - - - -
    - - - -     - - &reference.ui.ui.controls.entities.separator; - -     - - diff --git a/reference/ui/ui.controls.slider.xml b/reference/ui/ui.controls.slider.xml deleted file mode 100644 index d676d3fe3f..0000000000 --- a/reference/ui/ui.controls.slider.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Glissière de Contrôle - UI\Controls\Slider - - - - -
    - &reftitle.intro; - - Une glissière (Slider) est un contrôle qui représente une plage, et une valeur courante dans la plage. L'élément de glissement du contrôle (parfois appelé "pouce") reflète la valeur, et peut être ajusté dans la plage. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Slider - - - - - UI\Controls\Slider - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.controls.entities.slider; - -     - - diff --git a/reference/ui/ui.controls.spin.xml b/reference/ui/ui.controls.spin.xml deleted file mode 100644 index ad60d6f751..0000000000 --- a/reference/ui/ui.controls.spin.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Boîte de rotation de Contrôle - UI\Controls\Spin - - - - -
    - &reftitle.intro; - - Une boîte de rotation (Spin) est une boîte de texte avec un contrôle haut-bas qui change la valeur entière dans la boîte, dans une plage définie - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Spin - - - - - UI\Controls\Spin - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.controls.entities.spin; - -     - - diff --git a/reference/ui/ui.controls.tab.xml b/reference/ui/ui.controls.tab.xml deleted file mode 100644 index 4e7945e1a4..0000000000 --- a/reference/ui/ui.controls.tab.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Boîte d'onglets de Contrôle - UI\Controls\Tab - - - - -
    - &reftitle.intro; - - Une boîte d'onglets (Tab) est un conteneur de contrôles, chaque onglet contenant un titre, sélectionnable par l'utilisateur. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Tab - - - - - UI\Controls\Tab - - - - extends - UI\Control - - - - - &Properties; - - protected - controls - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - controls - - - Contient des contrôles, ne doit pas être manipulé directement - - - - -
    - - -     - - &reference.ui.ui.controls.entities.tab; - -     - - diff --git a/reference/ui/ui.draw.brush.gradient.xml b/reference/ui/ui.draw.brush.gradient.xml deleted file mode 100644 index 71597a3c5d..0000000000 --- a/reference/ui/ui.draw.brush.gradient.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Pinceaux de gradient - UI\Draw\Brush\Gradient - - - - -
    - &reftitle.intro; - - Abstraction pour les pinceaux de gradient - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Brush\Gradient - - - - - abstract - UI\Draw\Brush\Gradient - - - - extends - UI\Draw\Brush - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.draw.entities.brush.gradient; - -     - - diff --git a/reference/ui/ui.draw.brush.lineargradient.xml b/reference/ui/ui.draw.brush.lineargradient.xml deleted file mode 100644 index dd44a02976..0000000000 --- a/reference/ui/ui.draw.brush.lineargradient.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Gradient Linéaire - UI\Draw\Brush\LinearGradient - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Brush\LinearGradient - - - - - UI\Draw\Brush\LinearGradient - - - - extends - UI\Draw\Brush\Gradient - - - - - Constructor - - - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.draw.entities.brush.lineargradient; - -     - - diff --git a/reference/ui/ui.draw.brush.radialgradient.xml b/reference/ui/ui.draw.brush.radialgradient.xml deleted file mode 100644 index 63868458e7..0000000000 --- a/reference/ui/ui.draw.brush.radialgradient.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Gradient Radial - UI\Draw\Brush\RadialGradient - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Brush\RadialGradient - - - - - UI\Draw\Brush\RadialGradient - - - - extends - UI\Draw\Brush\Gradient - - - - - Constructor - - - - - &InheritedMethods; - - - - - -
    - -     - - &reference.ui.ui.draw.entities.brush.radialgradient; - -     - - diff --git a/reference/ui/ui.draw.brush.xml b/reference/ui/ui.draw.brush.xml deleted file mode 100644 index 5b4abb6ffe..0000000000 --- a/reference/ui/ui.draw.brush.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Pinceaux - UI\Draw\Brush - - - - -
    - &reftitle.intro; - - Représente un pinceau de couleur unie - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Brush - - - - - UI\Draw\Brush - - - - - Constructor - - - &Methods; - - - - -
    - -     - - &reference.ui.ui.draw.entities.brush; - -     - - diff --git a/reference/ui/ui.draw.color.xml b/reference/ui/ui.draw.color.xml deleted file mode 100644 index 3c140c33a0..0000000000 --- a/reference/ui/ui.draw.color.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - Représentation de couleur - UI\Draw\Color - - - - -
    - &reftitle.intro; - - Représente une couleur RGBA, les canaux individuels sont accessibles via des propriétés publiques. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Color - - - - - UI\Draw\Color - - - - &Constants; - - const - int - UI\Draw\Color::Red - - - const - int - UI\Draw\Color::Green - - - const - int - UI\Draw\Color::Blue - - - const - int - UI\Draw\Color::Alpha - - - &Properties; - - public - r - - - public - g - - - public - b - - - public - a - - - Constructor - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - r - - Apporte l'accès au canal rouge - - - - g - - Apporte l'accès au canal vert - - - - b - - Apporte l'accès au canal bleu - - - - a - - Apporte l'accès au canal alpha - - - -
    - - - - -
    - &reftitle.constants; - - - - UI\Draw\Color::Red - - Identifie le canal rouge - - - - - UI\Draw\Color::Green - - Identifie le canal vert - - - - - UI\Draw\Color::Blue - - Identifie le canal bleu - - - - - UI\Draw\Color::Alpha - - Identifie le canal alpha - - - - -
    - - - -     - - &reference.ui.ui.draw.entities.color; - -     - - diff --git a/reference/ui/ui.draw.line.cap.xml b/reference/ui/ui.draw.line.cap.xml deleted file mode 100644 index 6c7bb72745..0000000000 --- a/reference/ui/ui.draw.line.cap.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - Paramètres de terminaison de ligne - UI\Draw\Line\Cap - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Line\Cap - - - - - final - UI\Draw\Line\Cap - - - - &Constants; - - const - int - UI\Draw\Line\Cap::Flat - - - const - int - UI\Draw\Line\Cap::Round - - - const - int - UI\Draw\Line\Cap::Square - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Line\Cap::Flat - - - - - - UI\Draw\Line\Cap::Round - - - - - - UI\Draw\Line\Cap::Square - - - - - - -
    - -     - -     - - diff --git a/reference/ui/ui.draw.line.join.xml b/reference/ui/ui.draw.line.join.xml deleted file mode 100644 index 02c8c35272..0000000000 --- a/reference/ui/ui.draw.line.join.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - Paramètres de jonction de ligne - UI\Draw\Line\Join - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Line\Join - - - - - final - UI\Draw\Line\Join - - - - &Constants; - - const - int - UI\Draw\Line\Join::Miter - - - const - int - UI\Draw\Line\Join::Round - - - const - int - UI\Draw\Line\Join::Bevel - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Line\Join::Miter - - - - - - UI\Draw\Line\Join::Round - - - - - - UI\Draw\Line\Join::Bevel - - - - - - -
    - -     - -     - - diff --git a/reference/ui/ui.draw.matrix.xml b/reference/ui/ui.draw.matrix.xml deleted file mode 100644 index deb1cbf909..0000000000 --- a/reference/ui/ui.draw.matrix.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Dessin de matrice - UI\Draw\Matrix - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Matrix - - - - - UI\Draw\Matrix - - - - - &Methods; - - - - -
    - -     - - &reference.ui.ui.draw.entities.matrix; - -     - - diff --git a/reference/ui/ui.draw.path.xml b/reference/ui/ui.draw.path.xml deleted file mode 100644 index 74191b2836..0000000000 --- a/reference/ui/ui.draw.path.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - Dessin de chemin - UI\Draw\Path - - - - -
    - &reftitle.intro; - - Un chemin de dessin guide un stylo de dessin, indiquant au stylo où dessiner sur une zone. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Path - - - - - UI\Draw\Path - - - - &Constants; - - const - int - UI\Draw\Path::Winding - - - const - int - UI\Draw\Path::Alternate - - - Constructor - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Path::Winding - - - Ceci est le mode de dessin de chemin par défaut - - - - - - UI\Draw\Path::Alternate - - - Ceci est le mode de dessin de chemin alternatif - - - - - -
    - - - -     - - &reference.ui.ui.draw.entities.path; - -     - - diff --git a/reference/ui/ui.draw.pen.xml b/reference/ui/ui.draw.pen.xml deleted file mode 100644 index fbedb49a0c..0000000000 --- a/reference/ui/ui.draw.pen.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Stylo de dessin - UI\Draw\Pen - - - - -
    - &reftitle.intro; - - Le stylo est passé à l'événement de dessin de zone, il est utilisé pour le rognage, le remplissage, le tracé et l'écriture des chemins de dessin. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Pen - - - - - final - UI\Draw\Pen - - - - - &Methods; - - - - -
    - -     - - &reference.ui.ui.draw.entities.pen; - -     - - diff --git a/reference/ui/ui.draw.stroke.xml b/reference/ui/ui.draw.stroke.xml deleted file mode 100644 index 00b9cef7af..0000000000 --- a/reference/ui/ui.draw.stroke.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Dessin de trait - UI\Draw\Stroke - - - - -
    - &reftitle.intro; - - Tient la configuration pour le Stylo pour réaliser un trait - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Stroke - - - - - UI\Draw\Stroke - - - - - Constructor - - - &Methods; - - - - -
    - -     - - &reference.ui.ui.draw.entities.stroke; - -     - - diff --git a/reference/ui/ui.draw.text.font.descriptor.xml b/reference/ui/ui.draw.text.font.descriptor.xml deleted file mode 100644 index ed74ddb2c1..0000000000 --- a/reference/ui/ui.draw.text.font.descriptor.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Descripteur de police - UI\Draw\Text\Font\Descriptor - - - - -
    - &reftitle.intro; - - Décrit une police - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font\Descriptor - - - - - UI\Draw\Text\Font\Descriptor - - - - - Constructor - - - &Methods; - - - - -
    - -     - - &reference.ui.ui.draw.text.entities.font.descriptor; - -     - - diff --git a/reference/ui/ui.draw.text.font.italic.xml b/reference/ui/ui.draw.text.font.italic.xml deleted file mode 100644 index 9488d77fa8..0000000000 --- a/reference/ui/ui.draw.text.font.italic.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - Paramètres de police italique - UI\Draw\Text\Font\Italic - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font\Italic - - - - - final - UI\Draw\Text\Font\Italic - - - - &Constants; - - const - int - UI\Draw\Text\Font\Italic::Normal - 0 - - - const - int - UI\Draw\Text\Font\Italic::Oblique - 1 - - - const - int - UI\Draw\Text\Font\Italic::Italic - 2 - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Text\Font\Italic::Normal - - - - - - UI\Draw\Text\Font\Italic::Oblique - - - - - - UI\Draw\Text\Font\Italic::Italic - - - - - - -
    - -     - -     - - diff --git a/reference/ui/ui.draw.text.font.stretch.xml b/reference/ui/ui.draw.text.font.stretch.xml deleted file mode 100644 index 33f803d31c..0000000000 --- a/reference/ui/ui.draw.text.font.stretch.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - Paramètres d'étirement de police - UI\Draw\Text\Font\Stretch - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font\Stretch - - - - - final - UI\Draw\Text\Font\Stretch - - - - &Constants; - - const - int - UI\Draw\Text\Font\Stretch::UltraCondensed - 0 - - - const - int - UI\Draw\Text\Font\Stretch::ExtraCondensed - 1 - - - const - int - UI\Draw\Text\Font\Stretch::Condensed - 2 - - - const - int - UI\Draw\Text\Font\Stretch::SemiCondensed - 3 - - - const - int - UI\Draw\Text\Font\Stretch::Normal - 4 - - - const - int - UI\Draw\Text\Font\Stretch::SemiExpanded - 5 - - - const - int - UI\Draw\Text\Font\Stretch::Expanded - 6 - - - const - int - UI\Draw\Text\Font\Stretch::ExtraExpanded - 7 - - - const - int - UI\Draw\Text\Font\Stretch::UltraExpanded - 8 - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Text\Font\Stretch::UltraCondensed - - - - - - UI\Draw\Text\Font\Stretch::ExtraCondensed - - - - - - UI\Draw\Text\Font\Stretch::Condensed - - - - - - UI\Draw\Text\Font\Stretch::SemiCondensed - - - - - - UI\Draw\Text\Font\Stretch::Normal - - - - - - UI\Draw\Text\Font\Stretch::SemiExpanded - - - - - - UI\Draw\Text\Font\Stretch::Expanded - - - - - - UI\Draw\Text\Font\Stretch::ExtraExpanded - - - - - - UI\Draw\Text\Font\Stretch::UltraExpanded - - - - - - -
    - -     - -     - - diff --git a/reference/ui/ui.draw.text.font.weight.xml b/reference/ui/ui.draw.text.font.weight.xml deleted file mode 100644 index 3f81504791..0000000000 --- a/reference/ui/ui.draw.text.font.weight.xml +++ /dev/null @@ -1,194 +0,0 @@ - - - - - Paramètres d'épaisseur de police - UI\Draw\Text\Font\Weight - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font\Weight - - - - - final - UI\Draw\Text\Font\Weight - - - - &Constants; - - const - int - UI\Draw\Text\Font\Weight::Thin - - - const - int - UI\Draw\Text\Font\Weight::UltraLight - - - const - int - UI\Draw\Text\Font\Weight::Light - - - const - int - UI\Draw\Text\Font\Weight::Book - - - const - int - UI\Draw\Text\Font\Weight::Normal - - - const - int - UI\Draw\Text\Font\Weight::Medium - - - const - int - UI\Draw\Text\Font\Weight::SemiBold - - - const - int - UI\Draw\Text\Font\Weight::Bold - - - const - int - UI\Draw\Text\Font\Weight::UltraBold - - - const - int - UI\Draw\Text\Font\Weight::Heavy - - - const - int - UI\Draw\Text\Font\Weight::UltraHeavy - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Text\Font\Weight::Thin - - - - - - UI\Draw\Text\Font\Weight::UltraLight - - - - - - UI\Draw\Text\Font\Weight::Light - - - - - - UI\Draw\Text\Font\Weight::Book - - - - - - UI\Draw\Text\Font\Weight::Normal - - - - - - UI\Draw\Text\Font\Weight::Medium - - - - - - UI\Draw\Text\Font\Weight::SemiBold - - - - - - UI\Draw\Text\Font\Weight::Bold - - - - - - UI\Draw\Text\Font\Weight::UltraBold - - - - - - UI\Draw\Text\Font\Weight::Heavy - - - - - - UI\Draw\Text\Font\Weight::UltraHeavy - - - - - - -
    - -     - -     - - diff --git a/reference/ui/ui.draw.text.font.xml b/reference/ui/ui.draw.text.font.xml deleted file mode 100644 index 04e96cf9ee..0000000000 --- a/reference/ui/ui.draw.text.font.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Représente une police - UI\Draw\Text\Font - - - - -
    - &reftitle.intro; - - Charge une police décrite - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font - - - - - UI\Draw\Text\Font - - - - - Constructor - - - &Methods; - - - - - -
    - -     - - &reference.ui.ui.draw.text.entities.font; - -     - - diff --git a/reference/ui/ui.draw.text.layout.xml b/reference/ui/ui.draw.text.layout.xml deleted file mode 100644 index 574546fbc7..0000000000 --- a/reference/ui/ui.draw.text.layout.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Représente la mise en page de texte - UI\Draw\Text\Layout - - - - -
    - &reftitle.intro; - - Une mise en page de texte représente la mise en page du texte qui sera dessiné par le stylo - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Layout - - - - - UI\Draw\Text\Layout - - - - - Constructor - - - &Methods; - - - - -
    - -     - - &reference.ui.ui.draw.text.entities.layout; - -     - - diff --git a/reference/ui/ui.exception.invalidargumentexception.xml b/reference/ui/ui.exception.invalidargumentexception.xml deleted file mode 100644 index 3ab4a169f7..0000000000 --- a/reference/ui/ui.exception.invalidargumentexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - InvalidArgumentException - UI\Exception\InvalidArgumentException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Exception\InvalidArgumentException - - - - - UI\Exception\InvalidArgumentException - - - - extends - InvalidArgumentException - - - - Throwable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/ui/ui.exception.runtimeexception.xml b/reference/ui/ui.exception.runtimeexception.xml deleted file mode 100644 index dcad5253dd..0000000000 --- a/reference/ui/ui.exception.runtimeexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - RuntimeException - UI\Exception\RuntimeException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Exception\RuntimeException - - - - - UI\Exception\RuntimeException - - - - extends - RuntimeException - - - - Throwable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/ui/ui.executor.xml b/reference/ui/ui.executor.xml deleted file mode 100644 index a0afcc9346..0000000000 --- a/reference/ui/ui.executor.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Planificateur d'exécution - UI\Executor - - - - -
    - &reftitle.intro; - - Cela permet de planifier l'exécution répétée d'une fonction de rappel, utile pour les animations et autres activités similaires. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Executor - - - - - abstract - UI\Executor - - - - - Constructor - - - &Methods; - - - - -
    - -     - - &reference.ui.ui.entities.executor; - -     - - diff --git a/reference/ui/ui.key.xml b/reference/ui/ui.key.xml deleted file mode 100644 index e8755d53c4..0000000000 --- a/reference/ui/ui.key.xml +++ /dev/null @@ -1,502 +0,0 @@ - - - - - Identifiants de touche - UI\Key - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Key - - - - - final - UI\Key - - - - &Constants; - - const - int - UI\Key::Escape - - - const - int - UI\Key::Insert - - - const - int - UI\Key::Delete - - - const - int - UI\Key::Home - - - const - int - UI\Key::End - - - const - int - UI\Key::PageUp - - - const - int - UI\Key::PageDown - - - const - int - UI\Key::Up - - - const - int - UI\Key::Down - - - const - int - UI\Key::Left - - - const - int - UI\Key::Right - - - const - int - UI\Key::F1 - - - const - int - UI\Key::F2 - - - const - int - UI\Key::F3 - - - const - int - UI\Key::F4 - - - const - int - UI\Key::F5 - - - const - int - UI\Key::F6 - - - const - int - UI\Key::F7 - - - const - int - UI\Key::F8 - - - const - int - UI\Key::F9 - - - const - int - UI\Key::F10 - - - const - int - UI\Key::F11 - - - const - int - UI\Key::F12 - - - const - int - UI\Key::N0 - - - const - int - UI\Key::N1 - - - const - int - UI\Key::N2 - - - const - int - UI\Key::N3 - - - const - int - UI\Key::N4 - - - const - int - UI\Key::N5 - - - const - int - UI\Key::N6 - - - const - int - UI\Key::N7 - - - const - int - UI\Key::N8 - - - const - int - UI\Key::N9 - - - const - int - UI\Key::NDot - - - const - int - UI\Key::NEnter - - - const - int - UI\Key::NAdd - - - const - int - UI\Key::NSubtract - - - const - int - UI\Key::NMultiply - - - const - int - UI\Key::NDivide - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Key::Escape - - - - - - UI\Key::Insert - - - - - - UI\Key::Delete - - - - - - UI\Key::Home - - - - - - UI\Key::End - - - - - - UI\Key::PageUp - - - - - - UI\Key::PageDown - - - - - - UI\Key::Up - - - - - - UI\Key::Down - - - - - - UI\Key::Left - - - - - - UI\Key::Right - - - - - - UI\Key::F1 - - - - - - UI\Key::F2 - - - - - - UI\Key::F3 - - - - - - UI\Key::F4 - - - - - - UI\Key::F5 - - - - - - UI\Key::F6 - - - - - - UI\Key::F7 - - - - - - UI\Key::F8 - - - - - - UI\Key::F9 - - - - - - UI\Key::F10 - - - - - - UI\Key::F11 - - - - - - UI\Key::F12 - - - - - - UI\Key::N0 - - - - - - UI\Key::N1 - - - - - - UI\Key::N2 - - - - - - UI\Key::N3 - - - - - - UI\Key::N4 - - - - - - UI\Key::N5 - - - - - - UI\Key::N6 - - - - - - UI\Key::N7 - - - - - - UI\Key::N8 - - - - - - UI\Key::N9 - - - - - - UI\Key::NDot - - - - - - UI\Key::NEnter - - - - - - UI\Key::NAdd - - - - - - UI\Key::NSubtract - - - - - - UI\Key::NMultiply - - - - - - UI\Key::NDivide - - - - - - -
    - -     - -     - - diff --git a/reference/ui/ui.menu.xml b/reference/ui/ui.menu.xml deleted file mode 100644 index 66da5d7d4d..0000000000 --- a/reference/ui/ui.menu.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Menu - UI\Menu - - - - -
    - &reftitle.intro; - - Les menus doivent être construits avant la première fenêtre, et peuvent être affichés sur n'importe quelle fenêtre - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Menu - - - - - UI\Menu - - - - - Constructor - - - &Methods; - - - - -
    - -     - - &reference.ui.ui.entities.menu; - -     - - diff --git a/reference/ui/ui.menuitem.xml b/reference/ui/ui.menuitem.xml deleted file mode 100644 index db3ab8bde7..0000000000 --- a/reference/ui/ui.menuitem.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Élément de menu - UI\MenuItem - - - - -
    - &reftitle.intro; - - Les éléments de menu ne doivent être créés que par le menu - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\MenuItem - - - - - UI\MenuItem - - - - - &Methods; - - - - -
    - -     - - &reference.ui.ui.entities.menuitem; - -     - - diff --git a/reference/ui/ui.point.xml b/reference/ui/ui.point.xml deleted file mode 100644 index ea26fdda88..0000000000 --- a/reference/ui/ui.point.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - Représente une position (x,y) - UI\Point - - - - -
    - &reftitle.intro; - - Les points sont utilisés dans toute l'interface utilisateur pour représenter des coordonnées sur un écran, un contrôle ou une zone. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Point - - - - - final - UI\Point - - - - &Properties; - - public - x - - - public - y - - - Constructor - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - x - - - Contient la coordonnée X, peut être lu/écrit directement - - - - - y - - - Contient la coordonnée Y, peut être lu/écrit directement - - - - -
    - - - -     - - &reference.ui.ui.entities.point; - -     - - diff --git a/reference/ui/ui.size.xml b/reference/ui/ui.size.xml deleted file mode 100644 index db3540ab78..0000000000 --- a/reference/ui/ui.size.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Représente des dimensions (largeur, hauteur) - UI\Size - - - - -
    - &reftitle.intro; - - Les tailles sont utilisées dans toute l'interface utilisateur pour représenter la taille d'un écran, d'un contrôle ou d'une zone. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Size - - - - - final - UI\Size - - - - &Properties; - - public - width - - - public - height - - - Constructor - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - width - - - Contient la largeur, peut être lu/écrit directement - - - - - height - - - Contient la hauteur, peut être lu/écrit directement - - - - -
    - - -     - - &reference.ui.ui.entities.size; - -     - - diff --git a/reference/ui/ui.window.xml b/reference/ui/ui.window.xml deleted file mode 100644 index 09e2af06a8..0000000000 --- a/reference/ui/ui.window.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - Fenêtre - UI\Window - - - - -
    - &reftitle.intro; - - Représente une fenêtre UI - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Window - - - - - UI\Window - - - - extends - UI\Control - - - - &Properties; - - protected - controls - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - controls - - - Contient les contrôles, ne doit pas être manipulé directement - - - - -
    - - -     - - &reference.ui.ui.entities.window; - -     - - diff --git a/reference/ui/ui/area/ondraw.xml b/reference/ui/ui/area/ondraw.xml deleted file mode 100644 index 3c405a04f3..0000000000 --- a/reference/ui/ui/area/ondraw.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - UI\Area::onDraw - Fonction de rappel de dessin - - - - &reftitle.description; - - protected UI\Area::onDraw - UI\Draw\Penpen - UI\SizeareaSize - UI\PointclipPoint - UI\SizeclipSize - - - Doit être invoquée lorsque cette zone nécessite un redessin - - - - - - &reftitle.parameters; - - - pen - - - Un stylo adapté pour dessiner dans cette aire - - - - - areaSize - - - La taille de l'aire - - - - - clipPoint - - - Le point de découpe de l'aire - - - - - clipSize - - - La taille de découpe de l'aire - - - - - - - - - diff --git a/reference/ui/ui/area/onkey.xml b/reference/ui/ui/area/onkey.xml deleted file mode 100644 index 03748646e0..0000000000 --- a/reference/ui/ui/area/onkey.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - UI\Area::onKey - Fonction de rappel de touche - - - - &reftitle.description; - - protected UI\Area::onKey - stringkey - intext - intflags - - - Doit être exécutée sur les événements de touche - - - - - - &reftitle.parameters; - - - key - - - La touche pressée - - - - - ext - - - La touche étendue pressée - - - - - flags - - - Modificateurs d'événements - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/area/onmouse.xml b/reference/ui/ui/area/onmouse.xml deleted file mode 100644 index eca2488893..0000000000 --- a/reference/ui/ui/area/onmouse.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - UI\Area::onMouse - Fonction de rappel de souris - - - - &reftitle.description; - - protected UI\Area::onMouse - UI\PointareaPoint - UI\SizeareaSize - intflags - - - Doit être exécutée sur les événements de souris - - - - - - &reftitle.parameters; - - - areaPoint - - - Les coordonnées de l'événement - - - - - areaSize - - - La taille de la zone de l'événement - - - - - flags - - - Modificateurs d'événements - - - - - - - - - diff --git a/reference/ui/ui/area/redraw.xml b/reference/ui/ui/area/redraw.xml deleted file mode 100644 index 2f25422cc7..0000000000 --- a/reference/ui/ui/area/redraw.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Area::redraw - Redessine l'aire - - - - &reftitle.description; - - public UI\Area::redraw - - - - Demande que cette aire soit redessinée - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/area/scrollto.xml b/reference/ui/ui/area/scrollto.xml deleted file mode 100644 index 06e440c4fb..0000000000 --- a/reference/ui/ui/area/scrollto.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - UI\Area::scrollTo - Défilement de l'aire - - - - &reftitle.description; - - public UI\Area::scrollTo - UI\Pointpoint - UI\Sizesize - - - Défile cette aire - - - - - - &reftitle.parameters; - - - point - - - Le point sur lequel défiler - - - - - size - - - La taille du panneau de scroll - - - - - - - - - diff --git a/reference/ui/ui/area/setsize.xml b/reference/ui/ui/area/setsize.xml deleted file mode 100644 index 29db26d200..0000000000 --- a/reference/ui/ui/area/setsize.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Area::setSize - Définit la taille - - - - &reftitle.description; - - public UI\Area::setSize - UI\Sizesize - - - Définit la taille de cette aire - - - - - - &reftitle.parameters; - - - size - - - La nouvelle taille - - - - - - - - - - diff --git a/reference/ui/ui/control/destroy.xml b/reference/ui/ui/control/destroy.xml deleted file mode 100644 index d00f08d8b5..0000000000 --- a/reference/ui/ui/control/destroy.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::destroy - Détruit le contrôle - - - - &reftitle.description; - - public UI\Control::destroy - - - - Détruit ce contrôle - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/disable.xml b/reference/ui/ui/control/disable.xml deleted file mode 100644 index 2ee03ad2a1..0000000000 --- a/reference/ui/ui/control/disable.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::disable - Désactive le contrôle - - - - &reftitle.description; - - public UI\Control::disable - - - - Désactive ce contrôle - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/enable.xml b/reference/ui/ui/control/enable.xml deleted file mode 100644 index 781b47967b..0000000000 --- a/reference/ui/ui/control/enable.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::enable - Active le contrôle - - - - &reftitle.description; - - public UI\Control::enable - - - - Active ce contrôle - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/getparent.xml b/reference/ui/ui/control/getparent.xml deleted file mode 100644 index bd7d6eacf4..0000000000 --- a/reference/ui/ui/control/getparent.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::getParent - Renvoie le contrôle parent - - - - &reftitle.description; - - public UI\ControlUI\Control::getParent - - - - Renvoie le contrôle parent - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/gettoplevel.xml b/reference/ui/ui/control/gettoplevel.xml deleted file mode 100644 index 1be01490cf..0000000000 --- a/reference/ui/ui/control/gettoplevel.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Control::getTopLevel - Renvoie le plus haut niveau - - - - &reftitle.description; - - public intUI\Control::getTopLevel - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/hide.xml b/reference/ui/ui/control/hide.xml deleted file mode 100644 index d401690093..0000000000 --- a/reference/ui/ui/control/hide.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::hide - Cache le contrôle - - - - &reftitle.description; - - public UI\Control::hide - - - - Cache ce contrôle - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/isenabled.xml b/reference/ui/ui/control/isenabled.xml deleted file mode 100644 index e40621efb0..0000000000 --- a/reference/ui/ui/control/isenabled.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::isEnabled - Renvoie si le contrôle est activé - - - - &reftitle.description; - - public boolUI\Control::isEnabled - - - - Renvoie si ce contrôle est activé - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/isvisible.xml b/reference/ui/ui/control/isvisible.xml deleted file mode 100644 index 021ff664d5..0000000000 --- a/reference/ui/ui/control/isvisible.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::isVisible - Renvoie si le contrôle est visible - - - - &reftitle.description; - - public boolUI\Control::isVisible - - - - Renvoie si ce contrôle est visible - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/setparent.xml b/reference/ui/ui/control/setparent.xml deleted file mode 100644 index d225c9a5bc..0000000000 --- a/reference/ui/ui/control/setparent.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Control::setParent - Définit le contrôle parent - - - - &reftitle.description; - - public UI\Control::setParent - UI\Controlparent - - - Définit le contrôle parent de ce contrôle - - - - - - &reftitle.parameters; - - - parent - - - Le contrôle parent - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/show.xml b/reference/ui/ui/control/show.xml deleted file mode 100644 index 29fdc60cd1..0000000000 --- a/reference/ui/ui/control/show.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::show - Affiche le contrôle - - - - &reftitle.description; - - public UI\Control::show - - - - Affiche ce contrôle - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/box/append.xml b/reference/ui/ui/controls/box/append.xml deleted file mode 100644 index cf75dced9d..0000000000 --- a/reference/ui/ui/controls/box/append.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Controls\Box::append - Ajoute un contrôle - - - - &reftitle.description; - - public intUI\Controls\Box::append - Controlcontrol - boolstretchy&false; - - - Ajoute le contrôle donné à cette boîte - - - - - - &reftitle.parameters; - - - control - - - Le contrôle à ajouter - - - - - stretchy - - - Définit si le contrôle doit être étiré - - - - - - - - &reftitle.returnvalues; - - Renvoie l'index du contrôle ajouté, peut être 0 - - - - - - - diff --git a/reference/ui/ui/controls/box/construct.xml b/reference/ui/ui/controls/box/construct.xml deleted file mode 100644 index 134064f02a..0000000000 --- a/reference/ui/ui/controls/box/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\Box::__construct - Construit une nouvelle boîte - - - - &reftitle.description; - - public UI\Controls\Box::__construct - intorientationUI\Controls\Box::Horizontal - - - Construit une nouvelle boîte - - - - - - &reftitle.parameters; - - - orientation - - - Box::Horizontal ou Box::Vertical - - - - - - - - - - - diff --git a/reference/ui/ui/controls/box/delete.xml b/reference/ui/ui/controls/box/delete.xml deleted file mode 100644 index 93d3151a6c..0000000000 --- a/reference/ui/ui/controls/box/delete.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Controls\Box::delete - Supprime un contrôle - - - - &reftitle.description; - - public boolUI\Controls\Box::delete - intindex - - - Supprime le contrôle à l'index donné de cette boîte - - - - - - &reftitle.parameters; - - - index - - - L'index du contrôle à supprimer - - - - - - - - &reftitle.returnvalues; - - Indication de succès - - - - - - diff --git a/reference/ui/ui/controls/box/getorientation.xml b/reference/ui/ui/controls/box/getorientation.xml deleted file mode 100644 index a9804b2b33..0000000000 --- a/reference/ui/ui/controls/box/getorientation.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Box::getOrientation - Renvoie l'orientation - - - - &reftitle.description; - - public intUI\Controls\Box::getOrientation - - - - Renvoie l'orientation de cette boîte - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/box/ispadded.xml b/reference/ui/ui/controls/box/ispadded.xml deleted file mode 100644 index 478f1c314a..0000000000 --- a/reference/ui/ui/controls/box/ispadded.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Box::isPadded - Détection du padding - - - - &reftitle.description; - - public boolUI\Controls\Box::isPadded - - - - Détecte si le padding est activé sur cette boîte - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/box/setpadded.xml b/reference/ui/ui/controls/box/setpadded.xml deleted file mode 100644 index 49694c7999..0000000000 --- a/reference/ui/ui/controls/box/setpadded.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Box::setPadded - Définit le padding - - - - &reftitle.description; - - public UI\Controls\Box::setPadded - boolpadded - - - Définit si le padding est activé ou non sur cette boîte - - - - - - &reftitle.parameters; - - - padded - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/button/construct.xml b/reference/ui/ui/controls/button/construct.xml deleted file mode 100644 index 2b9bd8be40..0000000000 --- a/reference/ui/ui/controls/button/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\Button::__construct - Construit un nouveau bouton - - - - &reftitle.description; - - public UI\Controls\Button::__construct - stringtext - - - Construit un nouveau bouton - - - - - - &reftitle.parameters; - - - text - - - Le texte (étiquette) de ce bouton - - - - - - - - - - - diff --git a/reference/ui/ui/controls/button/gettext.xml b/reference/ui/ui/controls/button/gettext.xml deleted file mode 100644 index e004dacbb5..0000000000 --- a/reference/ui/ui/controls/button/gettext.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Button::getText - Renvoie le texte - - - - &reftitle.description; - - public stringUI\Controls\Button::getText - - - - Renvoie le texte (étiquette) de ce bouton - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le texte (étiquette) actuel - - - - - - - diff --git a/reference/ui/ui/controls/button/onclick.xml b/reference/ui/ui/controls/button/onclick.xml deleted file mode 100644 index 6ca58786a1..0000000000 --- a/reference/ui/ui/controls/button/onclick.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Button::onClick - Gestionnaire de clic - - - - &reftitle.description; - - protected UI\Controls\Button::onClick - - - - Doit être exécuté lorsque ce bouton est cliqué - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/button/settext.xml b/reference/ui/ui/controls/button/settext.xml deleted file mode 100644 index 7098f3e2ab..0000000000 --- a/reference/ui/ui/controls/button/settext.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Button::setText - Définit le texte - - - - &reftitle.description; - - public UI\Controls\Button::setText - stringtext - - - Définit le texte (étiquette) de ce bouton - - - - - - &reftitle.parameters; - - - text - - - Le nouveau texte (étiquette) - - - - - - - - - diff --git a/reference/ui/ui/controls/check/construct.xml b/reference/ui/ui/controls/check/construct.xml deleted file mode 100644 index d01420fcc6..0000000000 --- a/reference/ui/ui/controls/check/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Check::__construct - Construit une nouvelle case à cocher - - - - &reftitle.description; - - public UI\Controls\Check::__construct - stringtext - - - Construit une nouvelle case à cocher - - - - - - &reftitle.parameters; - - - text - - - Le texte (étiquette) pour la case à cocher - - - - - - - - - diff --git a/reference/ui/ui/controls/check/gettext.xml b/reference/ui/ui/controls/check/gettext.xml deleted file mode 100644 index d5f88095a6..0000000000 --- a/reference/ui/ui/controls/check/gettext.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Check::getText - Renvoie le texte - - - - &reftitle.description; - - public stringUI\Controls\Check::getText - - - - Renvoie le texte (étiquette) pour cette case à cocher - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le texte (label) courant - - - - - - - diff --git a/reference/ui/ui/controls/check/ischecked.xml b/reference/ui/ui/controls/check/ischecked.xml deleted file mode 100644 index 0a08ce1799..0000000000 --- a/reference/ui/ui/controls/check/ischecked.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Check::isChecked - Détection de la case cochée - - - - &reftitle.description; - - public boolUI\Controls\Check::isChecked - - - - Détecte le statut de cette case à cocher - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/check/ontoggle.xml b/reference/ui/ui/controls/check/ontoggle.xml deleted file mode 100644 index 16ae34e3ae..0000000000 --- a/reference/ui/ui/controls/check/ontoggle.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Check::onToggle - Fonction de rappel de basculement - - - - &reftitle.description; - - protected UI\Controls\Check::onToggle - - - - Doit être exécuté lorsque le statut de cette case est modifié - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/check/setchecked.xml b/reference/ui/ui/controls/check/setchecked.xml deleted file mode 100644 index 29b9229a7e..0000000000 --- a/reference/ui/ui/controls/check/setchecked.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Check::setChecked - Définit la case cochée - - - - &reftitle.description; - - public UI\Controls\Check::setChecked - boolchecked - - - Change le statut de cette case à cocher - - - - - - &reftitle.parameters; - - - checked - - - Le nouveau statut - - - - - - - - - - diff --git a/reference/ui/ui/controls/check/settext.xml b/reference/ui/ui/controls/check/settext.xml deleted file mode 100644 index c7953007cf..0000000000 --- a/reference/ui/ui/controls/check/settext.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Check::setText - Définit le texte - - - - &reftitle.description; - - public UI\Controls\Check::setText - stringtext - - - Définit le texte (étiquette) pour cette case à cocher - - - - - - &reftitle.parameters; - - - text - - - Le nouveau texte (étiquette) - - - - - - - - - - diff --git a/reference/ui/ui/controls/colorbutton/getcolor.xml b/reference/ui/ui/controls/colorbutton/getcolor.xml deleted file mode 100644 index a3affd700c..0000000000 --- a/reference/ui/ui/controls/colorbutton/getcolor.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\ColorButton::getColor - Renvoie la couleur - - - - &reftitle.description; - - public UI\ColorUI\Controls\ColorButton::getColor - - - - Renvoie la couleur actuellement sélectionnée - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/colorbutton/onchange.xml b/reference/ui/ui/controls/colorbutton/onchange.xml deleted file mode 100644 index f0fc78421a..0000000000 --- a/reference/ui/ui/controls/colorbutton/onchange.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\ColorButton::onChange - Gestionnaire de changement - - - - &reftitle.description; - - protected UI\Controls\ColorButton::onChange - - - - Doit être exécuté lorsque la couleur sélectionnée est modifiée - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/colorbutton/setcolor.xml b/reference/ui/ui/controls/colorbutton/setcolor.xml deleted file mode 100644 index b24bbb2566..0000000000 --- a/reference/ui/ui/controls/colorbutton/setcolor.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - UI\Controls\ColorButton::setColor - Définit la couleur - - - - &reftitle.description; - - public UI\Controls\ColorButton::setColor - UI\Draw\Colorcolor - - - public UI\Controls\ColorButton::setColor - intcolor - - - Définit la couleur actuellement sélectionnée - - - - - - &reftitle.parameters; - - - color - - - La nouvelle couleur - - - - - - - - - - diff --git a/reference/ui/ui/controls/combo/append.xml b/reference/ui/ui/controls/combo/append.xml deleted file mode 100644 index 98f68952e1..0000000000 --- a/reference/ui/ui/controls/combo/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Combo::append - Ajoute une option - - - - &reftitle.description; - - public UI\Controls\Combo::append - stringtext - - - Ajoute une option à cette boîte de sélection. - - - - - - &reftitle.parameters; - - - text - - - Le texte pour la nouvelle option. - - - - - - - - - - diff --git a/reference/ui/ui/controls/combo/getselected.xml b/reference/ui/ui/controls/combo/getselected.xml deleted file mode 100644 index 6da95843b9..0000000000 --- a/reference/ui/ui/controls/combo/getselected.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Combo::getSelected - Renvoie l'option sélectionnée - - - - &reftitle.description; - - public intUI\Controls\Combo::getSelected - - - - Renvoie l'index de l'option sélectionnée dans cette boîte de sélection. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/combo/onselected.xml b/reference/ui/ui/controls/combo/onselected.xml deleted file mode 100644 index 903d8bc075..0000000000 --- a/reference/ui/ui/controls/combo/onselected.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Combo::onSelected - Gestionnaire de sélection - - - - &reftitle.description; - - protected UI\Controls\Combo::onSelected - - - - Doit être exécuté lorsqu'une option est sélectionnée dans cette boîte de sélection. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/combo/setselected.xml b/reference/ui/ui/controls/combo/setselected.xml deleted file mode 100644 index d58abc4a0b..0000000000 --- a/reference/ui/ui/controls/combo/setselected.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Combo::setSelected - Définit l'option sélectionnée - - - - &reftitle.description; - - public UI\Controls\Combo::setSelected - intindex - - - Définit l'option actuellement sélectionnée dans cette boîte de sélection. - - - - - - &reftitle.parameters; - - - index - - - L'index de l'option à sélectionner - - - - - - - - - - diff --git a/reference/ui/ui/controls/editablecombo/append.xml b/reference/ui/ui/controls/editablecombo/append.xml deleted file mode 100644 index 1ef0726535..0000000000 --- a/reference/ui/ui/controls/editablecombo/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\EditableCombo::append - Ajoute une option - - - - &reftitle.description; - - public UI\Controls\EditableCombo::append - stringtext - - - Ajoute une nouvelle option à cette boîte de sélection éditable - - - - - - &reftitle.parameters; - - - text - - - Le texte de la nouvelle option - - - - - - - - - - diff --git a/reference/ui/ui/controls/editablecombo/gettext.xml b/reference/ui/ui/controls/editablecombo/gettext.xml deleted file mode 100644 index c257afd39d..0000000000 --- a/reference/ui/ui/controls/editablecombo/gettext.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\EditableCombo::getText - Renvoie le texte - - - - &reftitle.description; - - public stringUI\Controls\EditableCombo::getText - - - - Renvoie la valeur de l'option actuellement sélectionnée dans cette boîte de sélection éditable - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/editablecombo/onchange.xml b/reference/ui/ui/controls/editablecombo/onchange.xml deleted file mode 100644 index 2090a36d68..0000000000 --- a/reference/ui/ui/controls/editablecombo/onchange.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\EditableCombo::onChange - Gestionnaire de changement - - - - &reftitle.description; - - protected UI\Controls\EditableCombo::onChange - - - - Doit être exécuté lorsque la valeur de cette boîte de sélection éditable change - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/editablecombo/settext.xml b/reference/ui/ui/controls/editablecombo/settext.xml deleted file mode 100644 index 0c5ab64591..0000000000 --- a/reference/ui/ui/controls/editablecombo/settext.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\EditableCombo::setText - Définit le texte - - - - &reftitle.description; - - public UI\Controls\EditableCombo::setText - stringtext - - - Définit le texte de l'option actuellement sélectionnée dans cette boîte de sélection éditable - - - - - - &reftitle.parameters; - - - text - - - Le nouveau texte - - - - - - - - - - diff --git a/reference/ui/ui/controls/entry/construct.xml b/reference/ui/ui/controls/entry/construct.xml deleted file mode 100644 index 5d76d95bad..0000000000 --- a/reference/ui/ui/controls/entry/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Entry::__construct - Construit une nouvelle entrée - - - - &reftitle.description; - - public UI\Controls\Entry::__construct - inttypeUI\Controls\Entry::Normal - - - Construit une nouvelle entrée du type donné - - - - - - &reftitle.parameters; - - - type - - - Entry::Normal, Entry::Password, ou Entry::Search - - - - - - - - - diff --git a/reference/ui/ui/controls/entry/gettext.xml b/reference/ui/ui/controls/entry/gettext.xml deleted file mode 100644 index 43736cd955..0000000000 --- a/reference/ui/ui/controls/entry/gettext.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Entry::getText - Renvoie le texte - - - - &reftitle.description; - - public stringUI\Controls\Entry::getText - - - - Renvoie le texte actuel de cette entrée - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le texte actuel - - - - - - - diff --git a/reference/ui/ui/controls/entry/isreadonly.xml b/reference/ui/ui/controls/entry/isreadonly.xml deleted file mode 100644 index a9eaeb9adb..0000000000 --- a/reference/ui/ui/controls/entry/isreadonly.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Entry::isReadOnly - Detecte si l'entrée est en lecture seule - - - - &reftitle.description; - - public boolUI\Controls\Entry::isReadOnly - - - - Détecte si cette entrée est en lecture seule - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/entry/onchange.xml b/reference/ui/ui/controls/entry/onchange.xml deleted file mode 100644 index 278bdecdfd..0000000000 --- a/reference/ui/ui/controls/entry/onchange.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Entry::onChange - Gestionnaire de changement - - - - &reftitle.description; - - protected UI\Controls\Entry::onChange - - - - Doit être exécuté lorsque le texte de cette entrée change - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/entry/setreadonly.xml b/reference/ui/ui/controls/entry/setreadonly.xml deleted file mode 100644 index 8e911fdf2d..0000000000 --- a/reference/ui/ui/controls/entry/setreadonly.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Entry::setReadOnly - Définit si l'entrée est en lecture seule - - - - &reftitle.description; - - public UI\Controls\Entry::setReadOnly - boolreadOnly - - - Active ou désactive le mode lecture seule pour cette entrée - - - - - - &reftitle.parameters; - - - readOnly - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/entry/settext.xml b/reference/ui/ui/controls/entry/settext.xml deleted file mode 100644 index 5cf8da08af..0000000000 --- a/reference/ui/ui/controls/entry/settext.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Entry::setText - Définit le texte - - - - &reftitle.description; - - public UI\Controls\Entry::setText - stringtext - - - Définit le texte pour cette entrée - - - - - - &reftitle.parameters; - - - text - - - Le nouveau texte - - - - - - - - - - diff --git a/reference/ui/ui/controls/form/append.xml b/reference/ui/ui/controls/form/append.xml deleted file mode 100644 index 0301438df6..0000000000 --- a/reference/ui/ui/controls/form/append.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - UI\Controls\Form::append - Ajoute un contrôle - - - - &reftitle.description; - - public intUI\Controls\Form::append - stringlabel - UI\Controlcontrol - boolstretchy&false; - - - Ajoute le contrôle au formulaire, et définit le label - - - - - - &reftitle.parameters; - - - label - - - Le texte pour le label - - - - - control - - - Un contrôle - - - - - stretchy - - - Doit être défini à true pour étirer le contrôle - - - - - - - - &reftitle.returnvalues; - - Renvoie l'index du contrôle ajouté, peut être 0 - - - - - - - diff --git a/reference/ui/ui/controls/form/delete.xml b/reference/ui/ui/controls/form/delete.xml deleted file mode 100644 index c13cf5aade..0000000000 --- a/reference/ui/ui/controls/form/delete.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Controls\Form::delete - Supprime un contrôle - - - - &reftitle.description; - - public boolUI\Controls\Form::delete - intindex - - - Supprime le contrôle à l'index donné dans ce formulaire - - - - - &reftitle.parameters; - - - index - - - L'index du contrôle à supprimer - - - - - - - - &reftitle.returnvalues; - - Indication de succès - - - - - - - diff --git a/reference/ui/ui/controls/form/ispadded.xml b/reference/ui/ui/controls/form/ispadded.xml deleted file mode 100644 index 25f592dbcc..0000000000 --- a/reference/ui/ui/controls/form/ispadded.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Form::isPadded - Détection du padding - - - - &reftitle.description; - - public boolUI\Controls\Form::isPadded - - - - Détecte si le padding est activé sur ce formulaire - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/form/setpadded.xml b/reference/ui/ui/controls/form/setpadded.xml deleted file mode 100644 index 882ac97707..0000000000 --- a/reference/ui/ui/controls/form/setpadded.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Form::setPadded - Définit le padding - - - - &reftitle.description; - - public UI\Controls\Form::setPadded - boolpadded - - - Définit si le padding est activé ou non sur ce formulaire - - - - - - &reftitle.parameters; - - - padded - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/grid/append.xml b/reference/ui/ui/controls/grid/append.xml deleted file mode 100644 index bc140b563f..0000000000 --- a/reference/ui/ui/controls/grid/append.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - UI\Controls\Grid::append - Ajoute un contrôle - - - - &reftitle.description; - - public UI\Controls\Grid::append - UI\Controlcontrol - intleft - inttop - intxspan - intyspan - boolhexpand - inthalign - boolvexpand - intvalign - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - control - - - Le contrôle à ajouter - - - - - left - - - - - - - - top - - - - - - - - xspan - - - - - - - - yspan - - - - - - - - hexpand - - - - - - - - halign - - - - - - - - vexpand - - - - - - - - valign - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/grid/ispadded.xml b/reference/ui/ui/controls/grid/ispadded.xml deleted file mode 100644 index fd20802276..0000000000 --- a/reference/ui/ui/controls/grid/ispadded.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Grid::isPadded - Détection du padding - - - - &reftitle.description; - - public boolUI\Controls\Grid::isPadded - - - - Détecte si le rembourrage est activé sur cette grille - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/grid/setpadded.xml b/reference/ui/ui/controls/grid/setpadded.xml deleted file mode 100644 index 95927e7026..0000000000 --- a/reference/ui/ui/controls/grid/setpadded.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Grid::setPadded - Définit le padding - - - - &reftitle.description; - - public UI\Controls\Grid::setPadded - boolpadding - - - Définit si le padding est activé ou non sur cette grille - - - - - - &reftitle.parameters; - - - padding - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/group/append.xml b/reference/ui/ui/controls/group/append.xml deleted file mode 100644 index a47781e8ed..0000000000 --- a/reference/ui/ui/controls/group/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Group::append - Ajoute un contrôle - - - - &reftitle.description; - - public UI\Controls\Group::append - UI\Controlcontrol - - - Ajoute un contrôle à ce groupe - - - - - - &reftitle.parameters; - - - control - - - Le contrôle à ajouter - - - - - - - - - - diff --git a/reference/ui/ui/controls/group/construct.xml b/reference/ui/ui/controls/group/construct.xml deleted file mode 100644 index 58c49de88a..0000000000 --- a/reference/ui/ui/controls/group/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\Group::__construct - Construit un nouveau groupe - - - - &reftitle.description; - - public UI\Controls\Group::__construct - stringtitle - - - Construit un nouveau groupe avec le titre donné - - - - - - &reftitle.parameters; - - - title - - - Le texte pour l'étiquette du titre - - - - - - - - - - - diff --git a/reference/ui/ui/controls/group/gettitle.xml b/reference/ui/ui/controls/group/gettitle.xml deleted file mode 100644 index 456bc6a6dd..0000000000 --- a/reference/ui/ui/controls/group/gettitle.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Group::getTitle - Renvoie le titre - - - - &reftitle.description; - - public stringUI\Controls\Group::getTitle - - - - Renvoie le titre actuel pour ce groupe - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le titre actuel - - - - - - - diff --git a/reference/ui/ui/controls/group/hasmargin.xml b/reference/ui/ui/controls/group/hasmargin.xml deleted file mode 100644 index 9610582c8a..0000000000 --- a/reference/ui/ui/controls/group/hasmargin.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Group::hasMargin - Détection de margin - - - - &reftitle.description; - - public boolUI\Controls\Group::hasMargin - - - - Détecte si le margin est activé sur ce groupe - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/group/setmargin.xml b/reference/ui/ui/controls/group/setmargin.xml deleted file mode 100644 index 70f5c564c0..0000000000 --- a/reference/ui/ui/controls/group/setmargin.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Group::setMargin - Définit le margin - - - - &reftitle.description; - - public UI\Controls\Group::setMargin - boolmargin - - - Définit si le margin est activé ou non sur ce groupe - - - - - - &reftitle.parameters; - - - margin - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/group/settitle.xml b/reference/ui/ui/controls/group/settitle.xml deleted file mode 100644 index c27dfe7885..0000000000 --- a/reference/ui/ui/controls/group/settitle.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Group::setTitle - Définit le titre - - - - &reftitle.description; - - public UI\Controls\Group::setTitle - stringtitle - - - Définit le titre pour ce groupe - - - - - - &reftitle.parameters; - - - title - - - Le texte pour le nouveau titre - - - - - - - - - - diff --git a/reference/ui/ui/controls/label/construct.xml b/reference/ui/ui/controls/label/construct.xml deleted file mode 100644 index b526edaa70..0000000000 --- a/reference/ui/ui/controls/label/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Label::__construct - Construit un nouveau Label - - - - &reftitle.description; - - public UI\Controls\Label::__construct - stringtext - - - Construit un nouveau Label - - - - - - &reftitle.parameters; - - - text - - - Le texte pour ce label - - - - - - - - - diff --git a/reference/ui/ui/controls/label/gettext.xml b/reference/ui/ui/controls/label/gettext.xml deleted file mode 100644 index 03f52131f0..0000000000 --- a/reference/ui/ui/controls/label/gettext.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Label::getText - Renvoie le texte - - - - &reftitle.description; - - public stringUI\Controls\Label::getText - - - - Renvoie le texte actuel pour ce Label - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/label/settext.xml b/reference/ui/ui/controls/label/settext.xml deleted file mode 100644 index 36a49381e3..0000000000 --- a/reference/ui/ui/controls/label/settext.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Label::setText - Définit le texte - - - - &reftitle.description; - - public UI\Controls\Label::setText - stringtext - - - Définit le texte pour ce Label - - - - - - &reftitle.parameters; - - - text - - - Le nouveau texte - - - - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/append.xml b/reference/ui/ui/controls/multilineentry/append.xml deleted file mode 100644 index f73e7eefd3..0000000000 --- a/reference/ui/ui/controls/multilineentry/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::append - Ajoute un texte - - - - &reftitle.description; - - public UI\Controls\MultilineEntry::append - stringtext - - - Ajoute le texte donné au texte à cette entrée multiligne - - - - - - &reftitle.parameters; - - - text - - - Le texte à ajouter - - - - - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/construct.xml b/reference/ui/ui/controls/multilineentry/construct.xml deleted file mode 100644 index 79642fd666..0000000000 --- a/reference/ui/ui/controls/multilineentry/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::__construct - Construit une nouvelle entrée multiligne - - - - &reftitle.description; - - public UI\Controls\MultilineEntry::__construct - inttype - - - Construit une nouvelle entrée multiligne du type donné - - - - - - &reftitle.parameters; - - - type - - - MultilineEntry::Wrap ou MultilineEntry::NoWrap - - - - - - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/gettext.xml b/reference/ui/ui/controls/multilineentry/gettext.xml deleted file mode 100644 index da742d4d70..0000000000 --- a/reference/ui/ui/controls/multilineentry/gettext.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::getText - Renvoie le texte - - - - &reftitle.description; - - public stringUI\Controls\MultilineEntry::getText - - - - Retourne le texte de cette entrée multiligne - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/isreadonly.xml b/reference/ui/ui/controls/multilineentry/isreadonly.xml deleted file mode 100644 index 8799419dc2..0000000000 --- a/reference/ui/ui/controls/multilineentry/isreadonly.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::isReadOnly - Renvoie si cette entrée multiligne est en lecture seule - - - - &reftitle.description; - - public boolUI\Controls\MultilineEntry::isReadOnly - - - - Détecte si cette entrée multiligne est en lecture seule - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/onchange.xml b/reference/ui/ui/controls/multilineentry/onchange.xml deleted file mode 100644 index 498dc124f8..0000000000 --- a/reference/ui/ui/controls/multilineentry/onchange.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::onChange - Gestionnaire de changement - - - - &reftitle.description; - - protected UI\Controls\MultilineEntry::onChange - - - - Doit être exécuté lorsque le texte de cette entrée multiligne est modifié - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/multilineentry/setreadonly.xml b/reference/ui/ui/controls/multilineentry/setreadonly.xml deleted file mode 100644 index 319ee6a546..0000000000 --- a/reference/ui/ui/controls/multilineentry/setreadonly.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::setReadOnly - Définit si cette entrée multiligne est en lecture seule - - - - &reftitle.description; - - public UI\Controls\MultilineEntry::setReadOnly - boolreadOnly - - - Définit si la lecture seule est activée ou non sur cette entrée multiligne - - - - - - &reftitle.parameters; - - - readOnly - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/settext.xml b/reference/ui/ui/controls/multilineentry/settext.xml deleted file mode 100644 index 226bb58587..0000000000 --- a/reference/ui/ui/controls/multilineentry/settext.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::setText - Définit le texte - - - - &reftitle.description; - - public UI\Controls\MultilineEntry::setText - stringtext - - - Définit le texte de cette entrée multiligne - - - - - - &reftitle.parameters; - - - text - - - Le nouveau texte - - - - - - - - - diff --git a/reference/ui/ui/controls/picker/construct.xml b/reference/ui/ui/controls/picker/construct.xml deleted file mode 100644 index 2d91f3b642..0000000000 --- a/reference/ui/ui/controls/picker/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\Picker::__construct - Construit un nouveau sélecteur - - - - &reftitle.description; - - public UI\Controls\Picker::__construct - inttypeUI\Controls\Picker::Date - - - Construit un nouveau sélecteur du type donné - - - - - - &reftitle.parameters; - - - type - - - Picker::Date, Picker::Time, ou Picker::DateTime - - - - - - - - - - - diff --git a/reference/ui/ui/controls/progress/getvalue.xml b/reference/ui/ui/controls/progress/getvalue.xml deleted file mode 100644 index a9d67de413..0000000000 --- a/reference/ui/ui/controls/progress/getvalue.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Progress::getValue - Renvoie la valeur - - - - &reftitle.description; - - public intUI\Controls\Progress::getValue - - - - Renvoie la valeur actuelle de cette barre de progression - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/progress/setvalue.xml b/reference/ui/ui/controls/progress/setvalue.xml deleted file mode 100644 index 181b7dd449..0000000000 --- a/reference/ui/ui/controls/progress/setvalue.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Progress::setValue - Définit la valeur - - - - &reftitle.description; - - public UI\Controls\Progress::setValue - intvalue - - - Définit la valeur pour cette barre de progression - - - - - - &reftitle.parameters; - - - value - - - Un entier entre 0 et 100 (inclus) - - - - - - - - - diff --git a/reference/ui/ui/controls/radio/append.xml b/reference/ui/ui/controls/radio/append.xml deleted file mode 100644 index d83c750d4f..0000000000 --- a/reference/ui/ui/controls/radio/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Radio::append - Ajoute une option - - - - &reftitle.description; - - public UI\Controls\Radio::append - stringtext - - - Ajoute une nouvelle option à cette radio - - - - - - &reftitle.parameters; - - - text - - - Le texte (label) pour l'option - - - - - - - - - - diff --git a/reference/ui/ui/controls/radio/getselected.xml b/reference/ui/ui/controls/radio/getselected.xml deleted file mode 100644 index 0b4b5a98e9..0000000000 --- a/reference/ui/ui/controls/radio/getselected.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Radio::getSelected - Renvoie l'option sélectionnée - - - - &reftitle.description; - - public intUI\Controls\Radio::getSelected - - - - Renvoie l'index de l'option actuellement sélectionnée dans cette radio - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/radio/onselected.xml b/reference/ui/ui/controls/radio/onselected.xml deleted file mode 100644 index ee77cbd56a..0000000000 --- a/reference/ui/ui/controls/radio/onselected.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Radio::onSelected - Gestionnaire de sélection - - - - &reftitle.description; - - protected UI\Controls\Radio::onSelected - - - - Doit être exécuté lorsque l'option sélectionnée dans cette radio change - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/radio/setselected.xml b/reference/ui/ui/controls/radio/setselected.xml deleted file mode 100644 index 1b235f94f5..0000000000 --- a/reference/ui/ui/controls/radio/setselected.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Radio::setSelected - Définit l'option sélectionnée - - - - &reftitle.description; - - public UI\Controls\Radio::setSelected - intindex - - - Définit l'option actuellement sélectionnée dans cette radio - - - - - - &reftitle.parameters; - - - index - - - L'index de l'option à sélectionner - - - - - - - - - - diff --git a/reference/ui/ui/controls/separator/construct.xml b/reference/ui/ui/controls/separator/construct.xml deleted file mode 100644 index 5e276e01f9..0000000000 --- a/reference/ui/ui/controls/separator/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Separator::__construct - Construit un nouveau séparateur - - - - &reftitle.description; - - public UI\Controls\Separator::__construct - inttypeUI\Controls\Separator::Horizontal - - - Construit un nouveau séparateur du type donné - - - - - - &reftitle.parameters; - - - type - - - Separator::Horizontal ou Separator::Vertical - - - - - - - - - diff --git a/reference/ui/ui/controls/slider/construct.xml b/reference/ui/ui/controls/slider/construct.xml deleted file mode 100644 index bc8f6e2943..0000000000 --- a/reference/ui/ui/controls/slider/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - UI\Controls\Slider::__construct - Construit une nouvelle glissière - - - - &reftitle.description; - - public UI\Controls\Slider::__construct - intmin - intmax - - - Construit une nouvelle glissière avec la plage donnée - - - - - - &reftitle.parameters; - - - min - - - La valeur minimale autorisée - - - - - max - - - La valeur maximale autorisée - - - - - - - - - diff --git a/reference/ui/ui/controls/slider/getvalue.xml b/reference/ui/ui/controls/slider/getvalue.xml deleted file mode 100644 index f4a9bbd349..0000000000 --- a/reference/ui/ui/controls/slider/getvalue.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Slider::getValue - Renvoie la valeur - - - - &reftitle.description; - - public intUI\Controls\Slider::getValue - - - - Renvoie la valeur de cette glissière - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/slider/onchange.xml b/reference/ui/ui/controls/slider/onchange.xml deleted file mode 100644 index 96166fc0d7..0000000000 --- a/reference/ui/ui/controls/slider/onchange.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Slider::onChange - Gestionnaire de changement - - - - &reftitle.description; - - protected UI\Controls\Slider::onChange - - - - Doit être exécuté lorsque la valeur de cette glissière change - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/slider/setvalue.xml b/reference/ui/ui/controls/slider/setvalue.xml deleted file mode 100644 index ba57b3f842..0000000000 --- a/reference/ui/ui/controls/slider/setvalue.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Slider::setValue - Définit la valeur - - - - &reftitle.description; - - public UI\Controls\Slider::setValue - intvalue - - - Définit la valeur pour cette glissière - - - - - - &reftitle.parameters; - - - value - - - La nouvelle valeur - - - - - - - - - diff --git a/reference/ui/ui/controls/spin/construct.xml b/reference/ui/ui/controls/spin/construct.xml deleted file mode 100644 index 04b5511893..0000000000 --- a/reference/ui/ui/controls/spin/construct.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - UI\Controls\Spin::__construct - Construit une nouvelle boîte de rotation - - - - &reftitle.description; - - public UI\Controls\Spin::__construct - intmin - intmax - - - Construit une nouvelle boîte de rotation avec la plage donnée - - - - - - &reftitle.parameters; - - - min - - - La valeur minimale autorisée - - - - - max - - - La valeur maximale autorisée - - - - - - - - - - - diff --git a/reference/ui/ui/controls/spin/getvalue.xml b/reference/ui/ui/controls/spin/getvalue.xml deleted file mode 100644 index cc766a0e42..0000000000 --- a/reference/ui/ui/controls/spin/getvalue.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Spin::getValue - Renvoie la valeur - - - - &reftitle.description; - - public intUI\Controls\Spin::getValue - - - - Renvoie la valeur dans cette boîte de rotation - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/spin/onchange.xml b/reference/ui/ui/controls/spin/onchange.xml deleted file mode 100644 index a010ff6981..0000000000 --- a/reference/ui/ui/controls/spin/onchange.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Spin::onChange - Gestionnaire de changement - - - - &reftitle.description; - - protected UI\Controls\Spin::onChange - - - - Doit être exécuté lorsque la valeur de cette boîte de rotation change - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/spin/setvalue.xml b/reference/ui/ui/controls/spin/setvalue.xml deleted file mode 100644 index f5e57494da..0000000000 --- a/reference/ui/ui/controls/spin/setvalue.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Spin::setValue - Définit la valeur - - - - &reftitle.description; - - public UI\Controls\Spin::setValue - intvalue - - - Définit la valeur dans cette boîte de rotation - - - - - - &reftitle.parameters; - - - value - - - La nouvelle valeur - - - - - - - - - - diff --git a/reference/ui/ui/controls/tab/append.xml b/reference/ui/ui/controls/tab/append.xml deleted file mode 100644 index 490c951890..0000000000 --- a/reference/ui/ui/controls/tab/append.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Controls\Tab::append - Ajoute une page - - - - &reftitle.description; - - public intUI\Controls\Tab::append - stringname - UI\Controlcontrol - - - Ajoute une nouvelle page à cet onglet - - - - - - &reftitle.parameters; - - - name - - - Le nom de la nouvelle page - - - - - control - - - Le contrôle pour la nouvelle page - - - - - - - - &reftitle.returnvalues; - - Renvoie l'index du contrôle ajouté, peut être 0 - - - - - - - diff --git a/reference/ui/ui/controls/tab/delete.xml b/reference/ui/ui/controls/tab/delete.xml deleted file mode 100644 index e318c4cbeb..0000000000 --- a/reference/ui/ui/controls/tab/delete.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Controls\Tab::delete - Supprime une page - - - - &reftitle.description; - - public boolUI\Controls\Tab::delete - intindex - - - Supprime la page sélectionnée de cet onglet - - - - - - &reftitle.parameters; - - - index - - - L'index de la page à supprimer - - - - - - - - &reftitle.returnvalues; - - Indication de succès - - - - - - diff --git a/reference/ui/ui/controls/tab/hasmargin.xml b/reference/ui/ui/controls/tab/hasmargin.xml deleted file mode 100644 index 1c7db63007..0000000000 --- a/reference/ui/ui/controls/tab/hasmargin.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Controls\Tab::hasMargin - Détection de margin - - - - &reftitle.description; - - public boolUI\Controls\Tab::hasMargin - intpage - - - Détecte si le margin est activé sur cette page - - - - - &reftitle.parameters; - - - page - - - L'index de la page - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/tab/insertat.xml b/reference/ui/ui/controls/tab/insertat.xml deleted file mode 100644 index fc517fa4dd..0000000000 --- a/reference/ui/ui/controls/tab/insertat.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - UI\Controls\Tab::insertAt - Insère une page - - - - &reftitle.description; - - public UI\Controls\Tab::insertAt - stringname - intpage - UI\Controlcontrol - - - Insère une nouvelle page dans cet onglet - - - - - - &reftitle.parameters; - - - name - - - Le nom de la nouvelle page - - - - - page - - - L'index pour effectuer l'insertion avant - - - - - control - - - Le contrôle pour la nouvelle page - - - - - - - - - diff --git a/reference/ui/ui/controls/tab/pages.xml b/reference/ui/ui/controls/tab/pages.xml deleted file mode 100644 index 093b66ea02..0000000000 --- a/reference/ui/ui/controls/tab/pages.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Tab::pages - Nombre de pages - - - - &reftitle.description; - - public intUI\Controls\Tab::pages - - - - Renvoie le nombre de pages dans cet onglet - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nombre de pages dans cet onglet - - - - - - - diff --git a/reference/ui/ui/controls/tab/setmargin.xml b/reference/ui/ui/controls/tab/setmargin.xml deleted file mode 100644 index 10c9c4c46e..0000000000 --- a/reference/ui/ui/controls/tab/setmargin.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - UI\Controls\Tab::setMargin - Définit le margin - - - - &reftitle.description; - - public UI\Controls\Tab::setMargin - intpage - boolmargin - - - Définit si le margin est activé ou non sur la page sélectionnée - - - - - - &reftitle.parameters; - - - page - - - La page à sélectionner - - - - - margin - - - Interrupteur de margin - - - - - - - - - diff --git a/reference/ui/ui/draw/brush.gradient/addstop.xml b/reference/ui/ui/draw/brush.gradient/addstop.xml deleted file mode 100644 index 749a4183c5..0000000000 --- a/reference/ui/ui/draw/brush.gradient/addstop.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - UI\Draw\Brush\Gradient::addStop - Manipulation d'arrêt - - - - &reftitle.description; - - public intUI\Draw\Brush\Gradient::addStop - floatposition - UI\Draw\Colorcolor - - - public intUI\Draw\Brush\Gradient::addStop - floatposition - intcolor - - - Ajoute un arrêt à la position donnée avec la couleur donnée - - - - - - &reftitle.parameters; - - - position - - - La position pour le nouvel arrêt - - - - - color - - - La couleur pour le nouvel arrêt, peut être un objet UI\Draw\Color ou un entier RRGGBBAA - - - - - - - - &reftitle.returnvalues; - - Le nombre total d'arrêts - - - - - - - diff --git a/reference/ui/ui/draw/brush.gradient/delstop.xml b/reference/ui/ui/draw/brush.gradient/delstop.xml deleted file mode 100644 index 0b7bdee05b..0000000000 --- a/reference/ui/ui/draw/brush.gradient/delstop.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Draw\Brush\Gradient::delStop - Manipulation d'arrêt - - - - &reftitle.description; - - public intUI\Draw\Brush\Gradient::delStop - intindex - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - index - - - - - - - - - - - &reftitle.returnvalues; - - Le nombre total d'arrêts - - - - - - - diff --git a/reference/ui/ui/draw/brush.gradient/setstop.xml b/reference/ui/ui/draw/brush.gradient/setstop.xml deleted file mode 100644 index af3cab5b2f..0000000000 --- a/reference/ui/ui/draw/brush.gradient/setstop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - UI\Draw\Brush\Gradient::setStop - Manipulation d'arrêt - - - - &reftitle.description; - - public boolUI\Draw\Brush\Gradient::setStop - intindex - floatposition - UI\Draw\Colorcolor - - - public boolUI\Draw\Brush\Gradient::setStop - intindex - floatposition - intcolor - - - - - - - - - &reftitle.parameters; - - - index - - - L'index de l'arrêt à définir - - - - - position - - - La position pour l'arrêt - - - - - color - - - La couleur pour l'arrêt, peut être un objet UI\Draw\Color ou un entier RRGGBBAA - - - - - - - - &reftitle.returnvalues; - - Indication de succès - - - - - - - diff --git a/reference/ui/ui/draw/brush.lineargradient/construct.xml b/reference/ui/ui/draw/brush.lineargradient/construct.xml deleted file mode 100644 index 1768dba1e2..0000000000 --- a/reference/ui/ui/draw/brush.lineargradient/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - UI\Draw\Brush\LinearGradient::__construct - Construit un dégradé linéaire - - - - &reftitle.description; - - public UI\Draw\Brush\LinearGradient::__construct - UI\Pointstart - UI\Pointend - - - Construit un nouveau dégradé linéaire (linear gradient) - - - - - - &reftitle.parameters; - - - start - - - - - - - - end - - - - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/brush.radialgradient/construct.xml b/reference/ui/ui/draw/brush.radialgradient/construct.xml deleted file mode 100644 index 176cdd0340..0000000000 --- a/reference/ui/ui/draw/brush.radialgradient/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - UI\Draw\Brush\RadialGradient::__construct - Construit un dégradé radial - - - - &reftitle.description; - - public UI\Draw\Brush\RadialGradient::__construct - UI\Pointstart - UI\Pointouter - floatradius - - - Construit un nouveau dégradé radial (radial gradient) - - - - - - &reftitle.parameters; - - - start - - - - - - - - outer - - - - - - - - radius - - - - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/brush/construct.xml b/reference/ui/ui/draw/brush/construct.xml deleted file mode 100644 index 6d571eae1d..0000000000 --- a/reference/ui/ui/draw/brush/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - UI\Draw\Brush::__construct - Construit un nouveau pinceau - - - - &reftitle.description; - - public UI\Draw\Brush::__construct - UI\Draw\Colorcolor - - - public UI\Draw\Brush::__construct - intcolor - - - Construit un pinceau solide en utilisant la couleur donnée - - - - - - &reftitle.parameters; - - - color - - - Peut être un objet UI\Draw\Color ou un entier RRGGBBAA - - - - - - - - - diff --git a/reference/ui/ui/draw/brush/getcolor.xml b/reference/ui/ui/draw/brush/getcolor.xml deleted file mode 100644 index 29550ff1eb..0000000000 --- a/reference/ui/ui/draw/brush/getcolor.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Brush::getColor - Renvoie la couleur - - - - &reftitle.description; - - public UI\Draw\ColorUI\Draw\Brush::getColor - - - - Renvoie un objet UI\Draw\Color pour ce pinceau - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La couleur actuelle du pinceau - - - - - - - diff --git a/reference/ui/ui/draw/brush/setcolor.xml b/reference/ui/ui/draw/brush/setcolor.xml deleted file mode 100644 index c9d7c782a4..0000000000 --- a/reference/ui/ui/draw/brush/setcolor.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - UI\Draw\Brush::setColor - Définit la couleur - - - - &reftitle.description; - - public voidUI\Draw\Brush::setColor - UI\Draw\Colorcolor - - - public voidUI\Draw\Brush::setColor - intcolor - - - Définit la couleur de ce pinceau à la couleur fournie - - - - - - &reftitle.parameters; - - - color - - - Peut être un objet UI\Draw\Color ou un entier RRGGBBAA - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/color/construct.xml b/reference/ui/ui/draw/color/construct.xml deleted file mode 100644 index 85528db7a3..0000000000 --- a/reference/ui/ui/draw/color/construct.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Draw\Color::__construct - Construit une nouvelle couleur - - - - &reftitle.description; - - public UI\Draw\Color::__construct - UI\Draw\Colorcolor - - - public UI\Draw\Color::__construct - intcolor - - - Construit une nouvelle couleur - - - - - - &reftitle.parameters; - - - color - - - Peut être un objet UI\Draw\Color ou un entier RRGGBBAA - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/color/getchannel.xml b/reference/ui/ui/draw/color/getchannel.xml deleted file mode 100644 index 062d3eceff..0000000000 --- a/reference/ui/ui/draw/color/getchannel.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Draw\Color::getChannel - Manipulation de couleur - - - - &reftitle.description; - - public floatUI\Draw\Color::getChannel - intchannel - - - Renvoie la valeur d'un canal - - - - - - &reftitle.parameters; - - - channel - - - Une des constantes d'identité de canal - - - - - - - - &reftitle.returnvalues; - - La valeur actuelle du canal demandé - - - - - - - diff --git a/reference/ui/ui/draw/color/setchannel.xml b/reference/ui/ui/draw/color/setchannel.xml deleted file mode 100644 index 4f3d6462ab..0000000000 --- a/reference/ui/ui/draw/color/setchannel.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Draw\Color::setChannel - Manipulation de couleur - - - - &reftitle.description; - - public voidUI\Draw\Color::setChannel - intchannel - floatvalue - - - Définit le canal sélectionné à la valeur donnée - - - - - - &reftitle.parameters; - - - channel - - - Une des constantes d'identité de canal - - - - - value - - - La nouvelle valeur pour le canal sélectionné - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/matrix/invert.xml b/reference/ui/ui/draw/matrix/invert.xml deleted file mode 100644 index 7179a1b1e0..0000000000 --- a/reference/ui/ui/draw/matrix/invert.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Draw\Matrix::invert - Inverse la matrice - - - - &reftitle.description; - - public UI\Draw\Matrix::invert - - - - Inverse cette matrice - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/matrix/isinvertible.xml b/reference/ui/ui/draw/matrix/isinvertible.xml deleted file mode 100644 index 3a23ab3e8e..0000000000 --- a/reference/ui/ui/draw/matrix/isinvertible.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Draw\Matrix::isInvertible - Détecte si la matrice est inversible - - - - &reftitle.description; - - public boolUI\Draw\Matrix::isInvertible - - - - Détecte si cette matrice peut être inversée - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/matrix/multiply.xml b/reference/ui/ui/draw/matrix/multiply.xml deleted file mode 100644 index eb1c4bd246..0000000000 --- a/reference/ui/ui/draw/matrix/multiply.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Draw\Matrix::multiply - Multiplie la matrice - - - - &reftitle.description; - - public UI\Draw\MatrixUI\Draw\Matrix::multiply - UI\Draw\Matrixmatrix - - - Multiplie cette matrice avec la matrice donnée - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La nouvelle matrice - - - - - - diff --git a/reference/ui/ui/draw/matrix/rotate.xml b/reference/ui/ui/draw/matrix/rotate.xml deleted file mode 100644 index 3f5e03f0f5..0000000000 --- a/reference/ui/ui/draw/matrix/rotate.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Draw\Matrix::rotate - Pivote la matrice - - - - &reftitle.description; - - public UI\Draw\Matrix::rotate - UI\Pointpoint - floatamount - - - Pivote cette matrice - - - - - - &reftitle.parameters; - - - point - - - - - - - - amount - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/matrix/scale.xml b/reference/ui/ui/draw/matrix/scale.xml deleted file mode 100644 index c011ad64e5..0000000000 --- a/reference/ui/ui/draw/matrix/scale.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Draw\Matrix::scale - Dimensionne la matrice - - - - &reftitle.description; - - public UI\Draw\Matrix::scale - UI\Pointcenter - UI\Pointpoint - - - Dimensionne cette matrice - - - - - - &reftitle.parameters; - - - center - - - - - - - - point - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/matrix/skew.xml b/reference/ui/ui/draw/matrix/skew.xml deleted file mode 100644 index f20d620159..0000000000 --- a/reference/ui/ui/draw/matrix/skew.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Draw\Matrix::skew - Dévie la matrice - - - - &reftitle.description; - - public UI\Draw\Matrix::skew - UI\Pointpoint - UI\Pointamount - - - Dévie cette matrice - - - - - - &reftitle.parameters; - - - point - - - - - - - - amount - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/matrix/translate.xml b/reference/ui/ui/draw/matrix/translate.xml deleted file mode 100644 index d8416b519f..0000000000 --- a/reference/ui/ui/draw/matrix/translate.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Matrix::translate - Translation de la matrice - - - - &reftitle.description; - - public UI\Draw\Matrix::translate - UI\Pointpoint - - - Applique une translation à cette matrice - - - - - - &reftitle.parameters; - - - point - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/path/addrectangle.xml b/reference/ui/ui/draw/path/addrectangle.xml deleted file mode 100644 index 4345854d93..0000000000 --- a/reference/ui/ui/draw/path/addrectangle.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - UI\Draw\Path::addRectangle - Dessine un rectangle - - - - &reftitle.description; - - public UI\Draw\Path::addRectangle - UI\Pointpoint - UI\Sizesize - - - Trace le chemin pour un rectangle de la taille donnée, au point donné - - - - - - &reftitle.parameters; - - - point - - - Le point pour commencer la forme - - - - - size - - - La taille du rectangle - - - - - - - - - diff --git a/reference/ui/ui/draw/path/arcto.xml b/reference/ui/ui/draw/path/arcto.xml deleted file mode 100644 index 92a3b3224c..0000000000 --- a/reference/ui/ui/draw/path/arcto.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - UI\Draw\Path::arcTo - Dessine un arc - - - - &reftitle.description; - - public UI\Draw\Path::arcTo - UI\Pointpoint - floatradius - floatangle - floatsweep - floatnegative - - - Trace le chemin pour un arc - - - - - - &reftitle.parameters; - - - point - - - Le point de départ du tracé - - - - - radius - - - Le rayon de l'arc - - - - - angle - - - L'angle de l'arc - - - - - sweep - - - L'étendue de l'arc - - - - - negative - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/path/bezierto.xml b/reference/ui/ui/draw/path/bezierto.xml deleted file mode 100644 index 6a53e59022..0000000000 --- a/reference/ui/ui/draw/path/bezierto.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - UI\Draw\Path::bezierTo - Dessine une courbe de Bézier - - - - &reftitle.description; - - public UI\Draw\Path::bezierTo - UI\Pointpoint - floatradius - floatangle - floatsweep - floatnegative - - - Trace une courbe de Bézier - - - - - - &reftitle.parameters; - - - point - - - Le point de départ du tracé - - - - - radius - - - Le rayon de la courbe - - - - - angle - - - L'angle de la courbe - - - - - sweep - - - L'étendue de la courbe - - - - - negative - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/path/closefigure.xml b/reference/ui/ui/draw/path/closefigure.xml deleted file mode 100644 index 3d81cdd088..0000000000 --- a/reference/ui/ui/draw/path/closefigure.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Draw\Path::closeFigure - Ferme la figure - - - - &reftitle.description; - - public UI\Draw\Path::closeFigure - - - - Ferme la figure actuelle - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/path/construct.xml b/reference/ui/ui/draw/path/construct.xml deleted file mode 100644 index b1df27769f..0000000000 --- a/reference/ui/ui/draw/path/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Draw\Path::__construct - Construit un nouveau chemin - - - - &reftitle.description; - - public UI\Draw\Path::__construct - intmodeUI\Draw\Path::Winding - - - Construit un nouveau chemin dans le mode donné - - - - - - &reftitle.parameters; - - - mode - - - Path::Winding ou Path::Alternate - - - - - - - - - diff --git a/reference/ui/ui/draw/path/end.xml b/reference/ui/ui/draw/path/end.xml deleted file mode 100644 index bd12d2d11e..0000000000 --- a/reference/ui/ui/draw/path/end.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Draw\Path::end - Finalise le chemin - - - - &reftitle.description; - - public UI\Draw\Path::end - - - - Finalise ce chemin - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/path/lineto.xml b/reference/ui/ui/draw/path/lineto.xml deleted file mode 100644 index c22061b72b..0000000000 --- a/reference/ui/ui/draw/path/lineto.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - UI\Draw\Path::lineTo - Dessine une ligne - - - - &reftitle.description; - - public UI\Draw\Path::lineTo - UI\Pointpoint - floatradius - floatangle - floatsweep - floatnegative - - - Trace le chemin pour une ligne - - - - - - &reftitle.parameters; - - - point - - - Le point de départ du tracé - - - - - radius - - - - - - - - angle - - - - - - - - sweep - - - - - - - - negative - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/path/newfigure.xml b/reference/ui/ui/draw/path/newfigure.xml deleted file mode 100644 index ac8590870a..0000000000 --- a/reference/ui/ui/draw/path/newfigure.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Path::newFigure - Dessine une figure - - - - &reftitle.description; - - public UI\Draw\Path::newFigure - UI\Pointpoint - - - Trace le chemin pour une nouvelle figure au point donné - - - - - - &reftitle.parameters; - - - point - - - Le point pour commencer le tracé - - - - - - - - - - diff --git a/reference/ui/ui/draw/path/newfigurewitharc.xml b/reference/ui/ui/draw/path/newfigurewitharc.xml deleted file mode 100644 index b230c3292d..0000000000 --- a/reference/ui/ui/draw/path/newfigurewitharc.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - UI\Draw\Path::newFigureWithArc - Dessine une figure avec un arc - - - - &reftitle.description; - - public UI\Draw\Path::newFigureWithArc - UI\Pointpoint - floatradius - floatangle - floatsweep - floatnegative - - - - - - - - - &reftitle.parameters; - - - point - - - - - - - - radius - - - - - - - - angle - - - - - - - - sweep - - - - - - - - negative - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/clip.xml b/reference/ui/ui/draw/pen/clip.xml deleted file mode 100644 index ede455a1c6..0000000000 --- a/reference/ui/ui/draw/pen/clip.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Pen::clip - Coupe un chemin - - - - &reftitle.description; - - public UI\Draw\Pen::clip - UI\Draw\Pathpath - - - Coupe le chemin donné - - - - - - &reftitle.parameters; - - - path - - - Le chemin à couper - - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/fill.xml b/reference/ui/ui/draw/pen/fill.xml deleted file mode 100644 index 29158eda1f..0000000000 --- a/reference/ui/ui/draw/pen/fill.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - UI\Draw\Pen::fill - Remplit un chemin - - - - &reftitle.description; - - public UI\Draw\Pen::fill - UI\Draw\Pathpath - UI\Draw\Brushwith - - - public UI\Draw\Pen::fill - UI\Draw\Pathpath - UI\Draw\Colorwith - - - public UI\Draw\Pen::fill - UI\Draw\Pathpath - intwith - - - Remplit le chemin donné - - - - - - &reftitle.parameters; - - - path - - - Le chemin à remplir - - - - - with - - - La couleur ou le pinceau avec lequel remplir - - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/restore.xml b/reference/ui/ui/draw/pen/restore.xml deleted file mode 100644 index 17536ec25c..0000000000 --- a/reference/ui/ui/draw/pen/restore.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Draw\Pen::restore - Restaure - - - - &reftitle.description; - - public UI\Draw\Pen::restore - - - - Restaure un stylo précédemment sauvegardé - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/pen/save.xml b/reference/ui/ui/draw/pen/save.xml deleted file mode 100644 index a5fffc6c5c..0000000000 --- a/reference/ui/ui/draw/pen/save.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Draw\Pen::save - Sauvegarde - - - - &reftitle.description; - - public UI\Draw\Pen::save - - - - Sauvegarde le stylo - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/pen/stroke.xml b/reference/ui/ui/draw/pen/stroke.xml deleted file mode 100644 index 72ee38d112..0000000000 --- a/reference/ui/ui/draw/pen/stroke.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - UI\Draw\Pen::stroke - Trace un trait - - - - &reftitle.description; - - public UI\Draw\Pen::stroke - UI\Draw\Pathpath - UI\Draw\Brushwith - UI\Draw\Strokestroke - - - public UI\Draw\Pen::stroke - UI\Draw\Pathpath - UI\Draw\Colorwith - UI\Draw\Strokestroke - - - public UI\Draw\Pen::stroke - UI\Draw\Pathpath - intwith - UI\Draw\Strokestroke - - - Trace le trait donné - - - - - - &reftitle.parameters; - - - path - - - Le trait à tracer - - - - - with - - - La couleur ou le pinceau avec lequel tracer - - - - - stroke - - - La configuration du trait - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/transform.xml b/reference/ui/ui/draw/pen/transform.xml deleted file mode 100644 index c2bab52332..0000000000 --- a/reference/ui/ui/draw/pen/transform.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Draw\Pen::transform - Transforme une matrice - - - - &reftitle.description; - - public UI\Draw\Pen::transform - UI\Draw\Matrixmatrix - - - Effectue une transformation de matrice - - - - - - &reftitle.parameters; - - - matrix - - - La matrice à utiliser - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/write.xml b/reference/ui/ui/draw/pen/write.xml deleted file mode 100644 index a7b514a990..0000000000 --- a/reference/ui/ui/draw/pen/write.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Draw\Pen::write - Dessine un texte à un point - - - - &reftitle.description; - - public UI\Draw\Pen::write - UI\Pointpoint - UI\Draw\Text\Layoutlayout - - - Dessine la mise en page du texte donnée au point donné - - - - - - &reftitle.parameters; - - - point - - - Le point sur lequel effectuer le dessin - - - - - layout - - - La mise en page du texte à dessiner - - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/construct.xml b/reference/ui/ui/draw/stroke/construct.xml deleted file mode 100644 index f96e8b415b..0000000000 --- a/reference/ui/ui/draw/stroke/construct.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - UI\Draw\Stroke::__construct - Construit un nouveau trait - - - - &reftitle.description; - - public UI\Draw\Stroke::__construct - intcapUI\Draw\Line\Cap::Flat - intjoinUI\Draw\Line\Join::Miter - floatthickness1 - floatmiterLimit10 - - - Construit un nouveau trait - - - - - - &reftitle.parameters; - - - cap - - - UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, ou UI\Draw\Line\Cap::Square - - - - - join - - - UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, ou UI\Draw\Line\Join::Bevel - - - - - thickness - - - L'épaisseur du trait - - - - - miterLimit - - - La limite de miter (la valeur par défaut est raisonnable pour toutes les plateformes supportées) - - - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/getcap.xml b/reference/ui/ui/draw/stroke/getcap.xml deleted file mode 100644 index bd6f0e0826..0000000000 --- a/reference/ui/ui/draw/stroke/getcap.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Stroke::getCap - Renvoie le type de terminaison de trait - - - - &reftitle.description; - - public intUI\Draw\Stroke::getCap - - - - Renvoie le type de terminaison de ce trait - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, ou UI\Draw\Line\Cap::Square - - - - - - - diff --git a/reference/ui/ui/draw/stroke/getjoin.xml b/reference/ui/ui/draw/stroke/getjoin.xml deleted file mode 100644 index e8e1dad1bb..0000000000 --- a/reference/ui/ui/draw/stroke/getjoin.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Stroke::getJoin - Renvoie le type de jointure de trait - - - - &reftitle.description; - - public intUI\Draw\Stroke::getJoin - - - - Renvoie le type de jointure de ce trait - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, ou UI\Draw\Line\Join::Bevel - - - - - - - diff --git a/reference/ui/ui/draw/stroke/getmiterlimit.xml b/reference/ui/ui/draw/stroke/getmiterlimit.xml deleted file mode 100644 index 1bbaeba0a7..0000000000 --- a/reference/ui/ui/draw/stroke/getmiterlimit.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Stroke::getMiterLimit - Renvoie la limite d'onglet - - - - &reftitle.description; - - public floatUI\Draw\Stroke::getMiterLimit - - - - Renvoie la limite d'onglet de ce trait - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la limite d'onglet actuelle - - - - - - - diff --git a/reference/ui/ui/draw/stroke/getthickness.xml b/reference/ui/ui/draw/stroke/getthickness.xml deleted file mode 100644 index 676246514e..0000000000 --- a/reference/ui/ui/draw/stroke/getthickness.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Stroke::getThickness - Renvoie l'épaisseur - - - - &reftitle.description; - - public floatUI\Draw\Stroke::getThickness - - - - Renvoie l'épaisseur de ce trait - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'épaisseur actuelle - - - - - - - diff --git a/reference/ui/ui/draw/stroke/setcap.xml b/reference/ui/ui/draw/stroke/setcap.xml deleted file mode 100644 index e84c8ae2db..0000000000 --- a/reference/ui/ui/draw/stroke/setcap.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Stroke::setCap - Définit la terminaison de trait - - - - &reftitle.description; - - public UI\Draw\Stroke::setCap - intcap - - - Définit la terminaison de ce trait - - - - - &reftitle.parameters; - - - cap - - - UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, ou UI\Draw\Line\Cap::Square - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/setjoin.xml b/reference/ui/ui/draw/stroke/setjoin.xml deleted file mode 100644 index b576994f29..0000000000 --- a/reference/ui/ui/draw/stroke/setjoin.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Draw\Stroke::setJoin - Définit la jointure de trait - - - - &reftitle.description; - - public UI\Draw\Stroke::setJoin - intjoin - - - Définit la jointure de ce trait - - - - - - &reftitle.parameters; - - - join - - - UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, ou UI\Draw\Line\Join::Bevel - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/setmiterlimit.xml b/reference/ui/ui/draw/stroke/setmiterlimit.xml deleted file mode 100644 index 3eb108ea64..0000000000 --- a/reference/ui/ui/draw/stroke/setmiterlimit.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Stroke::setMiterLimit - Définit la limite de miter - - - - &reftitle.description; - - public UI\Draw\Stroke::setMiterLimit - floatlimit - - - Définit la limite de miter pour ce trait - - - - - - &reftitle.parameters; - - - limit - - - La nouvelle limite - - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/setthickness.xml b/reference/ui/ui/draw/stroke/setthickness.xml deleted file mode 100644 index bc36899cc8..0000000000 --- a/reference/ui/ui/draw/stroke/setthickness.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Stroke::setThickness - Définit l'épaisseur - - - - &reftitle.description; - - public UI\Draw\Stroke::setThickness - floatthickness - - - Définit l'épaisseur pour ce trait - - - - - - &reftitle.parameters; - - - thickness - - - La nouvelle épaisseur - - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/construct.xml b/reference/ui/ui/draw/text/font.descriptor/construct.xml deleted file mode 100644 index 80a2bcbd09..0000000000 --- a/reference/ui/ui/draw/text/font.descriptor/construct.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::__construct - Construit un nouveau descripteur de police - - - - &reftitle.description; - - public UI\Draw\Text\Font\Descriptor::__construct - stringfamily - floatsize - intweightUI\Draw\Text\Font\Weight::Normal - intitalicUI\Draw\Text\Font\Italic::Normal - intstretchUI\Draw\Text\Font\Stretch::Normal - - - Construit un nouveau descripteur de police - - - - - - &reftitle.parameters; - - - family - - - Le nom d'une famille de polices valide - - - - - size - - - La taille préférée - - - - - weight - - - Une constante de UI\Draw\Text\Font\Weight - - - - - italic - - - Une constante de UI\Draw\Text\Font\Italic - - - - - stretch - - - Une constante de UI\Draw\Text\Font\Stretch - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getfamily.xml b/reference/ui/ui/draw/text/font.descriptor/getfamily.xml deleted file mode 100644 index 1d5b34561c..0000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getfamily.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getFamily - Renvoie la famille de police - - - - &reftitle.description; - - public stringUI\Draw\Text\Font\Descriptor::getFamily - - - - Renvoie la famille de police demandée - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getitalic.xml b/reference/ui/ui/draw/text/font.descriptor/getitalic.xml deleted file mode 100644 index 460b8f8caa..0000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getitalic.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getItalic - Détection de style - - - - &reftitle.description; - - public intUI\Draw\Text\Font\Descriptor::getItalic - - - - Renvoie la constante de paramètre - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getsize.xml b/reference/ui/ui/draw/text/font.descriptor/getsize.xml deleted file mode 100644 index 5f9d048adc..0000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getsize.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getSize - Détection de taille - - - - &reftitle.description; - - public floatUI\Draw\Text\Font\Descriptor::getSize - - - - Renvoie la taille demandée - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getstretch.xml b/reference/ui/ui/draw/text/font.descriptor/getstretch.xml deleted file mode 100644 index 22e4cf7e63..0000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getstretch.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getStretch - Détection de style - - - - &reftitle.description; - - public intUI\Draw\Text\Font\Descriptor::getStretch - - - - Renvoie l'extensibilité demandée - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getweight.xml b/reference/ui/ui/draw/text/font.descriptor/getweight.xml deleted file mode 100644 index e7a700494a..0000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getweight.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getWeight - Détection d'épaisseur - - - - &reftitle.description; - - public intUI\Draw\Text\Font\Descriptor::getWeight - - - - Renvoie l'épaisseur demandée - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/construct.xml b/reference/ui/ui/draw/text/font/construct.xml deleted file mode 100644 index 3ec3a835ea..0000000000 --- a/reference/ui/ui/draw/text/font/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Draw\Text\Font::__construct - Construit une nouvelle police - - - - &reftitle.description; - - public UI\Draw\Text\Font::__construct - UI\Draw\Text\Font\Descriptordescriptor - - - Construit une nouvelle police en utilisant le descripteur donné - - - - - - &reftitle.parameters; - - - descriptor - - - Le descripteur pour la police - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getascent.xml b/reference/ui/ui/draw/text/font/getascent.xml deleted file mode 100644 index ac0ad91e8e..0000000000 --- a/reference/ui/ui/draw/text/font/getascent.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font::getAscent - Métriques de police - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getAscent - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getdescent.xml b/reference/ui/ui/draw/text/font/getdescent.xml deleted file mode 100644 index 26df5ad9f2..0000000000 --- a/reference/ui/ui/draw/text/font/getdescent.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font::getDescent - Métriques de police - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getDescent - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getleading.xml b/reference/ui/ui/draw/text/font/getleading.xml deleted file mode 100644 index cb1e8fe730..0000000000 --- a/reference/ui/ui/draw/text/font/getleading.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font::getLeading - Métriques de police - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getLeading - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getunderlineposition.xml b/reference/ui/ui/draw/text/font/getunderlineposition.xml deleted file mode 100644 index d2e91a56b7..0000000000 --- a/reference/ui/ui/draw/text/font/getunderlineposition.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font::getUnderlinePosition - Métriques de police - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getUnderlinePosition - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getunderlinethickness.xml b/reference/ui/ui/draw/text/font/getunderlinethickness.xml deleted file mode 100644 index f0b94067fb..0000000000 --- a/reference/ui/ui/draw/text/font/getunderlinethickness.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font::getUnderlineThickness - Métriques de police - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getUnderlineThickness - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/layout/construct.xml b/reference/ui/ui/draw/text/layout/construct.xml deleted file mode 100644 index e377b78eab..0000000000 --- a/reference/ui/ui/draw/text/layout/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - UI\Draw\Text\Layout::__construct - Construit une nouvelle mise en page de texte - - - - &reftitle.description; - - public UI\Draw\Text\Layout::__construct - stringtext - UI\Draw\Text\Fontfont - floatwidth - - - Construit une nouvelle mise en page de texte - - - - - - &reftitle.parameters; - - - text - - - Le texte pour la mise en page - - - - - font - - - La police à utiliser pour l'écriture - - - - - width - - - La largeur de la mise en page - - - - - - - - - - - diff --git a/reference/ui/ui/draw/text/layout/setcolor.xml b/reference/ui/ui/draw/text/layout/setcolor.xml deleted file mode 100644 index dba3202821..0000000000 --- a/reference/ui/ui/draw/text/layout/setcolor.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - UI\Draw\Text\Layout::setColor - Définit la couleur - - - - &reftitle.description; - - public UI\Draw\Text\Layout::setColor - UI\Draw\Colorcolor - intstart0 - intend - - - public UI\Draw\Text\Layout::setColor - intcolor - intstart0 - intend - - - Définit la couleur pour tout, ou une plage de texte dans la mise en page - - - - - - &reftitle.parameters; - - - color - - - La couleur à utiliser - - - - - start - - - Le caractère de départ - - - - - end - - - Le caractère de fin, par défaut la fin de la chaîne - - - - - - - - - - diff --git a/reference/ui/ui/draw/text/layout/setwidth.xml b/reference/ui/ui/draw/text/layout/setwidth.xml deleted file mode 100644 index 05e5303151..0000000000 --- a/reference/ui/ui/draw/text/layout/setwidth.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Text\Layout::setWidth - Définit la largeur - - - - &reftitle.description; - - public UI\Draw\Text\Layout::setWidth - floatwidth - - - Définit la largeur de cette mise en page de texte - - - - - - &reftitle.parameters; - - - width - - - La nouvelle largeur - - - - - - - - - - diff --git a/reference/ui/ui/executor/construct.xml b/reference/ui/ui/executor/construct.xml deleted file mode 100644 index 0c89bd3f68..0000000000 --- a/reference/ui/ui/executor/construct.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - UI\Executor::__construct - Construit un nouvel exécuteur - - - - &reftitle.description; - - public UI\Executor::__construct - - - - public UI\Executor::__construct - intmicroseconds - - - public UI\Executor::__construct - intseconds - intmicroseconds - - - Construit un exécuteur avec l'intervalle donné, ne commencera pas à exécuter tant que la boucle principale n'est pas entrée - - - - - - &reftitle.parameters; - - - seconds - - - Le nombre de secondes entre les exécutions - - - - - microseconds - - - Le nombre de microsecondes entre les exécutions - - - - - - - - - - - - - diff --git a/reference/ui/ui/executor/kill.xml b/reference/ui/ui/executor/kill.xml deleted file mode 100644 index ab2add85ff..0000000000 --- a/reference/ui/ui/executor/kill.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Executor::kill - Arrête l'exécuteur - - - - &reftitle.description; - - public voidUI\Executor::kill - - - - Arrête un exécuteur, l'exécuteur ne peut pas être redémarré - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/executor/onexecute.xml b/reference/ui/ui/executor/onexecute.xml deleted file mode 100644 index c3d25caf09..0000000000 --- a/reference/ui/ui/executor/onexecute.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Executor::onExecute - Fonction de rappel d'exécution - - - - &reftitle.description; - - abstract protected voidUI\Executor::onExecute - - - - Doit être répétitivement mis en file d'attente pour exécution dans le thread principal - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/executor/setinterval.xml b/reference/ui/ui/executor/setinterval.xml deleted file mode 100644 index 71a360a5a6..0000000000 --- a/reference/ui/ui/executor/setinterval.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - UI\Executor::setInterval - Manipulation d'intervalles - - - - &reftitle.description; - - public boolUI\Executor::setInterval - intmicroseconds - - - public boolUI\Executor::setInterval - intseconds - intmicroseconds - - - Définit le nouvel intervalle. Un intervalle de 0 mettra en pause l'exécuteur jusqu'à ce qu'un nouvel intervalle soit défini - - - - - - &reftitle.parameters; - - - seconds - - - - - - - - microseconds - - - - - - - - - - - &reftitle.returnvalues; - - Indication de succès - - - - - - - diff --git a/reference/ui/ui/menu/append.xml b/reference/ui/ui/menu/append.xml deleted file mode 100644 index 888be5f270..0000000000 --- a/reference/ui/ui/menu/append.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Menu::append - Ajout d'un élément de menu - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::append - stringname - stringtypeUI\MenuItem::class - - - Ajoute un nouvel élément de menu - - - - - - &reftitle.parameters; - - - name - - - Le nom (texte) du nouvel élément - - - - - type - - - Le type du nouvel élément - - - - - - - - &reftitle.returnvalues; - - Un objet construit du type donné - - - - - - - diff --git a/reference/ui/ui/menu/appendabout.xml b/reference/ui/ui/menu/appendabout.xml deleted file mode 100644 index 4c6f9f1d51..0000000000 --- a/reference/ui/ui/menu/appendabout.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Menu::appendAbout - Ajoute un élément de menu À Propos - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::appendAbout - stringtypeUI\MenuItem::class - - - Ajoute un nouvel élément de menu À Propos - - - - - - &reftitle.parameters; - - - type - - - Le type du nouvel élément - - - - - - - - &reftitle.returnvalues; - - Un élément de menu À Propos construit du type donné - - - - - - - diff --git a/reference/ui/ui/menu/appendcheck.xml b/reference/ui/ui/menu/appendcheck.xml deleted file mode 100644 index e0658df656..0000000000 --- a/reference/ui/ui/menu/appendcheck.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Menu::appendCheck - Ajoute un élément de menu cochable - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::appendCheck - stringname - stringtypeUI\MenuItem::class - - - Ajoute un nouvel élément de menu cochable - - - - - - &reftitle.parameters; - - - name - - - Le nom (texte) du nouvel élément - - - - - type - - - Le type du nouvel élément - - - - - - - - &reftitle.returnvalues; - - Un élément de menu cochable construit du type donné - - - - - - - diff --git a/reference/ui/ui/menu/appendpreferences.xml b/reference/ui/ui/menu/appendpreferences.xml deleted file mode 100644 index 6ffadcc631..0000000000 --- a/reference/ui/ui/menu/appendpreferences.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Menu::appendPreferences - Ajoute un élément de menu Préférences - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::appendPreferences - stringtypeUI\MenuItem::class - - - Ajoute un nouvel élément de menu Préférences - - - - - - &reftitle.parameters; - - - type - - - Le type pour le nouvel élément - - - - - - - - &reftitle.returnvalues; - - Un élément de menu Préférences construit du type donné - - - - - - - diff --git a/reference/ui/ui/menu/appendquit.xml b/reference/ui/ui/menu/appendquit.xml deleted file mode 100644 index b0de985acb..0000000000 --- a/reference/ui/ui/menu/appendquit.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Menu::appendQuit - Ajoute un élément de menu Quitter - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::appendQuit - stringtypeUI\MenuItem::class - - - Ajoute un nouvel élément de menu Quitter - - - - - - &reftitle.parameters; - - - type - - - Le type pour le nouvel élément - - - - - - - - &reftitle.returnvalues; - - Un élément de menu Quitter construit du type donné - - - - - - - diff --git a/reference/ui/ui/menu/appendseparator.xml b/reference/ui/ui/menu/appendseparator.xml deleted file mode 100644 index f684aafa95..0000000000 --- a/reference/ui/ui/menu/appendseparator.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Menu::appendSeparator - Ajoute un séparateur d'éléments de menu - - - - &reftitle.description; - - public UI\Menu::appendSeparator - - - - Ajoute un séparateur - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menu/construct.xml b/reference/ui/ui/menu/construct.xml deleted file mode 100644 index fe228d86ae..0000000000 --- a/reference/ui/ui/menu/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Menu::__construct - Construit un nouveau menu - - - - &reftitle.description; - - public UI\Menu::__construct - stringname - - - Construit un nouveau menu - - - - - - &reftitle.parameters; - - - name - - - Le nom (texte) pour le menu - - - - - - - - - diff --git a/reference/ui/ui/menuitem/disable.xml b/reference/ui/ui/menuitem/disable.xml deleted file mode 100644 index 60577fadf6..0000000000 --- a/reference/ui/ui/menuitem/disable.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\MenuItem::disable - Désactive un élément de menu - - - - &reftitle.description; - - public UI\MenuItem::disable - - - - Désactive cet élément de menu. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menuitem/enable.xml b/reference/ui/ui/menuitem/enable.xml deleted file mode 100644 index 17d3b39f91..0000000000 --- a/reference/ui/ui/menuitem/enable.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\MenuItem::enable - Active un élément de menu - - - - &reftitle.description; - - public UI\MenuItem::enable - - - - Active un élément de menu. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menuitem/ischecked.xml b/reference/ui/ui/menuitem/ischecked.xml deleted file mode 100644 index fd0b69a023..0000000000 --- a/reference/ui/ui/menuitem/ischecked.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\MenuItem::isChecked - Détecte si un élément de menu est coché - - - - &reftitle.description; - - public boolUI\MenuItem::isChecked - - - - Détecte si cet élément de menu est coché. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menuitem/onclick.xml b/reference/ui/ui/menuitem/onclick.xml deleted file mode 100644 index b32dc4e3a4..0000000000 --- a/reference/ui/ui/menuitem/onclick.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\MenuItem::onClick - Fonction de rappel sur clic - - - - &reftitle.description; - - protected UI\MenuItem::onClick - - - - Doit être exécuté lorsque cet élément de menu est cliqué - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menuitem/setchecked.xml b/reference/ui/ui/menuitem/setchecked.xml deleted file mode 100644 index 1579cdae7f..0000000000 --- a/reference/ui/ui/menuitem/setchecked.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\MenuItem::setChecked - Définit si un élément de menu est coché - - - - &reftitle.description; - - public UI\MenuItem::setChecked - boolchecked - - - Définit si cet élément de menu est coché - - - - - - &reftitle.parameters; - - - checked - - - Le nouveau statut - - - - - - - - - diff --git a/reference/ui/ui/point/at.xml b/reference/ui/ui/point/at.xml deleted file mode 100644 index 80bbc772e1..0000000000 --- a/reference/ui/ui/point/at.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - UI\Point::at - Coercition de taille - - - - &reftitle.description; - - public static UI\PointUI\Point::at - floatpoint - - - public static UI\PointUI\Point::at - UI\Sizesize - - - Renvoie un objet UI\Point où x et y sont égaux à ceux fournis, soit sous forme de float, soit sous forme de UI\Size - - - - - - &reftitle.parameters; - - - point - - - La valeur pour x et y - - - - - size - - - La taille à convertir - - - - - - - - &reftitle.returnvalues; - - Le point résultant - - - - - - - diff --git a/reference/ui/ui/point/construct.xml b/reference/ui/ui/point/construct.xml deleted file mode 100644 index bcea6697fd..0000000000 --- a/reference/ui/ui/point/construct.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Point::__construct - Construit un nouveau Point - - - - &reftitle.description; - - public UI\Point::__construct - floatx - floaty - - - Construit un nouveau Point en utilisant de nouvelles coordonnées - - - - - &reftitle.parameters; - - - x - - - La nouvelle coordonnée X - - - - - y - - - La nouvelle coordonnée Y - - - - - - - - - diff --git a/reference/ui/ui/point/getx.xml b/reference/ui/ui/point/getx.xml deleted file mode 100644 index c3c54b1e9b..0000000000 --- a/reference/ui/ui/point/getx.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Point::getX - Renvoie X - - - - &reftitle.description; - - public floatUI\Point::getX - - - - Renvoie la coordonnée X - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La coordonnée X actuelle - - - - - - - diff --git a/reference/ui/ui/point/gety.xml b/reference/ui/ui/point/gety.xml deleted file mode 100644 index 70337b10d2..0000000000 --- a/reference/ui/ui/point/gety.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Point::getY - Renvoie Y - - - - &reftitle.description; - - public floatUI\Point::getY - - - - Renvoie la coordonnée Y - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La coordonnée Y actuelle - - - - - - - diff --git a/reference/ui/ui/point/setx.xml b/reference/ui/ui/point/setx.xml deleted file mode 100644 index 16fb5fa5bf..0000000000 --- a/reference/ui/ui/point/setx.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Point::setX - Définit X - - - - &reftitle.description; - - public UI\Point::setX - floatpoint - - - Définit la coordonnée X - - - - - &reftitle.parameters; - - - point - - - La nouvelle coordonnée X - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/point/sety.xml b/reference/ui/ui/point/sety.xml deleted file mode 100644 index eec09a46b3..0000000000 --- a/reference/ui/ui/point/sety.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Point::setY - Définit Y - - - - &reftitle.description; - - public UI\Point::setY - floatpoint - - - Définit la coordonnée Y - - - - - &reftitle.parameters; - - - point - - - La nouvelle coordonnée Y - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/size/construct.xml b/reference/ui/ui/size/construct.xml deleted file mode 100644 index 91b26fea5c..0000000000 --- a/reference/ui/ui/size/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - UI\Size::__construct - Construit une nouvelle taille - - - - &reftitle.description; - - public UI\Size::__construct - floatwidth - floatheight - - - Construit une nouvelle taille en utilisant la nouvelle largeur et la nouvelle hauteur - - - - - - &reftitle.parameters; - - - width - - - La nouvelle largeur - - - - - height - - - La nouvelle hauteur - - - - - - - - - - - - - diff --git a/reference/ui/ui/size/getheight.xml b/reference/ui/ui/size/getheight.xml deleted file mode 100644 index d345eddea7..0000000000 --- a/reference/ui/ui/size/getheight.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - UI\Size::getHeight - Renvoie la hauteur - - - - &reftitle.description; - - public floatUI\Size::getHeight - - - - Renvoie la hauteur - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La hauteur actuelle - - - - - diff --git a/reference/ui/ui/size/getwidth.xml b/reference/ui/ui/size/getwidth.xml deleted file mode 100644 index c040c31e37..0000000000 --- a/reference/ui/ui/size/getwidth.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Size::getWidth - Renvoie la largeur - - - - &reftitle.description; - - public floatUI\Size::getWidth - - - - Renvoie la largeur - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la largeur actuelle - - - - - - - diff --git a/reference/ui/ui/size/of.xml b/reference/ui/ui/size/of.xml deleted file mode 100644 index 35b0cd57fd..0000000000 --- a/reference/ui/ui/size/of.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - UI\Size::of - Coercition de Point - - - - &reftitle.description; - - public static UI\SizeUI\Size::of - floatsize - - - public static UI\SizeUI\Size::of - UI\Pointpoint - - - Renvoie un objet UI\Size où la largeur et la hauteur sont égales à celles fournies, soit sous forme de float, soit sous forme de UI\Point - - - - - - &reftitle.parameters; - - - size - - - La valeur pour la largeur et la hauteur - - - - - point - - - Le Point à convertir - - - - - - - - &reftitle.returnvalues; - - La taille résultante - - - - - - - diff --git a/reference/ui/ui/size/setheight.xml b/reference/ui/ui/size/setheight.xml deleted file mode 100644 index 83261d4ea1..0000000000 --- a/reference/ui/ui/size/setheight.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Size::setHeight - Définit la hauteur - - - - &reftitle.description; - - public UI\Size::setHeight - floatsize - - - Définit la nouvelle hauteur - - - - - - &reftitle.parameters; - - - size - - - La nouvelle hauteur - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/size/setwidth.xml b/reference/ui/ui/size/setwidth.xml deleted file mode 100644 index 4b1f054657..0000000000 --- a/reference/ui/ui/size/setwidth.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Size::setWidth - Définit la largeur - - - - &reftitle.description; - - public UI\Size::setWidth - floatsize - - - Définit la nouvelle largeur - - - - - - &reftitle.parameters; - - - size - - - La nouvelle largeur - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/add.xml b/reference/ui/ui/window/add.xml deleted file mode 100644 index 0be8c36978..0000000000 --- a/reference/ui/ui/window/add.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Window::add - Ajoute un contrôle - - - - &reftitle.description; - - public UI\Window::add - UI\Controlcontrol - - - Ajoute un contrôle à cette fenêtre - - - - - - &reftitle.parameters; - - - control - - - Le contrôle à ajouter - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/construct.xml b/reference/ui/ui/window/construct.xml deleted file mode 100644 index 221ae5f2c1..0000000000 --- a/reference/ui/ui/window/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - UI\Window::__construct - Construit une nouvelle fenêtre - - - - &reftitle.description; - - public UI\Window::__construct - stringtitle - Sizesize - boolmenu&false; - - - Construit une nouvelle fenêtre - - - - - - &reftitle.parameters; - - - title - - - Le titre de la fenêtre - - - - - size - - - La taille de la fenêtre - - - - - menu - - - Changeur de menu - - - - - - - - - - - - - diff --git a/reference/ui/ui/window/error.xml b/reference/ui/ui/window/error.xml deleted file mode 100644 index d6adf0da8f..0000000000 --- a/reference/ui/ui/window/error.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - UI\Window::error - Affiche un message d'erreur - - - - &reftitle.description; - - public UI\Window::error - stringtitle - stringmsg - - - Devrait montrer un message d'erreur - - - - - - &reftitle.parameters; - - - title - - - Titre du message d'erreur - - - - - msg - - - Message d'erreur - - - - - - - - - - diff --git a/reference/ui/ui/window/getsize.xml b/reference/ui/ui/window/getsize.xml deleted file mode 100644 index 01c22a0cc7..0000000000 --- a/reference/ui/ui/window/getsize.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::getSize - Renvoie la taille de la fenêtre - - - - &reftitle.description; - - public UI\SizeUI\Window::getSize - - - - Renvoie la taille de cette fenêtre - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/gettitle.xml b/reference/ui/ui/window/gettitle.xml deleted file mode 100644 index 8f400d1b73..0000000000 --- a/reference/ui/ui/window/gettitle.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::getTitle - Renvoie le titre - - - - &reftitle.description; - - public stringUI\Window::getTitle - - - - Renvoie le titre de cette fenêtre - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/hasborders.xml b/reference/ui/ui/window/hasborders.xml deleted file mode 100644 index d991ed5452..0000000000 --- a/reference/ui/ui/window/hasborders.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::hasBorders - Détection des bordures - - - - &reftitle.description; - - public boolUI\Window::hasBorders - - - - Détecte si des bordures sont utilisées sur cette fenêtre - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/hasmargin.xml b/reference/ui/ui/window/hasmargin.xml deleted file mode 100644 index 6243fff6fa..0000000000 --- a/reference/ui/ui/window/hasmargin.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::hasMargin - Détection de margin - - - - &reftitle.description; - - public boolUI\Window::hasMargin - - - - Détecte si des marges sont utilisées sur cette fenêtre - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/isfullscreen.xml b/reference/ui/ui/window/isfullscreen.xml deleted file mode 100644 index 090322891e..0000000000 --- a/reference/ui/ui/window/isfullscreen.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::isFullScreen - Détection de plein écran - - - - &reftitle.description; - - public boolUI\Window::isFullScreen - - - - Détecte si cette fenêtre utilise tout l'écran - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/msg.xml b/reference/ui/ui/window/msg.xml deleted file mode 100644 index d91a651cf8..0000000000 --- a/reference/ui/ui/window/msg.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Window::msg - Affiche une boîte de message - - - - &reftitle.description; - - public UI\Window::msg - stringtitle - stringmsg - - - Affiche une boîte de message - - - - - - &reftitle.parameters; - - - title - - - Le titre de la boîte de message - - - - - msg - - - Le message - - - - - - - - - - diff --git a/reference/ui/ui/window/onclosing.xml b/reference/ui/ui/window/onclosing.xml deleted file mode 100644 index 66d33f196f..0000000000 --- a/reference/ui/ui/window/onclosing.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::onClosing - Fonction de rappel de fermeture - - - - &reftitle.description; - - protected intUI\Window::onClosing - - - - Doit détruire gracieusement cette fenêtre - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/open.xml b/reference/ui/ui/window/open.xml deleted file mode 100644 index 2c2ec3c7a8..0000000000 --- a/reference/ui/ui/window/open.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::open - Ouvre une boîte de dialogue - - - - &reftitle.description; - - public stringUI\Window::open - - - - Ouvre une boîte de dialogue pour ouvrir un fichier - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom du fichier sélectionné pour l'ouverture - - - - - - - diff --git a/reference/ui/ui/window/save.xml b/reference/ui/ui/window/save.xml deleted file mode 100644 index ff0374fe24..0000000000 --- a/reference/ui/ui/window/save.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::save - Boîte de sauvegarde - - - - &reftitle.description; - - public stringUI\Window::save - - - - Affiche une boîte de sauvegarde - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom du fichier sélectionné pour la sauvegarde - - - - - - - diff --git a/reference/ui/ui/window/setborders.xml b/reference/ui/ui/window/setborders.xml deleted file mode 100644 index 373a2c98a6..0000000000 --- a/reference/ui/ui/window/setborders.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Window::setBorders - Utilisation des bordures - - - - &reftitle.description; - - public UI\Window::setBorders - boolborders - - - Active ou désactive l'utilisation des bordures sur cette fenêtre - - - - - - &reftitle.parameters; - - - borders - - - - - - - - - - - - - diff --git a/reference/ui/ui/window/setfullscreen.xml b/reference/ui/ui/window/setfullscreen.xml deleted file mode 100644 index 1c7a73092d..0000000000 --- a/reference/ui/ui/window/setfullscreen.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - UI\Window::setFullScreen - Utilisation du plein écran - - - - &reftitle.description; - - public UI\Window::setFullScreen - boolfull - - - Active ou désactive l'utilisation du plein écran pour cette fenêtre - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - full - - - - - - - - - - - - - diff --git a/reference/ui/ui/window/setmargin.xml b/reference/ui/ui/window/setmargin.xml deleted file mode 100644 index 9bbbcf25d0..0000000000 --- a/reference/ui/ui/window/setmargin.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Window::setMargin - Utilisation des margins - - - - &reftitle.description; - - public UI\Window::setMargin - boolmargin - - - Active ou désactive l'utilisation des marges pour cette fenêtre - - - - - - &reftitle.parameters; - - - margin - - - - - - - - - - - - - diff --git a/reference/ui/ui/window/setsize.xml b/reference/ui/ui/window/setsize.xml deleted file mode 100644 index b31bdc0571..0000000000 --- a/reference/ui/ui/window/setsize.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Window::setSize - Définit la taille - - - - &reftitle.description; - - public UI\Window::setSize - UI\Sizesize - - - Définit la taille de cette fenêtre - - - - - - &reftitle.parameters; - - - size - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/settitle.xml b/reference/ui/ui/window/settitle.xml deleted file mode 100644 index f366d01922..0000000000 --- a/reference/ui/ui/window/settitle.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Window::setTitle - Titre de la fenêtre - - - - &reftitle.description; - - public UI\Window::setTitle - stringtitle - - - Définit le titre de cette fenêtre - - - - - - &reftitle.parameters; - - - title - - - Le nouveau titre - - - - - - - - - - diff --git a/reference/uopz/book.xml b/reference/uopz/book.xml deleted file mode 100644 index b23410c95a..0000000000 --- a/reference/uopz/book.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - Opérations utilisateurs pour Zend - uopz - - - &reftitle.intro; - - L'extension uopz - User Operations for Zend (NdT : les opérations utilisateurs pour Zend) - - expose les fonctionnalités du moteur Zend, normalement utilisées au moment de - la compilation et de l'exécution, afin de permettre la modification des - structures internes que représentent le code PHP, et pour le code utilisateur - d'interagir avec la VM. - - - uopz supporte les activités suivantes : - - - Surcharge d'opcodes incluant ZEND_EXIT et ZEND_NEW - Sauvegarde et restauration des fonctions et méthodes - Renommage des fonctions et des méthodes - Copie des fonctions et des méthodes - Suppression des fonctions et des méthodes - Re-définition des constantes globales et de classe - Suppression des constantes globales et de classe - Composition et modification de classes à l'exécution - - - - Toutes les activités supportées sont compatibles avec opcache. - - - - - PECL uopz 6.1.1 n'est pas compatible avec Xdebug >= 2.9.4. - Les versions ultérieures de uopz ne sont pas compatibles avec Xdebug < 2.9.4. - - - - - &reference.uopz.setup; - &reference.uopz.constants; - &reference.uopz.reference; - - - - diff --git a/reference/uopz/configure.xml b/reference/uopz/configure.xml deleted file mode 100644 index 4703505c3c..0000000000 --- a/reference/uopz/configure.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - -
    - &reftitle.install; - - - Utiliser - lors de la compilation de PHP. - - - - Les utilisateurs de Windows doivent inclure la bibliothèque - php_uopz.dll dans le &php.ini; - - -
    - - - diff --git a/reference/uopz/constants.xml b/reference/uopz/constants.xml deleted file mode 100644 index 0272db0cbf..0000000000 --- a/reference/uopz/constants.xml +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Les opcodes suivants sont définis comme des constantes par uopz avant 5.0.0 : - - - - - - ZEND_EXIT - (int) - - - - Invoque exit() et die() ; réceptionne aucun argument. - Retourne &true; pour sortir, &false; pour continuer - - - - - - ZEND_NEW - (int) - - - - Invoqué par la construction d'un objet, reçoit l'objet de la classe créée comme - seul argument - - - - - - ZEND_THROW - (int) - - - - Invoqué par la structure throw, reçoit l'exception de la classe émise comme seul argument - - - - - - ZEND_FETCH_CLASS - (int) - - - - Invoqué lors d'une composition, reçoit la classe, le nom de la classe récupérée comme seul argument - - - - - - ZEND_ADD_TRAIT - (int) - - - - Invoqué lors d'une composition, reçoit la classe dans laquelle le trait sera ajouté, comme premier - argument, et le nom du trait comme second argument - - - - - - ZEND_ADD_INTERFACE - (int) - - - - Invoqué lors d'une composition, reçoit la classe dans laquelle l'interface sera ajoutée comme premier - argument, et le nom de l'interface comme second argument - - - - - - ZEND_INSTANCEOF - (int) - - - - Invoqué par l'opérateur instanceof, reçoit l'objet a vérifier comme premier argument, - et le nom de la classe dont l'objet appartient comme second argument - - - - - - - Les constantes suivantes contrôlent le comportement de la VM après qu'un gestionnaire utilisateur ne - soit appelé ; soyez extrêmement prudent ! - Ces constantes sont supprimées à partir de uopz 5.0.0. - - - - - - ZEND_USER_OPCODE_CONTINUE - (int) - - - - Avance d'un opcode, et continue - - - - - - ZEND_USER_OPCODE_ENTER - (int) - - - - Entre dans un nouvel op_array sans récursion - - - - - - ZEND_USER_OPCODE_LEAVE - (int) - - - - Retourne l'op_array appelé dans le même exécuteur - - - - - - ZEND_USER_OPCODE_DISPATCH - (int) - - - - Dispatche le gestionnaire opcode original - - - - - - ZEND_USER_OPCODE_DISPATCH_TO - (int) - - - - Distribue à un gestionnaire spécifique - - - - - - ZEND_USER_OPCODE_RETURN - (int) - - - - Sort de l'exécuteur (retourne à la fonction) - - - - - - - Les modificateurs suivants sont enregistrés comme constantes par uopz - - - - - - ZEND_ACC_PUBLIC - (int) - - - - Marque une fonction comme publique, le comportement par défaut - - - - - - ZEND_ACC_PROTECTED - (int) - - - - Marque une fonction comme protégée - - - - - - ZEND_ACC_PRIVATE - (int) - - - - Marque une fonction comme privée - - - - - - ZEND_ACC_STATIC - (int) - - - - Marque une fonction comme statique - - - - - - ZEND_ACC_FINAL - (int) - - - - Marque une fonction comme finale - - - - - - ZEND_ACC_ABSTRACT - (int) - - - - Marque une fonction comme abstraite - - - - - - ZEND_ACC_CLASS - (int) - - - - Enregistrement pour la consistence, l'entrée par défaut d'une classe. - Supprimée à partir de uopz 5.0.0. - - - - - - ZEND_ACC_INTERFACE - (int) - - - - Marque la classe comme étant une interface. - Supprimée à partir de uopz 5.0.0. - - - - - - ZEND_ACC_TRAIT - (int) - - - - Marque la classe comme étant trait. - Supprimée à partir de uopz 5.0.0. - - - - - - ZEND_ACC_FETCH - (int) - - - - Utilisé pour récupérer seulement les drapeaux. - Supprimée à partir de uopz 5.0.0. - - - - - - - - - diff --git a/reference/uopz/functions/uopz-add-function.xml b/reference/uopz/functions/uopz-add-function.xml deleted file mode 100644 index 9d9b462e44..0000000000 --- a/reference/uopz/functions/uopz-add-function.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - uopz_add_function - Ajoute une fonction ou une méthode inexistante - - - - &reftitle.description; - - booluopz_add_function - stringfunction - Closurehandler - intflagsZEND_ACC_PUBLIC - - - booluopz_add_function - stringclass - stringfunction - Closurehandler - intflagsZEND_ACC_PUBLIC - intall&true; - - - Ajoute une fonction ou une méthode inexistante. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe. - - - - - function - - - Le nom de la fonction ou de la méthode. - - - - - handler - - - La Closure qui définit la nouvelle fonction ou méthode. - - - - - flags - - - Les drapeaux à définir pour la nouvelle fonction ou méthode. - - - - - all - - - Si toutes les classes qui descendent de class seront - également affectées. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - uopz_add_function lance une RuntimeException - si la fonction ou la méthode à ajouter existe déjà. - - - - - &reftitle.examples; - - Utilisation basique de <function>uopz_add_function</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_del_function - uopz_set_return - - - - - - diff --git a/reference/uopz/functions/uopz-allow-exit.xml b/reference/uopz/functions/uopz-allow-exit.xml deleted file mode 100644 index a68fd6fb99..0000000000 --- a/reference/uopz/functions/uopz-allow-exit.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - uopz_allow_exit - Permet de contrôler l'opcode exit désactivé - - - - &reftitle.description; - - voiduopz_allow_exit - boolallow - - - Par défaut, uopz désactive l'opcode exit, donc les appels à exit - sont pratiquement ignorés. uopz_allow_exit - permet de contrôler ce comportement. - - - - - &reftitle.parameters; - - - allow - - - Autoriser ou non l'exécution des opcodes exit. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple de <function>uopz_allow_exit</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - OPcache optimise le code mort après une sortie inconditionnelle. - - - - - - &reftitle.seealso; - - uopz_get_exit_status - - - - - - diff --git a/reference/uopz/functions/uopz-backup.xml b/reference/uopz/functions/uopz-backup.xml deleted file mode 100644 index 1ff0271143..0000000000 --- a/reference/uopz/functions/uopz-backup.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - uopz_backup - Sauvegarde une fonction - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_backup - stringfunction - - - voiduopz_backup - stringclass - stringfunction - - - Sauvegarde une fonction à l'exécution. - - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe contenant la fonction à sauvegarder - - - - - function - - - Le nom de la fonction - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <function>uopz_backup</function> - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-compose.xml b/reference/uopz/functions/uopz-compose.xml deleted file mode 100644 index fac521f374..0000000000 --- a/reference/uopz/functions/uopz-compose.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - - - uopz_compose - Compose une classe - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_compose - stringname - arrayclasses - arraymethods - arrayproperties - intflags - - - Crée une nouvelle classe de nom spécifié, qui implémente, étend ou - utilise toutes les classes fournies. - - - - - &reftitle.parameters; - - - name - - - Un nom de classe valide - - - - - classes - - - Un tableau de classes, d'interfaces ou de noms trait - - - - - methods - - - Un tableau associatif de méthodes ; les valeurs sont soit des - closures, soit des [modifiers => closure] - - - - - properties - - - Un tableau associatif de propriétés, ayant comme clés les noms, - et comme valeurs, les modificateurs - - - - - flags - - - Type d'entrée ; par défaut, ZEND_ACC_CLASS - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <function>uopz_compose</function> - - function() { - /* ... */ - } -]); - -var_dump( - class_uses(Composed::class), - class_parents(Composed::class), - class_implements(Composed::class)); -?> -]]> - - &example.outputs; - - - string(7) "myTrait" -} -array(1) { - ["myClass"]=> - string(7) "myClass" -} -array(1) { - ["myInterface"]=> - string(11) "myInterface" -} -]]> - - - - - - - - diff --git a/reference/uopz/functions/uopz-copy.xml b/reference/uopz/functions/uopz-copy.xml deleted file mode 100644 index 3915092cc3..0000000000 --- a/reference/uopz/functions/uopz-copy.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - uopz_copy - Copie une fonction - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - Closureuopz_copy - stringfunction - - - Closureuopz_copy - stringclass - stringfunction - - - Copie une fonction à partir de son nom. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe contenant la fonction à copier - - - - - function - - - Le nom de la fonction - - - - - - - - &reftitle.returnvalues; - - Une closure pour la fonction spécifiée. - - - - - &reftitle.examples; - - Exemple avec <function>uopz_copy</function> - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-del-function.xml b/reference/uopz/functions/uopz-del-function.xml deleted file mode 100644 index 7cc3607ec4..0000000000 --- a/reference/uopz/functions/uopz-del-function.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - uopz_del_function - Supprime une fonction ou une méthode précédemment ajoutée - - - - &reftitle.description; - - booluopz_del_function - stringfunction - - - booluopz_del_function - stringclass - stringfunction - intall&true; - - - Supprime une fonction ou une méthode précédemment ajoutée. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe. - - - - - function - - - Le nom de la fonction ou de la méthode. - - - - - all - - - Si toutes les classes qui descendent de class seront également affectées. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - uopz_del_function lance une RuntimeException - si la fonction ou la méthode à supprimer n'a pas été ajoutée par uopz_add_function. - - - - - &reftitle.examples; - - Utilisation basique de <function>uopz_del_function</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_add_function - uopz_unset_return - - - - - - diff --git a/reference/uopz/functions/uopz-delete.xml b/reference/uopz/functions/uopz-delete.xml deleted file mode 100644 index 4461e3b9c6..0000000000 --- a/reference/uopz/functions/uopz-delete.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - uopz_delete - Supprime une fonction - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_delete - stringfunction - - - voiduopz_delete - stringclass - stringfunction - - - Supprime une fonction ou une méthode. - - - - - &reftitle.parameters; - - - class - - - - - - - function - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <function>uopz_delete</function> - - -]]> - - &example.outputs.similar; - - - - - - Exemple avec <function>uopz_delete</function> et une classe - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-extend.xml b/reference/uopz/functions/uopz-extend.xml deleted file mode 100644 index 428da533bb..0000000000 --- a/reference/uopz/functions/uopz-extend.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - - uopz_extend - Etend une classe à l'exécution - - - - &reftitle.description; - - booluopz_extend - stringclass - stringparent - - - Etend la classe class en utilisant - la classe parent. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe à étendre - - - - - parent - - - Le nom de la classe parent - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - À partir de PHP 7.4.0, uopz_extend émet une - RuntimeException, si - OPcache est activé, et l'entrée de classe - de class ou parent (si dans - un trait) est immutable. - - - - - &reftitle.examples; - - Exemple avec <function>uopz_extend</function> - - -]]> - - &example.outputs; - - - string(1) "B" -} -]]> - - - - - - - diff --git a/reference/uopz/functions/uopz-flags.xml b/reference/uopz/functions/uopz-flags.xml deleted file mode 100644 index 565ea2a93b..0000000000 --- a/reference/uopz/functions/uopz-flags.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - - uopz_flags - Récupère ou défini les drapeaux d'une fonction ou d'une classe - - - - &reftitle.description; - - intuopz_flags - stringfunction - intflagsPHP_INT_MAX - - - intuopz_flags - stringclass - stringfunction - intflagsPHP_INT_MAX - - - Récupère ou défini les drapeaux d'une classe ou de l'entrée d'une - fonction à l'exécution. - - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe - - - - - function - - - Le nom de la fonction. Si class est fournie et - qu'une &string; vide est passée comme function, - uopz_flags récupère ou définit les drapeaux de - l'entrée de classe. - - - - - flags - - - Un jeu valide de drapeaux ZEND_ACC_ flags. - Si omis, uopz_flags agit comme un récupérateur. - - - - - - - - &reftitle.returnvalues; - - Si des drapeaux ont été définis, retourne les anciens drapeaux, - sinon, retourne les drapeaux courants - - - - - &reftitle.errors; - - À partir de PHP 7.4.0, si le paramètre flags est - fourni uopz_flags émet une - RuntimeException, si - OPcache est activé, et l'entrée de classe - de class ou l'entrée de fonction - function est immutable. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL uopz 5.0.0 - - Le paramètre flags est désormais optionnel. Auparavant, - ZEND_ACC_FETCH devait être passé pour utiliser - uopz_flags en tant que récupérateur. - - - - - - - - - &reftitle.examples; - - Exemple avec <function>uopz_flags</function> - - -]]> - - &example.outputs; - - - - - - Transformer une Classe finale en non-finale - -isFinal()); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-function.xml b/reference/uopz/functions/uopz-function.xml deleted file mode 100644 index a96bcfde81..0000000000 --- a/reference/uopz/functions/uopz-function.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - - uopz_function - Crée une fonction à l'exécution - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_function - stringfunction - Closurehandler - intmodifiers - - - voiduopz_function - stringclass - stringfunction - Closurehandler - intmodifiers - - - Crée une fonction à l'exécution. - - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe qui doit recevoir la nouvelle fonction - - - - - function - - - Le nom de la fonction - - - - - handler - - - La closure de la fonction - - - - - modifiers - - - Les modificateurs de la fonction ; par défaut, copié ou - ZEND_ACC_PUBLIC - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <function>uopz_function</function> - - -]]> - - &example.outputs.similar; - - - - - - Exemple avec <function>uopz_function</function> et une classe - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-get-exit-status.xml b/reference/uopz/functions/uopz-get-exit-status.xml deleted file mode 100644 index 771d8730a0..0000000000 --- a/reference/uopz/functions/uopz-get-exit-status.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - uopz_get_exit_status - Renvoie le dernier statut de sortie défini - - - - &reftitle.description; - - mixeduopz_get_exit_status - - - - Renvoie le dernier statut de sortie défini, c'est-à-dire la valeur passée à - exit. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Cette fonction renvoie le dernier statut de sortie, ou &null; si exit - n'a pas été appelée. - - - - - &reftitle.examples; - - Exemple de <function>uopz_get_exit_status</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - OPcache optimise le code mort après une sortie inconditionnelle. - - - - - - &reftitle.seealso; - - uopz_allow_exit - - - - - - diff --git a/reference/uopz/functions/uopz-get-hook.xml b/reference/uopz/functions/uopz-get-hook.xml deleted file mode 100644 index 52b491d93d..0000000000 --- a/reference/uopz/functions/uopz-get-hook.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - uopz_get_hook - Renvoie le hook précédemment défini sur une fonction ou une méthode - - - - &reftitle.description; - - Closureuopz_get_hook - stringfunction - - - Closureuopz_get_hook - stringclass - stringfunction - - - Renvoie le hook précédemment défini sur une fonction ou une méthode. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe. - - - - - function - - - Le nom de la fonction ou de la méthode. - - - - - - - - &reftitle.returnvalues; - - Renvoie le hook précédemment défini sur une fonction ou une méthode, ou &null; si aucun hook - n'a été défini. - - - - - &reftitle.examples; - - Utilisation basique de <function>uopz_get_hook</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - uopz_set_hook - uopz_unset_hook - - - - - - diff --git a/reference/uopz/functions/uopz-get-mock.xml b/reference/uopz/functions/uopz-get-mock.xml deleted file mode 100644 index 1219797f48..0000000000 --- a/reference/uopz/functions/uopz-get-mock.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - uopz_get_mock - Renvoie la simulation actuelle d'une classe - - - - &reftitle.description; - - mixeduopz_get_mock - stringclass - - - Renvoie la simulation actuelle de class. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe simulée. - - - - - - - &reftitle.returnvalues; - - Soit une chaîne contenant le nom de la simulation, soit un objet, - soit &null; si aucune simulation n'a été définie. - - - - - &reftitle.examples; - - Exemple de <function>uopz_get_mock</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_set_mock - uopz_unset_mock - - - - - - diff --git a/reference/uopz/functions/uopz-get-property.xml b/reference/uopz/functions/uopz-get-property.xml deleted file mode 100644 index f85b08ac4d..0000000000 --- a/reference/uopz/functions/uopz-get-property.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - uopz_get_property - Renvoie la valeur d'une propriété de classe ou d'instance - - - - &reftitle.description; - - mixeduopz_get_property - stringclass - stringproperty - - - mixeduopz_get_property - objectinstance - stringproperty - - - Renvoie la valeur d'une propriété de classe statique, si class - est donné, ou la valeur d'une propriété d'instance, si instance - est donné. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe. - - - - - instance - - - L'instance de l'objet. - - - - - property - - - Le nom de la propriété. - - - - - - - - &reftitle.returnvalues; - - Renvoie la valeur de la propriété de classe ou d'instance, ou &null; si la propriété - n'est pas définie. - - - - - &reftitle.examples; - - Utilisation basique de <function>uopz_get_property</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - uopz_set_property - - - - - - diff --git a/reference/uopz/functions/uopz-get-return.xml b/reference/uopz/functions/uopz-get-return.xml deleted file mode 100644 index 183ba53192..0000000000 --- a/reference/uopz/functions/uopz-get-return.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - uopz_get_return - Renvoie une valeur de retour précédemment définie pour une fonction - - - - &reftitle.description; - - mixeduopz_get_return - stringfunction - - - mixeduopz_get_return - stringclass - stringfunction - - - Renvoie la valeur de retour de la function précédemment définie par uopz_set_return. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe contenant la fonction - - - - - function - - - Le nom de la fonction - - - - - - - - &reftitle.returnvalues; - - La valeur de retour ou la Closure précédemment définie. - - - - - &reftitle.examples; - - Exemple de <function>uopz_get_return</function> - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-get-static.xml b/reference/uopz/functions/uopz-get-static.xml deleted file mode 100644 index 2fd480adb4..0000000000 --- a/reference/uopz/functions/uopz-get-static.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - uopz_get_static - Renvoie les variables statiques d'une fonction ou d'une méthode - - - - &reftitle.description; - - arrayuopz_get_static - stringclass - stringfunction - - - arrayuopz_get_static - stringfunction - - - Renvoie les variables statiques d'une fonction ou d'une méthode. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe. - - - - - function - - - Le nom de la fonction ou de la méthode. - - - - - - - - &reftitle.returnvalues; - - Renvoie un array associatif de noms de variables mappés à leurs - valeurs actuelles en cas de succès, ou &null; si la fonction ou la méthode n'existe pas. - - - À partir de PHP 8.3.0, les initialisateurs statiques sont soit calculés lors de la compilation, - ou si cela n'est pas possible, uniquement lorsque la fonction ou la méthode est exécutée - pour la première fois, auquel cas la valeur de la variable statique est rapportée comme &null; - avant la première invocation. - - - - - &reftitle.examples; - - Utilisation basique de <function>uopz_get_static</function> - - -]]> - - &example.outputs; - - - string(3) "baz" -} -]]> - - - - - - &reftitle.seealso; - - ReflectionFunctionAbstract::getStaticVariables - uopz_set_static - - - - - - diff --git a/reference/uopz/functions/uopz-implement.xml b/reference/uopz/functions/uopz-implement.xml deleted file mode 100644 index 0e1692aa81..0000000000 --- a/reference/uopz/functions/uopz-implement.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - uopz_implement - Implémente une interface à l'exécution - - - - &reftitle.description; - - booluopz_implement - stringclass - stringinterface - - - Implémente l'interface interface dans la classe - class. - - - - - - &reftitle.parameters; - - - class - - - - - - - - interface - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - À partir de PHP 7.4.0, uopz_implement émet une - RuntimeException, si - OPcache est activé, et l'entrée de classe - de class est immutable. - - - - - &reftitle.examples; - - Exemple avec <function>uopz_implement</function> - - -]]> - - &example.outputs; - - - string(11) "myInterface" -} -]]> - - - - - - - - diff --git a/reference/uopz/functions/uopz-overload.xml b/reference/uopz/functions/uopz-overload.xml deleted file mode 100644 index 82ed8832a3..0000000000 --- a/reference/uopz/functions/uopz-overload.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - uopz_overload - Surcharge un opcode VM - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_overload - intopcode - Callablecallable - - - Surcharge l'opcode spécifié avec une fonction - définie par l'utilisateur. - - - - - - &reftitle.parameters; - - - opcode - - - Un opcode valide ; voir les constantes pour plus de détails - sur les codes supportés - - - - - callable - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <function>uopz_overload</function> - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-redefine.xml b/reference/uopz/functions/uopz-redefine.xml deleted file mode 100644 index d0bf4fda7c..0000000000 --- a/reference/uopz/functions/uopz-redefine.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - - uopz_redefine - Re-défini une constante - - - - &reftitle.description; - - booluopz_redefine - stringconstant - mixedvalue - - - booluopz_redefine - stringclass - stringconstant - mixedvalue - - - Re-défini la constante constant fournie, - en value. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe contenant la constante - - - - - constant - - - Le nom de la constante - - - - - value - - - La nouvelle valeur de la constante ; doit être un type valide pour - une constante - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>uopz_redefine</function> - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-rename.xml b/reference/uopz/functions/uopz-rename.xml deleted file mode 100644 index 74ba933360..0000000000 --- a/reference/uopz/functions/uopz-rename.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - - uopz_rename - Renomme une fonction à l'exécution - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_rename - stringfunction - stringrename - - - voiduopz_rename - stringclass - stringfunction - stringrename - - - Renomme la fonction function en rename. - - - - Si les deux fonctions existent, leurs noms seront inversés. - - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe contenant la fonction - - - - - function - - - Le nom d'une fonction existante - - - - - rename - - - Le nouveau nom de la fonction - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <function>uopz_rename</function> - - -]]> - - &example.outputs; - - - - - - Exemple avec <function>uopz_rename</function> et une classe - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-restore.xml b/reference/uopz/functions/uopz-restore.xml deleted file mode 100644 index dd1bdd1705..0000000000 --- a/reference/uopz/functions/uopz-restore.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - uopz_restore - Restaure une fonction sauvegardée - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_restore - stringfunction - - - voiduopz_restore - stringclass - stringfunction - - - Restaure une fonction sauvegardée. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe contenant la fonction à restaurer - - - - - function - - - Le nom de la fonction - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <function>uopz_restore</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-set-hook.xml b/reference/uopz/functions/uopz-set-hook.xml deleted file mode 100644 index e4c1b40856..0000000000 --- a/reference/uopz/functions/uopz-set-hook.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - uopz_set_hook - Définit le hook à exécuter lors de l'entrée dans une fonction ou une méthode - - - - &reftitle.description; - - booluopz_set_hook - stringfunction - Closurehook - - - booluopz_set_hook - stringclass - stringfunction - Closurehook - - - Définit un hook à exécuter lors de l'entrée dans une fonction ou une méthode. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe. - - - - - function - - - Le nom de la fonction ou de la méthode. - - - - - hook - - - Une fermeture à exécuter lors de l'entrée dans la fonction ou la méthode. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Utilisation basique de <function>uopz_set_hook</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_get_hook - uopz_unset_hook - - - - - - diff --git a/reference/uopz/functions/uopz-set-mock.xml b/reference/uopz/functions/uopz-set-mock.xml deleted file mode 100644 index e8381680af..0000000000 --- a/reference/uopz/functions/uopz-set-mock.xml +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - uopz_set_mock - Utilise une simulation au lieu d'une classe pour de nouveaux objets - - - - &reftitle.description; - - voiduopz_set_mock - stringclass - mixedmock - - - Si mock est une chaîne contenant le nom d'une classe alors elle sera instanciée à la place de - class. mock peut aussi être un objet. - - - - Seul l'accès dynamique aux propriétés et méthodes utilisera l'objet mock. - L'accès statique utilise toujours la class originale. - Voir l'exemple ci-dessous. - - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe à simuler. - - - - - mock - - - La simulation à utiliser sous forme de chaîne contenant le nom de la classe à utiliser ou un objet. - Si une chaîne est passée, elle doit être le nom de la classe entièrement qualifié. Il est - recommandé d'utiliser la constante magique ::class dans ce cas. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL uopz 6.0.0 - - Simuler les membres statiques n'est plus supporté par cette fonction. - uopz_redefine et uopz_set_return, - ou Componere peuvent être utilisés à la place. - - - - - - - - - &reftitle.examples; - - Exemple de <function>uopz_set_mock</function> - -who(); -?> -]]> - - &example.outputs; - - - - - - Exemple de <function>uopz_set_mock</function> - -who(); -?> -]]> - - &example.outputs; - - - - - - <function>uopz_set_mock</function> et membres statiques - - Depuis uopz 6.0.0, la simulation des membres statiques n'est plus supportée. - - - -]]> - - &example.outputs; - - - - - L'exemple ci-dessus affiche avec uopz 5: - - - - - - - - - &reftitle.seealso; - - uopz_get_mock - uopz_unset_mock - - - - - - diff --git a/reference/uopz/functions/uopz-set-property.xml b/reference/uopz/functions/uopz-set-property.xml deleted file mode 100644 index 36cc298e72..0000000000 --- a/reference/uopz/functions/uopz-set-property.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - uopz_set_property - Définit la valeur d'une propriété de classe existante ou d'instance - - - - &reftitle.description; - - voiduopz_set_property - stringclass - stringproperty - mixedvalue - - - voiduopz_set_property - objectinstance - stringproperty - mixedvalue - - - Définit la valeur d'une propriété de classe statique existante, si class - est donné, ou la valeur d'une propriété d'instance (peu importe si la propriété d'instance existe déjà), si instance - est donné. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe. - - - - - instance - - - L'instance de l'objet. - - - - - property - - - Le nom de la propriété. - - - - - value - - - La valeur à assigner à la propriété. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Utilisation basique de <function>uopz_set_property</function> - -bar; - } -} -$foo = new Foo; -uopz_set_property('Foo', 'staticBar', 10); -uopz_set_property($foo, 'bar', 100); -var_dump(Foo::testStaticBar()); -var_dump($foo->testBar()); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_get_property - - - - - - diff --git a/reference/uopz/functions/uopz-set-return.xml b/reference/uopz/functions/uopz-set-return.xml deleted file mode 100644 index 15ce179833..0000000000 --- a/reference/uopz/functions/uopz-set-return.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - uopz_set_return - Apporte une valeur de retour pour une fonction existante - - - - &reftitle.description; - - booluopz_set_return - stringfunction - mixedvalue - boolexecute&false; - - - booluopz_set_return - stringclass - stringfunction - mixedvalue - boolexecute&false; - - - Définit la valeur de retour de la function à value. Si value - est une fermeture et que execute est défini, la fermeture sera exécutée à la place de la fonction d'origine. - Il est possible d'appeler la fonction d'origine depuis la fermeture. - - - - Cette fonction remplace uopz_rename. - - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe contenant la fonction - - - - - function - - - Le nom d'une fonction existante - - - - - value - - - La valeur que la fonction doit renvoyer. Si une fermeture est fournie et que le drapeau d'exécution est défini, la fermeture sera exécutée à la place de la fonction d'origine. - - - - - execute - - - Si true, et qu'une fermeture a été fournie en tant que valeur, la fermeture sera exécutée à la place de la fonction d'origine. - - - - - - - - &reftitle.returnvalues; - - True en cas de succès, sinon false. - - - - - &reftitle.examples; - - Exemple de <function>uopz_set_return</function> - - -]]> - - &example.outputs; - - - - - - Exemple de <function>uopz_set_return</function> - - -]]> - - &example.outputs; - - - - - - Exemple de <function>uopz_set_return</function> avec une classe - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-undefine.xml b/reference/uopz/functions/uopz-undefine.xml deleted file mode 100644 index a59cb9c5db..0000000000 --- a/reference/uopz/functions/uopz-undefine.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - uopz_undefine - Supprime une constante - - - - &reftitle.description; - - booluopz_undefine - stringconstant - - - booluopz_undefine - stringclass - stringconstant - - - Supprime une constante à l'exécution. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe contenant la constant - - - - - constant - - - Le nom d'une constante existante - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Exemple avec <function>uopz_undefine</function> - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-unset-hook.xml b/reference/uopz/functions/uopz-unset-hook.xml deleted file mode 100644 index 85b506b622..0000000000 --- a/reference/uopz/functions/uopz-unset-hook.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - uopz_unset_hook - Supprime le hook précédemment défini sur une fonction ou une méthode - - - - &reftitle.description; - - booluopz_unset_hook - stringfunction - - - booluopz_unset_hook - stringclass - stringfunction - - - Supprime le hook précédemment défini sur une fonction ou une méthode. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe. - - - - - function - - - Le nom de la fonction ou de la méthode. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Utilisation basique de <function>uopz_unset_hook</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_set_hook - uopz_get_hook - - - - - - diff --git a/reference/uopz/functions/uopz-unset-mock.xml b/reference/uopz/functions/uopz-unset-mock.xml deleted file mode 100644 index d6d0c25443..0000000000 --- a/reference/uopz/functions/uopz-unset-mock.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - uopz_unset_mock - Supprime la simulation précédemment définie - - - - &reftitle.description; - - voiduopz_unset_mock - stringclass - - - Supprime la simulation précédemment définie pour class. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe simulée. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Une RuntimeException est lancée, si aucune simulation n'a été précédemment - définie pour class. - - - - - &reftitle.examples; - - Exemple de <function>uopz_unset_mock</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_set_mock - uopz_get_mock - - - - - - diff --git a/reference/uopz/functions/uopz-unset-return.xml b/reference/uopz/functions/uopz-unset-return.xml deleted file mode 100644 index 374281fafa..0000000000 --- a/reference/uopz/functions/uopz-unset-return.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - uopz_unset_return - Supprime une valeur de retour précédemment définie pour une fonction - - - - &reftitle.description; - - booluopz_unset_return - stringfunction - - - booluopz_unset_return - stringclass - stringfunction - - - Supprime la valeur de retour de la function précédemment définie par uopz_set_return. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe contenant la fonction - - - - - function - - - Le nom de la fonction - - - - - - - - &reftitle.returnvalues; - - True en cas de succès - - - - - &reftitle.examples; - - Exemple de <function>uopz_unset_return</function> - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz_set_static.xml b/reference/uopz/functions/uopz_set_static.xml deleted file mode 100644 index e7b3af1827..0000000000 --- a/reference/uopz/functions/uopz_set_static.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - uopz_set_static - Définit les variables statiques dans la portée d'une fonction ou d'une méthode - - - - &reftitle.description; - - voiduopz_set_static - stringfunction - arraystatic - - - voiduopz_set_static - stringclass - stringfunction - arraystatic - - - Définit les variables statiques dans la portée d'une fonction ou d'une méthode. - - - - - &reftitle.parameters; - - - class - - - Le nom de la classe. - - - - - function - - - Le nom de la fonction ou de la méthode. - - - - - static - - - Le tableau associatif de noms de variables mappés à leurs valeurs. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Exemple d'utilisation de <function>uopz_set_static</function> - - 'qux']); -foo(); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_get_static - - - - - - diff --git a/reference/uopz/reference.xml b/reference/uopz/reference.xml deleted file mode 100644 index bdddc597f5..0000000000 --- a/reference/uopz/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; Uopz - - &reference.uopz.entities.functions; - - - - diff --git a/reference/uopz/setup.xml b/reference/uopz/setup.xml deleted file mode 100644 index 472079c196..0000000000 --- a/reference/uopz/setup.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - À partir de uopz 5.0 PHP 7.0 est nécessaire. À partir de uopz 5.1, PHP 7.1+ est nécessaire. - -
    - -
    - &reftitle.install; - - Les versions d'uopz sont hébergées par PECL et le code source par - github ; - la façon la plus simple de l'installer est de passer par l'installation - via PECL : - &url.pecl.package;uopz. - - - Les utilisateurs de Windows peuvent télécharger les binaires depuis le site web de - PECL. - - - À partir de uopz 5.0.0, l'extension doit être chargée en tant qu' - extension. Antérieur à cette version, elle doit - être chargée comme une zend_extension. - -
    - -
    - &reftitle.runtime; - &extension.runtime; - - - uopz &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - uopz.disable - "0" - INI_SYSTEM - Disponible à partir de uopz 5.0.2 - - - uopz.exit - "0" - INI_SYSTEM - Disponible à partir de uopz 6.0.1 - - - uopz.overloads - "1" - INI_SYSTEM - Disponible à partir de uopz 2.0.2. Supprimé à partir de uopz 5.0.0. - - - -
    - &ini.php.constants; -     - - &ini.descriptions.title; - - - - - - uopz.disable - bool - - - - Si activé, uopz devrait ne plus avoir d'effet sur le moteur. - - - - - - uopz.exit - bool - - - - Autoriser ou non l'exécution des codes d'opération (opcodes) de sortie. - Ce paramètre peut être dérogé lors de l'exécution en appelant uopz_allow_exit. - - - - - - uopz.overloads - bool - - - - Active la possibilité d'utiliser uopz_overload. - - - - - - - - - Lors de l'exécution avec OPcache activé, il peut être nécessaire de - désactiver toutes les - optimisations OPcache - (opcache.optimization_level=0). - - -
    - -     - - diff --git a/reference/v8js/book.xml b/reference/v8js/book.xml deleted file mode 100644 index 04a41dd4ed..0000000000 --- a/reference/v8js/book.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - Intégration du moteur Javascript V8 - V8js - - - &reftitle.intro; - - Cette extension embarque le - moteur Javascript V8 - dans PHP. - - - - &reference.v8js.setup; - &reference.v8js.examples; - - &reference.v8js.v8js; - &reference.v8js.v8jsexception; - - - - diff --git a/reference/v8js/configure.xml b/reference/v8js/configure.xml deleted file mode 100644 index e350f3df24..0000000000 --- a/reference/v8js/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;v8js - - - -
    - - - diff --git a/reference/v8js/examples.xml b/reference/v8js/examples.xml deleted file mode 100644 index f62be69592..0000000000 --- a/reference/v8js/examples.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - &reftitle.examples; - - Utilisation simple - - - Exécution d'un Javascript simple - -executeString($JS, 'basic.js')); -} catch (V8JsException $e) { - var_dump($e); -} - -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/v8js/ini.xml b/reference/v8js/ini.xml deleted file mode 100644 index 93f4fb4a5b..0000000000 --- a/reference/v8js/ini.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; V8js - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - v8js.max_disposed_contexts - 25 - INI_ALL - - - - v8js.flags - - INI_ALL - - - - -
    -     - - &ini.descriptions.title; - - - - - - v8js.max_disposed_contexts - int - - - - Définit une limite pour les contextes disposés avant de forcer V8 - à effectuer une passe de collecte de mémoire. - - - - - - v8js.flags - string - - - - Définit les drapeaux de la ligne de commande V8. La liste - des drapeaux disponibles peut être récupérée depuis la ligne - de commande en utilisant l'option --help. - Par exemple : - - - - - - - - Pour que ces drapeaux soient effectifs lors de l'exécution, - l'appel à la fonction ini_set() doit avoir été effectué - avant l'instanciation de tout objet V8Js ! - - - - - - - - -
    - - diff --git a/reference/v8js/setup.xml b/reference/v8js/setup.xml deleted file mode 100644 index 4ffbf898e7..0000000000 --- a/reference/v8js/setup.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - PHP et la bibliothèque V8 ainsi que ses en-têtes qui doivent - être installés dans les bons répertoires. - -
    - - &reference.v8js.configure; - - &reference.v8js.ini; - -     - - diff --git a/reference/v8js/v8js.xml b/reference/v8js/v8js.xml deleted file mode 100644 index 5283bf0070..0000000000 --- a/reference/v8js/v8js.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - La classe <classname>V8Js</classname> - V8Js - - - - -
    - &reftitle.intro; - - C'est la classe de base de l'extension V8Js. Chaque instance créée - depuis cette classe a son propre contexte dans lequel tout le - Javascript est compilé et exécuté. - - - Voir V8Js::__construct pour plus d'informations. - -
    - - -
    - &reftitle.classsynopsis; - - - - V8Js - - - - - V8Js - - - - &Constants; - - const - string - V8Js::V8_VERSION - - - const - int - V8Js::FLAG_NONE - 1 - - - const - int - V8Js::FLAG_FORCE_ARRAY - 2 - - - &Methods; - - - - - - - - - -
    - - -
    - &reftitle.constants; - - - - V8Js::V8_VERSION - - La version du moteur Javascript V8. - - - - - V8Js::FLAG_NONE - - Aucun drapeau. - - - - - V8Js::FLAG_FORCE_ARRAY - - Force tous les objets JS à être des tableaux associatifs - en PHP. - - - - -
    - - - -     - - &reference.v8js.entities.v8js; - -     - - diff --git a/reference/v8js/v8js/construct.xml b/reference/v8js/v8js/construct.xml deleted file mode 100644 index 78d393a147..0000000000 --- a/reference/v8js/v8js/construct.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - V8Js::__construct - Construit un nouvel objet V8Js - - - - &reftitle.description; - - public V8Js::__construct - stringobject_name"PHP" - arrayvariablesarray() - arrayextensionsarray() - boolreport_uncaught_exceptions&true; - - - Construit un nouvel objet V8Js. - - - - - - &reftitle.parameters; - - - object_name - - - Le nom de l'objet passé à Javascript. - - - - - variables - - - Une liste des variables PHP qui seront disponibles en Javascript. Doit être un - tableau associatif au format array("nom-pour-js" => "nom-de-la-variable-php"). - Par défaut, un tableau vide. - - - - - extensions - - - Liste des extensions enregistrées en utilisant la méthode - V8Js::registerExtension, qui devraient être disponibles - dans le contexte Javascript de l'objet V8Js créé. - - - Les extensions enregistrées de telle façon qu'elles soient automatiquement actives n'ont - pas besoin d'être listées dans ce tableau. - De plus, si une extension a des dépendances, celles-ci peuvent être omises. Par défaut, un tableau vide. - - - - - - - report_uncaught_exceptions - - - Contrôle si les exceptions Javascript non attrapées sont reportées immédiatement ou non. - Par défaut, vaut &true;. Si défini à &false;, l'exception non attrapée peut être accédée - en utilisant la méthode V8Js::getPendingException. - - - - - - - - - diff --git a/reference/v8js/v8js/executestring.xml b/reference/v8js/v8js/executestring.xml deleted file mode 100644 index 2b35462e3f..0000000000 --- a/reference/v8js/v8js/executestring.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - V8Js::executeString - Exécute une chaîne comme du code Javascript - - - - &reftitle.description; - - public mixedV8Js::executeString - stringscript - stringidentifier"V8Js::executeString()" - intflagsV8Js::FLAG_NONE - - - Compile et exécute la chaîne passée par le paramètre - script comme du code Javascript. - - - - - &reftitle.parameters; - - - script - - - La chaîne à exécuter. - - - - - identifier - - - Identifiant pour le code exécuté. Utilisé lors du débogage. - - - - - flags - - - Drapeaux d'exécution. Cette valeur doit être une des - constantes V8Js::FLAG_*, et vaut par défaut - V8Js::FLAG_NONE. - - - - V8Js::FLAG_NONE : aucun drapeau - - - - - V8Js::FLAG_FORCE_ARRAY : force tous - les objets Javascript passés à PHP à être des tableaux associatifs - - - - - - - - - - - &reftitle.returnvalues; - - Retourne la dernière variable instanciée dans le code Javascript, convertie en variable PHP - de type correspondant. - - - - - diff --git a/reference/v8js/v8js/getextensions.xml b/reference/v8js/v8js/getextensions.xml deleted file mode 100644 index 2a2a41632d..0000000000 --- a/reference/v8js/v8js/getextensions.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - V8Js::getExtensions - Retourne un tableau contenant les extensions enregistrées - - - - &reftitle.description; - - public static arrayV8Js::getExtensions - - - - Cette fonction retourne un tableau contenant les extensions Javascript enregistrées - en utilisant la méthode V8Js::registerExtension. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les extensions enregistrées ou un tableau - vide s'il n'y en a aucune. - - - - - - diff --git a/reference/v8js/v8js/getpendingexception.xml b/reference/v8js/v8js/getpendingexception.xml deleted file mode 100644 index 28d7a7004c..0000000000 --- a/reference/v8js/v8js/getpendingexception.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - V8Js::getPendingException - Retourne l'exception Javascript non attrapée restante - - - - &reftitle.description; - - public V8JsExceptionV8Js::getPendingException - - - - Retourne toute exception Javascript non attrapée restante depuis un ou plusieurs - appel(s) à la méthode V8Js::executeString, sous forme de - V8JsException. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objet V8JsException ou &null;. - - - - - - diff --git a/reference/v8js/v8js/registerextension.xml b/reference/v8js/v8js/registerextension.xml deleted file mode 100644 index 1d21b6acc4..0000000000 --- a/reference/v8js/v8js/registerextension.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - V8Js::registerExtension - Enregistre des extensions Javascript pour V8Js - - - - &reftitle.description; - - public static boolV8Js::registerExtension - stringextension_name - stringscript - arraydependenciesarray() - boolauto_enable&false; - - - Enregistre le code Javascript passé par le paramètre script - comme extension à utiliser dans les contextes V8Js. - - - - - &reftitle.parameters; - - - extension_name - - - Nom de l'extension à enregistrer. - - - - - script - - - Le code Javascript à enregistrer. - - - - - dependencies - - - Un tableau de noms d'extensions dont l'extension en cours d'enregistrement dépend. - Chacune d'elles sera activée automatiquement lors du chargement de cette extension. - - - Toutes les extensions, y compris les dépendances, doivent être enregistrées avant - la création de tout objet V8Js les utilisant. - - - - - - - auto_enable - - - Si défini à &true;, l'extension sera activée automatiquement dans tous les - contextes V8Js. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si l'extension a été enregistrée avec succès, &false; sinon. - - - - - - - diff --git a/reference/v8js/v8jsexception.xml b/reference/v8js/v8jsexception.xml deleted file mode 100644 index ead52c06b2..0000000000 --- a/reference/v8js/v8jsexception.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - La classe <classname>V8JsException</classname> - V8JsException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - V8JsException - - - - - V8JsException - - - - extends - Exception - - - - &Properties; - - protected - JsFileName - - - protected - JsLineNumber - - - protected - JsSourceLine - - - protected - JsTrace - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - JsFileName - - - - - - JsLineNumber - - - - - - JsSourceLine - - - - - - JsTrace - - - - - -
    - - - -     - - &reference.v8js.entities.v8jsexception; - -     - - diff --git a/reference/v8js/v8jsexception/getjsfilename.xml b/reference/v8js/v8jsexception/getjsfilename.xml deleted file mode 100644 index 264940aa19..0000000000 --- a/reference/v8js/v8jsexception/getjsfilename.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - V8JsException::getJsFileName - Le but de getJsFileName - - - - &reftitle.description; - - final public stringV8JsException::getJsFileName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/v8js/v8jsexception/getjslinenumber.xml b/reference/v8js/v8jsexception/getjslinenumber.xml deleted file mode 100644 index 7f06fd6f76..0000000000 --- a/reference/v8js/v8jsexception/getjslinenumber.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - V8JsException::getJsLineNumber - Le but de getJsLineNumber - - - - &reftitle.description; - - final public intV8JsException::getJsLineNumber - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/v8js/v8jsexception/getjssourceline.xml b/reference/v8js/v8jsexception/getjssourceline.xml deleted file mode 100644 index 6a45e84f8d..0000000000 --- a/reference/v8js/v8jsexception/getjssourceline.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - V8JsException::getJsSourceLine - Le but de getJsSourceLine - - - - &reftitle.description; - - final public stringV8JsException::getJsSourceLine - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/v8js/v8jsexception/getjstrace.xml b/reference/v8js/v8jsexception/getjstrace.xml deleted file mode 100644 index b6f5db1444..0000000000 --- a/reference/v8js/v8jsexception/getjstrace.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - V8JsException::getJsTrace - Le but de getJsTrace - - - - &reftitle.description; - - final public stringV8JsException::getJsTrace - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/var_representation/book.xml b/reference/var_representation/book.xml deleted file mode 100644 index 886a3a3f91..0000000000 --- a/reference/var_representation/book.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - var_representation - var_representation - - - &reftitle.intro; - - L'extension var_representation fournit une alternative compacte à var_export qui échappe correctement les caractères de contrôle. - - - - &reference.var-representation.setup; - &reference.var-representation.constants; - &reference.var-representation.reference; - - - - diff --git a/reference/var_representation/constants.xml b/reference/var_representation/constants.xml deleted file mode 100644 index 8963929279..0000000000 --- a/reference/var_representation/constants.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - VAR_REPRESENTATION_SINGLE_LINE - (int) - - - - Le drapeau de var_representation indiquant que les sauts de ligne - ne doivent pas être utilisés pour l'espacement dans les représentations de variables. - - - - - - VAR_REPRESENTATION_UNESCAPED - (int) - - - - Le drapeau de var_representation indiquant que les chaînes de caractères - doivent être encodées en tant que chaînes entre guillemets simples avec des caractères de contrôle non échappés. - - - - - - - diff --git a/reference/var_representation/functions/var-representation.xml b/reference/var_representation/functions/var-representation.xml deleted file mode 100644 index 6b8dca4e12..0000000000 --- a/reference/var_representation/functions/var-representation.xml +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - var_representation - Renvoie une représentation lisible, courte et analysable d'une variable - - - - &reftitle.description; - - stringvar_representation - mixedvalue - intflags0 - - - var_representation (de la PECL var_representation) renvoie une chaîne de caractères avec des informations structurées sur la - variable donnée. Elle est similaire à var_export avec des différences dans l'indentation, l'échappement des chaînes et les représentations de tableaux. - - - - - &reftitle.parameters; - - - value - - - La variable pour générer une représentation. - - - - - flags - - - Un masque de bits consistant en - VAR_REPRESENTATION_SINGLE_LINE, - VAR_REPRESENTATION_UNESCAPED. - Le comportement de ces constantes est décrit sur la page des - constantes de var_representation. - - - - - - - - &reftitle.returnvalues; - - Renvoie la représentation de la variable. - - - - - &reftitle.examples; - - - Exemple de <function>var_representation</function> - - 'value']]; -echo var_representation($a), "\n"; -echo var_representation($a, VAR_REPRESENTATION_SINGLE_LINE), "\n"; -?> -]]> - - &example.outputs; - - 'value', - ], -] -[1, 2, ['key' => 'value']] -]]> - - - - - - Échappement des caractères de contrôle - - - - &example.outputs; - - - - - - - - Exporter une <classname>stdClass</classname> - -name = 'ElePHPant ElePHPantsdotter'; -$person->website = 'https://php.net/elephpant.php'; - -echo var_representation($person); -]]> - - &example.outputs; - - 'ElePHPant ElePHPantsdotter', - 'website' => 'https://php.net/elephpant.php', -] -]]> - - - - - - Exporter des classes - -var = 5; -echo var_representation($a); -?> -]]> - - &example.outputs; - - 5, -]) -]]> - - - - - - Utilisation avec <link linkend="object.set-state">__set_state()</link> - -var1 = $an_array['var1']; - $obj->var2 = $an_array['var2']; - return $obj; - } -} - -$a = new A; -$a->var1 = 5; -$a->var2 = 'foo'; - -eval('$b = ' . var_representation($a) . ';'); // $b = \A::__set_state([ - // 'var1' => 5, - // 'var2' => 'foo', - // ]); -var_dump($b); -?> -]]> - - &example.outputs; - - - int(5) - ["var2"]=> - string(3) "foo" -} -]]> - - - - - - - &reftitle.seealso; - - - var_export - - - - - diff --git a/reference/var_representation/reference.xml b/reference/var_representation/reference.xml deleted file mode 100644 index eda8b22cb5..0000000000 --- a/reference/var_representation/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &Functions; de var_representation - - &reference.var-representation.entities.functions; - - - diff --git a/reference/var_representation/setup.xml b/reference/var_representation/setup.xml deleted file mode 100644 index 9b87b9dfe5..0000000000 --- a/reference/var_representation/setup.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;var_representation. - - - &pecl.windows.download.avail; - -
    - -     - diff --git a/reference/varnish/book.xml b/reference/varnish/book.xml deleted file mode 100644 index c6875ce0fe..0000000000 --- a/reference/varnish/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Varnish - Varnish - - - &reftitle.intro; - - Le cache Varnish est un logiciel open source, permettant d'accélérer - les applications web. Cette extension permet d’interagir avec une instance - Varnish via un socket TCP ou en mémoire partagée. - - - - &reference.varnish.setup; - &reference.varnish.constants; - &reference.varnish.examples; - - &reference.varnish.varnishadmin; - &reference.varnish.varnishstat; - &reference.varnish.varnishlog; - &reference.varnish.varnishexception; - - - - diff --git a/reference/varnish/configure.xml b/reference/varnish/configure.xml deleted file mode 100644 index 269b3689db..0000000000 --- a/reference/varnish/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;varnish - - - -
    - - - diff --git a/reference/varnish/constants.xml b/reference/varnish/constants.xml deleted file mode 100644 index 2dd622b51b..0000000000 --- a/reference/varnish/constants.xml +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - - VARNISH_STATUS_SYNTAX - (int) - - - - - - - - - VARNISH_STATUS_UNKNOWN - (int) - - - - - - - - - VARNISH_STATUS_UNIMPL - (int) - - - - - - - - - VARNISH_STATUS_TOOFEW - (int) - - - - - - - - - VARNISH_STATUS_TOOMANY - (int) - - - - - - - - - VARNISH_STATUS_PARAM - (int) - - - - - - - - - VARNISH_STATUS_AUTH - (int) - - - - - - - - - VARNISH_STATUS_OK - (int) - - - - - - - - - VARNISH_STATUS_CANT - (int) - - - - - - - - - VARNISH_STATUS_COMMS - (int) - - - - - - - - - VARNISH_STATUS_CLOSE - (int) - - - - - - - - - VARNISH_CONFIG_IDENT - (string) - - - - - - - - - VARNISH_CONFIG_HOST - (string) - - - - - - - - - VARNISH_CONFIG_PORT - (string) - - - - - - - - - VARNISH_CONFIG_TIMEOUT - (string) - - - - - - - - - VARNISH_CONFIG_SECRET - (string) - - - - - - - - - VARNISH_CONFIG_COMPAT - (string) - - - - - - - - - VARNISH_COMPAT_2 - (int) - - - - - - - - - VARNISH_COMPAT_3 - (int) - - - - - - - - - - - diff --git a/reference/varnish/examples.xml b/reference/varnish/examples.xml deleted file mode 100644 index 3562e8e18e..0000000000 --- a/reference/varnish/examples.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - &reftitle.examples; -
    - Exemple d'utilisation de VarnishAdmin - - Cet exemple montre une utilisation simple de la fonctionnalité - ban. - - - Bannir une URL - - "::1", - VARNISH_CONFIG_PORT => 6082, - VARNISH_CONFIG_SECRET => "5174826b-8595-4958-aa7a-0609632ad7ca", - VARNISH_CONFIG_TIMEOUT => 300, -); - -$va = new VarnishAdmin($args); - -try { - if(!$va->connect()) { - throw new VarnishException("Connection failed\n"); - } -} catch (VarnishException $e) { - echo $e->getMessage(); - exit(3); -} - -try { - if(!$va->auth()) { - throw new VarnishException("Auth failed\n"); - } -} catch (VarnishException $e) { - echo $e->getMessage(); - exit(3); -} - -try { - $status = $va->ban('req.url ~ "^/$"'); - if (VARNISH_STATUS_OK != $status) { - throw new VarnishException("Ban method returned $status status\n"); - } -} catch (VarnishException $e) { - echo $e->getMessage(); - exit(3); -} - -exit(0); - -?> -]]> - - -
    -
    - Exemple d'utilisation de VarnishStat - - Cet exemple montre comment récupérer les statistiques Varnish depuis la mémoire - partagée. - - - Récupération de statistiques - -getSnapshot(); -} catch (VarnishException $e) { - echo $e->getMessage(); - exit(3); -} - -exit(0); -?> -]]> - - -
    -
    - Exemple d'utilisation de VarnishLog - - Cet exemple montre comment lire des lignes des logs Varnish depuis la - mémoire partagée. - - - Lecture des logs Varnish depuis la mémoire partagée - -getLine(); - printf("%s %d %s", VarnishLog::getTagName($line['tag']), $line['id'], - $line['data']); -} - -exit(0); -?> -]]> - - -
    -     - - - diff --git a/reference/varnish/setup.xml b/reference/varnish/setup.xml deleted file mode 100644 index 89871f004f..0000000000 --- a/reference/varnish/setup.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Pour utiliser cette extension, une version de Varnish Cache supérieure ou égale à 3.0 doit être installée, - disponible sur la page d'accueil de Varnish Cache. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;varnish. - -
    - -     - - diff --git a/reference/varnish/varnishadmin.xml b/reference/varnish/varnishadmin.xml deleted file mode 100644 index 2579934861..0000000000 --- a/reference/varnish/varnishadmin.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - La classe VarnishAdmin - VarnishAdmin - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - VarnishAdmin - - - - - VarnishAdmin - - - - - &Methods; - - - - -
    - -     - - &reference.varnish.entities.varnishadmin; - -     - - diff --git a/reference/varnish/varnishadmin/auth.xml b/reference/varnish/varnishadmin/auth.xml deleted file mode 100644 index b5305d85dd..0000000000 --- a/reference/varnish/varnishadmin/auth.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::auth - S'authentifie sur une instance Varnish - - - - &reftitle.description; - - public boolVarnishAdmin::auth - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/varnish/varnishadmin/ban.xml b/reference/varnish/varnishadmin/ban.xml deleted file mode 100644 index 28c24ecdfa..0000000000 --- a/reference/varnish/varnishadmin/ban.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::ban - Ban des URLs en utilisant une expression VCL - - - - &reftitle.description; - - public intVarnishAdmin::ban - stringvcl_regex - - - - - - - - &reftitle.parameters; - - - - vcl_regex - - - Expression VCL Varnish. Elle est basée sur la commande - ban de Varnish. - - - - - - - - - &reftitle.returnvalues; - - Retourne le statut de la commande Varnish. - - - - - - diff --git a/reference/varnish/varnishadmin/banurl.xml b/reference/varnish/varnishadmin/banurl.xml deleted file mode 100644 index ed10aef432..0000000000 --- a/reference/varnish/varnishadmin/banurl.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - VarnishAdmin::banUrl - Ban une URL en utilisant une expression VCL - - - - &reftitle.description; - - public intVarnishAdmin::banUrl - stringvcl_regex - - - - - - - - &reftitle.parameters; - - - - vcl_regex - - - Expression rationnelle dans une syntaxe compatible PCRE. - Elle est basée sur la commande ban.url de Varnish. - - - - - - - - - &reftitle.returnvalues; - - Retourne le statut de la commande Varnish. - - - - - - - diff --git a/reference/varnish/varnishadmin/clearpanic.xml b/reference/varnish/varnishadmin/clearpanic.xml deleted file mode 100644 index 6b3ab8578a..0000000000 --- a/reference/varnish/varnishadmin/clearpanic.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::clearPanic - Efface les messages de panique de l'instance Varnish - - - - &reftitle.description; - - public intVarnishAdmin::clearPanic - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le statut de la commande Varnish. - - - - - - - diff --git a/reference/varnish/varnishadmin/connect.xml b/reference/varnish/varnishadmin/connect.xml deleted file mode 100644 index 3cfb7d3d25..0000000000 --- a/reference/varnish/varnishadmin/connect.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::connect - Connexion à l'interface d'administration de l'instance Varnish - - - - &reftitle.description; - - public boolVarnishAdmin::connect - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/varnish/varnishadmin/construct.xml b/reference/varnish/varnishadmin/construct.xml deleted file mode 100644 index 78048526d3..0000000000 --- a/reference/varnish/varnishadmin/construct.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - VarnishAdmin::__construct - Constructeur VarnishAdmin - - - - &reftitle.description; - - public VarnishAdmin::__construct - arrayargs - - - - - - - - &reftitle.parameters; - - - args - - - Arguments de configuration. Les clés possibles sont : - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - Exemple avec <function>VarnishAdmin::__construct</function> - - "::1", - VARNISH_CONFIG_PORT => 6082, - VARNISH_CONFIG_SECRET => "5174826b-8595-4958-aa7a-0609632ad7ca", - VARNISH_CONFIG_TIMEOUT => 300, - ); - $va = new VarnishAdmin($args); -?> -]]> - - - - - - - diff --git a/reference/varnish/varnishadmin/disconnect.xml b/reference/varnish/varnishadmin/disconnect.xml deleted file mode 100644 index a7c1aa4d15..0000000000 --- a/reference/varnish/varnishadmin/disconnect.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::disconnect - Déconnexion de l'interface d'administration d'une instance varnish - - - - &reftitle.description; - - public boolVarnishAdmin::disconnect - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/varnish/varnishadmin/getpanic.xml b/reference/varnish/varnishadmin/getpanic.xml deleted file mode 100644 index 75eefc744c..0000000000 --- a/reference/varnish/varnishadmin/getpanic.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - VarnishAdmin::getPanic - Récupère le dernier message de panique de l'instance Varnish - - - - &reftitle.description; - - public stringVarnishAdmin::getPanic - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - &reftitle.returnvalues; - - Retourne le dernier message de panique de l'instance Varnish courante. - - - - - - - diff --git a/reference/varnish/varnishadmin/getparams.xml b/reference/varnish/varnishadmin/getparams.xml deleted file mode 100644 index a841c4fb91..0000000000 --- a/reference/varnish/varnishadmin/getparams.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - VarnishAdmin::getParams - Récupère les paramètres de configuration de l'instance Varnish courante - - - - &reftitle.description; - - public arrayVarnishAdmin::getParams - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les paramètres de configuration - de l'instance Varnish. - - - - - - - diff --git a/reference/varnish/varnishadmin/isrunning.xml b/reference/varnish/varnishadmin/isrunning.xml deleted file mode 100644 index e9afffe5e0..0000000000 --- a/reference/varnish/varnishadmin/isrunning.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::isRunning - Vérifie si un processus esclave Varnish est actuellement en cours d'exécution - - - - &reftitle.description; - - public boolVarnishAdmin::isRunning - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/varnish/varnishadmin/setcompat.xml b/reference/varnish/varnishadmin/setcompat.xml deleted file mode 100644 index 46ddc597d3..0000000000 --- a/reference/varnish/varnishadmin/setcompat.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::setCompat - Définit le paramètre de configuration compat - - - - &reftitle.description; - - public voidVarnishAdmin::setCompat - intcompat - - - - - - - - &reftitle.parameters; - - - - compat - - - Option de compatibilité Varnish. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/sethost.xml b/reference/varnish/varnishadmin/sethost.xml deleted file mode 100644 index 98c8a926d9..0000000000 --- a/reference/varnish/varnishadmin/sethost.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::setHost - Définit le paramètre de configuration host - - - - &reftitle.description; - - public voidVarnishAdmin::setHost - stringhost - - - - - - - - &reftitle.parameters; - - - - host - - - Paramètre de configuration host. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/setident.xml b/reference/varnish/varnishadmin/setident.xml deleted file mode 100644 index 49fae96fd3..0000000000 --- a/reference/varnish/varnishadmin/setident.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::setIdent - Définit le paramètre de configuration ident - - - - &reftitle.description; - - public voidVarnishAdmin::setIdent - stringident - - - - - - - - &reftitle.parameters; - - - - ident - - - Paramètre de configuration ident. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/setparam.xml b/reference/varnish/varnishadmin/setparam.xml deleted file mode 100644 index f94cd932f5..0000000000 --- a/reference/varnish/varnishadmin/setparam.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - VarnishAdmin::setParam - Définit un paramètre de configuration sur l'instance courante Varnish - - - - &reftitle.description; - - public intVarnishAdmin::setParam - stringname - stringintvalue - - - - - - - - &reftitle.parameters; - - - - name - - - Nom du paramètre de configuration. - - - - - value - - - Valeur du paramètre de configuration. - - - - - - - - - &reftitle.returnvalues; - - Retourne le statut de la commande Varnish. - - - - - - - diff --git a/reference/varnish/varnishadmin/setport.xml b/reference/varnish/varnishadmin/setport.xml deleted file mode 100644 index 3ff3cd5258..0000000000 --- a/reference/varnish/varnishadmin/setport.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::setPort - Définit le paramètre de configuration port - - - - &reftitle.description; - - public voidVarnishAdmin::setPort - intport - - - - - - - - &reftitle.parameters; - - - - port - - - Le paramètre de configuration port. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/setsecret.xml b/reference/varnish/varnishadmin/setsecret.xml deleted file mode 100644 index 349cf23ff4..0000000000 --- a/reference/varnish/varnishadmin/setsecret.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::setSecret - Définit le paramètre de configuration secret - - - - &reftitle.description; - - public voidVarnishAdmin::setSecret - stringsecret - - - - - - - - &reftitle.parameters; - - - - secret - - - Le paramètre de configuration secret. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/settimeout.xml b/reference/varnish/varnishadmin/settimeout.xml deleted file mode 100644 index e788b5469c..0000000000 --- a/reference/varnish/varnishadmin/settimeout.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::setTimeout - Définit le paramètre de configuration timeout - - - - &reftitle.description; - - public voidVarnishAdmin::setTimeout - inttimeout - - - - - - - - &reftitle.parameters; - - - - timeout - - - Le paramètre de configuration timeout. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/start.xml b/reference/varnish/varnishadmin/start.xml deleted file mode 100644 index d9453c7223..0000000000 --- a/reference/varnish/varnishadmin/start.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::start - Démarre un processus Varnish - - - - &reftitle.description; - - public intVarnishAdmin::start - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le statut de la commande Varnish. - - - - - - - diff --git a/reference/varnish/varnishadmin/stop.xml b/reference/varnish/varnishadmin/stop.xml deleted file mode 100644 index 6e384bd608..0000000000 --- a/reference/varnish/varnishadmin/stop.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::stop - Arrête un processus Varnish - - - - &reftitle.description; - - public intVarnishAdmin::stop - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne le statut de la commande Varnish. - - - - - - - diff --git a/reference/varnish/varnishexception.xml b/reference/varnish/varnishexception.xml deleted file mode 100644 index e29e937d63..0000000000 --- a/reference/varnish/varnishexception.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - La classe VarnishException - VarnishException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - VarnishException - - - - - VarnishException - - - - extends - Exception - - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -     - - -     - - diff --git a/reference/varnish/varnishlog.xml b/reference/varnish/varnishlog.xml deleted file mode 100644 index 2e371607d9..0000000000 --- a/reference/varnish/varnishlog.xml +++ /dev/null @@ -1,756 +0,0 @@ - - - - - - - - La classe VarnishLog - VarnishLog - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - VarnishLog - - - - - VarnishLog - - - - &Constants; - - const - int - VarnishLog::TAG_Debug - 0 - - - const - int - VarnishLog::TAG_Error - 1 - - - const - int - VarnishLog::TAG_CLI - 2 - - - const - int - VarnishLog::TAG_StatSess - 3 - - - const - int - VarnishLog::TAG_ReqEnd - 4 - - - const - int - VarnishLog::TAG_SessionOpen - 5 - - - const - int - VarnishLog::TAG_SessionClose - 6 - - - const - int - VarnishLog::TAG_BackendOpen - 7 - - - const - int - VarnishLog::TAG_BackendXID - 8 - - - const - int - VarnishLog::TAG_BackendReuse - 9 - - - const - int - VarnishLog::TAG_BackendClose - 10 - - - const - int - VarnishLog::TAG_HttpGarbage - 11 - - - const - int - VarnishLog::TAG_Backend - 12 - - - const - int - VarnishLog::TAG_Length - 13 - - - const - int - VarnishLog::TAG_FetchError - 14 - - - const - int - VarnishLog::TAG_RxRequest - 15 - - - const - int - VarnishLog::TAG_RxResponse - 16 - - - const - int - VarnishLog::TAG_RxStatus - 17 - - - const - int - VarnishLog::TAG_RxURL - 18 - - - const - int - VarnishLog::TAG_RxProtocol - 19 - - - const - int - VarnishLog::TAG_RxHeader - 20 - - - const - int - VarnishLog::TAG_TxRequest - 21 - - - const - int - VarnishLog::TAG_TxResponse - 22 - - - const - int - VarnishLog::TAG_TxStatus - 23 - - - const - int - VarnishLog::TAG_TxURL - 24 - - - const - int - VarnishLog::TAG_TxProtocol - 25 - - - const - int - VarnishLog::TAG_TxHeader - 26 - - - const - int - VarnishLog::TAG_ObjRequest - 27 - - - const - int - VarnishLog::TAG_ObjResponse - 28 - - - const - int - VarnishLog::TAG_ObjStatus - 29 - - - const - int - VarnishLog::TAG_ObjURL - 30 - - - const - int - VarnishLog::TAG_ObjProtocol - 31 - - - const - int - VarnishLog::TAG_ObjHeader - 32 - - - const - int - VarnishLog::TAG_LostHeader - 33 - - - const - int - VarnishLog::TAG_TTL - 34 - - - const - int - VarnishLog::TAG_Fetch_Body - 35 - - - const - int - VarnishLog::TAG_VCL_acl - 36 - - - const - int - VarnishLog::TAG_VCL_call - 37 - - - const - int - VarnishLog::TAG_VCL_trace - 38 - - - const - int - VarnishLog::TAG_VCL_return - 39 - - - const - int - VarnishLog::TAG_VCL_error - 40 - - - const - int - VarnishLog::TAG_ReqStart - 41 - - - const - int - VarnishLog::TAG_Hit - 42 - - - const - int - VarnishLog::TAG_HitPass - 43 - - - const - int - VarnishLog::TAG_ExpBan - 44 - - - const - int - VarnishLog::TAG_ExpKill - 45 - - - const - int - VarnishLog::TAG_WorkThread - 46 - - - const - int - VarnishLog::TAG_ESI_xmlerror - 47 - - - const - int - VarnishLog::TAG_Hash - 48 - - - const - int - VarnishLog::TAG_Backend_health - 49 - - - const - int - VarnishLog::TAG_VCL_Log - 50 - - - const - int - VarnishLog::TAG_Gzip - 51 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - VarnishLog::TAG_Debug - - - - - - - VarnishLog::TAG_Error - - - - - - - VarnishLog::TAG_CLI - - - - - - - VarnishLog::TAG_StatSess - - - - - - - VarnishLog::TAG_ReqEnd - - - - - - - VarnishLog::TAG_SessionOpen - - - - - - - VarnishLog::TAG_SessionClose - - - - - - - VarnishLog::TAG_BackendOpen - - - - - - - VarnishLog::TAG_BackendXID - - - - - - - VarnishLog::TAG_BackendReuse - - - - - - - VarnishLog::TAG_BackendClose - - - - - - - VarnishLog::TAG_HttpGarbage - - - - - - - VarnishLog::TAG_Backend - - - - - - - VarnishLog::TAG_Length - - - - - - - VarnishLog::TAG_FetchError - - - - - - - VarnishLog::TAG_RxRequest - - - - - - - VarnishLog::TAG_RxResponse - - - - - - - VarnishLog::TAG_RxStatus - - - - - - - VarnishLog::TAG_RxURL - - - - - - - VarnishLog::TAG_RxProtocol - - - - - - - VarnishLog::TAG_RxHeader - - - - - - - VarnishLog::TAG_TxRequest - - - - - - - VarnishLog::TAG_TxResponse - - - - - - - VarnishLog::TAG_TxStatus - - - - - - - VarnishLog::TAG_TxURL - - - - - - - VarnishLog::TAG_TxProtocol - - - - - - - VarnishLog::TAG_TxHeader - - - - - - - VarnishLog::TAG_ObjRequest - - - - - - - VarnishLog::TAG_ObjResponse - - - - - - - VarnishLog::TAG_ObjStatus - - - - - - - VarnishLog::TAG_ObjURL - - - - - - - VarnishLog::TAG_ObjProtocol - - - - - - - VarnishLog::TAG_ObjHeader - - - - - - - VarnishLog::TAG_LostHeader - - - - - - - VarnishLog::TAG_TTL - - - - - - - VarnishLog::TAG_Fetch_Body - - - - - - - VarnishLog::TAG_VCL_acl - - - - - - - VarnishLog::TAG_VCL_call - - - - - - - VarnishLog::TAG_VCL_trace - - - - - - - VarnishLog::TAG_VCL_return - - - - - - - VarnishLog::TAG_VCL_error - - - - - - - VarnishLog::TAG_ReqStart - - - - - - - VarnishLog::TAG_Hit - - - - - - - VarnishLog::TAG_HitPass - - - - - - - VarnishLog::TAG_ExpBan - - - - - - - VarnishLog::TAG_ExpKill - - - - - - - VarnishLog::TAG_WorkThread - - - - - - - VarnishLog::TAG_ESI_xmlerror - - - - - - - VarnishLog::TAG_Hash - - - - - - - VarnishLog::TAG_Backend_health - - - - - - - VarnishLog::TAG_VCL_Log - - - - - - - VarnishLog::TAG_Gzip - - - - - - -
    - - - -     - - &reference.varnish.entities.varnishlog; - -     - - diff --git a/reference/varnish/varnishlog/construct.xml b/reference/varnish/varnishlog/construct.xml deleted file mode 100644 index 508812b446..0000000000 --- a/reference/varnish/varnishlog/construct.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - VarnishLog::__construct - Constructeur Varnishlog - - - - &reftitle.description; - - public VarnishLog::__construct - arrayargs - - - - - - - - &reftitle.parameters; - - - args - - - Arguments de configuration. Les clés possibles sont : - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishlog/getline.xml b/reference/varnish/varnishlog/getline.xml deleted file mode 100644 index de0d0f6d5a..0000000000 --- a/reference/varnish/varnishlog/getline.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishLog::getLine - Récupère la prochaine ligne de log - - - - &reftitle.description; - - public arrayVarnishLog::getLine - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les données de la prochaine ligne de log. - - - - - - - diff --git a/reference/varnish/varnishlog/gettagname.xml b/reference/varnish/varnishlog/gettagname.xml deleted file mode 100644 index de18d60bf4..0000000000 --- a/reference/varnish/varnishlog/gettagname.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishLog::getTagName - Récupère le nom de la balise représenté par son index - - - - &reftitle.description; - - public static stringVarnishLog::getTagName - intindex - - - - - - - - &reftitle.parameters; - - - - index - - - Index de la balise. - - - - - - - - - &reftitle.returnvalues; - - Retourne le nom de la balise, sous la forme d'une &string;. - - - - - - - diff --git a/reference/varnish/varnishstat.xml b/reference/varnish/varnishstat.xml deleted file mode 100644 index e8f7a94ce6..0000000000 --- a/reference/varnish/varnishstat.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - La classe VarnishStat - VarnishStat - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - VarnishStat - - - - - VarnishStat - - - - - &Methods; - - - - -
    - -     - - &reference.varnish.entities.varnishstat; - -     - - diff --git a/reference/varnish/varnishstat/construct.xml b/reference/varnish/varnishstat/construct.xml deleted file mode 100644 index 175e05faad..0000000000 --- a/reference/varnish/varnishstat/construct.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - VarnishStat::__construct - Constructeur VarnishStat - - - - &reftitle.description; - - public VarnishStat::__construct - arrayargs - - - - - - - - &reftitle.parameters; - - - args - - - Arguments de configuration. Les clés possibles sont : - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishstat/getsnapshot.xml b/reference/varnish/varnishstat/getsnapshot.xml deleted file mode 100644 index a06644a69a..0000000000 --- a/reference/varnish/varnishstat/getsnapshot.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - VarnishStat::getSnapshot - Récupère les statistiques de l'instance courante Varnish - - - - &reftitle.description; - - public arrayVarnishStat::getSnapshot - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau contenant les statistiques Varnish. Les clés du tableau sont identiques - à celles de l'outil Varnishstat. - - - - - - - diff --git a/reference/wddx/book.xml b/reference/wddx/book.xml deleted file mode 100644 index 208d8dfa4d..0000000000 --- a/reference/wddx/book.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - - WDDX - - - - &reftitle.intro; - - - Cette extension est OBSOLÈTE et RETIRÉE - à partir de PHP 7.4.0. - - - - Ces fonctions sont prévues pour fonctionner avec - WDDX. - - - - Ne pas passer de données utilisateur non fiables à la fonction - wddx_deserialize. La désérialisation peut conduire au chargement - et à l'exécution du code lors de l'instanciation de l'objet et de son autochargement, - ainsi, un utilisateur malveillant pourrait être en mesure d'exploiter cette faille. - Utiliser donc un format sécurisé et standardisé d'échange de données tel que JSON - (via la fonction json_decode et la fonction - json_encode) s'il faut passer les données sérialisées à l'utilisateur. - - - - - - &reference.wddx.setup; - &reference.wddx.examples; - &reference.wddx.reference; - - - - diff --git a/reference/wddx/configure.xml b/reference/wddx/configure.xml deleted file mode 100644 index 55ecf77176..0000000000 --- a/reference/wddx/configure.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - -
    - &reftitle.install; - -
    - PHP 7.4 - - &pecl.moved-ver;7.4.0 - - - &pecl.info; - &url.pecl.package;wddx. - -
    - -
    - PHP < 7.4 - - Après avoir installé Expat, compiler PHP avec - et utiliser - pour Expat. - - &windows.builtin; -
    -
    - - diff --git a/reference/wddx/examples.xml b/reference/wddx/examples.xml deleted file mode 100644 index 80b249f0a9..0000000000 --- a/reference/wddx/examples.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - &reftitle.examples; -
    - Exemples wddx - - Toutes les fonctions qui sérialisent les variables utilisent - le premier élément d'un tableau pour déterminer si le tableau - doit être sérialisé dans un tableau ou dans une structure. - Si le premier élément a une chaîne de caractères en tant que - clé, alors, il sera sérialisé dans une structure, sinon, dans - un tableau. - - - - Sérialisation d'une valeur simple avec WDDX - - -]]> - - - Cet exemple affichera : - - -
    -PHP to WDDX packet example -]]> - - - - - Utilisation de paquets incrémentaux avec WDDX - - -]]> - - - Cet exemple affichera : - - -
    -3.1415926 -AustinNovato -Seattle -]]> - - - - - - Les chaînes de caractères doivent être encodées en UTF-8 ; pour gérer d'autres encodages, - convertissez d'abord la chaîne de caractères en utilisant la mb_convert_encoding, - UConverter::transcode, ou iconv. - - -
    -     - - - diff --git a/reference/wddx/functions/wddx-add-vars.xml b/reference/wddx/functions/wddx-add-vars.xml deleted file mode 100644 index 3d45b99dd8..0000000000 --- a/reference/wddx/functions/wddx-add-vars.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - wddx_add_vars - Ajoute des variables à un paquet WDDX - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - boolwddx_add_vars - resourcepacket_id - mixedvar_name - mixedvar_names - - - Sert à enregistrer et à ajouter les variables passées en argument - au paquet repéré par son identifiant packet_id. - - - - - &reftitle.parameters; - - Cette fonction prend un nombre variable de paramètres. - - - packet_id - - - Un paquet WDDX, retourné par la fonction - wddx_packet_start. - - - - - var_name - - - Peut être une &string; nommant une variable ou un tableau - contenant des noms de variables ou d'autres tableaux, etc. - - - - - var_names - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/wddx/functions/wddx-deserialize.xml b/reference/wddx/functions/wddx-deserialize.xml deleted file mode 100644 index 44afd83b82..0000000000 --- a/reference/wddx/functions/wddx-deserialize.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - wddx_deserialize - Désérialise un paquet WDDX - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - mixedwddx_deserialize - stringpacket - - - Désérialise un paquet packet WDDX. - - - - Ne pas passer d'entrée utilisateur non vérifiée à wddx_deserialize. - La désérialisation peut faire que le code soit chargé et exécuté lors - de l'instanciation et l'autochargement de l'objet, et un utilisateur mal - intentionné pourrait être en mesure d'exploiter cette faille. - Utiliser un format, sûr, d'échange de données standardisé comme JSON (à l'aide de - json_decode et json_encode) s'il faut - passer des données sérialisées à l'utilisateur. - - - - - - &reftitle.parameters; - - - - packet - - - Un paquet WDDX, sous la forme d'une &string; - ou d'un flux. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur désérialisée, pouvant être une &string;, un nombre - ou un tableau. Il est à noter que les structures sont désérialisées dans - des tableaux associatifs. - - - - - - diff --git a/reference/wddx/functions/wddx-packet-end.xml b/reference/wddx/functions/wddx-packet-end.xml deleted file mode 100644 index 6f1045595a..0000000000 --- a/reference/wddx/functions/wddx-packet-end.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - wddx_packet_end - Clôt un paquet WDDX - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - stringwddx_packet_end - resourcepacket_id - - - Clôt un paquet WDDX. - - - - - &reftitle.parameters; - - - - packet_id - - - Un paquet WDDX, retourné par la fonction - wddx_packet_start. - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string; contenant le paquet WDDX. - - - - - diff --git a/reference/wddx/functions/wddx-packet-start.xml b/reference/wddx/functions/wddx-packet-start.xml deleted file mode 100644 index b6c60ec57e..0000000000 --- a/reference/wddx/functions/wddx-packet-start.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - wddx_packet_start - Commence un nouveau paquet WDDX avec une structure - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - resourcewddx_packet_start - stringcomment - - - wddx_packet_start sert à créer un - nouveau paquet WDDX, pour pouvoir y faire des ajouts incrémentaux - de variables. Elle va automatiquement créer une définition de structure - dans le paquet, pour accueillir des variables. - - - - - &reftitle.parameters; - - - - comment - - - Une &string; optionnelle contenant le commentaire. - - - - - - - - - &reftitle.returnvalues; - - Retourne un identifiant de paquet pour utilisation ultérieure avec les fonctions - WDDX, ou &false; si une erreur survient. - - - - - diff --git a/reference/wddx/functions/wddx-serialize-value.xml b/reference/wddx/functions/wddx-serialize-value.xml deleted file mode 100644 index 6b16cedb37..0000000000 --- a/reference/wddx/functions/wddx-serialize-value.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - wddx_serialize_value - Enregistre une valeur dans un paquet WDDX - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - stringwddx_serialize_value - mixedvar - stringcomment - - - Enregistre une valeur donnée dans un paquet WDDX. - - - - - &reftitle.parameters; - - - - var - - - La valeur à sérialiser. - - - - - comment - - - Une &string; optionnelle contenant un commentaire qui apparaît dans - l'en-tête du paquet. - - - - - - - - - &reftitle.returnvalues; - - Retourne le paquet WDDX, ou &false; si une erreur - survient. - - - - - diff --git a/reference/wddx/functions/wddx-serialize-vars.xml b/reference/wddx/functions/wddx-serialize-vars.xml deleted file mode 100644 index fc60527416..0000000000 --- a/reference/wddx/functions/wddx-serialize-vars.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - wddx_serialize_vars - Enregistre plusieurs valeurs dans un paquet WDDX - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - stringwddx_serialize_vars - mixedvar_name - mixedvar_names - - - Sert à créer un paquet WDDX avec une structure qui - contient la représentation des variables passées en arguments. - - - - - &reftitle.parameters; - - Cette fonction prend un nombre variable de paramètres. - - - var_name - - - Peut être une &string; nommant une variable ou un tableau - contenant des noms de variables ou d'autres tableaux, etc. - - - - - var_names - - - - - - - - - - - &reftitle.returnvalues; - - Retourne le paquet WDDX, ou &false; si une erreur - survient. - - - - - &reftitle.examples; - - - Exemple avec <function>wddx_serialize_vars</function> - - -]]> - - &example.outputs; - -
    1 -5.5 -blueorangeviolet -colors -]]> - - - - - - - diff --git a/reference/wddx/reference.xml b/reference/wddx/reference.xml deleted file mode 100644 index dc56d3afee..0000000000 --- a/reference/wddx/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - &Functions; WDDX - - &reference.wddx.entities.functions; - - - - diff --git a/reference/wddx/setup.xml b/reference/wddx/setup.xml deleted file mode 100644 index 34320301c8..0000000000 --- a/reference/wddx/setup.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - &libxml.required; - - Afin d'utiliser WDDX, il faut installer la bibliothèque expat - (qui est fournie avec Apache 1.3.7 ou supérieur). - -
    - - - - &reference.wddx.configure; - - - -
    - &reftitle.resources; - - Cette extension définit un identifiant de paquet WDDX, - retourné par la fonction wddx_packet_start. - -
    - - -     - - - diff --git a/reference/win32service/book.xml b/reference/win32service/book.xml deleted file mode 100644 index 2094b97835..0000000000 --- a/reference/win32service/book.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - win32service - - - - &reftitle.intro; - - L'extension win32service est une extension spécifique à Windows qui - autorise PHP à communiquer avec la Gestion de Contrôle de Service pour - démarrer, arrêter, enregistrer ou effacer des services, et autorise - aussi les scripts PHP à s'exécuter en tant que service. - - - - - &reference.win32service.setup; - &reference.win32service.constants; - &reference.win32service.win32serviceexception; - &reference.win32service.win32servicerightinfo; - &reference.win32service.examples; - &reference.win32service.reference; - - - - diff --git a/reference/win32service/constants.xml b/reference/win32service/constants.xml deleted file mode 100644 index d289ed8632..0000000000 --- a/reference/win32service/constants.xml +++ /dev/null @@ -1,1157 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - Masque binaire de type de Service de Win32Service - - - - Constante - Valeur - Description - - - - - WIN32_SERVICE_WIN32_OWN_PROCESS - 0x00000010 - - Le service s'exécute dans son propre processus. - - - - WIN32_SERVICE_INTERACTIVE_PROCESS - 0x00000100 - - Le service peut interagir avec le bureau. Cette option n'est pas disponible sur Windows Vista ou version ultérieure. - - - - WIN32_SERVICE_WIN32_OWN_PROCESS_INTERACTIVE - 0x00000110 - - Le service s'exécute dans son propre processus et peut interagir avec le bureau. - Cette option n'est pas disponible sous Windows Vista et versions suivantes. - - - - -
    - - - Constantes de Status du Service de Win32Service - - - - Constante - Valeur - Description - - - - - WIN32_SERVICE_CONTINUE_PENDING - 0x00000005 - - La continuation du service est en attente. - - - - WIN32_SERVICE_PAUSE_PENDING - 0x00000006 - - La mise en pause du service est en attente. - - - - WIN32_SERVICE_PAUSED - 0x00000007 - - Le service est en pause. - - - - WIN32_SERVICE_RUNNING - 0x00000004 - - Le service est en cours d'exécution. - - - - WIN32_SERVICE_START_PENDING - 0x00000002 - - Le service est en cours de démarrage. - - - - WIN32_SERVICE_STOP_PENDING - 0x00000003 - - Le service est en cours d'arrêt. - - - - WIN32_SERVICE_STOPPED - 0x00000001 - - Le service est arrêté. - - - - -
    - - - Constantes du Service de Contrôle de Message de Win32Service - - - - Constante - Valeur - Description - - - - - WIN32_SERVICE_CONTROL_CONTINUE - 0x00000003 - - Avertit un service suspendu qu'il devrait reprendre. - - - - WIN32_SERVICE_CONTROL_DEVICEEVENT - 0x0000000B - - - - - WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE - 0x0000000C - - - - - WIN32_SERVICE_CONTROL_INTERROGATE - 0x00000004 - - Avertit un service qu'il doit rendre compte d'informations sur son état actuel - au gestionnaire de contrôle de service. - - - - WIN32_SERVICE_CONTROL_NETBINDADD - 0x00000007 - - Avertit un service réseau qu'il existe un nouveau composant pour la liaison. - - - - WIN32_SERVICE_CONTROL_NETBINDDISABLE - 0x0000000A - - Avertit un service réseau que l'une de ses liaisons a été désactivée. - - - - WIN32_SERVICE_CONTROL_NETBINDENABLE - 0x00000009 - - Avertit un service réseau qu'une liaison désactivée a été activée. - - - - WIN32_SERVICE_CONTROL_NETBINDREMOVE - 0x00000008 - - Avertit un service réseau qu'un composant pour la liaison a été supprimé. - - - - WIN32_SERVICE_CONTROL_PARAMCHANGE - 0x00000006 - - Avertit un service que ses paramètres de démarrage ont changé. - - - - WIN32_SERVICE_CONTROL_PAUSE - 0x00000002 - - Avertit un service qu'il doit se mettre en pause. - - - - WIN32_SERVICE_CONTROL_POWEREVENT - 0x0000000D - - - - - WIN32_SERVICE_CONTROL_PRESHUTDOWN - 0x0000000F - - Avertit un service que le système va s'arrêter. Un service qui gère cette - notification bloque l'arrêt du système jusqu'à l'arrêt du service ou jusqu'à - ce que le délai preshutdown expire. Cette valeur n'est pas prise en charge par - Windows Server 2003 et Windows XP/2000. - - - - WIN32_SERVICE_CONTROL_SESSIONCHANGE - 0x0000000E - - - - - WIN32_SERVICE_CONTROL_SHUTDOWN - 0x00000005 - - Avertit un service que le système s'arrête et que le service peut donc - effectuer des tâches de nettoyage. Si un service accepte ce code de - contrôle, il doit s'arrêter dès qu'il s'acquitte de ses tâches de nettoyage. - Après l'envoi de ce code de contrôle par l'ACM, aucun autre code de contrôle - ne sera envoyé au service. - - - - WIN32_SERVICE_CONTROL_STOP - 0x00000001 - - Avertit un service qu'il doit s'arrêter. - - - - -
    - - - Masque binaire de Message de Contrôle de Service de Win32Service - - - - Constante - Valeur - Description - - - - - WIN32_SERVICE_ACCEPT_HARDWAREPROFILECHANGE - 0x00000020 - - Le service est notifié lorsque le profil matériel de l'ordinateur a changé. - Cela permet au système d'envoyer des notifications - WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE au service. - - - - WIN32_SERVICE_ACCEPT_NETBINDCHANGE - 0x00000010 - - Le service est un composant réseau qui peut accepter les modifications de - sa liaison sans être arrêté et redémarré. Ce code de contrôle permet au - service de recevoir les notifications - WIN32_SERVICE_CONTROL_NETBINDADD, - WIN32_SERVICE_CONTROL_NETBINDREMOVE, - WIN32_SERVICE_CONTROL_NETBINDENABLE, et - WIN32_SERVICE_CONTROL_NETBINDDISABLE. - - - - WIN32_SERVICE_ACCEPT_PARAMCHANGE - 0x00000008 - - Le service peut relire ses paramètres de démarrage sans être arrêté et redémarré. - Ce code de contrôle permet au service de recevoir des notifications WIN32_SERVICE_CONTROL_PARAMCHANGE. - - - - WIN32_SERVICE_ACCEPT_PAUSE_CONTINUE - 0x00000002 - - Le service peut être mis en pause et continué. Ce code de contrôle permet au - service de recevoir les notifications - WIN32_SERVICE_CONTROL_PAUSE et WIN32_SERVICE_CONTROL_CONTINUE. - - - - WIN32_SERVICE_ACCEPT_POWEREVENT - 0x00000040 - - Le service est notifié lorsque l'état d'alimentation de l'ordinateur a changé. - Cela permet au système d'envoyer des notifications - WIN32_SERVICE_CONTROL_POWEREVENT au service. - - - - WIN32_SERVICE_ACCEPT_PRESHUTDOWN - 0x00000100 - - Le service peut effectuer des tâches d'avant arrêt. Ce code de contrôle permet - au service de recevoir la notification WIN32_SERVICE_CONTROL_PRESHUTDOWN. - Cette valeur n'est pas prise en charge par Windows Server 2003 et Windows XP/2000. - - - - WIN32_SERVICE_ACCEPT_SESSIONCHANGE - 0x00000080 - - Le service est notifié lorsque l'état de session de l'ordinateur a changé. - Cela permet au système d'envoyer des notifications - WIN32_SERVICE_CONTROL_SESSIONCHANGE au service. - Windows 2000: cette valeur n'est pas prise en charge. - - - - WIN32_SERVICE_ACCEPT_SHUTDOWN - 0x00000004 - - Le service est informé lorsque l'arrêt du système se produit. Ce code de contrôle - permet au service de recevoir la notification WIN32_SERVICE_CONTROL_SHUTDOWN. - - - - WIN32_SERVICE_ACCEPT_STOP - 0x00000001 - - Le service peut être stoppé. Ce contrôle permet au service de recevoir la - notification WIN32_SERVICE_CONTROL_STOP. - - - - WIN32_SERVICE_ACCEPT_TIMECHANGE - 0x00000200 - - Le service est notifié lorsque l'heure système a changé. - Cela permet au système d'envoyer des notifications - WIN32_SERVICE_CONTROL_TIMECHANGE au service. - Windows Server 2008, Windows Vista, Windows Server 2003 et Windows XP/2000: - ce code de contrôle n'est pas pris en charge. - - - - WIN32_SERVICE_ACCEPT_TRIGGEREVENT - 0x00000400 - - Le service est notifié lorsqu'un événement pour lequel le service s'est - enregistré se produit. - Cela permet au système d'envoyer des notifications - WIN32_SERVICE_CONTROL_TRIGGEREVENT au service. - Windows Server 2008, Windows Vista, Windows Server 2003 et Windows XP/2000: - ce code de contrôle n'est pas pris en charge. - - - - -
    - - - Constantes de Type de Démarrage du Service de Win32Service - - - - Constante - Valeur - Description - - - - - WIN32_SERVICE_BOOT_START - 0x00000000 - - Un pilote de périphérique Démarré par le chargeur système. Cette valeur est valide uniquement pour les services de pilote. - - - - WIN32_SERVICE_SYSTEM_START - 0x00000001 - - Un pilote de périphérique Démarré par la fonction IoInitSystem. Cette valeur est valide uniquement pour les services de pilote. - - - - WIN32_SERVICE_AUTO_START - 0x00000002 - - Un service lancé automatiquement par le gestionnaire de contrôle de service au - démarrage du système. - - - - WIN32_SERVICE_DEMAND_START - 0x00000003 - - Un service démarré par le gestionnaire de contrôle de service quand un - processus appelle la fonction StartService. - - - - WIN32_SERVICE_DISABLED - 0x00000004 - - Un service qui ne peut pas être démarré. Les tentatives pour démarrer - retournent un code d'erreur WIN32_ERROR_SERVICE_DISABLED. - - - - -
    - - - Constantes de Contrôle d'Erreur de Win32Service - - - - Constante - Valeur - Description - - - - - WIN32_SERVICE_ERROR_IGNORE - 0x00000000 - - Le programme de démarrage ignore l'erreur et continue l'opération de démarrage. - - - - WIN32_SERVICE_ERROR_NORMAL - 0x00000001 - - Le programme de démarrage enregistre l'erreur dans le journal des événements, - mais il continue l'opération de démarrage. - - - - WIN32_SERVICE_ERROR_SEVERE - 0x00000002 - - Le programme de démarrage consigne l'erreur dans le journal des événements. - Si la dernière configuration connue est lancée, l'opération de démarrage se - poursuit. Sinon, le système est redémarré avec la dernière configuration - connue-bonne. - - - - WIN32_SERVICE_ERROR_CRITICAL - 0x00000003 - - Le programme de démarrage consigne l'erreur dans le journal des événements, - si possible. - Si la dernière configuration connue est lancée, l'opération de démarrage - échoue. Sinon, le système est redémarré avec la dernière bonne configuration - connue. - - - - -
    - - - Constantes de Service Flag de Win32Service - - - - Constante - Valeur - Description - - - - - WIN32_SERVICE_RUNS_IN_SYSTEM_PROCESS - 0x00000001 - - Le service s'exécute dans un processus système qui doit toujours - être en cours d'exécution. - - - - -
    - - - - Ces constantes ne sont plus utilisées à partir de Win32Service 1.0.0. - - - - Codes d'Erreur Win32 - - - - Constante - Valeur - Description - - - - - WIN32_ERROR_ACCESS_DENIED - 0x00000005 - - Le gestionnaire de la base de données SCM ne dispose pas des droits d'accès appropriés. - - - - WIN32_ERROR_CIRCULAR_DEPENDENCY - 0x00000423 - - Une dépendance circulaire de service est spécifiée. - - - - WIN32_ERROR_DATABASE_DOES_NOT_EXIST - 0x00000429 - - La base de données spécifiée n'existe pas. - - - - WIN32_ERROR_DEPENDENT_SERVICES_RUNNING - 0x0000041B - - Le service ne peut être stoppé car d'autres services en cours d'exécution - dépendent de lui. - - - - WIN32_ERROR_DUPLICATE_SERVICE_NAME - 0x00000436 - - Le nom d'affichage existe déjà dans la base de données du gestionnaire de service - en tant que nom de service ou que nom d'affichage. - - - - WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT - 0x00000427 - - Cette erreur est retournée si le programme est exécuté en application console - plutôt qu'en tant que service. Si le programme est exécuté en tant qu'application - console à des fins de débogage, il devrait être structuré afin que le code spécifique - au service ne soit jamais appelé. - - - - WIN32_ERROR_INSUFFICIENT_BUFFER - 0x0000007A - - Le tampon est trop petit pour la structure d'état de service. - Rien n'a été écrit dans la structure. - - - - WIN32_ERROR_INVALID_DATA - 0x0000000D - - La structure d'état de service indiquée n'est pas valide. - - - - WIN32_ERROR_INVALID_HANDLE - 0x00000006 - - Le handle pour le gestionnaire de service de contrôle spécifié est invalide. - - - - WIN32_ERROR_INVALID_LEVEL - 0x0000007C - - Le paramètre InfoLevel contient une valeur non prise en charge. - - - - WIN32_ERROR_INVALID_NAME - 0x0000007B - - Le nom de service spécifié n'est pas valide. - - - - WIN32_ERROR_INVALID_PARAMETER - 0x00000057 - - Un paramètre spécifié n'est pas valide. - - - - WIN32_ERROR_INVALID_SERVICE_ACCOUNT - 0x00000421 - - Le nom d'utilisateur spécifié dans le paramètre user - n'existe pas. Voir win32_create_service. - - - - WIN32_ERROR_INVALID_SERVICE_CONTROL - 0x0000041C - - Le code de contrôle demandé n'est pas valide, ou il est inacceptable pour le service. - - - - WIN32_ERROR_PATH_NOT_FOUND - 0x00000003 - - Le service de fichier binaire n'a pu être trouvé. - - - - WIN32_ERROR_SERVICE_ALREADY_RUNNING - 0x00000420 - - Une instance du service est déjà en cours d'exécution. - - - - WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL - 0x00000425 - - Le code de contrôle demandé ne peut être envoyé au service car l'état du service - est WIN32_SERVICE_STOPPED, - WIN32_SERVICE_START_PENDING ou - WIN32_SERVICE_STOP_PENDING. - - - - WIN32_ERROR_SERVICE_DATABASE_LOCKED - 0x0000041F - - La base de données est verrouillée. - - - - WIN32_ERROR_SERVICE_DEPENDENCY_DELETED - 0x00000433 - - Le service dépend d'un service qui n'existe pas ou qui a été marqué pour - suppression. - - - - WIN32_ERROR_SERVICE_DEPENDENCY_FAIL - 0x0000042C - - Ce service dépend d'un autre service qui n'a pas pu démarrer. - - - - WIN32_ERROR_SERVICE_DISABLED - 0x00000422 - - Le service a été désactivé. - - - - WIN32_ERROR_SERVICE_DOES_NOT_EXIST - 0x00000424 - - Le service spécifié n'existe pas en tant que service installé. - - - - WIN32_ERROR_SERVICE_EXISTS - 0x00000431 - - Le service spécifié existe déjà dans la base de données. - - - - WIN32_ERROR_SERVICE_LOGON_FAILED - 0x0000042D - - Le service n'a pas démarré en raison d'un échec de connexion. Cette - erreur se produit si le service est configuré pour s'exécuter sous - un compte qui n'a pas les droits "connecter en tant que service". - - - - WIN32_ERROR_SERVICE_MARKED_FOR_DELETE - 0x00000430 - - Le service spécifié a déjà été marqué pour suppression. - - - - WIN32_ERROR_SERVICE_NO_THREAD - 0x0000041E - - Un thread n'a pas pu être créé pour le service. - - - - WIN32_ERROR_SERVICE_NOT_ACTIVE - 0x00000426 - - Le service n'a pas été démarré. - - - - WIN32_ERROR_SERVICE_REQUEST_TIMEOUT - 0x0000041D - - Le processus du service a été démarré, mais il n'a pas appelé - StartServiceCtrlDispatcher, ou le thread qui a appelé StartServiceCtrlDispatcher - peut être bloqué dans une fonction du gestionnaire de contrôle. - - - - WIN32_ERROR_SHUTDOWN_IN_PROGRESS - 0x0000045B - - Le système s'arrête, cette fonction ne peut pas être appelée. - - - - WIN32_ERROR_SERVICE_SPECIFIC_ERROR - 0x0000042A - - Le service a retourné un code d'erreur spécifique au service. - - - - WIN32_NO_ERROR - 0x00000000 - - Aucune erreur. - - - - -
    - - - Classes de Priorité de Base Win32 - - - - Constante - Valeur - Description - - - - - WIN32_ABOVE_NORMAL_PRIORITY_CLASS - 0x00008000 - - Processus ayant une priorité supérieure à WIN32_NORMAL_PRIORITY_CLASS - mais inférieure à WIN32_HIGH_PRIORITY_CLASS. - - - - WIN32_BELOW_NORMAL_PRIORITY_CLASS - 0x00004000 - - Processus ayant une priorité supérieure à WIN32_IDLE_PRIORITY_CLASS - mais inférieure à WIN32_NORMAL_PRIORITY_CLASS. - - - - WIN32_HIGH_PRIORITY_CLASS - 0x00000080 - - Processus qui exécute des tâches critiques dans le temps qui doivent - être exécutées immédiatement. Le thread du processus devance les - threads de priorité normale ou au repos. Un exemple est la liste des - tâches, qui doit répondre rapidement quand elle est appelée par - l'utilisateur quelle que soit la charge du système. Soyez extrêmement - prudent lorsqu'on utilise la classe de haute priorité, car une - application de classe de haute priorité peut utiliser presque tout - le temps CPU disponible. - - - - WIN32_IDLE_PRIORITY_CLASS - 0x00000040 - - Processus dont les threads ne s'exécutent que lorsque le système est - inactif. Les threads du processus sont devancés par les threads de tout - processus en cours ayant une classe de plus grande priorité. - Un exemple est un économiseur d'écran. Cette classe est héritée par les - processus enfants. - - - - WIN32_NORMAL_PRIORITY_CLASS - 0x00000020 - - Processus sans planification de besoins spéciaux. - - - - WIN32_REALTIME_PRIORITY_CLASS - 0x00000100 - - Processus ayant la plus haute priorité possible. Les threads du processus - devancent les threads de tout autre processus, y compris les processus du - système d'exploitation exécutant des tâches importantes. Par exemple, un - processus en temps réel qui s'exécute un peu trop lentement peut causer - des pertes d'écriture du tampon sur le disque ou empêcher la souris de - répondre. - - - - -
    - - - Actions de récupération Win32 - - - - Constante - Valeur - Description - - - - - WIN32_SC_ACTION_NONE - 0x00000000 - - Aucune action. - - - - WIN32_SC_ACTION_RESTART - 0x00000001 - - Redémarrer le service. - - - - WIN32_SC_ACTION_REBOOT - 0x00000002 - - Redémarrer le serveur. - - - - WIN32_SC_ACTION_RUN_COMMAND - 0x00000003 - - Exécuter un programme. - - - - -
    - - - Informations de service Win32 - - - - Constante - Valeur - Description - - - - - WIN32_INFO_SERVICE - "service" - - - - - WIN32_INFO_DISPLAY - "display" - - - - - WIN32_INFO_USER - "user" - - - - - WIN32_INFO_PASSWORD - "password" - - - - - WIN32_INFO_PATH - "path" - - - - - WIN32_INFO_PARAMS - "params" - - - - - WIN32_INFO_DESCRIPTION - "description" - - - - - WIN32_INFO_START_TYPE - "start_type" - - - - - WIN32_INFO_LOAD_ORDER - "load_order" - - - - - WIN32_INFO_SVC_TYPE - "svc_type" - - - - - WIN32_INFO_ERROR_CONTROL - "error_control" - - - - - WIN32_INFO_DELAYED_START - "delayed_start" - - - - - WIN32_INFO_BASE_PRIORITY - "base_priority" - - - - - WIN32_INFO_DEPENDENCIES - "dependencies" - - - - - WIN32_INFO_RECOVERY_DELAY - "recovery_delay" - - - - - WIN32_INFO_RECOVERY_ACTION_1 - "recovery_action_1" - - - - - WIN32_INFO_RECOVERY_ACTION_2 - "recovery_action_2" - - - - - WIN32_INFO_RECOVERY_ACTION_3 - "recovery_action_3" - - - - - WIN32_INFO_RECOVERY_RESET_PERIOD - "recovery_reset_period" - - - - - WIN32_INFO_RECOVERY_ENABLED - "recovery_enabled" - - - - - WIN32_INFO_RECOVERY_REBOOT_MSG - "recovery_reboot_msg" - - - - - WIN32_INFO_RECOVERY_COMMAND - "recovery_command" - - - - - -
    - - - Permission de service Win32 - - - - Constante - Valeur - Description - - - - - WIN32_SERVICE_ALL_ACCESS - 0x000F003F - - - - - WIN32_SERVICE_CHANGE_CONFIG - 0x00000002 - - - - - WIN32_SERVICE_ENUMERATE_DEPENDENTS - 0x00000008 - - - - - WIN32_SERVICE_INTERROGATE - 0x00000080 - - - - - WIN32_SERVICE_PAUSE_CONTINUE - 0x00000040 - - - - - WIN32_SERVICE_QUERY_CONFIG - 0x00000001 - - - - - WIN32_SERVICE_QUERY_STATUS - 0x00000004 - - - - - WIN32_SERVICE_START - 0x00000010 - - - - - WIN32_SERVICE_STOP - 0x00000020 - - - - - WIN32_SERVICE_USER_DEFINED_CONTROL - 0x00000100 - - - - - WIN32_ACCESS_SYSTEM_SECURITY - 0x00001000 - - - - - WIN32_DELETE - 0x00010000 - - - - - WIN32_READ_CONTROL - 0x00020000 - - - - - WIN32_WRITE_DAC - 0x00040000 - - - - - WIN32_WRITE_OWNER - 0x00080000 - - - - - WIN32_GENERIC_READ - Inclut les permissions: - WIN32_STANDARD_RIGHTS_READ, - WIN32_SERVICE_QUERY_CONFIG, - WIN32_SERVICE_QUERY_STATUS, - WIN32_SERVICE_INTERROGATE, - WIN32_SERVICE_ENUMERATE_DEPENDENTS - - - - - - WIN32_GENERIC_WRITE - Inclut les permissions: - WIN32_STANDARD_RIGHTS_WRITE, - WIN32_SERVICE_CHANGE_CONFIG - - - - - - WIN32_GENERIC_EXECUTE - Inclut les permissions: - WIN32_STANDARD_RIGHTS_EXECUTE, - WIN32_SERVICE_START, - WIN32_SERVICE_STOP, - WIN32_SERVICE_PAUSE_CONTINUE, - WIN32_SERVICE_USER_DEFINED_CONTROL - - - - - - -
    -     - - diff --git a/reference/win32service/examples.xml b/reference/win32service/examples.xml deleted file mode 100644 index 0a8baf2bf9..0000000000 --- a/reference/win32service/examples.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - &reftitle.examples; - - - Enregistre un script PHP pour exécuter en tant que service - - 'dummyphp', # nom du service - 'display' => 'sample dummy PHP service', # description courte - 'description' => 'This is a dummy Windows service created using PHP.', # description longue - 'params' => '"' . __FILE__ . '" run', # chemin vers le script et paramètres -)); -?> -]]> - - - - - - Efface un service - - -]]> - - - - - - Exécution d'un service - - -]]> - - - - - - - diff --git a/reference/win32service/functions/win32-add-right-access-service.xml b/reference/win32service/functions/win32-add-right-access-service.xml deleted file mode 100644 index 3953be892f..0000000000 --- a/reference/win32service/functions/win32-add-right-access-service.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - win32_add_right_access_service - Ajoute les droits d'accès pour un utilisateur au service - - - - &reftitle.description; - - voidwin32_add_right_access_service - stringservicename - stringusername - intright - stringmachine&null; - - - Ajoute les droits d'accès pour username sur le service servicename. - Les privilèges administratifs sont requis pour que cela réussisse. - - - - - &reftitle.parameters; - - - - servicename - - - Le nom du service auquel ajouter les droits d'accès. - - - - - username - - - Lis les droits d'accès pour username. - - - - - right - - - Les droits autorisés pour username. - Les constantes pour définir cette valeur. - - - - - machine - - - Le nom de la machine optionnel sur laquelle on souhaite créer un service. - Si omis, il utilisera la machine locale. - - - - - - - - - &reftitle.returnvalues; - - Renvoie un objet Win32Service\RightInfo. - - - - - &reftitle.errors; - - Une ValueError est lancée si la valeur - du paramètre service est vide. - - - Une ValueError est lancée si la valeur - du paramètre username est vide. - - - Une Win32ServiceException est lancée en cas d'erreur. - - - - - &reftitle.seealso; - - - win32_read_all_rights_access_service - win32_read_rights_access_service - win32_remove_right_access_service - Constantes de permissions Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-add-service-env-var.xml b/reference/win32service/functions/win32-add-service-env-var.xml deleted file mode 100644 index 3e12c3a0aa..0000000000 --- a/reference/win32service/functions/win32-add-service-env-var.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - win32_add_service_env_var - Ajoute une variable d'environnement personnalisée sur le service - - - - &reftitle.description; - - voidwin32_add_service_env_var - stringservicename - stringvarname - stringvalue - - - Ajoute une variable d'environnement personnalisée varname sur le service servicename. - Cette fonction ne fonctionne que pour l'ordinateur local. Les privilèges administratifs sont requis pour que cela réussisse. - - - - - &reftitle.parameters; - - - - servicename - - - Le nom du service auquel ajouter la variable d'environnement. - - - - - varname - - - Le nom de la variable d'environnement. - - - - - value - - - La valeur de la variable d'environnement. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Une ValueError est lancée si la - valeur du paramètre service est vide. - - - Une ValueError est lancée si la - valeur du paramètre varname est vide. - - - Une Win32ServiceException est lancée en cas d'erreur. - - - - - &reftitle.seealso; - - - win32_get_service_env_vars - win32_remove_service_env_var - - - - - - - diff --git a/reference/win32service/functions/win32-continue-service.xml b/reference/win32service/functions/win32-continue-service.xml deleted file mode 100644 index 710175aa72..0000000000 --- a/reference/win32service/functions/win32-continue-service.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - win32_continue_service - Reprise d'un service en pause - - - &reftitle.description; - - voidwin32_continue_service - stringservicename - stringmachine&null; - - - Reprise d'un service en pause. Requiert des privilèges d'administrateur ou - un compte avec les droits appropriés définis dans l'ACL du service. - - - - &reftitle.parameters; - - - - servicename - - - Le nom court du service. - - - - - machine - - - Nom de la machine (optionnel). Si omis, la machine locale - sera utilisée. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Avant la version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Une ValueError est levée si la valeur du paramètre - servicename est vide. - - - Une Win32ServiceException est levée en cas d'erreur. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - PECL win32service 1.0.0 - - Le type de retour est maintenant void, avant il était mixed. - - - - PECL win32service 0.3.0 - - Cette fonction ne requiert plus de compte d'administrateur si l'ACL - est défini pour un autre compte. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service - win32_stop_service - win32_pause_service - win32_send_custom_control - Les codes erreur Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-create-service.xml b/reference/win32service/functions/win32-create-service.xml deleted file mode 100644 index 415837bd23..0000000000 --- a/reference/win32service/functions/win32-create-service.xml +++ /dev/null @@ -1,527 +0,0 @@ - - - - - - - win32_create_service - Crée une nouvelle entrée pour service dans la base de données SCM - - - - &reftitle.description; - - voidwin32_create_service - arraydetails - stringmachine&null; - - - Tente d'ajouter un service dans la base de données SCM. Des privilèges - d'administrateur sont nécessaires pour que cela réussisse. - - - - - &reftitle.parameters; - - - - details - - - Un tableau des détails des services : - - - service - - - Le nom court du service. C'est le nom utilisé pour - contrôler le service avec la commande - net. Le service doit être unique (deux services - ne peuvent partager le même nom), et idéalement, devrait éviter - d'avoir des espaces dans son nom. - - - - - display - - Le nom d'affichage du service. C'est le nom visible - dans l'Applet Services. - - - - - description - - - La description longue du service. - C'est la description visible dans l'Applet des - services. - - - - - user - - - Le nom de l'utilisateur sous lequel on souhaite que le service - s'exécute. Si oublié, le service fonctionnera en tant que - LocalSystem. Si le nom de l'utilisateur est spécifié, il faut - aussi fournir un mot de passe. - - - - - password - - - Le mot de passe qui correspond à user. - - - - - path - - - Le chemin complet au module exécutable qui sera démarré lorsque le - service est démarré. Si oublié, le chemin du processus courant de - PHP sera utilisé. - - - - - params - - - Paramètres de commande à passer au service lorsqu'il démarre. - Pour exécuter un script PHP en tant que service, alors - le premier paramètre devrait être le chemin complet au script PHP - prévu pour l'exécution. Si le nom du script ou le chemin - contiennent des espaces, alors, entourez le chemin complet du script - PHP par des " - - - - - load_order - - - Contrôle le load_order. Cela n'est pas encore complètement - supporté. - - - - - svc_type - - - Fixe le type de service. Si oublié, la valeur par défaut est - WIN32_SERVICE_WIN32_OWN_PROCESS. Ne changez - pas ceci à moins de savoir vraiment ce que l'on fait. - - - - - start_type - - - Spécifie comment le service devrait être démarré. La valeur par - défaut est WIN32_SERVICE_AUTO_START qui - signifie que le service sera démarré lorsque la machine démarrera. - - - - - error_control - - - Informe le SCM à propos de ce qu'il devrait faire lorsqu'il détecte - un problème avec le service. La valeur par défaut est - WIN32_SERVER_ERROR_IGNORE. Le changement de - cette valeur n'est pas encore complètement supporté. - - - - - delayed_start - - - Si delayed_start est défini à - &true;, alors il informera le SCM que ce service doit être - démarré après les services démarrés automatiquement et un certain - délai. - - - N'importe quel service peut être marqué comme étant un service - retardé après le démarrage automatique ; cependant, cette configuration - n'a aucun effet tant que le paramètre start_type - du service vaut WIN32_SERVICE_AUTO_START. - - - Cette configuration n'est applicable que sous Windows Vista et les - serveurs Windows 2008 et suivants. - - - - - base_priority - - - Pour réduire l'impact sur l'utilisation du processeur, il peut - être nécessaire de définir une priorité plus basse qu'à la normale. - - - Le paramètre base_priority peut être défini à - une des constantes définies dans les - classes de priorité de base Win32. - - - - dependencies - - - Pour définir les dépendances du service, il est nécessaire de - définir ce paramètre avec la liste des noms des services dans un tableau. - - - - - recovery_delay - - - Ce paramètre définit le délai entre la défaillance et l'exécution de - l'action de récupération. La valeur est en millisecondes. - - - La valeur par défaut est 60000. - - - - - recovery_action_1 - - - L'action qui sera exécutée lors de la première défaillance. L'action - par défaut est WIN32_SC_ACTION_NONE. - - - Le paramètre recovery_action_1 peut être défini - avec l'une des constantes définies dans les - Actions de récupération Win32. - - - - - recovery_action_2 - - - L'action qui sera exécutée lors de la deuxième défaillance. L'action - par défaut est WIN32_SC_ACTION_NONE. - - - Le paramètre recovery_action_2 peut être défini - avec l'une des constantes définies dans les - Actions de récupération Win32. - - - - - recovery_action_3 - - - L'action qui sera exécutée lors des défaillances suivantes. L'action - par défaut est WIN32_SC_ACTION_NONE. - - - Le paramètre recovery_action_3 peut être défini - avec l'une des constantes définies dans les - Actions de récupération Win32. - - - - - recovery_reset_period - - - Le compteur des défaillances sera réinitialisé après le délai défini - dans ce paramètre. Le délai est exprimé en secondes. - - - La valeur par défaut est 86400. - - - - - recovery_enabled - - - Définir ce paramètre à &true; pour activer les options de récupération, et &false; - pour les désactiver. - - - La valeur par défaut est &false; - - - - - recovery_reboot_msg - - - Ajouter ce paramètre pour définir le message enregistré dans le journal - d'évènements Windows avant le redémarrage. Utilisé uniquement si l'une - des actions est définie à - WIN32_SC_ACTION_REBOOT. - - - - - recovery_command - - - Ajouter ce paramètre pour définir la commande à exécuter lorsqu'une - action est définie à - WIN32_SC_ACTION_RUN_COMMAND. - - - - - - - - - machine - - - Le nom optionnel de la machine sur laquelle on souhaite créer le service. - Si oublié, cela utilisera la machine locale. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Avant la version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Une ValueError est levée si la valeur du paramètre - service est vide. - - - Une ValueError est levée si la valeur du paramètre - path est omise ou vide. - - - Une ValueError est levée si la valeur du paramètre - svc_type est incorrecte. - - - Une ValueError est levée si la valeur du paramètre - start_type est incorrecte. - - - Une ValueError est levée si la valeur du paramètre - error_control est incorrecte. - - - Une ValueError est levée si la valeur du paramètre - base_priority est incorrecte. - - - Une ValueError est levée si la valeur du paramètre - recovery_delay n'est pas entre - 0 et PHP_INT_MAX. - - - Une ValueError est levée si la valeur du paramètre - recovery_action_1 est incorrecte. - - - Une ValueError est levée si la valeur du paramètre - recovery_action_2 est incorrecte. - - - Une ValueError est levée si la valeur du paramètre - recovery_action_3 est incorrecte. - - - Une ValueError est levée si la valeur du paramètre - recovery_reset_period n'est pas entre - 0 et PHP_INT_MAX. - - - Une Win32ServiceException est levée en cas d'erreur. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - PECL win32service 1.0.0 - - Le type de retour est maintenant void, avant il était mixed. - - - - PECL win32service 0.4.0 - - Les paramètres dependencies, recovery_delay, - recovery_action_1, recovery_action_2, - recovery_action_3, recovery_reset_period, - recovery_enabled, recovery_reboot_msg - et recovery_command ont été ajoutés. - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>win32_create_service</function> - - Crée un service dont le nom court est 'dummyphp'. - - - 'dummyphp', // le nom de votre service - 'display' => 'service PHP simple', // la description courte - 'description' => 'Ceci est un service Windows créé en utilisant PHP', // la description longue - 'params' => '"' . __FILE__ . '" run', // chemin vers le script ainsi que les paramètres -)); -debug_zval_dump($x); -?> -]]> - - - - - - Un exemple <function>win32_create_service</function> avec les dépendances - - Crée un service dont le nom court est 'dummyphp' avec des dépendances. - - - 'dummyphp', // Le nom du service - 'display' => 'service PHP simple', // Une courte description - 'description' => 'Ceci est un service Windows créé en utilisant PHP.', // Une longue description - 'params' => '"' . __FILE__ . '" run', // chemin vers le script ainsi que les paramètres - 'dependencies' => array("Netman"), // La liste des dépendances -)); -debug_zval_dump($x); -?> -]]> - - - - - - Exemple de <function>win32_create_service</function> avec les options de récupération - - Crée un service dont le nom court est 'dummyphp' avec les options de récupération. - - - 'dummyphp', // Le nom du service - 'display' => 'service PHP simple', // Une courte description - 'description' => 'Ceci est un service Windows créé en utilisant PHP.', // Une longue description - 'params' => '"' . __FILE__ . '" run', // chemin vers le script ainsi que les paramètres - 'recovery_delay' => 120000, // Les actions de récupération seront exécutées après 2 minutes - 'recovery_action_1' => WIN32_SC_ACTION_RESTART, // Première défaillance, redémarrage du service - 'recovery_action_2' => WIN32_SC_ACTION_RUN_COMMAND, // Deuxième défaillance, exécution d'une commande - 'recovery_action_3' => WIN32_SC_ACTION_NONE, // Défaillance suivante, ne rien faire - 'recovery_reset_period' => 86400, // Réinitialiser le compteur des défaillances après 1 jour (86400 secondes) - 'recovery_enabled' => true, // Activer les options de récupération - 'recovery_reboot_msg' => null, // Ne pas définir de message de redémarrage, il n'est pas utile. - 'recovery_command' => "c:\clean-service.bat", // Lorsque l'action est WIN32_SC_ACTION_RUN_COMMAND, exécuter cette commande. -)); -debug_zval_dump($x); -?> -]]> - - - - - - - &reftitle.seealso; - - - win32_delete_service - Les classes de priorité de base Win32 - Les actions de récupération Win32 - Les codes erreurs Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-delete-service.xml b/reference/win32service/functions/win32-delete-service.xml deleted file mode 100644 index 230c763727..0000000000 --- a/reference/win32service/functions/win32-delete-service.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - win32_delete_service - Supprime une entrée de service de la base de données SCM - - - &reftitle.description; - - voidwin32_delete_service - stringservicename - stringmachine&null; - - - Essaie de supprimer un service de la base de données SCM. Les privilèges - d'administrateur sont requis pour que cette fonction réussisse. - - - Cette fonction ne fait que marquer le service pour suppression. Si d'autres - processus (comme l'Applet Services) sont ouverts, alors la suppression sera - reportée jusqu'à ce que ces applications soient fermées. Si un service est - marqué pour suppression, d'autres tentatives de suppression échoueront et les - tentatives de créer un nouveau service avec ce nom échoueront aussi. - - - - - &reftitle.parameters; - - - - servicename - - - Le nom court du service. - - - - - machine - - - Le nom optionnel de la machine. - Si oublié, cela utilisera la machine locale. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Avant la version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Une ValueError est levée si la valeur du paramètre - servicename est vide. - - - - Une Win32ServiceException est levée en cas d'erreur. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - PECL win32service 1.0.0 - - Le type de retour est maintenant void, avant il était mixed. - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>win32_delete_service</function> - - Supprime le service dummyphp. - - - -]]> - - - - - - - &reftitle.seealso; - - - win32_create_service - Les codes erreur Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-get-last-control-message.xml b/reference/win32service/functions/win32-get-last-control-message.xml deleted file mode 100644 index d17e658733..0000000000 --- a/reference/win32service/functions/win32-get-last-control-message.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - win32_get_last_control_message - Retourne le dernier message de contrôle qui a été envoyé à ce service - - - &reftitle.description; - - intwin32_get_last_control_message - - - - Retourne le code de contrôle qui a été envoyé en dernier à ce processus de - service. Lorsqu'il fonctionne en tant que service, il est recommandé de vérifier - périodiquement pour déterminer si le service doit être arrêté. - - - - - Depuis la version 0.2.0, cette fonction fonctionne uniquement en ligne de - commande. Elle est désactivée dans les autres cas. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne une constante de contrôle qui sera une parmi - les - constantes de contrôle des messages de service Win32Service : - WIN32_SERVICE_CONTROL_CONTINUE, - WIN32_SERVICE_CONTROL_DEVICEEVENT, - WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE, - WIN32_SERVICE_CONTROL_INTERROGATE, - WIN32_SERVICE_CONTROL_NETBINDADD, - WIN32_SERVICE_CONTROL_NETBINDDISABLE, - WIN32_SERVICE_CONTROL_NETBINDENABLE, - WIN32_SERVICE_CONTROL_NETBINDREMOVE, - WIN32_SERVICE_CONTROL_PARAMCHANGE, - WIN32_SERVICE_CONTROL_PAUSE, - WIN32_SERVICE_CONTROL_POWEREVENT, - WIN32_SERVICE_CONTROL_PRESHUTDOWN, - WIN32_SERVICE_CONTROL_SESSIONCHANGE, - WIN32_SERVICE_CONTROL_SHUTDOWN, - WIN32_SERVICE_CONTROL_STOP. - - - Si la valeur se situe entre 128 et 255, le code de contrôle est personnalisé. - - - - - &reftitle.errors; - - Avant la version 1.0.0, si cette fonction est utilisée en dehors du SAPI "cli", une - erreur E_ERROR sera émise. - - - À partir de la version 1.0.0, lancera une - Win32ServiceException si le SAPI n'est pas - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - PECL win32service 0.2.0 - - Cette fonction fonctionne uniquement en ligne de - commande. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service_ctrl_dispatcher - win32_set_service_status - win32_set_service_exit_mode - win32_set_service_exit_code - les constantes de contrôle des messages de service Win32Service - - - - - - diff --git a/reference/win32service/functions/win32-get-service-env-vars.xml b/reference/win32service/functions/win32-get-service-env-vars.xml deleted file mode 100644 index cda0fd9f62..0000000000 --- a/reference/win32service/functions/win32-get-service-env-vars.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - win32_get_service_env_vars - Lit toutes les variables d'environnement personnalisées sur le service - - - - &reftitle.description; - - arraywin32_get_service_env_vars - stringservicename - - - Lit toutes les variables d'environnement personnalisées sur le service servicename. - Cette fonction ne fonctionne que pour l'ordinateur local. Les privilèges administratifs sont requis pour que cela réussisse. - - - - - &reftitle.parameters; - - - - servicename - - - Le nom du service pour lire les variables d'environnement. - - - - - - - - - &reftitle.returnvalues; - - Renvoie un &array; avec le nom de la variable en clé et la valeur de la variable en valeur. - - - - - &reftitle.errors; - - Une ValueError est lancée si la valeur du paramètre - service est vide. - - - Une Win32ServiceException est lancée en cas d'erreur. - - - - - &reftitle.seealso; - - - win32_add_service_env_var - win32_remove_service_env_var - - - - - - - diff --git a/reference/win32service/functions/win32-pause-service.xml b/reference/win32service/functions/win32-pause-service.xml deleted file mode 100644 index 7b7e2e4a3b..0000000000 --- a/reference/win32service/functions/win32-pause-service.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - - win32_pause_service - Met en pause un service - - - &reftitle.description; - - voidwin32_pause_service - stringservicename - stringmachine&null; - - - Met en pause un service. Requiert des privilèges d'administrateur ou - un compte avec les droits appropriés définis dans l'ACL du service. - - - - &reftitle.parameters; - - - - servicename - - - Le nom court du service. - - - - - machine - - - Nom de la machine (optionnel). Si omis, la machine locale - sera utilisée. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Avant la version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Une ValueError est levée si la valeur du paramètre - servicename est vide. - - - - Une Win32ServiceException est levée en cas d'erreur. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - PECL win32service 1.0.0 - - Le type de retour est maintenant void, avant il était mixed. - - - - PECL win32service 0.3.0 - - Cette fonction ne requiert plus de compte d'administrateur si l'ACL - est défini pour un autre compte. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service - win32_stop_service - win32_continue_service - win32_send_custom_control - Les codes erreur Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-query-service-status.xml b/reference/win32service/functions/win32-query-service-status.xml deleted file mode 100644 index a2c351aa5d..0000000000 --- a/reference/win32service/functions/win32-query-service-status.xml +++ /dev/null @@ -1,234 +0,0 @@ - - - - - - - - win32_query_service_status - Questionne le statut d'un service - - - &reftitle.description; - - arraywin32_query_service_status - stringservicename - stringmachine&null; - - - Questionne le statut courant pour un service, retournant un tableau - d'informations. - - - - - &reftitle.parameters; - - - - servicename - - - Le nom court du service. - - - - - machine - - - Le nom optionnel de la machine. - Si oublié, cela utilisera la machine locale. - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les informations suivantes en - cas de succès. - - - Avant la version 1.0.0&win32service.false.error; - - - - - ServiceType - - - Le dwServiceType. Voir les - masques de type de - service Win32Service. - - - - - CurrentState - - - Le dwCurrentState. Voir les - constantes de statut - des services Win32Service. - - - - - ControlsAccepted - - - Quels contrôles de service sont acceptés par le service. Voir - les masques - acceptés pour les messages de contrôle de service Win32Service. - - - - - Win32ExitCode - - - Si le service quitte, le code de retour du processus. Cette valeur est égale - à WIN32_ERROR_SERVICE_SPECIFIC_ERROR si le mode de - sortie n'est pas gracieux. Voir - codes d'erreur Win32Service - et win32_set_service_exit_mode. - - - - - ServiceSpecificExitCode - - - Si le service quitte avec une condition d'erreur, le code spécifique du - service qui sera enregistré dans le journal d'évènements est visible ici. - Cette valeur est égale à la valeur définie par - win32_set_service_exit_code. - - - - - CheckPoint - - - Si le service s'arrête, garde le nombre courant de point de contrôle. - Ceci est utilisé par SCM comme un genre de battement de cœur pour - détecter un processus de service arrêté. La valeur du point de contrôle - est mieux interprétée en conjonction avec la valeur WaitHint. - - - - - WaitHint - - - Si le service s'arrête, il fixera un WaitHint à une valeur de point de - contrôle qui indiquera l'exécution 100%. Cela peut être utilisé pour - implanter un indicateur de progrès. - - - - - ProcessId - - - L'identifiant de processus Windows. Si 0, le processus ne fonctionne - pas. - - - - - ServiceFlags - - - Le dwServiceFlags. Voir les - constantes - utilisées pour les drapeaux des services Win32Service. - - - - - - - - - &reftitle.errors; - - Une ValueError est levée si la valeur du paramètre - servicename est vide. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - PECL win32service 1.0.0 - - Le type de retour est maintenant array, avant il était mixed. - - - - - - - - - - &reftitle.seealso; - - - Les constantes Win32Service prédéfinies - - - - - - diff --git a/reference/win32service/functions/win32-read-all-rights-access-service.xml b/reference/win32service/functions/win32-read-all-rights-access-service.xml deleted file mode 100644 index 44a873e4b4..0000000000 --- a/reference/win32service/functions/win32-read-all-rights-access-service.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - win32_read_all_rights_access_service - Lit tous les droits d'accès au service - - - - &reftitle.description; - - arraywin32_read_all_rights_access_service - stringservicename - stringmachine&null; - - - Lit tous les droits d'accès sur le service servicename. - Les privilèges administratifs sont requis pour que cela réussisse. - - - - - &reftitle.parameters; - - - - servicename - - - Le nom du service pour lire les droits d'accès. - - - - - machine - - - Le nom de la machine optionnel sur laquelle on souhaite créer un service. - Si omis, il utilisera la machine locale. - - - - - - - - - &reftitle.returnvalues; - - Renvoie un &array; de Win32Service\RightInfo - - - - - &reftitle.errors; - - Une ValueError est lancée si la valeur du paramètre - service est vide. - - - Une Win32ServiceException est lancée en cas d'erreur. - - - - - &reftitle.seealso; - - - win32_read_rights_access_service - win32_add_right_access_service - win32_remove_right_access_service - Constantes de permissions Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-read-right-access-service.xml b/reference/win32service/functions/win32-read-right-access-service.xml deleted file mode 100644 index 8c0c41c816..0000000000 --- a/reference/win32service/functions/win32-read-right-access-service.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - win32_read_right_access_service - Lit les droits d'accès au service pour un utilisateur - - - - &reftitle.description; - - Win32Service\RightInfowin32_read_right_access_service - stringservicename - stringusername - stringmachine&null; - - - Lit les droits d'accès pour username sur le service servicename. - Les privilèges administratifs sont requis pour que cela réussisse. - - - - - &reftitle.parameters; - - - - servicename - - - Le nom du service pour lire les droits d'accès. - - - - - username - - - Lit les droits d'accès pour username - - - - - machine - - - Le nom de la machine optionnel sur laquelle on souhaite créer un service. - Si omis, il utilisera la machine locale. - - - - - - - - - &reftitle.returnvalues; - - Renvoie un objet Win32Service\RightInfo. - - - - - &reftitle.errors; - - Une ValueError est lancée si la valeur du paramètre - service est vide. - - - Une ValueError est lancée si la valeur du paramètre - username est vide. - - - Une Win32ServiceException est lancée sur erreur. - - - - - &reftitle.seealso; - - - win32_read_all_rights_access_service - win32_add_right_access_service - win32_remove_right_access_service - Constantes de permissions Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-remove-right-access-service.xml b/reference/win32service/functions/win32-remove-right-access-service.xml deleted file mode 100644 index 5a9314ec4b..0000000000 --- a/reference/win32service/functions/win32-remove-right-access-service.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - win32_remove_right_access_service - Enlève les droits d'accès pour un utilisateur au service - - - - &reftitle.description; - - voidwin32_remove_right_access_service - stringservicename - stringusername - stringmachine&null; - - - Enlève les droits d'accès pour username sur le service servicename. - Les privilèges administratifs sont requis pour que cela réussisse. - - - - - &reftitle.parameters; - - - - servicename - - - Le nom du service auquel enlever les droits d'accès. - - - - - username - - - Lis les droits d'accès pour username. - - - - - machine - - - Le nom de la machine optionnel sur laquelle on souhaite créer un service. - Si omis, il utilisera la machine locale. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Une ValueError est lancée si la valeur du paramètre - service est vide. - - - Une ValueError est lancée si la valeur du paramètre - username est vide. - - - Une Win32ServiceException est lancée en cas d'erreur. - - - - - &reftitle.seealso; - - - win32_read_all_rights_access_service - win32_read_rights_access_service - win32_add_right_access_service - - - - - - - diff --git a/reference/win32service/functions/win32-remove-service-env-var.xml b/reference/win32service/functions/win32-remove-service-env-var.xml deleted file mode 100644 index f4aaededb5..0000000000 --- a/reference/win32service/functions/win32-remove-service-env-var.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - win32_remove_service_env_var - Supprime une variable d'environnement personnalisée sur le service - - - - &reftitle.description; - - voidwin32_remove_service_env_var - stringservicename - stringvarname - - - Supprime une variable d'environnement personnalisée varname sur le service servicename. - Cette fonction ne fonctionne que pour l'ordinateur local. Les privilèges administratifs sont requis pour que cela réussisse. - - - - - &reftitle.parameters; - - - - servicename - - - Le nom du service auquel supprimer la variable d'environnement. - - - - - varname - - - Le nom de la variable d'environnement. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Une ValueError est lancée si la valeur du paramètre - service est vide. - - - Une ValueError est lancée si la valeur du paramètre - varname est vide. - - - Une Win32ServiceException est lancée en cas d'erreur. - - - - - &reftitle.seealso; - - - win32_get_service_env_vars - win32_add_service_env_var - - - - - - - diff --git a/reference/win32service/functions/win32-send-custom-control.xml b/reference/win32service/functions/win32-send-custom-control.xml deleted file mode 100644 index 9964858a43..0000000000 --- a/reference/win32service/functions/win32-send-custom-control.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - - win32_send_custom_control - Envoyer un contrôle personnalisé au service - - - - &reftitle.description; - - voidwin32_send_custom_control - stringservicename - intcontrol - stringmachine&null; - - - - Voir Microsoft ControlService function pour plus de détails. - - - - - - &reftitle.parameters; - - - servicename - - - Le nom abrégé du service. - - - - - control - - - La valeur de contrôle personnalisé entre 128 et 255. - - - - - machine - - - Nom de la machine en option. Si omis, l'ordinateur local est utilisé. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Avant la version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Avant la version 1.0.0, si la valeur de contrôle n'est pas compris entre 128 et 255, cette fonction émet - une erreur de niveau E_ERROR. - - - - Une ValueError est levée si la valeur du paramètre - servicename est vide. - - - Une ValueError est levée si la valeur du paramètre - control n'est pas entre 128 et 255. - - - Une Win32ServiceException est levée en cas d'erreur. - - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - PECL win32service 1.0.0 - - Le type de retour est maintenant void, avant il était mixed. - - - - - - - - - - &reftitle.seealso; - - win32_start_service - win32_stop_service - win32_pause_service - win32_continue_service - Win32 Error Codes - - - - - - diff --git a/reference/win32service/functions/win32-set-service-exit-code.xml b/reference/win32service/functions/win32-set-service-exit-code.xml deleted file mode 100644 index 0ae2007e95..0000000000 --- a/reference/win32service/functions/win32-set-service-exit-code.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - win32_set_service_exit_code - Définir ou renvoyer le code de sortie pour le service en cours d'exécution - - - - &reftitle.description; - - intwin32_set_service_exit_code - intexitCode1 - - - Change ou retourne le code de sortie. Le code de sortie est utilisé uniquement - si le mode de sortie n'est pas gracieux. - Si la valeur n'est pas zéro, la configuration de récupération peut être utilisée - après l'échec du service. Voir les - codes d'erreur système Microsoft pour plus de détails - - - - - Cette fonction fonctionne uniquement dans SAPI "cli". Sur d'autres SAPI, cette - fonction est désactivée. - - - - - - &reftitle.parameters; - - - exitCode - - - Le code de retour utilisé à la sortie. - - - - - - - - &reftitle.returnvalues; - - Retourne le code de sortie actuel ou l'ancien. - - - - - &reftitle.errors; - - Avant la version 1.0.0, si cette fonction est utilisée en dehors du SAPI "cli", une - erreur E_ERROR sera émise. - - - À partir de la version 1.0.0, lancera une - Win32ServiceException si le SAPI n'est pas - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - - - - - - - &reftitle.seealso; - - win32_start_service_ctrl_dispatcher - win32_set_service_status - win32_set_service_exit_mode - - - - - - diff --git a/reference/win32service/functions/win32-set-service-exit-mode.xml b/reference/win32service/functions/win32-set-service-exit-mode.xml deleted file mode 100644 index c95f4e53a0..0000000000 --- a/reference/win32service/functions/win32-set-service-exit-mode.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - win32_set_service_exit_mode - Définir ou renvoyer le mode de sortie pour le service en cours d'exécution - - - - &reftitle.description; - - boolwin32_set_service_exit_mode - boolgracefulModetrue - - - Si le paramètre gracefulMode est fourni, le mode de - sortie est modifié. Lorsque le mode de sortie n'est pas gracieux, le code de - sortie utilisé peut être défini avec la fonction - win32_set_service_exit_code. - - - - - Cette fonction fonctionne uniquement dans SAPI "cli". Sur d'autres SAPI, cette - fonction est désactivée. - - - - - - &reftitle.parameters; - - - gracefulMode - - - &true; pour la sortie gracieuse. &false; pour la sortie avec erreur. - - - - - - - - &reftitle.returnvalues; - - Retournez le mode de sortie actuel ou ancien. - - - - - &reftitle.errors; - - Avant la version 1.0.0, si cette fonction est utilisée en dehors du SAPI "cli", une - erreur E_ERROR sera émise. - - - À partir de la version 1.0.0, lancera une - Win32ServiceException si le SAPI n'est pas - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - - - - - - - &reftitle.seealso; - - win32_start_service_ctrl_dispatcher - win32_set_service_status - win32_set_service_exit_code - - - - - - diff --git a/reference/win32service/functions/win32-set-service-pause-resume-state.xml b/reference/win32service/functions/win32-set-service-pause-resume-state.xml deleted file mode 100644 index fd40becb21..0000000000 --- a/reference/win32service/functions/win32-set-service-pause-resume-state.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - win32_set_service_pause_resume_state - Définit ou retourne la capacité de pause/reprise pour le service en cours d'exécution - - - - &reftitle.description; - - boolwin32_set_service_pause_resume_state - boolstatetrue - - - Si le paramètre state est fourni, la capacité de pause/reprise est modifiée. - - - - - Cette fonction ne fonctionne que dans le SAPI "cli" et dans le contexte d'exécution du service Windows. Sur les autres SAPI, - cette fonction est désactivée. - - - - - - &reftitle.parameters; - - - state - - - &true; pour activer la capacité de pause/reprise du service. &false; pour désactiver la capacité de pause/reprise du service. - - - - - - - - &reftitle.returnvalues; - - Renvoie l'état actuel ou ancien de la capacité de pause/reprise. - - - - - &reftitle.errors; - - Avant la version 1.0.0, si le SAPI n'est pas "cli", cette fonction émet une erreur de niveau - E_ERROR. - - - - Depuis la version 1.0.0, émet une - Win32ServiceException si le SAPI n'est pas - "cli" - - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lance une ValueError sur des données invalides dans les paramètres, - précédemment &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException sur erreur, - précédemment un - code d'erreur Win32 - était retourné. - - - - - - - - - - &reftitle.seealso; - - win32_start_service_ctrl_dispatcher - win32_set_service_status - win32_set_service_exit_code - - - - - - diff --git a/reference/win32service/functions/win32-set-service-status.xml b/reference/win32service/functions/win32-set-service-status.xml deleted file mode 100644 index d7a5b57853..0000000000 --- a/reference/win32service/functions/win32-set-service-status.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - - - win32_set_service_status - Met à jour le statut d'un service - - - - &reftitle.description; - - voidwin32_set_service_status - intstatus - intcheckpoint0 - - - Informe le SCM d'un statut courant d'un service qui fonctionne. Cet appel - est seulement valide pour un processus de service qui fonctionne. - - - - - Depuis la version 0.2.0, cette fonction fonctionne uniquement en ligne de - commande. Elle est désactivé dans les autres cas. - - - - - - &reftitle.parameters; - - - - status - - - Le code de statut de service, un de - WIN32_SERVICE_RUNNING, - WIN32_SERVICE_STOPPED, - WIN32_SERVICE_STOP_PENDING, - WIN32_SERVICE_START_PENDING, - WIN32_SERVICE_CONTINUE_PENDING, - WIN32_SERVICE_PAUSE_PENDING, - WIN32_SERVICE_PAUSED. - - - - - checkpoint - - - Cette valeur sera incrémentée par le service périodiquement - pour reporter sa progression lors des opérations de démarrage, d'arrêt, - de pause ou de reprise. Par exemple, le service incrémentera cette - valeur lorsqu'il aura terminé chaque étape de son initialisation - lors de son démarrage. - - - checkpoint n'est valide que lorsque - status est une des constantes suivantes : - WIN32_SERVICE_STOP_PENDING, - WIN32_SERVICE_START_PENDING, - WIN32_SERVICE_CONTINUE_PENDING ou - WIN32_SERVICE_PAUSE_PENDING. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Avant la version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Avant la version 1.0.0, si cette fonction est utilisée en dehors du SAPI "cli", une - erreur E_ERROR sera émise. - - - À partir de la version 1.0.0, lancera une - Win32ServiceException si le SAPI n'est pas - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - PECL win32service 1.0.0 - - Le type de retour est maintenant void, avant il était mixed. - - - - PECL win32service 0.2.0 - - Cette fonction fonctionne uniquement en ligne de - commande. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service_ctrl_dispatcher - win32_get_last_control_message - win32_set_service_exit_mode - win32_set_service_exit_code - Les constantes de statut des services Win32Service - - - - - - - diff --git a/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml b/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml deleted file mode 100644 index 40c7e2b8a6..0000000000 --- a/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - - win32_start_service_ctrl_dispatcher - Enregistre un script avec SCM, alors il peut être interprété en tant que service avec le nom donné - - - - &reftitle.description; - - voidwin32_start_service_ctrl_dispatcher - stringname - boolgracefulModetrue - - - Lorsqu'exécuté via le Gestionnaire de Contrôle de Service, un processus de - service est requis pour "archiver" avec lui pour établir un service de - surveillance et de communication ergonomique. Cette fonction effectue un - archivage en démarrant un thread pour gérer les communications de bas - niveau avec le gestionnaire de contrôle de service. - - - Une fois démarré, le processus du service doit faire 2 choses. La première - est d'indiquer au Service Control Manager que le service est en cours - d'exécution. Ceci est réalisé en appelant la fonction - win32_set_service_status avec la constante - WIN32_SERVICE_RUNNING. Si l'on a besoin de - lancer des processus longs avant que le service ne soit lancé, alors - il est possible d'utiliser la constante WIN32_SERVICE_START_PENDING. - La seconde est de continuer à vérifier en utilisant le Service Control Manager - sachant qu'il peut déterminer si le service se termine ou non. Ceci consiste - à appeler, périodiquement, la fonction win32_get_last_control_message - et à traiter le code retourné. - - - - - Depuis la version 0.2.0, cette fonction fonctionne uniquement en ligne de - commande. Elle est désactivé dans les autres cas. - - - - - - &reftitle.parameters; - - - - name - - - Le court nom du service, comme enregistré par - win32_create_service. - - - - - gracefulMode - - - &true; pour la sortie gracieuse. &false; pour la sortie avec erreur. Voir - win32_set_service_exit_mode pour plus de détails. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Avant la version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Avant la version 1.0.0, si cette fonction est utilisée en dehors du SAPI "cli", une - erreur E_ERROR sera émise. - - - À partir de la version 1.0.0, lancera une - Win32ServiceException si le SAPI n'est pas - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - PECL win32service 1.0.0 - - Le type de retour est maintenant void, avant il était mixed. - - - - PECL win32service 0.4.0 - - Le paramètre gracefulMode a été ajouté. - - - - PECL win32service 0.2.0 - - Cette fonction fonctionne uniquement en ligne de - commande. - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>win32_start_service_ctrl_dispatcher</function> - - Vérifie si le service fonctionne sous SCM. - - - -]]> - - - - - - - &reftitle.seealso; - - - win32_set_service_status - win32_get_last_control_message - win32_set_service_exit_mode - win32_set_service_exit_code - Les codes erreur Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-start-service.xml b/reference/win32service/functions/win32-start-service.xml deleted file mode 100644 index b079eba6c6..0000000000 --- a/reference/win32service/functions/win32-start-service.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - win32_start_service - Démarre un service - - - - &reftitle.description; - - voidwin32_start_service - stringservicename - stringmachine&null; - - - Essaie de démarrer le service nommé. Requiert des privilèges d'administrateur ou - un compte avec les droits appropriés définis dans l'ACL du service. - - - - - &reftitle.parameters; - - - - servicename - - - Le nom court du service. - - - - - machine - - - Le nom optionnel de la machine. - Si oublié, cela utilisera la machine locale. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Avant la version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Une ValueError est levée si la valeur du paramètre - servicename est vide. - - - Une Win32ServiceException est levée en cas d'erreur. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - PECL win32service 1.0.0 - - Le type de retour est maintenant void, avant il était mixed. - - - - PECL win32service 0.3.0 - - Cette fonction ne requiert plus de compte d'administrateur si l'ACL - est défini pour un autre compte. - - - - - - - - - - &reftitle.seealso; - - - win32_stop_service - win32_pause_service - win32_continue_service - win32_send_custom_control - Codes erreur Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-stop-service.xml b/reference/win32service/functions/win32-stop-service.xml deleted file mode 100644 index b248a64ad9..0000000000 --- a/reference/win32service/functions/win32-stop-service.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - win32_stop_service - Arrête un service - - - - &reftitle.description; - - voidwin32_stop_service - stringservicename - stringmachine&null; - - - Arrête un service nommé. Requiert des privilèges d'administrateur ou - un compte avec les droits appropriés définis dans l'ACL du service. - - - - - &reftitle.parameters; - - - - servicename - - - Le nom court du service. - - - - - machine - - - Le nom optionnel de la machine. - Si oublié, cela utilisera la machine locale. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Avant la version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Une ValueError est levée si la valeur du paramètre - servicename est vide. - - - Une Win32ServiceException est levée en cas d'erreur. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - PECL win32service 1.0.0 - - Lance une ValueError si un paramètre est invalide, - avant &false; était retourné. - - - - PECL win32service 1.0.0 - - Lance une Win32ServiceException en cas d'erreur, - avant un - Code d'erreur Win32 - était retourné. - - - - PECL win32service 1.0.0 - - Le type de retour est maintenant void, avant il était mixed. - - - - PECL win32service 0.3.0 - - Cette fonction ne requiert plus de compte d'administrateur si l'ACL - est défini pour un autre compte. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service - win32_pause_service - win32_continue_service - win32_send_custom_control - Codes erreur Win32 - - - - - - - diff --git a/reference/win32service/reference.xml b/reference/win32service/reference.xml deleted file mode 100644 index 69ca3695b3..0000000000 --- a/reference/win32service/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; win32service - - &reference.win32service.entities.functions; - - - - diff --git a/reference/win32service/rightinfo/construct.xml b/reference/win32service/rightinfo/construct.xml deleted file mode 100644 index 6e3d31bf4b..0000000000 --- a/reference/win32service/rightinfo/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Win32Service\RightInfo::__construct - Créer un nouveau RightInfo (non utilisé) - - - - &reftitle.description; - - final private Win32Service\RightInfo::__construct - - - - Les objets Win32Service\RightInfo sont retournés en tant que - résultat de win32_read_right_access_service. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - &reftitle.seealso; - - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - Win32Service\RightInfo::getDomain - - - - - - diff --git a/reference/win32service/rightinfo/get-domain.xml b/reference/win32service/rightinfo/get-domain.xml deleted file mode 100644 index a34ff26947..0000000000 --- a/reference/win32service/rightinfo/get-domain.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Win32Service\RightInfo::getDomain - Renvoie le domaine de l'utilisateur - - - - &reftitle.description; - - final public stringnull Win32Service\RightInfo::getDomain - - - - Renvoie le domaine de l'utilisateur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom de domaine ou &null; si aucun domaine n'est trouvé (compte local ou échec de résolution du GUID de l'utilisateur). - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - - - - - - diff --git a/reference/win32service/rightinfo/get-full-username.xml b/reference/win32service/rightinfo/get-full-username.xml deleted file mode 100644 index 7f690537b8..0000000000 --- a/reference/win32service/rightinfo/get-full-username.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Win32Service\RightInfo::getFullUsername - Renvoie le domaine et le nom d'utilisateur - - - - &reftitle.description; - - final public stringnull Win32Service\RightInfo::getFullUsername - - - - Renvoie le domaine et le nom d'utilisateur séparés par un anti-slash \. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le domaine et le nom d'utilisateur. Si le domaine est &null;, renvoie uniquement le nom d'utilisateur ; renvoie &null; si aucun nom d'utilisateur n'est trouvé. - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getUsername - - - - - - diff --git a/reference/win32service/rightinfo/get-rights.xml b/reference/win32service/rightinfo/get-rights.xml deleted file mode 100644 index 226c896d25..0000000000 --- a/reference/win32service/rightinfo/get-rights.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Win32Service\RightInfo::getRights - Renvoie la liste des droits - - - - &reftitle.description; - - final public array Win32Service\RightInfo::getRights - - - - Renvoie la liste des droits de l'utilisateur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie la liste des droits de l'utilisateur. - - - Le tableau indexé est le masque de bits du droit représenté par les constantes de permissions. - - - La valeur est une chaîne avec le nom de la constante Windows (sans le préfixe WIN32_). - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - Win32Service\RightInfo::getDomain - Constantes de permissions Win32 - - - - - - diff --git a/reference/win32service/rightinfo/get-username.xml b/reference/win32service/rightinfo/get-username.xml deleted file mode 100644 index ee9bbfc93b..0000000000 --- a/reference/win32service/rightinfo/get-username.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Win32Service\RightInfo::getUsername - Renvoie le nom d'utilisateur - - - - &reftitle.description; - - final public stringnull Win32Service\RightInfo::getUsername - - - - Renvoie le nom d'utilisateur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le nom d'utilisateur ou le GUID si la résolution échoue. - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getDomain - - - - - - diff --git a/reference/win32service/rightinfo/is-deny-access.xml b/reference/win32service/rightinfo/is-deny-access.xml deleted file mode 100644 index 2271241ef6..0000000000 --- a/reference/win32service/rightinfo/is-deny-access.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Win32Service\RightInfo::isDenyAccess - Renvoie true si le RightInfo concerne le refus d'accès à la ressource - - - - &reftitle.description; - - final public bool Win32Service\RightInfo::isDenyAccess - - - - Renvoie &true; si le RightInfo concerne le refus d'accès à la ressource, sinon, c'est &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si le RightInfo concerne le refus d'accès à la ressource, sinon, c'est &false;. - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - Win32Service\RightInfo::getDomain - - - - - - diff --git a/reference/win32service/rightinfo/is-grant-access.xml b/reference/win32service/rightinfo/is-grant-access.xml deleted file mode 100644 index a674f52032..0000000000 --- a/reference/win32service/rightinfo/is-grant-access.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Win32Service\RightInfo::isGrantAccess - Renvoie true si le RightInfo concerne l'accès à la ressource - - - - &reftitle.description; - - final public bool Win32Service\RightInfo::isGrantAccess - - - - Renvoie &true; si le RightInfo concerne l'accès à la ressource, sinon, c'est &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie &true; si le RightInfo concerne l'accès à la ressource, sinon, c'est &false;. - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - Win32Service\RightInfo::getDomain - - - - - - diff --git a/reference/win32service/setup.xml b/reference/win32service/setup.xml deleted file mode 100644 index 13d1539fbd..0000000000 --- a/reference/win32service/setup.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Les versions de Windows prises en charge sont les mêmes que le package - redistribuable Visual C++ utilisé pour construire PHP. - -
    - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;win32service - -
    - - -
    - Considération de sécurité - - Cette extension nécessite des privilèges d'administrateur pour certaines actions telles que - create, - delete, - start, - stop, - pause et - continue. - Cette exigence peut provoquer une élévation des privilèges si le contrôle de - service est disponible à partir de l'interface Web ou du contrôle à distance. - - - L'ACL du service peut être définie après son ajout dans le SCM afin de déléguer - les tâches d'administration actuelles à un compte non administrateur ou à un compte de service. - - - À partir de Win32Service 1.1.0, les droits de service peuvent être gérés avec PHP. Les ACL actuelles peuvent être lues avec - win32_read_all_rights_access_service, un droit d'accès ou de refus peut être ajouté avec - win32_add_right_access_service, ou un droit d'accès peut être supprimé avec - win32_remove_right_access_service. - - - Il est recommandé de mettre à jour vers Win32Service 1.1.0. - Pour des instructions supplémentaires sur la gestion des droits sans l'extension (ou avec une version antérieure à 1.1.0), consulter la - Base de connaissances Microsoft. - -
    - -     - - - diff --git a/reference/win32service/win32serviceexception.xml b/reference/win32service/win32serviceexception.xml deleted file mode 100644 index 07aaecf464..0000000000 --- a/reference/win32service/win32serviceexception.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - La classe Win32ServiceException - Win32ServiceException - - - - -
    - &reftitle.intro; - - L’exception remplace l’ancien mécanisme où la valeur d’erreur devait être - comparée aux constantes pour détecter quelle erreur a été émise. Le code de - l’exception est égal à la valeur de la constante d’erreur et le message de - l’exception est basé sur le nom de la constante correspondante. - -
    - - -
    - &reftitle.classsynopsis; - - - - Win32ServiceException - - - - - Win32ServiceException - - - - extends - Exception - - - - - &InheritedProperties; - - - - - - - - &InheritedMethods; - - - - -
    - -     - - - -     - - diff --git a/reference/win32service/win32servicerightinfo.xml b/reference/win32service/win32servicerightinfo.xml deleted file mode 100644 index 943a02b034..0000000000 --- a/reference/win32service/win32servicerightinfo.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - La classe Win32Service\RightInfo - Win32Service\RightInfo - - - - -
    - &reftitle.intro; - - La classe interne Win32Service\RightInfo encapsule le résultat de win32_read_right_access_service. - -
    - - -
    - &reftitle.classsynopsis; - - - - Win32Service\RightInfo - - - - final - - Win32Service\RightInfo - - - - - &Methods; - - - - -
    - -     - - &reference.win32service.entities.rightinfo; - -     - - diff --git a/reference/wincache/book.xml b/reference/wincache/book.xml deleted file mode 100644 index 115337449e..0000000000 --- a/reference/wincache/book.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - Windows Cache pour PHP - WinCache - - - &reftitle.intro; - - L'extension Windows Cache pour PHP est un accélérateur PHP qui est utilisé pour augmenter la - vitesse des applications PHP sous Windows et Windows Server. Une fois l'extension Windows Cache - activée et chargée par le moteur PHP, les applications PHP peuvent tirer parti des - fonctionnalités sans aucune modification de code. - - - L'extension Windows Cache comprend 5 types de caches. Ce qui suit décrit le but de chaque type - de cache et les avantages qu'il procure. - - - - - Cache d'Opcode PHP - PHP est un moteur de traitement de script, qui lit - un flux d'entrée de données qui contient du texte et / ou des instructions PHP et produit un - autre flux de données, le plus souvent au format HTML. Cela signifie que sur un serveur Web - le moteur PHP lit, analyse, compile et exécute un script PHP à chaque fois qu'il est demandé - par un client Web. Les opérations de lecture, d'analyse et de compilation ajoutent une charge - supplémentaire sur le processeur (CPU) et sur le système de fichiers, ce qui affecte la - performance globale d'une application web PHP. Le cache de bytecode PHP (Opcode) est utilisé - pour stocker le bytecode du script compilé dans la mémoire partagée pour qu'il puisse être - ré-utilisé par le moteur PHP lors des exécutions suivantes du même script. - - - Support pour le cache d'Opcode a été retiré dans Wincache 2.0.0, - tous les utilisateurs qui souhaitent avoir un opcache devraient utiliser l'extension - OPcache qui est incluse avec PHP. - - - - - Cache de fichiers - Même avec le cache d'opcode PHP activé, le moteur PHP - doit accéder aux fichiers de script sur un système de fichiers. Lorsque les scripts PHP sont - stockés sur le système de fichiers d'un ordinateur distant, les opérations sur ces fichiers - introduisent une surcharge importante des performances. L'extension de Cache Windows pour PHP - inclut un cache de fichier qui est utilisé pour stocker le contenu des fichiers de scripts PHP - dans la mémoire partagée, ce qui réduit le nombre d'opérations effectuées par le moteur PHP - sur le système de fichiers. - - - - - Cache de résolution des chemins de fichier - Les scripts PHP incluent ou - fonctionnent très souvent avec des fichiers en utilisant des chemins relatifs. Chaque chemin - de fichier doit être normalisé en un chemin de fichier absolu par le moteur PHP. Quand une - application PHP utilise de nombreux fichiers PHP et y accède par des chemins relatifs, - l'opération de résolution des chemins peut impacter négativement les performances de l'application. - L'extension de Cache Windows pour PHP fournit un cache de résolution des chemins de fichier, qui - est utilisé pour stocker les correspondances entre les chemins de fichier relatifs et absolus, - réduisant ainsi le nombre de résolutions que le moteur PHP devra effectuer. - - - - - Cache utilisateur (disponible depuis la version 1.1.0) - Les scripts PHP - peuvent tirer profit du cache de mémoire partagée en utilisant l'API de cache utilisateur. Les objets PHP - et les variables peuvent être stockées dans le cache utilisateur et réutilisés lors des requêtes suivantes. - Ce cache peut être utilisé pour améliorer les performances des scripts PHP et pour partager les données entre - plusieurs processus PHP. - - - - - Gestionnaire de session (disponible depuis la version 1.1.0) - Le gestionnaire de session - WinCache peut être utilisé pour stocker les données de session PHP dans le cache de la mémoire partagée. Cela - évite des opérations sur le système de fichiers pour la lecture et l'écriture des données de session, ce qui - améliore les performances lorsqu'un montant important de données est stocké dans la session PHP. - - - - - - &reference.wincache.setup; - &reference.wincache.reference; - &reference.wincache.win32build; - - - - - diff --git a/reference/wincache/functions/wincache-fcache-fileinfo.xml b/reference/wincache/functions/wincache-fcache-fileinfo.xml deleted file mode 100644 index b815ce9f60..0000000000 --- a/reference/wincache/functions/wincache-fcache-fileinfo.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - - - wincache_fcache_fileinfo - - Extrait des informations sur les fichiers mis en cache dans le cache de fichiers - - - - &reftitle.description; - - arrayfalsewincache_fcache_fileinfo - boolsummaryonly&false; - - - Extrait des informations sur le contenu du cache de fichiers et son utilisation. - - - - &reftitle.parameters; - - - - summaryonly - - - Si le tableau retourné doit contenir des informations sur chaque entrée du cache - en plus du résumé sur les fichiers du cache. - - - - - - - - &reftitle.returnvalues; - - Tableau de méta-données sur le cache de fichier &return.falseforfailure; - - - Le tableau retourné par cette fonction contient les éléments suivants : - - - - total_cache_uptime - Temps d'activité total en secondes du cache de fichiers - - - - - total_file_count - Nombre total de fichiers actuellement dans le cache de fichiers - - - - - total_hit_count - Nombre de fois où les fichiers ont été servis à partir du cache du fichiers - - - - - total_miss_count - Nombre de fois que les fichiers n'ont pas été trouvés dans le cache de fichiers - - - - - file_entries - Tableau contenant les informations sur tous les fichiers mis en cache: - - - - file_name - Nom et chemin absolu du fichier en cache - - - - - add_time - Temps en secondes depuis que le fichier a été ajouté au cache de fichiers - - - - - use_time - Temps en secondes depuis que le fichier a été consulté dans le cache de fichier - - - - - last_check - Temps en secondes depuis la dernière vérification de modifications - - - - - hit_count - Nombre de fois que le fichier a été servi à partir du cache - - - - - file_size - Taille en bytes du fichier caché - - - - - - - - - - &reftitle.examples; - - - Un exemple de <function>wincache_fcache_fileinfo</function> - - - - - -]]> - - &example.outputs; - - 3234 - [total_file_count] => 5 - [total_hit_count] => 0 - [total_miss_count] => 1 - [file_entries] => Array - ( - [1] => Array - ( - [file_name] => c:\inetpub\wwwroot\checkcache.php - [add_time] => 1 - [use_time] => 0 - [last_check] => 1 - [hit_count] => 1 - [file_size] => 2435 - ) - [2] => Array (...iterates for each cached file) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-fcache-meminfo.xml b/reference/wincache/functions/wincache-fcache-meminfo.xml deleted file mode 100644 index c6bdc65a96..0000000000 --- a/reference/wincache/functions/wincache-fcache-meminfo.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - - wincache_fcache_meminfo - - Extrait des informations sur l'utilisation de la mémoire du cache de fichiers. - - - - &reftitle.description; - - arrayfalsewincache_fcache_meminfo - - - - Extrait des informations sur l'utilisation de la mémoire du cache de fichiers. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Tableau de méta-données sur l'utilisation de la mémoire du cache de fichiers &return.falseforfailure; - - - Le tableau retourné par cette fonction contient les éléments suivants: - - - - memory_total - Quantité de mémoire en octets allouée pour le cache de fichiers - - - - - memory_free - Quantité de mémoire libre en octets disponible pour le cache de fichiers - - - - - num_used_blks - Nombre de blocs mémoire utilisés par le cache de fichiers - - - - - num_free_blks - Nombre de blocs mémoire libres disponibles pour le cache de fichiers - - - - - memory_overhead - Quantité de mémoire en bytes utilisée pour la structure interne du cache de fichiers - - - - - - - - &reftitle.examples; - - - Un exemple de <function>wincache_fcache_meminfo</function> - - - - - -]]> - - &example.outputs; - - 134217728 - [memory_free] => 131339120 - [num_used_blks] => 361 - [num_free_blks] => 3 - [memory_overhead] => 5856 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-lock.xml b/reference/wincache/functions/wincache-lock.xml deleted file mode 100644 index ddc9483048..0000000000 --- a/reference/wincache/functions/wincache-lock.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - - wincache_lock - Acquière un verrou exclusif sur une clé donnée - - - &reftitle.description; - - boolwincache_lock - stringkey - boolisglobal&false; - - - Obtient un verrou exclusif sur une clé donnée. L'exécution du script courant sera bloqué - tant que le verrou ne pourra pas être obtenu. Une fois le verrou obtenu, les autres scripts - tentant de requérir le verrou en utilisant la même clé seront bloqués, tant que le script courant - n'aura pas libéré le verrou en utilisant la fonction wincache_unlock. - - - - L'utilisation de la fonction wincache_lock et de la fonction - wincache_unlock peut conduire à des verrous morts lors de l'exécution - de scripts PHP sur des environnements multiprocessus, comme FastCGI. N'utiliser pas ces fonctions - à moins d'être absolument certain d'en avoir besoin. Pour la majorité des opérations sur - le cache utilisateur, il n'est pas nécessaire de les utiliser. - - - - - &reftitle.parameters; - - - - key - - - Nom de la clé du cache dont nous souhaitons obtenir un verrou. - - - - - isglobal - - - Contrôle si le contexte du verrou est local ou au niveau système. Les verrous locaux - ont un contexte au niveau applicatif dans le cas de l'utilisation sous IIS Fast CGI ou - au niveau de tous les processus PHP qui ont le même identifiant parent de processus. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Exemple avec <function>wincache_lock</function> - - -]]> - - - - - - - &reftitle.seealso; - - - wincache_unlock - wincache_ucache_set - wincache_ucache_get - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ocache-fileinfo.xml b/reference/wincache/functions/wincache-ocache-fileinfo.xml deleted file mode 100644 index 73ffe091a0..0000000000 --- a/reference/wincache/functions/wincache-ocache-fileinfo.xml +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - - - wincache_ocache_fileinfo - - Extrait des informations sur les fichiers mis en cache dans le cache opcode - - - - &reftitle.description; - - arrayfalsewincache_ocache_fileinfo - boolsummaryonly&false; - - - Extrait des informations sur le contenu du cache opcode et son utilisation. - - &warn.removed.function-7-0-0; - - - &reftitle.parameters; - - - - summaryonly - - - Contrôle si le tableau retourné doit contenir des informations - sur les entrées individuelles du cache en plus du résumé sur - le cache opcode. - - - - - - - - &reftitle.returnvalues; - - Tableau de méta-données sur le cache opcode &return.falseforfailure; - - - Le tableau retourné par cette fonction contient les éléments suivants: - - - - total_cache_uptime - Temps d'activité total en secondes du cache opcode - - - - - total_file_count - Nombre total de fichiers actuellement dans le cache opcode - - - - - total_hit_count - Nombre total de fois où l'opcode compilé a été servi par le cache - - - - - total_miss_count - Nombre de fois où l'opcode compilé n'a pas été trouvé dans le cache - - - - - is_local_cache - true si les méta-données du cache sont pour une instance de cache local, - false si les méta-données sont pour le cache global. - - - - - file_entries - Tableau contenant les informations sur tous les fichiers mis en cache: - - - - file_name - Nom de fichier absolu du fichier en cache - - - - - add_time - Temps en secondes depuis l'ajout du fichier dans le cache opcode - - - - - use_time - Temps en secondes depuis la consultation du fichier dans le cache opcode - - - - - last_check - Temps en secondes depuis où le fichier a été vérifié pour les modifications - - - - - hit_count - Nombre de fois où le fichier a été servi par le cache - - - - - function_count - Nombre de fonctions dans le cache - - - - - class_count - Nombre de classes dans le cache - - - - - - - - - - &reftitle.examples; - - - Un exemple de <function>wincache_ocache_fileinfo</function> - - - - - -]]> - - &example.outputs; - - 17357 - [total_file_count] => 121 - [total_hit_count] => 36562 - [total_miss_count] => 201 - [file_entries] => Array - ( - [1] => Array - ( - [file_name] => c:\inetpub\wwwroot\checkcache.php - [add_time] => 17356 - [use_time] => 7 - [last_check] => 10 - [hit_count] => 454 - [function_count] => 0 - [class_count] => 1 - ) - [2] => Array (...iterates for each cached file) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-ocache-meminfo.xml b/reference/wincache/functions/wincache-ocache-meminfo.xml deleted file mode 100644 index 2ef1b7fa34..0000000000 --- a/reference/wincache/functions/wincache-ocache-meminfo.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - - wincache_ocache_meminfo - - Extrait des informations sur l'utilisation du cache opcode - - - - &reftitle.description; - - arrayfalsewincache_ocache_meminfo - - - - Extrait des informations sur l'utilisation de la mémoire par le cache opcode. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Tableau de méta-données sur l'utilisation de la mémoire cache opcode &return.falseforfailure; - - - Le tableau retourné par cette fonction contient les éléments suivants : - - - - memory_total - Quantité de mémoire en octets, allouée pour le cache opcode - - - - - memory_free - Quantité de mémoire libre en octets, disponible pour le cache opcode - - - - - num_used_blks - Nombre de blocs mémoire utilisés par le cache opcode - - - - - num_free_blks - Nombre de blocs mémoire libres disponibles pour le cache opcode - - - - - memory_overhead - Quantité de mémoire en octets utilisée pour la structure interne du cache opcode - - - - - &warn.removed.function-7-0-0; - - - - &reftitle.examples; - - - Un exemple de <function>wincache_ocache_meminfo</function> - - - - - -]]> - - &example.outputs; - - 134217728 - [memory_free] => 112106972 - [num_used_blks] => 15469 - [num_free_blks] => 4 - [memory_overhead] => 247600 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-refresh-if-changed.xml b/reference/wincache/functions/wincache-refresh-if-changed.xml deleted file mode 100644 index fd6e320f5e..0000000000 --- a/reference/wincache/functions/wincache-refresh-if-changed.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - - wincache_refresh_if_changed - - Actualise les entrées du cache pour les fichiers mis en cache - - - - &reftitle.description; - - boolwincache_refresh_if_changed - arrayfilesNULL - - - Actualise les entrées du cache pour les fichiers dont les noms ont été passés dans les - arguments d'entrée. Si aucun argument n'est précisé, alors, actualise toutes les entrées du cache. - - - - &reftitle.parameters; - - - - files - - - Tableau de noms de fichiers pour les fichiers qui ont besoin d'être actualisés. - Un chemin de fichier absolu ou relatif peut être utilisé. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - WinCache effectue des contrôles réguliers sur les fichiers mis en cache pour - veiller à ce que, si un fichier a changé, l'entrée correspondante dans la mémoire cache - soit mise à jour. Par défaut, cette vérification est effectuée toutes les 30 secondes. - Si par exemple un script PHP met à jour un autre script PHP où les configurations de - l'application sont stockées, alors il peut arriver qu'après les changements de configuration - soient sauvés, l'application utilise toujours les anciens paramètres pour quelque temps - jusqu'à ce que le cache soit actualisé. Dans ce cas, il est préférable d'actualiser - le cache juste après que le fichier a été modifié. L'exemple qui suit montre comment - cela peut être effectué. - - Un exemple de <function>wincache_refresh_if_changed</function> - -'); -fclose($handle); -wincache_refresh_if_changed(array($filename)); -?> -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_ucache_meminfo - wincache_ucache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-rplist-fileinfo.xml b/reference/wincache/functions/wincache-rplist-fileinfo.xml deleted file mode 100644 index f5b3b6af88..0000000000 --- a/reference/wincache/functions/wincache-rplist-fileinfo.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - - - wincache_rplist_fileinfo - Récupère des informations du cache sur un chemin de fichier résolu - - - &reftitle.description; - - arrayfalsewincache_rplist_fileinfo - boolsummaryonly&false; - - - Récupère des informations sur une cartographie en cache entre des chemins - relatifs de fichiers et leurs correspondances en chemins absolus. - - - - - &reftitle.parameters; - - - - summaryonly - - - - - - - - - - - - &reftitle.returnvalues; - - Un tableau de données méta contenant le contenu du cache d'un chemin - de fichier résolu &return.falseforfailure; - - - Le tableau retourné par cette fonction contient les éléments suivants : - - - - total_file_count - nombre total de chemins - de fichiers stockés dans le cache - - - - - rplist_entries - un tableau contenant les informations - sur les chemins de fichier présents en cache : - - - - resolve_path - chemin vers le fichier - - - - - subkey_data - chemin absolu correspondant - - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>wincache_rplist_fileinfo</function> - - - - - -]]> - - &example.outputs; - - 5 - [rplist_entries] => Array - ( - [1] => Array - ( - [resolve_path] => checkcache.php - [subkey_data] => c:\inetpub\wwwroot|c:\inetpub\wwwroot\checkcache.php - ) - - [2] => Array (...iterates for each cached file) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_meminfo - wincache_fcache_fileinfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-rplist-meminfo.xml b/reference/wincache/functions/wincache-rplist-meminfo.xml deleted file mode 100644 index c7ebc1d423..0000000000 --- a/reference/wincache/functions/wincache-rplist-meminfo.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - - wincache_rplist_meminfo - Récupère des informations sur l'utilisation de la mémoire par le cache de chemin de fichier résolu - - - &reftitle.description; - - arrayfalsewincache_rplist_meminfo - - - - Récupère des informations sur l'utilisation de la mémoire par le cache de chemin de fichier résolu. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau de données méta qui décrit l'utilisation de la mémoire - par le cache de chemin de fichier résolu. &return.falseforfailure; - - - Le tableau retourné par cette fonction contient les éléments suivants : - - - - memory_total - nombre total de mémoire, en octets, allouée - au cache de chemins de fichiers résolus - - - - - memory_free - mémoire libre, en octets, disponible pour le - cache de chemins de fichiers résolus - - - - - num_used_blks - blocs mémoires utilisés par le cache de chemins - de fichiers résolus - - - - - num_free_blks - nombre de blocs mémoires de libre pour le cache - des chemins de fichiers résolus - - - - - memory_overhead - mémoire, en octets, utilisée pour la - structure interne du cache des chemins de fichiers résolus - - - - - - - - &reftitle.examples; - - - Exemple avec <function>wincache_rplist_meminfo</function> - - - - - -]]> - - &example.outputs; - - 9437184 - [memory_free] => 9416744 - [num_used_blks] => 23 - [num_free_blks] => 1 - [memory_overhead] => 416 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-scache-info.xml b/reference/wincache/functions/wincache-scache-info.xml deleted file mode 100644 index 2dd51bd3a5..0000000000 --- a/reference/wincache/functions/wincache-scache-info.xml +++ /dev/null @@ -1,205 +0,0 @@ - - - - - - - - wincache_scache_info - Récupère des informations sur des fichiers mis en cache - - - &reftitle.description; - - arrayfalsewincache_scache_info - boolsummaryonly&false; - - - Récupère des informations sur le contenu du cache et son utilisation. - - - - &reftitle.parameters; - - - - summaryonly - - - Contrôle si le tableau retourné doit contenir des informations sur des entrées - individuelles du cache en plus du résumé du cache. - - - - - - - - &reftitle.returnvalues; - - Un tableau de données méta sur le cache pour cette session - &return.falseforfailure; - - - Le tableau retourné par cette fonction contient les éléments suivants : - - - - total_cache_uptime - durée total (en secondes) d'activation du cache - - - - - total_item_count - nombre total d'éléments contenus actuellement dans le cache - - - - - is_local_cache - &true; si les méta-données du cache sont pour une instance - de cache locale, &false; si elles sont pour un cache global - - - - - total_hit_count - nombre total de fois que les données ont été servies - depuis le cache - - - - - total_miss_count - nombre total de fois que les données n'ont pas été trouvées dans - le cache - - - - - scache_entries - un tableau contenant les informations sur les éléments mis - en cache : - - - - key_name - nom de la clé utilisé pour stocker les données - - - - - value_type - type de la valeur stockée - - - - - use_time - durée, en secondes, depuis le dernier accès du fichier depuis le cache opcode - - - - - last_check - durée, en secondes, depuis la dernière fois où le fichier a été vérifié - afin de détection des modifications - - - - - ttl_seconds - durée restante avant suppression des données du cache, 0 signifiant qu'elles - ne seront jamais supprimées - - - - - age_seconds - l'âge des données dans le cache (i.e. depuis leurs insertions) - - - - - hitcount - nombre de fois que les données ont été servies depuis le cache - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>wincache_scache_info</function> - - - - - -]]> - - &example.outputs; - - 17357 - [total_file_count] => 121 - [total_hit_count] => 36562 - [total_miss_count] => 201 - [scache_entries] => Array - ( - [1] => Array - ( - [file_name] => c:\inetpub\wwwroot\checkcache.php - [add_time] => 17356 - [use_time] => 7 - [last_check] => 10 - [hit_count] => 454 - [function_count] => 0 - [class_count] => 1 - ) - [2] => Array (...iterates for each cached file) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-scache-meminfo.xml b/reference/wincache/functions/wincache-scache-meminfo.xml deleted file mode 100644 index 9bce0c29b7..0000000000 --- a/reference/wincache/functions/wincache-scache-meminfo.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - - wincache_scache_meminfo - Récupère des informations sur l'utilisation de la mémoire du cache - - - &reftitle.description; - - arrayfalsewincache_scache_meminfo - - - - Récupère des informations sur l'utilisation mémoire du cache. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau de données méta sur l'utilisation de la mémoire du cache - &return.falseforfailure; - - - Le tableau retourné par cette fonction contient les éléments suivants : - - - - memory_total - mémoire, en octets, allouée au cache - - - - - memory_free - mémoire disponible, en octets, pour le cache - - - - - num_used_blks - nombre de blocs mémoires utilisés par le cache - - - - - num_free_blks - nombre de blocs mémoires disponibles pour le cache - - - - - memory_overhead - mémoire, en octets, utilisé par les structures internes - du cache - - - - - - - - &reftitle.examples; - - - Exemple avec <function>wincache_scache_meminfo</function> - - - - - -]]> - - &example.outputs; - - 5242880 - [memory_free] => 5215056 - [num_used_blks] => 6 - [num_free_blks] => 3 - [memory_overhead] => 176 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_info - wincache_scache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-add.xml b/reference/wincache/functions/wincache-ucache-add.xml deleted file mode 100644 index d54079da0c..0000000000 --- a/reference/wincache/functions/wincache-ucache-add.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - - - - - - wincache_ucache_add - - Ajoute une nouvelle variable au cache utilisateur - - - - &reftitle.description; - - boolwincache_ucache_add - stringkey - mixedvalue - intttl0 - - - boolwincache_ucache_add - arrayvalues - mixedunusedNULL - intttl0 - - - Ajoute une variable au cache utilisateur, uniquement si elle n'existe pas déjà - dans le cache. La variable restera dans le cache tant que le délai d'expiration - n'est pas atteint ou qu'elle n'est effacée par la fonction - wincache_ucache_delete ou la fonction wincache_ucache_clear. - - - - &reftitle.parameters; - - - - key - - - Stocke la variable en utilisant le nom key. Si une variable - correspondant à la même clé est déjà présente dans le cache, la fonction - échouera et retournera &false;. Le paramètre key est sensible à la - casse. Pour écraser cette valeur, si key est présent, - utiliser plutôt la fonction wincache_ucache_set. - key peut également être un tableau de paires nom => valeur où - les noms seront utilisés comme clés. Ce format peut être utilisé pour ajouter - de multiples valeurs dans le cache en une seule opération. - - - - - value - - - La valeur de la variable à stocker. Le paramètre Value supporte - tous les types de données, sauf les ressources, comme des pointeurs de fichiers. - Ce paramètre sera ignoré si le premier argument est un tableau. De façon général, il convient - de passer la valeur &null; au paramètre value lors de l'utilisation - d'un tableau pour le paramètre key. Si le paramètre value - est un objet, ou un tableau contenant des objets, alors les objets seront sérialisés. Se reporter - à la fonction __sleep() pour plus de détails - sur la sérialisation d'objets. - - - - - values - - - Tableau associatif de clés et de valeurs. - - - - - ttl - - - Durée de vie de la variable dans le cache, en secondes. Après la durée spécifiée par le paramètre - ttl, la variable stockée sera supprimée du cache. Ce paramètre prend, comme - valeur par défaut, zéro (0), ce qui signifie que la variable restera dans le cache - tant qu'elle n'est pas explicitement effacée en utilisant la fonction wincache_ucache_delete - ou la fonction wincache_ucache_clear. - - - - - - - - &reftitle.returnvalues; - - Si le paramètre key est une &string;, la fonction retourne - &true; en cas de succès, &false; si une erreur survient. - - - Si le paramètre key est un tableau, la fonction retourne : - - - - Si toutes les paires nom => valeur du tableau peuvent être définies, la fonction retournera - un tableau vide ; - - - - - Si toutes les paires nom => valeur du tableau ne peuvent être définies, la fonction retournera - &false; ; - - - - - Si certaines peuvent être définies, et d'autres non, la fonction retournera un tableau de paires - nom => valeur n'ayant pû être définies dans le cache utilisateur. - - - - - - - &reftitle.examples; - - - Exemple avec <function>wincache_ucache_add</function> et le paramètre <parameter>key</parameter> sous forme de &string; - - -]]> - - &example.outputs; - - - - - - - - Exemple avec <function>wincache_ucache_add</function> et le paramètre <parameter>key</parameter> sous forme d'un &array; - - '5', 'Blue' => '6', 'yellow' => '7', 'cyan' => '8'); -var_dump(wincache_ucache_add($colors_array)); -var_dump(wincache_ucache_add($colors_array)); -var_dump(wincache_ucache_get('Blue')); -?> -]]> - - &example.outputs; - - int(-1) - ["Blue"]=> int(-1) - ["yellow"]=> int(-1) - ["cyan"]=> int(-1) -} -string(1) "6" -]]> - - - - - - - &reftitle.seealso; - - - wincache_ucache_set - wincache_ucache_get - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - __sleep() - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-cas.xml b/reference/wincache/functions/wincache-ucache-cas.xml deleted file mode 100644 index 8519aaa214..0000000000 --- a/reference/wincache/functions/wincache-ucache-cas.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - wincache_ucache_cas - Compare la variable avec son ancienne valeur et lui assigne une nouvelle valeur - - - &reftitle.description; - - boolwincache_ucache_cas - stringkey - intold_value - intnew_value - - - Compare la variable associée avec la clé key avec - la valeur old_value et si elle correspond, lui assigne - la nouvelle valeur new_value. - - - - &reftitle.parameters; - - - - key - - - La clé key utilisé pour stocker la variable - dans le cache. key est sensible à la casse. - - - - - old_value - - - L'ancienne valeur de la variable pointée par le paramètre - key dans le cache utilisateur. - La valeur doit être de type long, sinon, la fonction - retournera &false;. - - - - - new_value - - - La nouvelle valeur qui sera assignée à la variable pointée par - la clé key si la correspondance a été trouvée. - La valeur doit être de type long, sinon, la fonction - retournera &false;. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Exemple avec <function>wincache_ucache_cas</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - wincache_ucache_inc - wincache_ucache_dec - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-clear.xml b/reference/wincache/functions/wincache-ucache-clear.xml deleted file mode 100644 index 674ddf1b67..0000000000 --- a/reference/wincache/functions/wincache-ucache-clear.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - wincache_ucache_clear - Supprime le contenu d'une entrée du cache utilisateur - - - &reftitle.description; - - boolwincache_ucache_clear - - - - Supprime toutes les valeurs stockées dans le cache utilisateur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Exemple avec <function>wincache_ucache_clear</function> - - -]]> - - &example.outputs; - - int(1) - ["red"]=> int(2) - ["orange"]=> int(4) - ["blue"]=> int(8) - ["cyan"]=> int(16) } -bool(true) -bool(false) -]]> - - - - - - - &reftitle.seealso; - - - wincache_ucache_set - wincache_ucache_add - wincache_ucache_delete - wincache_ucache_get - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-dec.xml b/reference/wincache/functions/wincache-ucache-dec.xml deleted file mode 100644 index 89e8277267..0000000000 --- a/reference/wincache/functions/wincache-ucache-dec.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - wincache_ucache_dec - Décrémente la valeur associée à une clé - - - &reftitle.description; - - mixedwincache_ucache_dec - stringkey - intdec_by1 - boolsuccess - - - Décrémente de 1 ou dec_by de la valeur associée - avec la clé key. - - - - &reftitle.parameters; - - - - key - - - La clé key utilisée pour stocker la variable - dans le cache. Le paramètre key est sensible - à la casse. - - - - - dec_by - - - La valeur utilisée pour décrémenter la variable associée à la clé - key. Si l'argument est un nombre à virgule flottante, - il sera arrondi à l'entier le plus proche. La variable associée avec la clé - key doit être de type long, sinon, - la fonction retournera &false;. - - - - - success - - - Sera définie à &true; en cas de succès, &false; si une erreur survient. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur décrémentée en cas de succès, &false; si une erreur survient. - - - - &reftitle.examples; - - - Exemple avec <function>wincache_ucache_dec</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - wincache_ucache_inc - wincache_ucache_cas - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-delete.xml b/reference/wincache/functions/wincache-ucache-delete.xml deleted file mode 100644 index f1824b8333..0000000000 --- a/reference/wincache/functions/wincache-ucache-delete.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - wincache_ucache_delete - Supprime les variables du cache utilisateur - - - &reftitle.description; - - boolwincache_ucache_delete - mixedkey - - - Supprime les éléments pointés par la clé key - du cache utilisateur. - - - - &reftitle.parameters; - - - - key - - - La clé key utilisée pour stocker la variable dans - le cache. Le paramètre key est sensible à la casse. - key peut être un tableau de clés. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - Si le paramètre key est un tableau, alors la fonction - retournera &false; si un des éléments du tableau n'a pu être supprimé du cache - utilisateur, sinon, elle retournera un tableau contenant toutes les clés - ayant été supprimées avec succès. - - - - &reftitle.examples; - - - Exemple avec <function>wincache_ucache_delete</function> et - le paramètre <parameter>key</parameter> sous forme de &string; - - -]]> - - &example.outputs; - - - - - - - - Exemple avec <function>wincache_ucache_delete</function> et - le paramètre <parameter>key</parameter> sous forme d'un &array; - - '5', 'blue' => '6', 'yellow' => '7', 'cyan' => '8'); -wincache_ucache_set($array1); -$array2 = array('green', 'blue', 'yellow', 'cyan'); -var_dump(wincache_ucache_delete($array2)); -?> -]]> - - &example.outputs; - - string(5) "green" - [1]=> string(4) "blue" - [2]=> string(6) "yellow" - [3]=> string(4) "cyan" } -]]> - - - - - - Exemple avec <function>wincache_ucache_delete</function> et - le paramètre <parameter>key</parameter> sous la forme d'un &array; où quelques - éléments n'ont pas pu être supprimés - - '5', 'blue' => '6', 'yellow' => '7', 'cyan' => '8'); -wincache_ucache_set($array1); -$array2 = array('orange', 'red', 'yellow', 'cyan'); -var_dump(wincache_ucache_delete($array2)); -?> -]]> - - &example.outputs; - - string(6) "yellow" - [1]=> string(4) "cyan" } -]]> - - - - - - &reftitle.seealso; - - - wincache_ucache_set - wincache_ucache_add - wincache_ucache_get - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-exists.xml b/reference/wincache/functions/wincache-ucache-exists.xml deleted file mode 100644 index 53de7669c3..0000000000 --- a/reference/wincache/functions/wincache-ucache-exists.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - wincache_ucache_exists - Vérifie si une variable existe dans le cache utilisateur - - - &reftitle.description; - - boolwincache_ucache_exists - stringkey - - - Vérifie si une variable dont la clé est key - existe ou non dans le cache utilisateur. - - - - &reftitle.parameters; - - - - key - - - La clé key utilisée pour stocker - la variable dans le cache. Le paramètre key - est sensible à la casse. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si la variable dont la clé est key existe, - &false; sinon. - - - - &reftitle.examples; - - - Exemple avec <function>wincache_ucache_exists</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - - wincache_ucache_set - wincache_ucache_add - wincache_ucache_get - wincache_ucache_clear - wincache_ucache_delete - wincache_ucache_meminfo - wincache_ucache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-get.xml b/reference/wincache/functions/wincache-ucache-get.xml deleted file mode 100644 index 7272314089..0000000000 --- a/reference/wincache/functions/wincache-ucache-get.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - - - wincache_ucache_get - Récupère une variable stockée dans le cache utilisateur - - - &reftitle.description; - - mixedwincache_ucache_get - mixedkey - boolsuccess - - - Récupère une variable stockée dans le cache utilisateur. - - - - &reftitle.parameters; - - - - key - - - La clé key utilisée pour stocker la variable - dans le cache. Le paramètre key est sensible à la casse. - key peut être un tableau de clés. Dans ce cas, la valeur - retournée sera un tableau de valeurs de chaque élément du tableau key. - Si un objet ou un tableau contenant des objets est retourné, alors les objets - seront désérialisés. Se reporter à la fonction - __wakeup() pour plus - de détails sur la désérialisation des objets. - - - - - success - - - Sera définie à &true; en cas de succès, &false; si une erreur survient. - - - - - - - - &reftitle.returnvalues; - - Si le paramètre key est une &string;, la fonction retournera - la valeur de la variable stockée avec cette clé. Le paramètre success - sera défini à &true; en cas de succès, et à &false; si une erreur survient. - - - Si le paramètre key est un tableau, le paramètre - success sera toujours défini à &true;. Le tableau retourné - (paires de nom => valeur) contiendra uniquement les paires nom => valeur pour - lesquelles la récupération depuis le cache utilisateur a été un succès. - Si aucune des clés du tableau ne correspond à des entrées du cache utilisateur, - un tableau vide sera retourné. - - - - &reftitle.examples; - - - Exemple avec <function>wincache_ucache_get</function> et - le paramètre <parameter>key</parameter> sous forme de &string; - - -]]> - - &example.outputs; - - - - - - - - Exemple avec <function>wincache_ucache_get</function> et - le paramètre <parameter>key</parameter> sous forme d'un &array; - - '5', 'Blue' => '6', 'yellow' => '7', 'cyan' => '8'); -wincache_ucache_set($array1); -$array2 = array('green', 'Blue', 'yellow', 'cyan'); -var_dump(wincache_ucache_get($array2, $success)); -var_dump($success); -?> -]]> - - &example.outputs; - - string(1) "5" - ["Blue"]=> string(1) "6" - ["yellow"]=> string(1) "7" - ["cyan"]=> string(1) "8" } -bool(true) -]]> - - - - - - - &reftitle.seealso; - - - wincache_ucache_add - wincache_ucache_set - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - __wakeup() - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-inc.xml b/reference/wincache/functions/wincache-ucache-inc.xml deleted file mode 100644 index 66afc12ca7..0000000000 --- a/reference/wincache/functions/wincache-ucache-inc.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - - wincache_ucache_inc - Incrémente la valeur associée à une clé - - - &reftitle.description; - - mixedwincache_ucache_inc - stringkey - intinc_by1 - boolsuccess - - - Incrémente, de 1 ou de la valeur du paramètre inc_by, - la valeur associée avec la clé key. - - - - &reftitle.parameters; - - - - key - - - La clé key utilisée pour stocker la variable - dans le cache. Le paramètre key est sensible à la casse. - - - - - inc_by - - - La valeur utilisée pour incrémenter la variable associée à la clé - key. Si l'argument est un nombre à virgule flottante, - elle sera arrondie à l'entier le plus proche. La variable associée à la clé - key doit être de type long, sinon - la fonction échouera et retournera &false;. - - - - - success - - - Sera défini à &true; en cas de succès, &false; si une erreur survient. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur incrémentée en cas de succès, &false; si une erreur survient. - - - - &reftitle.examples; - - - Exemple avec <function>wincache_ucache_inc</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - wincache_ucache_dec - wincache_ucache_cas - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-info.xml b/reference/wincache/functions/wincache-ucache-info.xml deleted file mode 100644 index fe33abab30..0000000000 --- a/reference/wincache/functions/wincache-ucache-info.xml +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - - - wincache_ucache_info - Récupère des informations sur des données stockées dans le cache utilisateur - - - &reftitle.description; - - arrayfalsewincache_ucache_info - boolsummaryonly&false; - stringkeyNULL - - - Récupère des informations sur des données stockées dans le cache utilisateur. - - - - &reftitle.parameters; - - - - summaryonly - - - Contrôle si le tableau résultant doit contenir les informations - sur des entrées individuelles en plus du résumé du cache utilisateur. - - - - - key - - - La clé de l'entrée du cache utilisateur. Si spécifiée, alors le tableau - résultant contiendra des informations uniquement sur cette entrée - du cache. Si non spécifiée, et le paramètre summaryonly - est défini à &false;, alors le tableau résultant contiendra des informations - sur toutes les entrées du cache. - - - - - - - - &reftitle.returnvalues; - - Un tableau de données méta sur le cache utilisateur - &return.falseforfailure; - - - Le tableau retourné par cette fonction contient les éléments suivants : - - - - total_cache_uptime - durée, en secondes, depuis l'activation de ce cache utilisateur - - - - - total_item_count - nombre total d'éléments contenus dans le cache utilisateur - - - - - is_local_cache - &true; si les données méta du cache sont pour une instance - locale du cache, &false; si elles sont pour le cache global - - - - - total_hit_count - nombre de fois que les données ont été servies depuis le cache - - - - - total_miss_count - nombre de fois que les données n'ont pu être trouvées dans le cache - - - - - ucache_entries - un tableau contenant les informations sur les éléments mis en cache : - - - - key_name - nom de la clé utilisée pour stocker les données - - - - - value_type - type de valeur stockée pour cette clé - - - - - use_time - durée, en secondes, depuis laquelle le fichier a été accédé dans le cache opcode - - - - - last_check - durée, en secondes, depuis laquelle le fichier a été vérifié pour y détecter les modifications - - - - - is_session - indique si la donnée est une variable de session - - - - - ttl_seconds - durée de vie de la donnée dans le cache ; 0 signifie indéfiniment - - - - - age_seconds - durée depuis laquelle la donnée a été ajoutée dans le cache - - - - - hitcount - nombre de fois que la donnée a été servie depuis le cache - - - - - - - - - - &reftitle.examples; - - - Exemple avec <function>wincache_ucache_info</function> - - -]]> - - &example.outputs; - - int(0) - ["is_local_cache"] => bool(false) - ["total_item_count"] => int(1) - ["total_hit_count"] => int(3) - ["total_miss_count"] => int(1) - ["ucache_entries"] => Array(1) - ( [1] => Array(6) - ( - ["key_name"] => string(5) "green" - ["value_type"] => string(4) "long" - ["is_session"] => int(0) - ["ttl_seconds"] => int(0) - ["age_seconds"] => int(0) - ["hitcount"] => int(3) - ) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_meminfo - wincache_rplist_fileinfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-meminfo.xml b/reference/wincache/functions/wincache-ucache-meminfo.xml deleted file mode 100644 index e761019f41..0000000000 --- a/reference/wincache/functions/wincache-ucache-meminfo.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - - wincache_ucache_meminfo - Récupère des informations sur l'utilisation mémoire du cache utilisateur - - - &reftitle.description; - - arrayfalsewincache_ucache_meminfo - - - - Récupère des informations sur l'utilisation mémoire du cache utilisateur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Tableau de données méta sur l'utilisation mémoire du cache utilisateur - &return.falseforfailure; - - - Le tableau retourné par cette fonction contient les éléments suivants : - - - - memory_total - quantité de mémoire, en octets, allouée au cache utilisateur - - - - - memory_free - quantité de mémoire libre, en octets, disponible pour le cache utilisateur - - - - - num_used_blks - nombre de blocs mémoire utilisés par le cache utilisateur - - - - - num_free_blks - nombre de blocs mémoire libres disponible depuis le cache utilisateur - - - - - memory_overhead - quantité de mémoire, en octets, utilisé pour la structure interne du cache utilisateur - - - - - - - - &reftitle.examples; - - - Exemple avec <function>wincache_ucache_meminfo</function> - - - - - -]]> - - &example.outputs; - - 5242880 - [memory_free] => 5215056 - [num_used_blks] => 6 - [num_free_blks] => 3 - [memory_overhead] => 176 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-set.xml b/reference/wincache/functions/wincache-ucache-set.xml deleted file mode 100644 index eeac90f6cf..0000000000 --- a/reference/wincache/functions/wincache-ucache-set.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - - - wincache_ucache_set - Ajoute une variable au cache utilisateur et écrase la variable si elle existe déjà dans le cache - - - &reftitle.description; - - boolwincache_ucache_set - mixedkey - mixedvalue - intttl0 - - - boolwincache_ucache_set - arrayvalues - mixedunusedNULL - intttl0 - - - Ajoute une variable au cache utilisateur. Écrase une variable si elle existe déjà - dans le cache. La variable ainsi créée ou mise à jour restera dans le cache - utilisateur tant que le délai d'expiration n'est pas atteint ou tant qu'elle n'est - pas supprimée avec la fonction wincache_ucache_delete ou - la fonction wincache_ucache_clear. - - - - &reftitle.parameters; - - - - key - - - Stocke la variable en utilisant la clé key. - Si une variable utilisant la même clé key est - déjà présente, la fonction écrasera la précédente valeur avec la nouvelle. - Le paramètre key est sensible à la casse. - key peut également être un tableau de paires - nom => valeur où les noms seront utilisés comme clés. Ceci peut être utile - pour ajouter plusieurs valeurs dans le cache en une seule opération. - - - - - value - - - Valeur de la variable à stocker. Le paramètre Value - supporte tous les types de données, sauf les ressources, comme les pointeurs - de fichiers. Ce paramètre est ignoré si le premier argument est un tableau. - Il est de convention de passer la valeur &null; comme valeur du paramètre - value lors de l'utilisation d'un tableau dans le paramètre - key. Si le paramètre value est un objet, - ou un tableau contenant des objets, alors tous les objets seront sérialisés. - Se reporter à la fonction __sleep() - pour plus de détails sur la sérialisation d'objets. - - - - - values - - - Tableau associatif de clés et de valeurs. - - - - - ttl - - - Durée de vie de la variable dans le cache, en secondes. Après la durée spécifiée par - le paramètre ttl, la variable stockée sera effacée du cache utilisateur. - Ce paramètre prend par défaut la valeur zéro (0), ce qui signifie - que la variable restera dans le cache tant qu'elle ne sera pas explicitement supprimée - en appelant la fonction wincache_ucache_delete ou la fonction - wincache_ucache_clear. - - - - - - - - &reftitle.returnvalues; - - Si key est une &string;, la fonction retournera &true; en cas de succès, - &false; si une erreur survient. - - - Si key est un tableau, la fonction retournera : - - - - Si toutes les paires nom => valeur du tableau ont pu être définies, - la fonction retournera un tableau vide. - - - - - Si toutes les paires nom => valeur du tableau n'ont pu être définies, - la fonction retournera &false;. - - - - - Si quelques paires ont été définies, et d'autres non, la fonction - retournera un tableau de paires nom => valeur qui n'ont pas pu être définies - dans le cache utilisateur. - - - - - - - &reftitle.examples; - - - Exemple avec <function>wincache_ucache_set</function> et - le paramètre <parameter>key</parameter> sous forme de &string; - - -]]> - - &example.outputs; - - - - - - - - Exemple avec <function>wincache_ucache_set</function> et - le paramètre <parameter>key</parameter> sous forme de &array; - - '5', 'Blue' => '6', 'yellow' => '7', 'cyan' => '8'); -var_dump(wincache_ucache_set($colors_array)); -var_dump(wincache_ucache_set($colors_array)); -var_dump(wincache_ucache_get('Blue')); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - wincache_ucache_add - wincache_ucache_get - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - __sleep() - - - - - - - diff --git a/reference/wincache/functions/wincache-unlock.xml b/reference/wincache/functions/wincache-unlock.xml deleted file mode 100644 index 82b2565f0d..0000000000 --- a/reference/wincache/functions/wincache-unlock.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - wincache_unlock - Libère un verrou exclusif sur une clé donnée - - - &reftitle.description; - - boolwincache_unlock - stringkey - - - Libère un verrou exclusif qui a été obtenu sur une clé donnée en utilisant - la fonction wincache_lock. Si un autre processus est en - attente de ce verrou, pour cette clé, il obtiendra le verrou. - - - - L'utilisation des fonctions wincache_lock et - wincache_unlock peut provoquer des verrous morts lors - de l'exécution de scripts PHP dans un environnement multiprocessus comme FastCGI. - Il ne faut pas utiliser ces fonctions à moins d'être sûr d'en avoir besoin. - Pour la majorité des opérations sur le cache utilisateur, il n'est pas nécessaire - de les utiliser. - - - - - &reftitle.parameters; - - - - key - - - Nom de la clé du cache pour laquelle le verrou doit être libéré. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Exemple avec <function>wincache_unlock</function> - - -]]> - - - - - - - &reftitle.seealso; - - - wincache_lock - wincache_ucache_set - wincache_ucache_get - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - - - - - - - diff --git a/reference/wincache/ini.xml b/reference/wincache/ini.xml deleted file mode 100644 index c0cb772099..0000000000 --- a/reference/wincache/ini.xml +++ /dev/null @@ -1,538 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - Le tableau suivant répertorie et explique les paramètres de configuration - fournis par l'extension WinCache : - - - - Options de configuration WinCache - - - - &Name; - &Default; - Minimum - Maximum - &Changeable; - &Changelog; - - - - - wincache.fcenabled - "1" - "0" - "1" - INI_ALL - Disponible depuis WinCache 1.0.0 - - - wincache.fcenabledfilter - "NULL" - "NULL" - "NULL" - INI_SYSTEM - Disponible depuis WinCache 1.0.0 - - - wincache.fcachesize - "24" - "5" - "255" - INI_SYSTEM - Disponible depuis WinCache 1.0.0 - - - wincache.fcndetect - "1" - "0" - "1" - INI_SYSTEM - Disponible depuis WinCache 1.1.0 - - - wincache.maxfilesize - "256" - "10" - "2048" - INI_SYSTEM - Disponible depuis WinCache 1.0.0 - - - wincache.ocenabled - "1" - "0" - "1" - INI_ALL - Disponible depuis WinCache 1.0.0. Supprimé depuis 2.0.0.0 - - - wincache.ocenabledfilter - "NULL" - "NULL" - "NULL" - INI_SYSTEM - Disponible depuis WinCache 1.0.0. Supprimé depuis 2.0.0.0 - - - wincache.ocachesize - "96" - "15" - "255" - INI_SYSTEM - Disponible depuis WinCache 1.0.0. Supprimé depuis 2.0.0.0 - - - wincache.filecount - "4096" - "1024" - "16384" - INI_SYSTEM - Disponible depuis WinCache 1.0.0 - - - wincache.chkinterval - "30" - "0" - "300" - INI_SYSTEM - Disponible depuis WinCache 1.0.0 - - - wincache.ttlmax - "1200" - "0" - "7200" - INI_SYSTEM - Disponible depuis WinCache 1.0.0 - - - wincache.enablecli - 0 - 0 - 1 - INI_SYSTEM - Disponible depuis WinCache 1.0.0 - - - wincache.ignorelist - NULL - NULL - NULL - INI_ALL - Disponible depuis WinCache 1.0.0 - - - wincache.namesalt - NULL - NULL - NULL - INI_SYSTEM - Disponible depuis WinCache 1.0.0 - - - wincache.ucenabled - 1 - 0 - 1 - INI_SYSTEM - Disponible depuis WinCache 1.1.0 - - - wincache.ucachesize - 8 - 5 - 85 - INI_SYSTEM - Disponible depuis WinCache 1.1.0 - - - wincache.scachesize - 8 - 5 - 85 - INI_SYSTEM - Disponible depuis WinCache 1.1.0 - - - wincache.rerouteini - NULL - NULL - NULL - INI_SYSTEM - Disponible depuis WinCache 1.2.0. Retiré dans la version 1.3.7 - - - wincache.reroute_enabled - 1 - 0 - 1 - INI_SYSTEM|INI_PERDIR - Disponible depuis WinCache 1.3.7 - - - wincache.srwlocks - 1 - 0 - 1 - INI_SYSTEM - Disponible depuis WinCache 1.3.6.3. Supprimé depuis la version 2.0.0.0 - - - wincache.filemapdir - NULL - NULL - NULL - INI_SYSTEM - Disponible depuis WinCache 1.3.7.4 - - - -
    - &ini.php.constants; -     - - &ini.descriptions.title; - - - - - - wincache.fcenabled - bool - - - Active ou désactive la fonctionnalité de cache de fichiers. - - - - - wincache.fcenabledfilter - string - - - - Définit une liste séparée par des virgules, d'identificateurs de site Web IIS où - le cache de fichiers doit être activé ou désactivé. Ce paramètre fonctionne en - conjonction avec wincache.fcenabled : Si wincache.fcenabled - est réglé à 1, alors les sites listés dans wincache.fcenabledfilter - auront le cache de fichiers désactivé; si wincache.fcenabled - est réglé à 0, alors les sites listés dans wincache.fcenabledfilter - auront le cache de fichiers activé. - - - - - - wincache.fcachesize - int - - - - Définit la taille maximale de mémoire (en mégaoctets) qui est allouée pour le cache de fichiers. - Si la taille totale de tous les fichiers en cache dépasse la valeur spécifiée dans ce paramètre, - alors la plupart des fichiers périmés seront retirés du cache de fichiers. - - - - - - wincache.fcndetect - bool - - - - Active ou désactive les notifications de détection de modification - de fichier. Si la notification est supportée, alors elle sera utilisée - pour rafraîchir l'opcode ainsi que les entrées du fichier présentes dans - le cache aussitôt la modification correspondante des fichiers effectuée - sur le système de fichiers. Si la notification n'est pas supportée, par - exemple lors de l'utilisation de fichiers partagés par le réseau, alors - Wincache vérifiera les modifications de fichiers à intervalle régulier - spécifié par le paramètre wincache.chkinterval. - - - - - - wincache.maxfilesize - int - - - - Définit la taille maximale autorisée (en kilo-octets) pour un fichier unique qui sera mis en cache. - Si un fichier a une taille supérieure à la valeur spécifiée, le fichier ne sera pas mis en cache. - Ce paramètre s'applique à la mémoire cache de fichier seulement. - - - - - - wincache.ocenabled - bool - - - Cette option a été - SUPPRIMEE depuis la version 2.0.0.0 - Active ou désactive la fonctionnalité de cache opcode - - - - - wincache.ocenabledfilter - string - - - Cette option a été - SUPPRIMEE depuis la version 2.0.0.0 - - Définit une liste séparée par des virgules, d'identificateurs de site Web IIS où - le cache opcode doit être activé ou désactivé. Ce paramètre fonctionne en - conjonction avec wincache.ocenabled : Si wincache.ocenabled - est réglé à 1, alors les sites listés dans wincache.ocenabledfilter - auront le cache opcode désactivé; si wincache.ocenabled - est réglé à 0, alors les sites listés dans wincache.ocenabledfilter - auront le cache opcode activé. - - - - - - wincache.ocachesize - int - - - Cette option a été - SUPPRIMEE depuis la version 2.0.0.0 - - Définit la taille maximale de mémoire (en mégaoctets) qui est allouée pour le cache opcode. - Si la taille du cache opcode dépasse la valeur spécifiée, alors l'opcode le plus ancien - sera retiré du cache. Il est à noter que la taille du cache d'opcode doit être au moins 3 fois plus grande - que la taille du cache de fichiers. Si ce n'est pas le cas la taille du cache opcode sera - automatiquement augmentée. - - - - - - wincache.filecount - int - - - - Définit combien de fichiers sont censés être mis en cache par l'extension, de sorte à - ce qu'un montant de mémoire suffisant soit alloué au démarrage. Si le nombre de fichiers - excède la valeur spécifiée, WinCache ré-allouera plus de mémoire comme demandé. - - - - - - wincache.chkinterval - int - - - - Définit la fréquence (en secondes) à laquelle l'extension vérifiera les changements - de fichier de façon à rafraîchir le cache. Mettre cette option à 0 permet de désactiver - le rafraîchissement du cache. Les changements de fichiers ne seront pas reflétés dans le - cache à moins que l'entrée de cache soit supprimée par le récupérateur, que le pool - d'applications IIS soit recyclé, ou que la fonction wincache_refresh_if_changed soit appelée. - - - - - - wincache.ttlmax - int - - - - Définit le temps de vie maximale (en secondes) pour une entrée de cache sans être utilisée. - Définir ce paramètre à 0 désactive le récupérateur de cache, de façon à ce que les entrées du - cache ne soient jamais supprimées du cache pendant la durée de vie du processus de travail IIS. - - - - - - wincache.enablecli - bool - - - - Définit si le cache est activé lorsque PHP fonctionne en ligne de commande (CLI) . - - - - - - wincache.ignorelist - string - - - - Définit une liste de fichiers qui ne doivent pas être mis en cache par l'extension. - La liste des fichiers est spécifiée en utilisant des noms de fichiers uniquement, séparés par - le symbole pipe - "|". - - <literal>wincache.ignorelist</literal> exemple - - - - - - - - - - wincache.namesalt - string - - - - Définit une chaîne qui sera utilisée lors du nommage des objets spécifiques - à l'extension qui seront stockés dans la mémoire partagée. Ce paramètre est utilisé - afin d'éviter les conflits qui peuvent être provoqués si d'autres applications dans - un processus de travail IIS tentent d'accéder à la mémoire partagée. La longueur - de la chaîne namesalt ne peut être supérieure à 8 caractères. - - - - - - - wincache.ucenabled - bool - - - - Active ou désactive la fonctionnalité de cache utilisateur. - - - - - - wincache.ucachesize - int - - - - Définit la taille maximale de mémoire (en mégaoctets) qui est allouée pour le cache utilisateur. - Si la taille totale des variables stockées dans le cache utilisateur dépasse la valeur spécifiée, - alors les plus anciennes variables seront retirées du cache. - - - - - - wincache.scachesize - int - - - - Définit la taille maximale de mémoire, en méga-octets, à allouer - pour le cache de la session. Si la taille totale des données - stockées dans le cache de la session excède la valeur spécifiée, - alors les données les plus anciennes seront supprimées du cache. - - - - - - wincache.rerouteini - string - - - - Cette option a été SUPPRIMEE depuis la version 1.3.7. - Voir wincache.reroute_enabled pour des fonctionnalités - similaires depuis la version 1.3.7. - - - Indique un chemin absolu ou relatif vers le fichier reroute.ini contenant une liste de - fonctions PHP dont les implémentations devraient être remplacées par les équivalents - Wincache. Si un chemin relatif est passé, il est supposé relatif au fichier php-cgi.exe. - - - - - - wincache.reroute_enabled - bool - - - - Active ou désactive le reroutage de certaines fonctions d'entrées sorties - sur des fichiers au travers du cache fichier - - - - - - wincache.srwlocks - bool - - - Cette option a été - SUPPRIMEE depuis la version 2.0.0.0 - - Active ou désactive l'utilisation de verrous partagés en lecture écriture. - Le désactiver peut être utile lorsque surviennent des problèmes - d'interblocage dans WinCache. - - - - - - wincache.filemapdir - string - - - - Spécifie un chemin absolu vers un dossier où WinCache va stocker les - fichiers temporaires utilisés pour les segments de mémoire partagés. - - - Ce dossier doit être sur la machine locale et non sur un système de - fichier en réseau. - - - Si le dossier n'est pas précisé, WinCache va utiliser le Windows System - Page File pour tous les segments de mémoire partagés. - - - - - -
    - - diff --git a/reference/wincache/reference.xml b/reference/wincache/reference.xml deleted file mode 100644 index 6424367916..0000000000 --- a/reference/wincache/reference.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - &Functions; WinCache - - &reference.wincache.entities.functions; - - - - - diff --git a/reference/wincache/setup.xml b/reference/wincache/setup.xml deleted file mode 100644 index 101181c7d9..0000000000 --- a/reference/wincache/setup.xml +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - L'extension est actuellement uniquement supportée sur les configurations suivantes : - - Windows OS: - - - Windows XP SP3 avec IIS 5.1 et l'Extension FastCGI - - - Windows Server 2003 avec IIS 6.0 et l'Extension FastCGI - - - Windows Vista SP1 avec IIS 7.0 et le module FastCGI - - - Windows Server 2008 avec IIS 7.0 et le module FastCGI - - - Windows 7 avec IIS 7.5 et le module FastCGI - - - Windows Server 2008 R2 avec IIS 7.5 et le module FastCGI - - - PHP: - - - PHP 5.2.X, Non-thread-safe build - - - PHP 5.3 X86, Non-thread-safe VC9 build - - - - - L'extension WinCache peut uniquement être utilisée lorsque IIS est configuré pour exécuter PHP via FastCGI. - - -
    -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;wincache. - - - Il y a deux packages pour cette extension: un package est pour les versions PHP 5.2.X, - et l'autre package est pour PHP 5.3.X. Choisissez le package approprié à la version PHP - utilisée. - - - Pour installer et activer l'extension, suivez ces étapes : - - - - - Décompressez le package dans un endroit temporaire. - - - - - Copiez le fichier php_wincache.dll dans le dossier d'extensions PHP. - En général, ce dossier se nomme "ext" et est situé dans le même dossier avec tous les - fichiers binaires PHP. Par exemple : C:\Program Files\PHP\ext. - - - - - - Avec un éditeur de texte, ouvrez le fichier php.ini, qui se trouve généralement dans le même - dossier que tous les fichiers binaires PHP. Par exemple : - C:\Program Files\PHP\php.ini. - - - - - Ajouter la ligne suivante à la fin du fichier php.ini : - extension = php_wincache.dll. - - - - - Enregistrez et fermez le fichier php.ini. - - - - - Redémarrez le pool d'application IIS pour que PHP récupère les changements de - configuration. Pour vérifier que l'extension a été activée, créez un fichier nommé - phpinfo.php contenant un appel à la fonction - phpinfo. - - - - - Sauvez le fichier phpinfo.php dans le répertoire racine d'un - site Web IIS qui utilise PHP, puis ouvrez un navigateur et faites une requête sur - http://localhost/phpinfo.php. Cherchez une section appelée wincache - dans la page retournée. Si l'extension est activée, alors la sortie de - phpinfo listera les paramètres de configuration - fournis par WinCache. - - - - - - Ne pas oublier de supprimer le fichier phpinfo.php du répertoire - racine après avoir vérifié que l'extension a été activée. - - -
    - &reference.wincache.ini; - -
    - Script de statistiques WinCache - - Le package d'installation pour WinCache inclut un script PHP, - wincache.php, qui peut être utilisé pour obtenir des informations et des - statistiques sur le cache. - - - Si l'extension WinCache a été installée via l'installeur de Microsoft Web Platform, - alors ce script se trouve dans - %SystemDrive%\Program Files\IIS\Windows Cache for PHP\. - Sur une version 64 bits du système d'exploitation Windows Server, le script se trouve dans - %SystemDrive%\Program Files (x86)\IIS\Windows Cache for PHP. - Si l'extension a été installée manuellement, alors le fichier wincache.php - sera situé dans le même dossier à partir duquel le contenu du package d'installation a été extrait. - - - Pour utiliser wincache.php, copiez-le dans le dossier racine d'un site Web ou - dans n'importe quel sous-dossier. Pour protéger le script, ouvrez-le dans n'importe quel éditeur et - remplacez les valeurs des constantes USERNAME et PASSWORD. - Si n'importe quel autre authentification IIS est activée sur le serveur, alors suivez les instructions - dans les commentaires : - - Configuration de l'authentification pour <filename>wincache.php</filename> - - -]]> - - - - - Protégez toujours le script wincache.php en utilisant soit - le mécanisme d'authentification intégré ou le mécanisme d'authentification du serveur. - Laisser ce script non protégé peut compromettre la sécurité de l'application web - et du serveur. - - - -
    -
    - WinCache Session Handler - - Le gestionnaire de session WinCache (disponible depuis WinCache 1.1.0) peut être utilisé - pour configurer PHP pour stocker les données de session dans la mémoire partagée du cache de session. - L'utilisation de la mémoire partagée au lieu de la session par défaut aide à améliorer les performances - des applications PHP qui stockent de grandes quantités de données dans des objets de session. - Le cache de session Wincache utilise des fichiers basés sur la mémoire partagée, ce qui - assure que les données de session ne seront pas perdues lors du recyclage de la file - d'attente des applications IIS. - - - Pour configurer PHP pour utiliser le gestionnaire de session WinCache mettez le paramètre - session.save_handler du fichier - php.ini à wincache. - Par défaut, l'endroit où sont stockés les fichiers temporaires sous Windows est utilisé - pour stocker les données de session. Pour changer cet endroit, utiliser la directive - session.save_path. - - Activer le gestionnaire de session WinCache - - - - - -
    -
    - WinCache Functions Reroutes - - NOTE: - wincache.rerouteini - a été retiré avec WinCache 1.3.7.0. Cela a été remplacé par le reroutage - automatique de fonction. Voir : - wincache.reroute_enabled - - - Les fonctionnalités WinCache de re routages de fonctions (disponibles - depuis WinCache 1.2.0, retirée depuis WinCache 1.3.7.0) peuvent être utilisées pour remplacer des fonctions - PHP natives par leur équivalent optimisé pour des cas particuliers. L'extension - Wincache inclut des implémentations de fonctions PHP optimisées pour Windows, - notamment dans les cas d'accès réseau ou système de fichiers. - Les fonctions suivantes sont concernées : - - - - - file_exists - - - - - file_get_contents - - - - - readfile - - - - - is_readable - - - - - is_writable - - - - - is_dir - - - - - realpath - - - - - filesize - - - - - Pour configurer le re routage de fonctions avec Wincache, utiliser le fichier - reroute.ini inclus dans le paquet. Copiez-le dans le dossier - où se trouve php.ini. Après, ajoutez wincache.rerouteini dans - php.ini et précisez le chemin absolu ou relatif vers - reroute.ini. - - Activation des fonctionnalités de re routage des fonctions de WinCache - - - - - - - - Si activé, il est recommandé d'augmenter la taille du cache des fichiers. Ceci peut être - fait en utilisant le paramètre wincache.fcachesize. - - - - Le fichier reroute.ini contient la correspondance entre la fonction PHP native et - l'équivalent Wincache. Chaque ligne dans le fichier définit une correspondance. Voici la syntaxe: - - - <PHP function name>:[<number of function parameters>]=<wincache function name> - - - Un exemple de fichier est donné plus bas. Dans cet exemple, les appels aux fonctions PHP - file_get_contents seront remplacés par wincache_file_get_contents - seulement si le nombre de paramètres passés à la fonction est inférieur ou égal à deux. C'est utile de - préciser le nombre de paramètres lorsque la fonction de remplacement n'est pas conçue pour tous les - utiliser. - - Reroute.ini - - - - - -
    -     - - - diff --git a/reference/wincache/win32build.xml b/reference/wincache/win32build.xml deleted file mode 100644 index 0b48fa6e69..0000000000 --- a/reference/wincache/win32build.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Compilation sous Windows -
    - Prérequis - - Pour compiler l'extension WinCache, il faudra: - - - - le code source de PHP - - - un environnement de compilation PHP - - - le code source de WinCache - - - - Pour compléter les deux premières étapes, suivez le guide étape par étape - Compiler PHP sous Windows. - - - Pour obtenir le code source de WinCache, suivez les instructions décrites - dans Télécharger des extensions PECL. - -
    -
    - Compiler et construire - - Les étapes suivantes décrivent comment compiler et construire WinCache sous Windows: - - - - - Ouvrez une invite de commande utilisée pour compiler PHP - - - Allez dans le dossier racine où les sources de PHP sont présentes - - - - Lancez la commande : - - - - - - - - Lancez la commande : - - - - La sortie contiendra une nouvelle option --enable-wincache. - - - - - Lancez la commande : - - - - --enable-wincache est la seule option supplémentaire requise - pour s'assurer que l'extension WinCache se compile correctement. - Cette option permet de construire WinCache et le lier statiquement avec la - DLL de PHP. Pour construire l'extension comme une DLL externe, utiliser - l'option --enable-wincache=shared. - - - - - Lancez la commande : - - - - - - -
    -
    - Vérifier la construction - - Les étapes suivantes décrivent comment vérifier que WinCache a été construit correctement : - - - - - Allez dans le dossier où les fichiers PHP sont construits. - - - - - Lancez la commande : - - - - Si WinCache a été construit correctement, la sortie de cette commande listera - les directives INI et les fonctions supportées par WinCache. - - - -
    -     - - diff --git a/reference/wkhtmltox/book.xml b/reference/wkhtmltox/book.xml deleted file mode 100644 index 8bb0148562..0000000000 --- a/reference/wkhtmltox/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - - wkhtmltox - wkhtmltox - - - &reftitle.intro; - - libwkhtmltox est une bibliothèque open source LGPLv3 pour convertir - du HTML en PDF et en divers formats d'image en utilisant le moteur - de rendu QtWebKit. - - - - &reference.wkhtmltox.setup; - - &reference.wkhtmltox.wkhtmltox.pdf.converter; - &reference.wkhtmltox.wkhtmltox.pdf.object; - - &reference.wkhtmltox.wkhtmltox.image.converter; - - diff --git a/reference/wkhtmltox/configure.xml b/reference/wkhtmltox/configure.xml deleted file mode 100644 index bd8397a134..0000000000 --- a/reference/wkhtmltox/configure.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - -
    - &reftitle.install; - - - Il faut utiliser l'option - lors de la compilation de PHP. - - - -
    - - - diff --git a/reference/wkhtmltox/ini.xml b/reference/wkhtmltox/ini.xml deleted file mode 100644 index d5de8dd0b7..0000000000 --- a/reference/wkhtmltox/ini.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - wkhtmltox &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - wkhtmltox.graphics - Off - INI_SYSTEM|INI_PERDIR - >= 0.3.2 - - - -
    - &ini.php.constants; -     - -&ini.descriptions.title; - - - - - - wkhtmltox.graphics - bool - - - - Autorise libwkhtmltox à utiliser les graphiques. - - - - - -
    - - - - diff --git a/reference/wkhtmltox/setup.xml b/reference/wkhtmltox/setup.xml deleted file mode 100644 index 775a3286e2..0000000000 --- a/reference/wkhtmltox/setup.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Les sources et les binaires libwkhtmltox sont distribués - via le site wkhtmltopdf.org. - - - - Les utilisateurs de Windows doivent ajouter la bibliothèque - wkhtmltox.dll à leur variable d'environnement PATH. - - -
    - -
    - &reftitle.install; - - Le code source de cette extension et les binaires pour Windows sont stockés - sur github, - - - Récupération du code source et compilation de l'extension : - - - - - - Récupération des mises à jour et recompilation de l'extension : - - - - -
    - - &reference.wkhtmltox.ini; -     - - diff --git a/reference/wkhtmltox/wkhtmltox.image.converter.xml b/reference/wkhtmltox/wkhtmltox.image.converter.xml deleted file mode 100644 index 4482f09217..0000000000 --- a/reference/wkhtmltox/wkhtmltox.image.converter.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - La classe wkhtmltox\Image\Converter - wkhtmltox\Image\Converter - - - - -
    - &reftitle.intro; - - Convertit un HTML en une image en plusieurs formats - -
    - - -
    - &reftitle.classsynopsis; - - - - wkhtmltox\Image\Converter - - - - - wkhtmltox\Image\Converter - - - - - Constructor - - - &Methods; - - - - -
    - -     - - &reference.wkhtmltox.wkhtmltox.image.entities.converter; - -     - - diff --git a/reference/wkhtmltox/wkhtmltox.pdf.converter.xml b/reference/wkhtmltox/wkhtmltox.pdf.converter.xml deleted file mode 100644 index 89f796d4d7..0000000000 --- a/reference/wkhtmltox/wkhtmltox.pdf.converter.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - La classe wkhtmltox\PDF\Converter - wkhtmltox\PDF\Converter - - - - -
    - &reftitle.intro; - - Convertit un HTML en entrée, ou définit un jeu d'entrées HTML, - en un PDF en sortie - -
    - - -
    - &reftitle.classsynopsis; - - - - wkhtmltox\PDF\Converter - - - - - wkhtmltox\PDF\Converter - - - - - Constructor - - - &Methods; - - - - -
    - -     - - &reference.wkhtmltox.wkhtmltox.pdf.entities.converter; - -     - - diff --git a/reference/wkhtmltox/wkhtmltox.pdf.object.xml b/reference/wkhtmltox/wkhtmltox.pdf.object.xml deleted file mode 100644 index e3e10be9d1..0000000000 --- a/reference/wkhtmltox/wkhtmltox.pdf.object.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - La classe wkhtmltox\PDF\Object - wkhtmltox\PDF\Object - - - - -
    - &reftitle.intro; - - Représente un document HTML, entrée pour le convertisseur PDF - -
    - - -
    - &reftitle.classsynopsis; - - - - wkhtmltox\PDF\Object - - - - - wkhtmltox\PDF\Object - - - - - Constructor - - - - - - -
    - -     - - &reference.wkhtmltox.wkhtmltox.pdf.entities.object; - -     - - diff --git a/reference/wkhtmltox/wkhtmltox/image/converter/construct.xml b/reference/wkhtmltox/wkhtmltox/image/converter/construct.xml deleted file mode 100644 index 3048643f18..0000000000 --- a/reference/wkhtmltox/wkhtmltox/image/converter/construct.xml +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - - - wkhtmltox\Image\Converter::__construct - Crée un nouveau convertisseur d'image - - - - &reftitle.description; - - public wkhtmltox\Image\Converter::__construct - stringbuffer - arraysettings - - - Crée un convertisseur d'image, en utilisant optionnellement un buffer d'entrée - ainsi qu'une configuration - - - - - &reftitle.parameters; - - - buffer - - - HTML - - - - - settings - - - - - - - - Nom - Description - Valeur - Historique - - - - - in - URL ou chemin du fichier d'entrée, si la sortie "-" est utilisée - /chemin/vers/markup.html - >= 0.1.0 - - - out - Chemin du fichier de sortie, si la sortie "-" est utilisée ; par défaut, - un buffer interne est utilisé - /chemin/vers/sortie.png - >= 0.1.0 - - - fmt - format de sortie à utiliser - -
    - - - - - "" - default - - - jpg - sortie sous la forme d'un JPEG - - - png - sortie sous la forme d'un PNG - - - bmp - sortie sous la forme d'un bitmap - - - svg - sortie sous la forme d'un SVG - - - -
    - - >= 0.1.0 - - - transparent - lors d'une sortie en PNG ou SVG, rend l'arrière plan transparent - booléen - >= 0.1.0 - - - screenWidth - la largeur d'écran à utiliser pour le rendu en pixels - 800 - >= 0.1.0 - - - smartWidth - lorsque vaut &true;, la largeur de l'écran est étendue à la largeur du contenu - booléen - >= 0.1.0 - - - quality - Facteur de compression à utiliser lorsque la sortie est une image JPEG - 94 - >= 0.1.0 - - - crop.left - Gauche/coordonnée en X de la fenêtre à capturer, en pixels - 200 - >= 0.1.0 - - - crop.top - Haut/coordonnée en Y de la fenêtre à capturer, en pixels - 200 - >= 0.1.0 - - - crop.width - Largeur de la fenêtre à capturer, en pixels - 200 - >= 0.1.0 - - - crop.height - Hauteur de la fenêtre à capturer, en pixels - 200 - >= 0.1.0 - - - load.cookieJar - Chemin du fichier utilisé pour charger et stocker les cookies. - /tmp/cookies.txt - >= 0.1.0 - - - - - -     -     -     -     -     - - - - - -     - - diff --git a/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml b/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml deleted file mode 100644 index 36cfa3cdcf..0000000000 --- a/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - wkhtmltox\Image\Converter::convert - Réalise une conversion d'image - - - - &reftitle.description; - - public stringnullwkhtmltox\Image\Converter::convert - - - - Réalise une conversion dans le buffer de sortie. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La valeur retournée contiendra le contenu du buffer de conversion - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml b/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml deleted file mode 100644 index 52cb91a180..0000000000 --- a/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - wkhtmltox\Image\Converter::getVersion - Détermine la version du convertisseur - - - - &reftitle.description; - - public stringwkhtmltox\Image\Converter::getVersion - - - - Détermine la version du convertisseur, tel que rapporté par libwkhtmltox - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la version, sous la forme d'une chaîne de caractères - - - - Ceci n'est actuellement pas implémenté par libwkhtmltox - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml deleted file mode 100644 index d4813e88e2..0000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - wkhtmltox\PDF\Converter::add - Ajoute un objet pour la conversion - - - - &reftitle.description; - - public voidwkhtmltox\PDF\Converter::add - wkhtmltox\PDF\Objectobject - - - Ajoute l'objet fourni pour la conversion - - - - - &reftitle.parameters; - - - object - - - L'objet à ajouter - - - - - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml deleted file mode 100644 index c614ec5ec9..0000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml +++ /dev/null @@ -1,251 +0,0 @@ - - - - - - - wkhtmltox\PDF\Converter::__construct - Crée un nouveau convertisseur PDF - - - - &reftitle.description; - - public wkhtmltox\PDF\Converter::__construct - arraysettings - - - Crée un nouveau convertisseur PDF, en utilisant optionnellement, une configuration. - - - - - &reftitle.parameters; - - - settings - - - - - - - - Nom - Description - Valeurs - Historique - - - - - size.pageSize - Taille du papier du document final - A4 - >= 0.1.0 - - - size.width - Largeur du document final - 210mm - >= 0.1.0 - - - size.height - Hauteur du document final - 297mm - >= 0.1.0 - - - orientation - orientation du document final - -
    - - - - - Paysage - - - Portrait - - - -
    - - >= 0.1.0 - - - colorMode - Mode couleur du document final - - - - - - - Couleur - - - Niveau de gris - - - -
    -     - >= 0.1.0 -     - - resolution - résolution du document final - La plupart du temps, n'a aucun effet - >= 0.1.0 - - - dpi - dpi à utiliser lors de l'impression - 80 - >= 0.1.0 - - - pageOffset - Entier à ajouter aux numéros de pages générés pour l'en-tête, - le pieds de page et le sommaire - - >= 0.1.0 - - - copies - - - >= 0.1.0 - - - collate - Si l'on doit assembler les copies - booléen - >= 0.1.0 - - - outline - Génère un plan PDF - booléen - >= 0.1.0 - - - outlineDepth - Profondeur maximale du plan - - >= 0.1.0 - - - dumpOutline - Chemin du fichier pour extraire le plan XML - - >= 0.1.0 - - - out - Chemin pour le fichier final, si la sortie "-" est utilisée - - >= 0.1.0 - - - documentTitle - Titre du document final - - >= 0.1.0 - - - useCompression - Active ou désactive la compression sans perte - boolean - >= 0.1.0 - - - margin.top - Taille de la marge du haut - 2cm - >= 0.1.0 - - - margin.bottom - Taille de la marge du bas - 2cm - >= 0.1.0 - - - margin.left - Taille de la marge de gauche - 2cm - >= 0.1.0 - - - margin.right - Taille de la marge de droite - 2cm - >= 0.1.0 - - - imageDPI - DPI maximal pour les images dans le document final - - >= 0.1.0 - - - imageQuality - Le facteur de compression jpeg pour les images dans le document final - 94 - >= 0.1.0 - - - load.cookieJar - Chemin vers le fichier utilisé pour charger et stocker les cookies - /tmp/cookies.txt - >= 0.1.0 - - - - -     -     -     -     -     - - - - - -     - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml deleted file mode 100644 index 31b72c6dc9..0000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - wkhtmltox\PDF\Converter::convert - Lance la conversion PDF - - - - &reftitle.description; - - public stringnullwkhtmltox\PDF\Converter::convert - - - - Lance la conversion de tous les objets précédemment ajoutés. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La valeur retournée contiendra le contenu du buffer de conversion. - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml deleted file mode 100644 index bfb7fc8efa..0000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - wkhtmltox\PDF\Converter::getVersion - Détermine la version du convertisseur - - - - &reftitle.description; - - public stringwkhtmltox\PDF\Converter::getVersion - - - - Détermine la version du convertisseur, tel que rapporté par libwkhtmltox. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne la version sous la forme d'une chaîne de caractères. - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml b/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml deleted file mode 100644 index 71082e3c80..0000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml +++ /dev/null @@ -1,443 +0,0 @@ - - - - - - - - wkhtmltox\PDF\Object::__construct - Crée un nouvel objet PDF - - - - &reftitle.description; - - public wkhtmltox\PDF\Object::__construct - stringbuffer - arraysettings - - - Crée un nouvel objet PDF depuis le buffer fourni, - et optionnellement, configure les options. - - - - - - &reftitle.parameters; - - - buffer - - - HTML - - - - - settings - - - - - - - - Nom - Description - Valeur - Historique - - - - - page - URL ou chemin du fichier HTML à - convertir - - >= 0.1.0 - - - useExternalLinks - A définir à &true; pour convertir les liens externes - des données d'entrée en lien PDF externes dans les données - de sortie - booléen - >= 0.1.0 - - - useLocalLinks - A définir à &true; pour convertir les liens internes - dans les données d'entrées en lien PDF internes dans les - données de sortie - booléen - >= 0.1.0 - - - produceForms - A définir à &true; pour convertir les formulaires - HTML en formulaires PDF - booléen - >= 0.1.0 - - - replacements - non-documenté - - >= 0.1.0 - - - includeInOutline - A définir à &true; pour inclure les sections - depuis cet objet dans le contour et le sommaire - booléen - >= 0.1.0 - - - pagesCount - A définir à &true; pour inclure dans le sommaire le nombre - de pages de cet objet - booléen - >= 0.1.0 - - - tocXsl - A définir pour convertir cet objet en un objet de sommaire - - >= 0.1.0 - - - toc.useDottedLines - A définir à &true; pour utiliser des pointillés - dans le sommaire - booléen - >= 0.1.0 - - - toc.captionText - La légende pour le sommaire - - >= 0.1.0 - - - toc.forwardLinks - A définir à &true; pour créer des liens - depuis le sommaire vers le contenu - booléen - >= 0.1.0 - - - toc.backLinks - A définir à &true; pour créer des liens - depuis le contenu vers le sommaire - booléen - >= 0.1.0 - - - toc.indentation - L'indentation pour le sommaire - 2em - >= 0.1.0 - - - toc.fontScale - Le facteur pour diminuer la police de caractère - à tous les niveaux du sommaire - 0.8 - >= 0.1.0 - - - header.fontSize - La taille de la police de caractère à utiliser dans l'en-tête - 13 - >= 0.1.0 - - - header.fontName - Le nom de la police de caractères à utiliser dans l'en-tête - times - >= 0.1.0 - - - header.left - Le texte pour le côté gauche de l'en-tête - - >= 0.1.0 - - - header.center - Le texte pour le centre de l'en-tête - - >= 0.1.0 - - - header.right - Le texte pour le côté droit de l'en-tête - - >= 0.1.0 - - - header.line - Active ou désactive la règle horizontale sous l'en-tête - boolean - >= 0.1.0 - - - header.spacing - L'espace entre l'en-tête et le contenu - 1.8 - >= 0.1.0 - - - header.htmlUrl - URL ou le chemin vers le fichier HTML à utiliser - dans l'en-tête - - >= 0.1.0 - - - footer.fontSize - La taille de la police de caractère à utiliser dans le - bas de page - 13 - >= 0.1.0 - - - footer.fontName - Le nom de la police de caractère à utiliser dans le bas de page - times - >= 0.1.0 - - - footer.left - Le texte pour le côté gauche du bas de page - - >= 0.1.0 - - - footer.center - Le texte pour le centre du bas de page - - >= 0.1.0 - - - footer.right - Le texte pour le côté droit du bas de page - - >= 0.1.0 - - - footer.line - Active ou désactive la règle horizontale sous le bas de page - booléen - >= 0.1.0 - - - footer.spacing - L'espace entre le bas de page et le contenu - 1.8 - >= 0.1.0 - - - footer.htmlUrl - URL ou le chemin du fichier HTML à utiliser dans le - bas de page - - >= 0.1.0 - - - load.username - nom d'utilisateur à utiliser lors de la connexion à un site web - bart - >= 0.1.0 - - - load.password - mot de passe à utiliser lors de la connexion à un site web - elbarto - >= 0.1.0 - - - load.jsdelay - le temps en millisecondes à attendre après le chargement d'une page avant de la capturer - 1200 - >= 0.1.0 - - - load.zoomFactor - combien de zoom doit être appliqué au contenu - 2.2 - >= 0.1.0 - - - load.customHeaders - en-têtes personnalisés à envoyer lors de la demande de la page web principale - - >= 0.1.0 - - - load.repertCustomHeaders - définit à true pour envoyer avec toutes les demandes - boolean - >= 0.1.0 - - - load.cookies - cookie à envoyer lors de la demande de la page web principale - - >= 0.1.0 - - - load.post - chaîne à envoyer lors de la demande de la page web principale - - >= 0.1.0 - - - load.blockLocalFileAccess - empêche les fichiers locaux et les fichiers pipés d'accéder à d'autres fichiers locaux - boolean - >= 0.1.0 - - - load.stopSlowScript - arrête les scripts lents javascript - boolean - - - - load.debugJavascript - autorise javascript à lancer des avertissements - boolean - >= 0.1.0 - - - load.loadErrorHandling - définit la stratégie de gestion des erreurs - -
    - - - - - abort - annule le processus de conversion - - - skip - n'ajoute pas l'objet à la sortie finale - - - ignore - essaie d'ajouter l'objet à la sortie finale - - - -
    - - >= 0.1.0 - - - load.proxy - - - >= 0.1.0 - - - web.background - inclut une image de fond dans la sortie - boolean - >= 0.1.0 - - - web.loadImages - inclut des images dans la sortie - boolean - >= 0.1.0 - - - web.enableJavascript - active ou désactive javascript - boolean - >= 0.1.0 - - - web.enableIntelligentShrinking - active l'essai de mettre plus de contenu sur la page, s'applique uniquement à la sortie PDF - boolean - >= 0.1.0 - - - web.minimumFontSize - la taille de police minimale autorisée - 9 - >= 0.1.0 - - - web.printMediaType - affiche le contenu en utilisant le type de média d'impression au lieu du type de média d'écran - boolean - >= 0.1.0 - - - web.defaultEncoding - le contenu à utiliser lorsqu'aucun encodage n'est spécifié - utf-8 - >= 0.1.0 - - - web.userStyleSheet - URL ou chemin vers une feuille de style utilisateur spécifiée - /path/to/style.css - >= 0.1.0 - - - web.enablePlugins - active ou désactive les plugins NS - boolean - >= 0.1.0 - - - - -     -     -     -     -     - - - - - -     - - diff --git a/reference/xattr/book.xml b/reference/xattr/book.xml deleted file mode 100644 index 04a6d21154..0000000000 --- a/reference/xattr/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - - xattr - - - - &reftitle.intro; - - L'extension xattr permet la manipulation des attributs étendus d'un système - de fichiers. - - - - - &reference.xattr.setup; - &reference.xattr.constants; - &reference.xattr.reference; - - - - - diff --git a/reference/xattr/configure.xml b/reference/xattr/configure.xml deleted file mode 100644 index e92d14ee99..0000000000 --- a/reference/xattr/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;xattr. - - - &pecl.windows.download; - -
    - - diff --git a/reference/xattr/constants.xml b/reference/xattr/constants.xml deleted file mode 100644 index 52374e0914..0000000000 --- a/reference/xattr/constants.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - XATTR_ROOT - (int) - - - - Définit un attribut dans l'espace de noms racine. Nécessite les privilèges d'administrateur. - - - - - - XATTR_DONTFOLLOW - (int) - - - - Ne pas suivre un lien symbolique mais opérer directement sur le lien symbolique. - - - - - - XATTR_CREATE - (int) - - - - La fonction échouera si l'attribut étendu existe déjà. - - - - - - XATTR_REPLACE - (int) - - - - La fonction échouera si l'attribut étendu n'existe pas. - - - - - - - diff --git a/reference/xattr/functions/xattr-get.xml b/reference/xattr/functions/xattr-get.xml deleted file mode 100644 index cc3cd40838..0000000000 --- a/reference/xattr/functions/xattr-get.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - xattr_get - - Récupère un attribut étendu - - - - &reftitle.description; - - stringfalsexattr_get - stringfilename - stringname - intflags0 - - - xattr_get récupère la valeur de l'attribut étendu nommé - name du fichier filename. - - &xattr.namespace; - - - &reftitle.parameters; - - - - filename - - - Le fichier depuis lequel on récupère l'attribut. - - - - - name - - - Le nom de l'attribut. - - - - - flags - - - - Flags xattr supportés - - - - XATTR_DONTFOLLOW - Ne pas suivre les liens symboliques mais opère directement sur le lien - lui-même. - - - XATTR_ROOT - Définit l'attribut dans l'espace de noms racine. Nécessite - les privilèges d'administrateur. - - - -
    -     -     -     -     -     -     - - &reftitle.returnvalues; - - Retourne une chaîne contenant la valeur ou &false; si l'attribut n'existe pas. - - - - &reftitle.examples; - - - Vérifie si l'administrateur système a signé le fichier - - -]]> - - - - - - &reftitle.seealso; - - - xattr_list - xattr_set - xattr_remove - - - -     - - diff --git a/reference/xattr/functions/xattr-list.xml b/reference/xattr/functions/xattr-list.xml deleted file mode 100644 index 402f907b19..0000000000 --- a/reference/xattr/functions/xattr-list.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - - xattr_list - - Récupère une liste d'attributs étendus - - - - &reftitle.description; - - arrayxattr_list - stringfilename - intflags0 - - - xattr_list récupère une liste de noms d'attributs étendus - d'un fichier désigné par le paramètre filename. - - &xattr.namespace; - - - &reftitle.parameters; - - - - filename - - - Le chemin vers le fichier. - - - - - flags - - - - Flags xattr supportés - - - - XATTR_DONTFOLLOW - Ne pas suivre les liens symboliques mais opère directement sur le lien - lui-même. - - - XATTR_ROOT - Définit l'attribut dans l'espace de noms racine. Nécessite - les privilèges d'administrateur. - - - -
    -     -     -     -     -     -     - - &reftitle.returnvalues; - - Cette fonction retourne un tableau contenant les noms des attributs étendus. - - - - &reftitle.examples; - - - Affiche les noms de tous les attributs étendus d'un fichier - - -]]> - - - - - - &reftitle.seealso; - - - xattr_get - - - -     - - diff --git a/reference/xattr/functions/xattr-remove.xml b/reference/xattr/functions/xattr-remove.xml deleted file mode 100644 index dcab8d1961..0000000000 --- a/reference/xattr/functions/xattr-remove.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - xattr_remove - - Efface un attribut étendu - - - - &reftitle.description; - - boolxattr_remove - stringfilename - stringname - intflags0 - - - xattr_remove efface un attribut étendu nommé - name d'un fichier désigné par le paramètre - filename. - - &xattr.namespace; - - - &reftitle.parameters; - - - - filename - - - Le fichier depuis lequel nous effaçons l'attribut. - - - - - name - - - Le nom de l'attribut à effacer. - - - - - flags - - - - Options xattr disponibles - - - - XATTR_DONTFOLLOW - Ne pas suivre les liens symboliques mais opère directement sur le lien - lui-même. - - - XATTR_ROOT - Définit l'attribut dans l'espace de noms racine. Nécessite - les privilèges d'administrateur. - - - -
    -     -     -     -     -     -     - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Efface tous les attributs étendus d'un fichier - - -]]> - - - - - - &reftitle.seealso; - - - xattr_list - xattr_set - xattr_get - - - -     - - diff --git a/reference/xattr/functions/xattr-set.xml b/reference/xattr/functions/xattr-set.xml deleted file mode 100644 index ed4f24fb27..0000000000 --- a/reference/xattr/functions/xattr-set.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - - xattr_set - - Définit un attribut étendu - - - - &reftitle.description; - - boolxattr_set - stringfilename - stringname - stringvalue - intflags0 - - - xattr_set définit la valeur d'un attribut étendu nommé - name à la valeur value - d'un fichier désigné par le paramètre filename. - - &xattr.namespace; - - - &reftitle.parameters; - - - - filename - - - Le fichier dans lequel nous devons définir l'attribut. - - - - - name - - - Le nom de l'attribut étendu. Cet attribut sera créé s'il n'existe pas encore ou - remplacé sinon. Il est possible de modifier ce comportement en utilisant - le paramètre flags. - - - - - value - - - La valeur de l'attribut. - - - - - flags - - - - Flags xattr supportés - - - - XATTR_CREATE - La fonction échouera si l'attribut étendu existe déjà. - - - XATTR_REPLACE - La fonction échouera si l'attribut étendu n'existe pas. - - - XATTR_DONTFOLLOW - Ne pas suivre les liens symboliques mais opère directement sur le lien - lui-même. - - - XATTR_ROOT - Définit l'attribut dans l'espace de noms racine. Nécessite - les privilèges d'administrateur. - - - -
    -     -     -     -     -     -     - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Définition des attributs étendus dans un fichier <filename>.wav</filename> - - -]]> - - - - - - &reftitle.seealso; - - - xattr_get - xattr_remove - - - -     - - diff --git a/reference/xattr/functions/xattr-supported.xml b/reference/xattr/functions/xattr-supported.xml deleted file mode 100644 index 7d83ce3169..0000000000 --- a/reference/xattr/functions/xattr-supported.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - xattr_supported - - Vérifie si un système de fichiers supporte les attributs étendus - - - - &reftitle.description; - - boolxattr_supported - stringfilename - intflags0 - - - xattr_supported vérifie si le système de fichiers contenant - le fichier filename supporte les attributs étendus. - Un accès en lecture au fichier filename est nécessaire. - - - - &reftitle.parameters; - - - - filename - - - Le chemin du fichier à tester. - - - - - flags - - - - Flags xattr supportés - - - - XATTR_DONTFOLLOW - Ne pas suivre les liens symboliques mais opère directement sur le lien - lui-même. - - - -
    -     -     -     -     -     -     - - &reftitle.returnvalues; - - Cette fonction retourne &true; si le système de fichiers supporte les attributs étendus, - &false; sinon et &null; si l'on ne peut pas le déterminer (par exemple, - mauvais chemin vers le fichier ou lorsqu'il manque des permissions sur le fichier). - - - - &reftitle.examples; - - - Exemple avec <function>xattr_supported</function> - - Le code suivant vérifie si nous pouvons utiliser les attributs étendus. - - - -]]> - - - - - - &reftitle.seealso; - - - xattr_get - xattr_list - - - -     - - diff --git a/reference/xattr/reference.xml b/reference/xattr/reference.xml deleted file mode 100644 index 334e566a12..0000000000 --- a/reference/xattr/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; xattr - - &reference.xattr.entities.functions; - - - - diff --git a/reference/xattr/setup.xml b/reference/xattr/setup.xml deleted file mode 100644 index 8518e6ef0c..0000000000 --- a/reference/xattr/setup.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Pour utiliser xattr, il faut installer la bibliothèque libattr. - Elle est disponible sur - &url.xattr;. - - - - Ces fonctions ne fonctionnent que sur les systèmes de fichiers - qui supportent les attributs étendus, et qu'ils les ont activés - lors du montage du périphérique. Parmi les exemples de systèmes - de fichiers qui supportent les attributs étendus, on peut noter - ext2, ext3, reiserfs, - jfs, et xfs. - - -
    - - - - &reference.xattr.configure; - - -     - - - diff --git a/reference/xdiff/book.xml b/reference/xdiff/book.xml deleted file mode 100644 index b403b84adc..0000000000 --- a/reference/xdiff/book.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - xdiff - - - - &reftitle.intro; - - L'extension xdiff permet la création et l'application de patchs, contenant - les différences entre différentes versions d'un même fichier. - - - Cette extension supporte deux modes d'opération : sur les chaînes et sur les fichiers, - ainsi que deux formats de patch : unifié et binaire. Les patches unifiés sont parfaits - pour les fichiers textes, car ils sont lisibles et faciles à passer en revue. Les fichiers - binaires comme les archives compressées ou les images sont plus adaptés aux patches - binaires, car ils sont compatibles avec les données binaires, et gèrent les caractères - qui ne s'impriment pas. - - - Depuis la version 1.5.0, il y a deux jeux de fonctions pour générer les fichiers - binaires. Les nouvelles fonctions, xdiff_string_rabdiff et - xdiff_file_rabdiff génèrent un résultat compatible avec les anciennes - fonctions, mais généralement plus rapidement, et avec des résultats plus compacts. Pour plus - de détails sur la génération de patchs binaires, et leur différence, voir le site Web de - libxdiff. - - - Cette extension utilise la bibliothèque libxdiff pour implémenter ces fonctions. Se reporter à - &url.xdiff; pour plus d'informations. - - - - - &reference.xdiff.setup; - &reference.xdiff.constants; - &reference.xdiff.reference; - - - - - diff --git a/reference/xdiff/configure.xml b/reference/xdiff/configure.xml deleted file mode 100644 index 8cb3491b97..0000000000 --- a/reference/xdiff/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;xdiff. - - - &pecl.windows.download.avail; - -
    - - diff --git a/reference/xdiff/constants.xml b/reference/xdiff/constants.xml deleted file mode 100644 index 5afa3aa17b..0000000000 --- a/reference/xdiff/constants.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - XDIFF_PATCH_NORMAL - (int) - - - - Cette option indique que les fonctions xdiff_string_patch et - xdiff_file_patch doivent créer un résultat en appliquant le patch - au contenu original, et créer ainsi une nouvelle version du fichier. C'est le mode - d'opération par défaut. - - - - - - XDIFF_PATCH_REVERSE - (int) - - - - Cette option indique que les fonctions xdiff_string_patch et - xdiff_file_patch doivent créer un résultat en annulant - un patch depuis une version de fichier pour retrouver la version originale. - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-bdiff-size.xml b/reference/xdiff/functions/xdiff-file-bdiff-size.xml deleted file mode 100644 index 3b022824c1..0000000000 --- a/reference/xdiff/functions/xdiff-file-bdiff-size.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - xdiff_file_bdiff_size - Lit la taille d'un fichier créé lors de l'application d'un diff binaire - - - - &reftitle.description; - - intxdiff_file_bdiff_size - stringfile - - - Retourne la taille d'un fichier résultat créé après l'application d'un patch - binaire depuis le fichier file sur le fichier original. - - - - - &reftitle.parameters; - - - - file - - - Le chemin vers le patch binaire créé par la fonction - xdiff_string_bdiff ou - la fonction xdiff_string_rabdiff. - - - - - - - - - &reftitle.returnvalues; - - Retourne la taille du fichier créé. - - - - - &reftitle.examples; - - - Exemple avec <function>xdiff_file_bdiff_size</function> - - Le code suivant lit la taille d'un fichier créé après l'application d'un - diff binaire. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_file_bdiff - xdiff_file_rabdiff - xdiff_file_bpatch - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-bdiff.xml b/reference/xdiff/functions/xdiff-file-bdiff.xml deleted file mode 100644 index 9f375075f3..0000000000 --- a/reference/xdiff/functions/xdiff-file-bdiff.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - xdiff_file_bdiff - Crée un diff binaire de 2 fichiers - - - - &reftitle.description; - - boolxdiff_file_bdiff - stringold_file - stringnew_file - stringdest - - - Crée un diff binaire de 2 fichiers et enregistre le résultat dans un fichier patch. - Cette fonction fonctionne avec des fichiers textes mais aussi des fichiers binaires. - Le fichier patch résultant peut être ensuite appliqué en utilisant les fonctions - xdiff_file_bpatch et xdiff_string_bpatch. - - - - - &reftitle.parameters; - - - - old_file - - - Chemin vers le premier fichier. C'est l'ancien fichier. - - - - - new_file - - - Chemin vers le second fichier. C'est le nouveau fichier. - - - - - dest - - - Chemin vers le fichier patch résultant. Ce patch contient les différences - entre l'ancien et le nouveau fichier. Il est au format binaire et est - humainement illisible. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>xdiff_file_bdiff</function> - - Le code suivant crée un diff binaire de 2 archives. - - - -]]> - - - - - - - &reftitle.notes; - - - Les 2 fichiers seront chargés en mémoire ; aussi, il faut s'assurer que le - paramètre memory_limit est défini à une valeur assez élevée. - - - - - - &reftitle.seealso; - - - xdiff_file_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-bpatch.xml b/reference/xdiff/functions/xdiff-file-bpatch.xml deleted file mode 100644 index fffd1d0dda..0000000000 --- a/reference/xdiff/functions/xdiff-file-bpatch.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - - xdiff_file_bpatch - Patche un fichier avec un diff binaire - - - - &reftitle.description; - - boolxdiff_file_bpatch - stringfile - stringpatch - stringdest - - - Patche le fichier file avec le - patch binaire et enregistre le résultat dans le - fichier dest. Cette fonction accepte les patchs créés - via les fonctions xdiff_file_bdiff et - xdiff_file_rabdiff ou leur équivalent sous forme de chaînes. - - - - - &reftitle.parameters; - - - - file - - - Le fichier original. - - - - - patch - - - Le fichier patch binaire. - - - - - dest - - - Chemin vers le fichier résultat. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>xdiff_file_bpatch</function> - - Le code suivant applique un diff binaire à un fichier. - - - -]]> - - - - - - - &reftitle.notes; - - - Les 2 fichiers (file et patch) - seront chargés en mémoire ; aussi, il faut s'assurer que le paramétrage - de memory_limit est suffisamment élevé. - - - - - - &reftitle.seealso; - - - xdiff_file_bdiff - xdiff_file_rabdiff - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-diff-binary.xml b/reference/xdiff/functions/xdiff-file-diff-binary.xml deleted file mode 100644 index bc6a41c9d2..0000000000 --- a/reference/xdiff/functions/xdiff-file-diff-binary.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - - xdiff_file_diff_binary - &Alias; xdiff_file_bdiff - - - - &reftitle.description; - - boolxdiff_file_diff_binary - stringold_file - stringnew_file - stringdest - - - Crée un diff binaire entre les deux fichiers et stocke le résultat dans - dest. Cette fonction fonctionne avec les fichiers - texte, mais aussi avec les fichiers binaires. Le patch résultant - peut être appliqué à l'aide de la fonction xdiff_file_bpatch. - - - Depuis la version 1.5.0, cette fonction est un alias de - xdiff_file_bdiff. - - - - - &reftitle.parameters; - - - - old_file - - - Chemin jusqu'au premier fichier. Ce fichier est le "vieux" fichier. - - - - - new_file - - - Chemin jusqu'au deuxième fichier. Ce fichier est le "nouveau" fichier. - - - - - dest - - - Chemin vers le fichier résultat. Ce fichier contient les différences - entre l'ancien et le nouveau fichier. C'est un format binaire, et il est - illisible par un humain. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>xdiff_file_diff_binary</function> - - Le code suivant crée une différence binaire de deux archives. - - - -]]> - - - - - - - &reftitle.notes; - - - Les deux fichiers seront chargés en mémoire ; il faut s'assurer d'avoir défini - memory_limit à une valeur assez grande. - - - - - - &reftitle.seealso; - - - xdiff_file_bdiff - xdiff_file_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-diff.xml b/reference/xdiff/functions/xdiff-file-diff.xml deleted file mode 100644 index e323fc2fe2..0000000000 --- a/reference/xdiff/functions/xdiff-file-diff.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - - xdiff_file_diff - Crée un diff unifié entre deux fichiers - - - - &reftitle.description; - - boolxdiff_file_diff - stringold_file - stringnew_file - stringdest - intcontext3 - boolminimal&false; - - - Crée un diff unifié contenant les différences entre le fichier - old_file et new_file et les - enregistre dans le fichier dest. Le fichier résultant - est humainement lisible. Le paramètre optionnel context - spécifie le nombre de lignes du contexte qui doit être ajouté autour de - chaque modification. Si le paramètre - minimal vaut &true;, alors le fichier de sortie sera - le plus petit possible (peut prendre beaucoup de temps). - - - - - &reftitle.parameters; - - - - old_file - - - Chemin vers le premier fichier. Ce fichier représente l'ancien fichier. - - - - - new_file - - - Chemin vers le second fichier. Ce fichier représente le nouveau fichier. - - - - - dest - - - Chemin vers le fichier contenant la différence. - - - - - context - - - Indique le nombre de lignes de contexte qu'on souhaite inclure dans - le résultat de diff. - - - - - minimal - - - Configurer minimal à &true; pour - minimaliser la taille du fichier des différences (peut prendre beaucoup - de temps). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>xdiff_file_diff</function> - - Le code suivant crée un diff de deux fichiers php avec une longueur de - contexte de 2. - - - -]]> - - - - - - - &reftitle.notes; - - - Cette fonction ne fonctionne pas correctement avec les fichiers binaires. - Pour effectuer un diff sur des fichiers binaires, utiliser la fonction - xdiff_file_bdiff/xdiff_file_rabdiff. - - - - - - &reftitle.seealso; - - - xdiff_file_patch - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-merge3.xml b/reference/xdiff/functions/xdiff-file-merge3.xml deleted file mode 100644 index 52467142f0..0000000000 --- a/reference/xdiff/functions/xdiff-file-merge3.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - - xdiff_file_merge3 - Fusionne trois fichiers en un seul - - - - &reftitle.description; - - mixedxdiff_file_merge3 - stringold_file - stringnew_file1 - stringnew_file2 - stringdest - - - Fusionne trois fichiers en un seul et le stocke dans - dest. Le fichier old_file - est la version originale, tandis que les fichiers new_file1 - et new_file2 sont les versions modifiées de l'original. - - - - - &reftitle.parameters; - - - - old_file - - - Chemin vers le premier fichier. C'est l'ancien fichier. - - - - - new_file1 - - - Chemin vers le second fichier. C'est la version modifiée de old_file. - - - - - new_file2 - - - Chemin vers le troisième fichier. C'est la version modifiée de - old_file. - - - - - dest - - - Chemin vers le fichier résultant, contenant la fusion des modifications - des fichiers new_file1 et - new_file2. - - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si la fusion a réussi, une chaîne avec les - parties rejetées s'il y en a, ou &false; si une erreur interne s'est - produite. - - - - - &reftitle.examples; - - - Exemple avec <function>xdiff_file_merge3</function> - - Le code suivant fusionne trois fichiers en un. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_string_merge3 - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-patch-binary.xml b/reference/xdiff/functions/xdiff-file-patch-binary.xml deleted file mode 100644 index d0f0374bd4..0000000000 --- a/reference/xdiff/functions/xdiff-file-patch-binary.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - - xdiff_file_patch_binary - &Alias; xdiff_file_bpatch - - - - &reftitle.description; - - boolxdiff_file_patch_binary - stringfile - stringpatch - stringdest - - - Patche le fichier file avec un - patch binaire et enregistre le résultat dans le fichier - dest. Cette fonction accepte les patchs créés avec - la fonction xdiff_file_bdiff ou la fonction - xdiff_file_rabdiff ou leur équivalent sous forme de chaînes. - - - Depuis la version 1.5.0, cette fonction est un alias de la fonction - xdiff_file_bpatch. - - - - - &reftitle.parameters; - - - - file - - - Le fichier original. - - - - - patch - - - Le Patch binaire. - - - - - dest - - - Le chemin vers le fichier résultat. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>xdiff_file_patch_binary</function> - - Le code suivant applique un diff binaire à un fichier. - - - -]]> - - - - - - - &reftitle.notes; - - - Les deux fichiers (le fichier et le patch) seront chargés en mémoire ; il faut s'assurer d'avoir - défini memory_limit à une valeur assez élevée. - - - - - - &reftitle.seealso; - - - xdiff_string_patch_binary - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-patch.xml b/reference/xdiff/functions/xdiff-file-patch.xml deleted file mode 100644 index 405cd6e951..0000000000 --- a/reference/xdiff/functions/xdiff-file-patch.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - - xdiff_file_patch - Patche un fichier avec un diff unifié - - - - &reftitle.description; - - mixedxdiff_file_patch - stringfile - stringpatch - stringdest - intflagsDIFF_PATCH_NORMAL - - - Patche le fichier file avec le patch fourni par - le paramètre patch et enregistre le résultat dans un - fichier. patch doit être un diff unifié créé par la - fonction xdiff_file_diff/xdiff_string_diff. - Un paramètre optionnel flags spécifie le mode de - l'opération. - - - - - &reftitle.parameters; - - - - file - - - Le fichier original. - - - - - patch - - - Le fichier contenant le patch unifié. Il doit avoir été créé en utilisant - les fonctions xdiff_string_diff, - xdiff_file_diff ou par des outils compatibles. - - - - - dest - - - Le chemin vers le fichier résultat. - - - - - flags - - - Peut être soit XDIFF_PATCH_NORMAL (mode par - défaut, patch normal) ou XDIFF_PATCH_REVERSE - (patch inversé). - - - Depuis la version 1.5.0, il est également possible d'utiliser l'opérateur - binaire OR pour activer le drapeau - XDIFF_PATCH_IGNORESPACE. - - - - - - - - - &reftitle.returnvalues; - - Retourne &false; si une erreur interne s'est produite, une - chaîne avec les parties rejetées du patch si c'est le - cas ou &true; si le patch a été appliqué avec succès. - - - - - &reftitle.examples; - - - Exemple avec <function>xdiff_file_patch</function> - - Le code suivant applique un diff à un fichier. - - - -]]> - - - - Exemple de retour à l'état initial après l'application d'un patch - - Le code suivant annule un patch. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_file_diff - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-rabdiff.xml b/reference/xdiff/functions/xdiff-file-rabdiff.xml deleted file mode 100644 index d8f2a5baa3..0000000000 --- a/reference/xdiff/functions/xdiff-file-rabdiff.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - - xdiff_file_rabdiff - Crée un diff binaire de 2 fichiers en utilisant l'algorithme polynomial de Rabin des empreintes digitales - - - - &reftitle.description; - - boolxdiff_file_rabdiff - stringold_file - stringnew_file - stringdest - - - Crée un diff binaire de 2 fichiers et enregistre le résultat dans un fichier patch. - La différence entre cette fonction et la fonction xdiff_file_bdiff - se situe au niveau de l'algorithme utilisé. Aussi, cette fonction devrait être plus rapide - et devrait produire un diff plus petit. Cette fonction fonctionne avec des fichiers - textes, comme avec des fichiers binaires. Le fichier patch résultant pourra ensuite - être appliqué avec les fonctions xdiff_file_bpatch et - xdiff_string_bpatch. - - - Pour plus de détails concernant les différences d'algorithme, se reporter - au site web de la bibliothèque libxdiff. - - - - - &reftitle.parameters; - - - - old_file - - - Chemin vers le premier fichier. C'est l'ancien fichier. - - - - - new_file - - - Chemin vers le second fichier. C'est le nouveau fichier. - - - - - dest - - - Chemin vers le fichier résultant. Le fichier résultant contient les - différences entre l'ancien et le nouveau fichier. Il est au format - binaire, aussi, il ne sera pas humainement lisible. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Exemple avec <function>xdiff_file_rabdiff</function> - - Le code suivant crée un diff binaire de 2 archives. - - - -]]> - - - - - - - &reftitle.notes; - - - Les 2 fichiers seront chargés en mémoire ; aussi, il faut s'assurer que le - paramétrage de memory_limit est suffisamment élevé. - - - - - - &reftitle.seealso; - - - xdiff_file_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-bdiff-size.xml b/reference/xdiff/functions/xdiff-string-bdiff-size.xml deleted file mode 100644 index d934b53b85..0000000000 --- a/reference/xdiff/functions/xdiff-string-bdiff-size.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - xdiff_string_bdiff_size - Lit la taille d'un fichier créé en appliquant un diff binaire - - - - &reftitle.description; - - intxdiff_string_bdiff_size - stringpatch - - - Retourne la taille d'un fichier résultat créé après l'application d'un - patch binaire sur un fichier original. - - - - - &reftitle.parameters; - - - - patch - - - Le patch binaire créé par la fonction - xdiff_string_bdiff ou la fonction - xdiff_string_rabdiff. - - - - - - - - - &reftitle.returnvalues; - - Retourne la taille du fichier créé. - - - - - &reftitle.examples; - - - Exemple avec <function>xdiff_string_bdiff_size</function> - - Le code suivant lit la taille d'un fichier créé après l'application - d'un diff binaire. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_string_bdiff - xdiff_string_rabdiff - xdiff_string_bpatch - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-bdiff.xml b/reference/xdiff/functions/xdiff-string-bdiff.xml deleted file mode 100644 index f9782ebe8e..0000000000 --- a/reference/xdiff/functions/xdiff-string-bdiff.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - xdiff_string_bdiff - Crée un diff binaire de 2 chaînes - - - - &reftitle.description; - - stringxdiff_string_bdiff - stringold_data - stringnew_data - - - Crée un diff binaire de 2 chaînes et retourne le résultat. - Cette fonction fonctionne aussi bien avec des données textes qu'avec des - données binaires. Le patch résultant pourra ensuite être appliqué en - utilisant les fonctions xdiff_string_bpatch et - xdiff_file_bpatch. - - - - - &reftitle.parameters; - - - - old_data - - - Première chaîne contenant des données binaires. Ce sont les anciennes - données. - - - - - new_data - - - Seconde chaîne contenant des données binaires. Ce sont les nouvelles - données. - - - - - - - - - &reftitle.returnvalues; - - Retourne un diff binaire contenant les différences entre les anciennes - et les nouvelles données, ou &false; si une erreur interne survient. - - - - - &reftitle.seealso; - - - xdiff_string_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-bpatch.xml b/reference/xdiff/functions/xdiff-string-bpatch.xml deleted file mode 100644 index 97d5aee907..0000000000 --- a/reference/xdiff/functions/xdiff-string-bpatch.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - xdiff_string_bpatch - Patche une chaîne avec un diff binaire - - - - &reftitle.description; - - stringxdiff_string_bpatch - stringstr - stringpatch - - - Patche une chaîne str avec un patch - binaire. Cette fonction accepte les patchs créés via les fonctions - xdiff_string_bdiff et xdiff_string_rabdiff, - ou leur équivalent sous forme de fichier. - - - - - &reftitle.parameters; - - - - str - - - La chaîne binaire originale. - - - - - patch - - - Le patch binaire sous forme d'une &string;. - - - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne patchée, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - xdiff_string_bdiff - xdiff_string_rabdiff - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-diff-binary.xml b/reference/xdiff/functions/xdiff-string-diff-binary.xml deleted file mode 100644 index df29e6b456..0000000000 --- a/reference/xdiff/functions/xdiff-string-diff-binary.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - xdiff_string_diff_binary - &Alias; xdiff_string_bdiff - - - - &reftitle.description; - - stringxdiff_string_bdiff - stringold_data - stringnew_data - - - Crée un diff binaire de 2 chaînes et retourne le résultat. - Cette fonction fonctionne avec du texte mais aussi avec des données binaires. - Le patch résultant peut être appliqué ultérieurement en utilisant la fonction - xdiff_string_bpatch/xdiff_file_bpatch. - - - Depuis la version 1.5.0, cette fonction est un alias de la fonction - xdiff_string_bdiff. - - - - - &reftitle.parameters; - - - - old_data - - - Première chaîne avec des données binaires. Ce sont les anciennes données. - - - - - new_data - - - Seconde chaîne avec des données binaires. Ce sont les nouvelles données. - - - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne avec le résultat ou &false; si une erreur interne est - survenue. - - - - - &reftitle.seealso; - - - xdiff_string_bdiff - xdiff_string_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-diff.xml b/reference/xdiff/functions/xdiff-string-diff.xml deleted file mode 100644 index 1852f5d02c..0000000000 --- a/reference/xdiff/functions/xdiff-string-diff.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - xdiff_string_diff - Crée un diff unifié entre deux chaînes - - - - &reftitle.description; - - stringxdiff_string_diff - stringold_data - stringnew_data - intcontext3 - boolminimal&false; - - - Crée un diff unifié contenant les différences entre la chaîne - old_data et la chaîne new_data - et retourne le diff ainsi créé. Le diff résultant est humainement lisible. - Le paramètre optionnel context spécifie le nombre de - lignes de contexte à ajouter autour de chaque modification. Le fait de définir - le paramètre minimal à &true; fera que le diff sera le - plus petit possible (peut prendre du temps). - - - - - &reftitle.parameters; - - - - old_data - - - Première chaîne de données. Ce sont les anciennes données. - - - - - new_data - - - Seconde chaîne de données. Ce sont les nouvelles données. - - - - - context - - - Indique le nombre de lignes de contexte qu'on souhaite inclure - dans le diff résultant. - - - - - minimal - - - Configurer minimal à &true; pour - minimaliser la taille du diff (peut prendre beaucoup de temps). - - - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne représentant le diff résultant, ou &false; si une erreur - interne survient. - - - - - &reftitle.examples; - - - Exemple avec <function>xdiff_string_diff</function> - - Le code suivant effectue un diff de deux articles. - - - -]]> - - - - - - - &reftitle.notes; - - - Cette fonction ne fonctionne pas correctement avec des chaînes binaires. - Pour effectuer un diff de chaînes binaires, utiliser la fonction - xdiff_string_bdiff/xdiff_string_rabdiff. - - - - - - &reftitle.seealso; - - - xdiff_string_patch - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-merge3.xml b/reference/xdiff/functions/xdiff-string-merge3.xml deleted file mode 100644 index b149b58914..0000000000 --- a/reference/xdiff/functions/xdiff-string-merge3.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - xdiff_string_merge3 - Fusionne trois chaînes en une seule - - - - &reftitle.description; - - mixedxdiff_string_merge3 - stringold_data - stringnew_data1 - stringnew_data2 - stringerror - - - Fusionne 3 chaînes en une et retourne le résultat. - Le paramètre old_data est la version originale des données - tandis que new_data1 et new_data2 - sont les versions modifiées de l'original. Le paramètre optionnel - error est utilisé pour stocker toutes les parties - rejetées lors de la fusion. - - - - - &reftitle.parameters; - - - - old_data - - - Première chaîne de données. Ce sont les anciennes données. - - - - - new_data1 - - - Seconde chaîne de données. Ce sont les versions modifiées de - old_data. - - - - - new_data2 - - - Troisième chaîne de données. Ce sont les versions modifiées de - old_data. - - - - - error - - - Si error est fourni, alors les parties rejetées y - seront stockées. - - - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne fusionnée, &false; si une erreur interne survient ou - &true; si la chaîne fusionnée est vide. - - - - - &reftitle.seealso; - - - xdiff_file_merge3 - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-patch-binary.xml b/reference/xdiff/functions/xdiff-string-patch-binary.xml deleted file mode 100644 index d9021010e1..0000000000 --- a/reference/xdiff/functions/xdiff-string-patch-binary.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - xdiff_string_patch_binary - &Alias; xdiff_string_bpatch - - - - &reftitle.description; - - stringxdiff_string_patch_binary - stringstr - stringpatch - - - Patche une chaîne str avec un patch - binaire. Cette fonction accepte les patchs créés avec les fonctions - xdiff_string_bdiff et xdiff_string_rabdiff - ou leur équivalent en fichiers. - - - Depuis la version 1.5.0, cette fonction est un alias de la fonction - xdiff_string_bpatch. - - - - - &reftitle.parameters; - - - - str - - - La chaîne binaire originale. - - - - - patch - - - Le patch binaire. - - - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne patchée, ou &false; si une erreur survient. - - - - - &reftitle.seealso; - - - xdiff_string_bpatch - xdiff_string_bdiff - xdiff_string_rabdiff - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-patch.xml b/reference/xdiff/functions/xdiff-string-patch.xml deleted file mode 100644 index 8b2a7f73bd..0000000000 --- a/reference/xdiff/functions/xdiff-string-patch.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - - xdiff_string_patch - Patche une chaîne avec un diff unifié - - - - &reftitle.description; - - stringxdiff_string_patch - stringstr - stringpatch - intflags - stringerror - - - Patche la chaîne str avec un patch - unifié et retourne le résultat. patch doit être un - patch unifié créé par les fonctions - xdiff_file_diff et xdiff_string_diff. - Un paramètre optionnel flags spécifie le mode de - l'opération. Toutes les parties rejetées seront stockées dans la - variable error si elle est fournie. - - - - - &reftitle.parameters; - - - - str - - - La chaîne originale. - - - - - patch - - - Le patch unifié. Il doit avoir été créé en utilisant les fonctions - xdiff_string_diff, xdiff_file_diff - ou tout autre outil compatible. - - - - - flags - - - flags peut être soit - XDIFF_PATCH_NORMAL (mode par défaut, patch normal), - soit XDIFF_PATCH_REVERSE (patch inversé). - - - Depuis la version 1.5.0, il est également possible d'utiliser l'opérateur binaire - OR pour activer le drapeau XDIFF_PATCH_IGNORESPACE. - - - - - error - - - Si error est fourni, les parties rejetées y seront - stockées. - - - - - - - - - &reftitle.returnvalues; - - Retourne la chaîne patchée, ou &false; si une erreur survient. - - - - - &reftitle.examples; - - - Exemple avec <function>xdiff_string_patch</function> - - Le code suivant applique les changements à des articles. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_string_diff - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-rabdiff.xml b/reference/xdiff/functions/xdiff-string-rabdiff.xml deleted file mode 100644 index 3d496bec35..0000000000 --- a/reference/xdiff/functions/xdiff-string-rabdiff.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - xdiff_string_rabdiff - - Crée un diff binaire de 2 chaînes en utilisant l'algorithme polynomial de Rabin des empreintes digitales - - - - - &reftitle.description; - - stringfalsexdiff_string_rabdiff - stringold_data - stringnew_data - - - - Crée un diff binaire entre deux chaînes en utilisant l’algorithme d’empreinte polynomial de Rabin implémenté par - libxdiff. Comparé à - xdiff_string_bdiff, cet algorithme génère généralement des diffs plus compacts et fonctionne plus rapidement, - tout en restant pleinement compatible avec xdiff_string_bpatch et - xdiff_file_bpatch pour l’application des patchs. - - - Cette fonction peut être utilisée avec des données texte ou binaires. Les données de diff produites peuvent ensuite être - appliquées afin de recréer la nouvelle version à partir de l’ancienne. - - - Pour obtenir davantage d’informations sur l’algorithme, consulter la - documentation de libxdiff. - - - - - &reftitle.parameters; - - - - old_data - - - La première chaîne contenant les données binaires « anciennes ». - - - - - new_data - - - La seconde chaîne contenant les données binaires « nouvelles ». - - - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne binaire contenant les différences entre les données anciennes et nouvelles,&return.falseforfailure;. - - - - - &reftitle.examples; - - - Création d’un diff binaire entre deux chaînes - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_string_bdiff - xdiff_string_bpatch - xdiff_file_bpatch - - - - - - diff --git a/reference/xdiff/reference.xml b/reference/xdiff/reference.xml deleted file mode 100644 index 2359a0161b..0000000000 --- a/reference/xdiff/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; xdiff - - &reference.xdiff.entities.functions; - - - - diff --git a/reference/xdiff/setup.xml b/reference/xdiff/setup.xml deleted file mode 100644 index 9f0832cb87..0000000000 --- a/reference/xdiff/setup.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Pour utiliser xdiff, il faut avoir installé libxdiff, - disponible sur la page d'accueil de - &url.xdiff;. - - - - La version libxdiff 0.7 au minimum est nécessaire pour ces fonctions. - - -
    - - - - &reference.xdiff.configure; - - -     - - - diff --git a/reference/xhprof/book.xml b/reference/xhprof/book.xml deleted file mode 100644 index 2b6899f054..0000000000 --- a/reference/xhprof/book.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - Profilage hiérarchique - Xhprof - - - &reftitle.intro; - - XHProf est un profileur hiérarchique et instrumental léger. - Lors de la phase de collecte de données, il garde trace - des nombres d'appels et des métriques inclusives pour les arcs dans le - graphique dynamique d'appels d'un programme. Il calcule des métriques - exclusives lors de la phase de rapport/envoi, comme la durée accumulée, le temps - CPU, ainsi que l'utilisation de mémoire. Un profil de fonction peut être - décomposé par fonctions appelantes ou appelées. XHProf gère les - fonctions récursives en détectant les cycles dans le graphique d'appels - lors de la collecte des données, et évite les cycles en donnant des - noms uniques dépendant de la profondeur lors des invocations récursives. - - - XHProf inclut une interface utilisateur HTML simple (écrite en PHP). Le navigateur - web permet ainsi de consulter le résultat du profilage de façon simple, - ainsi que de partager les résultats. Une image du graphique d'appels - est également fournie. - - - Les rapports XHProf peuvent souvent être utiles pour comprendre la structure - du code exécuté. La nature hiérarchique des rapports - peut être utilisée pour déterminer, par exemple, la chaîne d'appels - ayant conduit à l'appel d'une fonction particulière. - - - XHProf permet de comparer deux exécutions (i.e. rapports différentiels) - ou d'agréger des données issues de plusieurs exécutions. Les rapports - différentiels et agrégés, tout comme les rapports d'exécution unique, offrent - une vue plate ainsi qu'une vue hiérarchique du profilage. - - - Il est possible de trouver plus d'informations sur la page - facebook de xhprof. - - - - &reference.xhprof.setup; - &reference.xhprof.constants; - &reference.xhprof.examples; - &reference.xhprof.reference; - - - - diff --git a/reference/xhprof/configure.xml b/reference/xhprof/configure.xml deleted file mode 100644 index 1d1d692391..0000000000 --- a/reference/xhprof/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;xhprof - - -
    - - - diff --git a/reference/xhprof/constants.xml b/reference/xhprof/constants.xml deleted file mode 100644 index 492278ce43..0000000000 --- a/reference/xhprof/constants.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - XHPROF_FLAGS_NO_BUILTINS - (int) - - - - Utilisée pour ne pas tenir compte de toutes les fonctions internes. - - - - - - XHPROF_FLAGS_CPU - (int) - - - - Utilisée pour ajouter les informations de profilage - CPU dans la sortie. - - - - - - XHPROF_FLAGS_MEMORY - (int) - - - - Utilisée pour ajouter les informations de profilage - de la mémoire dans la sortie. - - - - - - - diff --git a/reference/xhprof/examples.xml b/reference/xhprof/examples.xml deleted file mode 100644 index 92e2ee5fc0..0000000000 --- a/reference/xhprof/examples.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - &reftitle.examples; - - Exemple avec Xhprof et la GUI optionnelle - - Cet exemple démarre et stoppe le profilage, puis utilise - l'interface GUI fournie pour sauvegarder et analyser les - résultats. En d'autres termes, le code de l'extension en elle-même - s'arrête après l'appel à la fonction - xhprof_disable. - - -save_run($xhprof_data, "xhprof_testing"); - -echo "http://localhost/xhprof/xhprof_html/index.php?run={$run_id}&source=xhprof_testing\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - diff --git a/reference/xhprof/functions/xhprof-disable.xml b/reference/xhprof/functions/xhprof-disable.xml deleted file mode 100644 index 7675b68bd2..0000000000 --- a/reference/xhprof/functions/xhprof-disable.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - xhprof_disable - Stoppe le profilage xhprof - - - - &reftitle.description; - - arraynullxhprof_disable - - - - Stoppe le profilage, et retourne les données - xhprof correspondant à son exécution. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau de données xhprof, issues de son exécution. - Retourne &null; si le profilage n’est pas activé. - - - - - &reftitle.examples; - - Exemple avec <function>xhprof_disable</function> - - -]]> - - &example.outputs.similar; - -strlen] => Array - ( - [ct] => 1 - [wt] => 279 - ) - - [main()==>xhprof_disable] => Array - ( - [ct] => 1 - [wt] => 9 - ) - - [main()] => Array - ( - [ct] => 1 - [wt] => 610 - ) - -) -]]> - - - - - - - diff --git a/reference/xhprof/functions/xhprof-enable.xml b/reference/xhprof/functions/xhprof-enable.xml deleted file mode 100644 index 2430eeb782..0000000000 --- a/reference/xhprof/functions/xhprof-enable.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - - xhprof_enable - Démarre le profilage xhprof - - - - &reftitle.description; - - voidxhprof_enable - intflags0 - arrayoptions - - - Démarre le profilage xhprof. - - - - - &reftitle.parameters; - - - - flags - - - Drapeaux optionnels pour ajouter des informations supplémentaires au - profilage. Voir les - constantes XHprof pour plus - d'informations sur ces drapeaux, comme XHPROF_FLAGS_MEMORY - pour activer le profilage de la mémoire. - - - - - options - - - Un &array; d'options optionnelles, par exemple l'option - 'ignored_functions' pour spécifier des fonctions à ignorer durant - le profilage. - - - - - - - - - &reftitle.returnvalues; - - &null; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL xhprof 0.9.2 - - Le paramètre optionnel options a été ajouté. - - - - - - - - - - &reftitle.examples; - - Exemple avec <function>xhprof_enable</function> - - array('call_user_func', - 'call_user_func_array'))); - -// 3. profilage du temps écoulé ainsi que de la mémoire ; on ignore les fonctions call_user_func* lors du profilage -xhprof_enable( - XHPROF_FLAGS_MEMORY, - array('ignored_functions' => array('call_user_func', - 'call_user_func_array'))); -?> -]]> - - - - - - &reftitle.seealso; - - xhprof_disable - xhprof_sample_enable - memory_get_usage - getrusage - - - - - diff --git a/reference/xhprof/functions/xhprof-sample-disable.xml b/reference/xhprof/functions/xhprof-sample-disable.xml deleted file mode 100644 index b072850d47..0000000000 --- a/reference/xhprof/functions/xhprof-sample-disable.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - xhprof_sample_disable - Stoppe le profilage xhprof sur échantillon - - - - &reftitle.description; - - arraynullxhprof_sample_disable - - - - Stoppe le profilage xhprof sur échantillon et retourne les informations de profilage. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; de données de l'échantillon xhprof, issues de son exécution. - Retourne &null; si le profilage n’est pas activé. - - - - - &reftitle.examples; - - Exemple avec <function>xhprof_sample_disable</function> - - -]]> - - &example.outputs.similar; - - main() - [1272935300.900000] => main() -) -]]> - - - - - - - - diff --git a/reference/xhprof/functions/xhprof-sample-enable.xml b/reference/xhprof/functions/xhprof-sample-enable.xml deleted file mode 100644 index 3847e09880..0000000000 --- a/reference/xhprof/functions/xhprof-sample-enable.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - xhprof_sample_enable - Démarre le profilage en mode échantillonnage - - - - &reftitle.description; - - voidxhprof_sample_enable - - - - Démarre le profilage en mode échantillonnage, ce qui correspond à - une version plus légère de la fonction xhprof_enable. - L'intervalle d'échantillonnage est de 0.1 seconde, et les échantillons - enregistrent la pile complète des fonctions appelées. La principale - utilité de cette fonction est lorsque l'on souhaite diagnostiquer - et surveiller les performances sans pour autant consommer trop de - ressources. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &null; - - - - - &reftitle.seealso; - - xhprof_sample_disable - xhprof_enable - memory_get_usage - getrusage - - - - - diff --git a/reference/xhprof/ini.xml b/reference/xhprof/ini.xml deleted file mode 100644 index 848088ed70..0000000000 --- a/reference/xhprof/ini.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; Xhprof - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - xhprof.output_dir - "" - INI_ALL - - - - -
    -     - - &ini.descriptions.title; - - - - - xhprof.output_dir - string - - - - Dossier utilisé par l'implémentation par défaut de l'interface - iXHProfRuns (nommément, la classe XHProfRuns_Default) pour stocker - les exécutions de XHProf. - - - - -
    - - diff --git a/reference/xhprof/reference.xml b/reference/xhprof/reference.xml deleted file mode 100644 index 100e169a3b..0000000000 --- a/reference/xhprof/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; Xhprof - - &reference.xhprof.entities.functions; - - - - diff --git a/reference/xhprof/setup.xml b/reference/xhprof/setup.xml deleted file mode 100644 index 26413fae16..0000000000 --- a/reference/xhprof/setup.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Bien qu'elle ne soit pas requise, xhprof inclut une interface écrite en PHP. - Elle est utilisée pour sauvegarder et afficher les données de profilage - de manière exploitable, où la lecture s'effectue directement via un navigateur - web. Ainsi, un serveur web PHP rendra probablement l'utilisation de xhprof - plus conviviale. - - - Il existe également un fork de l'interface GUI sur - &url.xhprof.gui.fork1; - -
    - - &reference.xhprof.configure; - &reference.xhprof.ini; - -     - - diff --git a/reference/xlswriter/book.xml b/reference/xlswriter/book.xml deleted file mode 100644 index 438e690011..0000000000 --- a/reference/xlswriter/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - XLSWriter - - - - &reftitle.intro; - - Une extension efficace et rapide pour l'exportation des fichiers xlsx. - - - - - &reference.xlswriter.setup; - &reference.xlswriter.xlsx-kernel; - &reference.xlswriter.xlsx-format; - - - - - diff --git a/reference/xlswriter/configure.xml b/reference/xlswriter/configure.xml deleted file mode 100644 index a1ddac1350..0000000000 --- a/reference/xlswriter/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - -
    - &reftitle.install; - - Le support XML-RPC en PHP n'est pas activé par défaut. Il sera besoin - d'utiliser l'option de configuration - au moment de la - compilation de PHP pour activer le support XML-RPC. - -
    - - - diff --git a/reference/xlswriter/setup.xml b/reference/xlswriter/setup.xml deleted file mode 100644 index 0c600bad0b..0000000000 --- a/reference/xlswriter/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - XLSWriter nécessite PHP 7.0 ou ultérieur. - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;xlswriter - -
    - -
    - &reftitle.resources; - - Il y a une ressource utilisée par la version procédurale de l'extension - XLSWriter : renvoyée par fileName ou - \Vtiful\Kernel\Format. - -
    - -     - - - diff --git a/reference/xlswriter/xlsx-format.xml b/reference/xlswriter/xlsx-format.xml deleted file mode 100644 index 3fb31488fd..0000000000 --- a/reference/xlswriter/xlsx-format.xml +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - La classe Vtiful\Kernel\Format - Vtiful\Kernel\Format - - - - -
    - &reftitle.intro; - - Créé un objet de format de cellule - -
    - - -
    - &reftitle.classsynopsis; - - - - Vtiful\Kernel\Format - - - - - Vtiful\Kernel\Format - - - - - &Constants; - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_LEFT - 1 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER - 2 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_RIGHT - 3 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_FILL - 4 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_JUSTIFY - 5 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER_ACROSS - 6 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_DISTRIBUTED - 7 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_TOP - 8 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_BOTTOM - 9 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_CENTER - 10 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_JUSTIFY - 11 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_DISTRIBUTED - 12 - - - const - int - Vtiful\Kernel\Format::UNDERLINE_SINGLE - 1 - - - const - int - Vtiful\Kernel\Format::UNDERLINE_DOUBLE - 2 - - - const - int - Vtiful\Kernel\Format::UNDERLINE_SINGLE_ACCOUNTING - 3 - - - const - int - Vtiful\Kernel\Format::UNDERLINE_DOUBLE_ACCOUNTING - 4 - - - &Methods; - - - - - -
    - - -
    - &reftitle.constants; - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_LEFT - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_RIGHT - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_FILL - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_JUSTIFY - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER_ACROSS - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_DISTRIBUTED - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_TOP - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_BOTTOM - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_CENTER - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_JUSTIFY - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_DISTRIBUTED - - - - - - - Vtiful\Kernel\Format::UNDERLINE_SINGLE - - - - - - - Vtiful\Kernel\Format::UNDERLINE_DOUBLE - - - - - - - Vtiful\Kernel\Format::UNDERLINE_SINGLE_ACCOUNTING - - - - - - - Vtiful\Kernel\Format::UNDERLINE_DOUBLE_ACCOUNTING - - - - - - -
    - - -     - - &reference.xlswriter.entities.xlsx-format; - -     - - diff --git a/reference/xlswriter/xlsx-format/align.xml b/reference/xlswriter/xlsx-format/align.xml deleted file mode 100644 index 612e43bebd..0000000000 --- a/reference/xlswriter/xlsx-format/align.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - Vtiful\Kernel\Format::align - Définit l'alignement de la cellule - - - - &reftitle.description; - - public Vtiful\Kernel\Format::align - resourcehandle - intstyle - - - Définit l'alignement de la cellule. - - - - - &reftitle.parameters; - - - handle - - - Gestionnaire de fichier xlsx - - - - - style - - - Une constante Vtiful\Kernel\Format - - - - - - - - &reftitle.returnvalues; - - Resource - - - - - &reftitle.examples; - - Exemple de style d'alignement - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$alignStyle = $format->align(\Vtiful\Kernel\Format::FORMAT_ALIGN_LEFT)->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $alignStyle) - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-format/bold.xml b/reference/xlswriter/xlsx-format/bold.xml deleted file mode 100644 index b77baab4d1..0000000000 --- a/reference/xlswriter/xlsx-format/bold.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Vtiful\Kernel\Format::bold - Mise en gras - - - - &reftitle.description; - - public Vtiful\Kernel\Format::bold - resourcehandle - - - Vtiful\Kernel\Format mise en gras. - - - - - &reftitle.parameters; - - - handle - - - Gestionnaire de fichier xlsx - - - - - - - - &reftitle.returnvalues; - - Une ressource de formatage. - - - - - &reftitle.examples; - - Exemple de style en gras - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$boldStyle = $format->bold()->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $boldStyle) - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-format/italic.xml b/reference/xlswriter/xlsx-format/italic.xml deleted file mode 100644 index cadce479f9..0000000000 --- a/reference/xlswriter/xlsx-format/italic.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Vtiful\Kernel\Format::italic - Mise en italique - - - - &reftitle.description; - - public Vtiful\Kernel\Format::italic - resourcehandle - - - Vtiful\Kernel\Format mise en italique. - - - - - &reftitle.parameters; - - - handle - - - Gestionnaire de fichier xlsx. - - - - - - - - &reftitle.returnvalues; - - Une ressource de mise en italique. - - - - - &reftitle.examples; - - Exemple de style en italique - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$italicStyle = $format->italic()->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $italicStyle) - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-format/underline.xml b/reference/xlswriter/xlsx-format/underline.xml deleted file mode 100644 index 031d8ba7c0..0000000000 --- a/reference/xlswriter/xlsx-format/underline.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - Vtiful\Kernel\Format::underline - Mise en souligné - - - - &reftitle.description; - - public Vtiful\Kernel\Format::underline - resourcehandle - intstyle - - - Mise en souligné. - - - - - &reftitle.parameters; - - - handle - - - Gestionnaire de fichier xlsx - - - - - style - - - Une constante Vtiful\Kernel\Format - - - - - - - - &reftitle.returnvalues; - - Une ressource de mise en souligné. - - - - - &reftitle.examples; - - Exemple de style souligné - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$underlineStyle = $format->underline(\Vtiful\Kernel\Format::UNDERLINE_SINGLE)->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $underlineStyle) - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel.xml b/reference/xlswriter/xlsx-kernel.xml deleted file mode 100644 index 06410469be..0000000000 --- a/reference/xlswriter/xlsx-kernel.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - La classe Vtiful\Kernel\Excel - Vtiful\Kernel\Excel - - - - -
    - &reftitle.intro; - - Crée des fichiers xlsx et définit des cellules afin de récupérer des - fichiers xlsx en sortie - -
    - - -
    - &reftitle.classsynopsis; - - - - Vtiful\Kernel\Excel - - - - - Vtiful\Kernel\Excel - - - - - &Methods; - - - - - - - - - - -
    - -     - - &reference.xlswriter.entities.xlsx-kernel; - -     - diff --git a/reference/xlswriter/xlsx-kernel/add-sheet.xml b/reference/xlswriter/xlsx-kernel/add-sheet.xml deleted file mode 100644 index a020170189..0000000000 --- a/reference/xlswriter/xlsx-kernel/add-sheet.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::addSheet - Ajoute une feuille de calcul - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::addSheet - stringsheetName - - - Crée une nouvelle feuille de calcul dans le fichier xlsx. - - - - - &reftitle.parameters; - - - sheetName - - - Nom de la feuille de calcul - - - - - - - - &reftitle.returnvalues; - - Instance de la classe Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - Exemple - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']) - ->data([ - ['viest', 23], - ['wjx', 23] - ]); - -$file->addSheet('sheet_two') - ->header(['name', 'age']) - ->data([ - ['james', 33], - ['king', 33] - ]); - -$file->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/auto-filter.xml b/reference/xlswriter/xlsx-kernel/auto-filter.xml deleted file mode 100644 index 0682ca7435..0000000000 --- a/reference/xlswriter/xlsx-kernel/auto-filter.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::autoFilter - Ajoute un filtre automatique - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::autoFilter - stringscope - - - Ajoute un filtre automatique à une feuille de travail. - - - - - &reftitle.parameters; - - - scope - - - Chaîne de caractères représentant les coordonnées - de la cellule de début et la cellule de fin. - - - - - - - - &reftitle.returnvalues; - - Instance de la classe Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - Exemple - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('test.xlsx') - ->header(['name', 'age']) - ->data($data) - ->autoFilter('A1:B11') // Filtre automatique - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/const-memory.xml b/reference/xlswriter/xlsx-kernel/const-memory.xml deleted file mode 100644 index cc3b13de8a..0000000000 --- a/reference/xlswriter/xlsx-kernel/const-memory.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::constMemory - Écrit un gros fichier avec une utilisation constante de la mémoire - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::constMemory - stringfileName - stringsheetName - - - Écrit un gros fichier avec une utilisation constante - de la mémoire. - - - - - &reftitle.parameters; - - - fileName - - - Nom du fichier XLSX - - - - - sheetName - - - Nom de la feuille de calcul - - - - - - - - &reftitle.returnvalues; - - Instance de la classe Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - Exemple - - '/home/viest' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->constMemory('tutorial.xlsx', 'sheet'); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/construct.xml b/reference/xlswriter/xlsx-kernel/construct.xml deleted file mode 100644 index 1d59ed003c..0000000000 --- a/reference/xlswriter/xlsx-kernel/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - Vtiful\Kernel\Excel::__construct - Constructeur de la classe Vtiful\Kernel\Excel - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::__construct - arrayconfig - - - Constructeur de la classe - Vtiful\Kernel\Excel ; crée un nouvel objet. - - - - - &reftitle.parameters; - - - config - - - Configuration de l'exportation du fichier - XLSX - - - - - - - - &reftitle.examples; - - Exemple - - '/home/viest' -]; - -$excelObject = new \Vtiful\Kernel\Excel($config); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/data.xml b/reference/xlswriter/xlsx-kernel/data.xml deleted file mode 100644 index 5a935c3373..0000000000 --- a/reference/xlswriter/xlsx-kernel/data.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::data - Écrit des données - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::data - arraydata - - - Écrit des données dans une feuille de calcul. - - - - - &reftitle.parameters; - - - data - - - Les données de la feuille de calcul - - - - - - - - &reftitle.returnvalues; - - Instance de la classe - Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - Exemple - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']) - ->data([ - ['viest', 23], - ['wjx', 23], - ]); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/file-name.xml b/reference/xlswriter/xlsx-kernel/file-name.xml deleted file mode 100644 index 17d4683fc3..0000000000 --- a/reference/xlswriter/xlsx-kernel/file-name.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::fileName - Crée un nouveau fichier ainsi qu'une feuille de calcul - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::fileName - stringfileName - stringsheetName - - - Crée un nouveau fichier xlsx et crée une feuille de calcul. - - - - - &reftitle.parameters; - - - fileName - - - Nom du fichier XLSX - - - - - sheetName - - - Nom de la feuille de calcul - - - - - - - - &reftitle.returnvalues; - - Instance de la classe Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - Exemple - - '/home/viest' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet'); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/get-handle.xml b/reference/xlswriter/xlsx-kernel/get-handle.xml deleted file mode 100644 index 6e512e8c8a..0000000000 --- a/reference/xlswriter/xlsx-kernel/get-handle.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::getHandle - Récupère le gestionnaire de ressource - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::getHandle - - - - Récupère le gestionnaire de ressource xlsx. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La ressource - - - - - &reftitle.examples; - - Exemple - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']); - -$handle = $file->getHandle(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/header.xml b/reference/xlswriter/xlsx-kernel/header.xml deleted file mode 100644 index 7c25599071..0000000000 --- a/reference/xlswriter/xlsx-kernel/header.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::header - Écrit l'en-tête d'une feuille de calcul - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::header - arrayheaderData - - - Écrit l'en-tête d'une feuille de calcul. - - - - - &reftitle.parameters; - - - headerData - - - Les données de l'en-tête de la feuille de calcul - - - - - - - - &reftitle.returnvalues; - - Instance de la classe Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - Exemple - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/insert-formula.xml b/reference/xlswriter/xlsx-kernel/insert-formula.xml deleted file mode 100644 index 19a8b5f81c..0000000000 --- a/reference/xlswriter/xlsx-kernel/insert-formula.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::insertFormula - Insère une formule - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::insertFormula - introw - intcolumn - stringformula - - - Insère une formule. - - - - - &reftitle.parameters; - - - row - - - Cellule de la ligne - - - - - column - - - Cellule de la colonne - - - - - formula - - - Chaîne de caractères représentant la formule - - - - - - - - &reftitle.returnvalues; - - Instance de la classe - Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - Exemple - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); - -$file = $excel->fileName("free.xlsx") - ->header(['name', 'money']); - -for($index = 1; $index < 10; $index++) { - $file->insertText($index, 0, 'viest'); - $file->insertText($index, 1, 10); -} - -$file->insertText(12, 0, "Total"); -$file->insertFormula(12, 1, '=SUM(B2:B11)'); // Insère la formule - -$file->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/insert-image.xml b/reference/xlswriter/xlsx-kernel/insert-image.xml deleted file mode 100644 index f608b0d553..0000000000 --- a/reference/xlswriter/xlsx-kernel/insert-image.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::insertImage - Insère une image dans une cellule - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::insertImage - introw - intcolumn - stringlocalImagePath - - - Insère une image locale dans une cellule. - - - - - &reftitle.parameters; - - - row - - - Ligne de la cellule - - - - - column - - - Colonne de la cellule - - - - - localImagePath - - - Chemin local de l'image - - - - - - - - &reftitle.returnvalues; - - Une instance de la classe - Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - example - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); - -$file = $excel->fileName("free.xlsx"); - -$file->insertImage(5, 0, '/vagrant/ASW-G-66.jpg'); - -$file->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/insert-text.xml b/reference/xlswriter/xlsx-kernel/insert-text.xml deleted file mode 100644 index 1803bfa991..0000000000 --- a/reference/xlswriter/xlsx-kernel/insert-text.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - Vtiful\Kernel\Excel::insertText - Écrit du texte dans une cellule - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::insertText - introw - intcolumn - intfloatstringdata - stringformat - - - Écrit du texte dans une cellule. - - - - - &reftitle.parameters; - - - row - - - Ligne de la cellule - - - - - column - - - Colonne de la cellule - - - - - data - - - Le texte à écrire - - - - - format - - - Une chaîne de caractères représentant le format - - - - - - - - &reftitle.returnvalues; - - Une instance de la classe - Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - Exemple - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); - -$file = $excel->fileName("free.xlsx") - ->header(['name', 'money']); - -for ($index = 0; $index < 10; $index++) { - $file->insertText($index+1, 0, 'viest'); - $file->insertText($index+1, 1, 10000, '#,##0'); -} - -$file->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/merge-cells.xml b/reference/xlswriter/xlsx-kernel/merge-cells.xml deleted file mode 100644 index c3e97c8c4e..0000000000 --- a/reference/xlswriter/xlsx-kernel/merge-cells.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::mergeCells - Fusionne des cellules - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::mergeCells - stringscope - stringdata - - - Fusionne des cellules. - - - - - &reftitle.parameters; - - - scope - - - Chaîne de caractères représentant les - coordonnées de la cellule de début - et de la cellule de fin - - - - - data - - - Les données - - - - - - - - &reftitle.returnvalues; - - Une instance de la classe - Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - Exemple - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); - -$excel->fileName("test.xlsx") - ->mergeCells('A1:C1', 'Cellules fusionnées') - ->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/output.xml b/reference/xlswriter/xlsx-kernel/output.xml deleted file mode 100644 index e232b70922..0000000000 --- a/reference/xlswriter/xlsx-kernel/output.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::output - Enregistre le fichier xlsx sur le disque - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::output - - - - Enregistre le fichier xlsx sur le disque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Chemin vers le fichier XLSX - - - - - &reftitle.examples; - - Exemple - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']) - ->data([ - ['viest', 23], - ['wjx', 23], - ]); - -$path = $file->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/set-column.xml b/reference/xlswriter/xlsx-kernel/set-column.xml deleted file mode 100644 index afc47eb54d..0000000000 --- a/reference/xlswriter/xlsx-kernel/set-column.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::setColumn - Définit le format d'une colonne - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::setColumn - stringrange - floatwidth - resourceformat - - - Définit le format d'une colonne. - - - - - &reftitle.parameters; - - - range - - - Chaîne de caractères représentant les coordonnées - de la cellule de début et de la cellule de fin - - - - - width - - - Largeur de la colonne - - - - - format - - - Une ressource de format - - - - - - - - &reftitle.returnvalues; - - Une instance de la classe - Vtiful\Kernel\Excel. - - - - - &reftitle.examples; - - Exemple de setColumn - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$boldStyle = $format->bold()->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $boldStyle) - ->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/set-row.xml b/reference/xlswriter/xlsx-kernel/set-row.xml deleted file mode 100644 index 96fa0838dd..0000000000 --- a/reference/xlswriter/xlsx-kernel/set-row.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::setRow - Définit le format d'une ligne - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::setRow - stringrange - floatheight - resourceformat - - - Définit le format d'une ligne. - - - - - &reftitle.parameters; - - - range - - - Chaîne de caractères représentant les coordonnées - de la cellule de début et de la cellule de fin - - - - - height - - - Hauteur de la ligne - - - - - format - - - Ressource de format - - - - - - - - &reftitle.returnvalues; - - Une instance de la classe - Vtiful\Kernel\Excel. - - - - - &reftitle.examples; - - Exemple de setRow - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$boldStyle = $format->bold()->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setRow('A1', 20, $boldStyle,) - ->output(); -]]> - - - - - - - diff --git a/reference/xmldiff/book.xml b/reference/xmldiff/book.xml deleted file mode 100644 index 3b617e8c24..0000000000 --- a/reference/xmldiff/book.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - XML : Différence et fusion - XMLDiff - - - &reftitle.intro; - - L'extension est capable de produire la différence de deux documents XML, - puis d'appliquer la différence au document source. La différence est - un document XML contenant les copies/insertions/suppressions dans un - format humainement lisible. Les objets DOMDocument, les fichiers locaux, - et les chaînes de caractères en mémoire peuvent être utilisés. - - - - &reference.xmldiff.setup; - - - &reference.xmldiff.xmldiff.base; - &reference.xmldiff.xmldiff.dom; - &reference.xmldiff.xmldiff.memory; - &reference.xmldiff.xmldiff.file; - - - - diff --git a/reference/xmldiff/configure.xml b/reference/xmldiff/configure.xml deleted file mode 100644 index 4743269c7f..0000000000 --- a/reference/xmldiff/configure.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - -
    - &reftitle.install; - - - Utiliser l'option - lors de la compilation de PHP. - - - - Les utilisateurs de Windows doivent inclure la bibliothèque - php_xmldiff.dll dans le fichier &php.ini;. - - -
    - - - diff --git a/reference/xmldiff/reference.xml b/reference/xmldiff/reference.xml deleted file mode 100644 index 181f86929a..0000000000 --- a/reference/xmldiff/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; Xmldiff - - - - - - diff --git a/reference/xmldiff/setup.xml b/reference/xmldiff/setup.xml deleted file mode 100644 index 50a491d8b2..0000000000 --- a/reference/xmldiff/setup.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - libdiffmark - version 0.10 est comprise dans l'extension. Si diffmark est - disponible pour le système de paquets, son utilisation est fortement - encouragée. - - extension libxml - extension DOM -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;xmldiff. - -
    - - - -     - - diff --git a/reference/xmldiff/xmldiff-base/construct.xml b/reference/xmldiff/xmldiff-base/construct.xml deleted file mode 100644 index c1ba3f3e77..0000000000 --- a/reference/xmldiff/xmldiff-base/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - XMLDiff\Base::__construct - Constructeur - - - - &reftitle.description; - - public XMLDiff\Base::__construct - stringnsname - - - Constructeur de base pour toutes les classes de l'extension xmldiff. - - - - - - &reftitle.parameters; - - - nsname - - - Espace de noms personnalisé pour le document de différence. - L'espace de noms par défaut est http://www.locus.cz/diffmark - et est suffisant pour éviter les conflits d'espaces de noms. - Utiliser ce paramètre pour changer d'espace de noms. - - - - - - - - - diff --git a/reference/xmldiff/xmldiff-base/diff.xml b/reference/xmldiff/xmldiff-base/diff.xml deleted file mode 100644 index c3de520932..0000000000 --- a/reference/xmldiff/xmldiff-base/diff.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - XMLDiff\Base::diff - Produit la différence de deux documents XML - - - - &reftitle.description; - - abstract public mixedXMLDiff\Base::diff - mixedfrom - mixedto - - - Méthode abstraite de création de différence à implémenter par héritage de la classe. - - - Le but premier de cette méthode est de produire la différence de deux - documents. L'ordre des paramètres est important, et va produire une sortie - différente. - - - - - - &reftitle.parameters; - - - from - - - Document XML source. - - - - - to - - - Document XML cible. - - - - - - - - &reftitle.returnvalues; - - Dépend de l'implémentation. - - - - - - - diff --git a/reference/xmldiff/xmldiff-base/merge.xml b/reference/xmldiff/xmldiff-base/merge.xml deleted file mode 100644 index 9748aede46..0000000000 --- a/reference/xmldiff/xmldiff-base/merge.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - XMLDiff\Base::merge - Produit un nouveau document XML basé sur une différence - - - - &reftitle.description; - - abstract public mixedXMLDiff\Base::merge - mixedsrc - mixeddiff - - - Méthode abstraite de fusion à implémenter par héritage de la classe. - - - Basiquement, le but de cette méthode est de produire un nouveau document XML - basé sur les informations de différence. - - - - - &reftitle.parameters; - - - src - - - Document XML source. - - - - - diff - - - Document produit par la méthode de création de différence. - - - - - - - - &reftitle.returnvalues; - - Dépend de l'implémentation. - - - - - - - diff --git a/reference/xmldiff/xmldiff-dom/diff.xml b/reference/xmldiff/xmldiff-dom/diff.xml deleted file mode 100644 index 3a040bd6f6..0000000000 --- a/reference/xmldiff/xmldiff-dom/diff.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - XMLDiff\DOM::diff - Trouve la différence de deux objets DOMDocument - - - - &reftitle.description; - - public DOMDocumentXMLDiff\DOM::diff - DOMDocumentfrom - DOMDocumentto - - - Trouve la différence de deux instances DOMDocument et produit un nouvel - objet DOMDocument contenant les informations de différence. - - - - - &reftitle.parameters; - - - from - - - Objet source DOMDocument. - - - - - to - - - Objet cible DOMDocument. - - - - - - - - &reftitle.returnvalues; - - Un nouvel objet DOMDocument contenant les informations de différence ou NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-dom/merge.xml b/reference/xmldiff/xmldiff-dom/merge.xml deleted file mode 100644 index 6d1bc433be..0000000000 --- a/reference/xmldiff/xmldiff-dom/merge.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - XMLDiff\DOM::merge - Produit un DOMDocument fusionné - - - - &reftitle.description; - - public DOMDocumentXMLDiff\DOM::merge - DOMDocumentsrc - DOMDocumentdiff - - - Crée un nouveau DOMDocument basé sur une différence. - - - - - &reftitle.parameters; - - - src - - - Objet DOMDocument source. - - - - - diff - - - L'objet DOMDocument contenant les informations de différence. - - - - - - - - &reftitle.returnvalues; - - DOMDocument fusionné ou NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-file/diff.xml b/reference/xmldiff/xmldiff-file/diff.xml deleted file mode 100644 index a82faf932e..0000000000 --- a/reference/xmldiff/xmldiff-file/diff.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - XMLDiff\File::diff - Effectue la différence entre deux documents XML - - - - &reftitle.description; - - public stringXMLDiff\File::diff - stringfrom - stringto - - - Effectue la différence entre deux documents XML locaux, et produit une chaîne - contenant les informations de différence. - - - - - &reftitle.parameters; - - - from - - - Chemin vers le document source. - - - - - to - - - Chemin vers le document cible. - - - - - - - - &reftitle.returnvalues; - - Une chaîne contenant la différence des deux documents XML ou NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-file/merge.xml b/reference/xmldiff/xmldiff-file/merge.xml deleted file mode 100644 index 1d716eda17..0000000000 --- a/reference/xmldiff/xmldiff-file/merge.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - XMLDiff\File::merge - Fusionne un document XML - - - - &reftitle.description; - - public stringXMLDiff\File::merge - stringsrc - stringdiff - - - Crée un document XML basé sur des différences et sur le document source. - - - - - &reftitle.parameters; - - - src - - - Chemin vers le document XML source. - - - - - diff - - - Chemin vers le document XML contenant les informations de différence. - - - - - - - - &reftitle.returnvalues; - - Une chaîne de caractères représentant le nouveau document XML ou NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-memory/diff.xml b/reference/xmldiff/xmldiff-memory/diff.xml deleted file mode 100644 index 88a098ee03..0000000000 --- a/reference/xmldiff/xmldiff-memory/diff.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - XMLDiff\Memory::diff - Différence entre deux documents XML - - - - &reftitle.description; - - public stringXMLDiff\Memory::diff - stringfrom - stringto - - - Effectue la différence de deux chaînes contenant des documents XML et produit - les informations de différence. - - - - - &reftitle.parameters; - - - from - - - Document XML source. - - - - - to - - - Document XML cible. - - - - - - - - &reftitle.returnvalues; - - Une chaîne contenant la différence entre les deux documents XML ou NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-memory/merge.xml b/reference/xmldiff/xmldiff-memory/merge.xml deleted file mode 100644 index 1e8501f8e5..0000000000 --- a/reference/xmldiff/xmldiff-memory/merge.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - XMLDiff\Memory::merge - Fusionne un document XML - - - - &reftitle.description; - - public stringXMLDiff\Memory::merge - stringsrc - stringdiff - - - Crée un nouveau document XML basé sur les différences et le document source. - - - - - &reftitle.parameters; - - - src - - - Document XML source. - - - - - diff - - - Document XML contenant les informations de différence. - - - - - - - - &reftitle.returnvalues; - - Une chaîne contenant le nouveau document XML ou NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff.base.xml b/reference/xmldiff/xmldiff.base.xml deleted file mode 100644 index 310ee2f3ec..0000000000 --- a/reference/xmldiff/xmldiff.base.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - La classe XMLDiff\Base - XMLDiff\Base - - - - -
    - &reftitle.intro; - - Classe abstraite de base pour toutes les classes de comparaison - de cette extension. - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\Base - - - - - XMLDiff\Base - - - - - &Methods; - - - - - - - - - -
    - -     - - &reference.xmldiff.entities.xmldiff-base; - -     - - diff --git a/reference/xmldiff/xmldiff.dom.xml b/reference/xmldiff/xmldiff.dom.xml deleted file mode 100644 index 81151a32a9..0000000000 --- a/reference/xmldiff/xmldiff.dom.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - La classe XMLDiff\DOM - XMLDiff\DOM - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\DOM - - - - - XMLDiff\DOM - - - - extends - XMLDiff\Base - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.xmldiff.entities.xmldiff-dom; - -     - - diff --git a/reference/xmldiff/xmldiff.exception.xml b/reference/xmldiff/xmldiff.exception.xml deleted file mode 100644 index a3568d92d1..0000000000 --- a/reference/xmldiff/xmldiff.exception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - La classe XMLDiff\Exception - XMLDiff\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\Exception - - - - - XMLDiff\Exception - - - - extends - Exception - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - -
    - -     - - -     - - diff --git a/reference/xmldiff/xmldiff.file.xml b/reference/xmldiff/xmldiff.file.xml deleted file mode 100644 index b47ecae912..0000000000 --- a/reference/xmldiff/xmldiff.file.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - La classe XMLDiff\File - XMLDiff\File - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\File - - - - - XMLDiff\File - - - - extends - XMLDiff\Base - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.xmldiff.entities.xmldiff-file; - -     - - diff --git a/reference/xmldiff/xmldiff.memory.xml b/reference/xmldiff/xmldiff.memory.xml deleted file mode 100644 index 74e29b4308..0000000000 --- a/reference/xmldiff/xmldiff.memory.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - La classe XMLDiff\Memory - XMLDiff\Memory - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\Memory - - - - - XMLDiff\Memory - - - - extends - XMLDiff\Base - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.xmldiff.entities.xmldiff-memory; - -     - - diff --git a/reference/xmlrpc/book.xml b/reference/xmlrpc/book.xml deleted file mode 100644 index 61e16d0607..0000000000 --- a/reference/xmlrpc/book.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - XML-RPC - - - - &reftitle.intro; - - Ces fonctions servent à écrire des serveurs et des clients XML-RPC. - Il est possible de trouver plus - d'informations sur XML-RPC sur - &url.xmlrpc;, et plus de - documentation sur cette extension et ses fonctions, sur - &url.xmlrpc-epi;. - - &warn.experimental; - - - - &reference.xmlrpc.setup; - &reference.xmlrpc.reference; - - - - - diff --git a/reference/xmlrpc/configure.xml b/reference/xmlrpc/configure.xml deleted file mode 100644 index 5b7783b48a..0000000000 --- a/reference/xmlrpc/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - -
    - &reftitle.install; - - Le support de XML-RPC n'est pas activé par défaut en PHP. - Il faut l'activer avec l'option de compilation - . - -
    - - diff --git a/reference/xmlrpc/functions/xmlrpc-decode-request.xml b/reference/xmlrpc/functions/xmlrpc-decode-request.xml deleted file mode 100644 index dea57ebce1..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-decode-request.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - - xmlrpc_decode_request - Décode le XML en types PHP natifs - - - &reftitle.description; - - mixedxmlrpc_decode_request - stringxml - stringmethod - stringencoding - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-decode.xml b/reference/xmlrpc/functions/xmlrpc-decode.xml deleted file mode 100644 index 19ecd82260..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-decode.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - xmlrpc_decode - Décode le XML en types PHP natifs - - - &reftitle.description; - - mixedxmlrpc_decode - stringxml - stringencoding"iso-8859-1" - - &warn.experimental.func; - - - - &reftitle.parameters; - - - - xml - - - Réponse XML retournée par la méthode XMLRPC. - - - - - encoding - - - Encodage d'entrée, supporté par iconv. - - - - - - - - - &reftitle.returnvalues; - - Retourne soit un tableau, soit un entier, soit une chaîne, soit un booléen, - en fonction de la réponse retournée par la méthode XMLRPC. - - - - - &reftitle.examples; - - Voir l'exemple fourni avec la documentation de la fonction - xmlrpc_encode_request. - - - - - &reftitle.seealso; - - - xmlrpc_encode_request - xmlrpc_is_fault - - - - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-encode-request.xml b/reference/xmlrpc/functions/xmlrpc-encode-request.xml deleted file mode 100644 index f5533621e7..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-encode-request.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - xmlrpc_encode_request - Génère le XML pour une requête de méthode - - - &reftitle.description; - - stringxmlrpc_encode_request - stringmethod - mixedparams - arrayoutput_options - - &warn.experimental.func; - - - - &reftitle.parameters; - - - - method - - - Nom de la méthode à appeler. - - - - - params - - - Paramètres de la méthode, compatibles avec la signature de la méthode. - - - - - output_options - - - Tableau spécifiant les options de sortie pouvant contenir (les valeurs - par défaut sont en gras) : - - output_type: php, xml - verbosity: no_white_space, newlines_only, pretty - escaping: cdata, non-ascii, non-print, markup - (peut être une chaîne avec une valeur ou un tableau avec plusieurs valeurs) - version: simple, xmlrpc, soap 1.1, auto - encoding: iso-8859-1, autres jeux de caractères supportés par iconv - - - - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne contenant la représentation XML de la demande. - - - - - &reftitle.examples; - - - Exemple avec XMLRPC - - [ - 'method' => "POST", - 'header' => "Content-Type: text/xml", - 'content' => $request, - ] -]); -$file = file_get_contents("http://www.example.com/xmlrpc", false, $context); -$response = xmlrpc_decode($file); -if ($response && xmlrpc_is_fault($response)) { - trigger_error("xmlrpc: $response[faultString] ($response[faultCode])"); -} else { - print_r($response); -} -?> -]]> - - - - - - - &reftitle.seealso; - - - stream_context_create - file_get_contents - xmlrpc_decode - - - - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-encode.xml b/reference/xmlrpc/functions/xmlrpc-encode.xml deleted file mode 100644 index 2ab3670730..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-encode.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - xmlrpc_encode - Génère le code XML pour une valeur PHP - - - &reftitle.description; - - stringxmlrpc_encode - mixedvalue - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-get-type.xml b/reference/xmlrpc/functions/xmlrpc-get-type.xml deleted file mode 100644 index db490ad062..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-get-type.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - xmlrpc_get_type - Retourne le type XMLRPC d'une valeur PHP - - - &reftitle.description; - - stringxmlrpc_get_type - mixedvalue - - &warn.experimental.func; - - Particulièrement pratique pour les types chaînes de type - base64 et datetime. - - - - - &reftitle.parameters; - - - - value - - - Valeur PHP - - - - - - - - - &reftitle.returnvalues; - - Retourne le type XML-RPC. - - - - - &reftitle.examples; - - - Exemple de type XML-RPC - - -]]> - - - - - - - &reftitle.seealso; - - - xmlrpc_set_type - - - - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-is-fault.xml b/reference/xmlrpc/functions/xmlrpc-is-fault.xml deleted file mode 100644 index 9c6e1c977f..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-is-fault.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - xmlrpc_is_fault - Détermine si la valeur d'un tableau représente une erreur XMLRPC - - - &reftitle.description; - - boolxmlrpc_is_fault - arrayarg - - &warn.experimental.func; - - - - &reftitle.parameters; - - - - arg - - - Tableau retourné par la fonction - xmlrpc_decode. - - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si l'argument signifie fault, - &false; sinon. La description de fault - est disponible dans la variable $arg["faultString"], - le code de fault est disponible dans la variable - $arg["faultCode"]. - - - - - &reftitle.examples; - - Retrouvez un exemple avec la fonction - xmlrpc_encode_request. - - - - - &reftitle.seealso; - - - xmlrpc_decode - - - - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-parse-method-descriptions.xml b/reference/xmlrpc/functions/xmlrpc-parse-method-descriptions.xml deleted file mode 100644 index 258a9ed879..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-parse-method-descriptions.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - xmlrpc_parse_method_descriptions - Décode le code XML en une liste de descriptions de méthodes - - - &reftitle.description; - - arrayxmlrpc_parse_method_descriptions - stringxml - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-add-introspection-data.xml b/reference/xmlrpc/functions/xmlrpc-server-add-introspection-data.xml deleted file mode 100644 index 35d8518250..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-add-introspection-data.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - xmlrpc_server_add_introspection_data - Ajoute de la documentation d'introspection - - - &reftitle.description; - - intxmlrpc_server_add_introspection_data - resourceserver - arraydesc - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-call-method.xml b/reference/xmlrpc/functions/xmlrpc-server-call-method.xml deleted file mode 100644 index a79c825d0f..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-call-method.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - xmlrpc_server_call_method - Analyse une requête XML et appelle les méthodes associées - - - &reftitle.description; - - stringxmlrpc_server_call_method - resourceserver - stringxml - mixeduser_data - arrayoutput_options - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-create.xml b/reference/xmlrpc/functions/xmlrpc-server-create.xml deleted file mode 100644 index be8f2bbede..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-create.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - xmlrpc_server_create - Crée un serveur XMLRPC - - - &reftitle.description; - - resourcexmlrpc_server_create - - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-destroy.xml b/reference/xmlrpc/functions/xmlrpc-server-destroy.xml deleted file mode 100644 index 7ab688c6ab..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-destroy.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - xmlrpc_server_destroy - Détruit les ressources du serveur - - - &reftitle.description; - - boolxmlrpc_server_destroy - resourceserver - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-register-introspection-callback.xml b/reference/xmlrpc/functions/xmlrpc-server-register-introspection-callback.xml deleted file mode 100644 index fead4f6eb3..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-register-introspection-callback.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - xmlrpc_server_register_introspection_callback - Enregistre une fonction PHP pour générer la documentation - - - &reftitle.description; - - boolxmlrpc_server_register_introspection_callback - resourceserver - stringfunction - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-register-method.xml b/reference/xmlrpc/functions/xmlrpc-server-register-method.xml deleted file mode 100644 index 0b60d6ddcd..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-register-method.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - - xmlrpc_server_register_method - Associe une fonction PHP à la méthode XMLRPC correspondant à method_name - - - &reftitle.description; - - boolxmlrpc_server_register_method - resourceserver - stringmethod_name - stringfunction - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-set-type.xml b/reference/xmlrpc/functions/xmlrpc-set-type.xml deleted file mode 100644 index c2522db48f..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-set-type.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - - xmlrpc_set_type - Définit le type xmlrpc, base64 ou datetime, d'une valeur PHP - - - &reftitle.description; - - boolxmlrpc_set_type - stringvalue - stringtype - - - xmlrpc_set_type définit le type XMLRPC, - base64 ou datetime, pour une - chaîne PHP. - - &warn.experimental.func; - - - - &reftitle.parameters; - - - - value - - - Valeur dont on veut modifier le type - - - - - type - - - base64 ou datetime - - - - - - - - - &reftitle.returnvalues; - - &return.success; - En cas de réussite, value sera converti en objet. - - - - - &reftitle.errors; - - Émet une alerte de type E_WARNING lorsque le type - n'est pas supporté par XMLRPC. - - - - - &reftitle.examples; - - - Exemple avec <function>xmlrpc_set_type</function> - - - - -]]> - - &example.outputs.similar; - - - - - - 20090322T23:43:03 - - - -]]> - - - - - - - - diff --git a/reference/xmlrpc/reference.xml b/reference/xmlrpc/reference.xml deleted file mode 100644 index 35cb198fd4..0000000000 --- a/reference/xmlrpc/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; XML-RPC - -&reference.xmlrpc.entities.functions; - - - - diff --git a/reference/xmlrpc/setup.xml b/reference/xmlrpc/setup.xml deleted file mode 100644 index 03b8e5e7d6..0000000000 --- a/reference/xmlrpc/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - &libxml.required; -
    - - - - &reference.xmlrpc.configure; - - - -
    - &reftitle.resources; - - Cette extension définit une ressource serveur XML-RPC, retournée par la - fonction xmlrpc_server_create. - -
    - - -     - - - diff --git a/reference/xpass/book.xml b/reference/xpass/book.xml deleted file mode 100644 index bbdf5e7260..0000000000 --- a/reference/xpass/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - Xpass - Xpass - - - &reftitle.intro; - - Cette extension apporte des algorithmes de hachage de mots de passe utilisés par les distributions - Linux, en utilisant la bibliothèque crypt étendue. - - - Elle fournit également des fonctions supplémentaires de libxcrypt manquantes dans PHP. - - - - &reference.xpass.setup; - &reference.xpass.constants; - &reference.xpass.reference; - - - diff --git a/reference/xpass/constants.xml b/reference/xpass/constants.xml deleted file mode 100644 index dbb55c41e3..0000000000 --- a/reference/xpass/constants.xml +++ /dev/null @@ -1,338 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - L'extension Xpass fournit divers ensembles de constantes. - Méthodes de hachage (CRYPT_PREFIX_*) pour le - paramètre prefix de crypt_gensalt. - Codes d'erreur (CRYPT_SALT_*) retournés par - crypt_checksalt. - Algorithmes de mot de passe (PASSWORD_*) pour le - paramètre algo de password_hash. - - - - Méthodes de hachage - - - CRYPT_PREFIX_STD_DES - (string) - - - - La méthode de hachage originale de Unix V7, basée sur le chiffrement par bloc DES. - Étant donné que DES est peu coûteux sur le matériel moderne, - qu'il n'y a que 4096 sels possibles et 2**56 passphrases distinctes, - qui sont tronquées à 8 caractères, - il est possible de trouver n'importe quel mot de passe haché avec cette méthode. - Elle ne devrait être utilisée que pour supporter les anciens systèmes d'exploitation - qui ne supportent aucun autre algorithme de génération de hachage, en raison de la faiblesse des hachages DES. - - - - - - CRYPT_PREFIX_EXT_DES - (string) - - - - Une extension du DES traditionnel, qui élimine la limite de longueur, - augmente la taille du sel et rend le coût temporel réglable. - Elle provient de BSDI BSD/OS et est également disponible sur au moins NetBSD, - OpenBSD et FreeBSD en raison de l'utilisation de la bibliothèque FreeSec de David Burren. - Elle est bien meilleure que les hachages DES traditionnels et bigcrypt, - mais ne devrait toujours pas être utilisée pour de nouveaux hachages. - - - - - - CRYPT_PREFIX_MD5 - (string) - - - - Un hachage basé sur l'algorithme MD5, développé à l'origine par Poul-Henning Kamp pour FreeBSD. - Supporté sur la plupart des Unix libres et les versions plus récentes de Solaris. - Pas aussi faible que les hachages basés sur DES ci-dessous, - mais MD5 est si peu coûteux sur le matériel moderne qu'il ne devrait pas être utilisé pour de nouveaux hachages. - Le coût de traitement n'est pas ajustable. - - - - - - CRYPT_PREFIX_BLOWFISH - (string) - - - - Un hachage basé sur le chiffrement par bloc Blowfish, modifié pour avoir un calendrier de clés extra-coûteux. - Développé à l'origine par Niels Provos et David Mazieres pour OpenBSD et également supporté sur les versions récentes - de FreeBSD et NetBSD, sur Solaris 10 et plus récent, et sur plusieurs distributions GNU/*/Linux. - - - - - - CRYPT_PREFIX_SHA256 - (string) - - - - Un hachage basé sur SHA-2 avec une sortie de 256 bits, développé à l'origine par Ulrich Drepper pour GNU libc. - Supporté sur Linux mais pas courant ailleurs. - Acceptable pour de nouveaux hachages. - Le paramètre de coût de traitement par défaut est 5000, - ce qui est trop faible pour le matériel moderne. - - - - - - CRYPT_PREFIX_SHA512 - (string) - - - - Un hachage basé sur SHA-2 avec une sortie de 512 bits, développé à l'origine par Ulrich Drepper pour GNU libc. - Supporté sur Linux mais pas courant ailleurs. - Acceptable pour de nouveaux hachages. - Le paramètre de coût de traitement par défaut est 5000, - ce qui est trop faible pour le matériel moderne. - - - - - - CRYPT_PREFIX_SCRYPT - (string) - - - - Scrypt est une fonction de dérivation de clé basée sur un mot de passe créée par Colin Percival, - à l'origine pour le service de sauvegarde en ligne Tarsnap. - L'algorithme a été spécifiquement conçu pour rendre coûteux les attaques matérielles - personnalisées à grande échelle en nécessitant de grandes quantités de mémoire. - En 2016, l'algorithme scrypt a été publié par l'IETF en tant que RFC 7914. - - - - - - CRYPT_PREFIX_GOST_YESCRYPT - (string) - - - - Gost-yescrypt utilise la sortie de yescrypt comme message d'entrée pour HMAC avec - la fonction de hachage GOST R 34.11-2012 (Streebog) avec un digest de 256 bits. - Ainsi, les propriétés cryptographiques de yescrypt sont supplantées par celles de la fonction de hachage GOST. - Cette méthode de hachage est utile dans les applications qui nécessitent un hachage de mot de passe moderne, - mais doivent s'appuyer sur des algorithmes GOST. - La fonction de hachage GOST R 34.11-2012 (Streebog) a été publiée par l'IETF en tant que RFC 6986. - Acceptable pour de nouveaux hachages si nécessaire. - - - - - - CRYPT_PREFIX_YESCRYPT - (string) - - - - Yescrypt est un schéma de hachage de mot de passe évolutif conçu par Solar Designer, - qui est basé sur le scrypt de Colin Percival. - Bien que la force de yescrypt contre les attaques de devinettes de mot de passe provienne de sa conception d'algorithme, - sa sécurité cryptographique est garantie par son utilisation de SHA-256 sur la couche externe. - La fonction de hachage SHA-256 a été publiée par le NIST dans le FIPS PUB 180-2 - (et ses révisions ultérieures telles que le FIPS PUB 180-4) et par l'IETF en tant que RFC 4634 - (et par la suite RFC 6234). - Recommandé pour de nouveaux hachages. - - - - - - CRYPT_PREFIX_SM3CRYPT - (string) - - - - Un hachage basé sur la fonction de hachage ShangMi 3 avec une sortie de 256 bits, - qui utilise le même design que sha256crypt et/ou sha512crypt. - Supporté sur EulerOS, Kylin, openEuler et openKylin, mais pas courant - ailleurs. Acceptable pour de nouveaux hachages si nécessaire. Le paramètre - de coût de traitement par défaut est 5000, ce qui est trop faible pour le matériel moderne. - - - Disponible à partir de 1.2.0 avec libcxcrypt >= 4.5.0. - - - - - - CRYPT_PREFIX_SM3_YESCRYPT - (string) - - - - Sm3-yescrypt utilise la sortie de yescrypt comme message d'entrée pour HMAC - avec la fonction de hachage ShangMi 3 avec un digest de 256 bits. Ainsi, les propriétés - cryptographiques de yescrypt sont supplantées par celles de la fonction de hachage ShangMi 3. - Cette méthode de hachage est utile dans les applications qui nécessitent un hachage de - mot de passe moderne, mais doivent s'appuyer sur des algorithmes approuvés par le Bureau - chinois de l'administration de la cryptographie commerciale d'État (OSCCA). La fonction - de hachage ShangMi 3 a été publiée dans la partie 3 : "Fonctions de hachage dédiées" - de la norme ISO/IEC 10118-3:2018. Acceptable pour de nouveaux hachages si nécessaire. - - - Disponible à partir de 1.2.0 avec libcxcrypt >= 4.5.0. - - - - - - - Code d'erreur - - - CRYPT_SALT_OK - (int) - - - - Pas d'erreur. - - - - - - CRYPT_SALT_INVALID - (int) - - - - Méthode de hachage inconnue ou paramètres invalides. - - - - - - CRYPT_SALT_METHOD_DISABLED - (int) - - - - Méthode de hachage n'est plus autorisée à être utilisée. - - - - - - CRYPT_SALT_METHOD_LEGACY - (int) - - - - Méthode de hachage n'est plus considérée comme suffisamment forte. - - - - - - CRYPT_SALT_TOO_CHEAP - (int) - - - - Coût des paramètres considéré comme trop faible. - - - - - - - Algorithme de mot de passe - - - PASSWORD_SHA512 - (string) - - - - PASSWORD_SHA512 est utilisé pour créer de nouveaux hachages - de mot de passe en utilisant l'algorithme CRYPT_PREFIX_SHA512. - - - - - - PASSWORD_YESCRYPT - (string) - - - - PASSWORD_YESCRYPT est utilisé pour créer de nouveaux hachages - de mot de passe en utilisant l'algorithme CRYPT_PREFIX_YESCRYPT. - - - - - - PASSWORD_SM3CRYPT - (string) - - - - PASSWORD_SM3CRYPT est utilisé pour créer de nouveaux hachages - de mot de passe en utilisant l'algorithme CRYPT_PREFIX_SM3CRYPT. - - - Disponible à partir de 1.2.0 avec libcxcrypt >= 4.5.0. - - - - - - PASSWORD_SM3_YESCRYPT - (string) - - - - PASSWORD_SM3_YESCRYPT est utilisé pour créer de nouveaux hachages - de mot de passe en utilisant l'algorithme CRYPT_PREFIX_SM3_YESCRYPT. - - - Disponible à partir de 1.2.0 avec libcxcrypt >= 4.5.0. - - - - - - diff --git a/reference/xpass/functions/crypt-checksalt.xml b/reference/xpass/functions/crypt-checksalt.xml deleted file mode 100644 index 43a515ca57..0000000000 --- a/reference/xpass/functions/crypt-checksalt.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - crypt_checksalt - Valide un paramètre de hachage de mot de passe - - - - &reftitle.description; - - stringnullcrypt_checksalt - stringsalt - - - Vérifie si la chaîne de sel est conforme à la configuration système et signale si - la méthode de hachage et les paramètres qu'elle spécifie sont acceptables. - Il est destiné à être utilisé pour déterminer si le mot de passe de l'utilisateur doit être re-haché - en utilisant la méthode de hachage actuellement préférée. - - - - - &reftitle.parameters; - - - salt - - - La chaîne de sel à vérifier. - - - - - - - - &reftitle.returnvalues; - - Renvoie une des constantes - CRYPT_SALT_* - en tant qu'int. - - - - - &reftitle.examples; - - Un exemple de <function>crypt_checksalt</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - crypt_gensalt - - - - - diff --git a/reference/xpass/functions/crypt-gensalt.xml b/reference/xpass/functions/crypt-gensalt.xml deleted file mode 100644 index df92adb117..0000000000 --- a/reference/xpass/functions/crypt-gensalt.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - crypt_gensalt - Compile une chaîne pour utilisation comme argument de sel pour crypt - - - - &reftitle.description; - - stringnullcrypt_gensalt - stringprefix&null; - intcount0 - - - Compile une chaîne pour utilisation comme argument de sel pour crypt. - - - - - &reftitle.parameters; - - - prefix - - - La méthode de hachage à utiliser. - Une des constantes CRYPT_PREFIX_*. - Si &null;, la meilleure méthode de hachage disponible sera sélectionnée. - - - - - count - - - Contrôle le coût de traitement du hachage ; - la plage valide et la signification exacte de count dépendent de la méthode de hachage, - mais des nombres plus grands correspondent à des hachages plus coûteux en - termes de temps CPU et éventuellement d'utilisation de mémoire. - Si count est 0, un coût par défaut faible sera sélectionné. - - - - - - - - &reftitle.returnvalues; - - Renvoie une chaîne avec le paramètre, ou &null; en cas d'erreur. - - - - - &reftitle.examples; - - Un exemple de <function>crypt_gensalt</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - crypt_preferred_method - crypt - hash_equals - - - - - diff --git a/reference/xpass/functions/crypt-preferred-method.xml b/reference/xpass/functions/crypt-preferred-method.xml deleted file mode 100644 index 0b05e14a46..0000000000 --- a/reference/xpass/functions/crypt-preferred-method.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - crypt_preferred_method - Renvoie le préfixe de la méthode de hachage préférée - - - - &reftitle.description; - - stringnullcrypt_preferred_method - - - - Renvoie le préfixe de la méthode de hachage préférée. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie une chaîne avec le préfixe, ou &null; en cas d'erreur. - - - - - &reftitle.examples; - - Un exemple de <function>crypt_preferred_method</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - crypt_gensalt - - - - - diff --git a/reference/xpass/reference.xml b/reference/xpass/reference.xml deleted file mode 100644 index 701903ef25..0000000000 --- a/reference/xpass/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &Functions; Xpass - - &reference.xpass.entities.functions; - - - diff --git a/reference/xpass/setup.xml b/reference/xpass/setup.xml deleted file mode 100644 index 6e7f7af674..0000000000 --- a/reference/xpass/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Cette extension nécessite - libxcrypt - version 4.4 ou supérieure. - -
    - -
    - Installation via PECL - - &pecl.info; - &url.pecl.package;xpass. - -
    - -     - diff --git a/reference/yac/book.xml b/reference/yac/book.xml deleted file mode 100644 index 6fb5aff320..0000000000 --- a/reference/yac/book.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Yac - Yac - - - &reftitle.intro; - - Yac (Yet Another Cache) est un cache de données utilisateur en mémoire - partagée, sans verrou, pouvant être utilisé pour remplacer APC ou un - memcached local. - - - Yac stocke les données en mémoire partagée, ce qui les rend visibles par - chaque worker PHP de la même machine sans aucune communication - inter-processus. Au lieu de verrous, Yac repose sur des mises à jour - atomiques de slots et quelques sondes de collision, ce qui signifie qu'un - défaut de cache ne bloque jamais une requête, et qu'une écriture - concurrente peut au pire provoquer un échec de stockage ou une lecture - ratée que l'appelant peut simplement réessayer. - - - Sans verrou ni communication inter-processus dans le chemin d'accès, - une lecture est essentiellement une recherche dans une table de hachage - en mémoire partagée. Yac est ainsi extrêmement rapide, avec une latence - de lecture à la microseconde, et son débit peut s'adapter au nombre de - workers tant que les écritures sont réparties sur plusieurs clés ; voir les - tests de performance. - - - Parce que Yac échange des garanties de cohérence contre vitesse et - débit, il convient mieux aux données coûteuses à produire mais faciles à - recréer : fragments de page, instantanés de configuration, petites - réponses de service et autres caches locaux. Il ne doit pas être utilisé - comme stockage faisant autorité pour des données irremplaçables. - - - Depuis yac 2.4.0, les petites valeurs scalaires — - NULL, booléens, la plupart des entiers (ceux qui - tiennent sur 60 bits signés dans une compilation 64 bits), chaînes jusqu'à - 7 octets et tableaux vides — sont stockées directement dans le slot de - la table de hachage plutôt que dans un bloc de valeur séparé - (« valeurs intégrées »), ce qui supprime l'allocation et la copie de - bloc à chaque accès et améliore significativement les performances tout - en réduisant l'utilisation mémoire. La version 2.4.0 a également - remplacé le moteur de compression FastLZ par LZ4, rendant les lectures - compressées plusieurs fois plus rapides. - - - - La mémoire partagée n'est visible qu'au sein d'une seule machine. Pour - partager un cache entre plusieurs serveurs, utiliser un cache réseau tel - que Memcached ou Redis. - - - - - &reference.yac.setup; - &reference.yac.memory; - &reference.yac.constants; - - &reference.yac.yac; - - - - diff --git a/reference/yac/constants.xml b/reference/yac/constants.xml deleted file mode 100644 index be89ed13c6..0000000000 --- a/reference/yac/constants.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - YAC_VERSION - (string) - - - - La version de l'extension, sous forme de chaîne. - - - - - - YAC_MAX_KEY_LEN - (int) - - - - Longueur maximale d'une clé, en octets : 48. Un préfixe d'instance est - décompté de cette limite. - - - - - - YAC_MAX_VALUE_RAW_LEN - (int) - - - - Longueur maximale d'une valeur avant sérialisation, en octets : - 67 108 863 ((1 << 26) - 1). Les valeurs plus - grandes sont rejetées. - - - - - - YAC_MAX_RAW_COMPRESSED_LEN - (int) - - - - Taille maximale d'une entrée stockée, en octets : 1 048 576 (1M). Les - valeurs qui n'y tiennent pas, même compressées, sont rejetées. - - - - - - YAC_SERIALIZER_PHP - (int) - - - - Utilise le format serialize de PHP comme sérialisateur (par défaut). - - - - - - YAC_SERIALIZER_JSON - (int) - - - - Utilise JSON comme sérialisateur. Nécessite que l'extension soit - compilée avec . - - - - - - YAC_SERIALIZER_IGBINARY - (int) - - - - Utilise igbinary comme sérialisateur. Nécessite que l'extension soit - compilée avec . - - - - - - YAC_SERIALIZER_MSGPACK - (int) - - - - Utilise msgpack comme sérialisateur. Nécessite que l'extension soit - compilée avec . - - - - - - YAC_SERIALIZER - (string) - - - - Le sérialisateur actuellement utilisé par l'extension. - - - - - - - - diff --git a/reference/yac/ini.xml b/reference/yac/ini.xml deleted file mode 100644 index 0623bc1f7b..0000000000 --- a/reference/yac/ini.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Yac &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yac.compress_threshold - 4K - INI_SYSTEM - - - - yac.debug - 0 - INI_ALL - - - - yac.enable - 1 - INI_SYSTEM - - - - yac.enable_cli - 0 - INI_SYSTEM - - - - yac.keys_memory_size - 8M - INI_SYSTEM - - - - yac.serializer - php - INI_SYSTEM - - - - yac.values_memory_size - 64M - INI_SYSTEM - - - - -
    -     - - &ini.descriptions.title; - - - - - - yac.compress_threshold - int - - - - Les valeurs sérialisées plus grandes que ce nombre d'octets sont - compressées (avec LZ4, depuis Yac 2.4.0) avant d'être stockées. - Les valeurs au delà de la limite de 1M par entrée - stockée (YAC_MAX_RAW_COMPRESSED_LEN) sont - toujours compressées, quel que soit ce réglage, car elles ne peuvent - pas être stockées non compressées. La valeur par défaut de - 4K active la compression ; -1 - la désactive pour les valeurs en deçà de la limite par entrée - stockée, et les autres valeurs positives sont ramenées dans - l'intervalle 1024..1M. - Compresser les grandes valeurs économise de la mémoire partagée au - coût de quelques cycles CPU lors du stockage et de la récupération. - - - - - - yac.debug - int - - - - Réservé au débogage. À partir de Yac 2.4.0, cette directive est - enregistrée mais n'a aucun effet. - - - - - - yac.enable - int - - - - Si Yac est activé. Si désactivé, créer une instance de - Yac lance une exception. - - - - - - yac.enable_cli - int - - - - Si Yac est activé lors de l'exécution sous le SAPI - CLI. Désactivé par défaut car les scripts en - ligne de commande démarrent et s'arrêtent immédiatement, et le - segment de mémoire partagée serait créé inutilement. - - - - - - yac.keys_memory_size - string - - - - Quantité de mémoire partagée pour la table des clés. Elle plafonne le - nombre d'entrées pouvant exister simultanément : la valeur par défaut - de 8M autorise environ 65 536 entrées. L'augmenter - lorsque le taux de succès baisse et que kicks - grimpe ; voir pour le - comportement d'une table pleine et les cas où cela importe vraiment. - - - - - - yac.values_memory_size - string - - - - Quantité de mémoire partagée pour le stockage des valeurs. Les valeurs - sont allouées par un allocateur linéaire sur des segments de 4M - chacun ; lorsqu'aucun segment n'a de place pour une nouvelle valeur, - le curseur d'allocation repart au début et les valeurs les plus - anciennes sont silencieusement écrasées (« recyclées »). Leurs - lectures se dégradent alors en défauts de cache, détectés par un - contrôle d'intégrité. Augmenter cette valeur si - recycles grimpe alors que les slots ont encore de - la place, ou activer - yac.compress_threshold - pour réduire les grandes charges utiles. Voir - . - - - - - - yac.serializer - string - - - - Sérialisateur utilisé pour transformer les valeurs PHP arbitraires - en octets avant de les stocker. Les valeurs autorisées sont - php (la valeur par défaut), - json, igbinary et - msgpack. Les trois derniers nécessitent que - l'extension soit compilée avec le support correspondant. Les - sérialisateurs binaires tels que igbinary et - msgpack sont généralement plus rapides et - produisent des données plus compactes que php. - - - - - - -
    - - diff --git a/reference/yac/memory.xml b/reference/yac/memory.xml deleted file mode 100644 index 96e4d4a516..0000000000 --- a/reference/yac/memory.xml +++ /dev/null @@ -1,258 +0,0 @@ - - - - - Gestion de la mémoire - - - Yac conserve ses données dans deux réservoirs de mémoire partagée - indépendants, configurés par - yac.keys_memory_size - et - yac.values_memory_size. - Ils se remplissent et se libèrent différemment, il est donc utile de savoir - à quel réservoir se rattache un symptôme avant de toucher à l'un ou l'autre - réglage. - - -
    - Ce que contient chaque réservoir - - Les deux réservoirs stockent chacun une moitié d'une entrée. Le réservoir - de clés contient les clés : un slot par clé mise en cache, portant la clé - elle-même (jusqu'à 48 octets) accompagnée de son hachage, de son TTL, de - son nombre de succès et de sa date de dernier accès ; la valeur n'est - référencée que par un pointeur vers le réservoir de valeurs. Le réservoir - de valeurs contient les valeurs : chaque valeur stockée occupe un bloc - d'octets sérialisés — sa forme compressée lorsque l'entrée est passée par - yac.compress_threshold. - - - La seule exception est celle des valeurs intégrées : les petits scalaires - — &null;, &true;, &false;, la plupart des entiers (ceux qui tiennent sur - 60 bits signés dans une compilation 64 bits), les chaînes jusqu'à 7 octets - et les tableaux vides — sont stockés directement dans le slot, dans le - pointeur qui référencerait autrement un bloc. De telles valeurs - n'occupent aucune place dans le réservoir de valeurs ; seule leur clé en - occupe. - - - Pour un dimensionnement approximatif : - - - - le réservoir de clés contient environ 8 000 clés par Mo ; dimensionner - yac.keys_memory_size - comme le nombre de clés distinctes divisé par 8 000 par Mo, arrondi au - supérieur — la valeur par défaut de 8M contient - environ 64 000 clés ; - - - - - le réservoir de valeurs doit contenir toute valeur susceptible d'être - encore lue ; dimensionner - yac.values_memory_size - comme le nombre de valeurs vivantes multiplié par leur taille - sérialisée moyenne (après compression), et prévoir environ le double : - le réservoir est un anneau, et une valeur ne meurt qu'une fois que le - curseur d'allocation revient l'écraser. - - - - Les valeurs intégrées occupent un slot comme toute autre entrée, mais ne - consomment aucune place dans le réservoir de valeurs : les exclure du - second calcul. - -
    - -
    - Le réservoir de clés (slots) - - yac.keys_memory_size - contient une table de slots de taille fixe — la valeur par défaut de - 8M donne environ 65 536 slots. Chaque clé stockée - occupe exactement un slot ; ce réservoir plafonne donc le nombre - d'entrées pouvant exister simultanément. Contrairement au réservoir de - valeurs, les slots ne sont jamais libérés individuellement. Un slot - expiré — au delà de son TTL, ou la trace laissée par - Yac::delete — est recyclé gratuitement lorsqu'une - nouvelle clé en a besoin. Ce n'est que lorsque les quatre slots candidats - d'un chemin de sondage contiennent des entrées vivantes que l'un d'eux est - expulsé pour faire de la place : un kick (le compteur - kicks de Yac::info). - - - L'expulsion choisit uniquement parmi les quatre candidats vivants du - chemin de sondage en collision : - - - - le moins récemment utilisé (l'atime le plus ancien) - est expulsé ; - - - - - en cas d'égalité, l'entrée la moins souvent lue, puis la première - position de sondage. - - - - - - Une confusion fréquente : slots_used atteignant - slots_size n'est pas une - condition d'erreur. Un cache dont l'ensemble de clés actif est plus grand - que la table de slots tourne simplement à 100 % d'occupation à - partir de là, expulsant et réinsérant selon les besoins. La seule chose - qui dise si le réservoir de clés est correctement dimensionné est le taux - de succès (hits / (hits + miss), calculé sur les - écarts entre deux instantanés de Yac::info - plutôt que sur la moyenne depuis le démarrage). Un compteur - kicks élevé ne signifie en lui-même pas qu'il y a un - problème : la distribution des clés n'est simplement pas uniforme et - certains chemins de sondage entrent plus souvent en collision. Ce n'est - que lorsque le taux de succès et - kicks sont tous deux mauvais que la table est trop - petite pour l'ensemble de clés, et le remède est alors un - yac.keys_memory_size - plus grand. - - - Seconde conséquence du fait que les slots ne sont jamais libérés : les - entrées sans TTL (ttl = 0) qui ne sont plus jamais - lues continuent d'occuper un slot jusqu'à ce qu'une expulsion les - désigne. Si une application stocke de grandes quantités de telles données - à usage unique, leur donner un TTL pour qu'elles expirent et puissent - être recyclées sans déloger des entrées vivantes, ou dimensionner le - réservoir de clés pour l'ensemble de clés complet. - -
    - -
    - Le réservoir de valeurs (segments) - - yac.values_memory_size - est découpé en segments de 4M chacun, gérés comme des anneaux : les - écritures avancent un curseur par segment et la place n'est jamais - libérée entrée par entrée. Lorsqu'une allocation ne tient plus, le - curseur repart au début d'un segment : un recycle (le - compteur recycles de - Yac::info). Un recyclage n'invalide pas le - segment d'un coup : les valeurs écrasées restent lisibles jusqu'à ce que - le curseur revenu au début les écrase effectivement, moment à partir - duquel leurs lectures échouent au contrôle d'intégrité et se - transforment en défauts de cache. - - - Deux tailles comptent pour ce réservoir : le total de - yac.values_memory_size - doit contenir l'ensemble actif des valeurs vivantes, et une entrée seule - ne peut pas dépasser 1 Mo une fois stockée - (YAC_MAX_RAW_COMPRESSED_LEN). Les valeurs plus - grandes sont donc toujours compressées avant d'être stockées ; une valeur - qui ne peut pas descendre en dessous de 1 Mo — le plus souvent parce - qu'il s'agit de données aléatoires — est rejetée et incrémente le - compteur fails. La limite absolue sur la valeur - elle-même est bien plus haute : les valeurs sérialisées au delà de 64 Mo - (YAC_MAX_VALUE_RAW_LEN, soit - (1 << 26) - 1 octets) sont rejetées d'emblée. - -
    - -
    - Dimensionner et surveiller - - Commencer avec les valeurs par défaut et surveiller les compteurs de - Yac::info : ils s'accumulent depuis - start_time, il faut donc comparer deux instantanés - pris à quelque temps d'intervalle : - - - - - taux de succès sain (disons >= 90 %) : le cache va bien, - il n'y a rien à faire, quels que soient les autres compteurs ; - - - - - taux de succès faible et kicks en hausse : le - réservoir de clés est trop petit pour l'ensemble de clés — des entrées - vivantes sont expulsées avant d'avoir été relues. Augmenter - yac.keys_memory_size ; - - - - - recycles fréquents : c'est un vrai problème, pas un - compteur anodin. Un recyclage signifie que l'allocateur de valeurs est - revenu au début et s'apprête à écraser des entrées — tout ce qui est - écrasé meurt avant d'avoir pu être relu, les octets dépensés à le - stocker sont donc perdus et le taux de succès en souffre. Le réservoir - de valeurs est trop petit pour le volume de données vivantes. Par ordre - d'impact : - - - - donner un TTL aux entrées. Les valeurs écrites avec - ttl = 0 restent vivantes indéfiniment, elles - continuent donc d'occuper le réservoir et forcent le curseur à - reboucler plus tôt. Un TTL borne la durée de vie de chaque entrée et - réduit l'ensemble actif que le réservoir doit contenir ; - - - - - augmenter - yac.values_memory_size - pour que le réservoir contienne tout l'ensemble des valeurs vivantes - (penser à prévoir environ le double de l'empreinte vivante : une - valeur ne meurt qu'une fois que le curseur revient l'écraser) ; - - - - - stocker moins par entrée : baisser - yac.compress_threshold - s'il est réglé au dessus du minimum de 1024, afin - que les grandes charges utiles soient compressées, et élaguer les - valeurs qui n'ont pas besoin d'être mises en cache en entier ; - - - - - - - - fails en hausse : des valeurs qui n'ont pas pu être - stockées, le plus souvent une valeur seule dépassant la limite de 1 Mo - par entrée stockée même après compression — découper la valeur. - - - -
    - -     - - diff --git a/reference/yac/setup.xml b/reference/yac/setup.xml deleted file mode 100644 index ae0759ee89..0000000000 --- a/reference/yac/setup.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Aucune bibliothèque externe n'est requise. - -
    - - -
    - &reftitle.install; - - Yac peut être installé de trois façons : via PECL, via PIE ou en - compilant depuis les sources. - - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yac. - - - &pecl.windows.download.avail; - - - Installer Yac avec PECL - - - - - - Depuis Yac 2.3.2, l'extension peut être installée avec - &link.pie;, le PHP Installer for Extensions, en exécutant la commande - suivante. - - - Installer Yac avec PIE - - - - - - Des sérialisateurs optionnels peuvent être activés à l'installation : - - - Installer Yac avec PIE et un sérialisateur - - - - - - Le code source est hébergé sur - GitHub. Pour - compiler l'extension depuis les sources, exécuter les commandes - suivantes en remplaçant les chemins par ceux de l'installation PHP - locale. - - - Compiler Yac depuis les sources - - - - - - Les options configure suivantes sont disponibles : - - - Les valeurs sont compressées avec LZ4 avant d'être stockées. Le moteur - de compression LZ4 a été introduit dans Yac 2.4.0, remplaçant l'ancien - FastLZ. Par défaut, Yac utilise la copie de LZ4 fournie avec l'extension ; - aucun indicateur supplémentaire n'est nécessaire. Pour lier l'extension - contre la bibliothèque LZ4 système, utiliser le commutateur - , qui nécessite que - l'en-tête lz4.h et liblz4 soient - installés. - - - Des sérialisateurs alternatifs peuvent être compilés avec - , - ou - , qui enregistrent - l'extension correspondante comme dépendance optionnelle. Le sérialisateur - utilisé à l'exécution est sélectionné avec la directive ini - yac.serializer. - -
    - - - - &reference.yac.ini; - - -
    - &reftitle.resources; - - Cette extension ne définit aucune ressource. - -
    - -     - - diff --git a/reference/yac/yac.xml b/reference/yac/yac.xml deleted file mode 100644 index 64c9639922..0000000000 --- a/reference/yac/yac.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - La classe Yac - Yac - - - - -
    - &reftitle.intro; - - La classe Yac est l'interface du cache. Chaque - instance sur le même hôte est un handle léger vers un cache partagé : - toutes les instances lisent et écrivent les mêmes entrées, et en créer - une n'alloue rien au-delà du handle lui-même. - - - Le préfixe optionnel passé à - Yac::__construct est ajouté à chaque clé, ce - qui permet à plusieurs instances (ou applications) de partager un même - cache sans collision de clés. En plus des opérations classiques de cache - (Yac::add, - Yac::set, - Yac::get, - Yac::delete et - Yac::flush), la classe fournit - Yac::info et - Yac::dump pour inspecter le cache, et surcharge - l'accès aux propriétés pour que lire ou écrire une propriété d'objet lise - ou écrive une entrée du cache. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yac - - - - - Yac - - - - &Properties; - - protected - _prefix - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _prefix - - - Le préfixe de clé défini via - Yac::__construct. Il est ajouté à chaque - clé utilisée avec l'instance ; aucun séparateur n'est inséré, il - faut donc en inclure un dans le préfixe si nécessaire. Le préfixe - ne doit pas dépasser YAC_MAX_KEY_LEN (48) octets. - - - - -
    - - - -     - - &reference.yac.entities.yac; - -     - - diff --git a/reference/yac/yac/add.xml b/reference/yac/yac/add.xml deleted file mode 100644 index dc31769b41..0000000000 --- a/reference/yac/yac/add.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - Yac::add - Stocke une valeur sans écraser une valeur existante - - - - &reftitle.description; - - public boolYac::add - stringarraykey - mixedvalue - intttl0 - - - public boolYac::add - arrayvalues - intttl0 - - - Stocke une valeur dans le cache. Contrairement à - Yac::set, cette méthode n'écrase pas une entrée - existante encore valide ; le stockage est rejeté dans ce cas. - - - - - &reftitle.parameters; - - - key - - - Une clé string, ou un array de paires - clé => valeur à stocker en un seul appel. - - - - - value - - - La valeur à stocker. Tout type PHP sauf resource peut - être stocké. Utilisé uniquement dans la forme à clé unique ; quand - key est un tableau, cet argument est le - ttl optionnel. - - - - - ttl - - - Durée de vie en secondes. 0 signifie que l'entrée - n'expire jamais dans le temps. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, &false; en cas d'échec. Un stockage - est également rejeté (retournant &false;) quand la clé existe déjà et - n'a pas expiré. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yac::add</methodname> - -add("foo", "bar")); // bool(true) -var_dump($yac->add("foo", "baz")); // bool(false): "foo" existe déjà -?> -]]> - - - - Ajout d'une entrée avec un TTL - -add("short-lived", "value", 5); -sleep(6); -var_dump($yac->get("short-lived")); // bool(false): expiré -?> -]]> - - - - Ajout de plusieurs entrées en un appel - - valeur en un appel, avec un ttl -$yac->add(array("a" => 1, "b" => 2), 60); -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::get - Yac::delete - - - - - - - diff --git a/reference/yac/yac/construct.xml b/reference/yac/yac/construct.xml deleted file mode 100644 index 07af44284b..0000000000 --- a/reference/yac/yac/construct.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Yac::__construct - Constructeur - - - - &reftitle.description; - - public Yac::__construct - stringprefix"" - - - Crée une nouvelle instance de Yac. Le - prefix optionnel est ajouté au début de chaque - clé stockée par cette instance, ce qui permet à plusieurs applications - ou caches sur la même machine d'utiliser des noms de clés chevauchants - sans collision. - - - - - &reftitle.parameters; - - - prefix - - - Un préfixe de clé, jusqu'à 48 octets (YAC_MAX_KEY_LEN). - - - - - - - - &reftitle.errors; - - Lance une Exception si le cache est - désactivé (yac.enable=0), ou si - prefix est plus long que 48 octets. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yac::__construct</methodname> - -set("foo", "bar"); - -$other = new Yac("app2_"); -var_dump($other->get("foo")); // bool(false): espace de noms différent -$other->set("foo", "baz"); // stocké sous "app2_foo" -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::get - - - - - - - diff --git a/reference/yac/yac/delete.xml b/reference/yac/yac/delete.xml deleted file mode 100644 index 1e152e323f..0000000000 --- a/reference/yac/yac/delete.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - Yac::delete - Supprime des éléments du cache - - - - &reftitle.description; - - public boolYac::delete - stringarraykey - intdelay0 - - - Supprime un ou plusieurs éléments du cache. - - - - La suppression est implémentée en marquant l'entrée comme expirée - plutôt qu'en vidant son slot : l'entrée cesse immédiatement d'être - lisible, mais le slot reste occupé jusqu'à ce que la même clé soit - stockée à nouveau ou qu'une écriture ultérieure le récupère. En - conséquence, le nombre de slots utilisés rapporté par - Yac::info ne diminue pas après une - suppression, et Yac::dump liste toujours - l'entrée supprimée jusqu'à ce que son slot soit recyclé ; un - ttl non nul dans le passé indique une entrée - supprimée ou expirée, il appartient donc à l'appelant de les - filtrer dans la sortie de Yac::dump. - - - - - - &reftitle.parameters; - - - key - - - Une clé string, ou un array de clés à - supprimer. - - - - - delay - - - Nombre de secondes avant que l'élément devienne invalide. Quand omis - ou 0, l'élément est invalidé immédiatement. Une - valeur positive garde l'élément lisible pendant ce nombre de secondes - avant qu'il expire. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, ou &false; si la clé n'était pas - présente dans le cache. Comme une suppression ne fait que marquer - l'entrée comme expirée, une clé supprimée mais pas encore écrasée est - toujours considérée comme présente : supprimer la même clé à nouveau - retourne &true;. - - - Quand un array de clés est fourni, &true; est retourné - uniquement si toutes les clés étaient présentes ; si une clé est - absente, &false; est retourné. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yac::delete</methodname> - -set("foo", "bar"); - -var_dump($yac->delete("foo")); // bool(true) : marquée expirée -var_dump($yac->get("foo")); // bool(false) : manquant désormais -var_dump($yac->delete("foo")); // bool(true) à nouveau : le slot n'a pas - // encore été écrasé -var_dump($yac->delete("jamais")); // bool(false) : jamais stockée - -// une suppression ne libère pas le slot : slots_used ne diminue pas, et -// l'entrée expirée apparaît toujours dans le dump -var_dump($yac->info()["slots_used"]); // int(1) -print_r($yac->dump()); // "foo" est toujours listée ; son ttl - // est dans le passé -?> -]]> - - - - Suppression différée - -set("tmp", "value"); -var_dump($yac->delete("tmp", 60)); // bool(true) -?> -]]> - - - - Suppression de plusieurs clés en un appel - -set("tmp", "value"); - -// retourne true uniquement si toutes les clés étaient présentes -var_dump($yac->delete(array("tmp", "non"))); // bool(false) : "non" absente -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::flush - Yac::info - Yac::dump - - - - - - - diff --git a/reference/yac/yac/dump.xml b/reference/yac/yac/dump.xml deleted file mode 100644 index 3d5abf67f1..0000000000 --- a/reference/yac/yac/dump.xml +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - Yac::dump - Vide les entrées du cache pour inspection - - - - &reftitle.description; - - public arrayYac::dump - intlimit100 - intoffset0 - - - Vide les métadonnées des entrées actuellement stockées dans le cache. - Les valeurs elles-mêmes ne sont pas retournées. - - - - - &reftitle.parameters; - - - limit - - - Nombre maximum d'entrées à retourner. - - - Passer -1 comme limit vide - toutes les entrées actuellement présentes dans le cache. Il est à - noter que construire la liste complète peut utiliser une quantité - considérable de mémoire pour un grand cache ; quand la mémoire est - un critère, il vaut mieux paginer les entrées avec - limit et offset. - - - - - offset - - - Nombre d'entrées à sauter avant de collecter. Ce paramètre est - disponible à partir de PECL yac 2.4.0 ; les versions antérieures - commencent toujours depuis la première entrée. Combiné avec - limit, il peut être utilisé pour paginer un - cache contenant plus d'entrées qu'un seul appel ne peut en retourner. - - - - - - - - &reftitle.returnvalues; - - Un array avec un élément par entrée vidée. Chaque élément - est lui-même un tableau décrivant l'entrée : - - - - index - - L'index de slot de l'entrée dans la table de hachage. - - - - hash - - Le hachage 64 bits de la clé, utilisé pour le sondage de slots. - - - - crc - - La somme de contrôle CRC32 de la valeur stockée, utilisée pour - détecter les lectures incomplètes. 0 pour les - entrées intégrées, qui n'ont pas de bloc de valeur. - - - - ttl - - L'horodatage d'expiration (heure Unix). 0 signifie - que l'entrée n'expire jamais dans le temps. Il est à noter que - Yac::delete marque seulement une entrée - comme expirée, donc les entrées supprimées peuvent encore apparaître - dans le vidage ; un ttl non nul dans le passé - indique une entrée expirée ou supprimée. - - - - k_len - - La longueur de la clé, en octets. - - - - v_len - - La longueur de la valeur, en octets. Pour les entrées compressées, - c'est la longueur de la valeur originale avant - compression (à partir de yac 2.4.0 ; les versions antérieures - rapportaient la longueur stockée, compressée). - - - - c_len - - Présent uniquement pour les entrées compressées (à partir de yac - 2.4.0) : la longueur du contenu compressé réellement stocké en - mémoire partagée, en octets. Comparer c_len avec - v_len montre combien la compression économise par - entrée. - - - - size - - La taille allouée du bloc de valeur en mémoire partagée, en octets. - 0 pour les entrées intégrées. - - - - atime - - Le dernier temps d'accès (heure Unix), mis à jour à chaque - Yac::get réussi. Quand le cache est plein, - l'entrée avec l'atime le plus ancien parmi les - slots candidats est expulsée en premier (à partir de yac 2.4.0). - - - - hits - - Un compteur de succès par entrée, incrémenté à chaque - Yac::get réussi et remis à zéro quand - l'entrée est écrasée par un nouveau Yac::set - ou Yac::add (à partir de yac 2.4.0). - - - - embedded - - Si la valeur est stockée directement à l'intérieur du slot plutôt que - dans un bloc de valeur séparé (à partir de yac 2.4.0). Les petites - valeurs — NULL, booléens, petits entiers, chaînes - jusqu'à 7 octets et tableaux vides — sont intégrées de cette façon et - n'allouent aucune mémoire de valeur ; pour elles, crc - et size sont rapportés à 0. - - - - key - - La clé de cache, sans aucun préfixe d'instance. - - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yac::dump</methodname> - -set("foo", "bar"); -$yac->set("baz", "qux"); - -print_r($yac->dump()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [index] => 12345 - [hash] => 14463105906481965911 - [crc] => 0 - [ttl] => 0 - [k_len] => 3 - [v_len] => 3 - [size] => 0 - [atime] => 1725955200 - [hits] => 0 - [embedded] => 1 - [key] => foo - ) - - [1] => Array - ( - [index] => 12987 - [hash] => 15132029420525657053 - [crc] => 0 - [ttl] => 0 - [k_len] => 3 - [v_len] => 3 - [size] => 0 - [atime] => 1725955200 - [hits] => 0 - [embedded] => 1 - [key] => baz - ) - -) -]]> - - - Les entrées sont listées dans l'ordre des slots, pas dans l'ordre où - elles ont été stockées. Les entrées intégrées (petits scalaires gardés - à l'intérieur du slot lui-même) ont crc et - size à zéro ; les entrées stockées dans un bloc de - valeur séparé portent leur somme de contrôle et taille de bloc, et les - entrées compressées portent additionnellement c_len. - - - - Pagination d'un grand cache - - limit limite le nombre d'entrées qu'un seul - appel retourne, et offset en saute autant avant - de collecter, donc les deux peuvent être combinés pour paginer un cache - contenant plus d'entrées qu'un appel peut en retourner. - - -set("key$i", $i); -} - -$page_size = 100; -$page_num = 2; - -// sauter les 100 premières entrées et retourner les 100 suivantes (page 2) -$page = $yac->dump($page_size, $page_size * ($page_num - 1)); - -var_dump(count($page)); -?> -]]> - - &example.outputs.similar; - - - - - Moins d'entrées que demandé sont retournées quand le cache en contient - moins que la page demandée ne couvre, et un tableau vide est retourné - quand l'offset pointe au-delà du dernier slot occupé. - - - - - - &reftitle.seealso; - - - Yac::info - - - - - - - diff --git a/reference/yac/yac/flush.xml b/reference/yac/yac/flush.xml deleted file mode 100644 index 77f9d214e1..0000000000 --- a/reference/yac/yac/flush.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Yac::flush - Vide le cache - - - - &reftitle.description; - - public boolYac::flush - - - - Supprime toutes les valeurs mises en cache. Comme le cache est partagé - par chaque processus de la même machine, cela vide le cache globalement ; - le préfixe de clé donné à Yac::__construct ne - limite pas ce qui est vidé. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true;. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yac::flush</methodname> - -set("foo", "bar"); - -$other = new Yac("app2_"); -$other->set("baz", "qux"); - -// flush vide tout le cache : les entrées de chaque instance, -// quel que soit le préfixe utilisé lors de leur stockage -$yac->flush(); - -var_dump($yac->get("foo")); // bool(false) -var_dump($other->get("baz")); // bool(false) -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::delete - Yac::info - - - - - - - diff --git a/reference/yac/yac/get.xml b/reference/yac/yac/get.xml deleted file mode 100644 index 18ce2a2a45..0000000000 --- a/reference/yac/yac/get.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - Yac::get - Récupère des valeurs du cache - - - - &reftitle.description; - - public mixedYac::get - stringarraykey - mixeddefault&null; - - - Récupère des valeurs du cache. - - - - - &reftitle.parameters; - - - key - - - Une clé string, ou un array de clés. - - - - - default - - - La valeur à retourner quand la clé (ou les clés) demandée n'est pas - présente dans le cache, disponible à partir de yac 2.4.0. Quand - omis, un défaut de cache retourne &false;. - - - - Avant yac 2.4.0, cet emplacement d'argument contenait un jeton - $cas par référence plutôt qu'une valeur par - défaut. Le code qui passait ou se reposait sur ce jeton doit être - mis à jour lors d'une montée en version vers 2.4.0. - - - - - - - - - &reftitle.returnvalues; - - Pour une clé string, retourne la valeur mise en cache en - cas de succès, sinon la default (ou &false; si - aucune valeur par défaut n'a été donnée). - - - Pour un array de clés, retourne un tableau contenant les - valeurs trouvées indexées par leurs clés. Les clés absentes du cache - sont omises du résultat à partir de yac 2.4.0, ou remplies avec la - default quand une a été fournie ; avant 2.4.0, - un placeholder &false; était inséré pour chaque clé manquante. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yac::get</methodname> - -set("foo", "bar"); -var_dump($yac->get("foo")); // string(3) "bar" -var_dump($yac->get("missing")); // bool(false): défaut de cache -?> -]]> - - - - Distinguer un false stocké d'un défaut de cache - -set("flag", false); -var_dump($yac->get("flag")); // bool(false): la valeur stockée -var_dump($yac->get("missing", false)); // bool(false): un défaut de cache, même forme -var_dump($yac->get("flag", "__NONE__")); // bool(false): la valeur stockée -var_dump($yac->get("missing", "__NONE__")); // string(8) "__NONE__": un défaut de cache -?> -]]> - - - - Récupération de plusieurs clés en un appel - -set("foo", "bar"); -$yac->set("foo2", "bar2"); - -// avec un tableau de clés, seules les clés trouvées sont présentes dans le résultat -var_dump($yac->get(array("foo", "foo2", "missing"))); -// array(2) { ["foo"]=> string(3) "bar" ["foo2"]=> string(4) "bar2" } -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::__get - - - - - - - diff --git a/reference/yac/yac/getter.xml b/reference/yac/yac/getter.xml deleted file mode 100644 index dcfc343ebb..0000000000 --- a/reference/yac/yac/getter.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yac::__get - Récupère une valeur via la syntaxe propriété - - - - &reftitle.description; - - public mixedYac::__get - stringkey - - - Récupère une valeur du cache, invoqué lors de la lecture d'une propriété - d'une instance de Yac : $yac->foo - est équivalent à $yac->get("foo"). - - - - - &reftitle.parameters; - - - key - - - Le nom de la propriété, utilisé comme clé de cache. - - - - - - - - &reftitle.returnvalues; - - La valeur mise en cache en cas de succès, &null; quand la clé n'est pas - présente dans le cache. - - - - Contrairement à Yac::get, la syntaxe propriété - ne peut pas distinguer un &null; stocké d'une clé manquante, et ne - prend en charge que des clés uniques. - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yac::__get</methodname> - -set("foo", "bar"); - -var_dump($yac->foo); // string(3) "bar" -var_dump($yac->missing); // NULL -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::get - Yac::__set - - - - - - - diff --git a/reference/yac/yac/info.xml b/reference/yac/yac/info.xml deleted file mode 100644 index f4da9925d8..0000000000 --- a/reference/yac/yac/info.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - Yac::info - État du cache - - - - &reftitle.description; - - public arrayYac::info - - - - Retourne l'état du système de cache. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un array avec les clés suivantes : - - - - memory_size - - Mémoire partagée totale utilisée, en octets : la table de slots plus - les blocs de valeurs. - - - - slots_memory_size - - Mémoire réservée pour la table de hachage de slots, en octets. - - - - values_memory_size - - Mémoire réservée pour les valeurs stockées, en octets. - - - - segment_size - - Taille d'un segment de mémoire de valeurs, en octets. - - - - segment_num - - Nombre de segments de mémoire de valeurs. - - - - miss - - Nombre de défauts de cache : recherches n'ayant rien trouvé ou - trouvant une entrée expirée. - - - - hits - - Nombre de succès de cache : recherches fructueuses. - - - - fails - - Nombre de stockages échoués : stockages n'ayant pas pu allouer un - bloc de valeur. - - - - kicks - - Nombre d'évictions : combien de fois une entrée existante a dû être - expulsée parce que le chemin de slot candidat était plein. - - - - recycles - - Nombre de fois où l'allocateur a atteint la fin d'un segment et est - revenu à son début. - - - - start_time - - L'horodatage Unix auquel le cache en mémoire partagée a été - initialisé. - - - - slots_size - - Nombre total de slots de hachage. - - - - slots_used - - Nombre de slots de hachage actuellement occupés. - - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yac::info</methodname> - -set("foo", "bar"); - -print_r($yac->info()); -?> -]]> - - &example.outputs.similar; - - 75497472 - [slots_memory_size] => 8388608 - [values_memory_size] => 67108864 - [segment_size] => 4194304 - [segment_num] => 16 - [miss] => 0 - [hits] => 0 - [fails] => 0 - [kicks] => 0 - [recycles] => 0 - [start_time] => 1725955200 - [slots_size] => 65536 - [slots_used] => 1 -) -]]> - - - Le taux de succès peut être calculé comme - hits / (hits + miss) ; un compteur - kicks ou fails croissant indique - que le cache est sous pression mémoire. - - - - - - &reftitle.seealso; - - - Yac::dump - - - - - - - diff --git a/reference/yac/yac/set.xml b/reference/yac/yac/set.xml deleted file mode 100644 index 0982de6bac..0000000000 --- a/reference/yac/yac/set.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - Yac::set - Stocke une valeur dans le cache - - - - &reftitle.description; - - public boolYac::set - stringarraykey - mixedvalue - intttl0 - - - public boolYac::set - arrayvalues - intttl0 - - - Stocke une valeur dans le cache. Si la clé existe déjà, l'entrée - existante est écrasée, qu'elle ait expiré ou non. - - - - - &reftitle.parameters; - - - key - - - Une clé string, ou un array de paires - clé => valeur à stocker en un seul appel. - - - - - value - - - La valeur à stocker. Tout type PHP sauf resource peut - être stocké. Utilisé uniquement dans la forme à clé unique ; quand - key est un tableau, cet argument est le - ttl optionnel. - - - - - ttl - - - Durée de vie en secondes. 0 signifie que l'entrée - n'expire jamais dans le temps. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, &false; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yac::set</methodname> - -set("foo", "bar"); // stocker une valeur unique -$yac->set("foo", "baz"); // écraser l'entrée existante -?> -]]> - - - - Stockage d'une entrée avec un TTL - -set("short-lived", "value", 5); -sleep(6); -var_dump($yac->get("short-lived")); // bool(false): expiré -?> -]]> - - - - Stockage de plusieurs entrées en un appel - - valeur en un appel -$yac->set(array("a" => 1, "b" => 2)); -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::add - Yac::get - Yac::__set - - - - - - - diff --git a/reference/yac/yac/setter.xml b/reference/yac/yac/setter.xml deleted file mode 100644 index 0c3c389e7e..0000000000 --- a/reference/yac/yac/setter.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yac::__set - Stocke une valeur via la syntaxe propriété - - - - &reftitle.description; - - public mixedYac::__set - stringkey - mixedvalue - - - Stocke une valeur dans le cache, invoqué lors de l'écriture d'une - propriété d'une instance de Yac : - $yac->foo = "bar" est équivalent à - $yac->set("foo", "bar"), sans ttl. - - - - - &reftitle.parameters; - - - key - - - Le nom de la propriété, utilisé comme clé de cache. - - - - - value - - - La valeur à stocker. Tout type PHP sauf resource peut - être stocké. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur stockée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yac::__set</methodname> - -foo = "bar"; // stocké sans ttl -var_dump($yac->get("foo")); // string(3) "bar" -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::__get - - - - - - - diff --git a/reference/yaconf/book.xml b/reference/yaconf/book.xml deleted file mode 100644 index 78ec1373d8..0000000000 --- a/reference/yaconf/book.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Yaconf - Yaconf - - - &reftitle.intro; - - Yet Another Configurations Container - (Yaconf) est un conteneur de configuration. Il analyse - les fichiers INI au démarrage de PHP et conserve le - résultat en mémoire persistante pour toute la durée du cycle de vie de PHP, - de sorte que chaque accès est une simple recherche dans une table de hachage, - sans aucune E/S disque ni analyse par requête. - - - Yaconf enregistre toutes les configurations sous forme de chaînes internées - ou de tableaux immuables. Ils ne sont pas comptabilisés dans les références, - donc la récupération d'une configuration depuis Yaconf est effectivement - sans copie. Depuis Yaconf 1.2.0, l'arbre de configuration analysé est en - outre compacté dans un bloc contigu unique, ce qui réduit l'empreinte - mémoire et améliore la localité du cache. - - - La configuration analysée réside en mémoire persistante partagée par tous - les workers PHP-FPM via la copie sur écriture : tant qu'un fichier de - configuration ne change pas, les workers partagent les mêmes pages mémoire - physiques, quel que soit leur nombre. - - - Yaconf supporte les sections et l'héritage de sections dans les fichiers - INI. Sur les compilations non-ZTS, il recharge aussi les fichiers - automatiquement lorsqu'ils changent ; sur les compilations ZTS - (thread-safe), les configurations sont chargées au démarrage et un - redémarrage est nécessaire pour prendre en compte les modifications. - - - Depuis Yaconf 1.2.0, les sous-répertoires du répertoire configuré sont - chargés récursivement (jusqu'à 16 niveaux de profondeur) et adressés avec - le nom du répertoire comme niveau de clé : par exemple, - Yaconf::get("users.database.master") lit la clé - master depuis le fichier - database.ini placé dans le sous-répertoire - users/. - - - Stocker des configurations sensibles en dehors de l'arborescence web réduit - aussi la surface d'attaque. Avec Yaconf, les fichiers - .ini peuvent être placés dans un répertoire accessible - uniquement par root, comme /etc/yaconf : le master - PHP-FPM charge les configurations au démarrage du service, tandis que les - workers forqués — qui s'exécutent sous un utilisateur non privilégié et - traitent les requêtes web — n'ont pas besoin, et ne reçoivent pas, l'accès - à ce répertoire. - - - Yaconf nécessite PHP 7.0 ou supérieur. - - - - &reference.yaconf.setup; - &reference.yaconf.yaconf; - - - - diff --git a/reference/yaconf/configure.xml b/reference/yaconf/configure.xml deleted file mode 100644 index ca7eafee3d..0000000000 --- a/reference/yaconf/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;yaconf - - - -
    - - - diff --git a/reference/yaconf/ini.xml b/reference/yaconf/ini.xml deleted file mode 100644 index 3d46f06694..0000000000 --- a/reference/yaconf/ini.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Yaconf &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yaconf.directory - "" - INI_SYSTEM - - - - yaconf.check_delay - 300 - INI_SYSTEM - - - - -
    -     - - &ini.descriptions.title; - - - - - - yaconf.directory - string - - - - Le répertoire où tous les fichiers de configuration INI sont placés. - Seuls les fichiers avec l'extension .ini sont - chargés. Les sous-répertoires sont chargés récursivement (jusqu'à - 16 niveaux de profondeur) ; chacun agit comme un niveau de clé, de - sorte qu'un fichier database.ini placé dans le - sous-répertoire users/ est adressé comme - "users.database". Disponible depuis Yaconf 1.2.0 ; - avant cela, seuls les fichiers directement dans le répertoire étaient - chargés. - - - Les exemples ci-dessous supposent le - database.ini suivant placé dans le répertoire - configuré, à côté d'un features.ini contenant - des paramètres par fonctionnalité. - - - Syntaxe du fichier INI - - - - - - Exemple de sections INI - - - - - - - - - yaconf.check_delay - int - - - - L'intervalle, en secondes, auquel Yaconf vérifie si un fichier INI - chargé a changé et recharge les fichiers modifiés (la modification est - détectée en comparant les temps de modification du répertoire). Définir - cette valeur à 0 fait vérifier Yaconf à chaque - requête. - - - - Cette directive n'est enregistrée que sur les compilations non-ZTS. - Sur les compilations ZTS (thread-safe), les configurations sont - chargées au démarrage et le rechargement automatique n'est pas - disponible ; redémarrer PHP pour prendre en compte les modifications. - - - - - - -
    - - diff --git a/reference/yaconf/setup.xml b/reference/yaconf/setup.xml deleted file mode 100644 index 0db6c1f291..0000000000 --- a/reference/yaconf/setup.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Yaconf nécessite PHP 7.0 ou supérieur. - -
    - -
    - &reftitle.install; - - Yaconf peut être installé de trois façons : via PECL, via PIE, ou en - compilant depuis les sources. - - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yaconf. - - - &pecl.windows.download.avail; - - - Installation de Yaconf avec PECL - - - - - - Depuis Yaconf 1.2.0, l'extension peut être installée avec - &link.pie;, le PHP Installer for Extensions, en exécutant la commande - suivante. - - - Installation de Yaconf avec PIE - - - - - - Le code source est hébergé sur - GitHub. Pour - compiler l'extension depuis les sources, exécutez les commandes suivantes, - en remplaçant les chemins par ceux de l'installation PHP locale. - - - Compilation de Yaconf depuis les sources - - - - -
    - - &reference.yaconf.ini; - -
    - &reftitle.resources; - - - -
    - -     - diff --git a/reference/yaconf/yaconf.xml b/reference/yaconf/yaconf.xml deleted file mode 100644 index 7fafe26942..0000000000 --- a/reference/yaconf/yaconf.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - La classe Yaconf - Yaconf - - - - -
    - &reftitle.intro; - - Yaconf est un conteneur de configuration, - il analyse les fichiers INI, enregistre le résultat en - PHP quand PHP est démarré, le résultat vit tout - le long du cycle de vie de PHP. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaconf - - - - - Yaconf - - - - - &Methods; - - - - -
    - -     - - &reference.yaconf.entities.yaconf; - -     - - diff --git a/reference/yaconf/yaconf/debuginfo.xml b/reference/yaconf/yaconf/debuginfo.xml deleted file mode 100644 index ea466a32ca..0000000000 --- a/reference/yaconf/yaconf/debuginfo.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - Yaconf::__debug_info - Inspecte la façon dont une valeur de configuration est stockée - - - - &reftitle.description; - - public static arraynullYaconf::__debug_info - stringname - - - Retourne des informations de débogage sur la valeur stockée sous - name : l'adresse mémoire de la valeur stockée et - si la valeur réside toujours dans le bloc de stockage compacté de Yaconf. - - - - Cette méthode existe uniquement pour la suite de tests de Yaconf, qui - l'utilise pour vérifier que l'extension fonctionne correctement. Ne pas - l'utiliser dans du code de production, et ne pas se fier au format de sa - sortie : le tableau retourné peut changer à tout moment. - - - - - - &reftitle.parameters; - - - name - - - Le nom de configuration à inspecter, en utilisant la même notation - pointée que Yaconf::get. - - - - - - - - &reftitle.returnvalues; - - Un &array; avec quatre entrées lorsque la configuration existe, &null; - sinon : - - - - - key — le nom recherché. - - - - - address — l'adresse mémoire de la valeur stockée. - Les valeurs sont stockées comme des chaînes internées ou des tableaux - immuables, donc cette adresse reste constante jusqu'au rechargement de - la configuration. - - - - - val — la valeur stockée elle-même. - - - - - changed — &false; tant que les données de la valeur - résident dans le bloc de stockage compacté, ce qui signifie que le - système d'exploitation n'a pas eu besoin de copier la page (la - copie-sur-écriture s'applique toujours) ; &true; lorsque la valeur a - été réallouée en dehors du bloc. - - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaconf::__debug_info</methodname> - - - string(8) "app.name" - ["address"]=> - string(14) "0x7f8b1c0a3d20" - ["val"]=> - string(4) "shop" - ["changed"]=> - bool(false) -} -*/ - -var_dump(Yaconf::__debug_info("app.missing")); // NULL -?> -]]> - - - - - - &reftitle.seealso; - - - Yaconf::get - Yaconf::has - - - - - - - diff --git a/reference/yaconf/yaconf/get.xml b/reference/yaconf/yaconf/get.xml deleted file mode 100644 index c91b019451..0000000000 --- a/reference/yaconf/yaconf/get.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - Yaconf::get - Récupère une valeur de configuration par son nom - - - - &reftitle.description; - - public static mixedYaconf::get - stringname - mixeddefault&null; - - - Récupère la valeur de configuration stockée sous name. - Les noms utilisent la notation pointée pour traverser les clés imbriquées : - "app" adresse le fichier app.ini - entier, "app.name" une clé à l'intérieur, et depuis - Yaconf 1.2.0 "users.database.master" une clé dans le - fichier database.ini placé dans le sous-répertoire - users/. La notation pointée supporte jusqu'à 64 - niveaux d'imbrication. - - - - - &reftitle.parameters; - - - name - - - Le nom de configuration à rechercher, en utilisant la notation pointée - pour traverser les clés imbriquées, par exemple - "app.name", "app.features.1" - ou, depuis Yaconf 1.2.0, "users.database.master" - pour les fichiers dans des sous-répertoires. - - - - - default - - - La valeur à retourner lorsque name n'est pas - trouvé. Lorsqu'omis, &null; est retourné. - - - - - - - - &reftitle.returnvalues; - - La valeur de configuration stockée, une &string; ou un &array;, lorsque - name existe ; sinon la valeur - default (ou &null; lorsqu'aucun défaut n'a été - fourni). - - - - - &reftitle.examples; - - Les exemples ci-dessous supposent les deux fichiers suivants placés dans - le répertoire configuré avec yaconf.directory. - - - - - - - - - Exemple avec <methodname>Yaconf::get</methodname> - - -]]> - - - - - - &reftitle.seealso; - - - Yaconf::has - Yaconf::__debug_info - - - - - - - diff --git a/reference/yaconf/yaconf/has.xml b/reference/yaconf/yaconf/has.xml deleted file mode 100644 index d36e8811e8..0000000000 --- a/reference/yaconf/yaconf/has.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Yaconf::has - Vérifie si une valeur de configuration existe - - - - &reftitle.description; - - public static boolYaconf::has - stringname - - - Détermine si une valeur de configuration existe sous - name, qui utilise la même notation pointée que - Yaconf::get : par exemple, - "app.name" ou, depuis Yaconf 1.2.0, - "users.database.master" pour les fichiers dans des - sous-répertoires. - - - - - &reftitle.parameters; - - - name - - - Le nom de configuration à rechercher, en utilisant la notation pointée - pour traverser les clés imbriquées, par exemple - "app.name" ou - "users.database.master". - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si une valeur de configuration existe à - name, &false; sinon. - - - - - &reftitle.examples; - - Les exemples ci-dessous supposent un fichier app.ini - placé dans le répertoire configuré avec yaconf.directory, - contenant les clés name="shop" et - debug=0. - - - Exemple avec <methodname>Yaconf::has</methodname> - - -]]> - - - - - - &reftitle.seealso; - - - Yaconf::get - Yaconf::__debug_info - - - - - - - diff --git a/reference/yaf/appconfig.xml b/reference/yaf/appconfig.xml deleted file mode 100644 index c13a4bb1e2..0000000000 --- a/reference/yaf/appconfig.xml +++ /dev/null @@ -1,442 +0,0 @@ - - - - - Configuration de l'application - - Il faut fournir un tableau de configuration ou le chemin d'un fichier de - configuration ini (voir Yaf_Config_Ini) à - Yaf_Application::__construct. - - - Yaf fusionne automatiquement les configurations de l'application et celles - de l'utilisateur. Les configurations de l'application ont le préfixe "yaf." - ou "application.". Si "yaf." et "application." existent tous les deux, - "application." est retenu en priorité. - - Un exemple de tableau PHP - - array( - "directory" => dirname(__FILE__), - "dispatcher" => array( - "catchException" => 0, - ), - "view" => array( - "ext" => "phtml", - ), - ), -); - -$app = new Yaf_Application($configs); - -?> -]]> - - - - Un exemple de fichier ini - - - - - - - Lorsque la configuration devient volumineuse, - Yaf_Config_Ini, qui analyse le fichier ini à chaque - requête, représente un surcoût notable. - Yaconf analyse tous les - fichiers ini d'un répertoire une seule fois au démarrage de PHP et - conserve les valeurs analysées en mémoire partagée. Il faut définir - yaconf.directory vers le dossier contenant la - configuration, et passer le tableau retourné à - Yaf_Application::__construct : - - - -]]> - - - Un fichier contenant des en-têtes [section] est exposé - sous la forme d'une entrée par section (l'héritage, par exemple - [product : yaf], étant déjà résolu). Il est possible de - récupérer une seule section avec un point, - Yaconf::get("application.product"), et de passer ce - tableau à la place ; ses clés sont exactement les entrées fusionnées de - cette section. - - - - - - Configuration de l'application Yaf - - - - &Name; - &Default; - &Changelog; - - - - - application.directory - - - - - application.ext - "php" - - - - application.view.ext - "phtml" - - - - application.modules - "index" - - - - application.library - application.directory . "/library" - - - - application.library.directory - application.directory . "/library" - - - - application.library.namespace - "" - - - - application.bootstrap - application.directory . "/Bootstrap" . application.ext - - - - application.baseUri - "" - - - - application.dispatcher.defaultRoute - - - - - application.dispatcher.throwException - 1 - - - - application.dispatcher.catchException - 0 - - - - application.dispatcher.defaultModule - "index" - - - - application.dispatcher.defaultController - "index" - - - - application.dispatcher.defaultAction - "index" - - - - application.system - - - - - -
    -     - - &ini.descriptions.title; - - - - - - application.directory - string - - - - Le répertoire de l'application, c'est-à-dire le dossier qui contient - les dossiers "controllers", "views", "models" et "plugins". - - - - - Cette entrée de configuration est la seule qui n'a pas de valeur - par défaut. Il faut toujours la définir manuellement. - - - - - - - - application.ext - string - - - - L'extension de fichier des scripts PHP, utilisée lors du chargement - automatique des classes (Yaf_Loader). - - - - - - application.view.ext - string - - - - L'extension de fichier des scripts de gabarit de vue. - - - - - - application.modules - string - - - - Une liste, séparée par des virgules, des modules enregistrés, utilisée - lors du processus de routage, en particulier lorsqu'il y a plus de - trois segments dans le PATH_INFO, - - - Yaf a besoin d'un moyen de déterminer si le premier segment est un nom - de module ou non. - - - - - - application.library - string - - - - Le répertoire de la bibliothèque locale, voir - Yaf_Loader et - yaf.library. - - - - À partir de Yaf 2.1.6, cette entrée de configuration peut être un - tableau. Le chemin de la bibliothèque essaiera d'utiliser les - éléments définis dans application.library.directory - - - - - - - application.library.directory - string - - - - Alias de application.library. - Introduit en Yaf 2.1.6 - - - - - - application.library.namespace - string - - - - Un préfixe, séparé par des virgules, du namespace de la bibliothèque - locale. - - - Introduit en Yaf 2.1.6 - - - - - - application.bootstrap - string - - - - Un chemin absolu vers le script de la classe Bootstrap. - - - - - - application.baseUri - string - - - - Utilisé pour retirer un préfixe fixe de l'URI de requête lors du - processus de routage. Par exemple, si arrive une requête dont l'URI est - "/prefix/controller/action", et que application.baseUri est définie à - "/prefix", alors seul "/controller/action" sera pris comme PATH_INFO - lors du processus de routage. - - - En général, il n'est pas nécessaire de définir cette valeur. - - - - - - application.dispatcher.throwException - bool - - - - Si elle est définie à On, Yaf lancera une exception lorsqu'une erreur - se produit. Voir aussi - Yaf_Dispatcher::throwException. - - - - - - application.dispatcher.catchException - bool - - - - Si elle est définie à On, Yaf redirigera vers le contrôleur/l'action - Error lorsqu'il y a une exception non gérée. Voir aussi - Yaf_Dispatcher::catchException. - - - - - - application.dispatcher.defaultRoute - string - - - - La route par défaut ; si elle n'est pas spécifiée, la route Static sera - utilisée par défaut. Voir : - Yaf_Router::addRoute. - - - - - - application.dispatcher.defaultModule - string - - - - Le nom du module par défaut, voir aussi - Yaf_Dispatcher::setDefaultModule. - - - - - - application.dispatcher.defaultController - string - - - - Le nom du contrôleur par défaut, voir aussi - Yaf_Dispatcher::setDefaultController. - - - - - - application.dispatcher.defaultAction - string - - - - Le nom de l'action par défaut, voir aussi - Yaf_Dispatcher::setDefaultAction. - - - - - - - application.system - string - - - - Définit la configuration d'exécution de Yaf dans application.ini, - comme : - application.system.lowcase_path - - - seules les configurations INI_ALL peuvent être - définies de cette manière - - - - - - - - -     - - diff --git a/reference/yaf/book.xml b/reference/yaf/book.xml deleted file mode 100644 index 942310e5e9..0000000000 --- a/reference/yaf/book.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Yet Another Framework - Yaf - - - &reftitle.intro; - - L'extension Yet Another Framework - (Yaf) est un framework PHP utilisé pour développer - des applications web. - - - Contrairement aux frameworks PHP habituels, Yaf est écrit en C et compilé - sous forme d'extension : les classes du framework, le chargeur automatique, - le routeur et la boucle de distribution s'exécutent tous en code compilé, - si bien que le coût du framework par requête se mesure en microsecondes - plutôt qu'en millisecondes, et qu'aucun fichier PHP du framework n'est à - charger. Il est conçu pour les applications à fort trafic où le coût - d'amorçage compte, ainsi que pour les environnements d'exécution de - services à longue durée de vie (tels que Swoole) où chaque requête - nécessite un cycle de distribution vierge. - - - Yaf implémente l'architecture MVC classique avec un - script d'entrée unique, un fichier de configuration comportant des - sections d'environnement, des points d'ancrage d'amorçage, un système de - plugins doté de sept points d'ancrage de distribution, six types de routes - intégrés, un chargeur automatique de style PSR-0 - (Yaf_Loader) et une vue légère à base de gabarits - PHP (Yaf_View_Simple). - - - Un benchmark simple de Yaf est disponible sur la page - Performances de Yaf. Pour un - guide de démarrage rapide, se reporter à la section - Tutoriels. - - - - Yaf nécessite PHP 7.0 ou plus récent (la branche master de son dépôt de - sources) ; une branche php5 prend en charge PHP 5.2 et plus récent. - - - - - &reference.yaf.setup; - &reference.yaf.constants; - &reference.yaf.tutorials; - &reference.yaf.appconfig; - &reference.yaf.yaf-application; - &reference.yaf.yaf-bootstrap-abstract; - &reference.yaf.yaf-dispatcher; - &reference.yaf.yaf-config-abstract; - &reference.yaf.yaf-config-ini; - &reference.yaf.yaf-config-simple; - &reference.yaf.yaf-controller-abstract; - &reference.yaf.yaf-action-abstract; - &reference.yaf.yaf-view-interface; - &reference.yaf.yaf-view-simple; - &reference.yaf.yaf-loader; - &reference.yaf.yaf-plugin-abstract; - &reference.yaf.yaf-registry; - &reference.yaf.yaf-request-abstract; - &reference.yaf.yaf-request-http; - &reference.yaf.yaf-request-simple; - &reference.yaf.yaf-response-abstract; - &reference.yaf.yaf-response-cli; - &reference.yaf.yaf-response-http; - &reference.yaf.yaf-route-interface; - &reference.yaf.yaf-route-map; - &reference.yaf.yaf-route-regex; - &reference.yaf.yaf-route-rewrite; - &reference.yaf.yaf-router; - &reference.yaf.yaf-route-simple; - &reference.yaf.yaf-route-static; - &reference.yaf.yaf-route-supervar; - &reference.yaf.yaf-session; - &reference.yaf.yaf-exception; - &reference.yaf.yaf-exception-typeerror; - &reference.yaf.yaf-exception-startuperror; - &reference.yaf.yaf-exception-dispatchfailed; - &reference.yaf.yaf-exception-routerfailed; - &reference.yaf.yaf-exception-loadfailed; - &reference.yaf.yaf-exception-loadfailed-module; - &reference.yaf.yaf-exception-loadfailed-controller; - &reference.yaf.yaf-exception-loadfailed-action; - &reference.yaf.yaf-exception-loadfailed-view; - - - - diff --git a/reference/yaf/configure.xml b/reference/yaf/configure.xml deleted file mode 100644 index 5cf828f429..0000000000 --- a/reference/yaf/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;yaf - - -
    - - - diff --git a/reference/yaf/constants.xml b/reference/yaf/constants.xml deleted file mode 100644 index 926fb901a5..0000000000 --- a/reference/yaf/constants.xml +++ /dev/null @@ -1,222 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - Lorsqu'une erreur survient lors du démarrage, du routage, de la - distribution ou du chargement automatique, Yaf lève soit une sous-classe de - Yaf_Exception dont le code d'exception est - l'une des constantes YAF_ERR_*, soit déclenche une erreur - PHP du type correspondant — voir - Yaf_Dispatcher::throwException et - Yaf_Application::getLastErrorNo. - - - - - - YAF_VERSION - (string) - - - - La version de l'extension Yaf chargée, par exemple - "3.3.8". - - - - - - YAF_ENVIRON - (string) - - - - La valeur de la directive - yaf.environ - au moment du démarrage de l'extension, utilisée par - Yaf_Application pour sélectionner la section de - configuration. Vaut "product" par défaut. - - - - - - YAF_ERR_STARTUP_FAILED - (int) - - - - Échec du démarrage, valeur 512. Levée sous la forme - d'une Yaf_Exception_StartupError lorsque - Yaf_Application n'a pas pu être démarrée, par - exemple lorsque le répertoire de l'application est absent ou que la - configuration est invalide. - - - - - - YAF_ERR_ROUTE_FAILED - (int) - - - - Échec du routage, valeur 513. Levée sous la forme - d'une Yaf_Exception_RouterFailed lorsque aucune - route n'a été capable de router la requête. - - - - - - YAF_ERR_DISPATCH_FAILED - (int) - - - - Échec de la distribution, valeur 514. Levée sous la - forme d'une Yaf_Exception_DispatchFailed lorsque - la requête n'a pas pu être distribuée, par exemple lorsque la limite - yaf.forward_limit est - dépassée. - - - - - - YAF_ERR_NOTFOUND_MODULE - (int) - - - - Le module n'a pas pu être trouvé, valeur 515. Levée - sous la forme d'une - Yaf_Exception_LoadFailed_Module. - - - - - - YAF_ERR_NOTFOUND_CONTROLLER - (int) - - - - Le contrôleur n'a pas pu être trouvé, valeur 516. - Levée sous la forme d'une - Yaf_Exception_LoadFailed_Controller. - - - - - - YAF_ERR_NOTFOUND_ACTION - (int) - - - - L'action n'a pas pu être trouvée, valeur 517. Levée - sous la forme d'une - Yaf_Exception_LoadFailed_Action. - - - - - - YAF_ERR_NOTFOUND_VIEW - (int) - - - - Le script de vue n'a pas pu être trouvé, valeur 518. - Levée sous la forme d'une - Yaf_Exception_LoadFailed_View. - - - - - - YAF_ERR_CALL_FAILED - (int) - - - - L'appel d'une méthode a échoué, valeur 519. Utilisée - lorsqu'une méthode d'action ou un autre callable n'a pas pu être - invoqué. - - - - - - YAF_ERR_AUTOLOAD_FAILED - (int) - - - - Échec du chargement automatique, valeur 520. - Déclenchée par Yaf_Loader lorsque le fichier - d'une classe ne peut pas être chargé, par exemple lorsque le chemin - résolu est trop long. - - - - - - YAF_ERR_TYPE_ERROR - (int) - - - - Une erreur de type est survenue, valeur 521. Levée - sous la forme d'une - Yaf_Exception_TypeError lorsqu'un - argument ou une définition de classe est d'un type inattendu, par - exemple un contrôleur qui n'est pas une classe étendant - Yaf_Controller_Abstract. - - - - - - YAF_ERR_ACCESS_ERROR - (int) - - - - L'accès n'est pas autorisé, valeur 522. Utilisée, - par exemple, lors d'une tentative d'appel d'une méthode d'action qui - n'est pas publique. - - - (Disponible à partir de Yaf 3.2.0.) - - - - - - - - diff --git a/reference/yaf/ini.xml b/reference/yaf/ini.xml deleted file mode 100644 index 2c07db75da..0000000000 --- a/reference/yaf/ini.xml +++ /dev/null @@ -1,318 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Yaf &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yaf.library - "" - INI_ALL - - - - yaf.environ - "product" - INI_SYSTEM - - - - yaf.forward_limit - 5 - INI_ALL - - - - yaf.use_namespace - 0 - INI_ALL - - - - yaf.action_prefer - 0 - INI_ALL - - - - yaf.lowcase_path - 0 - INI_ALL - - - - yaf.use_spl_autoload - 0 - INI_ALL - - - - yaf.name_suffix - 1 - INI_ALL - - - - yaf.name_separator - "" - INI_ALL - - - - -
    -     - - &ini.descriptions.title; - - - - - La directive yaf.cache_config existait dans Yaf 2.x, - où elle mettait en cache le résultat de l'analyse du fichier de - configuration INI au sein du processus PHP. Elle a été supprimée dans - Yaf 3.0.0 et n'est plus reconnue. - - - - - - - - - yaf.library - string - - - - Le répertoire de bibliothèque global. Yaf_Loader - recherche dans ce répertoire les classes qui ne peuvent pas être - trouvées dans la bibliothèque locale de l'application (voir - application.library). - - - Voir aussi Yaf_Loader::getLibraryPath et - Yaf_Loader::setLibraryPath. - - - - - - yaf.environ - string - - - - Le nom de l'environnement, "product" par défaut. Il - est utilisé par Yaf_Application pour choisir la - section du fichier de configuration INI (son premier argument de - constructeur) qui devient la configuration de l'application. - - - Par exemple, si cette valeur est "product", Yaf - utilisera la section nommée [product] du fichier de - configuration INI comme configuration finale de - Yaf_Application. Le nom de l'environnement peut - également être redéfini pour chaque application en passant le second - argument du constructeur à - Yaf_Application::__construct. - - - - - - yaf.forward_limit - int - - - - Le nombre maximal de fois que - Yaf_Controller_Abstract::forward peut être - enchaîné au sein d'une même requête, 5 par défaut. - - - Il s'agit d'une protection contre les boucles récursives de - Yaf_Controller_Abstract::forward ; lorsque la - limite est dépassée, une exception - Yaf_Exception_DispatchFailed est lancée. Les - valeurs non positives sont ramenées à la valeur par défaut. - - - - - - yaf.use_namespace - int - - - - Lorsque cette directive est activée, toutes les classes déclarées par - Yaf sont nommées dans le style des namespaces : - - - \Yaf\Route\Rewrite -Yaf_Request_Http => \Yaf\Request\Http -]]> - - - Il existe une exception pour les classes dont le dernier composant est - un mot-clé réservé de PHP et ne peut donc pas être utilisé comme nom de - classe ; ces classes conservent le tiret bas dans leur dernier - composant : - - - \Yaf\Controller_Abstract -Yaf_Route_Static => \Yaf\Route_Static -]]> - - - - Un seul des deux styles de nommage est enregistré au démarrage de - l'extension, cette directive doit donc être définie avant le - chargement de l'extension ; elle ne peut pas être modifiée requête par - requête de manière utile. - - - - - - - yaf.action_prefer - int - - - - Lorsqu'il n'y a qu'une seule partie dans le - PATH_INFO, détermine si elle doit être considérée - comme un nom de contrôleur ou comme un nom d'action. - - - Si cette configuration est activée, le segment unique est considéré - comme un nom d'action, et le nom du contrôleur se rabat sur le - contrôleur par défaut ; sinon, il est considéré comme un nom de - contrôleur. - - - - - - yaf.lowcase_path - int - - - - Indique s'il faut mettre en minuscules tous les composants du chemin - lors du chargement automatique des classes. - - - - - - yaf.use_spl_autoload - int - - - - Lorsque cette valeur est activée, si Yaf_Loader - ne parvient pas à trouver une classe, il retournera &false;, laissant - ainsi la possibilité à d'autres fonctions de chargement automatique - d'être appelées. - - - Lorsque cette valeur est désactivée (le comportement par défaut), si - Yaf_Loader ne parvient pas à trouver une classe, - il retournera &true;, et le chargement automatique de la classe échoue - immédiatement : Yaf_Loader::autoload retourne - toujours &true; dans ce mode. - - - - Yaf enregistre son chargeur lors de l'instanciation d'un - Yaf_Application, aussi tout autre chargeur - automatique enregistré avant cette instanciation sera appelé avant - Yaf_Loader::autoload. - - - - - - - yaf.name_suffix - int - - - - Lorsque cette directive est activée (le comportement par défaut), - Yaf_Loader identifie une classe MVC par son - suffixe pour déterminer s'il s'agit d'une classe de contrôleur ou - d'action : IndexController, - IndexAction. - - - Lorsqu'elle est désactivée, Yaf_Loader examine à - la place le préfixe du nom de la classe : - Controller_Index, Action_Index. - - - - - - yaf.name_separator - string - - - - Lorsque cette directive n'est pas vide, Yaf_Loader - identifie les classes MVC grâce à ce séparateur plutôt qu'avec le tiret - bas qui sépare le nom et le suffixe MVC. - - - Par exemple, lorsque cette valeur est "_" et que - yaf.name_suffix est activée, - Yaf_Loader considérera - Index_Controller comme une classe de contrôleur, - tandis que IndexController sera considérée comme une - classe ordinaire. Lorsqu'elle est vide (le comportement par défaut), le - tiret bas est utilisé. - - - - - -
    - - diff --git a/reference/yaf/setup.xml b/reference/yaf/setup.xml deleted file mode 100644 index 75cfeb954b..0000000000 --- a/reference/yaf/setup.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yaf. - - - Yaf n'a aucune dépendance externe. Il s'installe avec : - - - - À partir de la version 3.3.8, Yaf peut également être installé avec - &link.pie;, l'installateur d'extensions PHP : - - - - - - Le code source est hébergé sur - GitHub. Pour compiler - l'extension à partir des sources : - - - - puis la charger en ajoutant la ligne suivante dans le - php.ini : - - - - - - &pecl.windows.download.avail; - -
    - - - - &reference.yaf.ini; - - -     - - diff --git a/reference/yaf/tutorials.xml b/reference/yaf/tutorials.xml deleted file mode 100644 index dbe48391e5..0000000000 --- a/reference/yaf/tutorials.xml +++ /dev/null @@ -1,420 +0,0 @@ - - - - - &reftitle.examples; - -
    - Démarrage rapide - - - Une arborescence d'application classique - - - - - Il faut définir le DocumentRoot du serveur web sur le - répertoire public, de sorte que seules les - ressources publiques soient accessibles depuis le web. - - - - - Une arborescence d'application multi-modules - - - - - Dans une application multi-modules, chaque module possède ses propres - répertoires controllers et views - sous application/modules/<NomDuModule>/. Les - modules enregistrés sont déclarés dans - application.modules. - - - - - Point d'entrée - - Le fichier index.php situé dans le répertoire public - est le seul point d'entrée de l'application ; il faut y réécrire toutes - les requêtes (il est possible d'utiliser un fichier - .htaccess avec Apache + mod_php, ou l'équivalent - pour le serveur web utilisé, voir ci-dessous). - - -bootstrap() //appelle les méthodes d'amorçage définies dans Bootstrap.php - ->run(); -?> -]]> - - - - - Règle de réécriture - - "/index.php/$1", - ) -} -]]> - - - - - Amorçage - - Toute méthode de la classe Bootstrap dont le nom - commence par _init est automatiquement appelée, dans - l'ordre de définition, par - Yaf_Application::bootstrap. Chacune de ces - méthodes reçoit l'instance de Yaf_Dispatcher en - argument. Les méthodes portant un autre nom ne sont pas appelées - automatiquement. - - - -]]> - - - - - Configuration de l'application - - application.ini est le fichier de configuration de - l'application. Les constantes définies dans - index.php peuvent y être utilisées, et les sections - peuvent hériter les unes des autres. - - - - - - - - Configuration de l'application sous forme de tableau PHP - - Outre un fichier de configuration INI, il est également possible de - passer un simple tableau PHP à - Yaf_Application::__construct en guise de - configuration. - - - array( - "directory" => APPLICATION_PATH . "/application/", - ), -); - -$app = new Yaf_Application($config); -?> -]]> - - - - - Contrôleur par défaut - - Dans Yaf, le contrôleur par défaut se nomme - IndexController : - - -getView()->content = "Hello World"; - } -} -?> -]]> - - - - - Modèle de vue par défaut - - Le script de vue du contrôleur/action par défaut est - application/views/index/index.phtml. Yaf fournit un - petit moteur de vue nommé Yaf_View_Simple, dont - les modèles sont de simples scripts PHP. - - - - - Hello World - - - - - -]]> - - - - - Exécution de l'application - - En pointant le navigateur sur le domaine configuré - (par exemple http://www.example.com), la réponse - ressemblera à : - - &example.outputs.similar; - - - - Hello World - - - hello world - - -]]> - - - - L'exemple minimal ci-dessus peut également être généré avec le - générateur de code de Yaf (tools/cg/yaf_cg), - livré avec le dépôt - source de Yaf : - - - - - - yaf_cg génère un squelette plus complet et - commenté que celui présenté dans ce tutoriel : un point d'entrée - public/ avec ses règles de réécriture, un - Bootstrap avec la configuration, la mise en place des plugins et des - routes personnalisées, un modèle d'exemple, un contrôleur d'erreur et - des modèles de vue. C'est un bon point de départ pour une véritable - application. - - - - -
    - -
    - Routes personnalisées - - - Routes personnalisées - - Outre la route par défaut Yaf_Route_Static, des - routes personnalisées peuvent être enregistrées dans la pile de routes - de Yaf_Router, généralement dans une méthode - _initRoute du Bootstrap, à l'aide de - Yaf_Router::addRoute. Les routes peuvent aussi - être déclarées dans des fichiers de configuration et chargées avec - Yaf_Router::addConfig. - - -getRouter(); - - // /user/123 -> controller=user, action=index, id=123 - $router->addRoute("user", new Yaf_Route_Rewrite( - "/user/:id", - array("controller" => "user", "action" => "index") - )); - } -} -?> -]]> - - - -
    - -
    - Plugins - - - Plugins - - Un plugin s'insère dans le cycle de distribution en étendant - Yaf_Plugin_Abstract et en redéfinissant une ou - plusieurs de ses six méthodes d'accrochage, puis il est enregistré - auprès du distributeur avec - Yaf_Dispatcher::registerPlugin, - typiquement dans le Bootstrap : - - -registerPlugin(new UserPlugin()); - } -} -?> -]]> - - - -
    - -     - diff --git a/reference/yaf/yaf-action-abstract.xml b/reference/yaf/yaf-action-abstract.xml deleted file mode 100644 index ff33b3eb42..0000000000 --- a/reference/yaf/yaf-action-abstract.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - La classe Yaf_Action_Abstract - Yaf_Action_Abstract - - - - -
    - &reftitle.intro; - - Une action peut être définie dans un fichier séparé en Yaf (voir - Yaf_Controller_Abstract). Autrement dit, une - méthode d'action peut aussi être une classe - Yaf_Action_Abstract. - - - Comme il devrait y avoir un point d'entrée pouvant être appelé par Yaf, - il faut implémenter la méthode abstraite - Yaf_Action_Abstract::execute dans la classe - d'action personnalisée. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Action_Abstract - - - - - Yaf_Action_Abstract - - - - extends - Yaf_Controller_Abstract - - - - &Properties; - - protected - _controller - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _controller - - - L'instance du contrôleur à laquelle appartient cette action, - récupérable avec - Yaf_Action_Abstract::getController. - - - - -
    - - - -     - - &reference.yaf.entities.yaf-action-abstract; - -     - - diff --git a/reference/yaf/yaf-application.xml b/reference/yaf/yaf-application.xml deleted file mode 100644 index 52f2378580..0000000000 --- a/reference/yaf/yaf-application.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - La classe Yaf_Application - Yaf_Application - - - - -
    - &reftitle.intro; - - Yaf_Application fournit un mécanisme d'amorçage - pour les applications, qui offre des ressources réutilisables, des - classes d'amorçage communes ou par module, ainsi que la vérification - des dépendances. - - - - Yaf_Application implémente le patron singleton, - et Yaf_Application ne peut être ni sérialisé ni - désérialisé, ce qui pose des problèmes lorsqu'on tente d'utiliser - PHPUnit pour écrire des cas de test pour Yaf. - - - Il est possible d'utiliser l'annotation - @backupGlobals de PHPUnit pour contrôler les - opérations de sauvegarde et de restauration des variables globales, - ce qui résout ce problème. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Application - - - - - final - Yaf_Application - - - - &Properties; - - protected - config - - - protected - dispatcher - - - protected - static - _app - - - protected - _modules - - - protected - _running - - - protected - _environ - - - protected - _err_no - - - protected - _err_msg - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - config - - L'objet de configuration de l'application. - - - - dispatcher - - L'instance de Yaf_Dispatcher utilisée - par cette application. - - - - _app - - Référence statique vers l'unique instance d'application en - cours d'exécution. - - - - _modules - - La liste des noms de modules enregistrés, analysée à partir de - application.modules. - - - - _running - - Indique si l'application est en cours d'exécution. - - - - _environ - - Le nom de l'environnement de l'application, valant - "product" par défaut. - - - - _err_no - - Le code de la dernière erreur, l'une des constantes - YAF_ERR_*. - - - - _err_msg - - Le message de la dernière erreur. - - - -
    - - - -     - - &reference.yaf.entities.yaf-application; - -     - - diff --git a/reference/yaf/yaf-bootstrap-abstract.xml b/reference/yaf/yaf-bootstrap-abstract.xml deleted file mode 100644 index dc503a85c2..0000000000 --- a/reference/yaf/yaf-bootstrap-abstract.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - La classe Yaf_Bootstrap_Abstract - Yaf_Bootstrap_Abstract - - - - -
    - &reftitle.intro; - - Bootstrap est un mécanisme utilisé pour réaliser certaines - configurations initiales avant l'exécution d'une application. - - - Les utilisateurs peuvent définir leur propre classe Bootstrap en - héritant de Yaf_Bootstrap_Abstract - - - Toute méthode déclarée dans la classe Bootstrap et commençant par - "_init" sera appelée une par une par - Yaf_Application::bootstrap, selon leur ordre - de définition. - -
    - - -
    - &reftitle.examples; - - Exemple avec Bootstrap - - array( - "directory" => dirname(__FILE__) . "/application/", - ), - ); - - $app = new Yaf_Application($config); - $app->bootstrap(); -?> -]]> - - &example.outputs.similar; - - - - -
    - -
    - &reftitle.classsynopsis; - - - - Yaf_Bootstrap_Abstract - - - - - abstract - Yaf_Bootstrap_Abstract - - - &Properties; - - &Methods; - - - -
    - -     - -     - - diff --git a/reference/yaf/yaf-config-abstract.xml b/reference/yaf/yaf-config-abstract.xml deleted file mode 100644 index 7d361573ee..0000000000 --- a/reference/yaf/yaf-config-abstract.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - La classe Yaf_Config_Abstract - Yaf_Config_Abstract - - - - -
    - &reftitle.intro; - - Yaf_Config_Abstract est la classe de base des - adaptateurs de configuration. Elle fournit une manière uniforme d'accéder à un ensemble de - valeurs de configuration via une syntaxe de propriétés imbriquées - ($config->section->key), un accès de type tableau et - l'itération. Les implémentations concrètes sont - Yaf_Config_Ini (en lecture seule, fichiers INI avec - héritage de sections) et Yaf_Config_Simple - (tableaux PHP, modifiables). - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Config_Abstract - - - - - abstract - Yaf_Config_Abstract - - - - &Properties; - - protected - _config - - - protected - _readonly - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - _config - - - - - - _readonly - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-config-abstract; - -     - - diff --git a/reference/yaf/yaf-config-ini.xml b/reference/yaf/yaf-config-ini.xml deleted file mode 100644 index 5e7e75ac0b..0000000000 --- a/reference/yaf/yaf-config-ini.xml +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - La classe Yaf_Config_Ini - Yaf_Config_Ini - - - - -
    - &reftitle.intro; - - Yaf_Config_Ini permet aux développeurs de stocker - des données de configuration dans le format INI familier et de les lire - dans l'application en utilisant une syntaxe de propriétés d'objets - imbriquées. Le format INI est prévu pour fournir à la fois la - possibilité d'avoir une hiérarchie de clés de données de configuration - et un héritage entre les sections de données de configuration. La - hiérarchie des données de configuration est prise en charge en séparant - les clés par le caractère point ("."). Une section - peut étendre une autre section, ou en hériter, en faisant suivre le nom - de la section par le caractère deux-points (":") puis - par le nom de la section dont les données doivent être héritées. - - - - Yaf_Config_Ini utilise la fonction PHP - parse_ini_file. Il faut consulter cette - documentation pour connaître ses comportements spécifiques, qui se - propagent à Yaf_Config_Ini, comme la façon dont - sont gérées les valeurs spéciales "&true;", "&false;", "yes", "no" et - "&null;". - - - - - Yaf_Config_Ini analyse le fichier de - configuration à chaque requête. Si une application gère une grande - quantité de configuration (essentiellement statique), il est préférable - d'envisager l'extension Yaconf : elle - conserve la configuration en mémoire partagée pendant tout le cycle de - vie de PHP, de sorte qu'elle n'est analysée qu'une seule fois et qu'elle - est accessible bien plus efficacement. Yaconf comprend exactement la - même syntaxe INI — des clés séparées par des points et un héritage entre - sections grâce à "[section : parent]" — si bien que - le fichier application.ini existant peut être servi - tel quel par Yaconf ; seule la façon dont il est passé à - Yaf_Application::__construct change (voir - l'astuce dans Configuration de - l'application). - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Config_Ini - - - - - Yaf_Config_Ini - - - - extends - Yaf_Config_Abstract - - - - Iterator - - - - ArrayAccess - - - - Countable - - - - &Properties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _config - - - - - - _readonly - - - - - -
    - - -
    - &reftitle.examples; - - Exemple avec <function>Yaf_Config_Ini</function> - - Cet exemple illustre une utilisation basique de Yaf_Config_Ini pour - charger des données de configuration depuis un fichier INI. Dans cet - exemple, il y a des données de configuration à la fois pour un système - de production et pour un système de pré-production. Comme les données de - configuration du système de pré-production sont très similaires à celles - de production, la section de pré-production hérite de la section de - production. Dans ce cas, la décision est arbitraire et aurait pu être - écrite dans l'autre sens, avec la section de production héritant de la - section de pré-production, mais ce n'est pas forcément le cas pour des - situations plus complexes. Supposons alors que les données de - configuration suivantes soient contenues dans /path/to/config.ini : - - - - - -database->params->host); -var_dump($config->database->params->dbname); -var_dump($config->get("database.params.username")); -?> -]]> - - &example.outputs.similar; - - - - -
    - -     - - &reference.yaf.entities.yaf-config-ini; - -     - - diff --git a/reference/yaf/yaf-config-simple.xml b/reference/yaf/yaf-config-simple.xml deleted file mode 100644 index 615fc3c5db..0000000000 --- a/reference/yaf/yaf-config-simple.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - La classe Yaf_Config_Simple - Yaf_Config_Simple - - - - -
    - &reftitle.intro; - - Yaf_Config_Simple est un adaptateur de configuration - reposant sur un tableau PHP (ou, éventuellement, sur un fichier INI). - Contrairement à Yaf_Config_Ini, il est modifiable - par défaut : les valeurs peuvent être changées à l'exécution, ce qui le - rend adapté aussi bien à une configuration construite par programmation - qu'à une configuration devant être ajustée pendant la requête. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Config_Simple - - - - - Yaf_Config_Simple - - - - extends - Yaf_Config_Abstract - - - - Iterator - - - - ArrayAccess - - - - Countable - - - - &Properties; - - protected - _readonly - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _config - - - - - - _readonly - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-config-simple; - -     - - diff --git a/reference/yaf/yaf-controller-abstract.xml b/reference/yaf/yaf-controller-abstract.xml deleted file mode 100644 index 2ffb709828..0000000000 --- a/reference/yaf/yaf-controller-abstract.xml +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - La classe Yaf_Controller_Abstract - Yaf_Controller_Abstract - - - - -
    - &reftitle.intro; - - Yaf_Controller_Abstract est le cœur du système de - Yaf. MVC signifie Modèle-Vue-Contrôleur et est un patron de conception - destiné à séparer la logique applicative de la logique d'affichage. - - - Tout contrôleur personnalisé doit hériter de - Yaf_Controller_Abstract. - - - Puisque Yaf_Controller_Abstract::__construct est - appelée par Yaf sans aucun argument, - Yaf_Controller_Abstract fournit un point d'entrée - alternatif tenant lieu de constructeur : - Yaf_Controller_Abstract::init. - - - Si une méthode init() est définie dans le contrôleur personnalisé, elle - sera appelée dès que le contrôleur est instancié. - - - Une action peut avoir des arguments : lorsqu'une requête arrive, s'il - existe après routage des variables de même nom dans les paramètres de la - requête (voir Yaf_Request_Abstract::getParam), - Yaf les transmet à la méthode d'action - (voir Yaf_Action_Abstract::execute). - - - Ces arguments sont récupérés directement, sans filtrage : ils devraient - être traités avec soin avant d'être utilisés. - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Controller_Abstract - - - - - abstract - Yaf_Controller_Abstract - - - - &Properties; - - protected - actions - - - protected - _module - - - protected - _name - - - protected - _request - - - protected - _response - - - protected - _invoke_args - - - protected - _view - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - actions - - - Il est également possible de définir une méthode d'action dans un script - PHP séparé en utilisant cette propriété et - Yaf_Action_Abstract. - - Définition d'une action dans un fichier séparé - - "actions/Dummy_action.php", - ); - - /* une méthode d'action peut avoir des arguments */ - public function indexAction($name, $id) { - /* $name et $id sont des données brutes non sûres */ - assert($name == $this->getRequest()->getParam("name")); - assert($id == $this->_request->getParam("id")); - } -} -?> -]]> - - - - Dummy_action.php - - -]]> - - - - - - - _module - - - Le nom du module auquel appartient le contrôleur. - - - - - _name - - - Le nom du contrôleur. - - - - - _request - - - L'objet Yaf_Request_Abstract courant. - - - - - _response - - - L'objet Yaf_Response_Abstract courant. - - - - - _invoke_args - - - Les arguments d'invocation transmis à l'action via - Yaf_Controller_Abstract::forward, sous la forme - d'un tableau indexé par nom d'argument. - - - - - _view - - - L'objet Yaf_View_Interface utilisé pour le rendu - des vues. - - - - -
    - - - -     - - &reference.yaf.entities.yaf-controller-abstract; - -     - - diff --git a/reference/yaf/yaf-dispatcher.xml b/reference/yaf/yaf-dispatcher.xml deleted file mode 100644 index a22e593d78..0000000000 --- a/reference/yaf/yaf-dispatcher.xml +++ /dev/null @@ -1,215 +0,0 @@ - - - - - - La classe Yaf_Dispatcher - Yaf_Dispatcher - - - - -
    - &reftitle.intro; - - Le but de Yaf_Dispatcher est d'initialiser - l'environnement de la requête, de router la requête entrante, puis de - distribuer les actions découvertes ; il agrège toutes les réponses et - les retourne une fois le processus terminé. - - - Yaf_Dispatcher implémente également le patron - singleton, ce qui signifie qu'une seule instance de cette classe peut - être disponible à un instant donné. Ceci lui permet aussi d'agir comme - un registre dans lequel les autres objets du processus de distribution - peuvent puiser. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Dispatcher - - - - - final - Yaf_Dispatcher - - - - &Properties; - - protected - _router - - - protected - _view - - - protected - _request - - - protected - _plugins - - - protected - static - _instance - - - protected - _auto_render - - - protected - _return_response - - - protected - _instantly_flush - - - protected - _default_module - - - protected - _default_controller - - - protected - _default_action - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _router - - L'instance de Yaf_Router utilisée par le - distributeur pour router les requêtes. - - - - _view - - L'implémentation de Yaf_View_Interface - utilisée pour rendre les vues, initialisée paresseusement lors de la - première distribution. - - - - _request - - L'objet requête en cours de distribution. - - - - _plugins - - La liste des plugins enregistrés avec - Yaf_Dispatcher::registerPlugin. - - - - _instance - - Référence statique vers l'unique instance du - distributeur. - - - - _auto_render - - Indique si le distributeur rend automatiquement la vue après la - distribution. Vaut &true; par défaut. - - - - _return_response - - Indique si Yaf_Application::run - retourne l'objet réponse au lieu de l'envoyer directement. Vaut - &false; par défaut. - - - - _instantly_flush - - Indique si le corps de la réponse est envoyé immédiatement - lorsqu'il est défini. Vaut &true; par défaut. - - - - _default_module - - Le nom du module par défaut, issu de l'entrée de configuration - application.dispatcher.defaultModule. - - - - _default_controller - - Le nom du contrôleur par défaut, issu de l'entrée de - configuration - application.dispatcher.defaultController. - - - - _default_action - - Le nom de l'action par défaut, issu de l'entrée de - configuration - application.dispatcher.defaultAction. - - - -
    - - - -     - - &reference.yaf.entities.yaf-dispatcher; - -     - - diff --git a/reference/yaf/yaf-exception-dispatchfailed.xml b/reference/yaf/yaf-exception-dispatchfailed.xml deleted file mode 100644 index d75089f13e..0000000000 --- a/reference/yaf/yaf-exception-dispatchfailed.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - La classe Yaf_Exception_DispatchFailed - Yaf_Exception_DispatchFailed - - - - -
    - &reftitle.intro; - - Yaf_Exception_DispatchFailed est levée lorsque le - distributeur échoue à distribuer la requête routée vers une action de - contrôleur. Son code d'erreur est 514. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_DispatchFailed - - - - - Yaf_Exception_DispatchFailed - - - - extends - Yaf_Exception - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -     - -     - - diff --git a/reference/yaf/yaf-exception-loadfailed-action.xml b/reference/yaf/yaf-exception-loadfailed-action.xml deleted file mode 100644 index a820ea6a00..0000000000 --- a/reference/yaf/yaf-exception-loadfailed-action.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - La classe Yaf_Exception_LoadFailed_Action - Yaf_Exception_LoadFailed_Action - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed_Action est levée lorsque - l'action demandée est introuvable ou ne peut pas être chargée. Son code d'erreur est - 517. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed_Action - - - - - Yaf_Exception_LoadFailed_Action - - - - extends - Yaf_Exception_LoadFailed - - - - &Properties; - - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -     - -     - - diff --git a/reference/yaf/yaf-exception-loadfailed-controller.xml b/reference/yaf/yaf-exception-loadfailed-controller.xml deleted file mode 100644 index 9d016220ee..0000000000 --- a/reference/yaf/yaf-exception-loadfailed-controller.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - La classe Yaf_Exception_LoadFailed_Controller - Yaf_Exception_LoadFailed_Controller - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed_Controller est levée - lorsque le contrôleur demandé ne peut être trouvé ou chargé. Son code - d'erreur est 516. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed_Controller - - - - - Yaf_Exception_LoadFailed_Controller - - - - extends - Yaf_Exception_LoadFailed - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - -
    - - - - - -     - -     - - diff --git a/reference/yaf/yaf-exception-loadfailed-module.xml b/reference/yaf/yaf-exception-loadfailed-module.xml deleted file mode 100644 index 3eddbeb5e3..0000000000 --- a/reference/yaf/yaf-exception-loadfailed-module.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - La classe Yaf_Exception_LoadFailed_Module - Yaf_Exception_LoadFailed_Module - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed_Module est levée lorsque le - module demandé est introuvable ou ne peut pas être chargé. Son code d'erreur - est 515. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed_Module - - - - - Yaf_Exception_LoadFailed_Module - - - - extends - Yaf_Exception_LoadFailed - - - - &Properties; - - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - -     - -     - - diff --git a/reference/yaf/yaf-exception-loadfailed-view.xml b/reference/yaf/yaf-exception-loadfailed-view.xml deleted file mode 100644 index cc8813edcd..0000000000 --- a/reference/yaf/yaf-exception-loadfailed-view.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - La classe Yaf_Exception_LoadFailed_View - Yaf_Exception_LoadFailed_View - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed_View est levée lorsque le - script de vue (template) demandé est introuvable ou ne peut être chargé. - Son code d'erreur est 518. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed_View - - - - - Yaf_Exception_LoadFailed_View - - - - extends - Yaf_Exception_LoadFailed - - - - &Properties; - - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -     - -     - - diff --git a/reference/yaf/yaf-exception-loadfailed.xml b/reference/yaf/yaf-exception-loadfailed.xml deleted file mode 100644 index 1d3e00d753..0000000000 --- a/reference/yaf/yaf-exception-loadfailed.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - La classe Yaf_Exception_LoadFailed - Yaf_Exception_LoadFailed - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed est levée lorsque le chargeur - ne parvient pas à charger un script requis. Son code d'erreur est - 520. Les échecs plus spécifiques sont représentés par - ses sous-classes Yaf_Exception_LoadFailed_Module, - Yaf_Exception_LoadFailed_Controller, - Yaf_Exception_LoadFailed_Action et - Yaf_Exception_LoadFailed_View. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed - - - - - Yaf_Exception_LoadFailed - - - - extends - Yaf_Exception - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -     - -     - - diff --git a/reference/yaf/yaf-exception-routerfailed.xml b/reference/yaf/yaf-exception-routerfailed.xml deleted file mode 100644 index e66bf26bac..0000000000 --- a/reference/yaf/yaf-exception-routerfailed.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - La classe Yaf_Exception_RouterFailed - Yaf_Exception_RouterFailed - - - - -
    - &reftitle.intro; - - Yaf_Exception_RouterFailed est levée lorsque le routage - échoue, par exemple lorsqu'aucune route enregistrée ne correspond à la requête - entrante. Son code d'erreur est 513. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_RouterFailed - - - - - Yaf_Exception_RouterFailed - - - - extends - Yaf_Exception - - - - &Properties; - - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -     - -     - - diff --git a/reference/yaf/yaf-exception-startuperror.xml b/reference/yaf/yaf-exception-startuperror.xml deleted file mode 100644 index 1fa890f335..0000000000 --- a/reference/yaf/yaf-exception-startuperror.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - La classe Yaf_Exception_StartupError - Yaf_Exception_StartupError - - - - -
    - &reftitle.intro; - - Yaf_Exception_StartupError est levée lorsque - l'application ne parvient pas à démarrer, c'est-à-dire lorsqu'une erreur - survient pendant l'initialisation de Yaf_Application - avant le début du routage. Son code d'erreur est 512. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_StartupError - - - - - Yaf_Exception_StartupError - - - - extends - Yaf_Exception - - - - &Properties; - - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -     - -     - - diff --git a/reference/yaf/yaf-exception-typeerror.xml b/reference/yaf/yaf-exception-typeerror.xml deleted file mode 100644 index 9ea25893df..0000000000 --- a/reference/yaf/yaf-exception-typeerror.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - La classe Yaf_Exception_TypeError - Yaf_Exception_TypeError - - - - -
    - &reftitle.intro; - - Yaf_Exception_TypeError est levée lorsqu'un argument - passé à une méthode de Yaf est d'un type inattendu ou d'une valeur invalide. - Son code d'erreur est 521. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_TypeError - - - - - Yaf_Exception_TypeError - - - - extends - Yaf_Exception - - - - &Properties; - - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -     - -     - - diff --git a/reference/yaf/yaf-exception.xml b/reference/yaf/yaf-exception.xml deleted file mode 100644 index 743c4e7087..0000000000 --- a/reference/yaf/yaf-exception.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - La classe Yaf_Exception - Yaf_Exception - - - - -
    - &reftitle.intro; - - Yaf_Exception est la classe de base de toutes les - exceptions levées par Yaf. Toutes les autres classes d'exception de Yaf en héritent. - - - Elle étend RuntimeException lorsque l'extension SPL est - chargée, et la classe native Exception sinon. - Les exceptions levées par Yaf portent un code d'erreur qui identifie le type - d'échec. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception - - - - - Yaf_Exception - - - - extends - RuntimeException - - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - -     - - &reference.yaf.entities.yaf-exception; - -     - - diff --git a/reference/yaf/yaf-loader.xml b/reference/yaf/yaf-loader.xml deleted file mode 100644 index a4ea530c73..0000000000 --- a/reference/yaf/yaf-loader.xml +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - La classe Yaf_Loader - Yaf_Loader - - - - -
    - &reftitle.intro; - - Yaf_Loader introduit une solution complète de - chargement automatique pour Yaf. - - - Lors de la première récupération d'une instance de - Yaf_Application, Yaf_Loader - instancie un singleton et s'enregistre auprès de spl_autoload. Il est - possible de récupérer une instance à l'aide de - Yaf_Loader::getInstance - - - Yaf_Loader ne tente de charger une classe qu'une - seule fois ; en cas d'échec, selon la valeur de yaf.use_spl_autoload, si cette - configuration est à On, Yaf_Loader::autoload - retournera &false;, laissant ainsi sa chance à une autre fonction de - chargement automatique. Si elle est à Off (valeur par défaut), - Yaf_Loader::autoload retournera &true;, et surtout - une alerte très utile sera déclenchée (très utile pour découvrir pourquoi - une classe n'a pas pu être chargée). - - - Il est recommandé de laisser yaf.use_spl_autoload à Off, à moins qu'une - bibliothèque ne dispose de son propre mécanisme de chargement automatique - et qu'il soit impossible de le réécrire. - - - - - Par défaut, Yaf_Loader suppose que toutes les - bibliothèques (les scripts définissant des classes) sont stockées dans le - répertoire global des bibliothèques, - qui est défini dans le php.ini (yaf.library). - - - - Pour que Yaf_Loader recherche certaines classes - (bibliothèques) dans le répertoire - local des classes (qui est défini dans application.ini, et qui vaut - par défaut application.directory . "/library"), - il faut enregistrer le préfixe de classe à l'aide de - Yaf_Loader::registerLocalNameSpace - - - - Voici quelques exemples (en supposant que APPLICATION_PATH vaut application.directory) : - - Exemple de configuration - - - - - - En supposant que l'espace de noms local suivant est enregistré : - - Enregistrement d'un espace de noms local - -registerLocalNameSpace(array("Foo", "Bar")); - } -} -?> -]]> - - - - Puis les exemples de chargement automatique : - - Exemple de chargement de classe - - - // APPLICATION_PATH/library/Foo/Bar/Test.php - -class GLO_Name => - // /global_dir/Glo/Name.php - -class BarNon_Test - // /global_dir/Barnon/Test.php -]]> - - - - - Exemple de chargement d'une classe avec namespace - - - // APPLICATION_PATH/library/Foo/Bar/Dummy.php - -class \FooBar\Bar\Dummy => - // /global_dir/FooBar/Bar/Dummy.php -]]> - - - - - - Il est à noter que tous les dossiers commencent par une majuscule ; il est - possible de les mettre en minuscules en définissant yaf.lowcase_path = On dans le php.ini - - - - Yaf_Loader est également conçu pour charger les - classes MVC, et la règle est la suivante : - - Exemple de chargement de classes MVC - - -// APPLICATION_PATH/controllers/ - -Model Classes => -// APPLICATION_PATH/models/ - -Plugin Classes => -// APPLICATION_PATH/plugins/ -]]> - - - - Yaf identifie le suffixe d'une classe (c'est le comportement par défaut, il - est aussi possible de passer au préfixe en modifiant la configuration yaf.name_suffix) pour déterminer s'il - s'agit d'une classe MVC : - - Distinction des classes MVC - - - // ***Controller - -Model Classes => - // ***Model - -Plugin Classes => - // ***Plugin -]]> - - - - quelques exemples : - - Exemple de chargement MVC - - - // APPLICATION_PATH/models/Data.php - -class DummyPlugin => - // APPLICATION_PATH/plugins/Dummy.php - -class A_B_TestModel => - // APPLICATION_PATH/models/A/B/Test.php -]]> - - - - - - À partir de la version 2.1.18, Yaf gère le chargement automatique des - contrôleurs côté script utilisateur (c'est-à-dire le chargement automatique - déclenché par un script PHP utilisateur, par exemple l'accès à une - propriété statique d'un contrôleur dans le Bootstrap ou dans les plugins), - mais le chargeur automatique ne cherche le script de la classe du - contrôleur que dans le dossier du module par défaut, à savoir - "APPLICATION_PATH/controllers/". - - - de plus, le répertoire sera affecté par yaf.lowcase_path. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Loader - - - - - Yaf_Loader - - - - &Properties; - - protected - _local_ns - - - protected - _library - - - protected - _global_library - - - static - _instance - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _local_ns - - - - - - _library - - - Par défaut, cette valeur est application.directory . "/library" ; - il est possible de la modifier soit dans le fichier - application.ini (application.library), soit par un appel à - Yaf_Loader::setLibraryPath - - - - - _global_library - - - - - - _instance - - - - - -
    - - - -     - - - &reference.yaf.entities.yaf-loader; - -     - - diff --git a/reference/yaf/yaf-plugin-abstract.xml b/reference/yaf/yaf-plugin-abstract.xml deleted file mode 100644 index 0219cead06..0000000000 --- a/reference/yaf/yaf-plugin-abstract.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - La classe Yaf_Plugin_Abstract - Yaf_Plugin_Abstract - - - - -
    - &reftitle.intro; - - Les plugins apportent la possibilité d'étendre et de personnaliser - facilement le framework. Un plugin est une classe qui étend - Yaf_Plugin_Abstract et qui redéfinit une ou - plusieurs méthodes d'accroche, appelées automatiquement à des moments - fixes du cycle de distribution : avant et après le routage, avant et - après la boucle de distribution, et avant et après chaque distribution - unitaire. - - - Un plugin est attaché au distributeur avec - Yaf_Dispatcher::registerPlugin, généralement dans - le Bootstrap ; une fois enregistré, toutes les méthodes d'accroche que le - plugin implémente sont appelées au moment voulu, chacune recevant les - instances courantes de Yaf_Request_Abstract et de - Yaf_Response_Abstract. - -
    - - -
    - &reftitle.examples; - - Exemple d'un plugin - -registerPlugin(new TestPlugin()); - } - } - - /* La classe du plugin doit être placée ici : ./application/plugins/ */ - class TestPlugin extends Yaf_Plugin_Abstract { - public function routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - /* avant le routage - dans cette accroche, il est possible de réécrire des URL */ - var_dump("routerStartup"); - } - public function routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - /* routage terminé - dans cette accroche, il est possible de vérifier l'authentification */ - var_dump("routerShutdown"); - } - public function dispatchLoopStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - var_dump("dispatchLoopStartup"); - } - public function preDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - var_dump("preDispatch"); - } - public function postDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - var_dump("postDispatch"); - } - public function dispatchLoopShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - /* dernière accroche - dans cette accroche, il est possible de journaliser ou d'implémenter la mise en page */ - var_dump("dispatchLoopShutdown"); - } - } - - Class IndexController extends Yaf_Controller_Abstract { - public function indexAction() { - return FALSE; //empêche le rendu - } - } - - $config = array( - "application" => array( - "directory" => dirname(__FILE__) . "/application/", - ), - ); - - $app = new Yaf_Application($config); - $app->bootstrap()->run(); -?> -]]> - - &example.outputs.similar; - - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Plugin_Abstract - - - - - Yaf_Plugin_Abstract - - - - - &Methods; - - - - -
    - -     - - &reference.yaf.entities.yaf-plugin-abstract; - -     - - diff --git a/reference/yaf/yaf-registry.xml b/reference/yaf/yaf-registry.xml deleted file mode 100644 index 457071f49a..0000000000 --- a/reference/yaf/yaf-registry.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - La classe Yaf_Registry - Yaf_Registry - - - - -
    - &reftitle.intro; - - Yaf_Registry est un espace de stockage global de couples - clé-valeur. Toutes ses méthodes sont statiques, ce qui la rend accessible - partout et permet de lire ou d'écrire n'importe quelle donnée personnalisée - depuis n'importe quel endroit du code, selon les besoins. - - - Elle sert typiquement à conserver les objets initialisés dans le Bootstrap - (une connexion à une base de données, un journaliseur, une configuration - partagée) afin que les contrôleurs, les actions et les plugins puissent les - récupérer sans avoir à se les transmettre. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Registry - - - - - Yaf_Registry - - - - &Properties; - - static - _instance - - - protected - _entries - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _instance - - - - - - _entries - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-registry; - -     - - diff --git a/reference/yaf/yaf-request-abstract.xml b/reference/yaf/yaf-request-abstract.xml deleted file mode 100644 index 58aa1d6a9e..0000000000 --- a/reference/yaf/yaf-request-abstract.xml +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - La classe Yaf_Request_Abstract - Yaf_Request_Abstract - - - - -
    - &reftitle.intro; - - Yaf_Request_Abstract est la classe de base des - objets de requête. Elle encapsule l'environnement de la requête : le module, - le contrôleur et l'action résolus par le routage, les paramètres de la - requête, ainsi que les accesseurs aux superglobales (chaîne de requête, - POST, cookie, serveur, environnement et fichiers téléchargés). - - - Deux implémentations concrètes sont fournies : - Yaf_Request_Http, initialisée à partir d'une - véritable requête web, et Yaf_Request_Simple, une - requête synthétique utilisée dans les tests et les scripts CLI. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Request_Abstract - - - - - Yaf_Request_Abstract - - - - &Constants; - - const - string - Yaf_Request_Abstract::SCHEME_HTTP - http - - - const - string - Yaf_Request_Abstract::SCHEME_HTTPS - https - - - &Properties; - - public - module - - - public - controller - - - public - action - - - public - method - - - protected - params - - - protected - language - - - protected - _exception - - - protected - _base_uri - - - protected - uri - - - protected - dispatched - - - protected - routed - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - module - - - - - - controller - - - - - - action - - - - - - method - - - - - - params - - - - - - language - - - - - - _exception - - - - - - _base_uri - - - - - - uri - - - - - - dispatched - - - - - - routed - - - - - -
    - - - - -
    - &reftitle.constants; - - - - Yaf_Request_Abstract::SCHEME_HTTP - - - - - - - Yaf_Request_Abstract::SCHEME_HTTPS - - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-request-abstract; - -     - - diff --git a/reference/yaf/yaf-request-http.xml b/reference/yaf/yaf-request-http.xml deleted file mode 100644 index a163ad746e..0000000000 --- a/reference/yaf/yaf-request-http.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - La classe Yaf_Request_Http - Yaf_Request_Http - - - - -
    - &reftitle.intro; - - Toute requête provenant d'un client est initialisée comme un objet - Yaf_Request_Http. - Il est possible de récupérer les informations de la requête, telles que - la chaîne de requête de l'URI et les paramètres POST, via les méthodes - de cette classe. - - - Pour des raisons de sécurité, $_GET/$_POST sont en lecture seule dans - Yaf, ce qui signifie que si une valeur est affectée à ces variables - globales, il ne sera pas possible de la récupérer via - Yaf_Request_Http::getQuery ou - Yaf_Request_Http::getPost. - - - Mais il existe des usages qui nécessitent une telle fonctionnalité, - comme les tests unitaires. Yaf peut donc être compilé avec - --enable-yaf-debug, ce qui lui permettra de lire la valeur définie - par un script. - - - Dans ce cas, Yaf émettra une alerte E_STRICT pour le rappeler : - Strict Standards: you are running yaf in debug mode - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Request_Http - - - - - Yaf_Request_Http - - - - extends - Yaf_Request_Abstract - - - - &Properties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - module - - - - - - controller - - - - - - action - - - - - - method - - - - - - params - - - - - - language - - - - - - _exception - - - - - - _base_uri - - - - - - uri - - - - - - dispatched - - - - - - routed - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-request-http; - -     - - diff --git a/reference/yaf/yaf-request-simple.xml b/reference/yaf/yaf-request-simple.xml deleted file mode 100644 index 0296db69b2..0000000000 --- a/reference/yaf/yaf-request-simple.xml +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - La classe Yaf_Request_Simple - Yaf_Request_Simple - - - - -
    - &reftitle.intro; - - Yaf_Request_Simple est particulièrement utilisée - à des fins de test, c'est-à-dire pour simuler des requêtes particulières - en mode CLI. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Request_Simple - - - - - Yaf_Request_Simple - - - - extends - Yaf_Request_Abstract - - - - &Constants; - - const - string - Yaf_Request_Simple::SCHEME_HTTP - http - - - const - string - Yaf_Request_Simple::SCHEME_HTTPS - https - - - &Properties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - module - - - - - - controller - - - - - - action - - - - - - method - - - - - - params - - - - - - language - - - - - - _exception - - - - - - _base_uri - - - - - - uri - - - - - - dispatched - - - - - - routed - - - - - -
    - - - - -
    - &reftitle.constants; - - - - Yaf_Request_Simple::SCHEME_HTTP - - - - - - - Yaf_Request_Simple::SCHEME_HTTPS - - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-request-simple; - -     - - diff --git a/reference/yaf/yaf-response-abstract.xml b/reference/yaf/yaf-response-abstract.xml deleted file mode 100644 index 6aaf3fb538..0000000000 --- a/reference/yaf/yaf-response-abstract.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - La classe Yaf_Response_Abstract - Yaf_Response_Abstract - - - - -
    - &reftitle.intro; - - Yaf_Response_Abstract est la classe de base de - l'objet de réponse, qui transporte les en-têtes et les blocs de contenu - à envoyer au client. Elle est instanciée par - Yaf_Dispatcher ; la méthode - Yaf_Dispatcher::getResponse permet d'y accéder, - typiquement depuis les contrôleurs, les actions ou les plugins. - - - Les sous-classes concrètes sont Yaf_Response_Http - (utilisée avec les SAPI web, qui envoie effectivement les en-têtes HTTP) - et Yaf_Response_Cli (utilisée en ligne de commande). - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Response_Abstract - - - - - Yaf_Response_Abstract - - - - &Constants; - - const - string - Yaf_Response_Abstract::DEFAULT_BODY - "content" - - - &Properties; - - protected - _header - - - protected - _body - - - protected - _sendheader - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _header - - - Les en-têtes HTTP définis jusqu'à présent, sous la forme d'un tableau - de paires nom/valeur d'en-tête. N'a de sens que pour - Yaf_Response_Http. - - - - - _body - - - Les blocs de contenu, indexés par la clé de contenu (par défaut - content, c'est-à-dire - Yaf_Response_Abstract::DEFAULT_BODY). - - - - - _sendheader - - - Indique si les en-têtes devraient être envoyés avec le contenu. Dans - Yaf_Response_Http, cette propriété indique - également si les en-têtes ont déjà été envoyés. - - - - -
    - - - -     - - &reference.yaf.entities.yaf-response-abstract; - -     - - diff --git a/reference/yaf/yaf-response-cli.xml b/reference/yaf/yaf-response-cli.xml deleted file mode 100644 index 5f41779a76..0000000000 --- a/reference/yaf/yaf-response-cli.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - La classe Yaf_Response_Cli - Yaf_Response_Cli - - - - -
    - &reftitle.intro; - - Yaf_Response_Cli est l'adaptateur de réponse - utilisé pour les requêtes en ligne de commande (CLI). Contrairement à - son homologue HTTP, elle n'envoie pas d'en-têtes, mais accumule - simplement le corps de la réponse et l'affiche directement lorsque le - cycle de distribution s'achève. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Response_Cli - - - - - Yaf_Response_Cli - - - - extends - Yaf_Response_Abstract - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _header - - - - - - _body - - - - - - _sendheader - - - - - -
    - - - -     - -     - - diff --git a/reference/yaf/yaf-response-http.xml b/reference/yaf/yaf-response-http.xml deleted file mode 100644 index 09090aae8f..0000000000 --- a/reference/yaf/yaf-response-http.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - La classe Yaf_Response_Http - Yaf_Response_Http - - - - -
    - &reftitle.intro; - - Yaf_Response_Http est l'adaptateur de réponse - utilisé pour les requêtes web. Il accumule les en-têtes et le corps - définis durant le cycle de distribution et les envoie au client lorsque - la distribution se termine, sauf si - Yaf_Dispatcher::returnResponse est activé. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Response_Http - - - - - Yaf_Response_Http - - - - extends - Yaf_Response_Abstract - - - - &Properties; - - protected - _sendheader - - - protected - _response_code - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _header - - - - - - _body - - - - - - _sendheader - - - - - - _response_code - - - - - -
    - - - -     - -     - - diff --git a/reference/yaf/yaf-route-interface.xml b/reference/yaf/yaf-route-interface.xml deleted file mode 100644 index 8167fb5abd..0000000000 --- a/reference/yaf/yaf-route-interface.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - La classe Yaf_Route_Interface - Yaf_Route_Interface - - - - -
    - &reftitle.intro; - - Yaf_Route_Interface définit le contrat que toute - route doit implémenter : Yaf_Route_Interface::route, - qui examine la requête et se l'approprie en définissant le module, le - contrôleur et l'action (et éventuellement les paramètres de la requête), - et Yaf_Route_Interface::assemble, qui construit - une URL à partir des informations de routage. - - - Il faut implémenter cette interface pour définir une route personnalisée, - puis l'enregistrer auprès du routeur avec - Yaf_Router::addRoute. Les classes de route - intégrées - (Yaf_Route_Static, - Yaf_Route_Simple, - Yaf_Route_Supervar, - Yaf_Route_Rewrite, - Yaf_Route_Regex et - Yaf_Route_Map) l'implémentent toutes. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Interface - - - - - Yaf_Route_Interface - - - - - &Methods; - - - - -
    - -     - - &reference.yaf.entities.yaf-route-interface; - -     - - diff --git a/reference/yaf/yaf-route-map.xml b/reference/yaf/yaf-route-map.xml deleted file mode 100644 index 046fe44e06..0000000000 --- a/reference/yaf/yaf-route-map.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - La classe Yaf_Route_Map - Yaf_Route_Map - - - - -
    - &reftitle.intro; - - Yaf_Route_Map est une route interne qui convertit - la totalité du point final de l'URI (la partie de l'URI qui vient après - l'URI de base : voir Yaf_Request_Abstract::setBaseUri) - en un unique nom de contrôleur ou nom d'action, suivant le premier - paramètre passé à Yaf_Route_Map::__construct. - Les segments du chemin sont reliés par des tirets bas : - - - A => A - A/B/C => A_B_C - A/B/C/D/E => A_B_C_D_E - - - Lorsque la correspondance donne un nom de contrôleur, sa première lettre - est mise en majuscule. - - - Si le second paramètre de - Yaf_Route_Map::__construct est spécifié, seule - la partie de l'URI située avant le délimiteur est utilisée pour le - routage, tandis que la partie située après est analysée comme les - paramètres de la requête (voir la section des exemples de - Yaf_Route_Map::__construct). - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Map - - - - - Yaf_Route_Map - - - - Yaf_Route_Interface - - - - &Properties; - - protected - _ctl_router - - - protected - _delimiter - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _ctl_router - - - - - - _delimiter - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-route-map; - -     - - diff --git a/reference/yaf/yaf-route-regex.xml b/reference/yaf/yaf-route-regex.xml deleted file mode 100644 index 6dd5562c0a..0000000000 --- a/reference/yaf/yaf-route-regex.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - La classe Yaf_Route_Regex - Yaf_Route_Regex - - - - -
    - &reftitle.intro; - - Yaf_Route_Regex est la route la plus flexible - parmi les routes internes de Yaf : elle compare l'URI de la requête à - une expression rationnelle. Lorsque le motif correspond, le module, le - contrôleur et l'action par défaut sont utilisés, et les sous-motifs - capturés sont affectés aux paramètres de la requête via une table de - correspondance numérique. - - - Elle est similaire à Yaf_Route_Rewrite, mais au - lieu d'un motif lisible par un humain, elle prend un motif PCRE complet, - ce qui lui permet d'exprimer des règles de correspondance que les autres - routes internes ne peuvent pas exprimer. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Regex - - - - - Yaf_Route_Regex - - - - extends - Yaf_Route_Interface - - - - Yaf_Route_Interface - - - - &Properties; - - protected - _route - - - protected - _default - - - protected - _maps - - - protected - _verify - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _route - - - - - - _default - - - - - - _maps - - - - - - _verify - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-route-regex; - -     - - diff --git a/reference/yaf/yaf-route-rewrite.xml b/reference/yaf/yaf-route-rewrite.xml deleted file mode 100644 index c0d14dac31..0000000000 --- a/reference/yaf/yaf-route-rewrite.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - La classe Yaf_Route_Rewrite - Yaf_Route_Rewrite - - - - -
    - &reftitle.intro; - - Yaf_Route_Rewrite est une route interne qui fait - correspondre un motif de chemin fixe à un module, un contrôleur et une - action. Le motif peut contenir des marqueurs nommés - (:nom, dont la valeur est définie comme paramètre de - la requête) et un joker * final qui capture les - segments restants sous forme de paires clé/valeur. - - - Pour l'utilisation, se reporter à la section des exemples de - Yaf_Route_Rewrite::__construct. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Rewrite - - - - - Yaf_Route_Rewrite - - - - extends - Yaf_Route_Interface - - - - Yaf_Route_Interface - - - - &Properties; - - protected - _route - - - protected - _default - - - protected - _verify - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _route - - - - - - _default - - - - - - _verify - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-route-rewrite; - -     - - diff --git a/reference/yaf/yaf-route-simple.xml b/reference/yaf/yaf-route-simple.xml deleted file mode 100644 index 88affb3238..0000000000 --- a/reference/yaf/yaf-route-simple.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - La classe Yaf_Route_Simple - Yaf_Route_Simple - - - - -
    - &reftitle.intro; - - Yaf_Route_Simple détermine les informations de - routage à partir de la chaîne de requête. Il suffit d'indiquer à - Yaf_Route_Simple quelle clé de - $_GET est le module, quelle clé est le contrôleur - et quelle clé est l'action. - - - Yaf_Route_Simple::route prend en charge la - requête (retourne &true;) dès qu'au moins une de ces clés est présente - dans la chaîne de requête ; les routes enregistrées après elle dans la - pile ne seront donc pas essayées pour une telle requête. Elle ne laisse - passer la requête (retourne &false;) que lorsque aucune des clés - configurées n'apparaît. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Simple - - - - - Yaf_Route_Simple - - - - Yaf_Route_Interface - - - - &Properties; - - protected - controller - - - protected - module - - - protected - action - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - controller - - - - - - module - - - - - - action - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-route-simple; - -     - - diff --git a/reference/yaf/yaf-route-static.xml b/reference/yaf/yaf-route-static.xml deleted file mode 100644 index 61f8d4fe0c..0000000000 --- a/reference/yaf/yaf-route-static.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - La classe Yaf_Route_Static - Yaf_Route_Static - - - - -
    - &reftitle.intro; - - Yaf_Route_Static est la route par défaut de - Yaf_Router : elle analyse le chemin de l'URI - sous la forme de segments - /module/controleur/action et est conçue pour - couvrir la plupart des besoins de routage sans configuration. - - - - Il est inutile d'instancier un - Yaf_Route_Static, ou de l'ajouter à la pile - de routes de Yaf_Router : il y en a toujours - un présent dans la pile, et il est toujours essayé en dernier. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Static - - - - - Yaf_Route_Static - - - - Yaf_Router - - - - - &Methods; - - - - -
    - -     - - &reference.yaf.entities.yaf-route-static; - -     - - diff --git a/reference/yaf/yaf-route-supervar.xml b/reference/yaf/yaf-route-supervar.xml deleted file mode 100644 index 4775debdab..0000000000 --- a/reference/yaf/yaf-route-supervar.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - La classe Yaf_Route_Supervar - Yaf_Route_Supervar - - - - -
    - &reftitle.intro; - - Yaf_Route_Supervar est une route native qui - détermine la cible de la requête à partir d'un unique paramètre GET - (la supervariable). La valeur de ce paramètre est analysée de la même - manière que PATH_INFO ; ainsi, une requête telle - que /?r=/user/list correspond au contrôleur - user et à l'action list lorsque - le nom de la supervariable est r. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Supervar - - - - - Yaf_Route_Supervar - - - - Yaf_Route_Interface - - - - &Properties; - - protected - _var_name - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _var_name - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-route-supervar; - -     - - diff --git a/reference/yaf/yaf-router.xml b/reference/yaf/yaf-router.xml deleted file mode 100644 index 48180ebea2..0000000000 --- a/reference/yaf/yaf-router.xml +++ /dev/null @@ -1,242 +0,0 @@ - - - - - - La classe Yaf_Router - Yaf_Router - - - - -
    - &reftitle.intro; - - Yaf_Router est le routeur standard du framework. Le routage est - le processus qui consiste à prendre le point d'entrée d'une URI (la partie de l'URI qui vient - après l'URI de base : voir Yaf_Request_Abstract::setBaseUri) - et à la décomposer en paramètres afin de déterminer quel module, quel contrôleur et quelle - action de ce contrôleur devraient recevoir la requête. Ces valeurs de module, - de contrôleur, d'action et les autres paramètres sont regroupés dans un objet - Yaf_Request_Abstract qui est ensuite traité par - Yaf_Dispatcher. Le routage n'a lieu qu'une seule fois : lorsque la requête - est initialement reçue et avant que le premier contrôleur ne soit distribué. - - Yaf_Router est conçu pour permettre des fonctionnalités semblables à - mod_rewrite en utilisant uniquement des structures PHP. Il s'inspire très librement du routage de - Ruby on Rails et ne nécessite aucune connaissance préalable de la réécriture d'URL par - le serveur web. Il est conçu pour fonctionner avec une unique règle mod_rewrite d'Apache - (l'une de celles-ci) : - - Règle de réécriture pour Apache - - - - - ou (de préférence) : - - Règle de réécriture pour Apache - - - - - Avec Lighttpd, la règle de réécriture suivante est valide : - - Règle de réécriture pour Lighttpd - - "/index.php?$1", - ".*\.(js|ico|gif|jpg|png|css|html)$" => "$0", - "" => "/index.php" -) -]]> - - - Avec Nginx, il faut utiliser la règle de réécriture suivante : - - Règle de réécriture pour Nginx - - - - - -
    - - -
    - Route par défaut - - Yaf_Router est préconfiguré avec une route par défaut, - Yaf_Route_Static, qui fait correspondre les URI de la forme - controller/action. De plus, un nom de module peut être indiqué comme premier - élément du chemin, autorisant les URI de la forme module/controller/action. Enfin, - elle fait aussi correspondre par défaut tous les paramètres supplémentaires ajoutés à l'URI - - controller/action/var1/value1/var2/value2. - - - Le nom du module doit être défini dans la configuration ; en considérant application.module="Index,Foo,Bar", - dans ce cas, seuls index, foo et bar peuvent être considérés comme un nom de module. - S'il n'est pas configuré, il n'y a qu'un seul module, nommé "Index". - - - - - - Quelques exemples illustrant la façon dont ces routes sont mises en correspondance : - - Exemple avec <classname>Yaf_Route_Static</classname>(route par défaut) - - array( - "modules" => "Index,Blog", - ), -); - -Contrôleur seul : -http://example/news - controller == news -Action seule (lorsque yaf.action_prefer=1 est défini dans php.ini) - action == news - -Un module invalide correspond à un nom de contrôleur : -http://example/foo - controller == foo - -Module + contrôleur : -http://example/blog/archive - module == blog - controller == archive - -Module + contrôleur + action : -http://example/blog/archive/list - module == blog - controller == archive - action == list - -Module + contrôleur + action + paramètres : -http://example/blog/archive/list/sort/alpha/date/desc - module == blog - controller == archive - action == list - sort == alpha - date == desc -]]> - - - - -
    - -
    - &reftitle.classsynopsis; - - - - Yaf_Router - - - - - Yaf_Router - - - - &Properties; - - protected - _routes - - - protected - _current - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _routes - - - la pile des routes enregistrées - - - - - _current - - - après la phase de routage, cette propriété indique le nom de la route - qui a été utilisée pour router la requête courante. - - Il est possible d'obtenir ce nom via - Yaf_Router::getCurrentRoute. - - - - -
    - - - -     - - &reference.yaf.entities.yaf-router; - -     - - diff --git a/reference/yaf/yaf-session.xml b/reference/yaf/yaf-session.xml deleted file mode 100644 index 29ff93f322..0000000000 --- a/reference/yaf/yaf-session.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - La classe Yaf_Session - Yaf_Session - - - - -
    - &reftitle.intro; - - Yaf_Session est une enveloppe avec espace de - noms autour du support natif des sessions de PHP. Elle s'utilise - comme un singleton, via - Yaf_Session::getInstance, et travaille - directement sur $_SESSION : les données de session - écrites via une interface sont visibles dans l'autre. - - - Les entrées de session sont accessibles et manipulables via la - syntaxe des propriétés, des appels de méthodes - (Yaf_Session::get, - Yaf_Session::set, - Yaf_Session::del, - Yaf_Session::has), l'accès de type tableau - (ArrayAccess), l'itération - (Iterator) et count(). - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Session - - - - - Yaf_Session - - - - Iterator - - - - ArrayAccess - - - - Countable - - - - &Properties; - - protected - static - _instance - - - protected - _session - - - protected - _started - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _instance - - - - - - _session - - - - - - _started - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-session; - -     - - diff --git a/reference/yaf/yaf-view-interface.xml b/reference/yaf/yaf-view-interface.xml deleted file mode 100644 index fa7773752d..0000000000 --- a/reference/yaf/yaf-view-interface.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - La classe Yaf_View_Interface - Yaf_View_Interface - - - - -
    - &reftitle.intro; - - Yaf offre aux développeurs la possibilité d'utiliser un moteur de vue - personnalisé au lieu du moteur interne qu'est - Yaf_View_Simple. Un exemple explique comment - procéder, se reporter à - Yaf_Dispatcher::setView. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_View_Interface - - - - - Yaf_View_Interface - - - - - &Methods; - - - - -
    - -     - - &reference.yaf.entities.yaf-view-interface; - -     - - diff --git a/reference/yaf/yaf-view-simple.xml b/reference/yaf/yaf-view-simple.xml deleted file mode 100644 index ba2c0abbc2..0000000000 --- a/reference/yaf/yaf-view-simple.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - La classe Yaf_View_Simple - Yaf_View_Simple - - - - -
    - &reftitle.intro; - - Yaf_View_Simple est le moteur de template interne - de Yaf ; c'est un moteur de template simple mais rapide, qui ne supporte - que les templates sous forme de scripts PHP. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_View_Simple - - - - - Yaf_View_Simple - - - - Yaf_View_Interface - - - - &Properties; - - protected - _tpl_vars - - - protected - _tpl_dir - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _tpl_vars - - - - - - _tpl_dir - - - - - -
    - - - -     - - &reference.yaf.entities.yaf-view-simple; - -     - - diff --git a/reference/yaf/yaf_action_abstract/execute.xml b/reference/yaf/yaf_action_abstract/execute.xml deleted file mode 100644 index dc0e6ed272..0000000000 --- a/reference/yaf/yaf_action_abstract/execute.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - Yaf_Action_Abstract::execute - Point d'entrée de l'action - - - - &reftitle.description; - - abstract publicmixedYaf_Action_Abstract::execute - mixedargs - - - L'utilisateur devrait toujours définir cette méthode pour une action ; - c'est le point d'entrée de l'action. - Yaf_Action_Abstract::execute peut avoir des - arguments. - - - La valeur récupérée depuis la requête n'est pas sûre. Il est recommandé - d'effectuer un travail de filtrage avant de l'utiliser. - - - - - - - &reftitle.parameters; - - - args - - - - - - - - - - - &reftitle.returnvalues; - - La valeur de retour de la méthode d'action n'est pas utilisée par Yaf ; les - données de sortie sont écrites directement ou collectées par le moteur de - vue. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Action_Abstract::execute</function> - - "actions/Index.php", - ); -} -?> -]]> - - - - Exemple avec <function>Yaf_Action_Abstract::execute</function> - -getRequest()->getParam("name")); - assert($id == $this->getRequest()->getParam("id")); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getParam - Yaf_Controller_Abstract::forward - - - - - - diff --git a/reference/yaf/yaf_action_abstract/getcontroller.xml b/reference/yaf/yaf_action_abstract/getcontroller.xml deleted file mode 100644 index 6edb2dbd8a..0000000000 --- a/reference/yaf/yaf_action_abstract/getcontroller.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yaf_Action_Abstract::getController - Récupère l'objet contrôleur - - - - &reftitle.description; - - publicYaf_Controller_AbstractnullYaf_Action_Abstract::getController - - - - Récupère le contrôleur auquel appartient cette action. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une instance de Yaf_Controller_Abstract, ou &null; - si aucun contrôleur n'est disponible. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Action_Abstract::getController</methodname> - -getController(); - var_dump($controller instanceof Yaf_Controller_Abstract); - - // par exemple, pour accéder à son moteur de vue - $controller->getView()->assign("products", array("yaf", "php")); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Action_Abstract::getControllerName - Yaf_Controller_Abstract - - - - - - - diff --git a/reference/yaf/yaf_action_abstract/getcontrollername.xml b/reference/yaf/yaf_action_abstract/getcontrollername.xml deleted file mode 100644 index c2111da29c..0000000000 --- a/reference/yaf/yaf_action_abstract/getcontrollername.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Action_Abstract::getControllerName - Récupère le nom du contrôleur - - - - &reftitle.description; - - public stringnullYaf_Action_Abstract::getControllerName - - - - Retourne le nom du contrôleur auquel appartient cette action. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom du contrôleur sous forme de &string;, ou &null; s'il n'est pas défini. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Action_Abstract::getControllerName</methodname> - -getControllerName()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Action_Abstract::getController - Yaf_Controller_Abstract::getName - - - - - - - diff --git a/reference/yaf/yaf_application/app.xml b/reference/yaf/yaf_application/app.xml deleted file mode 100644 index d83ffcc8eb..0000000000 --- a/reference/yaf/yaf_application/app.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yaf_Application::app - Récupère une instance de l'application - - - - &reftitle.description; - - public static Yaf_ApplicationnullYaf_Application::app - - - - Récupère l'instance de Yaf_Application. - Il est également possible d'utiliser - Yaf_Dispatcher::getApplication. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'instance de Yaf_Application, ou &null; si aucune - application n'a encore été initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Application::app</methodname> - -bootstrap()->run(); -?> -]]> - - - - Récupération de l'instance de l'application ailleurs - -environ()); - var_dump(Yaf_Application::getInstance() === $app); - - return false; - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::getApplication - - - - - - - diff --git a/reference/yaf/yaf_application/bootstrap.xml b/reference/yaf/yaf_application/bootstrap.xml deleted file mode 100644 index 6ee60f83a8..0000000000 --- a/reference/yaf/yaf_application/bootstrap.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - Yaf_Application::bootstrap - Appelle le bootstrap - - - - &reftitle.description; - - public Yaf_ApplicationfalseYaf_Application::bootstrap - - - - Exécute un Bootstrap. Toutes les méthodes publiques de la classe Bootstrap - dont le nom commence par _init sont appelées dans - l'ordre de leur déclaration, chacune recevant l'instance de - Yaf_Dispatcher comme unique argument. - - - La classe Bootstrap doit être nommée Bootstrap et - étendre Yaf_Bootstrap_Abstract. Si elle n'est pas - déjà définie, elle est chargée à partir du fichier - Bootstrap.php situé dans le répertoire de - l'application ; l'entrée de configuration - application.bootstrap remplace son emplacement. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Application lui-même en cas de - succès, ou &false; en cas d'échec (par exemple si la classe Bootstrap n'a - pas pu être chargée, ou si une exception non interceptée a été levée par - l'une des méthodes _init*). - - - - - &reftitle.errors; - - Déclenche une erreur YAF_ERR_TYPE_ERROR si la classe - trouvée n'est pas une sous-classe de - Yaf_Bootstrap_Abstract, ou une erreur - E_WARNING si le fichier de bootstrap ou la classe - Bootstrap est introuvable. - - - - - &reftitle.examples; - - Exemple de Bootstrap - - -]]> - - - - Exemple avec <function>Yaf_Application::bootstrap</function> - -bootstrap(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Bootstrap_Abstract - Yaf_Application::run - - - - - - - diff --git a/reference/yaf/yaf_application/clearlasterror.xml b/reference/yaf/yaf_application/clearlasterror.xml deleted file mode 100644 index 98f884405d..0000000000 --- a/reference/yaf/yaf_application/clearlasterror.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Yaf_Application::clearLastError - Efface les informations de la dernière erreur - - - - &reftitle.description; - - public Yaf_ApplicationnullYaf_Application::clearLastError - - - - Efface le code et le message de la dernière erreur, en les réinitialisant à - 0 et à une chaîne vide. Cela est utile dans les - gestionnaires d'erreurs, lorsqu'une erreur déjà traitée ne devrait pas être - signalée à nouveau. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Application lui-même en cas de - succès, ou &null; si l'application n'est pas correctement initialisée. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Application::clearLastError</function> - -clearLastError(); - var_dump(Yaf_Application::app()->getLastErrorNo()); -} - -$config = array( - "application" => array( - "directory" => "/tmp/notexists", - "dispatcher" => array( - "throwException" => 0, //déclenche une erreur au lieu de lever une exception lorsqu'une erreur survient - ), - ), -); - -$app = new Yaf_Application($config); -$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR); -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::getLastErrorNo - Yaf_Application::getLastErrorMsg - - - - - - - diff --git a/reference/yaf/yaf_application/construct.xml b/reference/yaf/yaf_application/construct.xml deleted file mode 100644 index a2aaa04dbe..0000000000 --- a/reference/yaf/yaf_application/construct.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - Yaf_Application::__construct - Constructeur de Yaf_Application - - - - &reftitle.description; - - public Yaf_Application::__construct - stringarrayconfig - stringnullenvironnull - - - Instancie un objet Yaf_Application. Le constructeur - initialise également l'application singleton, le - Yaf_Loader et le - Yaf_Dispatcher ; il doit donc être appelé avant - toute utilisation de ces derniers. - - - - - &reftitle.parameters; - - - config - - - Un chemin vers un fichier de configuration INI, ou un tableau de - configuration. - - - S'il s'agit d'un fichier de configuration INI, il devrait contenir une - section nommée d'après celle définie par - yaf.environ, qui vaut - "product" par défaut. - - - Les entrées de configuration de l'application (et leurs valeurs par - défaut) sont documentées dans - Configuration de l'application : - - - - Exemple de fichier de configuration ini - - - - - - - - - environ - - - La section qui sera chargée comme configuration finale. Si elle n'est - pas fournie, la valeur de la directive - yaf.environ est utilisée. - - - - - - - - &reftitle.errors; - - Lève une exception Yaf_Exception_StartupError - (ou déclenche une erreur YAF_ERR_STARTUP_FAILED, - lorsque Yaf_Dispatcher::throwException est - désactivé) si un objet Yaf_Application a déjà été - instancié, ou si la configuration est invalide. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Application::__construct</function> - -bootstrap()->run(); -?> -]]> - - - - Exemple avec <function>Yaf_Application::__construct</function> - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -$application->bootstrap()->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Config_Ini - Configuration de l'application - - - - - - - diff --git a/reference/yaf/yaf_application/environ.xml b/reference/yaf/yaf_application/environ.xml deleted file mode 100644 index dfe0c3ef71..0000000000 --- a/reference/yaf/yaf_application/environ.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Yaf_Application::environ - Récupère l'environnement - - - - &reftitle.description; - - public stringnullYaf_Application::environ - - - - Récupère le nom de l'environnement de l'application, qui est défini par la - directive yaf.environ (ou par le - paramètre environ du constructeur), et qui vaut - "product" par défaut. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom de l'environnement de l'application. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Application::environ</function> - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -print_r($application->environ()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_application/execute.xml b/reference/yaf/yaf_application/execute.xml deleted file mode 100644 index 2d16186490..0000000000 --- a/reference/yaf/yaf_application/execute.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - Yaf_Application::execute - Exécute une fonction de rappel - - - - &reftitle.description; - - public mixedYaf_Application::execute - callablecallback - mixedargs - - - Exécute une fonction de rappel. Cette méthode est généralement utilisée - pour lancer Yaf dans une tâche cron ou un autre script CLI, afin que le - script puisse réutiliser l'autoloader et le mécanisme de bootstrap. - - - - - &reftitle.parameters; - - - callback - - - Une fonction de rappel valide à exécuter. - - - - - args - - - Paramètres optionnels passés à la fonction de rappel. - - - - - - - - &reftitle.returnvalues; - - Retourne ce que retourne la fonction de rappel, ou &false; si l'appel de - la fonction de rappel a échoué. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Application::execute</function> - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -$application->execute("main", $argc, $argv); -?> -]]> - - &example.outputs.similar; - - - string(11) "execute.php" - [1]=> - string(3) "arg" -} -]]> - - - - - - &reftitle.seealso; - - - Yaf_Application::bootstrap - - - - - - - diff --git a/reference/yaf/yaf_application/getappdirectory.xml b/reference/yaf/yaf_application/getappdirectory.xml deleted file mode 100644 index 4d48de8439..0000000000 --- a/reference/yaf/yaf_application/getappdirectory.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Yaf_Application::getAppDirectory - Récupère le répertoire de l'application - - - - &reftitle.description; - - public stringnullYaf_Application::getAppDirectory - - - - Récupère le répertoire de l'application, dans lequel Yaf recherche les contrôleurs, - les vues et les modules. Il est défini par l'entrée de configuration - application.directory, ou par - Yaf_Application::setAppDirectory. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le chemin absolu du répertoire de l'application, ou &null; si - l'application n'est pas correctement initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Application::getAppDirectory</methodname> - -getAppDirectory()); -var_dump(Yaf_Application::app()->getAppDirectory()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::setAppDirectory - - - - - - - diff --git a/reference/yaf/yaf_application/getconfig.xml b/reference/yaf/yaf_application/getconfig.xml deleted file mode 100644 index 76b57d26fa..0000000000 --- a/reference/yaf/yaf_application/getconfig.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Yaf_Application::getConfig - Récupère l'instance de configuration - - - - &reftitle.description; - - public Yaf_Config_AbstractnullYaf_Application::getConfig - - - - Récupère l'instance de Yaf_Config_Abstract - contenant la configuration de l'application passée au constructeur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une instance de Yaf_Config_Abstract (un objet - Yaf_Config_Simple lorsqu'un tableau est passé au - constructeur, un objet Yaf_Config_Ini lorsqu'un - fichier INI est passé), ou &null; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Application::getConfig</function> - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -print_r($application->getConfig()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [application] => Array - ( - [directory] => /home/laruence/local/www/htdocs/application - ) - - ) - - [_readonly:protected] => 1 -) -]]> - - - - - - - diff --git a/reference/yaf/yaf_application/getdispatcher.xml b/reference/yaf/yaf_application/getdispatcher.xml deleted file mode 100644 index 3e3b7d8365..0000000000 --- a/reference/yaf/yaf_application/getdispatcher.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Application::getDispatcher - Récupère une instance de Yaf_Dispatcher - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Application::getDispatcher - - - - Récupère l'instance de Yaf_Dispatcher utilisée par - cette application. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'instance de Yaf_Dispatcher, ou &null; si - l'application n'est pas correctement initialisée. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Application::getDispatcher</function> - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -print_r($application->getDispatcher()); -?> -]]> - - &example.outputs.similar; - - Yaf_Router Object - ( - [_routes:protected] => Array - ( - [_default] => Yaf_Route_Static Object - ( - ) - - ) - - [_current:protected] => - ) - - [_view:protected] => - [_request:protected] => Yaf_Request_Http Object - ( - [method] => Cli - ) - - [_plugins:protected] => Array - ( - ) - - [_auto_render:protected] => 1 - [_return_response:protected] => - [_instantly_flush:protected] => 1 - [_default_module:protected] => Index - [_default_controller:protected] => Index - [_default_action:protected] => index -) -]]> - - - - - - - diff --git a/reference/yaf/yaf_application/getlasterrormsg.xml b/reference/yaf/yaf_application/getlasterrormsg.xml deleted file mode 100644 index 6da442a266..0000000000 --- a/reference/yaf/yaf_application/getlasterrormsg.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Application::getLastErrorMsg - Récupère le message de la dernière erreur survenue - - - - &reftitle.description; - - public stringnullYaf_Application::getLastErrorMsg - - - - Récupère le message de la dernière erreur survenue durant la distribution. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le message de la dernière erreur survenue, une chaîne vide si aucune - erreur n'est encore survenue, ou &null; si l'application n'est pas - correctement initialisée. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Application::getLastErrorMsg</function> - -getLastErrorMsg()); -} - -$config = array( - "application" => array( - "directory" => "/tmp/notexists", - "dispatcher" => array( - "throwException" => 0, //déclenche une erreur au lieu de lever une exception lorsqu'une erreur survient - ), - ), -); - -$app = new Yaf_Application($config); -$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR); -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::getLastErrorNo - Yaf_Application::clearLastError - - - - - - - diff --git a/reference/yaf/yaf_application/getlasterrorno.xml b/reference/yaf/yaf_application/getlasterrorno.xml deleted file mode 100644 index fd5876eaba..0000000000 --- a/reference/yaf/yaf_application/getlasterrorno.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Application::getLastErrorNo - Récupère le code de la dernière erreur survenue - - - - &reftitle.description; - - public intnullYaf_Application::getLastErrorNo - - - - Récupère le code de la dernière erreur survenue lors de la répartition, - l'une des constantes YAF_ERR_*. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le code de la dernière erreur survenue, 0 si aucune - erreur n'est encore survenue, ou &null; si l'application n'est pas - correctement initialisée. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Application::getLastErrorNo</function> - -getLastErrorNo()); - var_dump(Yaf_Application::app()->getLastErrorNo() == YAF_ERR_NOTFOUND_CONTROLLER); -} - -$config = array( - "application" => array( - "directory" => "/tmp/notexists", - "dispatcher" => array( - "throwException" => 0, //déclenche une erreur au lieu de lever une exception lorsqu'une erreur survient - ), - ), -); - -$app = new Yaf_Application($config); -$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR); -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_application/getmodules.xml b/reference/yaf/yaf_application/getmodules.xml deleted file mode 100644 index 01f0bf6f3f..0000000000 --- a/reference/yaf/yaf_application/getmodules.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Application::getModules - Récupère les noms des modules définis - - - - &reftitle.description; - - public arraynullYaf_Application::getModules - - - - Récupère les noms des modules définis dans l'entrée de configuration - application.modules. - Si aucun n'est défini, il y aura toujours un unique module nommé - "Index". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau de noms de modules, ou &null; si l'application n'est pas - correctement initialisée. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Application::getModules</function> - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -print_r($application->getModules()); -?> -]]> - - &example.outputs.similar; - - Index -) -]]> - - - - - - - diff --git a/reference/yaf/yaf_application/run.xml b/reference/yaf/yaf_application/run.xml deleted file mode 100644 index 09a8317bd6..0000000000 --- a/reference/yaf/yaf_application/run.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yaf_Application::run - Démarre Yaf_Application - - - - &reftitle.description; - - public Yaf_Response_AbstractfalseYaf_Application::run - - - - Exécute une Yaf_Application, permet à la - Yaf_Application d'accepter une requête, de router - cette requête, de la distribuer au contrôleur/à l'action et de générer une - réponse. Enfin, retourne la réponse au client. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Response_Abstract en cas de - succès, ou &false; en cas d'échec (par exemple si l'application est déjà - en cours d'exécution). - - - - - &reftitle.errors; - - Déclenche une erreur YAF_ERR_STARTUP_FAILED si - l'application a déjà été démarrée. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Application::run</function> - -bootstrap()->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Application::bootstrap - Yaf_Dispatcher::dispatch - - - - - - - diff --git a/reference/yaf/yaf_application/setappdirectory.xml b/reference/yaf/yaf_application/setappdirectory.xml deleted file mode 100644 index 93da7d9aca..0000000000 --- a/reference/yaf/yaf_application/setappdirectory.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Yaf_Application::setAppDirectory - Modifie le dossier de l'application - - - - &reftitle.description; - - public Yaf_ApplicationnullfalseYaf_Application::setAppDirectory - stringdirectory - - - Modifie le dossier de l'application, dans lequel Yaf recherche les - contrôleurs, les vues et les modules. Le nouveau dossier doit être un - chemin absolu. - - - - - &reftitle.parameters; - - - directory - - - Le chemin absolu du nouveau dossier de l'application. - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Application lui-même en cas de - succès, &false; si directory est vide ou n'est pas - un chemin absolu, ou &null; si l'application n'est pas correctement - initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Application::setAppDirectory</methodname> - -setAppDirectory("/srv/legacy/mvc/app")); -var_dump($app->getAppDirectory()); - -/* un chemin vide ou relatif est rejeté */ -var_dump($app->setAppDirectory("")); -var_dump($app->setAppDirectory("relative/path")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::getAppDirectory - - - - - - - diff --git a/reference/yaf/yaf_config_abstract/get.xml b/reference/yaf/yaf_config_abstract/get.xml deleted file mode 100644 index b0f0203ee4..0000000000 --- a/reference/yaf/yaf_config_abstract/get.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - -Yaf_Config_Abstract::get -Récupère une valeur de configuration - - - - &reftitle.description; - - public mixedYaf_Config_Abstract::get - stringnameNULL - - Récupère une valeur de configuration à partir de son nom. Si name est omis ou vaut &null;, l'objet de configuration lui-même est retourné, ce qui permet d'itérer sur toutes les valeurs. - - - - &reftitle.parameters; - - - name - -La clé de configuration. La notation pointée (par exemple database.host) peut être utilisée pour accéder aux valeurs imbriquées. - - - - - - &reftitle.returnvalues; -La valeur associée à name. Les valeurs de type tableau sont encapsulées dans un objet Yaf_Config_Abstract. Retourne &null; si la clé n'existe pas, ou l'objet de configuration lui-même lorsque name vaut &null;. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Abstract::get</methodname> - -get('database.host'), "\n"; - -$simple = new Yaf_Config_Simple([ - 'database' => ['host' => '127.0.0.1'], -]); - -// Les valeurs de type tableau sont exposées comme des instances de Yaf_Config_Abstract -echo $simple->get('database')->host, "\n"; - -var_dump($config->get('missing.key')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Abstract::set - Yaf_Config_Ini::get - Yaf_Config_Simple::get - - - - diff --git a/reference/yaf/yaf_config_abstract/readonly.xml b/reference/yaf/yaf_config_abstract/readonly.xml deleted file mode 100644 index 0404ac1ae3..0000000000 --- a/reference/yaf/yaf_config_abstract/readonly.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - -Yaf_Config_Abstract::readonly -Vérifie si une configuration est en lecture seule - - - - &reftitle.description; - - abstract public boolYaf_Config_Abstract::readonly - - - Vérifie si la configuration est en lecture seule. Cette méthode est abstraite et doit être implémentée par les classes filles. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la configuration est en lecture seule, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Abstract::readonly</methodname> - -readonly()); // Yaf_Config_Ini est toujours en lecture seule - -$writable = new Yaf_Config_Simple(['env' => 'development']); -var_dump($writable->readonly()); - -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -var_dump($frozen->readonly()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Abstract::set - Yaf_Config_Ini::readonly - Yaf_Config_Simple::readonly - - - - diff --git a/reference/yaf/yaf_config_abstract/set.xml b/reference/yaf/yaf_config_abstract/set.xml deleted file mode 100644 index fc1213deb6..0000000000 --- a/reference/yaf/yaf_config_abstract/set.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_Config_Abstract::set -Définit une valeur de configuration - - - - &reftitle.description; - - abstract public boolYaf_Config_Abstract::set - stringname - mixedvalue - - Définit une valeur de configuration. Cette méthode est abstraite et doit être implémentée par les classes filles. Les configurations en lecture seule rejettent les modifications. - - - - &reftitle.parameters; - - - name - -La clé de configuration à définir. - - - - value - -La valeur à affecter. - - - - - - &reftitle.returnvalues; -Retourne &true; en cas de succès, ou &false; en cas d'échec (par exemple lorsque la configuration est en lecture seule). - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Abstract::set</methodname> - - 'development']); -var_dump($config->set('env', 'production')); -echo $config->env, "\n"; - -// Les implémentations en lecture seule rejettent la modification -$ini = new Yaf_Config_Ini('/etc/myapp/application.ini', 'common'); -var_dump($ini->set('env', 'production')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Abstract::get - Yaf_Config_Abstract::readonly - - - - diff --git a/reference/yaf/yaf_config_abstract/toarray.xml b/reference/yaf/yaf_config_abstract/toarray.xml deleted file mode 100644 index ccd59d430b..0000000000 --- a/reference/yaf/yaf_config_abstract/toarray.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Config_Abstract::toArray -Exporte la configuration sous forme de tableau - - - - &reftitle.description; - - public arrayYaf_Config_Abstract::toArray - - - Retourne l'intégralité de la configuration sous la forme d'un simple tableau PHP. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Les données de configuration sous forme de tableau, ou &null; si aucune donnée de configuration n'est chargée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Abstract::toArray</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -print_r($config->toArray()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => MyApp - ) - - [database] => Array - ( - [host] => localhost - ) - -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Abstract::get - Yaf_Config_Ini::toArray - Yaf_Config_Simple::toArray - - - - diff --git a/reference/yaf/yaf_config_ini/construct.xml b/reference/yaf/yaf_config_ini/construct.xml deleted file mode 100644 index 9a786b6bbe..0000000000 --- a/reference/yaf/yaf_config_ini/construct.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - -Yaf_Config_Ini::__construct -Constructeur de Yaf_Config_Ini - - - - &reftitle.description; - - publicYaf_Config_Ini::__construct - mixedconfig_file - stringsectionNULL - - Crée une nouvelle instance de Yaf_Config_Ini à partir d'un fichier INI ou d'un tableau. La configuration résultante est toujours en lecture seule. - - - - &reftitle.parameters; - - - config_file - -Le chemin vers un fichier INI, ou un tableau de valeurs de configuration. - - - - section - -Le nom de la section INI à charger. Si omis, toutes les sections sont chargées. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::__construct</methodname> - -application->name, "\n"; -echo $config->database->host, "\n"; -echo $config->log->level, "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::set - Yaf_Config_Ini::readonly - - - - - diff --git a/reference/yaf/yaf_config_ini/count.xml b/reference/yaf/yaf_config_ini/count.xml deleted file mode 100644 index 66950a43e7..0000000000 --- a/reference/yaf/yaf_config_ini/count.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Config_Ini::count -Compte les entrées de configuration - - - - &reftitle.description; - - public intYaf_Config_Ini::count - - - Retourne le nombre d'entrées de configuration de premier niveau. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Le nombre d'entrées de premier niveau, sous forme d'entier. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::count</methodname> - -count()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::toArray - - - - - diff --git a/reference/yaf/yaf_config_ini/current.xml b/reference/yaf/yaf_config_ini/current.xml deleted file mode 100644 index b65f7b4a98..0000000000 --- a/reference/yaf/yaf_config_ini/current.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -Yaf_Config_Ini::current -Récupère la valeur de l'entrée courante - - - - &reftitle.description; - - public mixedYaf_Config_Ini::current - - - Retourne la valeur de l'entrée de configuration courante durant l'itération. Les valeurs de type tableau sont encapsulées dans un objet Yaf_Config_Abstract. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -La valeur de l'entrée courante, ou &false; si la position est invalide. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::current</methodname> - -rewind(); -while ($config->valid()) { - $value = $config->current(); - if ($value instanceof Yaf_Config_Abstract) { - echo $config->key(), " =>
    \n"; - } else { - echo $config->key(), " => ", $value, "\n"; - } - $config->next(); -} -?> -]]> - - &example.outputs.similar; - -
    -version => 1.0 -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::key - Yaf_Config_Ini::next - Yaf_Config_Ini::rewind - Yaf_Config_Ini::valid - - - - - diff --git a/reference/yaf/yaf_config_ini/get.xml b/reference/yaf/yaf_config_ini/get.xml deleted file mode 100644 index 0b7af25155..0000000000 --- a/reference/yaf/yaf_config_ini/get.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Config_Ini::get -Récupère une valeur de configuration - - - - &reftitle.description; - - public mixedYaf_Config_Ini::get - stringnameNULL - - Récupère une valeur de configuration à partir de son nom. La notation pointée (par exemple database.host) peut être utilisée pour accéder aux valeurs imbriquées. Si name est omis ou vaut &null;, l'objet de configuration lui-même est retourné. - - - - &reftitle.parameters; - - - name - -La clé de configuration, utilisant éventuellement la notation pointée pour un accès imbriqué. - - - - - - &reftitle.returnvalues; -La valeur associée à name. Les valeurs de type tableau sont encapsulées dans un objet Yaf_Config_Ini. Retourne &null; si la clé n'existe pas, ou l'objet de configuration lui-même lorsque name vaut &null;. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::get</methodname> - -get('database.host'), "\n"; - -// Les valeurs de type tableau sont encapsulées dans un objet Yaf_Config_Ini -echo $config->get('database')->port, "\n"; - -// Sans argument : l'objet de configuration lui-même est retourné -echo $config->get()->application->name, "\n"; - -var_dump($config->get('missing.key')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::set - Yaf_Config_Ini::toArray - - - - - diff --git a/reference/yaf/yaf_config_ini/isset.xml b/reference/yaf/yaf_config_ini/isset.xml deleted file mode 100644 index db64cd5948..0000000000 --- a/reference/yaf/yaf_config_ini/isset.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -Yaf_Config_Ini::__isset -Vérifie si une clé existe - - - - &reftitle.description; - - public boolYaf_Config_Ini::__isset - stringname - - Vérifie si une clé de configuration existe. Cette méthode est appelée lorsque isset() est utilisé sur un objet de configuration. - - - - &reftitle.parameters; - - - name - -La clé de configuration à vérifier. - - - - - - &reftitle.returnvalues; -Retourne &true; si la clé existe, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::__isset</methodname> - -database)); -var_dump($config->__isset('database')); -var_dump(isset($config->cache)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::offsetExists - - - - - diff --git a/reference/yaf/yaf_config_ini/key.xml b/reference/yaf/yaf_config_ini/key.xml deleted file mode 100644 index af3c8fdd09..0000000000 --- a/reference/yaf/yaf_config_ini/key.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Config_Ini::key -Récupère la clé de l'entrée courante - - - - &reftitle.description; - - public mixedYaf_Config_Ini::key - - - Retourne la clé de l'entrée de configuration courante lors de l'itération. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -La clé de l'entrée courante (chaîne de caractères ou entier), ou &false; si la position n'est pas valide. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::key</methodname> - -rewind(); $config->valid(); $config->next()) { - echo $config->key(), "\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::current - Yaf_Config_Ini::next - Yaf_Config_Ini::rewind - Yaf_Config_Ini::valid - - - - - diff --git a/reference/yaf/yaf_config_ini/next.xml b/reference/yaf/yaf_config_ini/next.xml deleted file mode 100644 index f2ef233095..0000000000 --- a/reference/yaf/yaf_config_ini/next.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Config_Ini::next -Avance à l'entrée suivante - - - - &reftitle.description; - - public voidYaf_Config_Ini::next - - - Déplace l'itérateur interne sur l'entrée de configuration suivante. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::next</methodname> - -rewind(); -echo $config->key(), "\n"; - -$config->next(); -echo $config->key(), "\n"; - -$config->next(); // au-delà de la dernière entrée -var_dump($config->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::current - Yaf_Config_Ini::key - Yaf_Config_Ini::rewind - Yaf_Config_Ini::valid - - - - - diff --git a/reference/yaf/yaf_config_ini/offsetexists.xml b/reference/yaf/yaf_config_ini/offsetexists.xml deleted file mode 100644 index 0c17e95dde..0000000000 --- a/reference/yaf/yaf_config_ini/offsetexists.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -Yaf_Config_Ini::offsetExists -Vérifie si une clé existe (ArrayAccess) - - - - &reftitle.description; - - public boolYaf_Config_Ini::offsetExists - mixedname - - Vérifie si une clé de configuration existe. Cette méthode est un alias de Yaf_Config_Ini::__isset et est appelée lorsque isset() est utilisé avec la syntaxe tableau sur un objet de configuration. - - - - &reftitle.parameters; - - - name - -La clé de configuration à vérifier. - - - - - - &reftitle.returnvalues; -Retourne &true; si la clé existe, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::offsetExists</methodname> - -offsetExists('database')); -var_dump(isset($config['cache'])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::__isset - - - - - diff --git a/reference/yaf/yaf_config_ini/offsetget.xml b/reference/yaf/yaf_config_ini/offsetget.xml deleted file mode 100644 index cd24986de1..0000000000 --- a/reference/yaf/yaf_config_ini/offsetget.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_Config_Ini::offsetGet -Récupère une valeur (ArrayAccess) - - - - &reftitle.description; - - public mixedYaf_Config_Ini::offsetGet - mixedname - - Récupère une valeur de configuration à partir d'une clé. Cette méthode est un alias de Yaf_Config_Ini::get et est appelée lorsque la syntaxe de tableau est utilisée pour lire un objet de configuration. - - - - &reftitle.parameters; - - - name - -La clé de configuration à récupérer. - - - - - - &reftitle.returnvalues; -La valeur associée à name, ou &null; si la clé n'existe pas. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::offsetGet</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::offsetSet - Yaf_Config_Ini::offsetUnset - - - - - diff --git a/reference/yaf/yaf_config_ini/offsetset.xml b/reference/yaf/yaf_config_ini/offsetset.xml deleted file mode 100644 index d423fdf6f2..0000000000 --- a/reference/yaf/yaf_config_ini/offsetset.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - -Yaf_Config_Ini::offsetSet -Définit une valeur de configuration (ArrayAccess) - - - - &reftitle.description; - - public voidYaf_Config_Ini::offsetSet - mixedname - mixedvalue - - Tente de définir une valeur de configuration en utilisant la syntaxe des tableaux. Cette méthode est un alias de Yaf_Config_Ini::set. Comme Yaf_Config_Ini est toujours en lecture seule, elle échoue systématiquement et émet une alerte. - - - - &reftitle.parameters; - - - name - -La clé de configuration à définir. - - - - value - -La valeur à affecter. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. Une alerte est émise, car Yaf_Config_Ini est en lecture seule. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::offsetSet</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::set - Yaf_Config_Ini::offsetGet - Yaf_Config_Ini::readonly - - - - - diff --git a/reference/yaf/yaf_config_ini/offsetunset.xml b/reference/yaf/yaf_config_ini/offsetunset.xml deleted file mode 100644 index 7e4fb7af6d..0000000000 --- a/reference/yaf/yaf_config_ini/offsetunset.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Config_Ini::offsetUnset -Supprime une clé (ArrayAccess) - - - - &reftitle.description; - - public voidYaf_Config_Ini::offsetUnset - mixedname - - Supprime une entrée de configuration à partir de sa clé. Cette méthode est appelée lorsque unset() est utilisé avec la syntaxe tableau sur un objet de configuration. - - - - &reftitle.parameters; - - - name - -La clé de configuration à supprimer. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. Une alerte est émise si la configuration est en lecture seule. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::offsetUnset</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::offsetGet - Yaf_Config_Ini::offsetSet - - - - - diff --git a/reference/yaf/yaf_config_ini/readonly.xml b/reference/yaf/yaf_config_ini/readonly.xml deleted file mode 100644 index 1ec3519d3a..0000000000 --- a/reference/yaf/yaf_config_ini/readonly.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - -Yaf_Config_Ini::readonly -Vérifie si la configuration est en lecture seule - - - - &reftitle.description; - - public boolYaf_Config_Ini::readonly - - - Vérifie si la configuration est en lecture seule. Yaf_Config_Ini est toujours en lecture seule. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne toujours &true;. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::readonly</methodname> - -readonly()); - -// Les tentatives d'écriture sont rejetées (et une alerte est émise) -var_dump($config->set('version', '2.0')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::set - - - - - diff --git a/reference/yaf/yaf_config_ini/rewind.xml b/reference/yaf/yaf_config_ini/rewind.xml deleted file mode 100644 index 8724037029..0000000000 --- a/reference/yaf/yaf_config_ini/rewind.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - -Yaf_Config_Ini::rewind -Replace l'itérateur sur la première entrée - - - - &reftitle.description; - - public voidYaf_Config_Ini::rewind - - - Replace l'itérateur interne sur la première entrée de configuration. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::rewind</methodname> - -next(); -echo $config->key(), "\n"; - -$config->rewind(); -echo $config->key(), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::current - Yaf_Config_Ini::key - Yaf_Config_Ini::next - Yaf_Config_Ini::valid - - - - - diff --git a/reference/yaf/yaf_config_ini/set.xml b/reference/yaf/yaf_config_ini/set.xml deleted file mode 100644 index 4803969bad..0000000000 --- a/reference/yaf/yaf_config_ini/set.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - -Yaf_Config_Ini::set -Définit une valeur de configuration - - - - &reftitle.description; - - public boolYaf_Config_Ini::set - stringname - mixedvalue - - Tente de définir une valeur de configuration. Comme Yaf_Config_Ini est toujours en lecture seule, cette méthode échoue systématiquement et émet une alerte. - - - - &reftitle.parameters; - - - name - -La clé de configuration à définir. - - - - value - -La valeur à assigner. - - - - - - &reftitle.returnvalues; -Retourne toujours &false; et émet une alerte, car Yaf_Config_Ini est en lecture seule. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::set</methodname> - -set('database.host', '192.0.2.10')); - -echo $config->get('database.host'), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::readonly - - - - - diff --git a/reference/yaf/yaf_config_ini/toarray.xml b/reference/yaf/yaf_config_ini/toarray.xml deleted file mode 100644 index 51f6c08c6f..0000000000 --- a/reference/yaf/yaf_config_ini/toarray.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_Config_Ini::toArray -Exporte la configuration sous forme de tableau - - - - &reftitle.description; - - public arrayYaf_Config_Ini::toArray - - - Retourne l'intégralité de la configuration sous la forme d'un simple tableau PHP. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Les données de configuration sous forme de tableau. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::toArray</methodname> - -toArray()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => MyApp - ) - - [database] => Array - ( - [host] => localhost - [port] => 3306 - ) - -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - - - - - diff --git a/reference/yaf/yaf_config_ini/valid.xml b/reference/yaf/yaf_config_ini/valid.xml deleted file mode 100644 index afa701ecb9..0000000000 --- a/reference/yaf/yaf_config_ini/valid.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Config_Ini::valid -Vérifie si la position courante est valide - - - - &reftitle.description; - - public boolYaf_Config_Ini::valid - - - Vérifie si la position courante de l'itérateur est valide. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la position courante est valide, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Ini::valid</methodname> - -rewind(); -var_dump($config->valid()); - -$config->next(); -var_dump($config->valid()); - -$config->next(); // au-delà de la dernière entrée -var_dump($config->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::current - Yaf_Config_Ini::key - Yaf_Config_Ini::next - Yaf_Config_Ini::rewind - - - - - diff --git a/reference/yaf/yaf_config_simple/construct.xml b/reference/yaf/yaf_config_simple/construct.xml deleted file mode 100644 index 9aad95a3da..0000000000 --- a/reference/yaf/yaf_config_simple/construct.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - -Yaf_Config_Simple::__construct -Constructeur de Yaf_Config_Simple - - - - &reftitle.description; - - publicYaf_Config_Simple::__construct - arrayvalues - boolreadonlyfalse - - Crée une nouvelle instance de Yaf_Config_Simple à partir d'un tableau de valeurs de configuration. - - - - &reftitle.parameters; - - - values - -Un tableau de valeurs de configuration. - - - - readonly - -Indique si la configuration devrait être en lecture seule. Vaut &false; par défaut (modifiable). - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::__construct</methodname> - - ['name' => 'MyApp', 'env' => 'production'], - 'database' => ['host' => 'localhost', 'port' => 3306], -]); - -echo $config->application->name, "\n"; -echo $config->database->host, "\n"; - -// Le second argument optionnel rend la configuration en lecture seule -$frozen = new Yaf_Config_Simple(['env' => 'testing'], true); -var_dump($frozen->readonly()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::set - Yaf_Config_Simple::readonly - - - - - diff --git a/reference/yaf/yaf_config_simple/count.xml b/reference/yaf/yaf_config_simple/count.xml deleted file mode 100644 index 0f71642fa7..0000000000 --- a/reference/yaf/yaf_config_simple/count.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - -Yaf_Config_Simple::count -Compte les entrées de configuration - - - - &reftitle.description; - - public intYaf_Config_Simple::count - - - Retourne le nombre d'entrées de configuration de premier niveau. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Le nombre d'entrées de premier niveau, sous forme d'entier. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::count</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -// Seules les entrées de premier niveau ("application" et "database") sont comptées -var_dump(count($config)); -var_dump($config->count()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::toArray - - - - - diff --git a/reference/yaf/yaf_config_simple/current.xml b/reference/yaf/yaf_config_simple/current.xml deleted file mode 100644 index faa70a63c7..0000000000 --- a/reference/yaf/yaf_config_simple/current.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Config_Simple::current -Récupère la valeur de l'entrée courante - - - - &reftitle.description; - - public mixedYaf_Config_Simple::current - - - Retourne la valeur de l'entrée de configuration courante durant l'itération. Les valeurs de type tableau sont encapsulées dans un objet Yaf_Config_Abstract. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -La valeur de l'entrée courante, ou &false; si la position est invalide. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::current</methodname> - - ['name' => 'MyApp'], - 'version' => '1.0', -]); - -$config->rewind(); -while ($config->valid()) { - $value = $config->current(); - if ($value instanceof Yaf_Config_Abstract) { - echo $config->key(), " => \n"; - } else { - echo $config->key(), " => ", $value, "\n"; - } - $config->next(); -} -?> -]]> - - &example.outputs.similar; - - -version => 1.0 -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::key - Yaf_Config_Simple::next - Yaf_Config_Simple::rewind - Yaf_Config_Simple::valid - - - - - diff --git a/reference/yaf/yaf_config_simple/get.xml b/reference/yaf/yaf_config_simple/get.xml deleted file mode 100644 index 8530362ada..0000000000 --- a/reference/yaf/yaf_config_simple/get.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Config_Simple::get -Récupère une valeur de configuration - - - - &reftitle.description; - - public mixedYaf_Config_Simple::get - stringnameNULL - - Récupère une valeur de configuration à partir de son nom. Si name est omis ou vaut &null;, l'objet de configuration lui-même est retourné. - - - - &reftitle.parameters; - - - name - -La clé de configuration à récupérer. - - - - - - &reftitle.returnvalues; -La valeur associée à name. Les valeurs de type tableau sont encapsulées dans un objet Yaf_Config_Simple. Retourne &null; si la clé n'existe pas, ou l'objet de configuration lui-même lorsque name vaut &null;. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::get</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -// Les valeurs de type tableau sont encapsulées dans un objet Yaf_Config_Simple -echo $config->get('database')->host, "\n"; -echo $config->get('application')->name, "\n"; -var_dump($config->get('missing')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::set - Yaf_Config_Simple::toArray - - - - - diff --git a/reference/yaf/yaf_config_simple/isset.xml b/reference/yaf/yaf_config_simple/isset.xml deleted file mode 100644 index 3eea1f5ae3..0000000000 --- a/reference/yaf/yaf_config_simple/isset.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Config_Simple::__isset -Vérifie si une clé existe - - - - &reftitle.description; - - public boolYaf_Config_Simple::__isset - stringname - - Vérifie si une clé de configuration existe. Cette méthode est appelée lorsque isset() est utilisé sur un objet de configuration. - - - - &reftitle.parameters; - - - name - -La clé de configuration à vérifier. - - - - - - &reftitle.returnvalues; -Retourne &true; si la clé existe, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::__isset</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -var_dump(isset($config->application)); -var_dump($config->__isset('application')); -var_dump(isset($config->cache)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::offsetExists - - - - - diff --git a/reference/yaf/yaf_config_simple/key.xml b/reference/yaf/yaf_config_simple/key.xml deleted file mode 100644 index d6aa760247..0000000000 --- a/reference/yaf/yaf_config_simple/key.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Config_Simple::key -Retourne la clé de l'entrée courante - - - - &reftitle.description; - - public mixedYaf_Config_Simple::key - - - Retourne la clé de l'entrée de configuration courante lors du parcours. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -La clé de l'entrée courante (chaîne de caractères ou entier), ou &false; si la position est invalide. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::key</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -for ($config->rewind(); $config->valid(); $config->next()) { - echo $config->key(), "\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::current - Yaf_Config_Simple::next - Yaf_Config_Simple::rewind - Yaf_Config_Simple::valid - - - - - diff --git a/reference/yaf/yaf_config_simple/next.xml b/reference/yaf/yaf_config_simple/next.xml deleted file mode 100644 index 182dc6114b..0000000000 --- a/reference/yaf/yaf_config_simple/next.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Config_Simple::next -Avance à l'entrée suivante - - - - &reftitle.description; - - public voidYaf_Config_Simple::next - - - Déplace l'itérateur interne sur l'entrée de configuration suivante. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::next</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -$config->rewind(); -echo $config->key(), "\n"; - -$config->next(); -echo $config->key(), "\n"; - -$config->next(); // au-delà de la dernière entrée -var_dump($config->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::current - Yaf_Config_Simple::key - Yaf_Config_Simple::rewind - Yaf_Config_Simple::valid - - - - - diff --git a/reference/yaf/yaf_config_simple/offsetexists.xml b/reference/yaf/yaf_config_simple/offsetexists.xml deleted file mode 100644 index ea5b64a423..0000000000 --- a/reference/yaf/yaf_config_simple/offsetexists.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Config_Simple::offsetExists -Vérifie si une clé existe (ArrayAccess) - - - - &reftitle.description; - - public boolYaf_Config_Simple::offsetExists - mixedname - - Vérifie si une clé de configuration existe. Cette méthode est un alias de Yaf_Config_Simple::__isset et est appelée lorsque isset() est utilisé avec la syntaxe de tableau sur un objet de configuration. - - - - &reftitle.parameters; - - - name - -La clé de configuration à vérifier. - - - - - - &reftitle.returnvalues; -Retourne &true; si la clé existe, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::offsetExists</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -var_dump(isset($config['database'])); -var_dump($config->offsetExists('database')); -var_dump(isset($config['cache'])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::__isset - - - - - diff --git a/reference/yaf/yaf_config_simple/offsetget.xml b/reference/yaf/yaf_config_simple/offsetget.xml deleted file mode 100644 index 0e043c1b6d..0000000000 --- a/reference/yaf/yaf_config_simple/offsetget.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Config_Simple::offsetGet -Récupère une valeur (ArrayAccess) - - - - &reftitle.description; - - public mixedYaf_Config_Simple::offsetGet - mixedname - - Récupère une valeur de configuration à partir d'une clé. Cette méthode est un alias de Yaf_Config_Simple::get et est appelée lorsque la syntaxe de tableau est utilisée pour lire un objet de configuration. - - - - &reftitle.parameters; - - - name - -La clé de configuration à récupérer. - - - - - - &reftitle.returnvalues; -La valeur associée à name, ou &null; si la clé n'existe pas. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::offsetGet</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -// Les valeurs de type tableau sont encapsulées dans un objet Yaf_Config_Simple -echo $config['application']->name, "\n"; -echo $config['database']['host'], "\n"; -var_dump($config['missing']); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::offsetSet - Yaf_Config_Simple::offsetUnset - - - - - diff --git a/reference/yaf/yaf_config_simple/offsetset.xml b/reference/yaf/yaf_config_simple/offsetset.xml deleted file mode 100644 index 40ec7f2ec9..0000000000 --- a/reference/yaf/yaf_config_simple/offsetset.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Config_Simple::offsetSet -Définit une valeur de configuration (ArrayAccess) - - - - &reftitle.description; - - public voidYaf_Config_Simple::offsetSet - mixedname - mixedvalue - - Définit une valeur de configuration en utilisant la syntaxe de tableau. Cette méthode est un alias de Yaf_Config_Simple::set. L'affectation échoue silencieusement si la configuration est en lecture seule. - - - - &reftitle.parameters; - - - name - -La clé de configuration à définir. - - - - value - -La valeur à affecter. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. L'affectation échoue si la configuration est en lecture seule. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::offsetSet</methodname> - - 'development']); - -// Accessible en écriture par défaut -$config['env'] = 'production'; -$config['cache'] = ['enable' => true]; -echo $config['env'], "\n"; -var_dump($config['cache']['enable']); - -// Les affectations sur une configuration en lecture seule échouent silencieusement -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -$frozen['env'] = 'production'; -echo $frozen['env'], "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::set - Yaf_Config_Simple::offsetGet - Yaf_Config_Simple::offsetUnset - - - - - diff --git a/reference/yaf/yaf_config_simple/offsetunset.xml b/reference/yaf/yaf_config_simple/offsetunset.xml deleted file mode 100644 index 55aff31c45..0000000000 --- a/reference/yaf/yaf_config_simple/offsetunset.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Config_Simple::offsetUnset -Supprime une clé (ArrayAccess) - - - - &reftitle.description; - - public voidYaf_Config_Simple::offsetUnset - mixedname - - Supprime une entrée de configuration par sa clé. Cette méthode est appelée lorsque unset() est utilisé avec la syntaxe de tableau sur un objet de configuration. - - - - &reftitle.parameters; - - - name - -La clé de configuration à supprimer. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. Une alerte est émise si la configuration est en lecture seule. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::offsetUnset</methodname> - - ['enable' => true], - 'env' => 'development', -]); - -unset($config['cache']); -var_dump(isset($config['cache'])); - -// Les configurations en lecture seule ne peuvent pas être modifiées : une alerte est émise -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -unset($frozen['env']); -var_dump(isset($frozen['env'])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::offsetGet - Yaf_Config_Simple::offsetSet - - - - - diff --git a/reference/yaf/yaf_config_simple/readonly.xml b/reference/yaf/yaf_config_simple/readonly.xml deleted file mode 100644 index 2b38727beb..0000000000 --- a/reference/yaf/yaf_config_simple/readonly.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - -Yaf_Config_Simple::readonly -Vérifie si la configuration est en lecture seule - - - - &reftitle.description; - - public boolYaf_Config_Simple::readonly - - - Vérifie si la configuration est en lecture seule. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la configuration est en lecture seule, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::readonly</methodname> - - 'development']); -var_dump($writable->readonly()); - -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -var_dump($frozen->readonly()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::set - - - - - diff --git a/reference/yaf/yaf_config_simple/rewind.xml b/reference/yaf/yaf_config_simple/rewind.xml deleted file mode 100644 index 16cf77a2a0..0000000000 --- a/reference/yaf/yaf_config_simple/rewind.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Config_Simple::rewind -Replace l'itérateur sur la première entrée - - - - &reftitle.description; - - public voidYaf_Config_Simple::rewind - - - Replace l'itérateur interne sur la première entrée de configuration. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::rewind</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -$config->next(); -echo $config->key(), "\n"; - -$config->rewind(); -echo $config->key(), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::current - Yaf_Config_Simple::key - Yaf_Config_Simple::next - Yaf_Config_Simple::valid - - - - - diff --git a/reference/yaf/yaf_config_simple/set.xml b/reference/yaf/yaf_config_simple/set.xml deleted file mode 100644 index edf3012c5a..0000000000 --- a/reference/yaf/yaf_config_simple/set.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - -Yaf_Config_Simple::set -Définit une valeur de configuration - - - - &reftitle.description; - - public boolYaf_Config_Simple::set - stringname - mixedvalue - - Définit une valeur de configuration. Échoue et retourne &false; si la configuration est en lecture seule. - - - - &reftitle.parameters; - - - name - -La clé de configuration à définir. - - - - value - -La valeur à assigner. - - - - - - &reftitle.returnvalues; -Retourne &true; en cas de succès, ou &false; si la configuration est en lecture seule. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::set</methodname> - - 'development']); - -var_dump($config->set('env', 'production')); -echo $config->env, "\n"; - -// Les configurations en lecture seule rejettent la modification -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -var_dump($frozen->set('env', 'production')); -echo $frozen->env, "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::readonly - - - - - diff --git a/reference/yaf/yaf_config_simple/toarray.xml b/reference/yaf/yaf_config_simple/toarray.xml deleted file mode 100644 index 9b1fef7c5c..0000000000 --- a/reference/yaf/yaf_config_simple/toarray.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Config_Simple::toArray -Exporte la configuration sous forme de tableau - - - - &reftitle.description; - - public arrayYaf_Config_Simple::toArray - - - Retourne l'intégralité de la configuration sous la forme d'un simple tableau PHP. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Les données de configuration sous la forme d'un tableau. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::toArray</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost', 'port' => 3306], -]); - -print_r($config->toArray()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => MyApp - ) - - [database] => Array - ( - [host] => localhost - [port] => 3306 - ) - -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - - - - - diff --git a/reference/yaf/yaf_config_simple/valid.xml b/reference/yaf/yaf_config_simple/valid.xml deleted file mode 100644 index 5b37b4dc97..0000000000 --- a/reference/yaf/yaf_config_simple/valid.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Config_Simple::valid -Vérifie si la position courante est valide - - - - &reftitle.description; - - public boolYaf_Config_Simple::valid - - - Vérifie si la position courante de l'itérateur est valide. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la position courante est valide, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Config_Simple::valid</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -$config->rewind(); -var_dump($config->valid()); - -$config->next(); -var_dump($config->valid()); - -$config->next(); // au-delà de la dernière entrée -var_dump($config->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::current - Yaf_Config_Simple::key - Yaf_Config_Simple::next - Yaf_Config_Simple::rewind - - - - - diff --git a/reference/yaf/yaf_controller_abstract/construct.xml b/reference/yaf/yaf_controller_abstract/construct.xml deleted file mode 100644 index 9c7e014354..0000000000 --- a/reference/yaf/yaf_controller_abstract/construct.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Yaf_Controller_Abstract::__construct - Constructeur de Yaf_Controller_Abstract - - - - &reftitle.description; - - public Yaf_Controller_Abstract::__construct - - - - Yaf_Controller_Abstract::__construct est - appelée par Yaf lorsqu'un objet contrôleur est créé pendant la - distribution. Elle ne prend aucun argument et ne devrait pas être - appelée directement. Comme elle n'est pas destinée à être surchargée - avec une logique personnalisée, la méthode - Yaf_Controller_Abstract::init est fournie à - la place comme point d'entrée d'initialisation côté utilisateur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Aucune valeur n'est retournée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::__construct</methodname> - -getRequest() instanceof Yaf_Request_Abstract); - var_dump($this->getResponse() instanceof Yaf_Response_Abstract); - var_dump($this->getView() instanceof Yaf_View_Interface); - } - - public function indexAction() { - // ... - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::init - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/display.xml b/reference/yaf/yaf_controller_abstract/display.xml deleted file mode 100644 index d8a1a7212d..0000000000 --- a/reference/yaf/yaf_controller_abstract/display.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - Yaf_Controller_Abstract::display - Effectue le rendu d'une vue et l'affiche - - - - &reftitle.description; - - protected boolnullYaf_Controller_Abstract::display - stringtpl - arraynullparameters - - - Effectue le rendu du script de vue tpl et envoie - directement le résultat, contrairement à - Yaf_Controller_Abstract::render, - qui retourne à la place le résultat du rendu. Le rendu automatique - du template de l'action par défaut est contrôlé par - Yaf_Dispatcher::autoRender. - - - - - &reftitle.parameters; - - - tpl - - - Le nom du script de vue, relatif au chemin des vues. - - - - - parameters - - - Un tableau associatif de variables à exporter vers le - script de vue pour ce rendu, qui remplacent celles - assignées via le moteur de vue. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, ou &false; / &null; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::display</methodname> - -display("product/list.phtml", array( - "products" => array("yaf", "php"), - )); - } -} -?> -]]> - - - - Exemple de template - - -
      - -
      • - -
    -]]> -     - &example.outputs.similar; - - -
  • yaf
    • -
  • php
    • - -]]> -     -     -     - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::render - Yaf_Dispatcher::autoRender - - - - -     - - diff --git a/reference/yaf/yaf_controller_abstract/forward.xml b/reference/yaf/yaf_controller_abstract/forward.xml deleted file mode 100644 index 10e5e08824..0000000000 --- a/reference/yaf/yaf_controller_abstract/forward.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - Yaf_Controller_Abstract::forward - Transfère la requête courante vers une autre action - - - - &reftitle.description; - - public boolnullYaf_Controller_Abstract::forward - stringaction - arraynullparameters - - - public boolnullYaf_Controller_Abstract::forward - stringcontroller - stringaction - arraynullparameters - - - public boolnullYaf_Controller_Abstract::forward - stringmodule - stringcontroller - stringaction - arraynullparameters - - - Transfère la requête courante vers une autre action. La cible est - déterminée à partir du nombre et du type des arguments : - - - action seul : transfère vers une autre action du contrôleur courant. - controller et action : transfère vers un autre contrôleur. - module, controller et action : transfère vers un autre module. - Le tableau optionnel parameters transporte les arguments d'invocation récupérables avec Yaf_Request_Abstract::getParam. - - - - Cette méthode ne bascule pas immédiatement vers l'action de - destination ; la bascule a lieu une fois le flux courant terminé. - Pour passer la main immédiatement, il faut sortir de la méthode - d'action courante (retourner &false; indique également à Yaf de ne - pas effectuer le rendu automatique de la vue courante). - - - - - - &reftitle.parameters; - - - module - - - Le nom du module de destination. Si le module courant est fourni, - il est utilisé tel quel. - - - - - controller - - - Le nom du contrôleur de destination. - - - - - action - - - Le nom de l'action de destination. - - - - - parameters - - - Les arguments d'invocation de l'action de destination, - récupérables avec Yaf_Request_Abstract::getParam. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, ou &false; / &null; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Controller_Abstract::forward</function> - -forward("login", array("from" => "Index")); // transfère vers l'action login - return false; // ceci est important, cela termine le flux courant - // et indique à Yaf de ne pas effectuer le rendu automatique - } - - // autres traitements - } - - public function loginAction() { - echo "login, redirigé depuis l'action ", $this->_request->getParam("from"); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Request_Abstract::getParam - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getinvokearg.xml b/reference/yaf/yaf_controller_abstract/getinvokearg.xml deleted file mode 100644 index 1196177bf0..0000000000 --- a/reference/yaf/yaf_controller_abstract/getinvokearg.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getInvokeArg - Récupère un argument d'invocation de l'action - - - - &reftitle.description; - - public stringnullYaf_Controller_Abstract::getInvokeArg - stringname - - - Retourne un unique argument d'invocation de l'action courante, à partir - de son nom. Les arguments d'invocation sont transmis à l'action via - Yaf_Controller_Abstract::forward. - - - - - &reftitle.parameters; - - - name - - - Le nom de l'argument d'invocation à récupérer. - - - - - - - - &reftitle.returnvalues; - - La valeur de l'argument, ou &null; s'il n'existe pas. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::getInvokeArg</methodname> - -forward("profile", array("name" => "laruence")); - return false; // termine le flux courant - } - - public function profileAction() { - // récupère un argument d'invocation par son nom - var_dump($this->getInvokeArg("name")); - var_dump($this->getInvokeArg("missing")); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getInvokeArgs - Yaf_Controller_Abstract::forward - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getinvokeargs.xml b/reference/yaf/yaf_controller_abstract/getinvokeargs.xml deleted file mode 100644 index 778aff5aee..0000000000 --- a/reference/yaf/yaf_controller_abstract/getinvokeargs.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getInvokeArgs - Récupère tous les arguments d'invocation de l'action - - - - &reftitle.description; - - public arraynullYaf_Controller_Abstract::getInvokeArgs - - - - Retourne tous les arguments d'invocation de l'action courante, sous la forme - d'un tableau indexé par le nom de l'argument. Les arguments d'invocation sont - transmis à l'action via - Yaf_Controller_Abstract::forward. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un tableau d'arguments d'invocation, ou &null; si aucun n'a été fourni. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::getInvokeArgs</methodname> - -forward("list", array("category" => "book", "page" => 2)); - return false; // termine le flux courant - } - - public function listAction() { - // tous les arguments d'invocation de l'action courante - var_dump($this->getInvokeArgs()); - } -} -?> -]]> - - &example.outputs.similar; - - - string(4) "book" - ["page"]=> - int(2) -} -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getInvokeArg - Yaf_Controller_Abstract::forward - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getmodulename.xml b/reference/yaf/yaf_controller_abstract/getmodulename.xml deleted file mode 100644 index cbe5218d8f..0000000000 --- a/reference/yaf/yaf_controller_abstract/getmodulename.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getModuleName - Récupère le nom du module - - - - &reftitle.description; - - public stringnullYaf_Controller_Abstract::getModuleName - - - - Retourne le nom du module auquel appartient le contrôleur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom du module sous forme de &string;, ou &null; s'il n'est pas défini. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::getModuleName</methodname> - -getModuleName()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getName - Yaf_Request_Abstract::getModuleName - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getname.xml b/reference/yaf/yaf_controller_abstract/getname.xml deleted file mode 100644 index 5640ca3124..0000000000 --- a/reference/yaf/yaf_controller_abstract/getname.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getName - Retourne le nom du contrôleur - - - - &reftitle.description; - - public stringnullYaf_Controller_Abstract::getName - - - - Retourne le nom du contrôleur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom du contrôleur sous forme de &string;, ou &null; s'il n'est pas - défini. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::getName</methodname> - -getName()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getModuleName - Yaf_Request_Abstract::getControllerName - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getrequest.xml b/reference/yaf/yaf_controller_abstract/getrequest.xml deleted file mode 100644 index 566995cc38..0000000000 --- a/reference/yaf/yaf_controller_abstract/getrequest.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getRequest - Récupère l'objet de requête courant - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Controller_Abstract::getRequest - - - - Retourne l'instance de Yaf_Request_Abstract associée à ce contrôleur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une instance de Yaf_Request_Abstract, ou &null; si aucune requête n'est disponible. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::getRequest</methodname> - -getRequest(); - var_dump($request->getModuleName()); - var_dump($request->getControllerName()); - var_dump($request->getActionName()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getResponse - Yaf_Request_Abstract - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getresponse.xml b/reference/yaf/yaf_controller_abstract/getresponse.xml deleted file mode 100644 index 4c6f31a2bd..0000000000 --- a/reference/yaf/yaf_controller_abstract/getresponse.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getResponse - Récupère l'objet de réponse courant - - - - &reftitle.description; - - public Yaf_Response_AbstractnullYaf_Controller_Abstract::getResponse - - - - Retourne l'instance de Yaf_Response_Abstract associée à ce contrôleur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une instance de Yaf_Response_Abstract, ou &null; si aucune réponse n'est disponible. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::getResponse</methodname> - -disableView(); - - $response = $this->getResponse(); - $response->setHeader("Content-Type", "application/json"); - $response->setBody(json_encode(array("name" => "yaf"))); - // Yaf envoie le corps une fois la boucle de distribution terminée - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getRequest - Yaf_Response_Abstract - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getview.xml b/reference/yaf/yaf_controller_abstract/getview.xml deleted file mode 100644 index 3132b0f98e..0000000000 --- a/reference/yaf/yaf_controller_abstract/getview.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getView - Récupère le moteur de vue - - - - &reftitle.description; - - public Yaf_View_InterfacenullYaf_Controller_Abstract::getView - - - - Retourne le moteur de vue lié à ce contrôleur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une instance de Yaf_View_Interface, ou &null; si aucun moteur de vue n'est disponible. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::getView</methodname> - -getView(); - - // exporte $products vers le template product/index.phtml - $view->assign("products", array("yaf", "php")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::initView - Yaf_View_Interface - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getviewpath.xml b/reference/yaf/yaf_controller_abstract/getviewpath.xml deleted file mode 100644 index 6bce8a94e8..0000000000 --- a/reference/yaf/yaf_controller_abstract/getviewpath.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getViewpath - Récupère le chemin des vues - - - - &reftitle.description; - - public stringnullYaf_Controller_Abstract::getViewpath - - - - Retourne le dossier des templates utilisé par le moteur de vue lié à ce contrôleur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le dossier des templates de la vue, sous forme de &string;. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::getViewpath</methodname> - -getViewpath()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::setViewpath - Yaf_Controller_Abstract::initView - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/init.xml b/reference/yaf/yaf_controller_abstract/init.xml deleted file mode 100644 index e2a9c7daa8..0000000000 --- a/reference/yaf/yaf_controller_abstract/init.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Controller_Abstract::init - Initialisateur du contrôleur - - - - &reftitle.description; - - public voidYaf_Controller_Abstract::init - - - - La méthode Yaf_Controller_Abstract::__construct - n'est pas destinée à être surchargée avec une logique personnalisée. - La méthode Yaf_Controller_Abstract::init est donc - fournie comme point d'entrée d'initialisation côté utilisateur. Si elle est - définie dans un contrôleur, elle est appelée juste après l'instanciation - de l'objet contrôleur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Aucune valeur n'est retournée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::init</methodname> - -getView()->assign("sitename", "Tutoriel Yaf"); - } - - public function indexAction() { - // ... - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Controller_Abstract::__construct - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/initview.xml b/reference/yaf/yaf_controller_abstract/initview.xml deleted file mode 100644 index 9a01b93c82..0000000000 --- a/reference/yaf/yaf_controller_abstract/initview.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Yaf_Controller_Abstract::initView - Initialise la vue et la retourne - - - - &reftitle.description; - - public Yaf_View_InterfacenullYaf_Controller_Abstract::initView - arraynulloptions - - - Retourne le moteur de vue lié à ce contrôleur. Le moteur de vue est - initialisé par Yaf_Dispatcher lors de la - distribution, en utilisant le chemin des templates défini pour le - contrôleur courant. - - - - - &reftitle.parameters; - - - options - - - Options passées au moteur de vue, voir - Yaf_View_Simple::__construct. - - - - - - - - &reftitle.returnvalues; - - Une instance de Yaf_View_Interface en cas de succès, - ou &null; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::initView</methodname> - -initView(); - $view->assign("products", array("yaf", "php")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getView - Yaf_View_Interface - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/redirect.xml b/reference/yaf/yaf_controller_abstract/redirect.xml deleted file mode 100644 index dfa561f536..0000000000 --- a/reference/yaf/yaf_controller_abstract/redirect.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Controller_Abstract::redirect - Redirige vers une URL - - - - &reftitle.description; - - public boolnullYaf_Controller_Abstract::redirect - stringurl - - - Redirige le client vers une autre URL en envoyant un en-tête - Location (statut HTTP 302). - - - - - &reftitle.parameters; - - - url - - - L'URL vers laquelle rediriger. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, ou &false; / &null; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::redirect</methodname> - -getRequest()->getParam("user")) { - // envoie un en-tête Location avec le statut HTTP 302 - $this->redirect("http://www.example.com/account/login/"); - return false; // ignore le rendu automatique - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::forward - Yaf_Response_Abstract::setRedirect - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/render.xml b/reference/yaf/yaf_controller_abstract/render.xml deleted file mode 100644 index 18f62cb84c..0000000000 --- a/reference/yaf/yaf_controller_abstract/render.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Controller_Abstract::render - Effectue le rendu du template de la vue - - - - &reftitle.description; - - protected stringboolnullYaf_Controller_Abstract::render - stringtpl - arraynullparameters - - - Effectue le rendu du script de vue tpl et retourne - les données de sortie, contrairement à - Yaf_Controller_Abstract::display. - - - - - &reftitle.parameters; - - - tpl - - - Le nom du script de vue, relatif au chemin des vues. - - - - - parameters - - - Un tableau associatif de variables à exporter vers le script de vue - pour ce rendu. - - - - - - - - &reftitle.returnvalues; - - Les données de sortie du rendu sous forme de &string; en cas de succès, - ou &false; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::render</methodname> - -disableView(); - - // effectue le rendu de product/index.phtml et retourne les données - // de sortie au lieu de les envoyer directement (comme le ferait display()) - $html = $this->render("product/index.phtml", array( - "products" => array("yaf", "php"), - )); - - // post-traitement et définition en tant que corps de la réponse - $this->getResponse()->setBody($html); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::display - Yaf_Dispatcher::autoRender - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/setviewpath.xml b/reference/yaf/yaf_controller_abstract/setviewpath.xml deleted file mode 100644 index cf9df4516f..0000000000 --- a/reference/yaf/yaf_controller_abstract/setviewpath.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Yaf_Controller_Abstract::setViewpath - Définit le chemin des vues - - - - &reftitle.description; - - public boolnullYaf_Controller_Abstract::setViewpath - stringview_directory - - - Définit le dossier des templates du moteur de vue lié à ce - contrôleur. - - - - - &reftitle.parameters; - - - view_directory - - - Le dossier qui contient les templates de vue. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès, ou &false; / &null; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Controller_Abstract::setViewpath</methodname> - -setViewpath(APPLICATION_PATH . "/themes/dark/views"); - } - - public function indexAction() { - // affiche application/themes/dark/views/product/index.phtml - $this->display("product/index.phtml"); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getViewpath - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/autorender.xml b/reference/yaf/yaf_dispatcher/autorender.xml deleted file mode 100644 index b30afdf967..0000000000 --- a/reference/yaf/yaf_dispatcher/autorender.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yaf_Dispatcher::autoRender - Active ou désactive le rendu automatique - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::autoRender - boolnullflagnull - - - Yaf_Dispatcher effectue automatiquement le rendu de la vue - après avoir distribué une requête entrante. Il est possible d'empêcher - ce rendu en appelant cette méthode avec le paramètre - flag valant &false;. - - - - Il est également possible de simplement retourner &false; dans une action pour empêcher - le rendu automatique de cette seule action. - - - - - - &reftitle.parameters; - - - flag - - - Indique s'il faut activer le rendu automatique. - - - - À partir de Yaf 2.2.0, si ce paramètre n'est pas fourni, l'état courant - est retourné à la place. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même lorsque - flag est fourni, ou un &boolean; indiquant si - le rendu automatique est activé lorsqu'il ne l'est pas. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Dispatcher::autoRender</function> - -getRequest()->isXmlHttpRequest()) { - //n'appelle pas render pour une requête ajax - //une chaîne json sera affichée - Yaf_Dispatcher::getInstance()->autoRender(FALSE); - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::flushInstantly - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/catchexception.xml b/reference/yaf/yaf_dispatcher/catchexception.xml deleted file mode 100644 index 7f7d5705e0..0000000000 --- a/reference/yaf/yaf_dispatcher/catchexception.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - Yaf_Dispatcher::catchException - Active/désactive la capture des exceptions - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::catchException - boolnullflagnull - - - Lorsque - application.dispatcher.throwException - est activé (ce qui peut également se faire en appelant - Yaf_Dispatcher::throwException), Yaf lève des - exceptions lorsque des erreurs surviennent, au lieu de déclencher des erreurs. - - - Si la capture des exceptions est de plus activée via cette méthode (ou via - application.dispatcher.catchException), - toutes les exceptions non capturées sont capturées et transmises à - ErrorController::error, si une telle méthode est définie. - - - - - &reftitle.parameters; - - - flag - - - Indique si Yaf devrait capturer les exceptions non capturées et les - transmettre à ErrorController::error. - - - - À partir de Yaf 2.2.0, si ce paramètre n'est pas fourni, l'état courant - est retourné à la place. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même lorsque - flag est fourni, ou un &boolean; indiquant si la - capture des exceptions est activée lorsqu'il ne l'est pas. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Dispatcher::catchException</function> - -getCode()) { - case YAF_ERR_NOTFOUND_MODULE: - case YAF_ERR_NOTFOUND_CONTROLLER: - case YAF_ERR_NOTFOUND_ACTION: - case YAF_ERR_NOTFOUND_VIEW: - echo 404, ":", $exception->getMessage(); - break; - default : - $message = $exception->getMessage(); - echo 0, ":", $exception->getMessage(); - break; - } - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::throwException - Yaf_Dispatcher::setErrorHandler - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/construct.xml b/reference/yaf/yaf_dispatcher/construct.xml deleted file mode 100644 index b082d0e8a6..0000000000 --- a/reference/yaf/yaf_dispatcher/construct.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Dispatcher::__construct - Constructeur de Yaf_Dispatcher - - - - &reftitle.description; - - private Yaf_Dispatcher::__construct - - - - Yaf_Dispatcher implémente le patron singleton, aussi - son constructeur est-il privé. Il faut utiliser - Yaf_Dispatcher::getInstance pour récupérer - l'instance du distributeur, qui est créée par - Yaf_Application. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <classname>Yaf_Dispatcher</classname> est un singleton - - -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::getInstance - Yaf_Application::getDispatcher - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/disableview.xml b/reference/yaf/yaf_dispatcher/disableview.xml deleted file mode 100644 index dd9a560ded..0000000000 --- a/reference/yaf/yaf_dispatcher/disableview.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Yaf_Dispatcher::disableView - Désactive le rendu de la vue - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::disableView - - - - Désactive le rendu de la vue. Ceci est généralement utilisé pour les actions - qui génèrent elles-mêmes leurs données de sortie, comme les actions qui - retournent des données JSON. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même en cas de - succès, ou &null; si l'application n'est pas initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::disableView</methodname> - -disableView(); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::enableView - Yaf_Dispatcher::autoRender - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/dispatch.xml b/reference/yaf/yaf_dispatcher/dispatch.xml deleted file mode 100644 index 534a406b41..0000000000 --- a/reference/yaf/yaf_dispatcher/dispatch.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Yaf_Dispatcher::dispatch - Répartit une requête - - - - &reftitle.description; - - public Yaf_Response_AbstractnullfalseYaf_Dispatcher::dispatch - Yaf_Request_Abstractrequest - - - Cette méthode réalise le gros du travail de la classe - Yaf_Dispatcher. Elle prend un objet de requête. - - - Le processus de répartition comporte trois événements distincts : - - Routage - Répartition - Réponse - - Le routage n'a lieu qu'une seule fois, en utilisant les valeurs de l'objet - de requête au moment où Yaf_Dispatcher::dispatch - est appelée. La répartition a lieu dans une boucle ; une requête peut soit - indiquer plusieurs actions à répartir, soit le contrôleur ou un plugin peut - réinitialiser l'objet de requête pour forcer la répartition d'actions - supplémentaires (voir Yaf_Plugin_Abstract). Lorsque - tout est terminé, la classe Yaf_Dispatcher retourne - une réponse. - - - - - &reftitle.parameters; - - - request - - - Une instance de Yaf_Request_Abstract à répartir. - - - - - - - - &reftitle.returnvalues; - - L'instance de Yaf_Response_Abstract en cas de succès, - &false; en cas d'échec, ou &null; si l'application n'est pas initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::dispatch</methodname> - -bootstrap(); - -// Construit une requête pointant vers ProductController::detailAction et -// la répartit manuellement. -$request = new Yaf_Request_Http("/product/detail/id/42"); - -$response = Yaf_Dispatcher::getInstance()->dispatch($request); - -if ($response instanceof Yaf_Response_Abstract) { - $response->response(); -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Application::run - Yaf_Plugin_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/enableview.xml b/reference/yaf/yaf_dispatcher/enableview.xml deleted file mode 100644 index 23b6ede2c2..0000000000 --- a/reference/yaf/yaf_dispatcher/enableview.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Yaf_Dispatcher::enableView - Active le rendu de la vue - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::enableView - - - - Active le rendu de la vue. C'est l'inverse de - Yaf_Dispatcher::disableView. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même en cas de - succès, ou &null; si l'application n'est pas initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::enableView</methodname> - -getModuleName() === "Api") { - // Les actions de l'API affichent elles-mêmes du JSON, aucun rendu de vue n'est souhaité - $dispatcher->disableView(); - } else { - $dispatcher->enableView(); - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::disableView - Yaf_Dispatcher::autoRender - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/flushinstantly.xml b/reference/yaf/yaf_dispatcher/flushinstantly.xml deleted file mode 100644 index 10a40ae354..0000000000 --- a/reference/yaf/yaf_dispatcher/flushinstantly.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Yaf_Dispatcher::flushInstantly - Active/désactive l'envoi instantané - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::flushInstantly - boolnullflagnull - - - Active ou désactive l'envoi instantané. Lorsqu'il est activé (comportement - par défaut), le corps de la réponse est envoyé au client immédiatement dès - qu'il est défini par - Yaf_Response_Abstract::setBody. - - - - - &reftitle.parameters; - - - flag - - - Indique s'il faut envoyer instantanément le corps de la réponse. - - - - À partir de Yaf 2.2.0, si ce paramètre n'est pas fourni, l'état - courant est retourné à la place. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même lorsque - flag est fourni, ou un &boolean; indiquant l'état - courant lorsqu'il ne l'est pas. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::flushInstantly</methodname> - -flushInstantly(false); - -// À partir de Yaf 2.2.0, un appel sans argument interroge l'état courant -var_dump($dispatcher->flushInstantly()); - -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::returnResponse - Yaf_Response_Abstract::setBody - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getapplication.xml b/reference/yaf/yaf_dispatcher/getapplication.xml deleted file mode 100644 index 7ea7077e37..0000000000 --- a/reference/yaf/yaf_dispatcher/getapplication.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Yaf_Dispatcher::getApplication - Récupère l'application - - - - &reftitle.description; - - public Yaf_ApplicationnullYaf_Dispatcher::getApplication - - - - Récupère l'instance Yaf_Application. Identique à - Yaf_Application::app. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'instance Yaf_Application, ou &null; si aucune - application n'a encore été initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::getApplication</methodname> - -getApplication() === Yaf_Application::app()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::app - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getdefaultaction.xml b/reference/yaf/yaf_dispatcher/getdefaultaction.xml deleted file mode 100644 index e0d01f86e9..0000000000 --- a/reference/yaf/yaf_dispatcher/getdefaultaction.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Dispatcher::getDefaultAction - Récupère le nom de l'action par défaut - - - - &reftitle.description; - - public stringnullYaf_Dispatcher::getDefaultAction - - - - Récupère le nom de l'action par défaut, utilisé lorsqu'aucun nom d'action - ne peut être extrait de l'URI de la requête. Vaut - "index" par défaut. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom de l'action par défaut, ou &null; si l'application n'est pas - initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::getDefaultAction</methodname> - -getDefaultAction()); - -$dispatcher->setDefaultAction("main"); -var_dump($dispatcher->getDefaultAction()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultAction - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getdefaultcontroller.xml b/reference/yaf/yaf_dispatcher/getdefaultcontroller.xml deleted file mode 100644 index 8f376e18ed..0000000000 --- a/reference/yaf/yaf_dispatcher/getdefaultcontroller.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Yaf_Dispatcher::getDefaultController - Récupère le nom du contrôleur par défaut - - - - &reftitle.description; - - public stringnullYaf_Dispatcher::getDefaultController - - - - Récupère le nom du contrôleur par défaut, qui est utilisé lorsqu'aucun nom - de contrôleur ne peut être extrait de l'URI de la requête. Vaut - "Index" par défaut. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom du contrôleur par défaut, ou &null; si l'application n'est pas - initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::getDefaultController</methodname> - -getDefaultController()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultController - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getdefaultmodule.xml b/reference/yaf/yaf_dispatcher/getdefaultmodule.xml deleted file mode 100644 index 9acc4420ff..0000000000 --- a/reference/yaf/yaf_dispatcher/getdefaultmodule.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Yaf_Dispatcher::getDefaultModule - Récupère le nom du module par défaut - - - - &reftitle.description; - - public stringnullYaf_Dispatcher::getDefaultModule - - - - Récupère le nom du module par défaut, qui est utilisé lorsqu'aucun nom de - module ne peut être extrait de l'URI de la requête. Vaut - "Index" par défaut. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom du module par défaut, ou &null; si l'application n'est pas - initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::getDefaultModule</methodname> - -getDefaultModule()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultModule - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getinstance.xml b/reference/yaf/yaf_dispatcher/getinstance.xml deleted file mode 100644 index cd2efa6a54..0000000000 --- a/reference/yaf/yaf_dispatcher/getinstance.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Yaf_Dispatcher::getInstance - Récupère l'instance du distributeur - - - - &reftitle.description; - - public static Yaf_DispatchernullYaf_Dispatcher::getInstance - - - - Récupère l'unique instance de Yaf_Dispatcher. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'instance de Yaf_Dispatcher, ou &null; si aucune - Yaf_Application n'a encore été initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::getInstance</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::getDispatcher - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getrequest.xml b/reference/yaf/yaf_dispatcher/getrequest.xml deleted file mode 100644 index b855e19d5f..0000000000 --- a/reference/yaf/yaf_dispatcher/getrequest.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Dispatcher::getRequest - Récupère l'instance de la requête - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Dispatcher::getRequest - - - - Récupère l'objet requête détenu par le distributeur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'instance de Yaf_Request_Abstract, ou &null; si - l'application n'est pas initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::getRequest</methodname> - -getRequest(); - - // Le distributeur détient exactement le même objet requête que - // celui passé au contrôleur - var_dump($request === $this->getRequest()); - - return false; - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setRequest - Yaf_Request_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getresponse.xml b/reference/yaf/yaf_dispatcher/getresponse.xml deleted file mode 100644 index bf4b0a9fb6..0000000000 --- a/reference/yaf/yaf_dispatcher/getresponse.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Dispatcher::getResponse - Récupère l'objet réponse - - - - &reftitle.description; - - public Yaf_Response_AbstractnullYaf_Dispatcher::getResponse - - - - Récupère l'instance de Yaf_Response_Abstract - utilisée par le distributeur. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'instance de Yaf_Response_Abstract, ou &null; si - l'application n'est pas initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::getResponse</methodname> - -getResponse()->setHeader( - "Content-Type", "text/html; charset=utf-8" - ); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setResponse - Yaf_Response_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getrouter.xml b/reference/yaf/yaf_dispatcher/getrouter.xml deleted file mode 100644 index 316656ee30..0000000000 --- a/reference/yaf/yaf_dispatcher/getrouter.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Dispatcher::getRouter - Récupère l'instance du routeur - - - - &reftitle.description; - - public Yaf_RouternullYaf_Dispatcher::getRouter - - - - Récupère l'instance de Yaf_Router utilisée par le - dispatcher pour router les requêtes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'instance de Yaf_Router, ou &null; si - l'application n'est pas initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::getRouter</methodname> - -getRouter(); - - // Route /product/42 vers ProductController::detailAction - $router->addRoute("product", new Yaf_Route_Rewrite( - "product/:id", - array("controller" => "product", "action" => "detail") - )); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Router - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/initview.xml b/reference/yaf/yaf_dispatcher/initview.xml deleted file mode 100644 index a0ed194148..0000000000 --- a/reference/yaf/yaf_dispatcher/initview.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Yaf_Dispatcher::initView - Initialise la vue et la retourne - - - - &reftitle.description; - - public Yaf_View_InterfacenullfalseYaf_Dispatcher::initView - stringtemplates_dir - arraynulloptionsnull - - - Initialise et retourne une instance de - Yaf_View_Simple liée au distributeur, en utilisant - le répertoire de templates fourni. - - - - - &reftitle.parameters; - - - templates_dir - - - Le répertoire qui contient les templates de la vue. - - - - - options - - - Les options passées au moteur de vue, voir - Yaf_View_Simple::__construct. - - - - - - - - &reftitle.returnvalues; - - Une instance de Yaf_View_Interface en cas de - succès, ou &false; / &null; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::initView</methodname> - -initView( - dirname(__FILE__) . "/application/views", - array("tpl_suffix" => ".html") -); - -$view->assign("title", "Accueil"); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setView - Yaf_View_Simple - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/registerplugin.xml b/reference/yaf/yaf_dispatcher/registerplugin.xml deleted file mode 100644 index c232725b95..0000000000 --- a/reference/yaf/yaf_dispatcher/registerplugin.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Dispatcher::registerPlugin - Enregistre un plugin - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::registerPlugin - Yaf_Plugin_Abstractplugin - - - Enregistre un plugin (voir Yaf_Plugin_Abstract). - Généralement, les plugins sont enregistrés dans le Bootstrap (voir - Yaf_Bootstrap_Abstract). - - - - - &reftitle.parameters; - - - plugin - - - Une instance de Yaf_Plugin_Abstract. - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même en cas de - succès, ou &false; / &null; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Dispatcher::registerPlugin</function> - -registerPlugin($user); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Plugin_Abstract - Yaf_Bootstrap_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/returnresponse.xml b/reference/yaf/yaf_dispatcher/returnresponse.xml deleted file mode 100644 index cf83032150..0000000000 --- a/reference/yaf/yaf_dispatcher/returnresponse.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Yaf_Dispatcher::returnResponse - Active ou désactive le retour de la réponse - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::returnResponse - boolflagfalse - - - Détermine si - Yaf_Application::run retourne l'objet réponse - au lieu de l'envoyer directement au client. Lorsque cette option est - activée, $response = $app->run() fournit l'instance de - Yaf_Response_Abstract, qui peut alors être - manipulée davantage. Disponible à partir de Yaf 3.2.2. - - - - - &reftitle.parameters; - - - flag - - - Indique s'il faut retourner la réponse au lieu de l'envoyer. - - - - Si ce paramètre n'est pas fourni, l'état courant est retourné à la - place. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même lorsque - flag est fourni, ou un &boolean; indiquant l'état - courant lorsqu'il ne l'est pas. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::returnResponse</methodname> - -returnResponse(true); - -// $app->run() retourne désormais la réponse au lieu de l'envoyer -$response = $app->run(); - -$response->setHeader("X-Generator", "Yaf"); -$response->response(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Application::run - Yaf_Response_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setdefaultaction.xml b/reference/yaf/yaf_dispatcher/setdefaultaction.xml deleted file mode 100644 index d799cf6eb0..0000000000 --- a/reference/yaf/yaf_dispatcher/setdefaultaction.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Yaf_Dispatcher::setDefaultAction - Modifie le nom par défaut de l'action - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::setDefaultAction - stringaction - - - Modifie le nom de l'action utilisé lorsqu'un nom d'action ne peut pas - être extrait de l'URI de la requête. Le nom est normalisé en minuscules. - - - - - &reftitle.parameters; - - - action - - - Le nom de l'action. - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même en cas de - succès, ou &false; si l'application n'est pas initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::setDefaultAction</methodname> - -setDefaultAction("main"); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultModule - Yaf_Dispatcher::setDefaultController - Yaf_Dispatcher::getDefaultAction - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml b/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml deleted file mode 100644 index be37d22900..0000000000 --- a/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Dispatcher::setDefaultController - Modifie le nom par défaut du contrôleur - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::setDefaultController - stringcontroller - - - Modifie le nom du contrôleur utilisé lorsqu'un nom de contrôleur ne peut - pas être extrait de l'URI de la requête. Le nom est normalisé de manière - à ce que la première lettre soit une majuscule. - - - - - &reftitle.parameters; - - - controller - - - Le nom du contrôleur. - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même en cas de - succès, ou &false; si l'application n'est pas initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::setDefaultController</methodname> - -setDefaultController("home"); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultModule - Yaf_Dispatcher::setDefaultAction - Yaf_Dispatcher::getDefaultController - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setdefaultmodule.xml b/reference/yaf/yaf_dispatcher/setdefaultmodule.xml deleted file mode 100644 index cc8a040e3d..0000000000 --- a/reference/yaf/yaf_dispatcher/setdefaultmodule.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Yaf_Dispatcher::setDefaultModule - Change le nom du module par défaut - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::setDefaultModule - stringmodule - - - Change le nom du module utilisé lorsqu'aucun nom de module ne peut être - extrait de l'URI de la requête. Le module doit être un module enregistré, - voir Yaf_Application::getModules. - - - - - &reftitle.parameters; - - - module - - - Le nom d'un module enregistré. - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même en cas de - succès, &false; si le module fourni n'est pas enregistré (et une erreur - YAF_ERR_TYPE_ERROR est déclenchée) ou si - l'application n'est pas initialisée, et &null; sinon. - - - - - &reftitle.errors; - - Déclenche une erreur YAF_ERR_TYPE_ERROR si - module n'est pas le nom d'un module enregistré. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::setDefaultModule</methodname> - -setDefaultModule("Home"); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultController - Yaf_Dispatcher::setDefaultAction - Yaf_Dispatcher::getDefaultModule - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/seterrorhandler.xml b/reference/yaf/yaf_dispatcher/seterrorhandler.xml deleted file mode 100644 index 5132218339..0000000000 --- a/reference/yaf/yaf_dispatcher/seterrorhandler.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Yaf_Dispatcher::setErrorHandler - Définit un gestionnaire d'erreur - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::setErrorHandler - mixedcallback - interror_types0 - - - Définit un gestionnaire d'erreur pour Yaf. Lorsque - application.dispatcher.throwException - est désactivé, Yaf déclenche des erreurs capturables lorsque des erreurs - inattendues surviennent. - - - Cette méthode est une enveloppe de set_error_handler ; - le gestionnaire est appelé chaque fois qu'une telle erreur est levée. - - - - - &reftitle.parameters; - - - callback - - - Une fonction de rappel callable, avec la même sémantique que la fonction - de rappel passée à set_error_handler. - - - - error_types - - - Les types d'erreurs à gérer, identiques au paramètre - error_levels de - set_error_handler. Par défaut, tous les types d'erreurs sont gérés. - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même en cas de - succès, &false; si l'appel à set_error_handler a échoué, - ou &null; si l'application n'est pas initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::setErrorHandler</methodname> - -setErrorHandler(function ($errno, $errstr) { - // Route les erreurs vers ErrorController::errorAction - $request = Yaf_Dispatcher::getInstance()->getRequest(); - $request->setControllerName("Error"); - $request->setActionName("error"); -}); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::throwException - Yaf_Application::getLastErrorNo - Yaf_Application::getLastErrorMsg - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setrequest.xml b/reference/yaf/yaf_dispatcher/setrequest.xml deleted file mode 100644 index 7e5ca64303..0000000000 --- a/reference/yaf/yaf_dispatcher/setrequest.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Yaf_Dispatcher::setRequest - Définit l'objet de requête - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::setRequest - Yaf_Request_Abstractrequest - - - Définit l'objet de requête utilisé par le distributeur. Cela permet - d'utiliser une implémentation personnalisée de la requête au lieu des - classes natives Yaf_Request_Http ou - Yaf_Request_Simple. - - - - - &reftitle.parameters; - - - request - - - Une instance de Yaf_Request_Abstract. - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même en cas - de succès, ou &null; si l'application n'est pas initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::setRequest</methodname> - -setRequest($request); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::getRequest - Yaf_Request_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setresponse.xml b/reference/yaf/yaf_dispatcher/setresponse.xml deleted file mode 100644 index 0481b9bab4..0000000000 --- a/reference/yaf/yaf_dispatcher/setresponse.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Dispatcher::setResponse - Définit l'objet de réponse - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::setResponse - Yaf_Response_Abstractresponse - - - Définit l'objet de réponse utilisé par le distributeur. Cela permet - d'utiliser une implémentation de réponse personnalisée à la place de - celles fournies nativement. - - - - - &reftitle.parameters; - - - response - - - Une instance de Yaf_Response_Abstract. - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même en cas de - succès, ou &null; si l'application n'est pas initialisée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Dispatcher::setResponse</methodname> - -setResponse(new ApiResponse()); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::getResponse - Yaf_Dispatcher::setRequest - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setview.xml b/reference/yaf/yaf_dispatcher/setview.xml deleted file mode 100644 index 3a454336bf..0000000000 --- a/reference/yaf/yaf_dispatcher/setview.xml +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - Yaf_Dispatcher::setView - Définit un moteur de vue personnalisé - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::setView - Yaf_View_Interfaceview - - - Cette méthode fournit une solution pour utiliser un moteur de vue - personnalisé au lieu de Yaf_View_Simple - - - - - - &reftitle.parameters; - - - view - - - Une instance de Yaf_View_Interface - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même en cas de - succès, ou &null; si l'application n'est pas initialisée. - - - - - &reftitle.examples; - - Exemple de moteur de vue personnalisé - -_smarty = new Smarty; - - if (null !== $tmplPath) { - $this->setScriptPath($tmplPath); - } - - foreach ($extraParams as $key => $value) { - $this->_smarty->$key = $value; - } - } - - /** - * Définit le chemin vers les templates - * - * @param string $path Le dossier à définir comme chemin. - * @return void - */ - public function setScriptPath($path) - { - if (is_readable($path)) { - $this->_smarty->template_dir = $path; - return; - } - - throw new Exception('Chemin fourni invalide'); - } - - /** - * Assigne une variable au template - * - * @param string $key Le nom de la variable. - * @param mixed $val La valeur de la variable. - * @return void - */ - public function __set($key, $val) - { - $this->_smarty->assign($key, $val); - } - - /** - * Permet le fonctionnement des tests avec empty() et isset() - * - * @param string $key - * @return boolean - */ - public function __isset($key) - { - return (null !== $this->_smarty->get_template_vars($key)); - } - - /** - * Permet le fonctionnement de unset() sur les propriétés de l'objet - * - * @param string $key - * @return void - */ - public function __unset($key) - { - $this->_smarty->clear_assign($key); - } - - /** - * Assigne des variables au template - * - * Permet de définir une clé spécifique à la valeur indiquée, OU de - * passer un tableau de paires clé => valeur pour une définition en masse. - * - * @see __set() - * @param string|array $spec La stratégie d'assignation à utiliser (clé ou - * tableau de paires clé => valeur) - * @param mixed $value (Optionnel) Lors de l'assignation d'une variable - * nommée, utilise ceci comme valeur. - * @return void - */ - public function assign($spec, $value = null) { - if (is_array($spec)) { - $this->_smarty->assign($spec); - return; - } - - $this->_smarty->assign($spec, $value); - } - - /** - * Efface toutes les variables assignées - * - * Efface toutes les variables assignées à Yaf_View, que ce soit via - * {@link assign()} ou par surcharge de propriété - * ({@link __get()}/{@link __set()}). - * - * @return void - */ - public function clearVars() { - $this->_smarty->clear_all_assign(); - } - - /** - * Traite un template et retourne les données de sortie. - * - * @param string $name Le template à traiter. - * @return string Les données de sortie. - */ - public function render($name, $value = NULL) { - return $this->_smarty->fetch($name); - } - - public function display($name, $value = NULL) { - echo $this->_smarty->fetch($name); - } - -} -?> -]]> - - - - Exemple avec <function>Yaf_Dispatcher::setView</function> - -getConfig(); - Yaf_Registry::set("config", $config); - } - - public function _initLocalName() { - /** la classe Smarty_Adapter est placée dans le dossier local des bibliothèques */ - Yaf_Loader::getInstance()->registerLocalNamespace('Smarty'); - } - - public function _initSmarty(Yaf_Dispatcher $dispatcher) { - $smarty = new Smarty_Adapter(null, Yaf_Registry::get("config")->get("smarty")); - $dispatcher->setView($smarty); - /* désormais, le moteur de vue Smarty devient le moteur de vue par défaut de Yaf */ - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_View_Interface - Yaf_View_Simple - - - - - - diff --git a/reference/yaf/yaf_dispatcher/throwexception.xml b/reference/yaf/yaf_dispatcher/throwexception.xml deleted file mode 100644 index a2ef7253f4..0000000000 --- a/reference/yaf/yaf_dispatcher/throwexception.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - Yaf_Dispatcher::throwException - Active/désactive le lancement d'exceptions - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::throwException - boolnullflagnull - - - Active/désactive le lancement d'exceptions lorsqu'une erreur inattendue - survient. Lorsque cette option est activée, Yaf lance des exceptions au - lieu de déclencher des erreurs attrapables. - - - Il est également possible d'utiliser - application.dispatcher.throwException - pour arriver au même résultat. - - - - - &reftitle.parameters; - - - flag - - - Indique si Yaf devrait lancer des exceptions en cas d'erreur. - - - - À partir de Yaf 2.2.0, si ce paramètre n'est pas fourni, c'est l'état - courant qui est retourné à la place. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet Yaf_Dispatcher lui-même lorsque - flag est fourni, ou un &boolean; indiquant si le - lancement d'exceptions est activé lorsqu'il ne l'est pas. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Dispatcher::throwException</function> - - array( - 'directory' => dirname(__FILE__), - ), -); -$app = new Yaf_Application($config); - -$app->getDispatcher()->throwException(true); - -try { - $app->run(); -} catch (Yaf_Exception $e) { - var_dump($e->getMessage()); -} -?> -]]> - - &example.outputs.similar; - - - - - - Exemple avec <function>Yaf_Dispatcher::throwException</function> - - array( - 'directory' => dirname(__FILE__), - ), -); -$app = new Yaf_Application($config); - -$app->getDispatcher()->throwException(false); - -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::catchException - Yaf_Exception - - - - - - - diff --git a/reference/yaf/yaf_exception/construct.xml b/reference/yaf/yaf_exception/construct.xml deleted file mode 100644 index 27d28026db..0000000000 --- a/reference/yaf/yaf_exception/construct.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -Yaf_Exception::__construct -Construit une exception Yaf - - - - &reftitle.description; - - public Yaf_Exception::__construct - stringmessage"" - intcode0 - - Construit une nouvelle Yaf_Exception. Le paramètre code porte le code d'erreur Yaf qui identifie le type d'échec, et est exposé via Exception::getCode. - - - - &reftitle.parameters; - - - message - -Le message de l'exception. - - - - code - -Le code d'erreur Yaf. - - - - - - - &reftitle.returnvalues; - Aucune valeur n'est retournée. - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Exception::__construct</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Yaf_Exception - Yaf_Exception::getPrevious - Yaf_Exception_RouterFailed - - - - - - diff --git a/reference/yaf/yaf_exception/getprevious.xml b/reference/yaf/yaf_exception/getprevious.xml deleted file mode 100644 index 5b19bc1c28..0000000000 --- a/reference/yaf/yaf_exception/getprevious.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Exception::getPrevious -Récupère l'exception précédente - - - - &reftitle.description; - - public ThrowableYaf_Exception::getPrevious - - - Cette méthode est héritée de la hiérarchie de base Throwable et retourne l'exception qui a été chaînée comme étant la précédente, s'il y en a une. - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - Retourne le Throwable précédent s'il est disponible, &null; sinon. - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Exception::getPrevious</methodname> - -getCode()); - $prev = $e->getPrevious(); - var_dump(get_class($prev)); - var_dump($prev->getMessage()); - var_dump($prev->getCode()); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Yaf_Exception::__construct - Yaf_Exception - - - - - - diff --git a/reference/yaf/yaf_loader/autoload.xml b/reference/yaf/yaf_loader/autoload.xml deleted file mode 100644 index 417111345f..0000000000 --- a/reference/yaf/yaf_loader/autoload.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Loader::autoload -Charge automatiquement une classe - - - - &reftitle.description; - - public boolYaf_Loader::autoload - stringclass_name - - Charge une classe à partir de son nom. Le nom de la classe est converti en un chemin de fichier : les tirets bas et les séparateurs de namespace deviennent des séparateurs de répertoires. - Les classes MVC (les classes dont le nom contient _Controller, _Action ou _Plugin) sont recherchées dans le répertoire de l'application, tandis que les autres classes sont recherchées dans les répertoires de bibliothèques : la bibliothèque locale pour les préfixes de classes enregistrés localement, sinon la bibliothèque globale. - - - - &reftitle.parameters; - - - class_name - -Le nom de la classe à charger. - - - - - - &reftitle.returnvalues; -Retourne &true; en cas de succès, ou &false; si une erreur survient. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Loader::autoload</methodname> - -autoload("Catalog_PriceService"); - -/* les classes MVC sont recherchées dans le répertoire de l'application */ -$loader->autoload("ProductController"); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Loader::import - Yaf_Loader::registerLocalNamespace - - - - - diff --git a/reference/yaf/yaf_loader/clearlocalnamespace.xml b/reference/yaf/yaf_loader/clearlocalnamespace.xml deleted file mode 100644 index 33c20bc691..0000000000 --- a/reference/yaf/yaf_loader/clearlocalnamespace.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - -Yaf_Loader::clearLocalNamespace -Efface les namespaces enregistrés - - - - &reftitle.description; - - public boolYaf_Loader::clearLocalNamespace - - - Efface tous les namespaces locaux enregistrés. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; en cas de succès. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Loader::clearLocalNamespace</methodname> - -registerLocalNamespace(array("Models", "Services")); -var_dump(count($loader->getLocalNamespace())); - -$loader->clearLocalNamespace(); -var_dump(count($loader->getLocalNamespace())); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::registerLocalNamespace - Yaf_Loader::getLocalNamespace - - - - - diff --git a/reference/yaf/yaf_loader/construct.xml b/reference/yaf/yaf_loader/construct.xml deleted file mode 100644 index f6e4c0c4ce..0000000000 --- a/reference/yaf/yaf_loader/construct.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Yaf_Loader::__construct -Le constructeur est privé - - - - &reftitle.description; - - private Yaf_Loader::__construct - - - Construit un nouveau chargeur. Le constructeur est privé ; Yaf_Loader est un singleton. Il faut utiliser Yaf_Loader::getInstance pour obtenir l'instance. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Obtention du singleton <classname>Yaf_Loader</classname> - -getMessage(), PHP_EOL; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::getInstance - - - - - diff --git a/reference/yaf/yaf_loader/getinstance.xml b/reference/yaf/yaf_loader/getinstance.xml deleted file mode 100644 index e1fb681c46..0000000000 --- a/reference/yaf/yaf_loader/getinstance.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - -Yaf_Loader::getInstance -Récupère l'instance de Yaf_Loader - - - - &reftitle.description; - - public static Yaf_LoaderfalseYaf_Loader::getInstance - stringlocal_library_pathnull - stringglobal_library_pathnull - - Récupère l'instance unique (singleton) de Yaf_Loader. - Si les chemins des bibliothèques sont fournis, ils sont appliqués à l'instance existante. - - - - &reftitle.parameters; - - - local_library_path - -Le répertoire de la bibliothèque locale, généralement identique à la directive de configuration application.library.directory. - - - - global_library_path - -Le répertoire de la bibliothèque globale. S'il n'est pas fourni, le répertoire local est utilisé. - - - - - - &reftitle.returnvalues; -L'instance de Yaf_Loader, ou &false; si le chargeur n'a pas été initialisé (ce qui est normalement fait par Yaf_Application). - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Loader::getInstance</methodname> - -registerNamespace("Vendor", APPLICATION_PATH . "/library/Vendor"); -?> -]]> - - - - <methodname>Yaf_Loader::getInstance</methodname> avant l'initialisation - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::setLibraryPath - Yaf_Loader::getLibraryPath - - - - - diff --git a/reference/yaf/yaf_loader/getlibrarypath.xml b/reference/yaf/yaf_loader/getlibrarypath.xml deleted file mode 100644 index 19dc6b75f2..0000000000 --- a/reference/yaf/yaf_loader/getlibrarypath.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Loader::getLibraryPath -Récupère le chemin de la bibliothèque - - - - &reftitle.description; - - public stringYaf_Loader::getLibraryPath - boolis_globalfalse - - Récupère le dossier de la bibliothèque. - - - - &reftitle.parameters; - - - is_global - -Indique s'il faut récupérer le dossier global de la bibliothèque au lieu du dossier local. - - - - - - &reftitle.returnvalues; -Le dossier de la bibliothèque sous la forme d'une chaîne de caractères, ou une chaîne vide lorsque le dossier global de la bibliothèque est demandé mais n'est pas défini. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Loader::getLibraryPath</methodname> - -getLibraryPath(), PHP_EOL; - -/* le dossier global de la bibliothèque */ -echo $loader->getLibraryPath(true), PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::setLibraryPath - - - - - diff --git a/reference/yaf/yaf_loader/getlocalnamespace.xml b/reference/yaf/yaf_loader/getlocalnamespace.xml deleted file mode 100644 index 6a1841dd39..0000000000 --- a/reference/yaf/yaf_loader/getlocalnamespace.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Loader::getLocalNamespace -Récupère les namespaces enregistrés - - - - &reftitle.description; - - public arrayYaf_Loader::getLocalNamespace - - - Récupère tous les namespaces locaux enregistrés ainsi que leurs chemins. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Un tableau des namespaces locaux enregistrés, indexé par le préfixe de namespace, ou un tableau vide si aucun n'est enregistré. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Loader::getLocalNamespace</methodname> - -registerLocalNamespace("Models"); -$loader->registerLocalNamespace("Vendor", APPLICATION_PATH . "/library/Vendor"); - -print_r($loader->getLocalNamespace()); -?> -]]> - - &example.outputs.similar; - - /var/www/shop/application/library - [Vendor] => /var/www/shop/application/library/Vendor -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Loader::registerLocalNamespace - Yaf_Loader::clearLocalNamespace - - - - - diff --git a/reference/yaf/yaf_loader/getnamespacepath.xml b/reference/yaf/yaf_loader/getnamespacepath.xml deleted file mode 100644 index 6e902952d5..0000000000 --- a/reference/yaf/yaf_loader/getnamespacepath.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Loader::getNamespacePath -Récupère le chemin de la bibliothèque d'une classe - - - - &reftitle.description; - - public stringYaf_Loader::getNamespacePath - stringclass_name - - Récupère le dossier de bibliothèque dans lequel une classe serait recherchée. - - - - &reftitle.parameters; - - - class_name - -Le nom de la classe dont le dossier de bibliothèque est demandé. - - - - - - &reftitle.returnvalues; -Le dossier local de la bibliothèque si la classe appartient à un namespace local enregistré, sinon le dossier global de la bibliothèque (avec un repli sur le dossier local lorsque le dossier global n'est pas défini). - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Loader::getNamespacePath</methodname> - -registerLocalNamespace("Models"); -$loader->setLibraryPath("/usr/local/share/yaf/library", true); - -/* "Models" est un namespace local enregistré */ -echo $loader->getNamespacePath("Models_Product"), PHP_EOL; - -/* les autres classes se replient sur le dossier global de la bibliothèque */ -echo $loader->getNamespacePath("Vendor_Payment"), PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::isLocalName - Yaf_Loader::getLibraryPath - - - - - diff --git a/reference/yaf/yaf_loader/getnamespaces.xml b/reference/yaf/yaf_loader/getnamespaces.xml deleted file mode 100644 index 140c1b9d4f..0000000000 --- a/reference/yaf/yaf_loader/getnamespaces.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - -Yaf_Loader::getNamespaces -Alias de getLocalNamespace - - - - &reftitle.description; - - public arrayYaf_Loader::getNamespaces - - - Alias de Yaf_Loader::getLocalNamespace. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - Un tableau des namespaces locaux enregistrés, indexé par le préfixe de namespace, ou un tableau vide si aucun n'est enregistré. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Loader::getNamespaces</methodname> - -registerLocalNamespace(array("Models", "Services")); - -/* getNamespaces() est un alias de getLocalNamespace() */ -var_dump($loader->getNamespaces() === $loader->getLocalNamespace()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::getLocalNamespace - - - - - diff --git a/reference/yaf/yaf_loader/import.xml b/reference/yaf/yaf_loader/import.xml deleted file mode 100644 index b9ea81751c..0000000000 --- a/reference/yaf/yaf_loader/import.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - -Yaf_Loader::import -Charge un script PHP - - - - &reftitle.description; - - public static boolYaf_Loader::import - stringfile - - Charge un fichier de script PHP une seule fois. Si le fichier n'est pas un chemin absolu, il est recherché dans le dossier local de la bibliothèque. - Un fichier n'est inclus qu'une seule fois ; un nouvel appel à Yaf_Loader::import avec le même fichier retourne &true; sans l'inclure de nouveau. - - - - &reftitle.parameters; - - - file - -Le fichier à charger. - - - - - - &reftitle.returnvalues; -Retourne &true; en cas de succès (y compris lorsque le fichier était déjà chargé), ou &false; en cas d'échec. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Loader::import</methodname> - - -]]> - - - - Un fichier n'est importé qu'une seule fois - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::autoload - - - - - diff --git a/reference/yaf/yaf_loader/islocalname.xml b/reference/yaf/yaf_loader/islocalname.xml deleted file mode 100644 index 0891cb3715..0000000000 --- a/reference/yaf/yaf_loader/islocalname.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Loader::isLocalName -Détermine si une classe est locale - - - - &reftitle.description; - - public boolYaf_Loader::isLocalName - stringclass_name - - Détermine si un nom de classe doit être recherché dans le répertoire de la bibliothèque locale, c'est-à-dire si son préfixe appartient à un namespace local enregistré. - - - - &reftitle.parameters; - - - class_name - -Le nom de la classe à vérifier. - - - - - - &reftitle.returnvalues; -Retourne &true; si le nom de la classe appartient à un namespace local enregistré, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Loader::isLocalName</methodname> - -registerLocalNamespace(array("Models", "Services")); - -var_dump($loader->isLocalName("Models_Product")); -var_dump($loader->isLocalName("Vendor_Session")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::registerLocalNamespace - Yaf_Loader::getNamespacePath - - - - - diff --git a/reference/yaf/yaf_loader/registerlocalnamespace.xml b/reference/yaf/yaf_loader/registerlocalnamespace.xml deleted file mode 100644 index 7b36a5becd..0000000000 --- a/reference/yaf/yaf_loader/registerlocalnamespace.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Loader::registerLocalNamespace -Enregistre un namespace local - - - - &reftitle.description; - - public Yaf_LoaderfalseYaf_Loader::registerLocalNamespace - stringarraynamespace - stringpath&null; - - Enregistre un namespace local. Les classes dont le préfixe appartient à un namespace local sont recherchées dans le chemin fourni (ou dans le répertoire de la bibliothèque locale si aucun chemin n'est fourni) au lieu du répertoire global. - Cela permet de placer ses propres classes dans le répertoire de la bibliothèque locale, tandis que les classes partagées résident dans le répertoire de la bibliothèque globale (voir la directive ini yaf.library). - - - - &reftitle.parameters; - - - namespace - -Une chaîne de préfixe de namespace, ou un tableau de paires préfixe/chemin (lorsque la valeur est une chaîne de chemin) ou de chaînes de préfixes. -Un préfixe ne correspond qu'à une frontière marquée par un tiret bas ou un antislash : enregistrer Models rend Models_User et Models lui-même locaux, mais pas ModelsUser. Un antislash initial est ignoré, et un nom de classe écrit avec des antislashs est recherché comme s'il s'agissait de tirets bas. - - - - path - -Le répertoire dans lequel rechercher le namespace. S'il n'est pas fourni, le répertoire de la bibliothèque locale est utilisé. - - - - - - &reftitle.returnvalues; -Retourne l'instance du chargeur elle-même en cas de succès, ou &false; si un paramètre invalide est fourni. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Loader::registerLocalNamespace</methodname> - -registerLocalNamespace("Models"); - - /* enregistre plusieurs préfixes à la fois, chacun avec - * son propre répertoire de recherche */ - $loader->registerLocalNamespace(array( - "Services" => APPLICATION_PATH . "/services", - "Vendor" => APPLICATION_PATH . "/vendor", - )); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Loader::getLocalNamespace - Yaf_Loader::clearLocalNamespace - Yaf_Loader::isLocalName - - - - - diff --git a/reference/yaf/yaf_loader/registernamespace.xml b/reference/yaf/yaf_loader/registernamespace.xml deleted file mode 100644 index 48bcca537a..0000000000 --- a/reference/yaf/yaf_loader/registernamespace.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_Loader::registerNamespace -Alias de registerLocalNamespace - - - - &reftitle.description; - - public Yaf_LoaderfalseYaf_Loader::registerNamespace - stringarraynamespace - stringpath&null; - - Alias de Yaf_Loader::registerLocalNamespace. - - - - &reftitle.parameters; - - - namespace - -Une chaîne de préfixe de namespace, ou un tableau de paires préfixe/chemin (lorsque la valeur est une chaîne de chemin) ou de chaînes de préfixes. - - - - path - -Le répertoire dans lequel rechercher le namespace. S'il n'est pas fourni, le répertoire de la bibliothèque locale est utilisé. - - - - - - &reftitle.returnvalues; -Retourne l'instance du chargeur elle-même en cas de succès, ou &false; si un paramètre invalide est fourni. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Loader::registerNamespace</methodname> - -registerNamespace( - "Vendor", - APPLICATION_PATH . "/library/Vendor" - ); - } -} - -/* new Vendor_Payment_Gateway() est désormais recherchée dans - * APPLICATION_PATH/library/Vendor/Payment/Gateway.php */ -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Loader::registerLocalNamespace - - - - - diff --git a/reference/yaf/yaf_loader/setlibrarypath.xml b/reference/yaf/yaf_loader/setlibrarypath.xml deleted file mode 100644 index ecc1b8a291..0000000000 --- a/reference/yaf/yaf_loader/setlibrarypath.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - -Yaf_Loader::setLibraryPath -Change le chemin de la bibliothèque - - - - &reftitle.description; - - public Yaf_LoaderYaf_Loader::setLibraryPath - stringlibrary_path - boolis_globalfalse - - Change le répertoire de la bibliothèque. - - - - &reftitle.parameters; - - - library_path - -Le nouveau répertoire de la bibliothèque. - - - - is_global - -Indique s'il faut changer le répertoire de la bibliothèque globale au lieu de celui de la bibliothèque locale. - - - - - - &reftitle.returnvalues; -Retourne l'instance du chargeur elle-même. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Loader::setLibraryPath</methodname> - -setLibraryPath("/var/www/shop/application/library"); - -/* change le répertoire de la bibliothèque globale */ -$loader->setLibraryPath("/usr/local/share/yaf/library", true); - -echo $loader->getLibraryPath(), PHP_EOL; -echo $loader->getLibraryPath(true), PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::getLibraryPath - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/dispatchloopshutdown.xml b/reference/yaf/yaf_plugin_abstract/dispatchloopshutdown.xml deleted file mode 100644 index 1400102b01..0000000000 --- a/reference/yaf/yaf_plugin_abstract/dispatchloopshutdown.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::dispatchLoopShutdown -Hook après la boucle de distribution - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - Ce hook est déclenché une seule fois, après que la boucle de distribution est terminée et que toutes les actions ont été exécutées, mais avant que la réponse ne soit envoyée au client. Il est habituellement utilisé pour la journalisation ou le nettoyage. - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract en cours de distribution. - - - - response - -L'instance de Yaf_Response_Abstract. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Plugin_Abstract::dispatchLoopShutdown</methodname> - -getRequestUri(), - $request->getControllerName(), - $request->getActionName() - )); - } -} - -/* les plugins sont enregistrés dans le bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new AccessLogPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::preResponse - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/dispatchloopstartup.xml b/reference/yaf/yaf_plugin_abstract/dispatchloopstartup.xml deleted file mode 100644 index 13085ff76b..0000000000 --- a/reference/yaf/yaf_plugin_abstract/dispatchloopstartup.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::dispatchLoopStartup -Hook avant la boucle de distribution - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - Ce hook est déclenché une seule fois, juste avant que la boucle de distribution ne démarre et que le moteur de vue ne soit initialisé. - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract en cours de distribution. - - - - response - -L'instance de Yaf_Response_Abstract. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Plugin_Abstract::dispatchLoopStartup</methodname> - -registerPlugin(new BenchmarkPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/postdispatch.xml b/reference/yaf/yaf_plugin_abstract/postdispatch.xml deleted file mode 100644 index ab38170bca..0000000000 --- a/reference/yaf/yaf_plugin_abstract/postdispatch.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::postDispatch -Hook après chaque distribution - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::postDispatch - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - Ce hook est déclenché après la fin de chaque itération de distribution, c'est-à-dire après l'exécution de l'action. Comme Yaf_Plugin_Abstract::preDispatch, il peut être appelé plusieurs fois par requête. - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract en cours de distribution. - - - - response - -L'instance de Yaf_Response_Abstract. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Plugin_Abstract::postDispatch</methodname> - -appendBody(sprintf( - "\n", - $elapsed - )); - } -} - -/* les plugins sont enregistrés dans le bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new BenchmarkPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/predispatch.xml b/reference/yaf/yaf_plugin_abstract/predispatch.xml deleted file mode 100644 index b65f3997e2..0000000000 --- a/reference/yaf/yaf_plugin_abstract/predispatch.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::preDispatch -Hook avant chaque distribution - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::preDispatch - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - Ce hook est déclenché avant chaque itération de distribution dans la boucle de distribution. Une boucle de distribution peut effectuer plusieurs itérations, ce hook peut donc être appelé plusieurs fois par requête. - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract en cours de distribution. - - - - response - -L'instance de Yaf_Response_Abstract. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Plugin_Abstract::preDispatch</methodname> - -getView(); - if ($request->getModuleName() == "Admin") { - $view->setScriptPath(APPLICATION_PATH . "/modules/admin/views"); - } - } -} - -/* les plugins sont enregistrés dans le bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new LayoutPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/preresponse.xml b/reference/yaf/yaf_plugin_abstract/preresponse.xml deleted file mode 100644 index e6ff0f0b3a..0000000000 --- a/reference/yaf/yaf_plugin_abstract/preresponse.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::preResponse -Point d'accroche avant l'envoi de la réponse - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::preResponse - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - Ce point d'accroche est prévu pour être déclenché avant que la réponse ne soit envoyée au client. - - Dans cette version, ce point d'accroche n'est jamais appelé : il est déclaré sur Yaf_Plugin_Abstract mais n'est pas relié au flux de distribution. Le redéfinir n'a aucun effet. - - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract en cours de distribution. - - - - response - -L'instance de Yaf_Response_Abstract. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Plugin_Abstract::preResponse</methodname> - -setBody( - preg_replace("/>\s+<", $response->getBody()) - ); - } -} - -/* les plugins sont enregistrés dans le bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new MinifyPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/routershutdown.xml b/reference/yaf/yaf_plugin_abstract/routershutdown.xml deleted file mode 100644 index 258018a28f..0000000000 --- a/reference/yaf/yaf_plugin_abstract/routershutdown.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::routerShutdown -Point d'accroche après le routage - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::routerShutdown - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - Ce point d'accroche est déclenché une fois le processus de routage terminé et les noms du contrôleur et de l'action résolus, mais avant le démarrage de la boucle de distribution. Il est habituellement utilisé pour des contrôles d'accès tels qu'une vérification de connexion, car le contrôleur et l'action cibles sont déjà connus. - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract en cours de distribution. - - - - response - -L'instance de Yaf_Response_Abstract. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Plugin_Abstract::routerShutdown</methodname> - - array("index"), "User" => array("login")); - - $controller = $request->getControllerName(); - $action = $request->getActionName(); - - if (isset($public[$controller]) && in_array($action, $public[$controller])) { - return; - } - - if (!Yaf_Session::getInstance()->has("login")) { - $response->setRedirect("/user/login"); - $request->setDispatched(true); // ne pas distribuer la requête - } - } -} - -/* les plugins sont enregistrés dans le bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new AuthPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/routerstartup.xml b/reference/yaf/yaf_plugin_abstract/routerstartup.xml deleted file mode 100644 index ce1d25593d..0000000000 --- a/reference/yaf/yaf_plugin_abstract/routerstartup.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::routerStartup -Point d'accroche avant le routage - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::routerStartup - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - Ce point d'accroche est déclenché juste avant que la requête ne soit routée. Il s'agit du point d'accroche le plus précoce du flux de distribution, il est donc habituellement utilisé pour la réécriture d'URL ou pour les décisions de routage qui doivent intervenir avant l'exécution de Yaf_Router::route. - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract en cours de distribution. - - - - response - -L'instance de Yaf_Response_Abstract. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Plugin_Abstract::routerStartup</methodname> - -getRequestUri(); - if (preg_match("#^/[a-z]+$#", $uri)) { - $request->setRequestUri("/page" . $uri); - } - } -} - -/* les plugins sont enregistrés dans le bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new RewritePlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - diff --git a/reference/yaf/yaf_registry/construct.xml b/reference/yaf/yaf_registry/construct.xml deleted file mode 100644 index a1d309f0dc..0000000000 --- a/reference/yaf/yaf_registry/construct.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -Yaf_Registry::__construct -Constructeur de Yaf_Registry - - - - &reftitle.description; - - privateYaf_Registry::__construct - - - Le constructeur est privé : Yaf_Registry implémente le patron singleton et ne peut pas être instanciée directement. Il faut utiliser les méthodes statiques pour lire et écrire les entrées du registre. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Registry::__construct</methodname> - - Le constructeur est privé, l'instanciation directe est donc rejetée : - - - -]]> - - &example.outputs.similar; - - - - - - Utilisation de <classname>Yaf_Registry</classname> via ses méthodes statiques - -getConfig()->application->version); -var_dump(Yaf_Registry::get("version")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Registry::set - Yaf_Registry::get - Yaf_Registry::has - - - - - diff --git a/reference/yaf/yaf_registry/del.xml b/reference/yaf/yaf_registry/del.xml deleted file mode 100644 index d074e6b31b..0000000000 --- a/reference/yaf/yaf_registry/del.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Registry::del -Supprime un élément du registre - - - - &reftitle.description; - - public static boolYaf_Registry::del - stringname - - Supprime une entrée du registre. La suppression d'un nom qui n'existe pas est acceptée silencieusement. - - - - &reftitle.parameters; - - - name - -Le nom de l'entrée du registre. - - - - - - &reftitle.returnvalues; -Retourne toujours &true;. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Registry::del</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Registry::get - Yaf_Registry::set - Yaf_Registry::has - - - - - diff --git a/reference/yaf/yaf_registry/get.xml b/reference/yaf/yaf_registry/get.xml deleted file mode 100644 index 357e524f3e..0000000000 --- a/reference/yaf/yaf_registry/get.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - -Yaf_Registry::get -Récupère un élément depuis le registre - - - - &reftitle.description; - - public static mixedYaf_Registry::get - stringname - - Récupère une valeur depuis le registre. - - - - &reftitle.parameters; - - - name - -Le nom de l'entrée du registre. - - - - - - &reftitle.returnvalues; -La valeur stockée sous name, ou &null; s'il n'existe aucune entrée portant ce nom. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Registry::get</methodname> - -getView()->assign("visits", $redis->get("site:visits")); - - return true; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Registry::set - Yaf_Registry::has - Yaf_Registry::del - - - - - diff --git a/reference/yaf/yaf_registry/has.xml b/reference/yaf/yaf_registry/has.xml deleted file mode 100644 index 2919e2c7d5..0000000000 --- a/reference/yaf/yaf_registry/has.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Registry::has -Vérifie si une entrée existe - - - - &reftitle.description; - - public static boolYaf_Registry::has - stringname - - Vérifie si une valeur existe dans le registre. - - - - &reftitle.parameters; - - - name - -Le nom de l'entrée du registre. - - - - - - &reftitle.returnvalues; -Retourne &true; si une entrée portant le nom donné existe, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Registry::has</methodname> - -getConfig()->redis; - - $redis = new Redis(); - $redis->connect($config->host, $config->port); - - Yaf_Registry::set("redis", $redis); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Registry::get - Yaf_Registry::set - Yaf_Registry::del - - - - - diff --git a/reference/yaf/yaf_registry/set.xml b/reference/yaf/yaf_registry/set.xml deleted file mode 100644 index d55108e098..0000000000 --- a/reference/yaf/yaf_registry/set.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_Registry::set -Ajoute une entrée dans le registre - - - - &reftitle.description; - - public static boolYaf_Registry::set - stringname - mixedvalue - - Stocke une valeur dans le registre. Définir un nom déjà existant écrase sa valeur précédente. - - - - &reftitle.parameters; - - - name - -Le nom de l'entrée du registre. - - - - value - -La valeur à stocker ; elle peut être de n'importe quel type, y compris un objet. - - - - - - &reftitle.returnvalues; -Retourne &true; en cas de succès, ou &false; si une erreur survient. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Registry::set</methodname> - -getConfig()->redis; - - $redis = new Redis(); - $redis->connect($config->host, $config->port); - - /* la connexion est désormais disponible pour toute l'application */ - Yaf_Registry::set("redis", $redis); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Registry::get - Yaf_Registry::has - Yaf_Registry::del - - - - - diff --git a/reference/yaf/yaf_request_abstract/clearparams.xml b/reference/yaf/yaf_request_abstract/clearparams.xml deleted file mode 100644 index 5a076d8fec..0000000000 --- a/reference/yaf/yaf_request_abstract/clearparams.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::clearParams -Supprime tous les paramètres - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Request_Abstract::clearParams - - - Supprime tous les paramètres définis par le routeur, ou par Yaf_Request_Abstract::setParam. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne l'objet requête lui-même. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::clearParams</methodname> - -getRequest(); - - $request->setParam("referrer", "newsletter"); - var_dump($request->getParam("referrer")); - - $request->clearParams(); - var_dump($request->getParam("referrer")); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setParam - Yaf_Request_Abstract::getParam - Yaf_Request_Abstract::getParams - - - - - diff --git a/reference/yaf/yaf_request_abstract/get.xml b/reference/yaf/yaf_request_abstract/get.xml deleted file mode 100644 index e54552ada4..0000000000 --- a/reference/yaf/yaf_request_abstract/get.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - -Yaf_Request_Abstract::get -Récupère une variable depuis la requête - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::get - stringname - mixeddefault - - Récupère une variable depuis la requête. L'ordre de recherche est le suivant : les paramètres de requête définis par Yaf_Request_Abstract::setParam, puis POST, GET, COOKIE, SERVER. - - - - &reftitle.parameters; - - - name - -Le nom de la variable. - - - - default - -La valeur à retourner si la variable n'est pas trouvée. - - - - - - &reftitle.returnvalues; -La valeur si elle est trouvée, ou default s'il a été fourni, &null; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::get</methodname> - -getRequest(); - - // En supposant que la requête soit /search?keyword=yaf&page=2 - $keyword = $request->get("keyword"); - $page = (int) $request->get("page", 1); - $sort = $request->get("sort", "relevance"); - - var_dump($keyword, $page, $sort); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getactionname.xml b/reference/yaf/yaf_request_abstract/getactionname.xml deleted file mode 100644 index 1c8233eb61..0000000000 --- a/reference/yaf/yaf_request_abstract/getactionname.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Request_Abstract::getActionName -Récupère le nom de l'action - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getActionName - - - Récupère le nom de l'action - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Le nom de l'action, ou &null; s'il n'est pas défini. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getActionName</methodname> - -getRequest()->getActionName()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getModuleName - Yaf_Request_Abstract::getControllerName - Yaf_Request_Abstract::getActionName - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setActionName - - - - - diff --git a/reference/yaf/yaf_request_abstract/getbaseuri.xml b/reference/yaf/yaf_request_abstract/getbaseuri.xml deleted file mode 100644 index cc00fceff6..0000000000 --- a/reference/yaf/yaf_request_abstract/getbaseuri.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::getBaseUri -Récupère l'URI de base - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getBaseUri - - - Récupère l'URI de base - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -L'URI de base, ou une chaîne vide si elle n'est pas définie. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getBaseUri</methodname> - -getRequest(); - - // En supposant que l'application soit servie sous /myapp, - // et que la requête soit /myapp/product/view - var_dump($request->getBaseUri()); - var_dump($request->getRequestUri()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setBaseUri - Yaf_Request_Abstract::getRequestUri - Yaf_Request_Abstract::setRequestUri - - - - - diff --git a/reference/yaf/yaf_request_abstract/getcontrollername.xml b/reference/yaf/yaf_request_abstract/getcontrollername.xml deleted file mode 100644 index 245ea3d275..0000000000 --- a/reference/yaf/yaf_request_abstract/getcontrollername.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Request_Abstract::getControllerName -Récupère le nom du contrôleur - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getControllerName - - - Récupère le nom du contrôleur - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Le nom du contrôleur, ou &null; s'il n'est pas défini. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getControllerName</methodname> - -getRequest()->getControllerName()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getModuleName - Yaf_Request_Abstract::getControllerName - Yaf_Request_Abstract::getActionName - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setActionName - - - - - diff --git a/reference/yaf/yaf_request_abstract/getcookie.xml b/reference/yaf/yaf_request_abstract/getcookie.xml deleted file mode 100644 index 75942f7483..0000000000 --- a/reference/yaf/yaf_request_abstract/getcookie.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - -Yaf_Request_Abstract::getCookie -Récupère une variable COOKIE - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getCookie - stringname - mixeddefault - - Récupère une variable de $_COOKIE. - - - - &reftitle.parameters; - - - name - -Le nom de la variable. S'il est omis, le tableau entier est retourné. - - - - default - -La valeur à retourner si la variable n'est pas trouvée. - - - - - - &reftitle.returnvalues; -La valeur du cookie, ou default si elle n'est pas définie. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getCookie</methodname> - -getRequest(); - - $theme = $request->getCookie("theme", "light"); - $sessionId = $request->getCookie("sid"); - - var_dump($theme, $sessionId); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getenv.xml b/reference/yaf/yaf_request_abstract/getenv.xml deleted file mode 100644 index 28d04c9b57..0000000000 --- a/reference/yaf/yaf_request_abstract/getenv.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - -Yaf_Request_Abstract::getEnv -Récupère une variable ENV - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getEnv - stringname - mixeddefault - - Récupère une variable ENV. - - - - &reftitle.parameters; - - - name - -Le nom de la variable. - - - - default - -La valeur à retourner si la variable n'est pas trouvée. - - - - - - &reftitle.returnvalues; -La valeur de la variable, ou default si elle n'est pas trouvée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getEnv</methodname> - -getRequest()->getEnv("APPLICATION_ENV", "production"); - - var_dump($env); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getexception.xml b/reference/yaf/yaf_request_abstract/getexception.xml deleted file mode 100644 index 960c042d14..0000000000 --- a/reference/yaf/yaf_request_abstract/getexception.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Yaf_Request_Abstract::getException - Récupère l'exception - - - - &reftitle.description; - - public ExceptionnullYaf_Request_Abstract::getException - - - Récupère l'exception interceptée durant la distribution. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - L'Exception interceptée durant la distribution, ou &null; s'il n'y en a aucune. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getException</methodname> - -catchException(true); - -class ErrorController extends Yaf_Controller_Abstract -{ - public function errorAction($exception) - { - var_dump($this->getRequest()->getException() === $exception); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Dispatcher::catchException - - - - - diff --git a/reference/yaf/yaf_request_abstract/getfiles.xml b/reference/yaf/yaf_request_abstract/getfiles.xml deleted file mode 100644 index 4ca2a62da4..0000000000 --- a/reference/yaf/yaf_request_abstract/getfiles.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - -Yaf_Request_Abstract::getFiles -Récupère les fichiers téléversés - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getFiles - stringname - mixeddefault - - Récupère une variable depuis $_FILES. - - - - &reftitle.parameters; - - - name - -Le nom de la variable. S'il est omis, le tableau complet est retourné. - - - - default - -La valeur à retourner si la variable n'est pas trouvée. - - - - - - &reftitle.returnvalues; -Le tableau des fichiers téléversés, ou default s'il n'est pas défini. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getFiles</methodname> - -getRequest()->getFiles("avatar"); - - if (is_array($file) && $file["error"] === UPLOAD_ERR_OK) { - move_uploaded_file( - $file["tmp_name"], - "/var/www/uploads/" . basename($file["name"]) - ); - } - } -} -?>]]> - - - - Exemple avec <methodname>Yaf_Request_Abstract::getFiles</methodname> - -getRequest()->getFiles("avatar")); - } -} -?>]]> - - &example.outputs.similar; - - - string(9) "photo.jpg" - ["type"]=> - string(10) "image/jpeg" - ["tmp_name"]=> - string(14) "/tmp/phpXvBXqZ" - ["error"]=> - int(0) - ["size"]=> - int(12455) -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getlanguage.xml b/reference/yaf/yaf_request_abstract/getlanguage.xml deleted file mode 100644 index 55aa4b0504..0000000000 --- a/reference/yaf/yaf_request_abstract/getlanguage.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - -Yaf_Request_Abstract::getLanguage -Récupère la langue préférée du client - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getLanguage - - - Récupère la langue préférée du client - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -La chaîne de la langue préférée, ou &null; si elle ne peut pas être déterminée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getLanguage</methodname> - -getRequest()->getLanguage(); - - var_dump($language); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getServer - Yaf_Request_Abstract::getEnv - - - - - diff --git a/reference/yaf/yaf_request_abstract/getmethod.xml b/reference/yaf/yaf_request_abstract/getmethod.xml deleted file mode 100644 index 04582f091c..0000000000 --- a/reference/yaf/yaf_request_abstract/getmethod.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - -Yaf_Request_Abstract::getMethod -Récupère la méthode de la requête - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getMethod - - - Récupère la méthode de la requête - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -La méthode de la requête sous forme de chaîne de caractères, par exemple GET, POST, PUT, DELETE. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getMethod</methodname> - -getRequest(); - - // En supposant que la requête a été envoyée avec POST /order/save - var_dump($request->getMethod()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/getmodulename.xml b/reference/yaf/yaf_request_abstract/getmodulename.xml deleted file mode 100644 index ddf82939bc..0000000000 --- a/reference/yaf/yaf_request_abstract/getmodulename.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Request_Abstract::getModuleName -Récupère le nom du module - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getModuleName - - - Récupère le nom du module - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Le nom du module, ou &null; s'il n'est pas défini. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getModuleName</methodname> - -getRequest()->getModuleName()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getModuleName - Yaf_Request_Abstract::getControllerName - Yaf_Request_Abstract::getActionName - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setActionName - - - - - diff --git a/reference/yaf/yaf_request_abstract/getparam.xml b/reference/yaf/yaf_request_abstract/getparam.xml deleted file mode 100644 index 678f0af4ab..0000000000 --- a/reference/yaf/yaf_request_abstract/getparam.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Request_Abstract::getParam -Récupère un paramètre - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getParam - stringname - mixeddefault - - Récupère un paramètre (un paramètre nommé de routage ou d'action) depuis la requête. - - - - &reftitle.parameters; - - - name - -Le nom du paramètre. - - - - default - -La valeur à retourner si le paramètre n'est pas défini. - - - - - - &reftitle.returnvalues; -La valeur du paramètre, ou default s'il a été fourni, &null; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getParam</methodname> - -getRequest(); - - // En supposant que la requête soit /product/view/id/17 - $id = (int) $request->getParam("id"); - $referrer = $request->getParam("referrer", "direct"); - - var_dump($id, $referrer); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setParam - Yaf_Request_Abstract::getParams - Yaf_Request_Abstract::clearParams - Yaf_Request_Abstract::get - - - - - diff --git a/reference/yaf/yaf_request_abstract/getparams.xml b/reference/yaf/yaf_request_abstract/getparams.xml deleted file mode 100644 index 3a90771e1e..0000000000 --- a/reference/yaf/yaf_request_abstract/getparams.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::getParams -Récupère tous les paramètres - - - - &reftitle.description; - - public arraynullYaf_Request_Abstract::getParams - - - Récupère tous les paramètres de la requête. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Un tableau de tous les paramètres, ou &null; si aucun n'est défini. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getParams</methodname> - -getRequest()->getParams()); - } -} -?>]]> - - &example.outputs.similar; - - - string(2) "17" - ["sort"]=> - string(5) "price" -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setParam - Yaf_Request_Abstract::getParam - Yaf_Request_Abstract::clearParams - - - - - diff --git a/reference/yaf/yaf_request_abstract/getpost.xml b/reference/yaf/yaf_request_abstract/getpost.xml deleted file mode 100644 index 1414a58245..0000000000 --- a/reference/yaf/yaf_request_abstract/getpost.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - -Yaf_Request_Abstract::getPost -Récupère un paramètre POST - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getPost - stringname - mixeddefault - - Récupère une variable depuis $_POST. - - - - &reftitle.parameters; - - - name - -Le nom de la variable. S'il est omis, le tableau entier est retourné. - - - - default - -La valeur à retourner si la variable n'est pas trouvée. - - - - - - &reftitle.returnvalues; -La valeur du paramètre POST, ou default s'il n'est pas défini. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getPost</methodname> - -getRequest()->isPost()) { - $username = $this->getRequest()->getPost("username"); - $remember = $this->getRequest()->getPost("remember", "no"); - - var_dump($username, $remember); - } - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getquery.xml b/reference/yaf/yaf_request_abstract/getquery.xml deleted file mode 100644 index ffc8094674..0000000000 --- a/reference/yaf/yaf_request_abstract/getquery.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Request_Abstract::getQuery -Récupère un paramètre de la chaîne de requête - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getQuery - stringname - mixeddefault - - Récupère une variable depuis $_GET. - - - - &reftitle.parameters; - - - name - -Le nom de la variable. S'il est omis, le tableau entier est retourné. - - - - default - -La valeur à retourner si la variable n'est pas trouvée. - - - - - - &reftitle.returnvalues; -La valeur du paramètre de la chaîne de requête, ou default s'il n'est pas défini. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getQuery</methodname> - -getRequest()->getQuery("keyword"); - $page = (int) $this->getRequest()->getQuery("page", 1); - - var_dump($keyword, $page); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getraw.xml b/reference/yaf/yaf_request_abstract/getraw.xml deleted file mode 100644 index 9f599236f4..0000000000 --- a/reference/yaf/yaf_request_abstract/getraw.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Request_Abstract::getRaw -Récupère le corps brut de la requête - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getRaw - - - Récupère le corps brut de la requête. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Le corps brut de la requête sous forme de chaîne de caractères, ou &null; en cas d'échec. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getRaw</methodname> - -getRequest()->getRaw(); - $data = json_decode($raw, true); - - var_dump($data); - } -} -?>]]> - - &example.outputs.similar; - - - string(3) "yaf" - ["version"]=> - int(3) -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getrequest.xml b/reference/yaf/yaf_request_abstract/getrequest.xml deleted file mode 100644 index fcb3ce28f3..0000000000 --- a/reference/yaf/yaf_request_abstract/getrequest.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Request_Abstract::getRequest -Récupère une variable REQUEST - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getRequest - stringname - mixeddefault - - Récupère une variable depuis $_REQUEST. - - - - &reftitle.parameters; - - - name - -Le nom de la variable. S'il est omis, le tableau entier est retourné. - - - - default - -La valeur à retourner si la variable n'est pas trouvée. - - - - - - &reftitle.returnvalues; -La valeur de la variable $_REQUEST, ou default si elle n'est pas définie. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getRequest</methodname> - -getRequest()->getRequest("keyword"); - $source = $this->getRequest()->getRequest("source", "web"); - - var_dump($keyword, $source); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getrequesturi.xml b/reference/yaf/yaf_request_abstract/getrequesturi.xml deleted file mode 100644 index f3052967a6..0000000000 --- a/reference/yaf/yaf_request_abstract/getrequesturi.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - -Yaf_Request_Abstract::getRequestUri -Récupère l'URI de la requête - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getRequestUri - - - Récupère l'URI de la requête - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -L'URI de la requête, ou une chaîne vide si elle n'est pas définie. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getRequestUri</methodname> - -getRequest()->getRequestUri()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setRequestUri - Yaf_Request_Abstract::getBaseUri - Yaf_Request_Abstract::setBaseUri - - - - - diff --git a/reference/yaf/yaf_request_abstract/getserver.xml b/reference/yaf/yaf_request_abstract/getserver.xml deleted file mode 100644 index 673db732a9..0000000000 --- a/reference/yaf/yaf_request_abstract/getserver.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - -Yaf_Request_Abstract::getServer -Récupère une variable SERVER - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getServer - stringname - mixeddefault - - Récupère une variable SERVER. - - - - &reftitle.parameters; - - - name - -Le nom de la variable. - - - - default - -La valeur à retourner si la variable n'est pas trouvée. - - - - - - &reftitle.returnvalues; -La valeur de la variable, ou default si elle n'est pas trouvée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::getServer</methodname> - -getRequest(); - - $host = $request->getServer("HTTP_HOST"); - $protocol = $request->getServer("SERVER_PROTOCOL", "HTTP/1.1"); - - var_dump($host, $protocol); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/iscli.xml b/reference/yaf/yaf_request_abstract/iscli.xml deleted file mode 100644 index 82cb90abda..0000000000 --- a/reference/yaf/yaf_request_abstract/iscli.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - -Yaf_Request_Abstract::isCli -Détermine si la requête est une requête CLI - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isCli - - - Vérifie si la requête a été envoyée avec la méthode CLI. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la requête a été effectuée en ligne de commande, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::isCli</methodname> - -isCli()); -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/isdelete.xml b/reference/yaf/yaf_request_abstract/isdelete.xml deleted file mode 100644 index 3e0b64d570..0000000000 --- a/reference/yaf/yaf_request_abstract/isdelete.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::isDelete -Détermine si la requête est une requête DELETE - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isDelete - - - Vérifie si la requête a été envoyée avec la méthode DELETE. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la méthode de la requête est DELETE, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::isDelete</methodname> - -getRequest()->isDelete()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/isdispatched.xml b/reference/yaf/yaf_request_abstract/isdispatched.xml deleted file mode 100644 index 2308a32067..0000000000 --- a/reference/yaf/yaf_request_abstract/isdispatched.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - -Yaf_Request_Abstract::isDispatched -Détermine si la requête a été distribuée - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isDispatched - - - Détermine si la requête a été distribuée. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la requête a été distribuée, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::isDispatched</methodname> - -getRequest()->setDispatched(); - - var_dump($this->getRequest()->isDispatched()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Dispatcher::dispatch - Yaf_Request_Abstract::setDispatched - - - - - diff --git a/reference/yaf/yaf_request_abstract/isget.xml b/reference/yaf/yaf_request_abstract/isget.xml deleted file mode 100644 index ea305c5c95..0000000000 --- a/reference/yaf/yaf_request_abstract/isget.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - -Yaf_Request_Abstract::isGet -Détermine si la requête est une requête GET - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isGet - - - Vérifie si la requête a été envoyée avec la méthode GET. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la méthode de la requête est GET, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::isGet</methodname> - -getRequest(); - - // En supposant que la requête a été envoyée avec GET /index - var_dump($request->isGet(), $request->isPost()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/ishead.xml b/reference/yaf/yaf_request_abstract/ishead.xml deleted file mode 100644 index f1d2687b2e..0000000000 --- a/reference/yaf/yaf_request_abstract/ishead.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - -Yaf_Request_Abstract::isHead -Détermine si la requête est une requête HEAD - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isHead - - - Vérifie si la requête a été envoyée avec la méthode HEAD. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la méthode de la requête est HEAD, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::isHead</methodname> - -getRequest()->isHead()) { - // En-têtes uniquement, le rendu du corps est ignoré - return false; - } - } -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/isoptions.xml b/reference/yaf/yaf_request_abstract/isoptions.xml deleted file mode 100644 index 49f22a171a..0000000000 --- a/reference/yaf/yaf_request_abstract/isoptions.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Yaf_Request_Abstract::isOptions -Détermine si la requête est une requête OPTIONS - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isOptions - - - Vérifie si la requête a été envoyée avec la méthode OPTIONS. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la méthode de la requête est OPTIONS, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::isOptions</methodname> - -getRequest()->isOptions()) { - $this->getResponse() - ->setHeader("Allow", "GET, POST, OPTIONS") - ->setBody(""); - return false; - } - } -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/ispatch.xml b/reference/yaf/yaf_request_abstract/ispatch.xml deleted file mode 100644 index e875ae563e..0000000000 --- a/reference/yaf/yaf_request_abstract/ispatch.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::isPatch -Détermine si la requête est une requête PATCH - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isPatch - - - Vérifie si la requête a été envoyée avec la méthode PATCH. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la méthode de la requête est PATCH, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::isPatch</methodname> - -getRequest()->isPatch()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/ispost.xml b/reference/yaf/yaf_request_abstract/ispost.xml deleted file mode 100644 index 6b3e3644c5..0000000000 --- a/reference/yaf/yaf_request_abstract/ispost.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::isPost -Détermine si la requête est une requête POST - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isPost - - - Vérifie si la requête a été envoyée avec la méthode POST. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la méthode de la requête est POST, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::isPost</methodname> - -getRequest()->isPost()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/isput.xml b/reference/yaf/yaf_request_abstract/isput.xml deleted file mode 100644 index 3ff5d3e7ad..0000000000 --- a/reference/yaf/yaf_request_abstract/isput.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Request_Abstract::isPut -Détermine si la requête est une requête PUT - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isPut - - - Vérifie si la requête a été envoyée avec la méthode PUT. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la méthode de la requête est PUT, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::isPut</methodname> - -getRequest()->isPut()) { - $payload = $this->getRequest()->getRaw(); - } - - var_dump($this->getRequest()->isPut()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/isrouted.xml b/reference/yaf/yaf_request_abstract/isrouted.xml deleted file mode 100644 index f4ad9d3535..0000000000 --- a/reference/yaf/yaf_request_abstract/isrouted.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::isRouted -Détermine si la requête a été routée - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isRouted - - - Détermine si la requête a été routée. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la requête a été routée, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::isRouted</methodname> - -isRouted()) { - return false; - } - - if (0 === strpos($request->getRequestUri(), "/api/")) { - $request->setControllerName("Api") - ->setActionName("handle"); - return true; - } - - return false; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Router::route - Yaf_Request_Abstract::setRouted - - - - - diff --git a/reference/yaf/yaf_request_abstract/isxmlhttprequest.xml b/reference/yaf/yaf_request_abstract/isxmlhttprequest.xml deleted file mode 100644 index 8f071a821f..0000000000 --- a/reference/yaf/yaf_request_abstract/isxmlhttprequest.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - -Yaf_Request_Abstract::isXmlHttpRequest -Détermine si la requête est une requête Ajax - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isXmlHttpRequest - - - Vérifie si la requête est une requête Ajax en inspectant l'en-tête de requête HTTP_X_REQUESTED_WITH. - - - Yaf_Request_Simple redéfinit cette méthode et retourne - toujours &false;, car les requêtes en ligne de commande ne sont jamais des requêtes Ajax. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la requête est une requête Ajax (l'en-tête X-Requested-With vaut XMLHttpRequest), &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::isXmlHttpRequest</methodname> - -getRequest()->isXmlHttpRequest()) { - $this->getResponse() - ->setHeader("Content-Type", "application/json") - ->setBody(json_encode(["id" => 17, "name" => "Yaf in Action"])); - return false; - } - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - - - - - diff --git a/reference/yaf/yaf_request_abstract/setactionname.xml b/reference/yaf/yaf_request_abstract/setactionname.xml deleted file mode 100644 index 7c6c28c3c2..0000000000 --- a/reference/yaf/yaf_request_abstract/setactionname.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Yaf_Request_Abstract::setActionName - Définit le nom de l'action - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Request_Abstract::setActionName - stringaction - boolformat_nametrue - - - Définit le nom de l'action dans la requête ; ceci est habituellement utilisé par un routeur personnalisé pour définir le nom de l'action résultant du routage. - - - - - - &reftitle.parameters; - - - action - - - &string;, le nom de l'action ; il devrait être en minuscules, comme "index" ou "foo_bar" - - - - - format_name - - - ceci a été introduit dans Yaf 3.2.0 ; par défaut, Yaf formate le nom en minuscules, - si ce paramètre vaut &false;, Yaf définit le nom original dans la requête. - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet requête lui-même en cas de succès, ou &null; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::setActionName</methodname> - -getRequestUri(), "/api")) { - $request->setControllerName("Api") - ->setActionName("orders"); - return true; - } - - return false; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::getActionName - - - - - diff --git a/reference/yaf/yaf_request_abstract/setbaseuri.xml b/reference/yaf/yaf_request_abstract/setbaseuri.xml deleted file mode 100644 index e47acd4be0..0000000000 --- a/reference/yaf/yaf_request_abstract/setbaseuri.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Yaf_Request_Abstract::setBaseUri - Définit l'URI de base - - - - &reftitle.description; - - public Yaf_Request_AbstractfalseYaf_Request_Abstract::setBaseUri - stringuir - - - Définit l'URI de base. L'URI de base est utilisée lors du routage : dans la - phase de routage, l'URI de la requête sert à router la requête, tandis que - l'URI de base sert à ignorer la partie initiale (l'URI de base) de l'URI de - la requête. - - Autrement dit, si une requête arrive avec l'URI de requête a/b/c, alors si - l'URI de base est définie à "a/b", seul "/c" sera utilisé lors de la phase - de routage. - - - en général, il n'est pas nécessaire de la définir, Yaf la détermine - automatiquement. - - - - - - - - &reftitle.parameters; - - - uir - - - l'URI de base - - - - - - - - &reftitle.returnvalues; - Retourne l'objet requête lui-même en cas de succès, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::setBaseUri</methodname> - -setBaseUri("/myapp"); -$request->setRequestUri("/myapp/product/view"); - -var_dump($request->getBaseUri()); -var_dump($request->getRequestUri()); -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getBaseUri - Yaf_Request_Abstract::setRequestUri - Yaf_Request_Abstract::getRequestUri - - - - - diff --git a/reference/yaf/yaf_request_abstract/setcontrollername.xml b/reference/yaf/yaf_request_abstract/setcontrollername.xml deleted file mode 100644 index 73dbb6eaf4..0000000000 --- a/reference/yaf/yaf_request_abstract/setcontrollername.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Yaf_Request_Abstract::setControllerName - Définit le nom du contrôleur - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Request_Abstract::setControllerName - stringcontroller - boolformat_nametrue - - - Définit le nom du contrôleur dans la requête ; ceci est habituellement utilisé par un routeur personnalisé pour définir le nom du contrôleur résultant du routage. - - - - - - &reftitle.parameters; - - - controller - - - &string;, le nom du contrôleur ; il devrait être en style camel, comme "Index" ou "Foo_Bar" - - - - - format_name - - - ceci a été introduit dans Yaf 3.2.0 ; par défaut, Yaf formate le nom en mode camel, - si ce paramètre vaut &false;, Yaf définit le nom original dans la requête. - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet requête lui-même en cas de succès, ou &null; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::setControllerName</methodname> - -getRequestUri(), "/api")) { - // Les noms sont formatés en style camel par défaut, - // ainsi "order_item" devient "Order_Item" - $request->setControllerName("order_item") - ->setActionName("list"); - return true; - } - - return false; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::setActionName - Yaf_Request_Abstract::getControllerName - - - - - diff --git a/reference/yaf/yaf_request_abstract/setdispatched.xml b/reference/yaf/yaf_request_abstract/setdispatched.xml deleted file mode 100644 index fc3e585605..0000000000 --- a/reference/yaf/yaf_request_abstract/setdispatched.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Yaf_Request_Abstract::setDispatched -Marque la requête comme distribuée - - - - &reftitle.description; - - final public Yaf_Request_AbstractYaf_Request_Abstract::setDispatched - boolflagtrue - - Marque la requête comme distribuée - Ceci est appelé par le distributeur après l'exécution d'une action ; cela arrête la boucle de distribution. Il est possible de l'appeler manuellement, par exemple pour sauter les itérations de distribution restantes. - - - - &reftitle.parameters; - - - flag - -L'état à définir. Vaut &true; par défaut. - - - - - - &reftitle.returnvalues; -Retourne l'objet requête lui-même. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::setDispatched</methodname> - -setDispatched(); - $response->setRedirect("/account/login"); - } - } -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isDispatched - Yaf_Dispatcher::dispatch - - - - - diff --git a/reference/yaf/yaf_request_abstract/setmodulename.xml b/reference/yaf/yaf_request_abstract/setmodulename.xml deleted file mode 100644 index a14de81a43..0000000000 --- a/reference/yaf/yaf_request_abstract/setmodulename.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Yaf_Request_Abstract::setModuleName - Définit le nom du module - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Request_Abstract::setModuleName - stringmodule - boolformat_nametrue - - - Définit le nom du module dans la requête ; ceci est habituellement utilisé par un routeur personnalisé pour définir le nom du module résultant du routage. - - - - - - &reftitle.parameters; - - - module - - - &string; le nom du module ; il devrait être en style camel, comme "Index" ou "Foo_Bar" - - - - - format_name - - - ceci a été introduit dans Yaf 3.2.0 ; par défaut, Yaf formate le nom en mode camel, - si ce paramètre vaut &false;, Yaf définit le nom original dans la requête. - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet requête lui-même en cas de succès, ou &null; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::setModuleName</methodname> - -getRequestUri(), "/admin")) { - $request->setModuleName("Admin") - ->setControllerName("Dashboard") - ->setActionName("index"); - return true; - } - - return false; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setActionName - Yaf_Request_Abstract::getModuleName - - - - - diff --git a/reference/yaf/yaf_request_abstract/setparam.xml b/reference/yaf/yaf_request_abstract/setparam.xml deleted file mode 100644 index 0fffb03df6..0000000000 --- a/reference/yaf/yaf_request_abstract/setparam.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -Yaf_Request_Abstract::setParam -Définit un paramètre dans la requête - - - - &reftitle.description; - - public Yaf_Request_AbstractboolnullYaf_Request_Abstract::setParam - mixedname - mixedvalue - - Définit un paramètre dans la requête, qui pourra être récupéré par Yaf_Request_Abstract::getParam. - Si la méthode est appelée avec un unique argument de type tableau, chaque paire clé/valeur est définie comme paramètre. - - - - &reftitle.parameters; - - - name - -Le nom du paramètre, ou un tableau de paires clé/valeur. - - - - value - -La valeur du paramètre. Requise sauf si name est un tableau. - - - - - - &reftitle.returnvalues; -Retourne l'objet requête lui-même en cas de succès, ou &false; en cas d'échec. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::setParam</methodname> - -getRequest(); - - $request->setParam("referrer", "newsletter"); - $request->setParam(["source" => "email", "campaign" => "spring"]); - - var_dump($request->getParam("referrer")); - var_dump($request->getParams()); - } -} -?>]]> - - &example.outputs.similar; - - - string(10) "newsletter" - ["source"]=> - string(5) "email" - ["campaign"]=> - string(6) "spring" -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getParam - Yaf_Request_Abstract::getParams - Yaf_Request_Abstract::clearParams - - - - - diff --git a/reference/yaf/yaf_request_abstract/setrequesturi.xml b/reference/yaf/yaf_request_abstract/setrequesturi.xml deleted file mode 100644 index a6913f4244..0000000000 --- a/reference/yaf/yaf_request_abstract/setrequesturi.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Request_Abstract::setRequestUri -Définit l'URI de la requête - - - - &reftitle.description; - - public Yaf_Request_AbstractYaf_Request_Abstract::setRequestUri - stringuri - - Définit l'URI de la requête, en remplaçant celle détectée depuis l'environnement. - Ceci est utile lors d'une distribution manuelle, par exemple dans des tests, avec une URI qui diffère de l'URI réelle. - - - - &reftitle.parameters; - - - uri - -L'URI de la requête à définir. - - - - - - &reftitle.returnvalues; -Retourne l'objet requête lui-même. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::setRequestUri</methodname> - -setRequestUri("/product/view/id/17"); - -var_dump($request->getRequestUri()); -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getRequestUri - Yaf_Request_Abstract::setBaseUri - Yaf_Request_Abstract::getBaseUri - - - - - diff --git a/reference/yaf/yaf_request_abstract/setrouted.xml b/reference/yaf/yaf_request_abstract/setrouted.xml deleted file mode 100644 index fb678364e0..0000000000 --- a/reference/yaf/yaf_request_abstract/setrouted.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Request_Abstract::setRouted -Marque la requête comme routée - - - - &reftitle.description; - - final public Yaf_Request_AbstractYaf_Request_Abstract::setRouted - boolflagtrue - - Marque la requête comme routée - Cette méthode est appelée par le routeur une fois le routage réussi. L'appeler manuellement peut empêcher l'exécution des routeurs personnalisés situés ensuite. - - - - &reftitle.parameters; - - - flag - -L'état à définir. Vaut &true; par défaut. - - - - - - &reftitle.returnvalues; -Retourne l'objet requête lui-même. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Abstract::setRouted</methodname> - -getRequestUri(), "/api/")) { - return false; - } - - $request->setControllerName("Api") - ->setActionName("handle"); - - // Empêche l'exécution des routeurs enregistrés après celui-ci - $request->setRouted(); - - return true; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isRouted - Yaf_Router::route - - - - - diff --git a/reference/yaf/yaf_request_http/construct.xml b/reference/yaf/yaf_request_http/construct.xml deleted file mode 100644 index 56936f311f..0000000000 --- a/reference/yaf/yaf_request_http/construct.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Request_Http::__construct - Constructeur de Yaf_Request_Http - - - - &reftitle.description; - - public Yaf_Request_Http::__construct - stringrequest_uri - stringbase_uri - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Http::__construct</methodname> - -getMethod()); -var_dump($request->getRequestUri()); -var_dump($request->getBaseUri()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Yaf_Request_Simple - Yaf_Request_Abstract::getMethod - Yaf_Request_Abstract::getRequestUri - - - - - - diff --git a/reference/yaf/yaf_request_simple/construct.xml b/reference/yaf/yaf_request_simple/construct.xml deleted file mode 100644 index 3b11b97940..0000000000 --- a/reference/yaf/yaf_request_simple/construct.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Yaf_Request_Simple::__construct - Constructeur de Yaf_Request_Simple - - - - &reftitle.description; - - public Yaf_Request_Simple::__construct - stringmethod - stringmodule - stringcontroller - stringaction - arrayparams - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Request_Simple::__construct</methodname> - - 10) // paramètres de la requête -); - -var_dump($request->isRouted()); /* les requêtes avec des noms MVC sont pré-routées */ -var_dump($request->getModuleName()); -var_dump($request->getControllerName()); -var_dump($request->getActionName()); -var_dump($request->getParam("id")); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Yaf_Request_Http - Yaf_Request_Abstract::isRouted - Yaf_Request_Abstract::getParam - - - - - - diff --git a/reference/yaf/yaf_response_abstract/appendbody.xml b/reference/yaf/yaf_response_abstract/appendbody.xml deleted file mode 100644 index 1d9f81fe50..0000000000 --- a/reference/yaf/yaf_response_abstract/appendbody.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Response_Abstract::appendBody -Ajoute du contenu à la fin du corps de la réponse - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::appendBody - stringbody - stringkey - - Ajoute du contenu à la fin du corps de la réponse. - - - - &reftitle.parameters; - - - body - -La chaîne de contenu. - - - - key - -La clé du contenu. Si elle n'est pas spécifiée, Yaf_Response_Abstract::DEFAULT_BODY sera utilisée. - - - - - - &reftitle.returnvalues; -Retourne l'objet réponse lui-même en cas de succès, ou &false; en cas d'échec. - - - &reftitle.examples; - - Exemple avec <function>Yaf_Response_Abstract::appendBody</function> - -setBody("Hello")->appendBody(" World"); - -echo $response; -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getBody - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::prependBody - Yaf_Response_Abstract::clearBody - - - - - diff --git a/reference/yaf/yaf_response_abstract/clearbody.xml b/reference/yaf/yaf_response_abstract/clearbody.xml deleted file mode 100644 index 0c3d736a12..0000000000 --- a/reference/yaf/yaf_response_abstract/clearbody.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Response_Abstract::clearBody -Supprime tous les corps de réponse existants - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::clearBody - stringkey - - Supprime tous les corps de réponse existants. - - - - &reftitle.parameters; - - - key - -La clé du contenu. Si elle est spécifiée, seul ce bloc de contenu est supprimé ; sinon, tous les blocs de contenu sont supprimés. - - - - - - &reftitle.returnvalues; -Retourne l'objet réponse lui-même en cas de succès, ou &null; en cas d'échec. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Response_Abstract::clearBody</methodname> - -getResponse(); - - $response->setBody("Hello", "intro"); - $response->setBody("World"); - - $response->clearBody("intro"); // supprime uniquement le bloc "intro" - var_dump($response->getBody(null)); - - $response->clearBody(); // supprime tous les blocs de contenu - var_dump($response->getBody(null)); - } -} -?> -]]> - - &example.outputs.similar; - - - string(5) "World" -} -array(0) { -}]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::appendBody - Yaf_Response_Abstract::prependBody - Yaf_Response_Abstract::getBody - - - - - diff --git a/reference/yaf/yaf_response_abstract/clearheaders.xml b/reference/yaf/yaf_response_abstract/clearheaders.xml deleted file mode 100644 index 73032e70e1..0000000000 --- a/reference/yaf/yaf_response_abstract/clearheaders.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - -Yaf_Response_Abstract::clearHeaders -Supprime tous les en-têtes de la réponse - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::clearHeaders - - - Supprime tous les en-têtes de réponse HTTP qui ont été définis. - Cette méthode n'est pleinement implémentée que dans la sous-classe Yaf_Response_Http. Dans la classe abstraite, il s'agit d'une ébauche. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne l'objet réponse lui-même en cas de succès, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Response_Abstract::clearHeaders</methodname> - -getResponse(); - - $response->setHeader("Content-Type", "application/json"); - $response->clearHeaders(); - - var_dump($response->getHeader()); // array(0) { } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setHeader - Yaf_Response_Abstract::getHeader - Yaf_Response_Abstract::setAllHeaders - - - - - diff --git a/reference/yaf/yaf_response_abstract/construct.xml b/reference/yaf/yaf_response_abstract/construct.xml deleted file mode 100644 index b82bed8e38..0000000000 --- a/reference/yaf/yaf_response_abstract/construct.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Response_Abstract::__construct - Construit une réponse - - - - &reftitle.description; - - public Yaf_Response_Abstract::__construct - - - - Construit un objet réponse. Le constructeur ne prend aucun argument ; les - sous-classes concrètes comme Yaf_Response_Http et - Yaf_Response_Cli initialisent leurs propres valeurs - par défaut (une réponse HTTP démarre par exemple avec le code de réponse - 200). - - - - En général, il n'est pas nécessaire de construire un objet réponse - manuellement : Yaf_Dispatcher::getResponse - retourne celui créé par le distributeur. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Aucune valeur n'est retournée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Response_Abstract::__construct</methodname> - -getResponse(); - -/* la construction directe est surtout utile dans les tests */ -$response = new Yaf_Response_Http(); -$response->setBody("Hello World"); - -echo $response; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Dispatcher::getResponse - Yaf_Response_Abstract::response - - - - - - diff --git a/reference/yaf/yaf_response_abstract/getbody.xml b/reference/yaf/yaf_response_abstract/getbody.xml deleted file mode 100644 index 361a64e37c..0000000000 --- a/reference/yaf/yaf_response_abstract/getbody.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_Response_Abstract::getBody -Récupère un bloc de contenu de la réponse - - - - &reftitle.description; - - public mixedYaf_Response_Abstract::getBody - stringkey - - Récupère le contenu d'un bloc de contenu de la réponse. - - - - &reftitle.parameters; - - - key - -La clé du contenu. Si elle n'est pas spécifiée, le bloc DEFAULT_BODY est utilisé ; passer &null; pour obtenir tous les blocs de contenu sous la forme d'un tableau. - - - - - - &reftitle.returnvalues; -La chaîne de contenu, ou un tableau de tous les blocs de contenu lorsque key vaut &null;. Retourne une chaîne vide si le bloc n'est pas défini. - - - &reftitle.examples; - - Exemple avec <function>Yaf_Response_Abstract::getBody</function> - -setBody("Hello")->setBody(" World", "footer"); - -var_dump($response->getBody()); -var_dump($response->getBody(Yaf_Response_Abstract::DEFAULT_BODY)); -var_dump($response->getBody("footer")); -var_dump($response->getBody(NULL)); -?>]]> - - &example.outputs.similar; - - - string(5) "Hello" - ["footer"]=> - string(6) " World" -}]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::appendBody - Yaf_Response_Abstract::prependBody - Yaf_Response_Abstract::clearBody - - - - - diff --git a/reference/yaf/yaf_response_abstract/getheader.xml b/reference/yaf/yaf_response_abstract/getheader.xml deleted file mode 100644 index 5264421976..0000000000 --- a/reference/yaf/yaf_response_abstract/getheader.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - -Yaf_Response_Abstract::getHeader -Récupère un en-tête de réponse HTTP - - - - &reftitle.description; - - public stringarraynullYaf_Response_Abstract::getHeader - stringname - - Récupère un en-tête de réponse HTTP. - Cette méthode n'est pleinement implémentée que dans la sous-classe Yaf_Response_Http. Dans la classe abstraite, il s'agit d'une ébauche. - - - - &reftitle.parameters; - - - name - -Le nom de l'en-tête. S'il est omis, tous les en-têtes sont retournés sous forme de tableau. - - - - - - &reftitle.returnvalues; -La valeur de l'en-tête sous forme de chaîne de caractères, ou un tableau de tous les en-têtes lorsque le nom est omis. Retourne &null; si l'en-tête demandé n'est pas défini. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Response_Abstract::getHeader</methodname> - -getResponse(); - $response->setHeader("Content-Type", "application/json"); - - var_dump($response->getHeader("Content-Type")); - var_dump($response->getHeader()); // tous les en-têtes - var_dump($response->getHeader("X-Missing")); - } -} -?> -]]> - - &example.outputs.similar; - - - string(16) "application/json" -} -NULL]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setHeader - Yaf_Response_Abstract::clearHeaders - Yaf_Response_Abstract::setAllHeaders - - - - - diff --git a/reference/yaf/yaf_response_abstract/prependbody.xml b/reference/yaf/yaf_response_abstract/prependbody.xml deleted file mode 100644 index ff82bf0ea2..0000000000 --- a/reference/yaf/yaf_response_abstract/prependbody.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Response_Abstract::prependBody -Ajoute du contenu au début du corps de la réponse - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::prependBody - stringbody - stringkey - - Ajoute du contenu au début du corps de la réponse - - - - &reftitle.parameters; - - - body - -La chaîne de contenu. - - - - key - -la clé du contenu. Si elle n'est pas spécifiée, Yaf_Response_Abstract::DEFAULT_BODY sera utilisée. - - - - - - &reftitle.returnvalues; -Retourne l'objet de réponse lui-même en cas de succès, &false; sinon. - - - &reftitle.examples; - - Exemple avec <function>Yaf_Response_Abstract::prependBody</function> - -setBody("Monde")->prependBody("Bonjour "); - -echo $response; -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getBody - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::appendBody - Yaf_Response_Abstract::clearBody - - - - - diff --git a/reference/yaf/yaf_response_abstract/response.xml b/reference/yaf/yaf_response_abstract/response.xml deleted file mode 100644 index 5cbf2814ea..0000000000 --- a/reference/yaf/yaf_response_abstract/response.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - -Yaf_Response_Abstract::response -Envoie la réponse - - - - &reftitle.description; - - public boolnullYaf_Response_Abstract::response - - - Envoie la réponse : les en-têtes et tous les blocs de corps, dans l'ordre. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; en cas de succès, ou &null; en cas d'échec. - - - &reftitle.examples; - - Exemple avec <function>Yaf_Response_Abstract::response</function> - -setBody("Bonjour")->setBody(" le monde", "footer"); - -$response->response(); -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::clearBody - - - - - diff --git a/reference/yaf/yaf_response_abstract/setallheaders.xml b/reference/yaf/yaf_response_abstract/setallheaders.xml deleted file mode 100644 index dcbd2ff87a..0000000000 --- a/reference/yaf/yaf_response_abstract/setallheaders.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Response_Abstract::setAllHeaders -Définit tous les en-têtes de la réponse HTTP - - - - &reftitle.description; - - public boolYaf_Response_Abstract::setAllHeaders - arrayheaders - - Définit tous les en-têtes de la réponse HTTP en une seule fois. - Cette méthode n'est pleinement implémentée que dans la sous-classe Yaf_Response_Http. Dans la classe abstraite, ce n'est qu'une ébauche. - - - - &reftitle.parameters; - - - headers - -Un tableau de paires nom/valeur d'en-têtes. Tout en-tête existant portant le même nom est remplacé. - - - - - - &reftitle.returnvalues; -Retourne &true;. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Response_Abstract::setAllHeaders</methodname> - -getResponse()->setAllHeaders(array( - "Content-Type" => "application/json; charset=utf-8", - "Cache-Control" => "no-cache", - "X-Request-Id" => "7f3c2d91", - )); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setHeader - Yaf_Response_Abstract::getHeader - Yaf_Response_Abstract::clearHeaders - - - - - diff --git a/reference/yaf/yaf_response_abstract/setbody.xml b/reference/yaf/yaf_response_abstract/setbody.xml deleted file mode 100644 index 142fcfb436..0000000000 --- a/reference/yaf/yaf_response_abstract/setbody.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - -Yaf_Response_Abstract::setBody -Définit le contenu de la réponse - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::setBody - stringbody - stringkey - - Définit le contenu de la réponse - - - - &reftitle.parameters; - - - body - -La chaîne de contenu. - - - - key - -la clé du contenu. Si elle n'est pas spécifiée, Yaf_Response_Abstract::DEFAULT_BODY sera utilisée. - - - - - - &reftitle.returnvalues; -Retourne l'objet réponse lui-même en cas de succès, ou &false; en cas d'échec. - - - &reftitle.examples; - - Exemple avec <function>Yaf_Response_Abstract::setBody</function> - -setBody("Bonjour")->setBody(" le monde", "footer"); - -print_r($response); -echo $response; -?>]]> - - &example.outputs.similar; - - Array - ( - ) - - [_body:protected] => Array - ( - [content] => Bonjour - [footer] => le monde - ) - - [_sendheader:protected] => 1 - [_response_code:protected] => 200 -) -Bonjour le monde]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getBody - Yaf_Response_Abstract::appendBody - Yaf_Response_Abstract::prependBody - Yaf_Response_Abstract::clearBody - - - - - diff --git a/reference/yaf/yaf_response_abstract/setheader.xml b/reference/yaf/yaf_response_abstract/setheader.xml deleted file mode 100644 index 39cc8924e7..0000000000 --- a/reference/yaf/yaf_response_abstract/setheader.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -Yaf_Response_Abstract::setHeader -Définit un en-tête de réponse HTTP - - - - &reftitle.description; - - public boolYaf_Response_Abstract::setHeader - stringname - stringvalue - boolreplacefalse - intresponse_code0 - - Définit un en-tête de réponse HTTP. - Cette méthode n'est pleinement implémentée que dans la sous-classe Yaf_Response_Http. Dans la classe abstraite, il s'agit d'une ébauche. - - - - &reftitle.parameters; - - - name - -Le nom de l'en-tête. - - - - value - -La valeur de l'en-tête. - - - - replace - -Indique s'il faut remplacer tout en-tête existant portant le même nom. Si &false;, la nouvelle valeur est ajoutée à la valeur existante, séparée par une virgule. Il est à noter que, bien que la valeur par défaut déclarée soit &false;, l'implémentation actuelle remplace l'en-tête existant lorsque ce paramètre est omis. - - - - response_code - -S'il est non nul, le code de réponse HTTP à définir sur la réponse. - - - - - - &reftitle.returnvalues; -Retourne &true; en cas de succès, ou &false; en cas d'échec. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Response_Abstract::setHeader</methodname> - -getResponse(); - - $response->setHeader("Content-Type", "application/json"); - - /* envoie un 401 et demande des identifiants */ - $response->setHeader("WWW-Authenticate", 'Basic realm="Member Area"', true, 401); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getHeader - Yaf_Response_Abstract::clearHeaders - Yaf_Response_Abstract::setAllHeaders - - - - - diff --git a/reference/yaf/yaf_response_abstract/setredirect.xml b/reference/yaf/yaf_response_abstract/setredirect.xml deleted file mode 100644 index 3f4cc31a0e..0000000000 --- a/reference/yaf/yaf_response_abstract/setredirect.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Response_Abstract::setRedirect -Redirige vers une autre URL - - - - &reftitle.description; - - public boolnullYaf_Response_Abstract::setRedirect - stringurl - - Redirige le client vers une autre URL (envoie un en-tête Location). - - - - &reftitle.parameters; - - - url - -L'URL vers laquelle rediriger. - - - - - - &reftitle.returnvalues; -Retourne &true; en cas de succès, ou &null; en cas d'échec. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Response_Abstract::setRedirect</methodname> - -has("login")) { - /* envoie un en-tête Location pointant vers la page de connexion */ - $this->getResponse()->setRedirect("/account/login"); - return false; // rien à afficher ici - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Controller_Abstract::redirect - - - - - diff --git a/reference/yaf/yaf_response_abstract/tostring.xml b/reference/yaf/yaf_response_abstract/tostring.xml deleted file mode 100644 index 2a14c2f828..0000000000 --- a/reference/yaf/yaf_response_abstract/tostring.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Yaf_Response_Abstract::__toString - Récupère tous les corps sous la forme d'une chaîne de caractères - - - - &reftitle.description; - - private stringYaf_Response_Abstract::__toString - - - - Retourne tous les blocs du corps de la réponse, concaténés en une seule - chaîne de caractères dans l'ordre dans lequel ils ont été ajoutés. C'est - ce qui est affiché lorsqu'un objet réponse est utilisé dans un contexte - de chaîne de caractères. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le corps de la réponse sous la forme d'une chaîne de caractères. - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Response_Abstract::__toString</methodname> - -setBody("Bonjour")->setBody(" tout le monde", "footer"); - -/* utiliser la réponse dans un contexte de chaîne affiche tous les blocs du corps */ -echo $response; -var_dump((string) $response); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getBody - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::response - - - - - - diff --git a/reference/yaf/yaf_route_interface/assemble.xml b/reference/yaf/yaf_route_interface/assemble.xml deleted file mode 100644 index 766d241544..0000000000 --- a/reference/yaf/yaf_route_interface/assemble.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - Yaf_Route_Interface::assemble - Assemble une requête - - - - &reftitle.description; - - abstract public stringYaf_Route_Interface::assemble - arrayinfo - arrayquery - - - Cette méthode retourne une URL suivant les informations de l'argument - info, et ajoute les chaînes de requête à l'URL suivant l'argument query. - - - Une route devrait implémenter cette méthode suivant ses propres règles de - routage, et effectuer le traitement inverse. - - - - - &reftitle.parameters; - - - info - - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Route_Interface::assemble</methodname> - -_match = $match; - $this->_route = $route; - } - - public function route(Yaf_Request_Abstract $request): bool { - if (!preg_match($this->_match, $request->getRequestUri(), $matches)) { - return false; - } - - foreach ($this->_route as $key => $value) { - if (is_string($value) && ':' === $value[0]) { - $value = $matches[substr($value, 1)]; - } - $request->setParam($key, $value); - } - $request->setRouted(); - - return true; - } - - /* applique les règles de routage en sens inverse pour reconstruire une URL */ - public function assemble(array $info, ?array $query = null): string { - $url = "/product"; - if (isset($info[':name'])) { - $url .= "/" . $info[':name']; - } - - if (!empty($query)) { - $url .= "?" . http_build_query($query); - } - - return $url; - } -} - -$router = new Yaf_Router(); -$router->addRoute("custom", - new RewriteRoute("#^/product#", array("controller" => "product")) -); - -var_dump($router->getRoute("custom")->assemble( - array(':name' => 'book'), - array('page' => 2) -)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Yaf_Route_Interface::route - Yaf_Route_Rewrite::assemble - Yaf_Route_Map::assemble - - - - - - diff --git a/reference/yaf/yaf_route_interface/route.xml b/reference/yaf/yaf_route_interface/route.xml deleted file mode 100644 index 1a48ec4b26..0000000000 --- a/reference/yaf/yaf_route_interface/route.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - Yaf_Route_Interface::route - Route une requête - - - - &reftitle.description; - - abstract public boolYaf_Route_Interface::route - Yaf_Request_Abstractrequest - - - Yaf_Route_Interface::route est la seule méthode - qu'une route personnalisée devrait implémenter. - - - À partir de la version 2.3.0, une autre méthode devrait également être - implémentée, voir Yaf_Route_Interface::assemble. - - - - - Si cette méthode retourne &true;, alors le processus de routage se - terminera. Sinon, Yaf_Router appellera la route - suivante dans la pile des routes pour router la requête. - - - - Cette méthode devrait affecter le résultat du routage au paramètre - request, en appelant - Yaf_Request_Abstract::setControllerName, - Yaf_Request_Abstract::setActionName et - Yaf_Request_Abstract::setModuleName. - - - - Cette méthode devrait également appeler - Yaf_Request_Abstract::setRouted pour marquer - la requête comme routée en dernier lieu. - - - - - - &reftitle.parameters; - - - request - - - Une instance de Yaf_Request_Abstract. - - - - - - - - &reftitle.returnvalues; - - - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Route_Interface::route</methodname> - -_prefix = $prefix; - } - - public function route(Yaf_Request_Abstract $request): bool { - $uri = $request->getRequestUri(); - if (0 !== strpos($uri, $this->_prefix)) { - /* cela ne nous concerne pas, le routeur essaiera la route suivante */ - return false; - } - - /* analyse l'URI "/api/user/list" en contrôleur/action */ - $segments = explode("/", ltrim(substr($uri, strlen($this->_prefix)), "/")); - $controller = isset($segments[0]) ? ucfirst($segments[0]) : NULL; - $action = isset($segments[1]) ? $segments[1] : NULL; - - if (empty($controller)) { - return false; - } - - $request->setModuleName("index"); - $request->setControllerName($controller); - $request->setActionName($action); - $request->setRouted(); /* le processus de routage se termine ici */ - - return true; - } - - public function assemble(array $info, ?array $query = null): string { - $uri = $this->_prefix . "/" . strtolower($info[':c']); - if (isset($info[':a'])) { - $uri .= "/" . $info[':a']; - } - - if (!empty($query)) { - $uri .= "?" . http_build_query($query); - } - - return $uri; - } -} - -/** - * enregistre la route personnalisée - */ -Yaf_Dispatcher::getInstance()->getRouter()->addRoute("api", new ApiRoute("/api")); -?> -]]> - - &example.outputs.similar; - - "index", - "controller" => "User", - "action" => "list", -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Interface::assemble - Yaf_Router::addRoute - Yaf_Request_Abstract::setRouted - - - - - - diff --git a/reference/yaf/yaf_route_map/assemble.xml b/reference/yaf/yaf_route_map/assemble.xml deleted file mode 100644 index d775670f1c..0000000000 --- a/reference/yaf/yaf_route_map/assemble.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Yaf_Route_Map::assemble - Assemble une URL - - - - &reftitle.description; - - public stringYaf_Route_Map::assemble - arrayinfo - arrayquery - - - Assemble une URL. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Retourne &string; en cas de succès ou &null; en cas d'échec. - - - - - &reftitle.errors; - - Peut lancer Yaf_Exception_TypeError. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Route_Map::assemble</function> - -addRoute("map", $route); - -var_dump($router->getRoute('map')->assemble( - array( - ':c' => 'foo_bar' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - ) -); - -$route = new Yaf_Route_Map(true, '_'); -$router->addRoute("map", $route); - -var_dump($router->getRoute('map')->assemble( - array( - ':a' => 'foo_bar' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - ) -); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_map/construct.xml b/reference/yaf/yaf_route_map/construct.xml deleted file mode 100644 index a07761fc2a..0000000000 --- a/reference/yaf/yaf_route_map/construct.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - -Yaf_Route_Map::__construct -Construit une route de type carte - - - - &reftitle.description; - - publicYaf_Route_Map::__construct - boolcontroller_preferfalse - stringdelimiter'' - - Construit une route de type carte. Une route de type carte associe l'URI entière à un nom de contrôleur ou à un nom d'action. - - - - &reftitle.parameters; - - - controller_prefer - -Indique s'il faut associer l'URI à un nom de contrôleur. Si &false;, l'URI est associée à un nom d'action. - - - - delimiter - -Le délimiteur utilisé pour séparer le nom associé des paramètres de la requête dans l'URI. S'il apparaît comme un segment de chemin précédé d'une barre oblique, tout ce qui le suit est analysé comme paramètres de la requête au lieu de faire partie du nom associé. S'il est vide, aucune séparation de ce type n'a lieu lors du routage. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <classname>Yaf_Route_Map</classname> - -getRouter()->addRoute("name", - new Yaf_Route_Map()); -?> -]]> - - &example.outputs.similar; - - "product_foo_bar", -) -]]> - - - - Exemple avec <classname>Yaf_Route_Map</classname> - -getRouter()->addRoute("name", - new Yaf_Route_Map(true, "_")); -?> -]]> - - &example.outputs.similar; - - "User_List", -) - -/** - * et les paramètres de requête : - */ -array( - "foo" => "22", -) -]]> - - - - Exemple avec <classname>Yaf_Route_Map</classname> - - array( - "type" => "map", // route Yaf_Route_Map - "controllerPrefer" => FALSE, - "delimiter" => "#!", - ), -); -Yaf_Dispatcher::getInstance()->getRouter()->addConfig( - new Yaf_Config_Simple($config)); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Map::route - Yaf_Route_Map::assemble - - - - - diff --git a/reference/yaf/yaf_route_map/route.xml b/reference/yaf/yaf_route_map/route.xml deleted file mode 100644 index 5a16fb2484..0000000000 --- a/reference/yaf/yaf_route_map/route.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - -Yaf_Route_Map::route -Route une requête - - - - &reftitle.description; - - public boolYaf_Route_Map::route - Yaf_Request_Abstractrequest - - Route la requête en associant l'URI entière à un nom de contrôleur ou à un nom d'action : les segments de chemin de l'URI sont joints par des tirets bas pour former le nom. - Lorsque la route a été construite avec l'option de préférence pour le contrôleur activée, le résultat est défini comme nom de contrôleur, sinon comme nom d'action. - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract à router. - - - - - - &reftitle.returnvalues; -Retourne toujours &true;. Il est à noter que la route de type carte prend en charge la requête même lorsque l'URI est vide, auquel cas aucun nom n'est défini. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Route_Map::route</methodname> - -setRequestUri("/product/foo/bar"); - -$route = new Yaf_Route_Map(); -var_dump($route->route($request)); -var_dump($request->getActionName()); -?> -]]> - - &example.outputs.similar; - - - - - - Exemple avec <methodname>Yaf_Route_Map::route</methodname> - -setRequestUri("/user/list/_/foo/22"); - -$route = new Yaf_Route_Map(true, "_"); -var_dump($route->route($request)); -var_dump($request->getControllerName()); -var_dump($request->getParam("foo")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Map::__construct - Yaf_Route_Map::assemble - - - - - diff --git a/reference/yaf/yaf_route_regex/assemble.xml b/reference/yaf/yaf_route_regex/assemble.xml deleted file mode 100644 index 7f6d3d2b8c..0000000000 --- a/reference/yaf/yaf_route_regex/assemble.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Yaf_Route_Regex::assemble - Assemble une URL - - - - &reftitle.description; - - public stringnullYaf_Route_Regex::assemble - arrayinfo - arrayquery - - - Assemble une URL. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Retourne &string; en cas de succès ou &null; en cas d'échec. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Route_Regex::assemble</function> - - "product", // route vers le contrôleur product, - ), - array(), - array(), - '/:m/:c/:a' - ); - -$router->addRoute("regex", $route); - -var_dump($router->getRoute('regex')->assemble( - array( - ':m' => 'module', - ':c' => 'controller', - ':a' => 'action' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => - 'tval2' - ) - ) - ); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_regex/construct.xml b/reference/yaf/yaf_route_regex/construct.xml deleted file mode 100644 index ce0cb5dd52..0000000000 --- a/reference/yaf/yaf_route_regex/construct.xml +++ /dev/null @@ -1,249 +0,0 @@ - - - - - - Yaf_Route_Regex::__construct - Constructeur Yaf_Route_Regex - - - - &reftitle.description; - - public Yaf_Route_Regex::__construct - stringmatch - arrayroute - arraynullmap&null; - arraynullverify&null; - stringnullreverse&null; - - - Construit une route Yaf_Route_Regex, qui route une - URI de requête correspondant à une expression rationnelle vers un module, - un contrôleur et une action. - - - - - - &reftitle.parameters; - - - match - - - Un masque d'expression rationnelle complet, utilisé pour correspondre à - l'URI de la requête. Lorsqu'il ne correspond pas, - Yaf_Route_Regex::route retourne &false; et le - routeur passe à la route suivante. - - - - - route - - - Lorsque le masque correspond à l'URI de la requête, ce &array; détermine - le module, le contrôleur et l'action vers lesquels router. - - - Chacune des trois entrées est optionnelle ; lorsque l'une n'est pas - fournie, la valeur par défaut est utilisée. Une entrée dont la valeur - commence par : est résolue à partir des paramètres - produits par map. - - - - - map - - - Un &array; associant les indices des groupes de capture à des noms de - paramètres. Seules les captures listées ici deviennent des paramètres de - la requête ; une capture numérique qui n'est pas listée est ignorée. - - - Les groupes de capture nommés sont toujours ajoutés sous leur propre nom - et n'ont pas besoin d'être listés. - - - - - verify - - - Accepté et stocké sur la route, mais inutilisé : l'implémentation - actuelle ne le consulte jamais lors du routage. - - - - - reverse - - - Une &string;, utilisée pour assembler une URL, voir - Yaf_Route_Regex::assemble. - - - Ce paramètre a été introduit en 2.3.0 - - - - - - - - - - &reftitle.returnvalues; - Aucune valeur n'est retournée. - - - - &reftitle.examples; - - <classname>Yaf_Route_Regex</classname> via <methodname>Yaf_Router::addRoute</methodname> - -getRouter()->addRoute( - "name", - new Yaf_Route_Regex( - "#^/product/([^/]+)/([^/]+)#", // correspond aux URI commençant par "/product" - array( - 'controller' => "product", // route vers le contrôleur product - ), - array( - 1 => "name", // $request->getParam("name") contient la première capture - 2 => "id", // et $request->getParam("id") la seconde - ) - ) -); -?> -]]> - - - - <classname>Yaf_Route_Regex</classname> utilisant une capture comme nom de contrôleur - -getRouter()->addRoute( - "name", - new Yaf_Route_Regex( - "#^/product/([^/]+)/([^/]+)#i", // correspond aux URI commençant par "/product" - array( - 'controller' => ":name", // la capture "name" (voir map) devient le contrôleur - ), - array( - 1 => "name", // $request->getParam("name") contient la première capture - 2 => "id", // et $request->getParam("id") la seconde - ) - ) -); -?> -]]> - - - - <classname>Yaf_Route_Regex</classname> utilisant un groupe de capture nommé - -getRouter()->addRoute( - "name", - new Yaf_Route_Regex( - "#^/product/(?[^/]+)/([^/]+)#i", // correspond aux URI commençant par "/product" - array( - 'controller' => ":name", // la capture "name" devient le contrôleur - ), - array( - 2 => "id", // le groupe 1 est nommé, seul le groupe 2 nécessite une entrée dans map - ) - ) -); -?> -]]> - - - - <classname>Yaf_Route_Regex</classname> via <methodname>Yaf_Router::addConfig</methodname> - - array( - "type" => "regex", // une route Yaf_Route_Regex - "match" => "#(.*)#", // correspond à n'importe quelle URI de requête - "route" => array( - 'controller' => "product", // route vers le contrôleur product - 'action' => "dummy", // et vers l'action dummy - ), - "map" => array( - 1 => "uri", // $request->getParam("uri") contient l'URI correspondante - ), - ), -); - -Yaf_Dispatcher::getInstance()->getRouter()->addConfig( - new Yaf_Config_Simple($config) -); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Regex::route - Yaf_Route_Regex::assemble - Yaf_Router::addRoute - Yaf_Router::addConfig - Yaf_Route_Static - Yaf_Route_Supervar - Yaf_Route_Simple - Yaf_Route_Rewrite - Yaf_Route_Map - - - - - - diff --git a/reference/yaf/yaf_route_regex/route.xml b/reference/yaf/yaf_route_regex/route.xml deleted file mode 100644 index d085e886f4..0000000000 --- a/reference/yaf/yaf_route_regex/route.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - -Yaf_Route_Regex::route -Route une requête - - - - &reftitle.description; - - public boolYaf_Route_Regex::route - Yaf_Request_Abstractrequest - - Route la requête à l'aide d'une expression rationnelle : l'URI est comparée au motif fourni au constructeur, et le résultat du routage (le module, le contrôleur et l'action) est tiré des variables capturées, associées par le paramètre map. - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract à router. - - - - - - &reftitle.returnvalues; -Retourne &true; si l'URI correspond, &false; sinon, ce qui amène le routeur à essayer la route suivante. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Route_Regex::route</methodname> - - "product", // route vers le contrôleur product - ), - array( - 1 => "name", // $request->getParam("name") vaudra "php-book" - ) -); - -var_dump($route->route($request)); - -var_dump($request->getControllerName()); -var_dump($request->getParam("name")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Regex::__construct - Yaf_Route_Regex::match - Yaf_Route_Regex::assemble - - - - - diff --git a/reference/yaf/yaf_route_rewrite/assemble.xml b/reference/yaf/yaf_route_rewrite/assemble.xml deleted file mode 100644 index 7c27186234..0000000000 --- a/reference/yaf/yaf_route_rewrite/assemble.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yaf_Route_Rewrite::assemble - Assemble une url - - - - &reftitle.description; - - public stringYaf_Route_Rewrite::assemble - arrayinfo - arrayquery - - - Assemble une url. - - - - - &reftitle.parameters; - - - info - - - - - - - query - - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string;. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Route_Rewrite::assemble</function> - - "product", - ), - array() -); - -$router->addRoute("rewrite", $route); - -var_dump($router->getRoute('rewrite')->assemble( - array( - ':name' => 'foo', - ':id' => 'bar', - ':tmpkey1' => 'tmpval1' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - ) -); - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_rewrite/construct.xml b/reference/yaf/yaf_route_rewrite/construct.xml deleted file mode 100644 index fe9bbf5e1d..0000000000 --- a/reference/yaf/yaf_route_rewrite/construct.xml +++ /dev/null @@ -1,240 +0,0 @@ - - - - - - Yaf_Route_Rewrite::__construct - Constructeur Yaf_Route_Rewrite - - - - &reftitle.description; - - public Yaf_Route_Rewrite::__construct - stringmatch - arrayroute - arrayverify - - - - - - - - &reftitle.parameters; - - - match - - - Un masque, qui sera utilisé pour correspondre à l'URI d'une requête ; - s'il ne correspond pas, Yaf_Route_Rewrite - retournera &false;. - - - Il est possible d'utiliser le style :name pour nommer les segments - correspondants, et * pour correspondre au reste des segments de l'URL. - - - - - route - - - Lorsque le masque correspond à l'URI de la requête, - Yaf_Route_Rewrite utilisera ce paramètre pour - déterminer quels module/contrôleur/action sont la destination. - - - Chacun des éléments module/contrôleur/action de ce tableau est - optionnel ; si aucune valeur spécifique n'est assignée, la route par - défaut sera utilisée. - - - - - verify - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <classname>Yaf_Route_Rewrite</classname> - -getRouter()->addRoute("name", - new Yaf_Route_Rewrite( - "/product/:name/:id/*", //correspond aux URI de requête commençant par "/product" - array( - 'controller' => "product", //route vers le contrôleur product, - ), - ) - ); -?> -]]> - - &example.outputs.similar; - - "product", - "module" => "index", //(par défaut) - "action" => "index", //(par défaut) -) - -/** - * et les paramètres de requête : - */ -array( - "name" => "foo", - "id" => 22, - "foo" => bar -) -]]> - - - - Exemple avec <classname>Yaf_Route_Rewrite</classname> - - array( - "type" => "rewrite", //route Yaf_Route_Rewrite - "match" => "/user-list/:id", //correspond uniquement à /user/list/?/ - "route" => array( - 'controller' => "user", //route vers le contrôleur user, - 'action' => "list", //route vers l'action list - ), - ), - ); - Yaf_Dispatcher::getInstance()->getRouter()->addConfig( - new Yaf_Config_Simple($config)); -?> -]]> - - &example.outputs.similar; - - "user", - "action" => "list", - "module" => "index", //(par défaut) -) - -/** - * et les paramètres de requête : - */ -array( - "id" => 22, -) -]]> - - - - Exemple avec <classname>Yaf_Route_Rewrite</classname> (à partir de 2.3.0) - - array( - "type" => "rewrite", - "match" => "/user-list/:a/:id", //correspond uniquement à /user-list/* - "route" => array( - 'controller' => "user", //route vers le contrôleur user, - 'action' => ":a", //route vers l'action :a - ), - ), - ); - Yaf_Dispatcher::getInstance()->getRouter()->addConfig( - new Yaf_Config_Simple($config)); -?> -]]> - - &example.outputs.similar; - - "user", - "action" => "list", - "module" => "index", //(par défaut) -) - -/** - * et les paramètres de requête : - */ -array( - "id" => 22, -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Router::addRoute - Yaf_Router::addConfig - Yaf_Route_Static - Yaf_Route_Supervar - Yaf_Route_Simple - Yaf_Route_Regex - Yaf_Route_Map - - - - - - diff --git a/reference/yaf/yaf_route_rewrite/route.xml b/reference/yaf/yaf_route_rewrite/route.xml deleted file mode 100644 index 3602c8f67c..0000000000 --- a/reference/yaf/yaf_route_rewrite/route.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Route_Rewrite::route - Route une requête - - - - &reftitle.description; - - public boolYaf_Route_Rewrite::route - Yaf_Request_Abstractrequest - - Route la requête en confrontant l'URI au masque fourni au constructeur. En cas de correspondance, le module, le contrôleur et l'action sont pris dans le tableau de route, où une valeur commençant par un deux-points est résolue à partir des variables correspondantes. - - - - &reftitle.parameters; - - - request - - L'instance de Yaf_Request_Abstract à router. - - - - - - - &reftitle.returnvalues; - Retourne &true; si l'URI correspond, &false; sinon, ce qui amène le routeur à essayer la route suivante. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Route_Rewrite::route</methodname> - - "product", // route vers le contrôleur product - ), - array() // aucune valeur par défaut -); - -var_dump($route->route($request)); - -var_dump($request->getControllerName()); -var_dump($request->getParam("name")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Rewrite::__construct - Yaf_Route_Rewrite::match - Yaf_Route_Rewrite::assemble - - - - - diff --git a/reference/yaf/yaf_route_simple/assemble.xml b/reference/yaf/yaf_route_simple/assemble.xml deleted file mode 100644 index dbfa25e448..0000000000 --- a/reference/yaf/yaf_route_simple/assemble.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Yaf_Route_Simple::assemble - Assemble une URL - - - - &reftitle.description; - - public stringYaf_Route_Simple::assemble - arrayinfo - arrayquery - - - Assemble une URL. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string;. - - - - - &reftitle.errors; - - Lance une Yaf_Exception_TypeError si les clés de - info ':c' ou - ':a' ne sont pas définies. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Route_Simple::assemble</function> - -addRoute("simple", $route); - -var_dump($router->getRoute('simple')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':c' => 'yafcontroller', - ':m' => 'yafmodule' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - )); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_simple/construct.xml b/reference/yaf/yaf_route_simple/construct.xml deleted file mode 100644 index 2e1db2b0fd..0000000000 --- a/reference/yaf/yaf_route_simple/construct.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Yaf_Route_Simple::__construct - Construit une route simple - - - - &reftitle.description; - - public Yaf_Route_Simple::__construct - stringmodule_name - stringcontroller_name - stringaction_name - - Construit une route simple. Une route simple lit les noms de module, de contrôleur et d'action dans les variables de la chaîne de requête nommées d'après les trois arguments. Par exemple, avec les arguments de constructeur module, controller et action, la route correspond à une requête telle que /?module=foo&controller=bar&action=list. - - - - &reftitle.parameters; - - - module_name - - Le nom de la variable de la chaîne de requête qui porte le nom du module. - - - - controller_name - - Le nom de la variable de la chaîne de requête qui porte le nom du contrôleur. - - - - action_name - - Le nom de la variable de la chaîne de requête qui porte le nom de l'action. - - - - - - - &reftitle.returnvalues; - Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Route_Simple::__construct</methodname> - -getRouter()->addRoute("simple", - new Yaf_Route_Simple("m", "c", "a") -); -?> -]]> - - &example.outputs.similar; - - "main", - "controller" => "product", - "action" => "detail", -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Simple::route - Yaf_Route_Simple::assemble - - - - - diff --git a/reference/yaf/yaf_route_simple/route.xml b/reference/yaf/yaf_route_simple/route.xml deleted file mode 100644 index 95c7c771ec..0000000000 --- a/reference/yaf/yaf_route_simple/route.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Route_Simple::route -Route une requête - - - - &reftitle.description; - - public boolYaf_Route_Simple::route - Yaf_Request_Abstractrequest - - Route la requête à l'aide des paramètres de la chaîne de requête : les noms de module, de contrôleur et d'action sont récupérés dans les variables de la chaîne de requête nommées d'après celles fournies au constructeur. - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract à router. - - - - - - &reftitle.returnvalues; -Retourne &true; si l'une des trois variables de la chaîne de requête est présente, &false; sinon, ce qui amène le routeur à essayer la route suivante. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Route_Simple::route</methodname> - -route($request)); - -var_dump($request->getModuleName()); -var_dump($request->getControllerName()); -var_dump($request->getActionName()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Simple::__construct - Yaf_Route_Simple::assemble - - - - - diff --git a/reference/yaf/yaf_route_static/assemble.xml b/reference/yaf/yaf_route_static/assemble.xml deleted file mode 100644 index e34457e146..0000000000 --- a/reference/yaf/yaf_route_static/assemble.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - Yaf_Route_Static::assemble - Assemble une URL - - - - &reftitle.description; - - public stringYaf_Route_Static::assemble - arrayinfo - arrayquery - - - Assemble une URL. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string;. - - - - - &reftitle.errors; - - Lance une Yaf_Exception_TypeError si les clés de - info ':c' et - ':a' ne sont pas définies. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Route_Static::assemble</function> - -addRoute("static", $route); - -var_dump($router->getRoute('static')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':c' => 'yafcontroller', - ':m' => 'yafmodule' - ), - ) -); - -var_dump($router->getRoute('static')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':c' => 'yafcontroller', - ':m' => 'yafmodule' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - ) -); - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_static/match.xml b/reference/yaf/yaf_route_static/match.xml deleted file mode 100644 index b577c95684..0000000000 --- a/reference/yaf/yaf_route_static/match.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Yaf_Route_Static::match -Détermine si la route correspond à une URI - - - - &reftitle.description; - - public boolYaf_Route_Static::match - stringuri - - Détermine si la route statique correspond à une URI. Comme la route statique correspond à n'importe quelle URI, cette méthode retourne toujours &true;. - - - - &reftitle.parameters; - - - uri - -L'URI à vérifier. - - - - - - &reftitle.returnvalues; -Retourne toujours &true;. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Route_Static::match</methodname> - -match("/product/detail/id/10")); -var_dump($route->match("/")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Static::route - - - - - diff --git a/reference/yaf/yaf_route_static/route.xml b/reference/yaf/yaf_route_static/route.xml deleted file mode 100644 index 923a295907..0000000000 --- a/reference/yaf/yaf_route_static/route.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -Yaf_Route_Static::route -Route une requête - - - - &reftitle.description; - - public boolYaf_Route_Static::route - Yaf_Request_Abstractrequest - - Route la requête suivant une URI de style PATH_INFO : le premier segment du chemin n'est traité comme le nom du module que s'il fait partie des modules enregistrés, sinon les segments sont associés dans l'ordre au contrôleur et à l'action. Les segments restants deviennent les paramètres de la requête. - Par exemple, en l'absence d'un module nommé foo, /foo/bar/age/10 route vers le contrôleur Foo, l'action bar, avec un paramètre age valant 10. - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract à router. - - - - - - &reftitle.returnvalues; -Retourne toujours &true;. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Route_Static::route</methodname> - -getRouter()->getRoute("_default"); -var_dump($route->route($request)); - -var_dump($request->getControllerName()); -var_dump($request->getActionName()); -var_dump($request->getParam("id")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Static::match - Yaf_Route_Static::assemble - - - - - diff --git a/reference/yaf/yaf_route_supervar/assemble.xml b/reference/yaf/yaf_route_supervar/assemble.xml deleted file mode 100644 index 50151c3c7d..0000000000 --- a/reference/yaf/yaf_route_supervar/assemble.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - Yaf_Route_Supervar::assemble - Assemble une URL - - - - &reftitle.description; - - public stringYaf_Route_Supervar::assemble - arrayinfo - arrayquery - - - Assemble une URL. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Retourne une &string;. - - - - - &reftitle.errors; - - Lance une Yaf_Exception_TypeError si les clés de - info ':c' et - ':a' ne sont pas définies. - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Route_Supervar::assemble</function> - -addRoute("supervar", $route); - -var_dump($router->getRoute('supervar')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':c' => 'yafcontroller', - ':m' => 'yafmodule' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) -)); - -try { -var_dump($router->getRoute('supervar')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':m' => 'yafmodule' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2', - 1 => array(), - ) -)); -} catch (Exception $e) { - var_dump($e->getMessage()); -} -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_supervar/construct.xml b/reference/yaf/yaf_route_supervar/construct.xml deleted file mode 100644 index 4a3b19ccec..0000000000 --- a/reference/yaf/yaf_route_supervar/construct.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - -Yaf_Route_Supervar::__construct -Construit une route supervar - - - - &reftitle.description; - - publicYaf_Route_Supervar::__construct - stringsupervar_name - - Construit une route supervar. Une route supervar attend qu'une variable de la chaîne de requête porte une URI de style PATH_INFO. - - - - &reftitle.parameters; - - - supervar_name - -Le nom de la variable de requête qui porte l'URI. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Route_Supervar::__construct</methodname> - -getRouter()->addRoute("supervar", - new Yaf_Route_Supervar("_url") -); -?> -]]> - - &example.outputs.similar; - - "product", - "module" => "index", //(par défaut) - "action" => "detail", //(par défaut) -) - -/** - * et les paramètres de requête : - */ -array( - "id" => 10 -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Supervar::route - Yaf_Route_Supervar::assemble - - - - - diff --git a/reference/yaf/yaf_route_supervar/route.xml b/reference/yaf/yaf_route_supervar/route.xml deleted file mode 100644 index 9d2ba6a53e..0000000000 --- a/reference/yaf/yaf_route_supervar/route.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Route_Supervar::route -Route une requête - - - - &reftitle.description; - - public boolYaf_Route_Supervar::route - Yaf_Request_Abstractrequest - - Route la requête à l'aide d'une super variable : la variable de requête nommée comme celle fournie au constructeur est censée contenir une URI de style PATH_INFO, qui est ensuite analysée comme le fait Yaf_Route_Static. - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract à router. - - - - - - &reftitle.returnvalues; -Retourne &true; si la variable est présente et contient une chaîne de caractères, &false; sinon, ce qui amène le routeur à essayer la route suivante. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Route_Supervar::route</methodname> - -route($request)); - -var_dump($request->getControllerName()); -var_dump($request->getActionName()); -var_dump($request->getParam("id")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Supervar::__construct - Yaf_Route_Supervar::assemble - - - - - diff --git a/reference/yaf/yaf_router/addconfig.xml b/reference/yaf/yaf_router/addconfig.xml deleted file mode 100644 index f8549c0b81..0000000000 --- a/reference/yaf/yaf_router/addconfig.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - Yaf_Router::addConfig - Ajoute les routes définies dans la configuration au routeur - - - - &reftitle.description; - - public boolYaf_Router::addConfig - Yaf_Config_Abstractconfig - - - Ajoute les routes définies dans les configurations - dans la pile des routes de la classe Yaf_Router. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une instance de la classe Yaf_Config_Abstract - qui doit contenir une ou plusieurs configurations de routes valides. - - - - - &reftitle.examples; - - Exemple avec <function>application.ini</function> - - - - - - Exemple avec <function>Yaf_Dispatcher::autoConfig</function> - -getConfig(); - Yaf_Registry::set("config", $config); - } - - public function _initRoute(Yaf_Dispatcher $dispatcher) { - $router = $dispatcher->getRouter(); - /** - * Nous pouvons ajouter quelques routes prédéfinies dans le - * fichier de configuration application.ini - */ - $router->addConfig(Yaf_Registry::get("config")->routes); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Router::addRoute - Yaf_Route_Static - Yaf_Route_Supervar - Yaf_Route_Simple - Yaf_Route_Regex - Yaf_Route_Rewrite - Yaf_Route_Map - - - - - - diff --git a/reference/yaf/yaf_router/addroute.xml b/reference/yaf/yaf_router/addroute.xml deleted file mode 100644 index 747fc743c2..0000000000 --- a/reference/yaf/yaf_router/addroute.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - Yaf_Router::addRoute - Ajoute une nouvelle route dans un routeur - - - - &reftitle.description; - - public boolYaf_Router::addRoute - stringname - Yaf_Route_Abstractroute - - - Par défaut, Yaf_Router utilise une instance de la classe - Yaf_Route_Static comme route par défaut. Il est possible - d'ajouter de nouvelles routes dans la pile des routes du routeur en appelant - cette méthode. - - - La nouvelle route sera appelée avant l'ancienne de la pile de routes, et si la - nouvelle route retourne &true;, le processus du routeur s'arrêtera. Sinon, - la ou les anciennes routes de la pile seront appelées. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <function>Yaf_Dispatcher::autoRender</function> - -getConfig(); - Yaf_Registry::set("config", $config); - } - - public function _initRoute(Yaf_Dispatcher $dispatcher) { - $router = $dispatcher->getRouter(); - /** - * Nous pouvons ajouter des routes définies dans le fichier de - * configuration application.ini - */ - $router->addConfig(Yaf_Registry::get("config")->routes); - /** - * Ajoute une route de réécriture, matchant la requête - * http://example.com/product/list/22/foo et dont le résultat sera : - * - * [module] => - * [controller] => product - * [action] => info - * [method] => GET - * [params:protected] => Array - * ( - * [id] => 22 - * [name] => foo - * ) - * - */ - $route = new Yaf_Route_Rewrite( - "/product/list/:id/:name", - array( - "controller" => "product", - "action" => "info", - ) - ); - - $router->addRoute('dummy', $route); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Router::addConfig - Yaf_Route_Static - Yaf_Route_Supervar - Yaf_Route_Simple - Yaf_Route_Regex - Yaf_Route_Rewrite - Yaf_Route_Map - - - - - - diff --git a/reference/yaf/yaf_router/construct.xml b/reference/yaf/yaf_router/construct.xml deleted file mode 100644 index bd2e9894da..0000000000 --- a/reference/yaf/yaf_router/construct.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Router::__construct - Constructeur de la classe Yaf_Router - - - - &reftitle.description; - - public Yaf_Router::__construct - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Router::__construct</methodname> - - Dans un usage normal, le routeur n'est pas construit manuellement, il - appartient au distributeur : - - -getRouter(); -var_dump($router); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Dispatcher::getRouter - Yaf_Router::addRoute - - - - - - diff --git a/reference/yaf/yaf_router/getcurrentroute.xml b/reference/yaf/yaf_router/getcurrentroute.xml deleted file mode 100644 index 59a963d7b9..0000000000 --- a/reference/yaf/yaf_router/getcurrentroute.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - Yaf_Router::getCurrentRoute - Récupère le nom de la route effective - - - - &reftitle.description; - - public stringYaf_Router::getCurrentRoute - - - - Récupère le nom de la route qui est effective dans le processus de routage. - - - Il est recommandé d'appeler cette méthode une fois le processus de routage - terminé, car avant cela, cette méthode retournera toujours &null;. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Une chaîne de caractères, le nom de la route effective. - - - - - &reftitle.examples; - - Enregistrement de quelques routes dans le Bootstrap - -getConfig(); - Yaf_Registry::set("config", $config); - } - - public function _initRoute(Yaf_Dispatcher $dispatcher) { - $router = $dispatcher->getRouter(); - $rewrite_route = new Yaf_Route_Rewrite( - "/product/list/:page", - array( - "controller" => "product", - "action" => "list", - ) - ); - - $regex_route = new Yaf_Route_Rewrite( - "#^/product/info/(\d+)", - array( - "controller" => "product", - "action" => "info", - ) - ); - - $router->addRoute('rewrite', $rewrite_route)->addRoute('regex', $regex_route); - } - - /** - * enregistre un plugin - */ - public function __initPlugins(Yaf_Dispatcher $dispatcher) { - $dispatcher->registerPlugin(new DummyPlugin()); - } -} -?> -]]> - - - - plugin Dummy.php (sous <link - linkend="configuration.yaf.directory">application.directory</link>/plugins) - -getRouter()->getCurrentRoute()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Bootstrap_Abstract - Yaf_Plugin_Abstract - Yaf_Router::addRoute - - - - - - diff --git a/reference/yaf/yaf_router/getroute.xml b/reference/yaf/yaf_router/getroute.xml deleted file mode 100644 index 195ae54db3..0000000000 --- a/reference/yaf/yaf_router/getroute.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Yaf_Router::getRoute - Récupère une route via son nom - - - - &reftitle.description; - - public Yaf_Route_InterfaceYaf_Router::getRoute - stringname - - - Récupère une route via son nom, voir aussi - Yaf_Router::getCurrentRoute - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Router::getRoute</methodname> - -getRouter(); - - $router->addRoute("rewrite", new Yaf_Route_Rewrite( - "/product/:id", - ["controller" => "product", "action" => "detail"] - )); - - /* vérifie ce qui a été enregistré sous un nom donné */ - var_dump($router->getRoute("rewrite")); - - /* un nom inconnu retourne NULL */ - var_dump($router->getRoute("unknown")); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Bootstrap_Abstract - Yaf_Plugin_Abstract - Yaf_Router::addRoute - Yaf_Router::getCurrentRoute - - - - - - diff --git a/reference/yaf/yaf_router/getroutes.xml b/reference/yaf/yaf_router/getroutes.xml deleted file mode 100644 index 64470bd381..0000000000 --- a/reference/yaf/yaf_router/getroutes.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Router::getRoutes - Récupère les routes enregistrées - - - - &reftitle.description; - - public mixedYaf_Router::getRoutes - - - - Récupère les routes enregistrées - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Router::getRoutes</methodname> - -getRouter(); - - $router->addRoute("rewrite", new Yaf_Route_Rewrite( - "/product/:id", - ["controller" => "product", "action" => "detail"] - )); - - /* outre la route personnalisée, la route "_default" native - fait aussi partie de la table de routage */ - var_dump(array_keys($router->getRoutes())); - } -} -?> -]]> - - &example.outputs.similar; - - - string(8) "_default" - [1]=> - string(7) "rewrite" -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Router::getRoute - Yaf_Router::addRoute - Yaf_Dispatcher::getRouter - - - - - - diff --git a/reference/yaf/yaf_router/route.xml b/reference/yaf/yaf_router/route.xml deleted file mode 100644 index d443d19ac6..0000000000 --- a/reference/yaf/yaf_router/route.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - -Yaf_Router::route -Route une requête - - - - &reftitle.description; - - public boolnullYaf_Router::route - Yaf_Request_Abstractrequest - - Route la requête avec les routes enregistrées. - Les routes sont essayées dans l'ordre inverse de leur enregistrement. La première route qui revendique la requête l'emporte ; la requête est alors marquée comme routée (voir Yaf_Request_Abstract::setRouted) et le nom de la route gagnante est enregistré, ce qui permet de le récupérer via Yaf_Router::getCurrentRoute. - La route par défaut, enregistrée sous le nom _default, est Yaf_Route_Static, sauf si une route par défaut personnalisée est configurée. - - - - &reftitle.parameters; - - - request - -L'instance de Yaf_Request_Abstract à router. - - - - - - &reftitle.returnvalues; -Retourne &true; si la requête a été routée, ou &false; si aucune route ne correspond (par exemple, une URI mal formée), ce qui arrête le distributeur. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Router::route</methodname> - -getRouter(); - - $router->addRoute("rewrite", new Yaf_Route_Rewrite( - "/product/:id", - ["controller" => "product", "action" => "detail"] - )); - - /* route une requête construite à la main, par exemple dans un test unitaire */ - $request = new Yaf_Request_Simple("CLI", null, "index.php", - "/product/123", null); - - if ($router->route($request)) { - var_dump($router->getCurrentRoute()); - var_dump($request->getControllerName()); - var_dump($request->getActionName()); - var_dump($request->getParam("id")); - } else { - /* aucune route ne correspond */ - } - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Router::addRoute - Yaf_Router::getCurrentRoute - Yaf_Dispatcher::dispatch - - - - - diff --git a/reference/yaf/yaf_session/construct.xml b/reference/yaf/yaf_session/construct.xml deleted file mode 100644 index 9d74f4c651..0000000000 --- a/reference/yaf/yaf_session/construct.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - -Yaf_Session::__construct -Le constructeur de Yaf_Session - - - - &reftitle.description; - - privateYaf_Session::__construct - - - Le constructeur est privé : Yaf_Session implémente le patron singleton et ne peut pas être instanciée directement. Il faut utiliser Yaf_Session::getInstance pour obtenir l'instance de session. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::__construct</methodname> - -start(); - -$session->set("user_id", 42); -echo $session->get("user_id"); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::getInstance - Yaf_Session::start - - - - - diff --git a/reference/yaf/yaf_session/count.xml b/reference/yaf/yaf_session/count.xml deleted file mode 100644 index b247095eed..0000000000 --- a/reference/yaf/yaf_session/count.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - -Yaf_Session::count -Compte les entrées de la session - - - - &reftitle.description; - - public intYaf_Session::count - - - Retourne le nombre d'entrées de la session. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Le nombre d'entrées de la session sous forme d'entier. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::count</methodname> - -start(); - -$session->set("user_id", 42); -$session->set("cart_items", 3); - -var_dump(count($session)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::has - - - - - diff --git a/reference/yaf/yaf_session/current.xml b/reference/yaf/yaf_session/current.xml deleted file mode 100644 index c912f19761..0000000000 --- a/reference/yaf/yaf_session/current.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Session::current -Récupère la valeur de l'entrée de session courante - - - - &reftitle.description; - - public mixedYaf_Session::current - - - Retourne la valeur de l'entrée de session courante lors de l'itération. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -La valeur de l'entrée de session courante. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::current</methodname> - -start(); - -$session->set("user_id", 42); -$session->set("is_vip", true); - -foreach ($session as $key => $value) { - // Yaf_Session::current() fournit chaque valeur lors de l'itération - echo "$key => "; - var_dump($value); -} -?> -]]> - - &example.outputs.similar; - - int(42) -is_vip => bool(true) -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::key - Yaf_Session::next - Yaf_Session::rewind - Yaf_Session::valid - - - - - diff --git a/reference/yaf/yaf_session/del.xml b/reference/yaf/yaf_session/del.xml deleted file mode 100644 index 1c65e3fddc..0000000000 --- a/reference/yaf/yaf_session/del.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Session::del -Supprime une clé de session - - - - &reftitle.description; - - public boolYaf_Session::del - stringname - - Supprime une clé de session et sa valeur. - - - - &reftitle.parameters; - - - name - -La clé de session à supprimer. - - - - - - &reftitle.returnvalues; -Retourne &true; en cas de succès, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::del</methodname> - -start(); - - $expected = $session->get("captcha_code"); - - // code à usage unique : le supprimer juste après utilisation - $session->del("captcha_code"); - - if ($expected === null - || $this->getRequest()->getPost("code") !== $expected) { - echo "captcha invalide"; - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::set - Yaf_Session::has - - - - - diff --git a/reference/yaf/yaf_session/get.xml b/reference/yaf/yaf_session/get.xml deleted file mode 100644 index 26e0a9d2ba..0000000000 --- a/reference/yaf/yaf_session/get.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Session::get -Récupère une valeur de session - - - - &reftitle.description; - - public mixedYaf_Session::get - stringnameNULL - - Récupère une valeur de session par son nom. Si name est omis ou vaut &null;, le tableau de session complet est retourné. - - - - &reftitle.parameters; - - - name - -La clé de session à récupérer, ou &null; pour obtenir toutes les données de session. - - - - - - &reftitle.returnvalues; -La valeur de session, ou &null; si la clé n'existe pas. Lorsque name vaut &null;, le tableau de session complet est retourné. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::get</methodname> - -start(); - - $userId = $session->get("user_id"); - if ($userId === null) { - return $this->redirect("/account/login"); - } - - echo "bon retour, utilisateur n°", $userId; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::set - Yaf_Session::has - Yaf_Session::del - - - - - diff --git a/reference/yaf/yaf_session/getinstance.xml b/reference/yaf/yaf_session/getinstance.xml deleted file mode 100644 index 1a4952bc9f..0000000000 --- a/reference/yaf/yaf_session/getinstance.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Session::getInstance -Récupère le singleton de session - - - - &reftitle.description; - - public static Yaf_SessionYaf_Session::getInstance - - - Retourne l'instance singleton de Yaf_Session, en la créant si nécessaire. La session est démarrée automatiquement au premier accès. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -L'instance singleton de Yaf_Session, ou &null; si la session n'a pas pu être démarrée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::getInstance</methodname> - -start(); -$session->set("user_id", 42); - -// ... plus tard, ailleurs dans l'application -$same = Yaf_Session::getInstance(); - -var_dump($same === $session); -var_dump($same->get("user_id")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::start - Yaf_Session::get - Yaf_Session::set - - - - - diff --git a/reference/yaf/yaf_session/has.xml b/reference/yaf/yaf_session/has.xml deleted file mode 100644 index 83d2ca3a34..0000000000 --- a/reference/yaf/yaf_session/has.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Session::has -Vérifie si une clé de session existe - - - - &reftitle.description; - - public boolYaf_Session::has - stringname - - Vérifie si une clé de session existe. - - - - &reftitle.parameters; - - - name - -La clé de session à vérifier. - - - - - - &reftitle.returnvalues; -Retourne &true; si la clé existe, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::has</methodname> - -start(); - - if (!$session->has("user_id")) { - $this->redirect("/account/login"); - return false; - } - - return true; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::set - Yaf_Session::del - - - - - diff --git a/reference/yaf/yaf_session/isset.xml b/reference/yaf/yaf_session/isset.xml deleted file mode 100644 index 747f48d1cd..0000000000 --- a/reference/yaf/yaf_session/isset.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - -Yaf_Session::__isset -Vérifie si une clé de session existe - - - - &reftitle.description; - - public boolYaf_Session::__isset - stringname - - Vérifie si une clé de session existe. Cette méthode est un alias de Yaf_Session::has et est appelée lorsque isset() est utilisé sur un objet session. - - - - &reftitle.parameters; - - - name - -La clé de session à vérifier. - - - - - - &reftitle.returnvalues; -Retourne &true; si la clé existe, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::__isset</methodname> - -start(); - -$session->user_id = 42; - -var_dump(isset($session->user_id)); -var_dump(isset($session->user_name)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::has - Yaf_Session::get - - - - - diff --git a/reference/yaf/yaf_session/key.xml b/reference/yaf/yaf_session/key.xml deleted file mode 100644 index 016f2a39f8..0000000000 --- a/reference/yaf/yaf_session/key.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Yaf_Session::key -Récupère la clé de l'entrée de session courante - - - - &reftitle.description; - - public mixedYaf_Session::key - - - Retourne la clé de l'entrée de session courante lors d'une itération. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -La clé de l'entrée de session courante. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::key</methodname> - -start(); - -$session->set("user_id", 42); -$session->set("lang", "en"); - -for ($session->rewind(); $session->valid(); $session->next()) { - echo $session->key(), " => ", var_export($session->current(), true), PHP_EOL; -} -?> -]]> - - &example.outputs.similar; - - 42 -lang => 'en' -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::current - Yaf_Session::next - Yaf_Session::rewind - Yaf_Session::valid - - - - - diff --git a/reference/yaf/yaf_session/next.xml b/reference/yaf/yaf_session/next.xml deleted file mode 100644 index 3ea9051946..0000000000 --- a/reference/yaf/yaf_session/next.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Session::next -Avance à l'entrée de session suivante - - - - &reftitle.description; - - public voidYaf_Session::next - - - Déplace l'itérateur interne sur l'entrée de session suivante. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::next</methodname> - -start(); - -$session->set("user_id", 42); -$session->set("lang", "en"); - -$session->rewind(); -echo $session->key(), PHP_EOL; - -$session->next(); -echo $session->key(), PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::current - Yaf_Session::key - Yaf_Session::rewind - Yaf_Session::valid - - - - - diff --git a/reference/yaf/yaf_session/offsetexists.xml b/reference/yaf/yaf_session/offsetexists.xml deleted file mode 100644 index 3e1978363e..0000000000 --- a/reference/yaf/yaf_session/offsetexists.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - -Yaf_Session::offsetExists -Vérifie si une clé de session existe (ArrayAccess) - - - - &reftitle.description; - - public boolYaf_Session::offsetExists - mixedname - - Vérifie si une clé de session existe. Cette méthode est un alias de Yaf_Session::has et est appelée lorsque isset() est utilisé avec la syntaxe de tableau. - - - - &reftitle.parameters; - - - name - -La clé de session à vérifier. - - - - - - &reftitle.returnvalues; -Retourne &true; si la clé existe, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::offsetExists</methodname> - -start(); - -$session["user_id"] = 42; - -var_dump(isset($session["user_id"])); -var_dump(isset($session["user_name"])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::has - Yaf_Session::offsetGet - - - - - diff --git a/reference/yaf/yaf_session/offsetget.xml b/reference/yaf/yaf_session/offsetget.xml deleted file mode 100644 index b504b669ec..0000000000 --- a/reference/yaf/yaf_session/offsetget.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Session::offsetGet -Récupère une valeur de session (ArrayAccess) - - - - &reftitle.description; - - public mixedYaf_Session::offsetGet - mixedname - - Récupère une valeur de session à partir d'une clé. Cette méthode est un alias de Yaf_Session::get et est appelée lorsque la syntaxe de tableau est utilisée pour lire un objet session. - - - - &reftitle.parameters; - - - name - -La clé de session à récupérer. - - - - - - &reftitle.returnvalues; -La valeur de session, ou &null; si la clé n'existe pas. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::offsetGet</methodname> - -start(); - - // la lecture avec la syntaxe de tableau appelle offsetGet() - $userId = $session["user_id"]; - if ($userId === null) { - return $this->redirect("/account/login"); - } - - echo "connecté en tant qu'utilisateur #", $userId; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::offsetSet - Yaf_Session::offsetUnset - - - - - diff --git a/reference/yaf/yaf_session/offsetset.xml b/reference/yaf/yaf_session/offsetset.xml deleted file mode 100644 index 6a2b2eee12..0000000000 --- a/reference/yaf/yaf_session/offsetset.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - -Yaf_Session::offsetSet -Définit une valeur de session (ArrayAccess) - - - - &reftitle.description; - - public voidYaf_Session::offsetSet - mixedname - mixedvalue - - Définit une valeur de session. Cette méthode est appelée lorsque la syntaxe de tableau est utilisée pour écrire dans un objet session. - - - - &reftitle.parameters; - - - name - -La clé de session à définir. - - - - value - -La valeur à stocker. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::offsetSet</methodname> - -start(); - - // l'écriture avec la syntaxe de tableau appelle offsetSet() - $session["user_id"] = $user->getId(); - $session["login_time"] = time(); - - return $this->redirect("/dashboard"); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::set - Yaf_Session::offsetGet - Yaf_Session::offsetUnset - - - - - diff --git a/reference/yaf/yaf_session/offsetunset.xml b/reference/yaf/yaf_session/offsetunset.xml deleted file mode 100644 index 9c4194fbc9..0000000000 --- a/reference/yaf/yaf_session/offsetunset.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Session::offsetUnset -Supprime une clé de session (ArrayAccess) - - - - &reftitle.description; - - public voidYaf_Session::offsetUnset - mixedname - - Supprime une clé de session et sa valeur. Cette méthode est appelée lorsque unset() est utilisé avec la syntaxe de tableau sur un objet session. - - - - &reftitle.parameters; - - - name - -La clé de session à supprimer. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::offsetUnset</methodname> - -start(); - -$session["captcha_code"] = "8X2Q"; - -// ... après vérification du captcha, suppression du code à usage unique -unset($session["captcha_code"]); - -var_dump(isset($session["captcha_code"])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::del - Yaf_Session::offsetGet - Yaf_Session::offsetSet - - - - - diff --git a/reference/yaf/yaf_session/rewind.xml b/reference/yaf/yaf_session/rewind.xml deleted file mode 100644 index b1cca53297..0000000000 --- a/reference/yaf/yaf_session/rewind.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Session::rewind -Réinitialise l'itérateur de session sur la première entrée - - - - &reftitle.description; - - public voidYaf_Session::rewind - - - Replace l'itérateur interne sur la première entrée de session. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::rewind</methodname> - -start(); - -$session->set("user_id", 42); -$session->set("lang", "en"); - -foreach ($session as $key => $value) { - echo "$key => $value", PHP_EOL; -} - -// un nouveau foreach appelle implicitement rewind() à nouveau -foreach ($session as $key => $value) { - echo "$key => $value", PHP_EOL; -} -?> -]]> - - &example.outputs.similar; - - 42 -lang => en -user_id => 42 -lang => en -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::current - Yaf_Session::key - Yaf_Session::next - Yaf_Session::valid - - - - - diff --git a/reference/yaf/yaf_session/set.xml b/reference/yaf/yaf_session/set.xml deleted file mode 100644 index 4b88f350a0..0000000000 --- a/reference/yaf/yaf_session/set.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - -Yaf_Session::set -Définit une valeur de session - - - - &reftitle.description; - - public boolYaf_Session::set - stringname - mixedvalue - - Définit une valeur de session. - - - - &reftitle.parameters; - - - name - -La clé de session à définir. - - - - value - -La valeur à stocker. - - - - - - &reftitle.returnvalues; -Retourne &true; en cas de succès, ou &false; si une erreur survient. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::set</methodname> - -start(); - - $session->set("user_id", $user->getId()); - $session->set("login_time", time()); - - return $this->redirect("/dashboard"); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::has - Yaf_Session::del - - - - - diff --git a/reference/yaf/yaf_session/start.xml b/reference/yaf/yaf_session/start.xml deleted file mode 100644 index 0cff9962d6..0000000000 --- a/reference/yaf/yaf_session/start.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - -Yaf_Session::start -Démarre la session - - - - &reftitle.description; - - public Yaf_SessionYaf_Session::start - - - Démarre la session si elle n'a pas encore été démarrée. Cela appelle le mécanisme natif de démarrage de session de PHP. Appeler cette méthode plusieurs fois est sans danger. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne l'instance de Yaf_Session. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::start</methodname> - -start(); - -$session->set("user_id", 42); -echo $session->get("user_id"); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::getInstance - - - - - diff --git a/reference/yaf/yaf_session/unset.xml b/reference/yaf/yaf_session/unset.xml deleted file mode 100644 index febba494c0..0000000000 --- a/reference/yaf/yaf_session/unset.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - -Yaf_Session::__unset -Supprime une clé de session - - - - &reftitle.description; - - public voidYaf_Session::__unset - stringname - - Supprime une clé de session et sa valeur. Cette méthode est appelée lorsque unset() est utilisé sur une propriété d'un objet de session. - - - - &reftitle.parameters; - - - name - -La clé de session à supprimer. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::__unset</methodname> - -start(); - -$session->user_id = 42; - -// ... lorsque l'utilisateur se déconnecte -unset($session->user_id); - -var_dump(isset($session->user_id)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::del - Yaf_Session::offsetUnset - - - - - diff --git a/reference/yaf/yaf_session/valid.xml b/reference/yaf/yaf_session/valid.xml deleted file mode 100644 index 5f0560fb52..0000000000 --- a/reference/yaf/yaf_session/valid.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Session::valid -Vérifie si la position courante de la session est valide - - - - &reftitle.description; - - public boolYaf_Session::valid - - - Vérifie si la position courante de l'itérateur de session est valide. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Retourne &true; si la position courante est valide, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_Session::valid</methodname> - -start(); - -$session->set("user_id", 42); - -$session->rewind(); -var_dump($session->valid()); - -$session->next(); -// au-delà de la dernière entrée, la position n'est plus valide -var_dump($session->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::current - Yaf_Session::key - Yaf_Session::next - Yaf_Session::rewind - - - - - diff --git a/reference/yaf/yaf_view_interface/assign.xml b/reference/yaf/yaf_view_interface/assign.xml deleted file mode 100644 index d3d6a85524..0000000000 --- a/reference/yaf/yaf_view_interface/assign.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - -Yaf_View_Interface::assign -Assigne une variable à la vue - - - - &reftitle.description; - - abstract public boolYaf_View_Interface::assign - mixedname - mixedvalueNULL - - Assigne une variable à la vue. Les variables assignées sont disponibles dans le template sous leur nom. - - - - &reftitle.parameters; - - - name - -Le nom sous lequel la variable devient disponible dans le template. - - - - value - -La valeur à assigner. - - - - - - &reftitle.returnvalues; -La valeur de retour est définie par l'implémentation concrète. Yaf_View_Simple, le moteur de vue par défaut, retourne l'instance de la vue. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Interface::assign</methodname> - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* branchement du moteur de vue personnalisé sur le distributeur dans le bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::display - Yaf_View_Interface::render - Yaf_View_Interface::setScriptPath - Yaf_View_Interface::getScriptPath - - - - - diff --git a/reference/yaf/yaf_view_interface/display.xml b/reference/yaf/yaf_view_interface/display.xml deleted file mode 100644 index f6a4fad956..0000000000 --- a/reference/yaf/yaf_view_interface/display.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - -Yaf_View_Interface::display -Construit et affiche un template - - - - &reftitle.description; - - abstract public boolYaf_View_Interface::display - stringtpl - arraytpl_varsNULL - - Construit un template et envoie le résultat directement sur la sortie. - - - - &reftitle.parameters; - - - tpl - -Le chemin vers le template, relatif au dossier des templates. - - - - tpl_vars - -Variables optionnelles à assigner uniquement pour ce template ; elles remplacent les variables assignées portant le même nom. - - - - - - &reftitle.returnvalues; -Retourne &true; en cas de succès, ou &false; en cas d'échec. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Interface::display</methodname> - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* branchement du moteur de vue personnalisé sur le distributeur dans le bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::render - Yaf_View_Interface::assign - Yaf_View_Interface::setScriptPath - Yaf_View_Interface::getScriptPath - - - - - diff --git a/reference/yaf/yaf_view_interface/getscriptpath.xml b/reference/yaf/yaf_view_interface/getscriptpath.xml deleted file mode 100644 index 91d748a20b..0000000000 --- a/reference/yaf/yaf_view_interface/getscriptpath.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - -Yaf_View_Interface::getScriptPath -Récupère le dossier des templates - - - - &reftitle.description; - - abstract public stringYaf_View_Interface::getScriptPath - - - Récupère le dossier dans lequel les templates sont recherchés. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Le dossier des templates sous forme de chaîne de caractères, ou &null; s'il n'a pas encore été défini. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Interface::getScriptPath</methodname> - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* branche le moteur de vue personnalisé sur le distributeur dans le bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::setScriptPath - Yaf_View_Interface::render - Yaf_View_Interface::display - - - - - diff --git a/reference/yaf/yaf_view_interface/render.xml b/reference/yaf/yaf_view_interface/render.xml deleted file mode 100644 index a31d787c89..0000000000 --- a/reference/yaf/yaf_view_interface/render.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - -Yaf_View_Interface::render -Effectue le rendu d'un template - - - - &reftitle.description; - - abstract public stringYaf_View_Interface::render - stringtpl - arraytpl_varsNULL - - Effectue le rendu d'un template et retourne le résultat sous forme de chaîne de caractères au lieu de l'afficher. - - - - &reftitle.parameters; - - - tpl - -Le chemin vers le template, relatif au dossier des templates. - - - - tpl_vars - -Variables optionnelles à affecter pour ce seul template ; elles remplacent les variables affectées portant le même nom. - - - - - - &reftitle.returnvalues; -Le résultat du rendu sous forme de chaîne de caractères, ou &false; en cas d'échec. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Interface::render</methodname> - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* branche le moteur de vue personnalisé sur le distributeur dans le bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::display - Yaf_View_Interface::assign - Yaf_View_Interface::setScriptPath - Yaf_View_Interface::getScriptPath - - - - - diff --git a/reference/yaf/yaf_view_interface/setscriptpath.xml b/reference/yaf/yaf_view_interface/setscriptpath.xml deleted file mode 100644 index ca884ab8ae..0000000000 --- a/reference/yaf/yaf_view_interface/setscriptpath.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - -Yaf_View_Interface::setScriptPath -Définit le dossier des templates - - - - &reftitle.description; - - abstract public Yaf_View_InterfaceYaf_View_Interface::setScriptPath - stringtemplate_dir - - Définit le dossier dans lequel les templates sont recherchés. - - - - &reftitle.parameters; - - - template_dir - -Le dossier dans lequel les scripts de template sont stockés. - - - - - - &reftitle.returnvalues; -Retourne l'instance de la vue, ou &false; si template_dir n'est pas un chemin absolu. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Interface::setScriptPath</methodname> - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* branche le moteur de vue personnalisé sur le distributeur dans le bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::getScriptPath - Yaf_View_Interface::render - Yaf_View_Interface::display - - - - - diff --git a/reference/yaf/yaf_view_simple/assign.xml b/reference/yaf/yaf_view_simple/assign.xml deleted file mode 100644 index cf29312cac..0000000000 --- a/reference/yaf/yaf_view_simple/assign.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - -Yaf_View_Simple::assign -Assigne une variable à la vue - - - - &reftitle.description; - - public boolYaf_View_Simple::assign - mixedname - mixedvalueNULL - - Assigne une variable à la vue. Les variables assignées sont disponibles dans le template sous leur nom. - Lors d'un appel avec un unique argument de type tableau, chaque paire clé/valeur est assignée, les clés devenant les noms des variables. - - - - &reftitle.parameters; - - - name - -Le nom sous lequel la variable devient disponible dans le template, ou un tableau de variables à assigner. - - - - value - -La valeur à assigner. - - - - - - &reftitle.returnvalues; -Retourne &true;. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Simple::assign</methodname> - -getView()->assign("foo", "bar"); - $this->_view->assign(array("key" => "value", "name" => "value")); - } -} -?> -]]> - - - - Exemple de template - - - - <?php echo $foo; ?> - - - _tpl_vars as $name => $value) { - echo $$name; // ou echo $this->_tpl_vars[$name]; - } - ?> - - -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assignRef - Yaf_View_Simple::clear - Yaf_View_Simple::get - - - - - diff --git a/reference/yaf/yaf_view_simple/assignref.xml b/reference/yaf/yaf_view_simple/assignref.xml deleted file mode 100644 index 32ee10df9b..0000000000 --- a/reference/yaf/yaf_view_simple/assignref.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - -Yaf_View_Simple::assignRef -Alias de Yaf_View_Simple::assign - - - - &reftitle.description; - - public boolYaf_View_Simple::assignRef - stringname - mixedvalue - - Affecte une variable à la vue par référence. Contrairement à Yaf_View_Simple::assign, la valeur est passée par référence, si bien que les modifications ultérieures de la variable de l'appelant deviennent visibles dans le template. - - - - &reftitle.parameters; - - - name - -Le nom sous lequel la variable devient disponible dans le template. - - - - value - -La valeur à affecter. - - - - - - &reftitle.returnvalues; -Retourne &true;. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Simple::assignRef</methodname> - -getView()->assignRef("foo", $value); - - /* les modifications ultérieures de $value sont visibles dans le template, - * car la variable a été affectée par référence */ - $value = "changed"; - - //empêche le rendu automatique - Yaf_Dispatcher::getInstance()->autoRender(false); - } -} -?> -]]> - - - - Exemple de template - - - - <?php echo $foo; ?> - - - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::clear - Yaf_View_Simple::get - - - - - diff --git a/reference/yaf/yaf_view_simple/clear.xml b/reference/yaf/yaf_view_simple/clear.xml deleted file mode 100644 index 7fd7719ff3..0000000000 --- a/reference/yaf/yaf_view_simple/clear.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - -Yaf_View_Simple::clear -Supprime une variable assignée - - - - &reftitle.description; - - public boolYaf_View_Simple::clear - stringnameNULL - - Supprime une variable assignée de la vue. - Lorsque la méthode est appelée sans argument, toutes les variables assignées sont supprimées. - - - - &reftitle.parameters; - - - name - -Le nom de la variable à supprimer, ou omis/&null; pour supprimer toutes les variables assignées. - - - - - - &reftitle.returnvalues; -Retourne &true;. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Simple::clear</methodname> - -getView()->clear("foo")->clear("bar"); // supprime "foo" et "bar" - $this->_view->clear(); // supprime toutes les variables assignées - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::get - - - - - diff --git a/reference/yaf/yaf_view_simple/construct.xml b/reference/yaf/yaf_view_simple/construct.xml deleted file mode 100644 index 7cb5031dd5..0000000000 --- a/reference/yaf/yaf_view_simple/construct.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_View_Simple::__construct -Constructeur de Yaf_View_Simple - - - - &reftitle.description; - - publicYaf_View_Simple::__construct - stringtemplate_dir - arrayoptionsNULL - - Yaf_View_Simple est le moteur de vue par défaut, et le seul que Yaf fournit nativement. Une instance est créée automatiquement par Yaf_Dispatcher au démarrage de l'application ; il n'est nécessaire de l'instancier directement que pour effectuer un rendu de templates en dehors du flux de distribution. - L'argument template_dir doit pointer vers un dossier existant contenant les scripts de vue ; il devient le chemin des scripts de la vue et peut être modifié par la suite avec Yaf_View_Simple::setScriptPath. - - - - &reftitle.parameters; - - - template_dir - -Le dossier dans lequel sont stockés les scripts de template. - - - - options - -Options facultatives de la vue, sous forme de tableau. Réservé aux implémentations personnalisées de moteur de vue ; le moteur natif l'accepte mais ne l'utilise pas. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Simple::__construct</methodname> - -assign("name", "world"); -echo $view->render("greeting.phtml"); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::render - Yaf_View_Simple::display - Yaf_View_Simple::setScriptPath - - - - - diff --git a/reference/yaf/yaf_view_simple/display.xml b/reference/yaf/yaf_view_simple/display.xml deleted file mode 100644 index 81124b082f..0000000000 --- a/reference/yaf/yaf_view_simple/display.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -Yaf_View_Simple::display -Effectue le rendu d'un template et le stocke dans la réponse - - - - &reftitle.description; - - public boolYaf_View_Simple::display - stringtpl - arrayvarsNULL - - Effectue le rendu d'un template et ajoute le résultat au corps de Yaf_Response_Abstract. - - Contrairement à Yaf_View_Simple::render, le résultat n'est pas retourné mais stocké dans la réponse, et Yaf_Application l'envoie au moment de l'émission de la réponse. - - - - - &reftitle.parameters; - - - tpl - -Le chemin du template, relatif au dossier de templates défini par Yaf_View_Simple::setScriptPath ou par application.view.directory. - - - - vars - -Variables facultatives à assigner pour ce seul template ; elles remplacent les variables assignées portant le même nom. - - - - - - &reftitle.returnvalues; -Retourne &true; en cas de succès, ou &false; si une erreur survient. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Simple::display</methodname> - -getView()->assign("title", "Ma page d'accueil"); - - /* effectue le rendu de index/index.phtml et stocke le résultat - * dans le corps de la réponse */ - $this->getView()->display("index/index.phtml"); - - return false; // le rendu a été fait ici, on ignore le rendu automatique - } -} -?> -]]> - - - - Exemple de template - - - - <?php echo $title; ?> - - -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::render - Yaf_View_Simple::assign - - - - - diff --git a/reference/yaf/yaf_view_simple/eval.xml b/reference/yaf/yaf_view_simple/eval.xml deleted file mode 100644 index 28ff256950..0000000000 --- a/reference/yaf/yaf_view_simple/eval.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_View_Simple::eval -Effectue le rendu d'une chaîne de template - - - - &reftitle.description; - - public stringYaf_View_Simple::eval - stringtpl_content - arrayvarsNULL - - Effectue le rendu d'un template fourni sous forme de chaîne et retourne le résultat. - - Aucun fichier de template n'étant impliqué, le dossier de templates n'est pas consulté. - - - - - &reftitle.parameters; - - - tpl_content - -Le contenu du template sous forme de chaîne. - - - - vars - -Variables facultatives à assigner pour ce rendu ; elles remplacent les variables assignées portant le même nom. - - - - - - &reftitle.returnvalues; -Le résultat du rendu sous forme de chaîne, ou &false; si une erreur survient. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Simple::eval</methodname> - -"; - - /* effectue le rendu de la chaîne de template sans accéder au système de fichiers */ - $html = $this->getView()->eval($template, array("title" => "Dernière minute")); - - $this->getResponse()->setBody($html); - return false; // ignore le rendu automatique - } -} -?> -]]> - - &example.outputs.similar; - -Dernière minute]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::render - Yaf_View_Simple::display - - - - - diff --git a/reference/yaf/yaf_view_simple/get.xml b/reference/yaf/yaf_view_simple/get.xml deleted file mode 100644 index 8953a49405..0000000000 --- a/reference/yaf/yaf_view_simple/get.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_View_Simple::get -Récupère une variable assignée - - - - &reftitle.description; - - public mixedYaf_View_Simple::get - stringnameNULL - - Récupère une variable précédemment assignée à la vue. - Lorsque la méthode est appelée sans argument, toutes les variables assignées sont retournées. - - - - &reftitle.parameters; - - - name - -Le nom de la variable à récupérer, ou paramètre omis/&null; pour récupérer toutes les variables assignées. - - - - - - &reftitle.returnvalues; -La valeur assignée sous le nom name, ou &null; s'il n'existe aucune variable portant ce nom. Lorsque la méthode est appelée sans argument, un tableau de toutes les variables assignées est retourné. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Simple::get</methodname> - -getView(); - $view->assign("foo", "bar"); - - var_dump($view->get("foo")); - var_dump($view->get()); // toutes les variables assignées - } -} -?> -]]> - - &example.outputs.similar; - - - string(3) "bar" -}]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::clear - - - - - diff --git a/reference/yaf/yaf_view_simple/getscriptpath.xml b/reference/yaf/yaf_view_simple/getscriptpath.xml deleted file mode 100644 index 60531ede8b..0000000000 --- a/reference/yaf/yaf_view_simple/getscriptpath.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - -Yaf_View_Simple::getScriptPath -Récupère le dossier des templates - - - - &reftitle.description; - - public stringYaf_View_Simple::getScriptPath - - - Récupère le dossier dans lequel les templates sont recherchés. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Le dossier des templates sous forme de chaîne de caractères, ou &null; s'il n'a pas encore été défini. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Simple::getScriptPath</methodname> - -getView()->getScriptPath(); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_View_Simple::setScriptPath - - - - - diff --git a/reference/yaf/yaf_view_simple/isset.xml b/reference/yaf/yaf_view_simple/isset.xml deleted file mode 100644 index 9febefc0b3..0000000000 --- a/reference/yaf/yaf_view_simple/isset.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_View_Simple::__isset -Vérifie si une variable est assignée - - - - &reftitle.description; - - public boolYaf_View_Simple::__isset - stringname - - Vérifie si une variable est assignée à la vue. Cette méthode est appelée lorsque isset() est utilisée sur un objet vue. - - - - &reftitle.parameters; - - - name - -Le nom de la variable à vérifier. - - - - - - &reftitle.returnvalues; -Retourne &true; si une variable est assignée sous le nom name, &false; sinon. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Simple::__isset</methodname> - -getView(); - $view->assign("title", "Bienvenue"); - - var_dump(isset($view->title)); - var_dump(isset($view->unknown)); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::get - Yaf_View_Simple::clear - - - - - diff --git a/reference/yaf/yaf_view_simple/render.xml b/reference/yaf/yaf_view_simple/render.xml deleted file mode 100644 index 3b15e76a67..0000000000 --- a/reference/yaf/yaf_view_simple/render.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - -Yaf_View_Simple::render -Rend un template - - - - &reftitle.description; - - public stringYaf_View_Simple::render - stringtpl - arrayvarsNULL - - Rend un template et retourne le résultat sous forme de chaîne de caractères. Le template est inclus comme un simple script PHP, si bien que tout code PHP qu'il contient est exécuté, et que les variables assignées sont disponibles sous leur nom. - - Contrairement à Yaf_View_Simple::display, le résultat est retourné au lieu d'être ajouté au corps de Yaf_Response_Abstract. - - - - - &reftitle.parameters; - - - tpl - -Le chemin vers le template, relatif au dossier des templates défini par Yaf_View_Simple::setScriptPath ou par application.view.directory. - - - - vars - -Variables optionnelles à assigner pour ce rendu ; elles remplacent les variables assignées portant le même nom. - - - - - - &reftitle.returnvalues; -Le résultat du rendu sous forme de chaîne de caractères, ou &false; en cas d'échec. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Simple::render</methodname> - -getView()->render("product/detail.phtml", array( - "name" => "Yaf in Action", - "price" => "29.90", - )); - - $this->getResponse()->setBody($html); - return false; // désactive le rendu automatique - } -} -?> -]]> - - - - Exemple de template - - -

    Prix : EUR

    -]]> -     - &example.outputs.similar; - -Yaf in Action -

    Prix : 29.90 EUR

    ]]> -     -     -     - - - &reftitle.seealso; - - Yaf_View_Simple::display - Yaf_View_Simple::eval - Yaf_View_Simple::assign - - -     - - diff --git a/reference/yaf/yaf_view_simple/set.xml b/reference/yaf/yaf_view_simple/set.xml deleted file mode 100644 index e5cacbb93e..0000000000 --- a/reference/yaf/yaf_view_simple/set.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - -Yaf_View_Simple::__set -Affecte une variable via l'écriture d'une propriété - - - - &reftitle.description; - - public voidYaf_View_Simple::__set - stringname - mixedvalue - - Affecte une variable à la vue. Cette méthode est appelée lors de l'écriture d'une propriété d'un objet de vue, et se comporte de la même manière que Yaf_View_Simple::assign. - - - - &reftitle.parameters; - - - name - -Le nom sous lequel la variable devient disponible dans le modèle. - - - - value - -La valeur à affecter. - - - - - - &reftitle.returnvalues; -Aucune valeur n'est retournée. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Simple::__set</methodname> - -getView()->foo = "bar"; // identique à assign("foo", "bar"); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::get - - - - - diff --git a/reference/yaf/yaf_view_simple/setscriptpath.xml b/reference/yaf/yaf_view_simple/setscriptpath.xml deleted file mode 100644 index aa49f3ac16..0000000000 --- a/reference/yaf/yaf_view_simple/setscriptpath.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Yaf_View_Simple::setScriptPath -Définit le répertoire des modèles - - - - &reftitle.description; - - public Yaf_View_SimpleYaf_View_Simple::setScriptPath - stringtemplate_dir - - Définit le répertoire dans lequel les modèles sont recherchés. - - - - &reftitle.parameters; - - - template_dir - -Le répertoire où sont stockés les scripts de modèle. - - - - - - &reftitle.returnvalues; -Retourne l'instance de la vue, ou &false; si template_dir n'est pas un chemin absolu. - - - - &reftitle.examples; - - Exemple avec <methodname>Yaf_View_Simple::setScriptPath</methodname> - -getView()->setScriptPath(APPLICATION_PATH . "/modules/admin/views"); - - $this->getView()->display("dashboard/index.phtml"); - - return false; // le rendu a été fait manuellement, on saute le rendu automatique - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::getScriptPath - - - - - diff --git a/reference/yaml/book.xml b/reference/yaml/book.xml deleted file mode 100644 index d5576b4dad..0000000000 --- a/reference/yaml/book.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - Sérialisation de données YAML - Yaml - - - - &reftitle.intro; - - Cette extension donne accès au standard de sérialisation - YAML Ain't Markup Language (YAML). - L'analyse syntaxique et la production de données sont effectuées - par la bibliothèque LibYAML. - - - - - &reference.yaml.setup; - &reference.yaml.constants; - &reference.yaml.examples; - &reference.yaml.callbacks; - &reference.yaml.reference; - - - - - diff --git a/reference/yaml/callbacks.xml b/reference/yaml/callbacks.xml deleted file mode 100644 index 53ab1942c6..0000000000 --- a/reference/yaml/callbacks.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - Callbacks - -
    - Analyse des fonctions de rappel - - L'analyse des fonctions de rappel callable est invoquée par - les fonctions - yaml_parse, yaml_parse_file ou - yaml_parse_url lorsqu'une balise YAML enregistrée est - rencontrée. La fonction de rappel est appelée avec la valeur de l'entité - de la balise, la balise, et les drapeaux indiquant le type scalaire de - l'entité. La fonction de rappel doit retourner les données que l'analyseur YAML - doit émettre pour cette entité. - - - Exemple d'analyse de fonction de rappel - - 'tag_callback', - )); - -var_dump($result); -?> -]]> - - &example.outputs.similar; - - - string(5) "World" - [1]=> - string(14) "!example/hello" - [2]=> - int(1) -} -array(1) { - ["greeting"]=> - string(11) "Hello World" -} -]]> - - -
    - -
    - Émission des fonctions de rappel - - L'émission des fonctions de rappel est invoquée lorsqu'une instance - d'une classe enregistrée est émise via la fonction yaml_emit ou - la fonction yaml_emit_file. La fonction de rappel - reçoit l'objet à émettre. La fonction de rappel doit retourner un tableau - contenant 2 clés : - "tag" et "data". - La valeur associée avec la clé "tag" doit être une - chaîne à utiliser comme balise YAML dans la sortie. La valeur associée - avec la clé "data" sera encodée YAML et émise - à la place de l'objet intercepté. - - - Exemple d'émission des fonctions de rappel - -data = $d; - } - - /** - * Yaml émet une fonction de rappel, référencée par un appel à yaml_emit par le nom de la classe - * - * Il est attendu de retourner un tableau contenant 2 valeurs : - * - 'tag': balise personnalisée pour cette sérialisation - * - 'data': valeur à convertir en yaml (array, string, bool, number) - * - * @param object $obj Objet à émettre - * @return array Balise et données associées à émettre - */ - public static function yamlEmit (EmitExample $obj) { - return array( - 'tag' => '!example/emit', - 'data' => $obj->data, - ); - } -} - -$emit_callbacks = array( - 'EmitExample' => array('EmitExample', 'yamlEmit') -); - -$t = new EmitExample(array('a','b','c')); -$yaml = yaml_emit( - array( - 'example' => $t, - ), - YAML_ANY_ENCODING, - YAML_ANY_BREAK, - $emit_callbacks -); -var_dump($yaml); -?> -]]> - - &example.outputs.similar; - - - - -
    - -     - - diff --git a/reference/yaml/constants.xml b/reference/yaml/constants.xml deleted file mode 100644 index f9e0c18bd0..0000000000 --- a/reference/yaml/constants.xml +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - - Styles scalaires utilisés par les fonctions de rappel de - <function>yaml_parse</function> - - - YAML_ANY_SCALAR_STYLE - (int) - - - - - - - - - YAML_PLAIN_SCALAR_STYLE - (int) - - - - - - - - - YAML_SINGLE_QUOTED_SCALAR_STYLE - (int) - - - - - - - - - YAML_DOUBLE_QUOTED_SCALAR_STYLE - (int) - - - - - - - - - YAML_LITERAL_SCALAR_STYLE - (int) - - - - - - - - - YAML_FOLDED_SCALAR_STYLE - (int) - - - - - - - - - - Tags utilisables pour les fonctions de rappel - <function>yaml_parse</function> - - - YAML_NULL_TAG - (string) - - - - "tag:yaml.org,2002:null" - - - - - - YAML_BOOL_TAG - (string) - - - - "tag:yaml.org,2002:bool" - - - - - - YAML_STR_TAG - (string) - - - - "tag:yaml.org,2002:str" - - - - - - YAML_INT_TAG - (string) - - - - "tag:yaml.org,2002:int" - - - - - - YAML_FLOAT_TAG - (string) - - - - "tag:yaml.org,2002:float" - - - - - - YAML_TIMESTAMP_TAG - (string) - - - - "tag:yaml.org,2002:timestamp" - - - - - - YAML_SEQ_TAG - (string) - - - - "tag:yaml.org,2002:seq" - - - - - - YAML_MAP_TAG - (string) - - - - "tag:yaml.org,2002:map" - - - - - - YAML_PHP_TAG - (string) - - - - "!php/object" - - - - - - - Types d'encodages pour <function>yaml_emit</function> - - - YAML_ANY_ENCODING - (int) - - - - Laisse l'émetteur choisir l'encodage. - - - - - - YAML_UTF8_ENCODING - (int) - - - - Encode en UTF8. - - - - - - YAML_UTF16LE_ENCODING - (int) - - - - Encode en UTF16LE. - - - - - - YAML_UTF16BE_ENCODING - (int) - - - - Encode en UTF16BE. - - - - - - - Types de coupure de lignes pour <function>yaml_emit</function> - - - YAML_ANY_BREAK - (int) - - - - Laisse l'émetteur choisir le caractère de coupure de ligne. - - - - - - YAML_CR_BREAK - (int) - - - - Utilise \r comme caractère de coupure (style Mac). - - - - - - YAML_LN_BREAK - (int) - - - - Utilise \n comme caractère de coupure (style Unix). - - - - - - YAML_CRLN_BREAK - (int) - - - - Utilise \r\n comme caractère de coupure (style DOS). - - - - - - - - - diff --git a/reference/yaml/examples.xml b/reference/yaml/examples.xml deleted file mode 100644 index 2db5ae1c00..0000000000 --- a/reference/yaml/examples.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - &reftitle.examples; - - Exemples Yaml - - "Chris", - "family"=> "Dumars", - "address"=> array( - "lines"=> "458 Walkman Dr. - Suite #292", - "city"=> "Royal Oak", - "state"=> "MI", - "postal"=> 48046, - ), - ); -$invoice = array ( - "invoice"=> 34843, - "date"=> "2001-01-23", - "bill-to"=> $addr, - "ship-to"=> $addr, - "product"=> array( - array( - "sku"=> "BL394D", - "quantity"=> 4, - "description"=> "Basketball", - "price"=> 450, - ), - array( - "sku"=> "BL4438H", - "quantity"=> 1, - "description"=> "Super Hoop", - "price"=> 2392, - ), - ), - "tax"=> 251.42, - "total"=> 4443.52, - "comments"=> "Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.", - ); - -// génère une représentation YAML de la facture -$yaml = yaml_emit($invoice); -var_dump($yaml); - -// convertit la syntaxe YAML vers une variable PHP -$parsed = yaml_parse($yaml); - -// vérifie que la conversion a produit une structure équivalente -var_dump($parsed == $invoice); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/yaml/functions/yaml-emit-file.xml b/reference/yaml/functions/yaml-emit-file.xml deleted file mode 100644 index 5c530e9f1e..0000000000 --- a/reference/yaml/functions/yaml-emit-file.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - - yaml_emit_file - Envoie une représentation YAML vers un fichier - - - - &reftitle.description; - - boolyaml_emit_file - stringfilename - mixeddata - intencodingYAML_ANY_ENCODING - intlinebreakYAML_ANY_BREAK - arraycallbacks&null; - - - Génère une représentation YAML de la donnée data - dans le fichier filename. - - - - - &reftitle.parameters; - - - - filename - - - Chemin vers un fichier. - - - - - data - - - Donnée à encoder. Peut être de tout type sauf resource. - - - - - encoding - - - Encodage des caractères en sortie choisi parmi - YAML_ANY_ENCODING, - YAML_UTF8_ENCODING, - YAML_UTF16LE_ENCODING, - YAML_UTF16BE_ENCODING. - - - - - linebreak - - - Caractère de fin de ligne choisi parmi - YAML_ANY_BREAK, - YAML_CR_BREAK, - YAML_LN_BREAK, - YAML_CRLN_BREAK. - - - - - callbacks - - - Gestionnaires de contenu pour l'émission de nœud YAML. - Doit être un tableau associatif de paires "nom de classe" => - callable. Voir - l'émission de fonctions de rappel - pour plus de détails. - - - - - - - - - &reftitle.returnvalues; - - Retourne &true; en cas de succès. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL yaml 1.1.0 - - Le paramètre callbacks a été ajouté. - - - - - - - - - - &reftitle.seealso; - - - yaml_emit - yaml_parse - - - - - - - diff --git a/reference/yaml/functions/yaml-emit.xml b/reference/yaml/functions/yaml-emit.xml deleted file mode 100644 index 4b389967a5..0000000000 --- a/reference/yaml/functions/yaml-emit.xml +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - - - yaml_emit - Retourne une chaîne représentant une valeur YAML - - - - &reftitle.description; - - stringyaml_emit - mixeddata - intencodingYAML_ANY_ENCODING - intlinebreakYAML_ANY_BREAK - arraycallbacks&null; - - - Génère une représentation YAML de la donnée data. - - - - - &reftitle.parameters; - - - - data - - - Les données à encoder. Peut être de tout type sauf resource. - - - - - encoding - - - Encodage des caractères en sortie choisi parmi - YAML_ANY_ENCODING, - YAML_UTF8_ENCODING, - YAML_UTF16LE_ENCODING, - YAML_UTF16BE_ENCODING. - - - - - linebreak - - - Caractère de fin de ligne choisi parmi - YAML_ANY_BREAK, - YAML_CR_BREAK, - YAML_LN_BREAK, - YAML_CRLN_BREAK. - - - - - callbacks - - - Gestionnaires de contenu pour l'émission de nœud YAML. - Doit être un tableau associatif de paires "nom de classe" => - callable. Voir - l'émission de fonctions de rappel - pour plus de détails. - - - - - - - - - &reftitle.returnvalues; - - Retourne une chaîne YAML en cas de succès. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL yaml 1.1.0 - - Le paramètre callbacks a été ajouté. - - - - - - - - - - &reftitle.examples; - - - Exemple <function>yaml_emit</function> - - "Chris", - "family"=> "Dumars", - "address"=> array( - "lines"=> "458 Walkman Dr. - Suite #292", - "city"=> "Royal Oak", - "state"=> "MI", - "postal"=> 48046, - ), - ); -$invoice = array ( - "invoice"=> 34843, - "date"=> 980208000, - "bill-to"=> $addr, - "ship-to"=> $addr, - "product"=> array( - array( - "sku"=> "BL394D", - "quantity"=> 4, - "description"=> "Basketball", - "price"=> 450, - ), - array( - "sku"=> "BL4438H", - "quantity"=> 1, - "description"=> "Super Hoop", - "price"=> 2392, - ), - ), - "tax"=> 251.42, - "total"=> 4443.52, - "comments"=> "Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.", - ); -var_dump(yaml_emit($invoice)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - yaml_emit_file - yaml_parse - - - - - - - diff --git a/reference/yaml/functions/yaml-parse-file.xml b/reference/yaml/functions/yaml-parse-file.xml deleted file mode 100644 index 1cc3dd0131..0000000000 --- a/reference/yaml/functions/yaml-parse-file.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - - yaml_parse_file - Analyse un flux YAML depuis un fichier - - - - &reftitle.description; - - mixedyaml_parse_file - stringfilename - intpos0 - intndocs - arraycallbacks&null; - - - Convertit tout ou partie d'un document YAML provenant d'un fichier vers une - variable PHP. - - - - - &reftitle.parameters; - - - - filename - - - Chemin vers le fichier. - - - - - pos - - - Le document à extraire du flux (-1 pour tous les - documents, 0 pour le premier, ...). - - - - - ndocs - - - Si ndocs est fourni, alors il est rempli avec - le nombre de documents trouvés dans le flux. - - - - - callbacks - - - Analyseurs de contenu pour les nœuds YAML. Tableau associatif tag YAML - => callable. Voir - l'analyse des fonctions de rappel - pour plus de détails. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur encodée de filename dans le type PHP - approprié. - - - En cas d'échec, une chaîne contenant un message d'erreur est retournée. - - - Si pos vaut -1, un array - sera retourné avec une entrée pour chaque document trouvé dans le flux. - - - - - &reftitle.notes; - - - Le fait de traiter une entrée utilisateur non sécurisée avec - yaml_parse_file est dangereux si l'utilisation de - unserialize est activée pour les nœuds utilisant - la balise !php/object. Ce comportement peut être - désactivé en utilisant la configuration ini - yaml.decode_php. - - - - - - &reftitle.seealso; - - - yaml_parse - yaml_parse_url - yaml_emit - - - - - - - diff --git a/reference/yaml/functions/yaml-parse-url.xml b/reference/yaml/functions/yaml-parse-url.xml deleted file mode 100644 index aa73128e2a..0000000000 --- a/reference/yaml/functions/yaml-parse-url.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - yaml_parse_url - Analyse un flux YAML depuis une URL - - - - &reftitle.description; - - mixedyaml_parse_url - stringurl - intpos0 - intndocs - arraycallbacks&null; - - - Convertit tout ou partie d'un document YAML provenant d'une URL vers une - variable PHP. - - - - - &reftitle.parameters; - - - - url - - - url doit être de la forme "scheme://...". PHP - cherchera le protocole pour cette URL. Si aucun protocole n'a été - enregistré pour ce flux, PHP émettra une notice pour aider à - trouver le problème et continuera. - - - - - pos - - - Le document à extraire du flux (-1 pour tous les - documents, 0 pour le premier, ...). - - - - - ndocs - - - Si ndocs est fourni, alors il est rempli avec - le nombre de documents trouvés dans le flux. - - - - - callbacks - - - Analyseurs de contenu pour les nœuds YAML. Tableau associatif tag YAML - => callable. Voir - l'analyse des fonctions de rappel - pour plus d'informations. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur encodée de url dans le type PHP - approprié&return.falseforfailure;. - Si pos vaut -1, un tableau sera retourné - avec pour chaque valeur, un document trouvé dans le flux. - - - - - &reftitle.notes; - - - Le fait de traiter une entrée utilisateur non sécurisée avec - yaml_parse_url est dangereux si l'utilisation de - unserialize est activée pour les nœuds utilisant - la balise !php/object. Ce comportement peut être - désactivé en utilisant la configuration ini - yaml.decode_php. - - - - - - &reftitle.seealso; - - - yaml_parse - yaml_parse_file - yaml_emit - - - - - - - diff --git a/reference/yaml/functions/yaml-parse.xml b/reference/yaml/functions/yaml-parse.xml deleted file mode 100644 index 7540c62544..0000000000 --- a/reference/yaml/functions/yaml-parse.xml +++ /dev/null @@ -1,255 +0,0 @@ - - - - - - - - yaml_parse - Analyse un flux YAML - - - - &reftitle.description; - - mixedyaml_parse - stringinput - intpos0 - intndocs - arraycallbacks&null; - - - Convertit tout ou partie d'un document YAML provenant d'une chaîne vers une - variable PHP. - - - - - &reftitle.parameters; - - - - input - - - La chaîne à analyser comme document YAML. - - - - - pos - - - Le document à extraire du flux (-1 pour tous les - documents, 0 pour le premier, ...). - - - - - ndocs - - - Si le paramètre ndocs est fourni, alors il est - rempli avec le nombre de documents trouvés dans le flux. - - - - - callbacks - - - Analyseurs de contenu pour les nœuds YAML. Tableau associatif tag YAML - => callable. Voir - l'analyse des fonctions de rappel - pour plus d'informations. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur encodée de input dans le type PHP - approprié&return.falseforfailure;. - Si pos vaut -1, un tableau sera retourné - avec pour chaque valeur un document trouvé dans le flux. - - - - - &reftitle.examples; - - - Exemple <function>yaml_parse</function> - - -]]> - - &example.outputs.similar; - - - int(34843) - ["date"]=> - string(10) "2001-01-23" - ["bill-to"]=> - &array(3) { - ["given"]=> - string(5) "Chris" - ["family"]=> - string(6) "Dumars" - ["address"]=> - array(4) { - ["lines"]=> - string(34) "458 Walkman Dr. - Suite #292" - ["city"]=> - string(9) "Royal Oak" - ["state"]=> - string(2) "MI" - ["postal"]=> - int(48046) - } - } - ["ship-to"]=> - &array(3) { - ["given"]=> - string(5) "Chris" - ["family"]=> - string(6) "Dumars" - ["address"]=> - array(4) { - ["lines"]=> - string(34) "458 Walkman Dr. - Suite #292" - ["city"]=> - string(9) "Royal Oak" - ["state"]=> - string(2) "MI" - ["postal"]=> - int(48046) - } - } - ["product"]=> - array(2) { - [0]=> - array(4) { - ["sku"]=> - string(6) "BL394D" - ["quantity"]=> - int(4) - ["description"]=> - string(10) "Basketball" - ["price"]=> - int(450) - } - [1]=> - array(4) { - ["sku"]=> - string(7) "BL4438H" - ["quantity"]=> - int(1) - ["description"]=> - string(10) "Super Hoop" - ["price"]=> - int(2392) - } - } - ["tax"]=> - float(251.42) - ["total"]=> - float(4443.52) - ["comments"]=> - string(68) "Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338." -} -]]> - - - - - - - &reftitle.notes; - - - Le fait de traiter une entrée utilisateur non sécurisée avec - yaml_parse est dangereux si l'utilisation de - unserialize est activée pour les nœuds utilisant - la balise !php/object. Ce comportement peut être - désactivé en utilisant la configuration ini - yaml.decode_php. - - - - - - &reftitle.seealso; - - - yaml_parse_file - yaml_parse_url - yaml_emit - - - - - - - diff --git a/reference/yaml/ini.xml b/reference/yaml/ini.xml deleted file mode 100644 index 74d633770e..0000000000 --- a/reference/yaml/ini.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; Yaml - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yaml.decode_binary - 0 - INI_ALL - - - - yaml.decode_php - 0 - INI_ALL - Ajouté dans la version 1.2.0, avant la version 2.0.0 la valeur par défaut était 1 - - - yaml.decode_timestamp - 0 - INI_ALL - - - - yaml.output_canonical - 0 - INI_ALL - - - - yaml.output_indent - 2 - INI_ALL - - - - yaml.output_width - 80 - INI_ALL - - - - -
    -     - - &ini.descriptions.title; - - - - - - yaml.decode_binary - bool - - - - Off par défaut ; si mis à on, permet le décodage des entités binaires - base64 ayant le tag explicite "tag:yaml.org,2002:binary". - - - - - - yaml.decode_php - bool - - - - Désactivé par défaut, mais peut être activé pour causer la désérialisation des objets PHP sérialisés ayant la balise explicite "!php/object". - - - - - - yaml.decode_timestamp - int - - - - Contrôle le décodage des scalaires implicites et explicites - "tag:yaml.org,2002:timestamp" dans le flux du document YAML. - La valeur par défaut est 0, elle n'appliquera - aucun décodage. Mis à 1, strtotime - sera utilisé pour analyser le timestamp comme un timestamp Unix. - Mis à 2, date_create sera utilisée - pour analyser le timestamp via un objet DateTime. - - - - - - yaml.output_canonical - bool - - - - Off par défaut ; si mis à on, une sortie canonique sera utilisée. - - - - - - yaml.output_indent - int - - - - Nombre d'espaces pour l'indentation. Un entier entre - 1 et 10 est requis. - - - - - - yaml.output_width - int - - - - Précise la largeur de ligne. -1 signifie illimité. - - - - - -
    diff --git a/reference/yaml/reference.xml b/reference/yaml/reference.xml deleted file mode 100644 index 1d2a827ab9..0000000000 --- a/reference/yaml/reference.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - &Functions; Yaml - - &reference.yaml.entities.functions; - - - - - diff --git a/reference/yaml/setup.xml b/reference/yaml/setup.xml deleted file mode 100644 index afdbe34f14..0000000000 --- a/reference/yaml/setup.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Cette extension nécessite la bibliothèque - C LibYAML en version 0.1.0 ou plus pour être installée. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yaml. - -
    - - - &reference.yaml.ini; - - -     - - - diff --git a/reference/yar/book.xml b/reference/yar/book.xml deleted file mode 100644 index 125c15cdea..0000000000 --- a/reference/yar/book.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Yet Another RPC Framework - Yar - - - &reftitle.intro; - - Yar (Yet another RPC framework) est un framework RPC léger et concurrent - qui a pour but de fournir une façon simple et aisée de communiquer entre - applications PHP. Il peut également émettre plusieurs appels vers des - services distants simultanément. - - - Yar est une extension PHP native plutôt qu'une bibliothèque utilisateur. - Elle utilise un protocole binaire compact au-dessus de HTTP, HTTPS ou TCP - et est fournie avec trois empaqueteurs intégrés (php, - json et, lorsqu'elle est compilée avec - , - msgpack), de sorte qu'aucun paquet supplémentaire ni - processus mandataire n'est requis. - - - Le protocole est agnostique vis-à-vis du langage, les services peuvent - donc être consommés par n'importe quel langage ; voir - Le protocole Yar pour les détails. - - - - &reference.yar.protocol; - &reference.yar.setup; - &reference.yar.constants; - &reference.yar.examples; - &reference.yar.yar-server; - &reference.yar.yar-client; - &reference.yar.yar-concurrent-client; - &reference.yar.yar-server-exception; - &reference.yar.yar-server-output-exception; - &reference.yar.yar-server-packager-exception; - &reference.yar.yar-server-protocol-exception; - &reference.yar.yar-server-request-exception; - - &reference.yar.yar-client-exception; - &reference.yar.yar-client-packager-exception; - &reference.yar.yar-client-protocol-exception; - &reference.yar.yar-client-transport-exception; - - - - diff --git a/reference/yar/configure.xml b/reference/yar/configure.xml deleted file mode 100644 index f2c4a890e1..0000000000 --- a/reference/yar/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;yar - - -
    - - - diff --git a/reference/yar/constants.xml b/reference/yar/constants.xml deleted file mode 100644 index c4b43c73f8..0000000000 --- a/reference/yar/constants.xml +++ /dev/null @@ -1,356 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - YAR_VERSION - (string) - - - - La version de l'extension Yar, par exemple - "2.4.0". - - - - - - YAR_HAS_MSGPACK - (int) - - - - 1 lorsque Yar a été compilé avec - , sinon - 0. - - - - - - YAR_CLIENT_PROTOCOL_HTTP - (int) - - - - Identifie le protocole HTTP, exposé via la propriété en lecture - seule _protocol de - Yar_Client. - - - - - - YAR_CLIENT_PROTOCOL_TCP - (int) - - - - Identifie le protocole TCP, exposé via la propriété en lecture - seule _protocol de - Yar_Client. - - - - - - YAR_CLIENT_PROTOCOL_UNIX - (int) - - - - Identifie le protocole des sockets Unix, exposé via la propriété en - lecture seule _protocol de - Yar_Client. - - - - - - YAR_OPT_PACKAGER - (int) - - - - Option de client permettant de surcharger la directive - yar.packager - pour un seul client. La valeur doit être l'une des suivantes : - php, json ou - msgpack. - - - - - - YAR_OPT_PERSISTENT - (int) - - - - Option de client permettant d'activer les connexions persistantes. - Lorsqu'elle vaut une valeur vraie, le keep-alive HTTP est utilisé - afin que les appels répétés vers le même serveur réutilisent la - connexion pendant tout le reste du cycle de vie de la requête PHP. - - - - - - YAR_OPT_TIMEOUT - (int) - - - - Option de client permettant de surcharger la directive - yar.timeout, en - millisecondes. - - - - - - YAR_OPT_CONNECT_TIMEOUT - (int) - - - - Option de client permettant de surcharger la directive - yar.connect_timeout, - en millisecondes. - - - - - - YAR_OPT_HEADER - (int) - - - - Option de client permettant d'ajouter des en-têtes HTTP - personnalisés. La valeur doit être un tableau de chaînes de - caractères de la forme - "X-Custom: value". Effective uniquement avec les - protocoles HTTP et HTTPS. Disponible à partir de Yar 2.0.4. - - - - - - YAR_OPT_RESOLVE - (int) - - - - Option de client permettant de surcharger la résolution des noms - d'hôte pour les appels HTTP. La valeur doit être un tableau de - chaînes de caractères au format - HOST:PORT:ADDRESS, suivant la syntaxe - CURLOPT_RESOLVE de curl. Nécessite libcurl - >= 7.21.3. Disponible à partir de Yar 2.1.0. - - - - - - YAR_OPT_PROXY - (int) - - - - Option de client permettant de faire transiter les appels HTTP par - un proxy HTTP. La valeur doit être une chaîne de caractères telle - que 127.0.0.1:8888. - Disponible à partir de Yar 2.2.0. - - - - - - YAR_OPT_PROVIDER - (int) - - - - Option de client portant l'identité du fournisseur envoyée avec - chaque requête. La valeur doit être une chaîne de caractères d'au - plus 32 octets, qui est transmise à la méthode magique - __auth côté serveur. - Disponible à partir de Yar 2.3.0. - - - - - - YAR_OPT_TOKEN - (int) - - - - Option de client portant le jeton d'authentification envoyé avec - chaque requête. La valeur doit être une chaîne de caractères d'au - plus 32 octets, qui est transmise à la méthode magique - __auth côté serveur. - Disponible à partir de Yar 2.3.0. - - - - - - YAR_PACKAGER_PHP - (string) - - - - L'identifiant de l'empaqueteur php, - "PHP". - - - - - - YAR_PACKAGER_JSON - (string) - - - - L'identifiant de l'empaqueteur json, - "JSON". - - - - - - YAR_PACKAGER_MSGPACK - (string) - - - - L'identifiant de l'empaqueteur msgpack, - "MSGPACK". - - - - - - YAR_ERR_OKEY - (int) - - - - Aucune erreur ; la requête a été traitée avec succès. - - - - - - YAR_ERR_PACKAGER - (int) - - - - Une erreur d'empaquetage, par exemple un corps qui n'a pas pu être - désempaqueté. - - - - - - YAR_ERR_PROTOCOL - (int) - - - - Une erreur de protocole, par exemple un en-tête Yar mal formé. - - - - - - YAR_ERR_REQUEST - (int) - - - - Une erreur de requête, par exemple un appel à une méthode non - définie ou non publique. - - - - - - YAR_ERR_OUTPUT - (int) - - - - Une erreur de sortie, par exemple le serveur n'a pas pu démarrer son - tampon de sortie. - - - - - - YAR_ERR_TRANSPORT - (int) - - - - Une erreur de transport, par exemple un échec de connexion ou un - dépassement de délai. - - - - - - YAR_ERR_EXCEPTION - (int) - - - - Le service distant a levé une exception lors du traitement de la - requête. - - - - - - YAR_ERR_FORBIDDEN - (int) - - - - La requête a été rejetée par l'authentification du serveur - (voir les champs provider et - token de - l'en-tête du protocole Yar). - - - - - - - diff --git a/reference/yar/examples.xml b/reference/yar/examples.xml deleted file mode 100644 index 638760c95f..0000000000 --- a/reference/yar/examples.xml +++ /dev/null @@ -1,229 +0,0 @@ - - - - - &reftitle.examples; - - Les exemples ci-dessous décrivent un service complet : un serveur qui - expose quelques méthodes arithmétiques, un client synchrone qui les - appelle, un client qui parallélise plusieurs appels, et un client qui - dialogue avec un serveur via TCP. - - - - Exemple de serveur Yar - - Un service Yar est simplement une classe PHP ordinaire enveloppée par - Yar_Server. Chaque méthode publique de l'objet - devient un point d'entrée RPC ; les méthodes protégées et privées, ainsi - que celles dont le nom commence par un tiret bas, restent cachées aux - clients. Les commentaires de documentation des méthodes publiques sont - collectés et affichés sur la page d'information du service. - - - Les requêtes RPC arrivent comme des requêtes HTTP POST portant un payload - binaire au format du protocole Yar, donc le script est habituellement - mappé à un URI sur un serveur web classique. - - -_add($a, $b); - } - - /** - * Sub - */ - public function sub($a, $b) { - return $a - $b; - } - - /** - * Mul - */ - public function mul($a, $b) { - return $a * $b; - } - - /** - * Les méthodes protégées ne seront pas exposées - * @param integer - * @return integer - */ - protected function _add($a, $b) { - return $a + $b; - } -} - -$server = new Yar_Server(new Operator()); -$server->handle(); -?> -]]> - - - - - Accès au serveur depuis un navigateur (requête GET) - - Lorsqu'une requête GET est envoyée à l'URI du service — par exemple en - l'ouvrant dans un navigateur — Yar n'effectue pas d'appel RPC mais - affiche une page d'information listant chaque méthode publique de l'objet - exécuteur accompagnée de son commentaire de documentation. Ceci est - contrôlé par la directive - yar.expose_info ; quand elle - est désactivée, une requête GET échoue à la place. - - &example.outputs.similar; - - Information du serveur Yar - - - - - - - - Exemple de client Yar - - Un Yar_Client est lié à une seule adresse de - service. Appeler n'importe quelle méthode non définie dessus est - transparentement transformé en appel RPC synchrone, les méthodes distantes - se comportant donc comme des méthodes locales ; - Yar_Client::call fait la même chose explicitement - par nom. - - - Les méthodes protégées ne sont pas exposées : les appeler échoue avec une - Yar_Client_Exception dont le code est - YAR_ERR_REQUEST. - - -add(1, 2)); - -/* appel via call() */ -var_dump($client->call("add", array(3, 2))); - -/* _add ne peut pas être appelée : elle n'est pas publique */ -var_dump($client->_add(1, 2)); -?> -]]> - - &example.outputs.similar; - - - - - - - Exemple de client Yar concurrent - - Au lieu d'appeler les services l'un après l'autre, - Yar_Concurrent_Client enregistre d'abord plusieurs - appels, puis les dispatch tous en même temps avec - Yar_Concurrent_Client::loop. Les réponses sont - passées au callback dans l'ordre où elles arrivent, pas dans l'ordre où - les appels ont été enregistrés. - - - Juste après que toutes les requêtes ont été envoyées, le callback est - invoqué une fois avec des arguments &null; pour signaler à l'appelant - qu'aucune requête n'est plus en attente ; l'exemple ci-dessous vérifie - cette notification. - - - -]]> - - &example.outputs.similar; - - - - - - - Exemple de client Yar TCP - - Outre HTTP, Yar_Client peut dialoguer avec des - serveurs compatibles Yar via TCP ou des sockets Unix, par exemple un - service implémenté avec le - framework Yar en C, - qui utilise le même protocole binaire Yar que le serveur PHP. - - -add(1, 2)); -?> -]]> - - - - - - diff --git a/reference/yar/ini.xml b/reference/yar/ini.xml deleted file mode 100644 index becf53735b..0000000000 --- a/reference/yar/ini.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; Yar - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yar.connect_timeout - 1000 - INI_ALL - - - - yar.content_type - application/octet-stream - INI_ALL - - - - yar.debug - Off - INI_ALL - - - - yar.expose_info - On - INI_PERDIR - - - - yar.packager - php - INI_PERDIR - - - - yar.ssl_verify - Off - INI_ALL - - - - yar.timeout - 5000 - INI_ALL - - - - -
    -     - - &ini.descriptions.title; - - - - - - yar.connect_timeout - int - - - - Délai maximal de connexion, en millisecondes, pour les appels HTTP - émis par Yar_Client et - Yar_Concurrent_Client. - - - - Cette valeur est interprétée en millisecondes. Dans les versions - antérieures à Yar 1.2.1, elle était exprimée en secondes (la valeur - par défaut était 1). - - - - - - - yar.content_type - string - - - - La valeur de l'en-tête de réponse Content-Type - envoyé par Yar_Server. Yar utilise un - protocole binaire, la valeur par défaut est donc - application/octet-stream. - - - - - - yar.debug - bool - - - - Active le mode de débogage. Lorsqu'il est actif, Yar émet des - messages E_WARNING détaillant le protocole pour - chaque requête et chaque réponse, préfixés par - [Debug Yar_Server] ou - [Debug Yar_Client] et un horodatage. - - - - - - yar.expose_info - bool - - - - Indique si Yar_Server::handle affiche la page - d'informations du service pour les requêtes non POST (généralement - GET). Lorsque cette directive est désactivée, de telles requêtes - lèvent une Yar_Server_Exception à la - place. - - - - - - yar.packager - string - - - - L'empaqueteur par défaut utilisé pour sérialiser le corps des requêtes - et des réponses. Les valeurs valides sont php - (sérialisation PHP), json et - msgpack (uniquement lorsque Yar a été compilé avec - ). - - - Lorsque Yar est compilé avec le support de msgpack, la valeur par - défaut devient msgpack. - - - Cette valeur peut être surchargée pour chaque client avec l'option - YAR_OPT_PACKAGER. - - - - - - yar.ssl_verify - bool - - - - Indique s'il faut vérifier le certificat TLS des serveurs HTTPS. - Lorsque cette directive est active, le transport curl définit - CURLOPT_SSL_VERIFYPEER et - CURLOPT_SSL_VERIFYHOST, et les requêtes vers des - serveurs dont le certificat est invalide échouent. Désactivée par - défaut pour des raisons de compatibilité ascendante. Disponible à - partir de Yar 2.4.0. - - - - - - yar.timeout - int - - - - Délai maximal, en millisecondes, pour les appels RPC émis par - Yar_Client et - Yar_Concurrent_Client. - - - - - - -
    - - diff --git a/reference/yar/protocol.xml b/reference/yar/protocol.xml deleted file mode 100644 index fdd12649d6..0000000000 --- a/reference/yar/protocol.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - Le protocole Yar - - Yar ne s'appuie pas sur un schéma ou un fichier IDL : tout est échangé - sur le réseau sous forme d'octets bruts. N'importe quel langage capable - de lire et d'écrire des octets peut communiquer avec un service Yar, sans - installer aucun framework — il suffit de construire un en-tête binaire de - taille fixe et un corps de requête sérialisé, de les envoyer à l'URI du - service, et d'analyser la réponse. - - - Un message se compose d'un en-tête de taille fixe de 82 octets suivi d'un - corps. L'en-tête est disposé exactement comme la structure C suivante, - compactée sans remplissage, et est écrit sur le réseau champ après champ - dans l'ordre de déclaration : - - - - - - Les champs id, magic_num, - reserved et body_len sont stockés - dans l'ordre réseau (gros-boutiste) ; les champs restants sont des octets - bruts. - - - Le corps commence par un identifiant d'empaqueteur de 8 octets — - PHP, JSON ou - MSGPACK, complété par des zéros — indiquant au - destinataire comment le reste a été encodé, suivi du contenu sérialisé - lui-même. - - - - - Le corps de requête se décode en un tableau avec les clés - i (l'identifiant de transaction), - m (la méthode appelée) et p - (la liste des paramètres). - - - - - Le corps de réponse se décode en un tableau avec les clés - i (l'identifiant de transaction), - s (le statut, l'un des codes - YAR_ERR_*), r (la valeur de - retour), o (toute sortie produite par la méthode - du service) et e (l'erreur ou l'exception, quand - l'appel a échoué). - - - - - En HTTP le message est envoyé comme corps d'une requête POST, la réponse - arrivant comme corps de la réponse ; en TCP ou socket Unix il est écrit - directement sur le flux. - - - Appel d'un service Yar sans l'extension - - Le script autonome suivant construit une requête Yar valide pour - l'empaqueteur php avec uniquement des sockets - standard, l'envoie à un URI de service et affiche la réponse décodée. - Exécuté contre le service Operator des - exemples, il affiche - int(3). - - - 1, "m" => "add", "p" => array(1, 2))); -$body = str_pad("PHP", 8, "\0") . $serialized; - -/* 2. l'en-tête : 82 octets, entiers multi-octets dans l'ordre réseau */ -$header = pack("N", 1) /* id */ - . pack("v", 0) /* version */ - . pack("N", 0x80DFEC60) /* nombre magique */ - . pack("N", 0) /* reserved */ - . str_pad("", 32, "\0") /* provider */ - . str_pad("", 32, "\0") /* token */ - . pack("N", strlen($body)); /* longueur du corps */ - -/* 3. l'envoyer comme corps d'une requête POST */ -$stream = stream_context_create(array("http" => array( - "method" => "POST", - "header" => "Content-Type: application/octet-stream\r\n", - "content" => $header . $body, -))); -$reply = file_get_contents($uri, false, $stream); - -/* 4. analyser la réponse : en-tête de 82 octets, puis le corps */ -$response = unserialize(substr($reply, 82 + 8)); -var_dump($response["r"]); -?> -]]> - - - - Une implémentation client plus complète en PHP pur, qui décode également - l'en-tête de réponse et supporte les appels concurrents, se trouve dans - le répertoire tools/ du - dépôt source de Yar. - - - - diff --git a/reference/yar/setup.xml b/reference/yar/setup.xml deleted file mode 100644 index 66477066f5..0000000000 --- a/reference/yar/setup.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - La bibliothèque cURL est requise pour les transports HTTP et HTTPS. Le - transport TCP est implémenté avec de simples sockets et ne nécessite - aucune bibliothèque supplémentaire. - - - L'extension JSON est requise ; elle est - fournie avec PHP et toujours disponible à partir de PHP 8.0.0. - - - Pour utiliser le packager msgpack, l'extension - msgpack doit être - installée et Yar doit être compilé avec l'option de configuration - . - -
    - - -
    - &reftitle.install; - - Yar peut être installé de trois façons : via PECL, via PIE ou en - compilant depuis les sources. - - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yar. - - - &pecl.windows.download.avail; - - - Installer Yar avec PECL - - - - - - Depuis Yar 2.4.0, l'extension peut être installée avec - &link.pie;, le PHP Installer for Extensions, en exécutant la commande - suivante. - - - Installer Yar avec PIE - - - - - - Le packager msgpack peut être activé à l'installation : - - - Installer Yar avec PIE et msgpack - - - - - - Le code source est hébergé sur - GitHub. Pour - compiler l'extension depuis les sources, exécuter les commandes suivantes - en remplaçant les chemins par ceux de l'installation PHP locale. - - - Compiler Yar depuis les sources - - - - - - Les options de configure suivantes sont disponibles : - - - - - - - - - Emplacement de l'installation de cURL, s'il n'est pas trouvé dans les - chemins d'inclusion par défaut. - - - - - - - - - - Active le packager msgpack et fait de l'extension - msgpack une dépendance optionnelle. Lorsque Yar est - compilé avec cette option, la valeur par défaut de - yar.packager devient - msgpack. - - - - - - - - - - Utilise epoll de Linux au lieu de - select() pour le multiplexage des entrées/sorties, - disponible à partir de Yar 2.1.2. Cela peut améliorer les performances - de Yar_Concurrent_Client en cas de forte - concurrence. Cela ne prend effet que sous Linux ; sur les autres - plateformes, l'option est ignorée silencieusement. - - - - -
    - - - - &reference.yar.ini; - - -
    - &reftitle.resources; - - Cette extension ne définit aucune ressource. - -
    - -     - - diff --git a/reference/yar/yar-client-exception.xml b/reference/yar/yar-client-exception.xml deleted file mode 100644 index 25195c2454..0000000000 --- a/reference/yar/yar-client-exception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - La classe Yar_Client_Exception - Yar_Client_Exception - - - - -
    - &reftitle.intro; - - Classe de base des exceptions levées lorsqu'une requête échoue avant, - pendant ou après avoir atteint le service distant : une sous-classe est - levée en fonction de l'endroit où l'échec s'est produit. Le code de - l'exception est l'une des constantes YAR_ERR_*. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Client_Exception - - - - extends - Exception - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -     - - &reference.yar.entities.yar-client-exception; - -     - - diff --git a/reference/yar/yar-client-packager-exception.xml b/reference/yar/yar-client-packager-exception.xml deleted file mode 100644 index b41ff630e6..0000000000 --- a/reference/yar/yar-client-packager-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La classe Yar_Client_Packager_Exception - Yar_Client_Packager_Exception - - - -
    - &reftitle.intro; - - Levée lorsque le corps de la réponse ne peut pas être décodé avec l'empaqueteur demandé (code d'exception YAR_ERR_PACKAGER). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Client_Packager_Exception - - - - extends - Yar_Client_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/yar/yar-client-protocol-exception.xml b/reference/yar/yar-client-protocol-exception.xml deleted file mode 100644 index cbe41251e4..0000000000 --- a/reference/yar/yar-client-protocol-exception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - La classe Yar_Client_Protocol_Exception - Yar_Client_Protocol_Exception - - - -
    - &reftitle.intro; - - Levée lorsque la réponse du service RPC viole le protocole Yar, par exemple une adresse de protocole non supportée ou un en-tête de réponse mal formé (code d'exception YAR_ERR_PROTOCOL). - - - À partir de Yar 2.4.0, cela inclut également une réponse dont - l'identifiant de transaction ne correspond pas à celui de la requête à - laquelle elle répond. Le client valide le champ i de - chaque réponse ; une réponse portant un identifiant de transaction - différent et non nul (par exemple mal routée par un mandataire) est - rejetée. Les réponses avec un identifiant de transaction nul ou absent - sont toujours acceptées pour la compatibilité ascendante avec les - serveurs plus anciens. - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Client_Protocol_Exception - - - - extends - Yar_Client_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/yar/yar-client-transport-exception.xml b/reference/yar/yar-client-transport-exception.xml deleted file mode 100644 index 5f6859995a..0000000000 --- a/reference/yar/yar-client-transport-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La classe Yar_Client_Transport_Exception - Yar_Client_Transport_Exception - - - -
    - &reftitle.intro; - - Lancée lorsque la connexion au service RPC échoue : connexion refusée, dépassement du délai d'attente, ou réponse vide (code d'exception YAR_ERR_TRANSPORT). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Client_Transport_Exception - - - - extends - Yar_Client_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/yar/yar-client.xml b/reference/yar/yar-client.xml deleted file mode 100644 index e56e5018e3..0000000000 --- a/reference/yar/yar-client.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - La classe Yar_Client - Yar_Client - - - - -
    - &reftitle.intro; - - La partie cliente du framework RPC Yar. Un client est lié à une - unique adresse de service ; l'appel de toute méthode non définie sur - celui-ci déclenche un appel distant portant ce nom de méthode et les - arguments fournis. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Client - - - &Properties; - - protected - int - _protocol - - - protected - string - _uri - - - protected - arraynull - _options - - - protected - bool - _running - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _protocol - - - En lecture seule. Le protocole déduit de l'adresse du service : - l'une des constantes - YAR_CLIENT_PROTOCOL_HTTP, - YAR_CLIENT_PROTOCOL_TCP ou - YAR_CLIENT_PROTOCOL_UNIX. - - - - - _uri - - - En lecture seule. L'adresse du service avec laquelle le client a - été créé. - - - - - _options - - - En lecture seule. Un &array; des options définies sur ce client, - indexé par les constantes YAR_OPT_*, ou &null; - si aucune n'a été définie. - - - - - _running - - - En lecture seule. Indique si un appel émis par ce client est - actuellement en cours. - - - - -
    - - -     - - &reference.yar.entities.yar-client; - -     - - diff --git a/reference/yar/yar-concurrent-client.xml b/reference/yar/yar-concurrent-client.xml deleted file mode 100644 index 0aadae4201..0000000000 --- a/reference/yar/yar-concurrent-client.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - La classe Yar_Concurrent_Client - Yar_Concurrent_Client - - - - -
    - &reftitle.intro; - - Une classe utilitaire statique qui regroupe des appels RPC distants. Les appels - enregistrés avec Yar_Concurrent_Client::call ne sont pas - envoyés immédiatement ; ils sont tous émis ensemble, en parallèle, par - Yar_Concurrent_Client::loop. - - - La classe est destinée aux applications qui ont besoin des résultats de - plusieurs appels distants. Seuls les appels indépendants — ceux qui - n'ont pas besoin du résultat les uns des autres — peuvent être regroupés - ainsi ; quand un appel dépend du résultat d'un autre, les deux doivent - s'exécuter séquentiellement. Via Yar_Client, les - appels sont envoyés l'un après l'autre, chacun payant son temps - d'aller-retour complet ; avec le client concurrent, ils sont envoyés en - même temps, de sorte que le temps d'attente total se réduit à la durée - du seul appel le plus lent. - - - - Seuls les services HTTP(S) sont supportés pour les appels concurrents. - Ils sont envoyés simultanément via l'interface multi-handle de curl, - que le transport TCP/socket Unix n'implémente pas. - - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Concurrent_Client - - - &Methods; - - - - -
    - -     - - &reference.yar.entities.yar-concurrent-client; - -     - - diff --git a/reference/yar/yar-server-exception.xml b/reference/yar/yar-server-exception.xml deleted file mode 100644 index bb8dcf060c..0000000000 --- a/reference/yar/yar-server-exception.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - La classe Yar_Server_Exception - Yar_Server_Exception - - - - -
    - &reftitle.intro; - - Lancée côté client lorsque la requête RPC a échoué sur le serveur. - Si la méthode du service distant a elle-même lancé une exception, son - message, son code, son fichier, sa ligne et son nom de classe sont - reportés, et Yar_Server_Exception::getType - retourne le nom de la classe de l'exception d'origine. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Server_Exception - - - - extends - Exception - - - &Properties; - - protected - string - _type - "Yar_Exception_Server" - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - _type - - - Le nom de la classe de l'exception lancée par le service distant, ou - "Yar_Exception_Server" si l'erreur n'a pas été - causée par une exception utilisateur. Lu via - Yar_Server_Exception::getType. - - - - -
    - - -     - - &reference.yar.entities.yar-server-exception; - -     - - diff --git a/reference/yar/yar-server-output-exception.xml b/reference/yar/yar-server-output-exception.xml deleted file mode 100644 index 4cb7846647..0000000000 --- a/reference/yar/yar-server-output-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La classe Yar_Server_Output_Exception - Yar_Server_Output_Exception - - - -
    - &reftitle.intro; - - Lancée lorsque le serveur ne parvient pas à capturer les données de sortie de la méthode du service (code d'exception YAR_ERR_OUTPUT). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Server_Output_Exception - - - - extends - Yar_Server_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/yar/yar-server-packager-exception.xml b/reference/yar/yar-server-packager-exception.xml deleted file mode 100644 index be155d3369..0000000000 --- a/reference/yar/yar-server-packager-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La classe Yar_Server_Packager_Exception - Yar_Server_Packager_Exception - - - -
    - &reftitle.intro; - - Levée lorsque le corps de la requête ne peut pas être décodé avec l'empaqueteur annoncé dans la requête (code d'exception YAR_ERR_PACKAGER). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Server_Packager_Exception - - - - extends - Yar_Server_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/yar/yar-server-protocol-exception.xml b/reference/yar/yar-server-protocol-exception.xml deleted file mode 100644 index c1dbdca642..0000000000 --- a/reference/yar/yar-server-protocol-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La classe Yar_Server_Protocol_Exception - Yar_Server_Protocol_Exception - - - -
    - &reftitle.intro; - - Levée lorsque la requête entrante viole le protocole Yar, par exemple un en-tête de requête mal formé (code d'exception YAR_ERR_PROTOCOL). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Server_Protocol_Exception - - - - extends - Yar_Server_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/yar/yar-server-request-exception.xml b/reference/yar/yar-server-request-exception.xml deleted file mode 100644 index 6b4857cd0f..0000000000 --- a/reference/yar/yar-server-request-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La classe Yar_Server_Request_Exception - Yar_Server_Request_Exception - - - -
    - &reftitle.intro; - - Levée lorsque la méthode distante demandée n'existe pas sur l'objet serveur, ou n'est pas publique (code d'exception YAR_ERR_REQUEST). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Server_Request_Exception - - - - extends - Yar_Server_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/yar/yar-server.xml b/reference/yar/yar-server.xml deleted file mode 100644 index 46beffa48a..0000000000 --- a/reference/yar/yar-server.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - La classe Yar_Server - Yar_Server - - - - -
    - &reftitle.intro; - - Enveloppe un objet et expose toutes ses méthodes publiques en tant que - service distant, servi via HTTP par - Yar_Server::handle. - - - L'extension PHP ne fournit qu'un serveur HTTP. Un serveur TCP et socket - Unix utilisant le même protocole Yar est fourni par le - framework Yar en C. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Server - - - &Properties; - - protected - object - _executor - null - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _executor - - - L'objet dont les méthodes publiques sont exposées en tant que - services RPC. - - - - -
    - - -     - - &reference.yar.entities.yar-server; - -     - - diff --git a/reference/yar/yar_client/call.xml b/reference/yar/yar_client/call.xml deleted file mode 100644 index c60cf84ab0..0000000000 --- a/reference/yar/yar_client/call.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - Yar_Client::call - Appelle un service distant - - - - &reftitle.description; - - public mixedYar_Client::call - stringmethod - arrayarguments - - - Émet un appel RPC vers la méthode distante method. - C'est exactement ce qui se produit lorsqu'une méthode inexistante est - invoquée sur un objet Yar_Client (via la méthode - magique __call de PHP) ; - Yar_Client::call n'existe que pour que les - méthodes distantes nommées littéralement call ou - __call restent accessibles. - - - - - &reftitle.parameters; - - - method - - - Le nom de la méthode du service distant. - - - - - arguments - - - La liste des arguments passés à la méthode distante. - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur de retour de la méthode du service distant. - - - - - &reftitle.errors; - - Lorsque la méthode distante n'existe pas sur le serveur, ou n'est pas - publique, le client lance une - Yar_Client_Exception avec le code - YAR_ERR_REQUEST. Voir - Yar_Client_Exception - pour les autres échecs côté client et leurs classes d'exception. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yar_Client::call</methodname> - -add(1, 2)); - -/* Équivalent : appeler la méthode explicitement par nom */ -var_dump($client->call("add", array(1, 2))); - -/* Nécessaire uniquement lorsque le service distant expose littéralement une - * méthode nommée call (ou __call), que la magie __call ne peut pas atteindre */ -var_dump($client->call("call", array($some_argument))); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Client::setOpt - - - - - - diff --git a/reference/yar/yar_client/construct.xml b/reference/yar/yar_client/construct.xml deleted file mode 100644 index 7074ddbc3d..0000000000 --- a/reference/yar/yar_client/construct.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yar_Client::__construct - Crée un client - - - - &reftitle.description; - - final public Yar_Client::__construct - stringuri - arraynulloptionsnull - - - Crée un Yar_Client pour le service RPC situé - à l'adresse uri. - - - - - &reftitle.parameters; - - - uri - - - Adresse du service RPC. Le protocole est déduit du schéma : - http:// et https:// sélectionnent - le transport HTTP, tcp:// sélectionne le transport TCP, - et unix:// sélectionne le transport par socket Unix. - - - - - options - - - Un &array; d'options du client, indexé par les constantes - YAR_OPT_*, équivalent à un appel à - Yar_Client::setOpt pour chaque entrée. Les - options invalides sont ignorées silencieusement. - - - - - - - - &reftitle.returnvalues; - - Une nouvelle instance de Yar_Client. - - - - - &reftitle.errors; - - Si l'URI ne commence pas par un schéma supporté, une exception - Yar_Client_Protocol_Exception est levée. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yar_Client::__construct</methodname> - - 1000, - YAR_OPT_PACKAGER => "json", -]); -?> -]]> - - - - - - &reftitle.seealso; - - Yar_Client::call - Yar_Client::setOpt - - - - - - diff --git a/reference/yar/yar_client/getopt.xml b/reference/yar/yar_client/getopt.xml deleted file mode 100644 index 0f8fdc4b7a..0000000000 --- a/reference/yar/yar_client/getopt.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yar_Client::getOpt - Lit une option du client - - - - &reftitle.description; - - public mixedYar_Client::getOpt - intname - - - Retourne la valeur précédemment définie avec - Yar_Client::setOpt, ou avec le paramètre - options de - Yar_Client::__construct. - - - - - &reftitle.parameters; - - - name - - - Une des constantes YAR_OPT_*, voir - Yar_Client::setOpt. - - - - - - - - &reftitle.returnvalues; - - La valeur de l'option, ou &false; si l'option n'a pas été définie sur ce - client ou si le nom de l'option est inconnu. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yar_Client::getOpt</methodname> - -setOpt(YAR_OPT_TIMEOUT, 1000); - -var_dump($client->getOpt(YAR_OPT_TIMEOUT)); -var_dump($client->getOpt(YAR_OPT_PACKAGER)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Client::setOpt - - - - - - diff --git a/reference/yar/yar_client/setopt.xml b/reference/yar/yar_client/setopt.xml deleted file mode 100644 index f98baa3a13..0000000000 --- a/reference/yar/yar_client/setopt.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - Yar_Client::setOpt - Définit les options du client - - - - &reftitle.description; - - public Yar_ClientboolYar_Client::setOpt - intname - mixedvalue - - - Définit une option sur le client. Les options sont évaluées au moment où - un appel est émis, elles peuvent donc être modifiées entre deux appels. - - - - - &reftitle.parameters; - - - name - - - L'une des constantes YAR_OPT_* : - - - YAR_OPT_PACKAGER — un nom de packager : php, json ou, si l'extension a été compilée avec le support de msgpack, msgpack - YAR_OPT_PERSISTENT — un booléen indiquant si la connexion est persistante (HTTP keep-alive) - YAR_OPT_TIMEOUT — un délai d'expiration en millisecondes, qui surcharge yar.timeout - YAR_OPT_CONNECT_TIMEOUT — un délai d'expiration de connexion en millisecondes, qui surcharge yar.connect_timeout - YAR_OPT_HEADER (à partir de 2.0.4) — un &array; de lignes d'en-tête HTTP supplémentaires - YAR_OPT_RESOLVE (à partir de 2.1.0) — un &array; d'entrées de résolution de noms d'hôtes - YAR_OPT_PROXY (à partir de 2.2.0) — une adresse de proxy HTTP - YAR_OPT_PROVIDER (à partir de 2.3.0) — l'identité du fournisseur, jusqu'à 32 octets - YAR_OPT_TOKEN (à partir de 2.3.0) — le jeton d'authentification, jusqu'à 32 octets - - - - - value - - - La valeur de l'option. Une valeur invalide émet une alerte et fait - retourner &false; à l'appel. - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet client lui-même, ce qui permet une interface fluide, ou - &false; si le nom de l'option est inconnu, si la valeur est invalide, ou - si l'option ne s'applique pas au protocole avec lequel le client a été - créé. - - - - - &reftitle.errors; - - Les conditions qui font retourner &false; à l'appel émettent également - une alerte : - - - - - YAR_OPT_HEADER, - YAR_OPT_RESOLVE et - YAR_OPT_PROXY ne fonctionnent qu'avec le protocole - HTTP ; les utiliser avec un client tcp:// ou - unix:// émet une alerte. - - - - - YAR_OPT_RESOLVE nécessite en outre libcurl - >= 7.21.3. - - - - - Chaque option attend un type de valeur précis (chaîne, booléen, entier - ou tableau), décrit sur la page des - constantes. - - - - - - - &reftitle.examples; - - Exemple avec <methodname>Yar_Client::setOpt</methodname> - -setOpt(YAR_OPT_TIMEOUT, 1000); - -/* Définit le packager à JSON */ -$client->setOpt(YAR_OPT_PACKAGER, "json"); - -/* Définit des en-têtes personnalisés */ -$client->setOpt(YAR_OPT_HEADER, ["X-Api-Key: value"]); - -/* Passe par un proxy HTTP */ -$client->setOpt(YAR_OPT_PROXY, "127.0.0.1:8888"); - -/* Appelle le service distant */ -$result = $client->some_method("parameter"); -?> -]]> - - - - - - &reftitle.seealso; - - Yar_Client::getOpt - Yar_Client::call - - - - - - diff --git a/reference/yar/yar_client_exception/gettype.xml b/reference/yar/yar_client_exception/gettype.xml deleted file mode 100644 index 9c271761c8..0000000000 --- a/reference/yar/yar_client_exception/gettype.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yar_Client_Exception::getType - Récupère le type de l'exception - - - - &reftitle.description; - - public stringYar_Client_Exception::getType - - - - Retourne le type de l'exception. Les exceptions côté client sont levées par - le client lui-même (échecs de transport, erreurs de protocole, etc.), aussi - le type est toujours la chaîne fixe - "Yar_Exception_Client". Utiliser - Exception::getCode pour distinguer l'échec - précis ; le code est l'une des constantes - YAR_ERR_*. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne "Yar_Exception_Client". - - - - - &reftitle.examples; - - Exemple avec <methodname>Yar_Client_Exception::getType</methodname> - -some_method("parameter"); -} catch (Yar_Client_Exception $e) { - var_dump($e->getType()); - var_dump($e->getCode()); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Server_Exception::getType - - - - - - diff --git a/reference/yar/yar_concurrent_client/call.xml b/reference/yar/yar_concurrent_client/call.xml deleted file mode 100644 index 31a9c52693..0000000000 --- a/reference/yar/yar_concurrent_client/call.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - Yar_Concurrent_Client::call - Enregistre un appel concurrent - - - - &reftitle.description; - - public static intfalsenullYar_Concurrent_Client::call - stringuri - stringmethod - arraynullparametersnull - callablenullcallbacknull - callablenullerror_callbacknull - arraynulloptionsnull - - - Enregistre un appel RPC distant. La requête n'est pas envoyée - immédiatement ; tous les appels enregistrés sont envoyés ensemble par - Yar_Concurrent_Client::loop, et les réponses - sont traitées au fur et à mesure de leur arrivée. - - - - Seules les URI HTTP et HTTPS sont supportées. Les appels concurrents - sont envoyés simultanément via l'interface multi-handle de curl, que - le transport TCP/socket Unix n'implémente pas. - - - - - - &reftitle.parameters; - - - uri - - - Adresse du service RPC, commençant par - http:// ou https://. - - - - - method - - - Le nom de la méthode du service distant. - - - - - parameters - - - La liste des arguments passés à la méthode distante. - - - - - callback - - - Un callable invoqué lorsque la réponse à cet appel - arrive, avec deux arguments : la valeur de la réponse, et un - &array; callinfo décrivant l'appel : - - - sequence — le numéro de séquence retourné - lors de l'enregistrement de l'appel - uri — l'adresse du service - method — le nom de la méthode distante - - - S'il est omis, la fonction de rappel - callback de - Yar_Concurrent_Client::loop est utilisée ; - voir cette méthode pour ce qui se passe quand ni l'un ni l'autre n'est - fourni. - - - - - error_callback - - - Un callable invoqué lorsque cet appel échoue, avec trois - arguments : le type d'erreur (l'un des codes - YAR_ERR_*), le message d'erreur, et l'&array; - callinfo décrit ci-dessus. S'il est omis, la - fonction de rappel error_callback de - Yar_Concurrent_Client::loop est utilisée ; - voir cette méthode pour ce qui se passe quand ni l'un ni l'autre n'est - fourni. - - - - - options - - - Un &array; d'options du client, indexé par les constantes - YAR_OPT_*, voir - Yar_Client::setOpt. Appliqué à cet appel - uniquement. - - - - - - - - &reftitle.returnvalues; - - Retourne le numéro de séquence de l'appel enregistré, un ID unique - commençant à 1 qui identifie l'appel. Retourne - &false; lorsque le client concurrent est déjà à l'intérieur de - Yar_Concurrent_Client::loop ou lorsque le - maximum de 128 appels enregistrés est atteint ; dans - les deux cas, une alerte est émise. Retourne &null; si l'URI ou le nom - de la méthode est vide, ou si l'URI n'est pas une adresse HTTP(S), avec - une alerte. - - - - - &reftitle.examples; - - - "json")); - -/* Délai d'attente maximal personnalisé */ -Yar_Concurrent_Client::call("http://api.example.com/operator.php", "some_method", array("parameters"), "callback", NULL, array(YAR_OPT_TIMEOUT => 1000)); - -/* Les requêtes ne sont pas encore envoyées */ -]]> - - - - - - &reftitle.seealso; - - Yar_Concurrent_Client::loop - Yar_Concurrent_Client::reset - - - - - - diff --git a/reference/yar/yar_concurrent_client/loop.xml b/reference/yar/yar_concurrent_client/loop.xml deleted file mode 100644 index a2b6bcad3a..0000000000 --- a/reference/yar/yar_concurrent_client/loop.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - Yar_Concurrent_Client::loop - Envoie tous les appels enregistrés et attend leur réponse - - - - &reftitle.description; - - public static boolnullYar_Concurrent_Client::loop - callablenullcallbacknull - callablenullerror_callbacknull - arraynulloptionsnull - - - Envoie en parallèle tous les appels enregistrés avec - Yar_Concurrent_Client::call et bloque jusqu'à ce - que chaque réponse soit arrivée et ait été traitée. La liste des appels - est vidée lorsque cette méthode retourne. - - - Comme les appels s'exécutent simultanément, la boucle ne dure que le - temps du seul appel le plus lent, plutôt que la somme de tous les appels. - Les callbacks, cependant, ne sont pas invoqués dans l'ordre où les appels - ont été enregistrés : un callback se déclenche dès que sa réponse arrive. - Pour savoir à quel appel appartient une réponse, comparer l'entrée - sequence de l'argument callinfo avec - le numéro de séquence retourné par - Yar_Concurrent_Client::call. Le &array; - callinfo contient la sequence, - l'uri et la method de l'appel ; voir - Yar_Concurrent_Client::call. - - - - - &reftitle.parameters; - - - callback - - - Un callable utilisé pour traiter les réponses des appels - qui ont été enregistrés sans leur propre fonction de rappel. Juste - après l'envoi de toutes les requêtes, il est de plus appelé une fois - avec deux arguments &null;, avant l'arrivée de toute réponse. - - - Si ce paramètre est omis, la valeur de retour d'un appel réussi est - simplement affichée lorsque sa réponse arrive. - - - - - error_callback - - - Un callable utilisé pour traiter les erreurs des appels - qui ont été enregistrés sans leur propre fonction de rappel d'erreur. - Il reçoit trois arguments : le type d'erreur (l'un des codes - YAR_ERR_*), le message d'erreur et le &array; - callinfo. - - - Si ce paramètre est omis, un appel échoué émet un avertissement PHP ; - contrairement au Yar_Client synchrone, aucune - exception n'est levée. - - - - - options - - - Un &array; d'options du client, indexé par les constantes - YAR_OPT_*, appliqué à chaque appel enregistré qui - ne les redéfinit pas. - - - - - - - - &reftitle.returnvalues; - - Retourne &true; lorsque chaque appel enregistré a été traité, ou lorsque - aucun appel n'a été enregistré du tout. Retourne &false; si le client - concurrent est déjà en cours d'exécution dans une autre boucle ; dans ce - cas, une alerte est émise. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yar_Concurrent_Client::loop</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Concurrent_Client::call - Yar_Concurrent_Client::reset - - - - - - diff --git a/reference/yar/yar_concurrent_client/reset.xml b/reference/yar/yar_concurrent_client/reset.xml deleted file mode 100644 index 55812420df..0000000000 --- a/reference/yar/yar_concurrent_client/reset.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yar_Concurrent_Client::reset - Nettoie tous les appels enregistrés - - - - &reftitle.description; - - public static boolYar_Concurrent_Client::reset - - - - Abandonne tous les appels enregistrés avec - Yar_Concurrent_Client::call qui n'ont pas encore - été envoyés. - - - - Yar_Concurrent_Client::loop vide automatiquement - la liste des appels une fois terminée, si bien que reset n'est nécessaire - que pour annuler un lot qui n'a jamais été envoyé. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true;, ou &false; lorsque le client concurrent est actuellement à - l'intérieur de Yar_Concurrent_Client::loop, auquel - cas une erreur de niveau E_WARNING est émise. - - - - - &reftitle.examples; - - Exemple avec <function>Yar_Concurrent_Client::reset</function> - - -]]> - - - - - - &reftitle.seealso; - - Yar_Concurrent_Client::call - Yar_Concurrent_Client::loop - - - - - - diff --git a/reference/yar/yar_server/construct.xml b/reference/yar/yar_server/construct.xml deleted file mode 100644 index 718e6d2a60..0000000000 --- a/reference/yar/yar_server/construct.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - Yar_Server::__construct - Crée un serveur RPC - - - - &reftitle.description; - - final public Yar_Server::__construct - objectexecutor - - - Crée un serveur Yar HTTP RPC. Toutes les méthodes publiques de - executor sont enregistrées comme services RPC. - - - - - &reftitle.parameters; - - - executor - - - Tout objet dont les méthodes publiques devraient être exposées comme - services RPC. Les méthodes protégées et privées, ainsi que les méthodes - dont le nom commence par un tiret bas, ne sont pas exposées. - - - L'exécuteur peut optionnellement définir deux méthodes magiques - protégées, reconnues par - Yar_Server::handle et jamais exposées - comme points d'entrée RPC : - - - - - protected function __info(string $markup): - string — depuis Yar 2.3.0. Appelée lorsque la page - d'information du service est demandée ; elle reçoit le contenu de - la page que Yar aurait sinon affichée, et si elle retourne une - &string;, cette chaîne est envoyée au client à la place. Voir - Yar_Server::handle. - - - - - protected function __auth(string $provider, string - $token): bool — depuis Yar 2.3.0. Appelée au tout - début de chaque requête avec les champs - provider et token de - l'en-tête de requête, définis par le client avec les options - YAR_OPT_PROVIDER et - YAR_OPT_TOKEN. Retourner exactement - &false; rejette la requête ; toute autre valeur de retour la - laisse s'exécuter. Voir - Yar_Server::handle. - - - - - Les deux méthodes ne prennent effet que lorsqu'elles sont - protected ; une méthode publique ou privée - portant le même nom est ignorée. - - - - - - - - &reftitle.returnvalues; - - Une instance de Yar_Server. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yar_Server::__construct</methodname> - -handle(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yar_Server::handle - - - - - - - diff --git a/reference/yar/yar_server/handle.xml b/reference/yar/yar_server/handle.xml deleted file mode 100644 index 3dac430e80..0000000000 --- a/reference/yar/yar_server/handle.xml +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - Yar_Server::handle - Démarre le serveur RPC - - - - &reftitle.description; - - public boolYar_Server::handle - - - - Démarre le traitement de la requête RPC entrante. - - - - Les appels RPC habituels sont émis sous forme de requêtes HTTP POST. - Si une requête HTTP GET est émise à la place, la page d'informations - du service, générée à partir des méthodes publiques et de leurs - commentaires de documentation de l'objet exécuteur, est affichée. - Ce comportement peut être désactivé avec la directive - yar.expose_info, - auquel cas une requête GET lance une - Yar_Server_Exception. - - - - - À partir de Yar 2.3.0, l'objet exécuteur peut définir les méthodes - magiques protégées __info et - __auth pour personnaliser la page d'informations du - service et authentifier les requêtes ; voir - Yar_Server::__construct pour les détails. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true;. - - - - - &reftitle.errors; - - - Erreurs de <methodname>Yar_Server::handle</methodname> - - - - Condition - Exception - - - - - - La méthode distante a lancé une exception. - - - Yar_Server_Exception (avec le nom - de la classe d'origine dans sa propriété _type). - - - - - La méthode distante n'a pas été trouvée ou n'est pas publique. - - - Yar_Server_Request_Exception. - - - - - Le corps de la requête n'a pas pu être décodé. - - - Yar_Server_Packager_Exception. - - - - - La requête est mal formée au niveau du protocole. - - - Yar_Server_Protocol_Exception. - - - - - La sortie du serveur n'a pas pu être capturée. - - - Yar_Server_Output_Exception. - - - - - L'authentification a échoué, ou la page d'informations a été demandée - alors que yar.expose_info - est désactivée. - - - Yar_Server_Exception avec le code - YAR_ERR_FORBIDDEN. - - - - -
    -     -     - - - &reftitle.examples; - - Exemple avec <methodname>Yar_Server::handle</methodname> - -handle(); -?> -]]> - - - - Personnalisation de la page d'informations du service avec - <literal>__info</literal> (à partir de Yar 2.3.0) - -handle(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yar_Server::__construct - - - - -     - - diff --git a/reference/yar/yar_server_exception/gettype.xml b/reference/yar/yar_server_exception/gettype.xml deleted file mode 100644 index c1db5ba17c..0000000000 --- a/reference/yar/yar_server_exception/gettype.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yar_Server_Exception::getType - Récupère le type de l'exception - - - - &reftitle.description; - - public stringintYar_Server_Exception::getType - - - - Lorsqu'une méthode distante lève une exception, le serveur intègre - l'exception d'origine dans la réponse et le client la relève sous la forme - d'une Yar_Server_Exception. Cette méthode - retourne le nom de classe de cette exception d'origine. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Le nom de classe de l'exception levée par le service distant, ou - "Yar_Exception_Server" lorsque l'exception côté serveur - ne comportait aucun nom de classe. - - - - - &reftitle.examples; - - Exemple avec <methodname>Yar_Server_Exception::getType</methodname> - -handle(); -?> -]]> - - -throw_exception("client"); -} catch (Yar_Server_Exception $e) { - var_dump($e->getType()); - var_dump($e->getMessage()); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Client_Exception::getType - - - - - - diff --git a/reference/yaz/book.xml b/reference/yaz/book.xml deleted file mode 100644 index f48ebf0815..0000000000 --- a/reference/yaz/book.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - YAZ - - - - &reftitle.intro; - - Cette extension offre une interface PHP à la bibliothèque - YAZ qui implémente le - protocole Z39.50 - pour récupérer des informations. - Avec cette extension, il est possible de simplement implémenter une - origine Z39.50 (client) qui cherche ou analyse des cibles - Z39.50 (serveurs) en parallèle. - - - Ce module simplifie l'utilisation complexe du protocole - Z39.50. Il supporte les connexions persistantes de façon similaire - aux APIs RDB, qui sont disponibles pour PHP. Cela signifie que les - sessions sont conservées mais partagées entre les utilisateurs, - évitant ainsi les étapes de connexion et d'initialisation dans la - plupart des cas. - - - YAZ est disponible sur &url.yaz;. Il est possible de trouver - des informations supplémentaires, des exemples de scripts, etc. - pour cette extension sur &url.yaz-phpyaz;. - - - - &pecl.moved-ver;5.0.0. - - - - - - &reference.yaz.setup; - &reference.yaz.examples; - &reference.yaz.reference; - - - - - diff --git a/reference/yaz/configure.xml b/reference/yaz/configure.xml deleted file mode 100644 index 02b7f7ff58..0000000000 --- a/reference/yaz/configure.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;yaz - - - &pecl.windows.download; - - - Information spécifique aux utilisateurs de Windows - - php_yaz.dll dépend de la bibliothèque - yaz.dll. Le fichier yaz.dll - fait partie du ZIP Win32 depuis le site de PHP. Il fait également - partie de l'installation Windows YAZ, disponible depuis l' - espace YAZ WIN32. - - - Sous Windows, il ne faut pas oublier d'ajouter le dossier PHP au PATH - pour que le fichier yaz.dll soit trouvé par - le système. - - - - &warn.imaprecodeyaz; - -
    - - diff --git a/reference/yaz/examples.xml b/reference/yaz/examples.xml deleted file mode 100644 index dad6eabcad..0000000000 --- a/reference/yaz/examples.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - &reftitle.examples; - - PHP/YAZ garde les traces des connexions avec les cibles - (Z-Associations). Une ressource représente une connexion - à une cible. - - - Le script ci-dessous montre la fonctionnalité de recherche parallèle - de l'API. Lorsqu'appelée sans argument, elle affiche une requête ; - sinon, elle cherche la cible donnée dans le tableau - host. - - - - Recherche parallèle en utilisant Yaz - - - - test GILS - - test local - - Library of Congress -
    - Requête RPN: - - - - '; -} else { - echo 'Votre recherche pour ' . htmlspecialchars($query) . '
    '; - for ($i = 0; $i < $num_hosts; $i++) { - $id[] = yaz_connect($host[$i]); - yaz_syntax($id[$i], "usmarc"); - yaz_range($id[$i], 1, 10); - yaz_search($id[$i], "rpn", $query); - } - yaz_wait(); - for ($i = 0; $i < $num_hosts; $i++) { - echo '
    ' . $host[$i] . ':'; - $error = yaz_error($id[$i]); - if (!empty($error)) { - echo "Erreur : $error"; - } else { - $hits = yaz_hits($id[$i]); - echo "Nombre de résultat(s) : $hits"; - } - echo '
    '; - for ($p = 1; $p <= 10; $p++) { - $rec = yaz_record($id[$i], $p, "string"); - if (empty($rec)) continue; - echo "
    $p
    "; - echo nl2br($rec); - echo "
    "; - } - echo '
    '; - } -} -?> -]]> -     -     -     -     - - - diff --git a/reference/yaz/functions/yaz-addinfo.xml b/reference/yaz/functions/yaz-addinfo.xml deleted file mode 100644 index 9fe908fa52..0000000000 --- a/reference/yaz/functions/yaz-addinfo.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - yaz_addinfo - Retourne plus de détails après une erreur - - - - &reftitle.description; - - stringyaz_addinfo - resourceid - - - Retourne plus de détails après une erreur pour la dernière requête sur le - serveur. - - - Avec certains serveurs, cette fonction peut retourner la même chaîne de - caractères que la fonction yaz_error. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - - - - - &reftitle.returnvalues; - - Une chaîne de caractères contenant des informations additionnelles ou une - chaîne de caractères vide si la dernière opération était réussie ou si - aucune information additionnelle n'était fournie par le serveur. - - - - - &reftitle.seealso; - - - yaz_error - yaz_errno - - - - - - diff --git a/reference/yaz/functions/yaz-ccl-conf.xml b/reference/yaz/functions/yaz-ccl-conf.xml deleted file mode 100644 index 9f4c801b3a..0000000000 --- a/reference/yaz/functions/yaz-ccl-conf.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - - yaz_ccl_conf - Configure l'analyseur CCL - - - - &reftitle.description; - - voidyaz_ccl_conf - resourceid - arrayconfig - - - Cette fonction configure l'analyseur CCL de requête pour un serveur avec - les définitions de points d'accès (CCL qualifiers) et leur - équivalent en RPN. - - - Pour faire correspondre une requête CCL spécifique à RPN, utiliser la - fonction yaz_ccl_parse. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - config - - - Un tableau de configuration. Chaque clé du tableau est le nom du champ - CCL et la valeur correspondante contient une chaîne de caractères qui - spécifie la correspondance au RPN. - - - La correspondance est une séquence de paires d'attributs type et - d'attributs valeur. L'attribut type et l'attribut valeur sont séparés par - un signe égal (=). Chaque paire est séparée par un - espace. - - - Des informations supplémentaires peuvent être trouvées sur la page CCL. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Dans l'exemple ci-dessous, l'analyseur CCL est configuré pour supporter - trois champs CCL : ti, au et - isbn. Chaque champ correspond à leur équivalent BIB-1. - On suppose que la variable $id est l'ID de la connexion. - - - Configuration CCL - - "1=4", - "au" => "1=1", - "isbn" => "1=7" -); -yaz_ccl_conf($id, $fields); -?> -]]> - - - - - - &reftitle.seealso; - - - yaz_ccl_parse - - - - - - diff --git a/reference/yaz/functions/yaz-ccl-parse.xml b/reference/yaz/functions/yaz-ccl-parse.xml deleted file mode 100644 index 1d0bcdd8fb..0000000000 --- a/reference/yaz/functions/yaz-ccl-parse.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - yaz_ccl_parse - Appelle l'analyseur CCL - - - - &reftitle.description; - - boolyaz_ccl_parse - resourceid - stringquery - arrayresult - - - Cette fonction appelle l'analyseur CCL. Il convertit une requête - CCL FIND en une requête RPN qui peut être passée à - yaz_search pour effectuer une recherche. - - - Pour définir un champ CCL valide, utiliser la fonction - yaz_ccl_conf avant d'utiliser cette fonction. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - query - - - La requête CCL FIND. - - - - - result - - - Si la fonction a été exécutée correctement, cet argument sera un - tableau contenant la requête RPN valide sous la clé - rpn. - - - Lors d'un échec, trois index sont écrits dans ce tableau pour indiquer - la cause de l'échec : - - - - errorcode - le code d'erreur CCL (&integer;) - - - - - errorstring - l'erreur CCL en chaîne de caractères - - - - - errorpos - position approximative dans la requête - qui est en échec (&integer; qui est la position d'un caractère) - - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Analyse CCL - - Nous allons essayer de chercher en utilisant CCL. Dans l'exemple - ci-dessous, $ccl est une requête CCL. - - - -]]> - - - - - - diff --git a/reference/yaz/functions/yaz-close.xml b/reference/yaz/functions/yaz-close.xml deleted file mode 100644 index e632340913..0000000000 --- a/reference/yaz/functions/yaz-close.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - yaz_close - Ferme une connexion YAZ - - - - &reftitle.description; - - boolyaz_close - resourceid - - - Ferme la connexion donnée par le paramètre id. - - - - Cette fonction fermera seulement une connexion non persistante ouverte en - mettant l'option persistent à &false; avec - yaz_connect. - - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - yaz_connect - - - - - - diff --git a/reference/yaz/functions/yaz-connect.xml b/reference/yaz/functions/yaz-connect.xml deleted file mode 100644 index 9dfeb633a4..0000000000 --- a/reference/yaz/functions/yaz-connect.xml +++ /dev/null @@ -1,234 +0,0 @@ - - - - - - - - yaz_connect - Prépare une connexion à un serveur Z39.50 - - - - &reftitle.description; - - mixedyaz_connect - stringzurl - mixedoptions - - - Cette fonction retourne une ressource de connexion en cas de succès et - &zero; en cas d'échec. - - - yaz_connect prépare une connexion - à un serveur Z39.50. Cette fonction n'est pas bloquante, - et ne tente pas d'établir une connexion. En fait, elle ne fait que - préparer la connexion pour exécution ultérieure - par yaz_wait. - - - - Le proxy YAZ est un proxy Z39.50 librement - disponible. - - - - - - &reftitle.parameters; - - - - zurl - - - Une chaîne de caractères qui prend la forme - host[:port][/database]. Si le port est omis, le port - 210 est utilisé. Si la base de données est omise, - Default est utilisée. - - - - - options - - - Si donné comme une chaîne de caractères, cela sera traité comme la - chaîne d'authentification Z39.50 V2 (OpenAuth). - - - Si donné comme un tableau, le contenu du tableau sert en tant - qu'options. - - - user - - - Utilisateur pour authentification. - - - - - group - - - Groupe pour authentification. - - - - - password - - - Mot de passe pour authentification. - - - - - cookie - - - Cookie pour session (proxy YAZ). - - - - - proxy - - - Proxy pour connexion (proxy YAZ). - - - - - persistent - - - Un booléen. Si &true; la connexion est persistante; Si &false; la - connexion n'est pas persistante. Par défaut les connexions sont - persistantes. - - - - Lors de l'ouverture d'une connexion persistante, il ne sera pas - possible de la fermer plus tard avec - yaz_close. - - - - - - piggyback - - - Un booléen. Si &true; piggyback est activé pour les recherches. Si - &false; piggyback est désactivé. Par défaut piggyback est activé. - - - L'activation de piggyback est plus efficace : il sauvegarde - habituellement les allers-retours du réseau pour les premières - lectures de résultats. Cependant, quelques serveurs Z39.50 ne - supportent pas piggyback ou ils ignorent ce jeu de noms. Pour ceux-ci, - piggyback devrait être désactivé. - - - - - charset - - - Une chaîne de caractères qui spécifie le jeu de caractères qui sera - utilisé dans le langage Z39.50 et le jeu de caractères pour les - négociations. Utiliser une chaîne de caractères comme : - ISO-8859-1, UTF-8, - UTF-16. - - - La plupart des serveurs Z39.50 ne supportent pas cette option (et, - pour ceux-ci, cet argument est ignoré). Plusieurs serveurs - utilisent l'encodage ISO-8859-1 pour les requêtes et les messages. - Les enregistrements MARC21/USMARC ne sont pas affectés par cette - configuration. - - - - - - preferredMessageSize - - - Un entier qui spécifie la taille maximale en octets pour toutes les - entrées qui seront retournées par la cible durant la récupération. - Voir le standard Z39.50 - pour plus d'informations. - - - - Cette option est supportée dans PECL YAZ 1.0.5 ou supérieure. - - - - - - - maximumRecordSize - - - Un entier qui spécifie la taille maximale en octets pour une seule - entrée qui sera retournée par la cible durant la récupération. - Cette entité est référée à Exceptional-record-size dans le standard Z39.50. - - - - Cette option est supportée dans PECL YAZ 1.0.5 ou supérieure. - - - - - - - - - - - - - - - &reftitle.returnvalues; - - Une ressource de connexion en cas de réussite, &false; en cas d'erreur. - - - - &reftitle.seealso; - - - yaz_close - - - - - - diff --git a/reference/yaz/functions/yaz-database.xml b/reference/yaz/functions/yaz-database.xml deleted file mode 100644 index 184dbe242a..0000000000 --- a/reference/yaz/functions/yaz-database.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - yaz_database - - Spécifie la base d'une session YAZ - - - - - &reftitle.description; - - boolyaz_database - resourceid - stringdatabases - - - Cette fonction permet de changer de base de données à l'intérieur de - la session en spécifiant une ou plusieurs bases de données à utiliser dans - la recherche, récupération de données, etc. Écrase les bases de données - spécifiées dans l'appel de yaz_connect. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - databases - - - Une chaîne de caractères contenant une ou plusieurs bases de données. - Plusieurs bases de données sont séparées par un signe plus - +. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/yaz/functions/yaz-element.xml b/reference/yaz/functions/yaz-element.xml deleted file mode 100644 index 2f6d2bf648..0000000000 --- a/reference/yaz/functions/yaz-element.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - yaz_element - - Spécifie le type d'éléments YAZ à lire - - - - - &reftitle.description; - - boolyaz_element - resourceid - stringelementset - - - Cette fonction spécifie le type d'éléments à lire. - - - Appelez cette fonction avant yaz_search ou - yaz_present pour spécifier un type d'élément pour les - enregistrements à récupérer. - - - - Si cette fonction semble sans effet, voir la description de l'option - piggybacking dans yaz_connect. - - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - elementset - - - La plupart des serveurs supportent F (pour les - enregistrements complets) et B (pour les - enregistrements brefs). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/yaz/functions/yaz-errno.xml b/reference/yaz/functions/yaz-errno.xml deleted file mode 100644 index 670e13e39f..0000000000 --- a/reference/yaz/functions/yaz-errno.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - yaz_errno - Retourne le numéro d'erreur - - - - &reftitle.description; - - intyaz_errno - resourceid - - - Retourne un numéro d'erreur pour le serveur (dernière requête) identifié - par id. - - - yaz_errno devrait être appelée après chaque requête - pour chaque serveur - (après le retour de yaz_wait) - pour déterminer le succès ou l'échec de la dernière opération (c'est-à-dire - la recherche). - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - - - - - &reftitle.returnvalues; - - Retourne un code d'erreur. Le code d'erreur est soit un code diagnostique - Z39.50 (habituellement un diagnostic Bib-1), soit un code d'erreur côté - client qui est généré par PHP/YAZ lui-même, par exemple - "Connect failed", "Init Rejected", etc. - - - - - &reftitle.seealso; - - - yaz_error - yaz_addinfo - - - - - - diff --git a/reference/yaz/functions/yaz-error.xml b/reference/yaz/functions/yaz-error.xml deleted file mode 100644 index 305e12532a..0000000000 --- a/reference/yaz/functions/yaz-error.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - yaz_error - Retourne une description de l'erreur - - - - &reftitle.description; - - stringyaz_error - resourceid - - - yaz_error retourne un message d'erreur en anglais - correspondant au dernier numéro d'erreur retourné par - yaz_errno. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - - - - - &reftitle.returnvalues; - - Retourne un message d'erreur pour le serveur (dernière requête), identifié - par le paramètre id. Une chaîne de caractères vide - est retournée si la dernière opération était réussie. - - - - - &reftitle.seealso; - - - yaz_errno - yaz_addinfo - - - - - - diff --git a/reference/yaz/functions/yaz-es-result.xml b/reference/yaz/functions/yaz-es-result.xml deleted file mode 100755 index 50ca0216c3..0000000000 --- a/reference/yaz/functions/yaz-es-result.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - yaz_es_result - - Inspecte le résultat d'un service étendu - - - - - &reftitle.description; - - arrayyaz_es_result - resourceid - - - - Cette fonction inspecte le dernier résultat d'un service étendu - depuis un serveur. Un service étendu est initié par la fonction - yaz_item_order ou la fonction - yaz_es. - - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau avec l'élément - targetReference pour la référence pour - l'opération de service étendu (généré et retourné depuis le serveur). - - - - - &reftitle.seealso; - - - yaz_es - - - - - - - diff --git a/reference/yaz/functions/yaz-es.xml b/reference/yaz/functions/yaz-es.xml deleted file mode 100644 index 9c89ee7826..0000000000 --- a/reference/yaz/functions/yaz-es.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - - yaz_es - Prépare pour une Requête de Service Étendu - - - &reftitle.description; - - voidyaz_es - - resourceid - - - stringtype - - - arrayargs - - - - Cette fonction prépare pour une Requête de Service Étendu. - Les Services Étendus sont une famille de divers services Z39.50, - comme "Record Update", "Item Order", - "Database administration", etc. - - - - Il existe des serveurs Z39.50 qui ne supportent pas les Services Étendus. - - - - La fonction yaz_es crée des paquets d'une Requête de - Service Étendu et les place dans une file d'attente d'opérations. - Utiliser yaz_wait pour envoyer la/les requête(s) au - serveur. - À la fin de yaz_wait, le résultat de l'opération de - Service Étendu devrait être obtenu avec un appel à - yaz_es_result. - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - type - - - Une &string; représentant le type de Service Étendu : - itemorder (Item Order), - create (Create Database), - drop (Drop Database), - commit (Commit Operation), - update (Update Record), - xmlupdate (XML Update). - Chaque type est spécifié dans la section suivante. - - - - - - args - - - Un tableau avec les options de service étendu et les options - spécifiques du paquet. Les options sont identiques à celles offertes - par l'API C de ZOOM C. Se reporter à ZOOM - Services Étendus. - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Mise à Jour d'Enregistrements - - "un titre", - "syntax" => "xml", - "action" => "specialUpdate" -); -yaz_es($con, "update", $args); -yaz_wait(); -$result = yaz_es_result($id); -?> -]]> - - - - - - &reftitle.seealso; - - - yaz_es_result - - - - - - - diff --git a/reference/yaz/functions/yaz-get-option.xml b/reference/yaz/functions/yaz-get-option.xml deleted file mode 100644 index 55200bb232..0000000000 --- a/reference/yaz/functions/yaz-get-option.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - yaz_get_option - Retourne la valeur d'une option de connexion YAZ - - - - &reftitle.description; - - stringyaz_get_option - resourceid - stringname - - - Retourne la valeur de l'option spécifiée par name. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - name - - - Le nom de l'option. - - - - - - - - - &reftitle.returnvalues; - - Retourne la valeur de l'option spécifiée ou une chaîne de caractères vide - si l'option n'était pas définie. - - - - - &reftitle.seealso; - - - - La description de yaz_set_option pour les options - disponibles - - - - - - - diff --git a/reference/yaz/functions/yaz-hits.xml b/reference/yaz/functions/yaz-hits.xml deleted file mode 100644 index f8e79b4438..0000000000 --- a/reference/yaz/functions/yaz-hits.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - yaz_hits - - Retourne le nombre de résultats de la dernière recherche - - - - - &reftitle.description; - - intyaz_hits - resourceid - arraysearchresult - - - yaz_hits retourne le nombre de résultats de - la dernière recherche. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - searchresult - - - Tableau de résultats pour des informations de résultats de recherche - détaillés. - - - - - - - - - &reftitle.returnvalues; - - Retourne le nombre de résultats pour la dernière recherche ou 0 si aucune - recherche n'a été effectuée. - - - Le tableau de résultats de recherche (s'il est fourni) contient des - informations qui sont retournées par un serveur Z39.50 dans le format - SearchResult-1 d'une réponse de recherche. - Le format SearchResult-1 peut être utilisé pour obtenir des informations à - propos du nombre de résultats pour des parties de requête (sous-requête). - En particulier, il est possible d'obtenir le nombre de résultats pour les - termes de recherche individuels dans une requête. L'information pour la - première sous-requête est dans $array[0], la seconde sous-requête dans - $array[1] et ainsi de suite. - - - Membres de searchresult - - - - - - Élément - Description - - - - - id - Sous-requête ID2 (&string;) - - - count - Nombre de résultats (&integer;) - - - subquery.term - Terme de sous-requête (&string;) - - - interpretation.term - Terme interprété de sous-requête (&string;) - - - recommendation.term - Terme recommandé de sous-requête (&string;) - - - -
    - - - Le service de SearchResult requiert PECL YAZ 1.0.5 ou supérieur et YAZ - 2.1.9 ou supérieur. - - - - - Très peu d'implémentations de Z39.50 supportent le service de - SearchResult. - - -     -     - - diff --git a/reference/yaz/functions/yaz-itemorder.xml b/reference/yaz/functions/yaz-itemorder.xml deleted file mode 100644 index 4a56e90897..0000000000 --- a/reference/yaz/functions/yaz-itemorder.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - - - yaz_itemorder - - Prépare une requête Z39.50 Item Order avec le paquet ILL-Request - - - - - &reftitle.description; - - voidyaz_itemorder - resourceid - arrayargs - - - Cette fonction prépare une requête de type "Extended Services" en - utilisant le "Profile" avec - "Use of Z39.50 Item Order Extended Service to Transport ILL (Profile/1)". - Se reporter ici et aux - spécifications. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - args - - - Doit être un tableau associatif avec les informations à propos de - l'ordre des items des requêtes qui seront envoyées. La clé du tableau est - le nom du chemin tag ASN.1 correspondant. Par exemple, le ISBN sous le - Item-ID a la clé item-id,ISBN. - - - Les paramètres de requête ILL sont : - - -protocol-version-num -transaction-id,initial-requester-id,person-or-institution-symbol,person -transaction-id,initial-requester-id,person-or-institution-symbol,institution -transaction-id,initial-requester-id,name-of-person-or-institution,name-of-person -transaction-id,initial-requester-id,name-of-person-or-institution,name-of-institution -transaction-id,transaction-group-qualifier -transaction-id,transaction-qualifier -transaction-id,sub-transaction-qualifier -service-date-time,this,date -service-date-time,this,time -service-date-time,original,date -service-date-time,original,time -requester-id,person-or-institution-symbol,person -requester-id,person-or-institution-symbol,institution -requester-id,name-of-person-or-institution,name-of-person -requester-id,name-of-person-or-institution,name-of-institution -responder-id,person-or-institution-symbol,person -responder-id,person-or-institution-symbol,institution -responder-id,name-of-person-or-institution,name-of-person -responder-id,name-of-person-or-institution,name-of-institution -transaction-type -delivery-address,postal-address,name-of-person-or-institution,name-of-person -delivery-address,postal-address,name-of-person-or-institution,name-of-institution -delivery-address,postal-address,extended-postal-delivery-address -delivery-address,postal-address,street-and-number -delivery-address,postal-address,post-office-box -delivery-address,postal-address,city -delivery-address,postal-address,region -delivery-address,postal-address,country -delivery-address,postal-address,postal-code -delivery-address,electronic-address,telecom-service-identifier -delivery-address,electronic-address,telecom-service-addreess -billing-address,postal-address,name-of-person-or-institution,name-of-person -billing-address,postal-address,name-of-person-or-institution,name-of-institution -billing-address,postal-address,extended-postal-delivery-address -billing-address,postal-address,street-and-number -billing-address,postal-address,post-office-box -billing-address,postal-address,city -billing-address,postal-address,region -billing-address,postal-address,country -billing-address,postal-address,postal-code -billing-address,electronic-address,telecom-service-identifier -billing-address,electronic-address,telecom-service-addreess -ill-service-type -requester-optional-messages,can-send-RECEIVED -requester-optional-messages,can-send-RETURNED -requester-optional-messages,requester-SHIPPED -requester-optional-messages,requester-CHECKED-IN -search-type,level-of-service -search-type,need-before-date -search-type,expiry-date -search-type,expiry-flag -place-on-hold -client-id,client-name -client-id,client-status -client-id,client-identifier -item-id,item-type -item-id,call-number -item-id,author -item-id,title -item-id,sub-title -item-id,sponsoring-body -item-id,place-of-publication -item-id,publisher -item-id,series-title-number -item-id,volume-issue -item-id,edition -item-id,publication-date -item-id,publication-date-of-component -item-id,author-of-article -item-id,title-of-article -item-id,pagination -item-id,ISBN -item-id,ISSN -item-id,additional-no-letters -item-id,verification-reference-source -copyright-complicance -retry-flag -forward-flag -requester-note -forward-note - - - Il y a aussi quelques paramètres du paquet Extended Services Request - et ItemOrder : - - -package-name -user-id -contact-name -contact-phone -contact-email -itemorder-item - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/yaz/functions/yaz-present.xml b/reference/yaz/functions/yaz-present.xml deleted file mode 100644 index 97074c080c..0000000000 --- a/reference/yaz/functions/yaz-present.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - yaz_present - Prépare à la lecture (Z39.50 present) - - - - &reftitle.description; - - boolyaz_present - resourceid - - - Cette fonction prépare PHP à la lecture des résultats, après une recherche. - - - La fonction yaz_range doit être appelée avant celle-ci - pour spécifier la plage de résultats à lire. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/yaz/functions/yaz-range.xml b/reference/yaz/functions/yaz-range.xml deleted file mode 100644 index 7352c691cf..0000000000 --- a/reference/yaz/functions/yaz-range.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - yaz_range - - Spécifie un intervalle d'enregistrements à récupérer - - - - - &reftitle.description; - - voidyaz_range - resourceid - intstart - intnumber - - - Spécifie un intervalle d'enregistrements à récupérer. - - - Cette fonction doit être appelée avant la fonction - yaz_search ou yaz_present. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - start - - - Spécifie la position du premier enregistrement à récupérer. Les numéros - des enregistrements vont de 1 à yaz_hits. - - - - - number - - - Spécifie le nombre d'enregistrements qui doivent être récupérés. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/yaz/functions/yaz-record.xml b/reference/yaz/functions/yaz-record.xml deleted file mode 100644 index eaeee39ddd..0000000000 --- a/reference/yaz/functions/yaz-record.xml +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - yaz_record - Retourne un enregistrement - - - - &reftitle.description; - - stringyaz_record - resourceid - intpos - stringtype - - - La fonction yaz_record retourne un enregistrement dans - le jeu de résultats courant à la position spécifiée par le paramètre - pos. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - pos - - - La position de l'enregistrement. Les positions des enregistrements dans - un jeu de résultats sont numérotés de 1 jusqu'au - nombre retourné par yaz_hits. - - - - - type - - - Le type spécifie la forme du résultat retourné. - - - - C'est l'application qui est responsable pour s'assurer que les résultats - retournés à partir du serveur Z39.50/SRW sont dans un format correct. - Le type donné spécifie seulement une conversion qui doit avoir lieu - sur le côté client (dans PHP/YAZ). - - - - Sans compter la conversion du transfert de résultats de chaîne de - caractères en tableau, PHP/YAZ est aussi possible d'effectuer une - conversion de jeu de caractères du résultat. En particulier pour - USMARC/MARC21 qui est recommandé puisque ces résultats sont normalement - retournés dans le jeu de caractères MARC-8 qui n'est pas supporté par - les navigateurs, etc. Pour spécifier une conversion, ajoutez ; - charset=from, - to ou from est le - jeu de caractères original du résultat et to - est le jeu de caractères à obtenir (comme vu par PHP). - - - - string - - - L'enregistrement est retourné comme une chaîne de caractères pour - affichage simple. Dans ce mode, tous les enregistrements MARC sont - convertis dans un format ligne par ligne puisque ISO2709 est - difficile à lire. Les enregistrements XML et SUTRS sont retournés - dans leur format original. GRS-1 est retourné dans un format - ligne par ligne (laid). - - - Ce format est approprié si les enregistrements seront affichés - rapidement (pour débogage) ou parce que ce n'est pas faisable - d'effectuer un affichage approprié. - - - - - xml - - - L'enregistrement est retourné comme une chaîne de caractères XML si - possible. Dans ce mode, tous les enregistrements MARC sont convertis - en MARCXML. - Les enregistrements XML et SUTRS sont retournés dans leur format - original. GRS-1 n'est pas supporté. - - - Ce format est similaire à string à l'exception - que les enregistrements MARC sont convertis en MARCXML - - - Ce format est approprié si les enregistrements sont analysés par la - suite par un analyseur XML ou un processeur XSLT. - - - - - raw - - - L'enregistrement est retourné comme une chaîne de caractères dans sa - forme originale. Ce type est approprié pour MARC, XML et SUTRS. Il - ne fonctionne pas pour GRS-1. - - - Les enregistrements MARC sont retournés comme une chaîne de - caractères ISO2709. XML et SUTRS sont retournés comme des chaînes de - caractères. - - - - - syntax - - - La syntaxe de l'enregistrement sera retournée comme une chaîne de - caractères, par exemple USmarc, - GRS-1, XML, etc. - - - - - database - - - Le nom de la base de données associée aux résultats à la position est - retourné comme une chaîne de caractères. - - - - - array - - - L'enregistrement est retourné comme un tableau qui reflète la - structure GRS-1. Ce type est approprié pour MARC et GRS-1. XML, - SUTRS ne sont pas supportés et, si l'enregistrement actuel est XML ou - SUTRS, une chaîne de caractères vide sera retournée. - - - Le tableau retourné consiste en une liste correspondant à chaque - feuille/nœud interne de GRS-1. Chaque item de la liste consiste en - une sous-liste avec le premier élément path et - data (si les données sont disponibles). - - - Le chemin, qui est une chaîne de caractères, contient une liste de chaque composant - de l'arbre (de la structure des enregistrements GRS-1) depuis la racine vers l'extrémité. - Chaque composant est une paire de type de balise/valeur sous la forme - (type, - value - - - Les balises de chaîne de caractères ont normalement une correspondance - avec le type tag 3. MARC peut aussi être retourné comme un tableau - (ils sont convertis en GRS-1 de manière interne). - - - - - - - - - - - - &reftitle.returnvalues; - - Retourne l'enregistrement à la position pos ou une - chaîne vide si aucun enregistrement n'existe à la position donnée. - - - Si aucun enregistrement de base de données n'existe à la position donnée une - chaîne vide sera retournée. - - - - - &reftitle.examples; - - Tableau pour des enregistrements GRS-1 - - Considérez les enregistrements GRS-1 - - - - Cet enregistrement a deux nœuds à la racine. - Le premier élément de la racine est (4,52) [tag type 4, tag value 52], - et a comme donnée Robert M. Pirsig. - Le deuxième élément de la racine (4,70) a un sous-arbre avec un élément simple (4,90). - (4,90) a maintenant un sous-arbre (2,7) avec comme donnée Transworld Publishers, - ltd.. - - - Si cet enregistrement est présent à la position $p, alors - - -]]> - - - Array - ( - [0] => (4,52) - [1] => Robert M. Pirsig - ) - [1] => Array - ( - [0] => (4,70) - ) - [2] => Array - ( - [0] => (4,70)(4,90) - ) - [3] => Array - ( - [0] => (4,70)(4,90)(2,7) - [1] => Transworld Publishers, ltd. - ) -) -]]> - - - - - Travail avec MARCXML - - Le script PHP ci-dessous retourne un enregistrement MARC21/USMARC - comme MARCXML. L'enregistrement original est retourné dans le jeu de caractères - marc-8 (inconnu de beaucoup d'analyseurs XML), donc nous le convertissons en UTF-8 - (que tous les analyseurs XML supportent). - - -]]> - - - - L'enregistrement $rec peut être obtenu avec le processeur - Sablotron XSLT comme cela : - - - - $rec); -$res = xslt_process($processor, 'arg:/_xml', $xslfile, NULL, $parms); -xslt_free($processor); -$res = preg_replace("']*>'", '', $res); -echo $res; - -?> -]]> - - - - - - - diff --git a/reference/yaz/functions/yaz-scan-result.xml b/reference/yaz/functions/yaz-scan-result.xml deleted file mode 100644 index 632e64cc4f..0000000000 --- a/reference/yaz/functions/yaz-scan-result.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - yaz_scan_result - Retourne le résultat d'un scan - - - - &reftitle.description; - - arrayyaz_scan_result - resourceid - arrayresult - - - yaz_scan_result retourne un tableau contenant - les termes reçus de l'hôte, lors de la dernière requête de scan. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - result - - - Si donné, ce tableau sera modifié pour contenir des informations - additionnelles prises à partir de la réponse Scan : - - - - number - Nombre d'entrées retournées - - - - - stepsize - Grandeur de pas - - - - - position - Position du terme - - - - - status - Statut du scan - - - - - - - - - - - &reftitle.returnvalues; - - Retourne un tableau (0..n-1) où n est le nombre de termes retournés. Chaque - valeur est une paire où le premier item est un terme et le second item est - le nombre de résultats. - - - - - diff --git a/reference/yaz/functions/yaz-scan.xml b/reference/yaz/functions/yaz-scan.xml deleted file mode 100644 index 5d291abe8b..0000000000 --- a/reference/yaz/functions/yaz-scan.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - - yaz_scan - Prépare un scan YAZ - - - - &reftitle.description; - - voidyaz_scan - resourceid - stringtype - stringstartterm - arrayflags - - - yaz_scan prépare une requête - "Z39.50 Scan Request" sur la connexion YAZ spécifiée. - - - Pour réellement transférer la requête "Scan Request" - au serveur et recevoir le "Scan Response", - la fonction yaz_wait doit être appelée. - Après la fin de yaz_wait, appelez - yaz_error et yaz_scan_result - pour connaître la réponse. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - type - - - Actuellement seulement le type rpn est supporté. - - - - - startterm - - - Point de départ du scan. - - - La forme dans laquelle le terme de départ est spécifié est donnée par - le paramètre type. - - - La syntaxe de ce paramètre est similaire à la requête RPN comme décrite - dans yaz_search. Cela consiste à aucune ou - plusieurs spécifications d'opérateur @attr, ensuite - suivies par exactement une seule marque. - - - - - flags - - - Ce paramètre optionnel spécifie des informations supplémentaires pour - contrôler le comportement de la requête de scan. Trois index sont - actuellement lus à partir du tableau d'options : - number (nombre de termes demandés), - position (position préférée du terme) et - stepSize (grandeur de pas préférée). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Fonction PHP qui analyse les titres sur un serveur YAZ - - $val) { - echo "$key = $val "; - } - echo '
    '; - while (list($key, list($k, $term, $tcount)) = each($ar)) { - if (empty($k)) continue; - echo ""; - } - echo '
    $term$tcount
    '; - } else { - echo "Erreur de Scan. Erreur : " . yaz_error($id) . "
    "; - } -} -?> -]]> -     -     -     -     -     - - diff --git a/reference/yaz/functions/yaz-schema.xml b/reference/yaz/functions/yaz-schema.xml deleted file mode 100644 index 58a217e660..0000000000 --- a/reference/yaz/functions/yaz-schema.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - yaz_schema - Spécifie le schéma de lecture - - - - &reftitle.description; - - voidyaz_schema - resourceid - stringschema - - - yaz_schema spécifie le schéma de lecture. - - - Cette fonction devrait être appelée avant yaz_search - ou yaz_present. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - schema - - - Doit être spécifié comme un OID (Object Identifier) dans une notation - par point brut (comme 1.2.840.10003.13.4) ou comme - un des schémas connus enregistrés : GILS-schema, - Holdings, Zthes, ... - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/yaz/functions/yaz-search.xml b/reference/yaz/functions/yaz-search.xml deleted file mode 100644 index fb1a494084..0000000000 --- a/reference/yaz/functions/yaz-search.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - - - - - - yaz_search - Prépare une recherche - - - - &reftitle.description; - - boolyaz_search - resourceid - stringtype - stringquery - - - yaz_search prépare une recherche sur la connexion - donnée - - - Comme pour yaz_connect, cette fonction - n'est pas bloquante et ne fait que préparer la recherche pour - exécution ultérieure lorsque yaz_wait est appelée. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - type - - - Ce paramètre représente le type de requête - seul - "rpn" est supporté actuellement et, dans ce cas, le - troisième argument est un préfixe de notation de requête utilisé par - YAZ. - - - - - query - - - Les requêtes RPN sont des représentations textuelles des - requêtes de type Type-1, comme défini dans le standard - Z39.50. Cependant, dans la représentation textuelle utilisée - par YAZ, une notation à préfixe est utilisée, - c'est-à-dire que l'opérateur précède - l'opérande. La chaîne de requête est une - séquence de mots réservés, où les espaces sont - ignorés, à moins qu'ils n'aient été - mis entre guillemets doubles. Les mots réservés qui commencent - par un arobase (@) sont considérés - comme des opérateurs et traités comme tels. - - - Opérateurs RPN - - - - - - Syntaxe - Description - - - - - @and query1 query2 - intersection des requêtes query1 et query2 - - - @or query1 query2 - union des requêtes query1 et query2 - - - @not query1 query2 - requêtes "query1 et non(query2)" - - - @set name - nomme le résultat - - - @attrset set query - spécifie le jeu d'attributs de la requête. Cette construction - n'est autorisée qu'une seule fois, au début d'une requête. - - - @attr [set] type=value query - applique les attributs à une requête. Le type et la valeur - sont des entiers indiquant les types et valeurs des attributs, dans - cet ordre. Le jeu, si fourni, spécifie le jeu d'attributs utilisé. - - - - -
    - - Il est possible de trouver des informations sur les attributs sur le site - Z39.50 Maintenance Agency. - - - - Dans le cas où l'on souhaiterait utiliser une notation plus facile, utiliser - l'analyseur CCL - fonctions yaz_ccl_conf et - yaz_ccl_parse. - - -     -     -     -     -     - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Exemples de Requête - - Il est possible de chercher pour des termes simples, comme ceci : - - - - qui concorde avec les documents où "ordinateur" se trouve. Aucun attribut - n'est spécifié. - - - La requête - - - - concorde avec les documents où "knuth donald" se trouve (en supposant que - le serveur supporte la recherche de phrase). - - - Cette requête applique deux attributs à la même phrase. - @attr 1=1003 @attr 4=1 "knuth donald" - Le premier attribut est de type 1 (Bib-1), et sa valeur est 1003 - (Auteur). - Le second attribut est de type 4 (structure), valeur 1 (phrase), - ce qui fait que la requête recherche les documents dont - Donald Knuth est l'auteur. - - - La requête - - - - ressemblerait en notation infix (a or b) and ((c or d) not e). - - - Un autre exemple, plus complexe : - - - - La requête utilise l'ensemble de sous attributs GILS. La requête - recherche les documents où le mot art - apparaît dans le titre (GILS,BIB-1) et dont la société - (company) apparaît comme distributeur (GILS). - - - -     - - diff --git a/reference/yaz/functions/yaz-set-option.xml b/reference/yaz/functions/yaz-set-option.xml deleted file mode 100644 index ec19ca8c2d..0000000000 --- a/reference/yaz/functions/yaz-set-option.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - - - yaz_set_option - Modifie une ou plusieurs options de connexion YAZ - - - - &reftitle.description; - - voidyaz_set_option - resourceid - stringname - stringvalue - - - voidyaz_set_option - resourceid - arrayoptions - - - Modifie une ou plusieurs options sur la connexion donnée. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - name ou options - - - Peut être soit une chaîne de caractères, soit un tableau. - - - Si donné comme chaîne de caractères, cela sera le nom de l'option - à spécifier. Il faudra donner sa valeur value. - - - Si donné comme tableau, cela sera un tableau associatif (nom de - l'option => valeur de l'option). - - - Options de connexion PHP/YAZ - - - - - - &Name; - &Description; - - - - - implementationName - Nom de l'implémentation du serveur - - - implementationVersion - Version de l'implémentation du serveur - - - implementationId - ID de l'implémentation du serveur - - - schema - - Schéma de lecture. Par défaut, aucun schéma n'est - utilisé. Modifier cette option équivaut à - utiliser la fonction yaz_schema - - - - preferredRecordSyntax - - Syntaxe des enregistrements en lecture. Par défaut, il - n'y a pas de syntaxe. Modifier cette option équivaut à - utiliser la fonction yaz_syntax - - - - start - - Décalage du premier enregistrement à lire, - via la fonction yaz_search ou - yaz_present. Les enregistrements - sont numérotés à partir de 0. Modifier cette option, - en combinaison avec l'option count, - équivaut à utiliser la fonction - yaz_range, hormis le fait que les - enregistrements sont numérotés à partir de - 1 avec yaz_range - - - - count - Nombre maximal d'enregistrements à lire via - yaz_search et yaz_present. - - - - elementSetName - element-set-name en lecture. Modifier cette option équivaut à - utiliser la fonction yaz_element. - - - - -
    -     -     - - value - - - La nouvelle valeur de l'option. Utiliser cet argument seulement si - l'argument précédent est une chaîne de caractères. - - - -     -     -     - - - &reftitle.returnvalues; - - &return.void; - - -     - - diff --git a/reference/yaz/functions/yaz-sort.xml b/reference/yaz/functions/yaz-sort.xml deleted file mode 100644 index 97f84592d9..0000000000 --- a/reference/yaz/functions/yaz-sort.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - - yaz_sort - Configure les critères de tri - - - - &reftitle.description; - - voidyaz_sort - resourceid - stringcriteria - - - Cette fonction configure les critères de tri et active le tri Z39.50. - - - Cette fonction doit être appelée avant - yaz_search. Utilisée seule, cette fonction n'a aucun - effet. Si elle est utilisée conjointement avec - yaz_search, une commande Z39.50 Sort sera envoyée - après chaque retour de recherche et avant que les résultats ne soient - lus avec Z39.50 Present (yaz_present). - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - criteria - - - Une chaîne de caractères qui prend la forme de field1 - flags1 field2 flags2 où field1 spécifie les attributs - primaires pour le tri, field2 le second, etc. - - - Le champ spécifie soit un attribut numérique, combinaison consistant de - paires type=value séparées par des virgules (c'est-à-dire - 1=4,2=1), soit il peut être spécifié en une - chaîne de caractères (c'est-à-dire titre). Le flags - est une séquence des caractères suivants qui ne peuvent être - séparés par aucun espace. - - - - Options de tri - - a - - - Tri ascendant - - - - - d - - - Tri descendant - - - - - i - - - Tri insensible à la casse - - - - - s - - - Tri sensible à la casse - - - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - Critères de Tri - - Pour effectuer des tris avec l'attribut Bib1 du champ "title", de manière - insensible à la casse, il est possible d'utiliser le critère suivant : - - - - - - Si le second critère de tri doit être l'auteur, en tenant compte - de la casse, et dans l'ordre alphabétique, il est possible d'utiliser : - - - - - - - - - diff --git a/reference/yaz/functions/yaz-syntax.xml b/reference/yaz/functions/yaz-syntax.xml deleted file mode 100644 index cdf8e274a1..0000000000 --- a/reference/yaz/functions/yaz-syntax.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - yaz_syntax - Spécifie la syntaxe d'enregistrement préférée pour la récupération - - - - &reftitle.description; - - voidyaz_syntax - resourceid - stringsyntax - - - yaz_syntax spécifie la syntaxe d'enregistrement préférée pour la récupération. - - - Cette fonction devrait être appelée avant yaz_search - ou yaz_present. - - - - - &reftitle.parameters; - - - - id - - - La ressource de connexion retournée par - yaz_connect. - - - - - syntax - - - Doit être spécifié comme un OID (Object Identifier) dans une notation - par point brut (comme 1.2.840.10003.5.10) ou comme - une des syntaxes d'enregistrement connues et enregistrées (sutrs, usmarc, - grs1, xml, etc.). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/yaz/functions/yaz-wait.xml b/reference/yaz/functions/yaz-wait.xml deleted file mode 100644 index ae8134f551..0000000000 --- a/reference/yaz/functions/yaz-wait.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - yaz_wait - Attend l'exécution d'une requête - - - - &reftitle.description; - - mixedyaz_wait - arrayoptions - - - Cette fonction exécute une activité réseau (bloquée) pour les demandes - en attente qui ont été préparées par les fonctions yaz_connect, - yaz_search, yaz_present, - yaz_scan et yaz_itemorder. - - - yaz_wait se termine lorsque tous les hôtes - ont terminé leurs requêtes (éventuellement en cas d'erreur). - - - - - &reftitle.parameters; - - - - options - - - Un tableau associatif des options : - - - timeout - - - Spécifie un délai d'attente en secondes. Si un serveur n'a pas - répondu dans les délais, il est considéré comme mort et - yaz_wait se termine. La valeur par défaut pour - le délai est de 15 secondes. - - - - - event - - - Un booléen. - - - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - En mode événement, la fonction retourne une ressource - &return.falseforfailure;. - - - - - diff --git a/reference/yaz/reference.xml b/reference/yaz/reference.xml deleted file mode 100644 index e85845af7c..0000000000 --- a/reference/yaz/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - YAZ &Functions; - - &reference.yaz.entities.functions; - - - - diff --git a/reference/yaz/setup.xml b/reference/yaz/setup.xml deleted file mode 100644 index b324d3a537..0000000000 --- a/reference/yaz/setup.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Récupérez YAZ (support ANSI/NISO Z39.50) et installez-le. - YAZ peut être récupéré sous forme de source ou sous forme de paquets - pré-compilés depuis l'archive YAZ. - Les systèmes comme Debian GNU/Linux, Suse Linux, FreeBSD ont également - YAZ fournis dans leurs distributions. - -
    - - - - &reference.yaz.configure; - - -     - - - diff --git a/reference/zmq/book.xml b/reference/zmq/book.xml deleted file mode 100644 index d0425c1644..0000000000 --- a/reference/zmq/book.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - ZMQ - 0MQ messaging - - - &reftitle.intro; - - &warn.experimental; - "ØMQ est une bibliothèque qui permet d'implémenter - rapidement une application rapide à base de message." --Site Web 0MQ - - - Pour plus d'informations sur 0MQ, voir - &url.zeromq;. - - - - &reference.zmq.setup; - - &reference.zmq.zmq; - &reference.zmq.zmqexception; - - &reference.zmq.zmqcontext; - &reference.zmq.zmqcontextexception; - - &reference.zmq.zmqsocket; - &reference.zmq.zmqsocketexception; - - &reference.zmq.zmqpoll; - &reference.zmq.zmqpollexception; - - &reference.zmq.zmqdevice; - &reference.zmq.zmqdeviceexception; - - - - diff --git a/reference/zmq/setup.xml b/reference/zmq/setup.xml deleted file mode 100644 index 64a729a957..0000000000 --- a/reference/zmq/setup.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - L'extension ZMQ requiert 0MQ en version 2.0.7 ou supérieure. - 0MQ peut être obtenu depuis - &url.zeromq;area:download. - -
    - -
    - &reftitle.install; - - - &pecl.info.dead; - &url.pecl.package;zmq - - - &pecl.windows.download.avail; - -
    -     - - diff --git a/reference/zmq/zmq.xml b/reference/zmq/zmq.xml deleted file mode 100644 index bad93e7e02..0000000000 --- a/reference/zmq/zmq.xml +++ /dev/null @@ -1,866 +0,0 @@ - - - - - - - La classe ZMQ - ZMQ - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQ - - - - - ZMQ - - - - &Constants; - - const - int - ZMQ::SOCKET_PAIR - - - const - int - ZMQ::SOCKET_PUB - - - const - int - ZMQ::SOCKET_SUB - - - const - int - ZMQ::SOCKET_REQ - - - const - int - ZMQ::SOCKET_REP - - - const - int - ZMQ::SOCKET_XREQ - - - const - int - ZMQ::SOCKET_XREP - - - const - int - ZMQ::SOCKET_PUSH - - - const - int - ZMQ::SOCKET_PULL - - - const - int - ZMQ::SOCKET_ROUTER - - - const - int - ZMQ::SOCKET_DEALER - - - const - int - ZMQ::SOCKET_XPUB - - - const - int - ZMQ::SOCKET_XSUB - - - const - int - ZMQ::SOCKET_STREAM - - - const - int - ZMQ::SOCKOPT_HWM - - - const - int - ZMQ::SOCKOPT_SNDHWM - - - const - int - ZMQ::SOCKOPT_RCVHWM - - - const - int - ZMQ::SOCKOPT_AFFINITY - - - const - int - ZMQ::SOCKOPT_IDENTITY - - - const - int - ZMQ::SOCKOPT_SUBSCRIBE - - - const - int - ZMQ::SOCKOPT_UNSUBSCRIBE - - - const - int - ZMQ::SOCKOPT_RATE - - - const - int - ZMQ::SOCKOPT_RECOVERY_IVL - - - const - int - ZMQ::SOCKOPT_RECONNECT_IVL - - - const - int - ZMQ::SOCKOPT_RECONNECT_IVL_MAX - - - const - int - ZMQ::SOCKOPT_MCAST_LOOP - - - const - int - ZMQ::SOCKOPT_SNDBUF - - - const - int - ZMQ::SOCKOPT_RCVBUF - - - const - int - ZMQ::SOCKOPT_RCVMORE - - - const - int - ZMQ::SOCKOPT_TYPE - - - const - int - ZMQ::SOCKOPT_LINGER - - - const - int - ZMQ::SOCKOPT_BACKLOG - - - const - int - ZMQ::SOCKOPT_MAXMSGSIZE - - - const - int - ZMQ::SOCKOPT_SNDTIMEO - - - const - int - ZMQ::SOCKOPT_RCVTIMEO - - - const - int - ZMQ::SOCKOPT_IPV4ONLY - - - const - int - ZMQ::SOCKOPT_LAST_ENDPOINT - - - const - int - ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE - - - const - int - ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT - - - const - int - ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL - - - const - int - ZMQ::SOCKOPT_TCP_ACCEPT_FILTER - - - const - int - ZMQ::SOCKOPT_TCP_ACCEPT_FILTER - - - const - int - ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT - - - const - int - ZMQ::SOCKOPT_XPUB_VERBOSE - - - const - int - ZMQ::SOCKOPT_ROUTER_RAW - - - const - int - ZMQ::SOCKOPT_IPV6 - - - const - int - ZMQ::CTXOPT_MAX_SOCKETS - - - const - int - ZMQ::POLL_IN - - - const - int - ZMQ::POLL_OUT - - - const - int - ZMQ::MODE_NOBLOCK - - - const - int - ZMQ::MODE_DONTWAIT - - - const - int - ZMQ::MODE_SNDMORE - - - const - int - ZMQ::ERR_INTERNAL - - - const - int - ZMQ::ERR_EAGAIN - - - const - int - ZMQ::ERR_ENOTSUP - - - const - int - ZMQ::ERR_EFSM - - - const - int - ZMQ::ERR_ETERM - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; -
    - Types de constantes ZMQ - - - - ZMQ::SOCKET_PAIR - - Masque de paire exclusif - - - - - ZMQ::SOCKET_PUB - - Socket de publication - - - - - ZMQ::SOCKET_SUB - - Socket de souscription - - - - - ZMQ::SOCKET_REQ - - Socket de requête - - - - - ZMQ::SOCKET_REP - - Socket de réponse - - - - - ZMQ::SOCKET_XREQ - - Alias de SOCKET_DEALER - - - - - ZMQ::SOCKET_XREP - - Alias de SOCKET_ROUTER - - - - - ZMQ::SOCKET_PUSH - - Socket de flux montant - - - - - ZMQ::SOCKET_PULL - - Socket de flux descendant - - - - - ZMQ::SOCKET_ROUTER - - Socket REP étendu, qui peut diriger les réponses aux demandeurs - - - - - ZMQ::SOCKET_DEALER - - Socket REQ étendu, qui effectue une balance de charge sur tous les pairs connectés - - - - - ZMQ::SOCKET_XPUB - - - Similaire à SOCKET_PUB, sauf qu'il est possible de recevoir des souscriptions - comme messages. Le message de souscription est 0 (désabonner) - ou 1 (abonner) suivi du topic. - - - - - ZMQ::SOCKET_XSUB - - Similaire à SOCKET_SUB, sauf qu'il est possible d'envoyer des - souscriptions. Voir SOCKET_XPUB pour le format. - - - - - ZMQ::SOCKET_STREAM - - - Utilisé pour envoyer et recevoir des données TCP depuis - un pair non-ØMQ. Disponible si compilé avec - ZeroMQ 4.x ou supérieures (Valeur : &integer;). - - - - - ZMQ::SOCKOPT_HWM - - - La limite haute pour les messages entrants et sortants - est une limite sur le nombre maximal de messages ØMQ - en attente dans la file d'attente mémoire pour un chaque - pair avec lequel le socket communique. Le fait de définir - cette option sur un socket n'affectera que les connexions - effectuées après que l'option ait été définie. Sur ZeroMQ 3.x, - c'est une enveloppe pour définir à la fois SNDHWM et RCVHWM. - (Valeur : &integer;). - - - - - - ZMQ::SOCKOPT_SNDHWM - - - L'option ZMQ_SNDHWM va définir la limite haute pour les messages - sortants sur le socket spécifié. Disponible si compilé avec - ZeroMQ 3.x ou supérieures (Valeur : &integer;). - - - - - - ZMQ::SOCKOPT_RCVHWM - - - L'option SOCKOPT_RCVHWM va définir la limite haute pour les messages - entrants sur le socket spécifié. Disponible si compilé avec - ZeroMQ 3.x ou supérieures (Valeur : &integer;). - - - - - - ZMQ::SOCKOPT_AFFINITY - - Définit l'affinité I/O thread (Valeur : &integer;) - - - - - ZMQ::SOCKOPT_IDENTITY - - Définit l'identifiant du socket (Valeur : &string;) - - - - - ZMQ::SOCKOPT_SUBSCRIBE - - Établit un filtre de message. Valide pour un socket - de souscription (Valeur : &string;) - - - - - ZMQ::SOCKOPT_UNSUBSCRIBE - - - Supprime un filtre de message. Valide pour un socket de - souscription (Valeur : &string;) - - - - - ZMQ::SOCKOPT_RATE - - - Définit le taux pour les sockets multicast (pgm) (Valeur : &integer; >= 0) - - - - - - ZMQ::SOCKOPT_RECOVERY_IVL - - Définit l'intervalle de récupération multicast - (Valeur : &integer; >= 0) - - - - - ZMQ::SOCKOPT_RECONNECT_IVL - - Définit l'intervalle de reconnexion initial (Valeur : &integer; >= 0) - - - - - ZMQ::SOCKOPT_RECONNECT_IVL_MAX - - Définit l'intervalle de reconnexion maximal (Valeur : &integer; >= 0) - - - - - ZMQ::SOCKOPT_MCAST_LOOP - - Contrôle de la boucle locale multicast (Valeur : &integer; >= 0) - - - - - ZMQ::SOCKOPT_SNDBUF - - Définit la taille du tampon de transmission du Kernel - (Valeur : &integer; >= 0) - - - - - ZMQ::SOCKOPT_RCVBUF - - Définit la taille du tampon de réception du Kernel (Valeur : &integer; >= 0) - - - - - ZMQ::SOCKOPT_RCVMORE - - Réception de messages multipart (Valeur : &integer;) - - - - - ZMQ::SOCKOPT_TYPE - - Récupère le type de socket. - Valide pour getSockOpt (Valeur : &integer;) - - - - - ZMQ::SOCKOPT_LINGER - - - La valeur linger du socket. Spécifie la durée de blocage du socket - lors de sa tentative de vider les messages après qu'il a été - fermé (Valeur : &integer;) - - - - - ZMQ::SOCKOPT_BACKLOG - - L'option SOCKOPT_BACKLOG définit la taille maximale de la file - d'attente des messages sortants par connexions pour le socket - spécifié ; ceci ne s'applique que pour les transports orientés connexion. - (Valeur : &integer;) - - - - - ZMQ::SOCKOPT_MAXMSGSIZE - - - Limite la taille maximale d'un message entrant. La valeur -1 signifie - qu'il n'y a aucune limite. Disponible que si compilé avec - ZeroMQ 3.x ou supérieurs (Valeur : &integer;) - - - - - - ZMQ::SOCKOPT_SNDTIMEO - - - Définit le délai d'attente maximal pour une opération d'envoi - sur le socket. La valeur -1 signifie qu'il n'y a aucune limite. - Disponible que si compilé avec ZeroMQ 3.x ou supérieures (Valeur : &integer;) - - - - - - ZMQ::SOCKOPT_RCVTIMEO - - - Définit le délai d'attente pour une opération de réception sur - le socket. La valeur -1 signifie qu'il n'y a aucune limite. - Disponible que si compilé avec ZeroMQ 3.x ou supérieures (Valeur : &integer;) - - - - - - ZMQ::SOCKOPT_IPV4ONLY - - Si vaut 1, le support IPV6 sera désactivé. - Disponible que si compilé avec ZeroMQ 3.x ou supérieures (Valeur : &integer;) - - - - - - ZMQ::SOCKOPT_LAST_ENDPOINT - - - Récupère le point final de la dernière connexion - pour une utilisation - avec les jokers * des ports. Disponible que si compilé avec ZeroMQ 3.x - ou supérieures (Valeur : &string;) - - - - - - ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE - - - Temps d'inactivité pour les keepalive TCP. - Disponible que si compilé avec ZeroMQ 3.x ou supérieures - (Valeur : &integer;) - - - - - - ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT - - - Compteur de temps pour les keepalive TCP. Disponible que si compilé - avec ZeroMQ 3.x ou supérieures (Valeur : &integer;) - - - - - - ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL - - - Intervalle pour les keepalive TCP. Disponible que si compilé avec - ZeroMQ 3.x ou supérieures (Valeur : &integer;) - - - - - - ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT - - - Définit une chaîne CIDR pour correspondre avec les connexions TCP - entrantes. Disponible que si compilé avec - ZeroMQ 3.x ou supérieures (Valeur : &string;) - - - - - - ZMQ::SOCKOPT_TCP_ACCEPT_FILTER - - - Définit une chaîne CIDR pour correspondre avec les connexions - entrantes TCP. Disponible que si compilé avec ZeroMQ 3.x ou supérieures - (Valeur : &string;) - - - - - - ZMQ::SOCKOPT_XPUB_VERBOSE - - - Définit le XPUB pour recevoir un message d'application sur chaque instance - d'une souscription. Disponible que si compilé avec ZeroMQ 3.x ou supérieures - (Valeur : &string;) - - - - - ZMQ::SOCKOPT_ROUTER_RAW - - - Définit le mode brut sur le ROUTER (définir à la valeur 1 pour cela). - En mode brut, lors de l'utilisation du transport tcp://, le socket - va lire et écrire sans ZeroMQ. Disponible que si compilé avec - ZeroMQ 4.0 ou supérieures (Valeur : &string;) - - - - - ZMQ::SOCKOPT_IPV6 - - Active l'IPV6. Disponible que si compilé avec - ZeroMQ 4.0 ou supérieures (Valeur : &string;) - - - - - ZMQ::CTXOPT_MAX_SOCKETS - - - La limite du socket pour ce contexte. Disponible que si compilé avec - ZeroMQ 3.x ou supérieures (Valeur : &integer;) - - - - - ZMQ::POLL_IN - - File pour les données entrantes - - - - - ZMQ::POLL_OUT - - File pour les données sortantes - - - - - ZMQ::MODE_NOBLOCK - - Opération non-bloquante. Obsolète : utiliser plutôt ZMQ::MODE_DONTWAIT - - - - - ZMQ::MODE_DONTWAIT - - Opération non-bloquante - - - - - ZMQ::MODE_SNDMORE - - Envoie un message multipart - - - - - ZMQ::DEVICE_FORWARDER - - Périphérique de transfert - - - - - ZMQ::DEVICE_QUEUE - - Périphérique de file - - - - - ZMQ::DEVICE_STREAMER - - Périphérique de streamer - - - - - ZMQ::ERR_INTERNAL - - Erreur interne de l'extension ZMQ - - - - - ZMQ::ERR_EAGAIN - - Implique que l'opération bloquera lorsque - ZMQ::MODE_DONTWAIT est utilisé - - - - - ZMQ::ERR_ENOTSUP - - L'opération n'est pas supportée par ce type de socket - - - - - ZMQ::ERR_EFSM - - L'opération ne peut être exécutée car le socket est dans un - statut incorrect - - - - - ZMQ::ERR_ETERM - - Le contexte doit se terminer - - - - -
    -
    - - - -     - - &reference.zmq.entities.zmq; - -     - - diff --git a/reference/zmq/zmq/construct.xml b/reference/zmq/zmq/construct.xml deleted file mode 100644 index 09775db9a0..0000000000 --- a/reference/zmq/zmq/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - ZMQ::__construct - Constructeur de ZMQ - - - - &reftitle.description; - - private ZMQ::__construct - - - - Constructeur privé pour empêcher l'initialisation directe. Cette classe contient les constantes d'extension ZMQ. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/zmq/zmqcontext.xml b/reference/zmq/zmqcontext.xml deleted file mode 100644 index 0f7abe96a7..0000000000 --- a/reference/zmq/zmqcontext.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - La classe ZMQContext - ZMQContext - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQContext - - - - - ZMQContext - - - - - &Methods; - - - - -
    - -     - - &reference.zmq.entities.zmqcontext; - -     - - diff --git a/reference/zmq/zmqcontext/construct.xml b/reference/zmq/zmqcontext/construct.xml deleted file mode 100644 index ec7571a8fb..0000000000 --- a/reference/zmq/zmqcontext/construct.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - ZMQContext::__construct - Construit un nouvel objet ZMQContext - - - - &reftitle.description; - - public ZMQContext::__construct - intio_threads1 - boolis_persistent&true; - - - Construit un nouveau contexte ZMQ. Le contexte est utilisé pour initialiser - les sockets. Un contexte persistant est nécessaire pour initialiser des - sockets persistants. - - - - - &reftitle.parameters; - - - - io_threads - - - Nombre de io-threads dans le contexte. - - - - - is_persistent - - - Si le contexte est persistant ou non. Un contexte persistant - est stocké pour plusieurs requêtes, et est nécessaire pour les - sockets persistants. - - - - - - - - - &reftitle.errors; - - Lance ZMQContextException si le contexte d'initialisation échoue. - - - - - &reftitle.examples; - - - Exemple avec <function>ZMQContext</function> - - Construit un nouveau contexte et y alloue le socket de la requête. - - -getSocket(ZMQ::SOCKET_REQ, 'my sock'); - -/* Connexion au socket */ -$socket->connect("tcp://example.com:1234"); - -/* Envoie une requête */ -$socket->send("Hello there"); - -/* Réception de la réponse */ -$message = $socket->recv(); -?> -]]> - - - - - - - diff --git a/reference/zmq/zmqcontext/getopt.xml b/reference/zmq/zmqcontext/getopt.xml deleted file mode 100644 index 259e6d9db0..0000000000 --- a/reference/zmq/zmqcontext/getopt.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ZMQContext::getOpt - Récupère une option de contexte - - - - &reftitle.description; - - public mixedZMQContext::getOpt - stringkey - - - Retourne la valeur d'une option de contexte. - - - - - &reftitle.parameters; - - - - key - - - Un entier représentant l'option. Voir les constantes - ZMQ::CTXOPT_*. - - - - - - - - - &reftitle.returnvalues; - - Retourne soit une &string; ou un &integer; suivant le - paramètre key. Lance une exception - ZMQContextException si une erreur survient. - - - - - - diff --git a/reference/zmq/zmqcontext/getsocket.xml b/reference/zmq/zmqcontext/getsocket.xml deleted file mode 100644 index 986135e12e..0000000000 --- a/reference/zmq/zmqcontext/getsocket.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - ZMQContext::getSocket - Crée un nouveau socket - - - - &reftitle.description; - - public ZMQSocketZMQContext::getSocket - inttype - stringpersistent_id&null; - callableon_new_socket&null; - - - Raccourci pour créer de nouveaux sockets depuis le contexte. Si le contexte - n'est pas persistant, le paramètre persistent_id - sera ignoré, et le socket deviendra non persistant. Le paramètre - on_new_socket ne sera appelé que si une nouvelle structure - sous-jacente de socket est créée. - - - - - &reftitle.parameters; - - - - type - - - Une constante ZMQ::SOCKET_* pour spécifier le type de socket. - - - - - persistent_id - - - Si persistent_id est spécifié, le socket sera persistant - entre les différentes requêtes. - - - - - on_new_socket - - - Fonction de rappel, qui sera exécutée lorsqu'une nouvelle structure de socket est - créée. Cette fonction ne sera pas appelée si la connexion sous-jacente persistante - est ré-utilisée. La fonction de rappel prend deux arguments : ZMQSocket et persistent_id. - - - - - - - - - &reftitle.returnvalues; - - Retourne un objet ZMQSocket. - - - - - &reftitle.errors; - - Lance une ZMQSocketException en cas d'erreur. - - - - - &reftitle.examples; - - - Exemple avec <function>ZMQContext</function> - - Basic usage - - -getSocket(ZMQ::SOCKET_REQ, 'my sock'); - -/* Connexion au socket */ -$socket->connect("tcp://example.com:1234"); - -/* Envoi une requête */ -$socket->send("Hello there"); - -/* Réception de la réponse */ -$message = $socket->recv(); -echo "Received message: {$message}\n"; -?> -]]> - - - - - - - - diff --git a/reference/zmq/zmqcontext/ispersistent.xml b/reference/zmq/zmqcontext/ispersistent.xml deleted file mode 100644 index ab6fd14513..0000000000 --- a/reference/zmq/zmqcontext/ispersistent.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - ZMQContext::isPersistent - Vérifie si le contexte est persistant - - - - &reftitle.description; - - public boolZMQContext::isPersistent - - - - Vérifie si le contexte est persistant. Un contexte persistant est nécessaire - pour les connexions persistantes, sachant que chaque socket est - alloué à un contexte. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne &true; si le contexte est persistant, et &false; s'il ne l'est pas. - - - - - - - diff --git a/reference/zmq/zmqcontext/setopt.xml b/reference/zmq/zmqcontext/setopt.xml deleted file mode 100644 index bb3f96b990..0000000000 --- a/reference/zmq/zmqcontext/setopt.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - ZMQContext::setOpt - Définit une option de socket - - - - &reftitle.description; - - public ZMQContextZMQContext::setOpt - intkey - mixedvalue - - - Définit une option de contexte ZMQ. Le type du paramètre - value dépend du paramètre key. - Voir les types de constantes ZMQ pour - plus d'informations. - - - - - &reftitle.parameters; - - - - key - - - Une constante ZMQ::CTXOPT_*. - - - - - value - - - La valeur du paramètre. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet courant. Lance une exception - ZMQContextException si une erreur survient. - - - - - - - diff --git a/reference/zmq/zmqcontextexception.xml b/reference/zmq/zmqcontextexception.xml deleted file mode 100644 index 434930e755..0000000000 --- a/reference/zmq/zmqcontextexception.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - La classe ZMQContextException - ZMQContextException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQContextException - - - - - ZMQContextException - - - - extends - ZMQException - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -     - -     - - diff --git a/reference/zmq/zmqdevice.xml b/reference/zmq/zmqdevice.xml deleted file mode 100644 index 0a8b717c20..0000000000 --- a/reference/zmq/zmqdevice.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - La classe ZMQDevice - ZMQDevice - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQDevice - - - - - ZMQDevice - - - - - &Methods; - - - - -
    - -     - - &reference.zmq.entities.zmqdevice; - -     - - diff --git a/reference/zmq/zmqdevice/construct.xml b/reference/zmq/zmqdevice/construct.xml deleted file mode 100644 index bfe8783acf..0000000000 --- a/reference/zmq/zmqdevice/construct.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - ZMQDevice::__construct - Construit un nouveau périphérique - - - - &reftitle.description; - - public ZMQDevice::__construct - ZMQSocketfrontend - ZMQSocketbackend - ZMQSocketlistener - - - "Les périphériques ØMQ peuvent effectuer une médiation entre les - adresses, les services, les files d'attente ou toute autre abstraction - pour définir le message et l'interface des sockets." -- zguide - - - - - &reftitle.parameters; - - - frontend - - - Paramètre Frontend pour le périphérique. Habituellement le lieu - d'arrivée des messages. - - - - - backend - - - Paramètre Backend pour le périphérique. Habituellement le lieu - de départ des messages. - - - - - listener - - - Socket d'écoute, qui reçoit une copie de tous les messages - entrants et sortants. Le type de ce socket doit être - SUB, PULL ou DEALER. - - - - - - - - &reftitle.returnvalues; - - L'appel à cette méthode va préparer le périphérique. Habituellement, - les périphériques sont des processus qui s'exécutent pendant beaucoup - de temps, aussi l'exécution de cette méthode depuis un script interactif - n'est pas recommandée. Cette méthode lance une exception ZMQDeviceException - si le périphérique ne peut être lancé. - - - - - - - diff --git a/reference/zmq/zmqdevice/getidletimeout.xml b/reference/zmq/zmqdevice/getidletimeout.xml deleted file mode 100644 index 38b518611c..0000000000 --- a/reference/zmq/zmqdevice/getidletimeout.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - ZMQDevice::getIdleTimeout - Récupère le délai d'attente maximal d'inactivité - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::getIdleTimeout - - - - Récupère le délai d'attente maximal d'inactivité. - Ajouté dans l'extension ZMQ en version 1.1.0. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Cette méthode retourne la valeur du délai d'attente maximal de la - fonction de rappel d'inactivité. - - - - - diff --git a/reference/zmq/zmqdevice/gettimertimeout.xml b/reference/zmq/zmqdevice/gettimertimeout.xml deleted file mode 100644 index 4eaae56ff3..0000000000 --- a/reference/zmq/zmqdevice/gettimertimeout.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - ZMQDevice::getTimerTimeout - Récupère le délai d'attente maximal du timer - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::getTimerTimeout - - - - Récupère la valeur du délai maximal d'attente de la fonction de rappel - d'inactivité. Ajouté à l'extension ZMQ en version 1.1.0. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Cette méthode retourne la valeur du délai maximal d'attente du timer. - - - - - diff --git a/reference/zmq/zmqdevice/run.xml b/reference/zmq/zmqdevice/run.xml deleted file mode 100644 index 97315466da..0000000000 --- a/reference/zmq/zmqdevice/run.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - ZMQDevice::run - Exécute le nouveau périphérique - - - - &reftitle.description; - - public voidZMQDevice::run - - - - Exécute le périphérique. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - L'appel à cette méthode est bloquant tant que le périphérique - est en fonctionnement. Il n'est pas recommandé d'utiliser les - périphériques depuis des scripts interactifs. En cas d'échec, - cette méthode lancera une exception ZMQDeviceException. - - - - - - diff --git a/reference/zmq/zmqdevice/setidlecallback.xml b/reference/zmq/zmqdevice/setidlecallback.xml deleted file mode 100644 index 9e464a32a6..0000000000 --- a/reference/zmq/zmqdevice/setidlecallback.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - ZMQDevice::setIdleCallback - Définit la fonction de rappel d'inactivité - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::setIdleCallback - callablecb_func - inttimeout - mixeduser_data - - - Définit la fonction de rappel d'inactivité. Si le délai d'attente maximal - d'inactivité est défini, la fonction de rappel d'inactivité sera - appelée si la boucle interne expire sans événement. Si la fonction de - rappel retourne &false; ou une valeur évaluée à &false;, le périphérique - est stoppé. La signature de la fonction de rappel est : mixed $user_data. - - - - - &reftitle.parameters; - - - cb_func - - - La fonction de rappel à appeler lorsque le périphérique est inactif. - Le fait de retourner &false; ou une valeur évaluée à &false; stoppera - le périphérique. - - - - - timeout - - - Le délai d'attente maximal avant d'appeler la fonction de rappel, en millisecondes. - La fonction de rappel est appelée périodiquement lorsqu'il n'y a aucune activité - sur le périphérique. La valeur du délai d'attente maximal garantit qu'il y aura - au moins cette durée entre les appels à la fonction de rappel. - - - - - user_data - - - Données additionnelles à passer à la fonction de rappel. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette méthode retourne l'objet courant. - - - - - - - diff --git a/reference/zmq/zmqdevice/setidletimeout.xml b/reference/zmq/zmqdevice/setidletimeout.xml deleted file mode 100644 index c7bac34117..0000000000 --- a/reference/zmq/zmqdevice/setidletimeout.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - ZMQDevice::setIdleTimeout - Définit le délai d'attente maximal d'inactivité - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::setIdleTimeout - inttimeout - - - Définit la valeur du délai d'attente maximal de la fonction de rappel - d'inactivité. Cette fonction de rappel est appelée périodiquement lorsque - le périphérique est inactif. - - - - - &reftitle.parameters; - - - timeout - - - La valeur du délai d'attente maximal de la fonction de rappel d'inactivité. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette méthode retourne l'objet courant. - - - - - - - diff --git a/reference/zmq/zmqdevice/settimercallback.xml b/reference/zmq/zmqdevice/settimercallback.xml deleted file mode 100644 index 809ded7aca..0000000000 --- a/reference/zmq/zmqdevice/settimercallback.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - ZMQDevice::setTimerCallback - Définit la fonction de rappel du timer - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::setTimerCallback - callablecb_func - inttimeout - mixeduser_data - - - Définit la fonction de rappel du timer. La fonction de rappel du timer - est appelée à l'expiration du délai maximal d'attente. La différence - entre les fonctions de rappel de l'inactivité et du timer est que - la fonction de rappel de l'inactivité est appelée uniquement lorsque le - périphérique est inactif. La signature de la fonction de rappel - est : callback (mixed $user_data). Ajouté dans l'extension ZMQ en version 1.1.0. - - - - - &reftitle.parameters; - - - cb_func - - - Fonction de rappel à appeler lorsque le timer se déclenche. - Elle doit retourner &false; ou une valeur évaluée à &false; - pour stopper le périphérique. - - - - - timeout - - - Indique à partir de combien de temps la fonction de rappel du timer - doit être appelée, en millisecondes. La fonction de rappel - du timer est appelée périodiquement. La valeur du délai d'attente - maximal garantit qu'il y aura au moins ce temps-là avant l'appel - à la fonction de rappel. - - - - - user_data - - - Données additionnelles à passer à la fonction de rappel. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette méthode retourne l'objet courant. - - - - - - - diff --git a/reference/zmq/zmqdevice/settimertimeout.xml b/reference/zmq/zmqdevice/settimertimeout.xml deleted file mode 100644 index 3a2b29088e..0000000000 --- a/reference/zmq/zmqdevice/settimertimeout.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - ZMQDevice::setTimerTimeout - Définit le délai d'attente maximal du timer - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::setTimerTimeout - inttimeout - - - Définit la valeur du délai maximal d'attente de la fonction - de rappel du timer. Cette fonction de rappel est appelée périodiquement - si elle a été définie. Ajouté dans l'extension ZMQ en version 1.1.0. - - - - - &reftitle.parameters; - - - timeout - - - La valeur du délai d'attente maximal de la fonction de rappel. - - - - - - - - &reftitle.returnvalues; - - En cas de succès, cette méthode retourne l'objet courant. - - - - - - - diff --git a/reference/zmq/zmqdeviceexception.xml b/reference/zmq/zmqdeviceexception.xml deleted file mode 100644 index cf85fdb215..0000000000 --- a/reference/zmq/zmqdeviceexception.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - La classe ZMQDeviceException - ZMQDeviceException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQDeviceException - - - - - ZMQDeviceException - - - - extends - ZMQException - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -     - -     - - diff --git a/reference/zmq/zmqexception.xml b/reference/zmq/zmqexception.xml deleted file mode 100644 index 475e3eb619..0000000000 --- a/reference/zmq/zmqexception.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - La classe ZMQException - ZMQException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQException - - - - - ZMQException - - - - extends - Exception - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -     - -     - - diff --git a/reference/zmq/zmqpoll.xml b/reference/zmq/zmqpoll.xml deleted file mode 100644 index 2764971f2f..0000000000 --- a/reference/zmq/zmqpoll.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - La classe ZMQPoll - ZMQPoll - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQPoll - - - - - ZMQPoll - - - - - &Methods; - - - - -
    - -     - - &reference.zmq.entities.zmqpoll; - -     - - diff --git a/reference/zmq/zmqpoll/add.xml b/reference/zmq/zmqpoll/add.xml deleted file mode 100644 index 0879ff3e28..0000000000 --- a/reference/zmq/zmqpoll/add.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - ZMQPoll::add - Ajoute un élément dans le poll - - - - &reftitle.description; - - public stringZMQPoll::add - mixedentry - inttype - - - Ajoute un nouvel élément dans le poll, et retourne l'ID interne - de l'élément ajouté. L'élément peut être supprimé du poll en utilisant - cet ID. - - - - - &reftitle.parameters; - - - - entry - - - Objet ZMQSocket ou une ressource de flux PHP - - - - - type - - - Définit l'activité prévue du socket. - Voir les constantes ZMQ::POLL_IN et - ZMQ::POLL_OUT. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'ID de l'élément ajouté, qui pourra être utilisé par la suite - pour supprimer l'élément. Lance une exception ZMQPollException en cas - d'erreur. - - - - - - - diff --git a/reference/zmq/zmqpoll/clear.xml b/reference/zmq/zmqpoll/clear.xml deleted file mode 100644 index a0de4268c9..0000000000 --- a/reference/zmq/zmqpoll/clear.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - ZMQPoll::clear - Supprime tous les éléments du poll - - - - &reftitle.description; - - public ZMQPollZMQPoll::clear - - - - Supprime tous les éléments du poll. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'objet courant. - - - - - - - diff --git a/reference/zmq/zmqpoll/count.xml b/reference/zmq/zmqpoll/count.xml deleted file mode 100644 index 2ee3de817a..0000000000 --- a/reference/zmq/zmqpoll/count.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - ZMQPoll::count - Compte les éléments du poll - - - - &reftitle.description; - - public intZMQPoll::count - - - - Compte les éléments du poll. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &integer; représentant tous les éléments du poll. - - - - - - - diff --git a/reference/zmq/zmqpoll/getlasterrors.xml b/reference/zmq/zmqpoll/getlasterrors.xml deleted file mode 100644 index 3b0ebd9a5a..0000000000 --- a/reference/zmq/zmqpoll/getlasterrors.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - ZMQPoll::getLastErrors - Récupère les erreurs du poll - - - - &reftitle.description; - - public arrayZMQPoll::getLastErrors - - - - Retourne les IDs des objets qui ont des erreurs dans le dernier poll. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les IDs des éléments qui ont des erreurs - dans le dernier poll. Un tableau vide est retourné s'il n'y a aucune - erreur. - - - - - - - diff --git a/reference/zmq/zmqpoll/poll.xml b/reference/zmq/zmqpoll/poll.xml deleted file mode 100644 index b2e93d7899..0000000000 --- a/reference/zmq/zmqpoll/poll.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - - ZMQPoll::poll - Sonde les éléments - - - - &reftitle.description; - - public intZMQPoll::poll - arrayreadable - arraywritable - inttimeout-1 - - - Sonde les éléments du poll courant. Les éléments accessibles en lecture et en écriture - sont retournés respectivement dans les paramètres - readable et writable. - La méthode ZMQPoll::getLastErrors peut être utilisée pour vérifier - s'il y a des erreurs. - - - - - &reftitle.parameters; - - - - readable - - - Tableau contenant les ZMQSockets/flux PHP retournés, et accessible en lecture. - Le tableau sera réinitialisé au début de l'opération. - - - - - writable - - - Tableau contenant les ZMQSockets/flux PHP retournés, et accessible en écriture. - Le tableau sera réinitialisé au début de l'opération. - - - - - timeout - - - Délai maximal d'attente de l'opération. -1 signifie que le poll va attendre - qu'au moins un élément ne soit actif. Il est à noter que depuis la version 1.0.0, le - délai maximal d'attente du poll est défini en millisecondes, plutôt qu'en - microsecondes. - - - - - - - - - &reftitle.returnvalues; - - Retourne un entier représentant la quantité d'objets avec activité. - - - - - &reftitle.errors; - - Lance une ZMQPollException en cas d'erreur. - - - - - &reftitle.examples; - - - Exemple avec <function>ZMQPoll</function> - - Crée un serveur poll simple - - -getSocket(ZMQ::SOCKET_REP); - -/* Lie le port 5555 sur 127.0.0.1 */ -$server->bind("tcp://127.0.0.1:5555"); - -/* Crée un nouveau poll pour les messages entrants/sortants */ -$poll = new ZMQPoll(); - -/* Ajoute l'objet et écoute les entrées/sorties du poll */ -$id = $poll->add($server, ZMQ::POLL_IN | ZMQ::POLL_OUT); -echo "Added object with id " . $id . "\n"; - -/* Initialise les tableaux accueillant les éléments en lecture et écriture */ -$readable = array(); -$writable = array(); - -while (true) { - /* Nombre d'événements à récupérer */ - $events = 0; - - try { - /* Bloque le Poll tant qu'il y a quelque chose à faire */ - $events = $poll->poll($readable, $writable, -1); - $errors = $poll->getLastErrors(); - - if (count($errors) > 0) { - foreach ($errors as $error) { - echo "Error polling object " . $error . "\n"; - } - } - } catch (ZMQPollException $e) { - echo "poll failed: " . $e->getMessage() . "\n"; - } - - if ($events > 0) { - /* Boucle sur les objets accessibles en lecture et réceptionne les messages */ - foreach ($readable as $r) { - try { - echo "Received message: " . $r->recv() . "\n"; - } catch (ZMQException $e) { - echo "recv failed: " . $e->getMessage() . "\n"; - } - } - - /* Boucle sur les objets accessibles en écriture et retourne les messages */ - foreach ($writable as $w) { - try { - $w->send("Got it!"); - } catch (ZMQException $e) { - echo "send failed: " . $e->getMessage() . "\n"; - } - } - } -} -?> -]]> - - - - - - - diff --git a/reference/zmq/zmqpoll/remove.xml b/reference/zmq/zmqpoll/remove.xml deleted file mode 100644 index 4830383218..0000000000 --- a/reference/zmq/zmqpoll/remove.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - ZMQPoll::remove - Supprime un élément du poll - - - - &reftitle.description; - - public boolZMQPoll::remove - mixeditem - - - Supprime un élément du poll. Le paramètre item - peut être un objet ZMQSocket, une ressource de flux, - ou l'ID retourné depuis la méthode ZMQPoll::add. - - - - - &reftitle.parameters; - - - - item - - - L'objet ZMQSocket, le flux PHP ou une &string; représentant - l'id de l'élément. - - - - - - - - - &reftitle.returnvalues; - - Retourne &true; si l'élément a été supprimé et &false; si l'objet - avec l'ID fourni n'existe pas dans le poll. - - - - - - - diff --git a/reference/zmq/zmqpollexception.xml b/reference/zmq/zmqpollexception.xml deleted file mode 100644 index bfeb84b518..0000000000 --- a/reference/zmq/zmqpollexception.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - La classe ZMQPollException - ZMQPollException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQPollException - - - - - ZMQPollException - - - - extends - ZMQException - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -     - -     - - diff --git a/reference/zmq/zmqsocket.xml b/reference/zmq/zmqsocket.xml deleted file mode 100644 index 9317be800b..0000000000 --- a/reference/zmq/zmqsocket.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - La classe ZMQSocket - ZMQSocket - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQSocket - - - - - ZMQSocket - - - - - &Methods; - - - - -
    - -     - - &reference.zmq.entities.zmqsocket; - -     - - diff --git a/reference/zmq/zmqsocket/bind.xml b/reference/zmq/zmqsocket/bind.xml deleted file mode 100644 index b1b2a16759..0000000000 --- a/reference/zmq/zmqsocket/bind.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - ZMQSocket::bind - Lie un socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::bind - stringdsn - boolforce&false; - - - Lie un socket à un point final. Le point final est défini au format - transport://address où le transport peut être - une des valeurs suivantes : inproc, ipc, tcp, pgm ou epgm. - - - - - &reftitle.parameters; - - - - dsn - - - Le DSN, par exemple : transport://address. - - - - - force - - - On tente le lien même si le socket a déjà été lié au point final - donné. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet courant. Lance une exception - ZMQSocketException en cas d'erreur. - - - - - - - diff --git a/reference/zmq/zmqsocket/connect.xml b/reference/zmq/zmqsocket/connect.xml deleted file mode 100644 index c0c4690da3..0000000000 --- a/reference/zmq/zmqsocket/connect.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - ZMQSocket::connect - Connecte le socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::connect - stringdsn - boolforce&false; - - - Connecte le socket à un point final distant. Le point final est défini - au format transport://address où le transport - est une des valeurs suivantes : inproc, ipc, tcp, pgm ou epgm. - - - - - &reftitle.parameters; - - - - dsn - - - Le DSN de connexion, par exemple : transport://address. - - - - - force - - - Tente de se connecter même si le socket est déjà connecté au - point final fourni. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet courant. - - - - - &reftitle.errors; - - Lance une ZMQSocketException en cas d'erreur. - - - - - &reftitle.examples; - - - Exemple avec <function>ZMQContext</function> - - Construit un nouveau contexte et y alloue la requête du socket - - -getEndpoints(); - -/* Vérifie si le socket est connecté */ -if (!in_array($dsn, $endpoints['connect'])) { - echo "

    Connecting to $dsn

    "; - $socket->connect($dsn); -} else { - echo "

    Already connected to $dsn

    "; -} - -/* Envoi et réception */ -$socket->send("Hello!"); -$message = $socket->recv(); - -echo "

    Server said: {$message}

    "; -?> -]]> -     -     -     -     - -     - diff --git a/reference/zmq/zmqsocket/construct.xml b/reference/zmq/zmqsocket/construct.xml deleted file mode 100644 index 19467f0b99..0000000000 --- a/reference/zmq/zmqsocket/construct.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - ZMQSocket::__construct - Construit un nouveau ZMQSocket - - - - &reftitle.description; - - public ZMQSocket::__construct - ZMQContextcontext - inttype - stringpersistent_id&null; - callableon_new_socket&null; - - - Construit un objet ZMQSocket. Le paramètre persistent_id - peut être utilisé pour allouer un socket persistant. Un socket - persistant doit être alloué depuis un contexte persistant, - et il restera connecté pendant plusieurs requêtes. Le paramètre - persistent_id peut être utilisé - pour ré-appeler le même socket lors des prochaines requêtes. - on_new_socket est appelé uniquement lorsqu'une - nouvelle structure sous-jacente de socket est créée. - - - - - &reftitle.parameters; - - - - context - - - Objet ZMQContext. - - - - - type - - - Le type de socket. Voir les constantes ZMQ::SOCKET_*. - - - - - persistent_id - - - Si persistent_id est spécifié, le socket sera - persistant pendant plusieurs requêtes. Si context - n'est pas persistant, le socket passera automatiquement en mode non-persistant. - - - - - on_new_socket - - - Fonction de rappel, qui sera exécutée lorsqu'une nouvelle structure de socket - sera créée. Cette fonction ne sera pas appelée si la connexion - persistante est ré-appelée. - - - callback - ZMQSocketsocket - stringpersistent_id&null; - - - - - - - - - &reftitle.errors; - - Lance une ZMQSocketException en cas d'erreur. - - - - - &reftitle.examples; - - - Exemple avec <function>ZMQSocket</function> - - Utilisation de la fonction de rappel sur le socket lié/connecté - - -bind("tcp://localhost:12122"); - } else { - $socket->connect("tcp://localhost:12122"); - } -} - -/* Alloue un nouveau contexte */ -$context = new ZMQContext(); - -/* Crée un nouveau socket */ -$socket = $context->getSocket(ZMQ::SOCKET_REP, 'server', 'on_new_socket_cb'); - -$message = $socket->recv(); -echo "Received message: {$message}\n"; -?> -]]> - - - - - - - diff --git a/reference/zmq/zmqsocket/disconnect.xml b/reference/zmq/zmqsocket/disconnect.xml deleted file mode 100644 index a6e36fa1e5..0000000000 --- a/reference/zmq/zmqsocket/disconnect.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ZMQSocket::disconnect - Déconnecte un socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::disconnect - stringdsn - - - Déconnecte le socket d'un point final distant précédemment connecté. - Le point final est défini au format transport://address - où le transport est un des suivants : inproc, ipc, tcp, pgm ou epgm. - - - - - &reftitle.parameters; - - - - dsn - - - Le DSN de connexion, par exemple : transport://address. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet courant. Lance une exception - ZMQSocketException en cas d'erreur. - - - - - - diff --git a/reference/zmq/zmqsocket/getendpoints.xml b/reference/zmq/zmqsocket/getendpoints.xml deleted file mode 100644 index 972b81668f..0000000000 --- a/reference/zmq/zmqsocket/getendpoints.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - ZMQSocket::getEndpoints - Récupère la liste des points finaux - - - - &reftitle.description; - - public arrayZMQSocket::getEndpoints - - - - Retourne une liste des points finaux sur lesquels le socket est connecté - ou lié. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un tableau contenant les éléments 'bind' et 'connect'. - - - - - - diff --git a/reference/zmq/zmqsocket/getpersistentid.xml b/reference/zmq/zmqsocket/getpersistentid.xml deleted file mode 100644 index d8ba2aa41a..0000000000 --- a/reference/zmq/zmqsocket/getpersistentid.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - ZMQSocket::getPersistentId - Récupère l'ID persistant - - - - &reftitle.description; - - public stringZMQSocket::getPersistentId - - - - Retourne l'ID persistant du socket. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne l'ID persistant assigné à l'objet ou - &null; si le socket n'est pas persistant. - - - - - - diff --git a/reference/zmq/zmqsocket/getsockettype.xml b/reference/zmq/zmqsocket/getsockettype.xml deleted file mode 100644 index c1ad1b33dc..0000000000 --- a/reference/zmq/zmqsocket/getsockettype.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - ZMQSocket::getSocketType - Récupère le type du socket - - - - &reftitle.description; - - public intZMQSocket::getSocketType - - - - Récupère le type du socket. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un entier représentant le type du socket. - L'entier peut être comparé à une des constantes - ZMQ::SOCKET_*. - - - - - - diff --git a/reference/zmq/zmqsocket/getsockopt.xml b/reference/zmq/zmqsocket/getsockopt.xml deleted file mode 100644 index 17bddd3f08..0000000000 --- a/reference/zmq/zmqsocket/getsockopt.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ZMQSocket::getSockOpt - Récupère une option du socket - - - - &reftitle.description; - - public mixedZMQSocket::getSockOpt - stringkey - - - Retourne la valeur d'une option du socket. - - - - - &reftitle.parameters; - - - - key - - - Un entier représentant l'option. - Voir les constantes ZMQ::SOCKOPT_*. - - - - - - - - - &reftitle.returnvalues; - - Retourne soit une &string;, soit un &integer; - suivant le paramètre key. Lance une exception - ZMQSocketException en cas d'erreur. - - - - - - diff --git a/reference/zmq/zmqsocket/ispersistent.xml b/reference/zmq/zmqsocket/ispersistent.xml deleted file mode 100644 index 7f2969009b..0000000000 --- a/reference/zmq/zmqsocket/ispersistent.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - ZMQSocket::isPersistent - Vérifie si le socket est persistant - - - - &reftitle.description; - - public boolZMQSocket::isPersistent - - - - Vérifie si le socket est persistant. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retourne un &boolean; suivant si le socket est persistant ou non. - - - - - - - diff --git a/reference/zmq/zmqsocket/recv.xml b/reference/zmq/zmqsocket/recv.xml deleted file mode 100644 index 9c7daba3af..0000000000 --- a/reference/zmq/zmqsocket/recv.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - ZMQSocket::recv - Reçoit un message - - - - &reftitle.description; - - public stringZMQSocket::recv - intmode0 - - - Reçoit un message du socket. Par défaut, la réception va être bloquante - tant qu'un message est disponible, à moins que - ZMQ::MODE_DONTWAIT ne soit utilisé. - L'option ZMQ::SOCKOPT_RCVMORE du socket peut - être utilisée pour recevoir des messages multipart. - Voir ZMQSocket::setSockOpt pour plus d'informations. - - - - - &reftitle.parameters; - - - - mode - - - Drapeaux de mode pour recevoir les messages multipart, ou rendre - l'opération non-bloquante. Voir les constantes - ZMQ::MODE_*. - - - - - - - - - &reftitle.returnvalues; - - Retourne le message. Si ZMQ::MODE_DONTWAIT - est utilisé et que l'opération bloquerait &false; devrait être retourné. - - - - - &reftitle.errors; - - Lance une ZMQSocketException en cas d'erreur. - - - - - &reftitle.examples; - - - Un exemple d'envoi/réception - - Envoi et réception non bloquante - - -connect("tcp://127.0.0.1:5555"); - -/* Assigne le socket 1 à la file, envoi et réceptionne */ -$retries = 5; -$sending = true; - -/* Démarre la boucle */ -do { - try { - /* Tente un envoi/réception */ - if ($sending) { - echo "Envoi du message\n"; - $queue->send("Ceci est un message", ZMQ::MODE_DONTWAIT); - $sending = false; - } else { - echo "Réception de la réponse : " . $queue->recv(ZMQ::MODE_DONTWAIT) . "\n"; - break; - } - } catch (ZMQSocketException $e) { - /* EAGAIN signifie que l'opération a bloqué ; nouvelle tentative */ - if ($e->getCode() === ZMQ::ERR_EAGAIN) { - echo " - Réception de EAGAIN, nouvelle tentative ($retries)\n"; - } else { - die(" - Erreur : " . $e->getMessage()); - } - } - /* On attend un peu entre les opérations */ - usleep(5); -} while (--$retries); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/zmq/zmqsocket/recvmulti.xml b/reference/zmq/zmqsocket/recvmulti.xml deleted file mode 100644 index f69e596d7b..0000000000 --- a/reference/zmq/zmqsocket/recvmulti.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - ZMQSocket::recvMulti - Reçoit un message multipart - - - - &reftitle.description; - - public arrayZMQSocket::recvMulti - intmode0 - - - Reçoit un tableau contenant le message multipart depuis un socket. - Par défaut, la réception va être bloquante tant qu'un message est disponible - à moins que ZMQ::MODE_NOBLOCK ne soit utilisé. - - - - - &reftitle.parameters; - - - - mode - - - Drapeaux de mode pour recevoir les messages multipart, ou faire que - l'opération ne soit pas bloquante. Voir les constantes - ZMQ::MODE_*. - - - - - - - - - &reftitle.returnvalues; - - Retourne le tableau contenant les parties du message. Lance une - exception ZMQSocketException en cas d'erreur. - Si ZMQ::MODE_NOBLOCK est utilisé et que l'opération - est bloquante, &false; sera retourné. - - - - - - - diff --git a/reference/zmq/zmqsocket/send.xml b/reference/zmq/zmqsocket/send.xml deleted file mode 100644 index ec92f60500..0000000000 --- a/reference/zmq/zmqsocket/send.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - ZMQSocket::send - Envoie un message - - - - &reftitle.description; - - public ZMQSocketZMQSocket::send - stringmessage - intmode0 - - - Envoie un message en utilisant le socket. L'opération peut être bloquante - à moins que ZMQ::MODE_NOBLOCK ne soit utilisé. - - - - - &reftitle.parameters; - - - - message - - - Le message à envoyer. - - - - - mode - - - Drapeaux du mode pour recevoir des messages multipart ou rendre - l'opération non-bloquante. Voir les constantes - ZMQ::MODE_*. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet courant. Lance une exception ZMQSocketException en cas - d'erreur. Si ZMQ::MODE_NOBLOCK est utilisé, et que - l'opération est bloquante, &false; sera retourné. - - - - - diff --git a/reference/zmq/zmqsocket/sendmulti.xml b/reference/zmq/zmqsocket/sendmulti.xml deleted file mode 100644 index fbfec2f3ae..0000000000 --- a/reference/zmq/zmqsocket/sendmulti.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - ZMQSocket::sendmulti - Envoie un message multipart - - - - &reftitle.description; - - public ZMQSocketZMQSocket::sendmulti - arraymessage - intmode0 - - - Envoie un message multipart en utilisant le socket. L'opération - sera bloquante à moins que ZMQ::MODE_NOBLOCK - ne soit utilisé. - - - - - &reftitle.parameters; - - - - message - - - Le message à envoyer - un tableau de chaînes de caractères - - - - - mode - - - Drapeaux pour le mode pour recevoir les messages multipart ou - faire que l'opération ne soit pas bloquante. Voir les constantes - ZMQ::MODE_*. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet courant. Lance une exception - ZMQSocketException en cas d'erreur. Si ZMQ::MODE_NOBLOCK - est utilisé, et que l'opération est bloquante, &false; sera retourné. - - - - - diff --git a/reference/zmq/zmqsocket/setsockopt.xml b/reference/zmq/zmqsocket/setsockopt.xml deleted file mode 100644 index 5632216fab..0000000000 --- a/reference/zmq/zmqsocket/setsockopt.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - ZMQSocket::setSockOpt - Définit une option de socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::setSockOpt - intkey - mixedvalue - - - Définit une option de socket ZMQ. Le type du paramètre - value dépend de la clé key. - Voir les types de constantes ZMQ - pour plus d'informations. - - - - - &reftitle.parameters; - - - - key - - - Une constante ZMQ::SOCKOPT_*. - - - - - value - - - La valeur du paramètre. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet courant. Lance une exception - ZMQSocketException en cas d'erreur. - - - - - - - diff --git a/reference/zmq/zmqsocket/unbind.xml b/reference/zmq/zmqsocket/unbind.xml deleted file mode 100644 index aea0b1638f..0000000000 --- a/reference/zmq/zmqsocket/unbind.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - ZMQSocket::unbind - Dé-lie le socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::unbind - stringdsn - - - Dé-lie le socket du point final. Le point final est défini au format - transport://address où le transport peut être - une des valeurs suivantes : inproc, ipc, tcp, pgm ou epgm. - - - - - &reftitle.parameters; - - - - dsn - - - Le DSN précédemment lié, par exemple : transport://address. - - - - - - - - - &reftitle.returnvalues; - - Retourne l'objet courant. Lance une exception - ZMQSocketException en cas d'erreur. - - - - - - - diff --git a/reference/zmq/zmqsocketexception.xml b/reference/zmq/zmqsocketexception.xml deleted file mode 100644 index 84bfcd00ad..0000000000 --- a/reference/zmq/zmqsocketexception.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - La classe ZMQSocketException - ZMQSocketException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQSocketException - - - - - ZMQSocketException - - - - extends - ZMQException - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -     - -     - - diff --git a/reference/zookeeper/book.xml b/reference/zookeeper/book.xml deleted file mode 100644 index b21fdcb964..0000000000 --- a/reference/zookeeper/book.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - ZooKeeper - ZooKeeper - - - - &reftitle.intro; - - Cette extension utilise la bibliothèque libzookeeper pour fournir une API permettant - de communiquer avec le service Zookeeper. - - - ZooKeeper est un projet Apache qui fournit un service centralisé pour maintenir - les informations de configuration et de nommage, avec une synchronisation distribuée - et des groupes de services. - - - - - &reference.zookeeper.setup; - - &reference.zookeeper.reference; - - &reference.zookeeper.zookeeper; - &reference.zookeeper.zookeeperconfig; - - &reference.zookeeper.zookeeperexception; - &reference.zookeeper.zookeeperauthenticationexception; - &reference.zookeeper.zookeeperconnectionexception; - &reference.zookeeper.zookeepermarshallingexception; - &reference.zookeeper.zookeepernonodeexception; - &reference.zookeeper.zookeeperoperationtimeoutexception; - &reference.zookeeper.zookeepersessionexception; - - - - - diff --git a/reference/zookeeper/configure.xml b/reference/zookeeper/configure.xml deleted file mode 100644 index 8f947e7533..0000000000 --- a/reference/zookeeper/configure.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;zookeeper. - - - - Pour utiliser zookeeper, configurer PHP avec l'option - . - DIR est le préfixe du dossier d'installation du client C, il doit contenir le - fichier include/zookeeper/zookeeper.h - - - &pecl.windows.download; - -
    - - - diff --git a/reference/zookeeper/functions/zookeeper_dispatch.xml b/reference/zookeeper/functions/zookeeper_dispatch.xml deleted file mode 100644 index b10d72c208..0000000000 --- a/reference/zookeeper/functions/zookeeper_dispatch.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - zookeeper_dispatch - Appelle les fonctions de rappel pour les opérations en attente - - - - &reftitle.description; - - voidzookeeper_dispatch - - - - - La fonction zookeeper_dispatch appelle les fonctions de rappel passées par les opérations comme Zookeeper::get ou Zookeeper::exists. - - - - - Depuis la version 0.4.0, cette fonction doit être appelée manuellement pour réaliser des opérations asynchrones. Pour que cela soit fait automatiquement, il est également possible de déclarer des ticks au début du programme. - - - - - Après PHP 7.1, il est possible d'ignorer cette fonction. Cette extension utilise EG(vm_interrupt) pour implémenter la répartition asynchrone. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Cette méthode émet une alerte PHP lorsque la fonction de rappel ne peut pas être invoquée. - - - - - &reftitle.examples; - - Exemple de <methodname>zookeeper_dispatch</methodname> #1 - - Répartir manuellement les fonctions de rappel. - - -connect('localhost:2181'); -$client->get('/zookeeper', function() { - echo "Callback was called".PHP_EOL; -}); -while(true) { - sleep(1); - zookeeper_dispatch(); -} -?> -]]> - - - - - Exemple de <methodname>zookeeper_dispatch</methodname> #2 - - Déclarer des ticks. - - -connect('localhost:2181'); -$client->get('/zookeeper', function() { - echo "Callback was called".PHP_EOL; -}); -while(true) { - sleep(1); -} -?> -]]> - - - - - - &reftitle.seealso; - - - Zookeeper::addAuth - Zookeeper::connect - Zookeeper::__construct - Zookeeper::exists - Zookeeper::get - Zookeeper::getChildren - Zookeeper::setWatcher - - - - - - - diff --git a/reference/zookeeper/ini.xml b/reference/zookeeper/ini.xml deleted file mode 100644 index 47e79a9628..0000000000 --- a/reference/zookeeper/ini.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - - Zookeeper &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - zookeeper.recv_timeout - 10000 - INI_ALL - - - - zookeeper.session_lock - 1 - INI_SYSTEM - - - - zookeeper.sess_lock_wait - 150000 - INI_ALL - - - - -
    - - &ini.php.constants; - -     - - &ini.descriptions.title; - - - - - - - zookeeper.recv_timeout - int - - - - Délai maximum d'attente par défaut pour toutes les sessions de ZooKeeper. - - - - - - - zookeeper.session_lock - int - - - - Autorise le verrouillage des sessions PHP. - - - - - - - zookeeper.sess_lock_wait - int - - - - Temps d'attente en microsecondes pour les tentatives de verrouillage de la session PHP. - Il faut être prudent lors de la définition de cette valeur. Les valeurs valides sont des entiers, - où 0 est interprété comme la valeur par défaut. - Les valeurs négatives entraînent un verrouillage réduit à une tentative de verrouillage. - - - - - - -
    - - - diff --git a/reference/zookeeper/reference.xml b/reference/zookeeper/reference.xml deleted file mode 100644 index 396c049f61..0000000000 --- a/reference/zookeeper/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; ZooKeeper - - &reference.zookeeper.entities.functions; - - - - diff --git a/reference/zookeeper/setup.xml b/reference/zookeeper/setup.xml deleted file mode 100644 index 01eef3a4c2..0000000000 --- a/reference/zookeeper/setup.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Cette extension nécessite ZooKeeper - C Binding (version 3.4.1 ou ultérieure). Pour plus d'informations, consulter - ZooKeeper Programmer's Guide. - -
    - - - - &reference.zookeeper.configure; - - - - - &reference.zookeeper.ini; - - -     - - - diff --git a/reference/zookeeper/zookeeper.xml b/reference/zookeeper/zookeeper.xml deleted file mode 100644 index 04c5def282..0000000000 --- a/reference/zookeeper/zookeeper.xml +++ /dev/null @@ -1,830 +0,0 @@ - - - - - La classe Zookeeper - Zookeeper - - - - -
    - &reftitle.intro; - - Représente une session ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - Zookeeper - - - - - Zookeeper - - - - - - - &Methods; - - - - - - - - - - &Constants; - - const - int - PERM_READ - 1 - - - const - int - PERM_WRITE - 2 - - - const - int - PERM_CREATE - 4 - - - const - int - PERM_DELETE - 8 - - - const - int - PERM_ADMIN - 16 - - - const - int - PERM_ALL - 31 - - - - const - int - EPHEMERAL - 1 - - - const - int - SEQUENCE - 2 - - - - const - int - LOG_LEVEL_ERROR - 1 - - - const - int - LOG_LEVEL_WARN - 2 - - - const - int - LOG_LEVEL_INFO - 3 - - - const - int - LOG_LEVEL_DEBUG - 4 - - - - const - int - EXPIRED_SESSION_STATE - -112 - - - const - int - AUTH_FAILED_STATE - -113 - - - const - int - CONNECTING_STATE - 1 - - - const - int - ASSOCIATING_STATE - 2 - - - const - int - CONNECTED_STATE - 3 - - - const - int - READONLY_STATE - 5 - - - const - int - NOTCONNECTED_STATE - 999 - - - - const - int - CREATED_EVENT - 1 - - - const - int - DELETED_EVENT - 2 - - - const - int - CHANGED_EVENT - 3 - - - const - int - CHILD_EVENT - 4 - - - const - int - SESSION_EVENT - -1 - - - const - int - NOTWATCHING_EVENT - -2 - - - - const - int - SYSTEMERROR - -1 - - - const - int - RUNTIMEINCONSISTENCY - -2 - - - const - int - DATAINCONSISTENCY - -3 - - - const - int - CONNECTIONLOSS - -4 - - - const - int - MARSHALLINGERROR - -5 - - - const - int - UNIMPLEMENTED - -6 - - - const - int - OPERATIONTIMEOUT - -7 - - - const - int - BADARGUMENTS - -8 - - - const - int - INVALIDSTATE - -9 - - - const - int - NEWCONFIGNOQUORUM - -13 - - - const - int - RECONFIGINPROGRESS - -14 - - - - const - int - OK - 0 - - - const - int - APIERROR - -100 - - - const - int - NONODE - -101 - - - const - int - NOAUTH - -102 - - - const - int - BADVERSION - -103 - - - const - int - NOCHILDRENFOREPHEMERALS - -108 - - - const - int - NODEEXISTS - -110 - - - const - int - NOTEMPTY - -111 - - - const - int - SESSIONEXPIRED - -112 - - - const - int - INVALIDCALLBACK - -113 - - - const - int - INVALIDACL - -114 - - - const - int - AUTHFAILED - -115 - - - const - int - CLOSING - -116 - - - const - int - NOTHING - -117 - - - const - int - SESSIONMOVED - -118 - - - const - int - NOTREADONLY - -119 - - - const - int - EPHEMERALONLOCALSESSION - -120 - - - const - int - NOWATCHER - -121 - - - const - int - RECONFIGDISABLED - -122 - - - - - - -
    - - -
    - &reftitle.constants; - - -
    - Permissions de <acronym>ZooKeeper</acronym> - - - - Zookeeper::PERM_READ - - Peut lire la valeur des nœuds et lister ses enfants - - - - Zookeeper::PERM_WRITE - - Peut modifier la valeur des nœuds - - - - Zookeeper::PERM_CREATE - - Peut créer des enfants - - - - Zookeeper::PERM_DELETE - - Peut supprimer des enfants - - - - Zookeeper::PERM_ADMIN - - Peut exécuter set_acl() - - - - Zookeeper::PERM_ALL - - Tous les flags ci-dessus ORd ensemble - - - - -
    - - - -
    - Drapeaux de création <acronym>ZooKeeper</acronym> - - - - Zookeeper::EPHEMERAL - - Si le drapeau Zookeeper::EPHEMERAL est mis, le nœud sera automatiquement supprimé si la session du client est perdue. - - - - Zookeeper::SEQUENCE - - Si le drapeau Zookeeper::SEQUENCE est mis, un numéro de séquence unique et croissant est ajouté au nom du nœud. Le numéro de séquence est toujours de 10 chiffres, complété par des zéros. - - - -
    - - - -
    - Niveaux de journalisation <acronym>ZooKeeper</acronym> - - - - Zookeeper::LOG_LEVEL_ERROR - - Sortie des messages d'erreur uniquement - - - - Zookeeper::LOG_LEVEL_WARN - - Sortie des messages d'erreur et d'avertissement - - - - Zookeeper::LOG_LEVEL_INFO - - Sortie des messages d'action importante en plus des erreurs et avertissements - - - - Zookeeper::LOG_LEVEL_DEBUG - - Sortie de tous les messages - - - - -
    - - - -
    - États <acronym>ZooKeeper</acronym> - - - - Zookeeper::EXPIRED_SESSION_STATE - - Connecté mais la session a expiré - - - - Zookeeper::AUTH_FAILED_STATE - - Connecté mais l'authentification a échoué - - - - Zookeeper::CONNECTING_STATE - - Connexion en cours - - - - Zookeeper::ASSOCIATING_STATE - - Association en cours - - - - Zookeeper::CONNECTED_STATE - - Connecté - - - - Zookeeper::READONLY_STATE - - TODO: aidez nous à améliorer cette extension. - - - - Zookeeper::NOTCONNECTED_STATE - - La connexion a échoué - - - - -
    - - - -
    - Types d'observateurs <acronym>ZooKeeper</acronym> - - - - Zookeeper::CREATED_EVENT - - Un nœud a été créé - Ceci est généré uniquement par les observateurs sur des nœuds inexistants. Ces observateurs sont définis en utilisant Zookeeper::exists. - - - - Zookeeper::DELETED_EVENT - - Un nœud a été supprimé - Ceci est généré uniquement par les observateurs sur des nœuds. Ces observateurs sont définis en utilisant Zookeeper::exists et Zookeeper::get. - - - - Zookeeper::CHANGED_EVENT - - Un nœud a été changé - Ceci est généré uniquement par les observateurs sur des nœuds. Ces observateurs sont définis en utilisant Zookeeper::exists et Zookeeper::get. - - - - Zookeeper::CHILD_EVENT - - Un changement a eu lieu dans la liste des enfants - Ceci est généré uniquement par les observateurs sur la liste des enfants d'un nœud. Ces observateurs sont définis en utilisant Zookeeper::getChildren. - - - - Zookeeper::SESSION_EVENT - - Une session a été perdue - Ceci est généré lorsqu'un client perd le contact ou se reconnecte avec un serveur. - - - - Zookeeper::NOTWATCHING_EVENT - - Un observateur a été supprimé - Ceci est généré lorsque le serveur pour une raison quelconque, probablement une contrainte de ressource, ne surveillera plus un nœud pour un client. - - - - -
    - - - -
    - Erreurs systèmes et côté serveur <acronym>ZooKeeper</acronym> - - - Zookeeper::SYSTEMERROR - - Ceci n'est jamais généré par le serveur, il ne devrait pas être utilisé autrement que pour indiquer une plage. Spécifiquement les codes d'erreurs supérieurs à cette valeur, mais inférieurs à Zookeeper::APIERROR, sont des erreurs systèmes. - - - - Zookeeper::RUNTIMEINCONSISTENCY - - Une incohérence d'exécution a été trouvée. - - - - Zookeeper::DATAINCONSISTENCY - - Une incohérence de données a été trouvée. - - - - Zookeeper::CONNECTIONLOSS - - La connexion au serveur a été perdue - - - - Zookeeper::MARSHALLINGERROR - - Erreur lors de la sérialisation ou désérialisation des données. - - - - Zookeeper::UNIMPLEMENTED - - L'opération n'est pas implémentée. - - - - Zookeeper::OPERATIONTIMEOUT - - L'opération a expiré. - - - - Zookeeper::BADARGUMENTS - - Arguments invalides. - - - - Zookeeper::INVALIDSTATE - - État zhandle invalide. - - - - Zookeeper::NEWCONFIGNOQUORUM - - Aucun quorum de la nouvelle configuration n'est connecté et à jour avec le leader de la dernière configuration validée - essayez d'invoquer la reconfiguration après que les nouveaux serveurs soient connectés et synchronisés. - Disponible à partir de ZooKeeper 3.5.0 - - - - Zookeeper::RECONFIGINPROGRESS - - Reconfiguration demandée alors qu'une autre reconfiguration est en cours. Ceci n'est actuellement pas supporté. Il convient de réessayer. - Disponible à partir de ZooKeeper 3.5.0 - - - -
    - - - -
    - Erreurs d'API <acronym>ZooKeeper</acronym> - - - Zookeeper::OK - - Tout est OK. - - - - Zookeeper::APIERROR - - Ceci n'est jamais généré par le serveur, il ne devrait pas être utilisé autrement que pour indiquer une plage. Spécifiquement les codes d'erreurs supérieurs à cette valeur sont des erreurs d'api (tandis que les valeurs inférieures indiquent une Zookeeper::SYSTEMERROR). - - - - Zookeeper::NONODE - - Le nœud n'existe pas. - - - - Zookeeper::NOAUTH - - Non authentifié. - - - - Zookeeper::BADVERSION - - Conflit de version. - - - - Zookeeper::NOCHILDRENFOREPHEMERALS - - Les nœuds éphémères ne peuvent pas avoir d'enfants. - - - - Zookeeper::NODEEXISTS - - Le nœud existe déjà. - - - - Zookeeper::NOTEMPTY - - Le nœud a des enfants. - - - - Zookeeper::SESSIONEXPIRED - - La session a expiré par le serveur. - - - - Zookeeper::INVALIDCALLBACK - - Fonction de rappel spécifiée invalide. - - - - Zookeeper::INVALIDACL - - ACL spécifiée invalide. - - - - Zookeeper::AUTHFAILED - - L'authentification du client a échoué. - - - - Zookeeper::CLOSING - - ZooKeeper est en train de fermer. - - - - Zookeeper::NOTHING - - (pas une erreur) Aucune réponse du serveur à traiter. - - - - Zookeeper::SESSIONMOVED - - La session a été déplacée vers un autre serveur, donc l'opération est ignorée. - - - - Zookeeper::NOTREADONLY - - Requête de changement d'état passée à un serveur en lecture seule. - - - - Zookeeper::EPHEMERALONLOCALSESSION - - Tentative de création de nœud éphémère sur une session locale. - - - - Zookeeper::NOWATCHER - - L'observateur n'a pas été trouvé. - - - - Zookeeper::RECONFIGDISABLED - - Tentative de réaliser une opération de reconfiguration alors que la fonctionnalité de reconfiguration est désactivée. - - - -
    - - -
    - - - -     - - &reference.zookeeper.entities.zookeeper; - -     - - diff --git a/reference/zookeeper/zookeeper/addauth.xml b/reference/zookeeper/zookeeper/addauth.xml deleted file mode 100644 index 67805b50ec..0000000000 --- a/reference/zookeeper/zookeeper/addauth.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - Zookeeper::addAuth - Spécifie les informations d'authentification de l'application - - - - &reftitle.description; - - public - boolZookeeper::addAuth - stringscheme - stringcert - callablecompletion_cb&null; - - - L'application appelle cette fonction pour spécifier ses informations d'authentification. Le serveur utilisera le fournisseur de sécurité spécifié par le paramètre scheme pour authentifier la connexion du client. Si la demande d'authentification a échoué : - - la connexion du serveur est abandonnée. - - l'observateur est appelé avec la valeur ZOO_AUTH_FAILED_STATE comme paramètre d'état. - - - - - &reftitle.parameters; - - - scheme - - - L'id du schéma d'authentification. Pris en charge nativement : "digest" authentification basée sur le mot de passe - - - - - cert - - - Les informations d'authentification de l'application. La valeur réelle dépend du schéma. - - - - - completion_cb - - - La routine à invoquer lorsque la demande est terminée. L'un des codes de résultat suivants peut être passé à la fonction de rappel de fin : - - ZOK l'opération s'est terminée avec succès - - ZAUTHFAILED l'authentification a échoué - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Cette méthode émet une erreur PHP/avertissement lorsque le nombre de paramètres ou les types sont incorrects ou lorsque l'opération échoue. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.examples; - - Exemple de <methodname>Zookeeper::addAuth</methodname> - - Ajoute l'authentification avant de demander la valeur du nœud. - - -set($path, $value); - -$zookeeper->addAuth('digest', 'user0:passwd0'); -$r = $zookeeper->get($path); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::setAcl - Zookeeper::getAcl - État de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/close.xml b/reference/zookeeper/zookeeper/close.xml deleted file mode 100644 index 09f76b1a00..0000000000 --- a/reference/zookeeper/zookeeper/close.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Zookeeper::close - Ferme la connexion au serveur ZooKeeper et libère les ressources associées - - - - &reftitle.description; - - public - voidZookeeper::close - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Cette méthode émet ZookeeperException et ses dérivés lors de la fermeture d'une instance non initialisée. - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/connect.xml b/reference/zookeeper/zookeeper/connect.xml deleted file mode 100644 index 01d5fd28ef..0000000000 --- a/reference/zookeeper/zookeeper/connect.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Zookeeper::connect - Crée un gestionnaire utilisé pour communiquer avec zookeeper - - - - &reftitle.description; - - public - voidZookeeper::connect - stringhost - callablewatcher_cb&null; - intrecv_timeout10000 - - - - Cette méthode crée une nouvelle connexion et une session zookeeper qui correspond à cette connexion. L'établissement de session est asynchrone, ce qui signifie que la session ne doit pas être considérée comme établie jusqu'à ce qu'un événement d'état ZOO_CONNECTED_STATE soit reçu. - - - - - &reftitle.parameters; - - - host - - - Séparés par des virgules, chaque paire hôte:port correspondant à un serveur zk. Par exemple, "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002" - - - - - watcher_cb - - - La fonction de rappel globale d'observation. Lorsque des notifications sont déclenchées, cette fonction sera invoquée. - - - - - recv_timeout - - - Le délai d'attente pour cette session, uniquement valide si la connexion est actuellement connectée (c'est-à-dire que le dernier état de l'observateur est ZOO_CONNECTED_STATE). - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou que l'instance n'a pas pu être initialisée. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/construct.xml b/reference/zookeeper/zookeeper/construct.xml deleted file mode 100644 index a5cca0306b..0000000000 --- a/reference/zookeeper/zookeeper/construct.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Zookeeper::__construct - Créer une connexion pour communiquer avec Zookeeper - - - - &reftitle.description; - - public - Zookeeper::__construct - stringhost'' - callablewatcher_cb&null; - intrecv_timeout10000 - - - Cette méthode crée une nouvelle connexion et une session zookeeper qui correspond à ce gestionnaire. L'établissement de session est asynchrone, ce qui signifie que la session ne doit pas être considérée comme établie jusqu'à ce qu'un événement d'état ZOO_CONNECTED_STATE soit reçu. - - - - - &reftitle.parameters; - - - host - - - Séparés par des virgules, chaque paire hôte:port correspondant à un serveur zk. Par exemple, "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002" - - - - - watcher_cb - - - La fonction de rappel globale d'observation. Lorsque des notifications sont déclenchées, cette fonction sera invoquée. - - - - - recv_timeout - - - Le délai d'attente pour cette session, uniquement valide si la connexion est actuellement connectée (c'est-à-dire que le dernier état de l'observateur est ZOO_CONNECTED_STATE). - - - - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou que l'instance n'a pas pu être initialisée. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.seealso; - - Zookeeper::connect - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/create.xml b/reference/zookeeper/zookeeper/create.xml deleted file mode 100644 index 195e0d28c0..0000000000 --- a/reference/zookeeper/zookeeper/create.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - Zookeeper::create - Créer un nœud de manière synchrone - - - - &reftitle.description; - - public - stringZookeeper::create - stringpath - stringvalue - arrayacls - intflags&null; - - - Cette méthode crée un nœud dans ZooKeeper. Un nœud ne peut être créé que s'il n'existe pas déjà. Les drapeaux de création affectent la création des nœuds. Si le drapeau ZOO_EPHEMERAL est défini, le nœud sera automatiquement supprimé si la session client disparaît. Si le drapeau ZOO_SEQUENCE est défini, un numéro de séquence unique et croissant est ajouté au nom du chemin. - - - - - &reftitle.parameters; - - - path - - - Le nom du nœud. Exprimé sous la forme d'un nom de fichier avec des barres obliques séparant les ancêtres du nœud. - - - - - value - - - Les données à stocker dans le nœud. - - - - - acls - - - Les ACL initiales du nœud. L'ACL ne doit pas être nulle ou vide. - - - - - flags - - - Ce paramètre peut être défini sur 0 pour une création normale ou un OU des drapeaux de création. - - - - - - - - &reftitle.returnvalues; - - Renvoie le chemin du nouveau nœud (cela peut être différent du chemin fourni en raison du drapeau ZOO_SEQUENCE) en cas de succès, et false en cas d'échec. - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou que la création du nœud a échoué. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.examples; - - Exemple de <methodname>Zookeeper::create</methodname> - - Créer un nouveau nœud. - - - Zookeeper::PERM_ALL, - 'scheme' => 'world', - 'id' => 'anyone', - ) -); -$path = '/path/to/newnode'; -$realPath = $zookeeper->create($path, null, $aclArray); -if ($realPath) - echo $realPath; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::delete - Zookeeper::getChildren - Permissions de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/delete.xml b/reference/zookeeper/zookeeper/delete.xml deleted file mode 100644 index 30943782f0..0000000000 --- a/reference/zookeeper/zookeeper/delete.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Zookeeper::delete - Enlève un nœud de manière synchrone - - - - &reftitle.description; - - public - boolZookeeper::delete - stringpath - intversion-1 - - - - - &reftitle.parameters; - - - path - - - Le nom du nœud. Exprimé sous la forme d'un nom de fichier avec des barres obliques séparant les ancêtres du nœud. - - - - - version - - - La version attendue du nœud. La fonction échouera si la version actuelle du nœud ne correspond pas à la version attendue. Si -1 est utilisé, la vérification de version n'aura pas lieu. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou que la suppression du nœud a échoué. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.examples; - - Exemple de <methodname>Zookeeper::delete</methodname> - - Supprime un nœud existant. - - -delete($path); -if ($r) - echo 'SUCCESS'; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::getChildren - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/exists.xml b/reference/zookeeper/zookeeper/exists.xml deleted file mode 100644 index b4235b2752..0000000000 --- a/reference/zookeeper/zookeeper/exists.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Zookeeper::exists - Vérifie l'existence d'un nœud de manière synchrone - - - - &reftitle.description; - - public - arrayZookeeper::exists - stringpath - callablewatcher_cb&null; - - - - - &reftitle.parameters; - - - path - - - Le nom du nœud. Exprimé sous la forme d'un nom de fichier avec des barres obliques séparant les ancêtres du nœud. - - - - - watcher_cb - - - Si différent de zéro, un observateur sera défini sur le serveur pour notifier le client si le nœud change. L'observateur sera défini même si le nœud n'existe pas. - - - - - - - - &reftitle.returnvalues; - - Renvoie la valeur de stat pour le chemin si le nœud donné existe, sinon false. - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou que la vérification de l'existence du nœud a échoué. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.examples; - - Exemple de <methodname>Zookeeper::exists</methodname> - - Vérifie l'existence d'un nœud. - - -exists($path); -if ($r) - echo 'EXISTS'; -else - echo 'N/A or ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::get - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/get.xml b/reference/zookeeper/zookeeper/get.xml deleted file mode 100644 index 19d08cfb1e..0000000000 --- a/reference/zookeeper/zookeeper/get.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - Zookeeper::get - Renvoie les données associées à un nœud de manière synchrone - - - - &reftitle.description; - - public - stringZookeeper::get - stringpath - callablewatcher_cb&null; - arraystat&null; - intmax_size0 - - - - - &reftitle.parameters; - - - path - - - Le nom du nœud. Exprimé sous la forme d'un nom de fichier avec des barres obliques séparant les ancêtres du nœud. - - - - - watcher_cb - - - Si différent de zéro, un observateur sera défini sur le serveur pour notifier le client si le nœud change. - - - - - stat - - - Si différent de NULL, contiendra la valeur de stat pour le chemin lors du retour. - - - - - max_size - - - La taille maximale des données. Si 0 est utilisé, cette méthode renverra l'ensemble des données. - - - - - - - - &reftitle.returnvalues; - - Renvoie les données en cas de succès, et false en cas d'échec. - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou que la récupération des données a échoué. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.examples; - - Exemple de <methodname>Zookeeper::get</methodname> - - Récupère la valeur du nœud. - - -set($path, $value); - -$r = $zookeeper->get($path); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - Exemple de stats de <methodname>Zookeeper::get</methodname> - - Renvoie les informations de stats du nœud. - - -get($path, null, $stat); -var_dump($stat); -?> -]]> - - &example.outputs; - - - float(0) - ["mzxid"]=> - float(0) - ["ctime"]=> - float(0) - ["mtime"]=> - float(0) - ["version"]=> - int(0) - ["cversion"]=> - int(-2) - ["aversion"]=> - int(0) - ["ephemeralOwner"]=> - float(0) - ["dataLength"]=> - int(0) - ["numChildren"]=> - int(2) - ["pzxid"]=> - float(0) -} -]]> - - - - - - &reftitle.seealso; - - Zookeeper::set - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getacl.xml b/reference/zookeeper/zookeeper/getacl.xml deleted file mode 100644 index 75e99113cf..0000000000 --- a/reference/zookeeper/zookeeper/getacl.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - Zookeeper::getAcl - Renvoie les ACL associées à un nœud de manière synchrone - - - - &reftitle.description; - - public - arrayZookeeper::getAcl - stringpath - - - - - &reftitle.parameters; - - - path - - - Le nom du nœud. Exprimé sous la forme d'un nom de fichier avec des barres obliques séparant les ancêtres du nœud. - - - - - - - - &reftitle.returnvalues; - - Renvoie un tableau d'ACL en cas de succès et false en cas d'échec. - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou que la récupération des ACL du nœud a échoué. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.examples; - - Exemple de <methodname>Zookeeper::getAcl</methodname> - - Renvoie les ACL d'un nœud. - - - Zookeeper::PERM_ALL, - 'scheme' => 'world', - 'id' => 'anyone', - ) -); -$path = '/path/to/newnode'; -$zookeeper->setAcl($path, $aclArray); - -$r = $zookeeper->getAcl($path); -if ($r) - var_dump($r); -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - array(3) { - ["perms"]=> - int(31) - ["scheme"]=> - string(5) "world" - ["id"]=> - string(6) "anyone" - } -} -]]> - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::setAcl - Permissions de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getchildren.xml b/reference/zookeeper/zookeeper/getchildren.xml deleted file mode 100644 index b5f64cd2b6..0000000000 --- a/reference/zookeeper/zookeeper/getchildren.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - Zookeeper::getChildren - Liste les enfants d'un nœud de manière synchrone - - - - &reftitle.description; - - public - arrayZookeeper::getChildren - stringpath - callablewatcher_cb&null; - - - - - &reftitle.parameters; - - - path - - - Le nom du nœud. Exprimé sous la forme d'un nom de fichier avec des barres obliques séparant les ancêtres du nœud. - - - - - watcher_cb - - - Si différent de zéro, un observateur sera défini sur le serveur pour notifier le client si le nœud change. - - - - - - - - &reftitle.returnvalues; - - Renvoie un tableau avec les chemins des enfants en cas de succès, et false en cas d'échec. - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou que la liste des enfants d'un nœud a échoué. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.examples; - - Exemple de <methodname>Zookeeper::getChildren</methodname> - - Liste les enfants d'un nœud. - - -getchildren($path); - -if ($r) { - var_dump($r); -} else { - echo 'ERR'; -} - -?> -]]> - - &example.outputs; - - - string(6) "config" -} -]]> - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::delete - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getclientid.xml b/reference/zookeeper/zookeeper/getclientid.xml deleted file mode 100644 index bd24da5a10..0000000000 --- a/reference/zookeeper/zookeeper/getclientid.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Zookeeper::getClientId - Renvoie l'identifiant de session client, uniquement valide si la connexion est actuellement établie (c'est-à-dire si le dernier état de l'observateur est ZOO_CONNECTED_STATE) - - - - &reftitle.description; - - public - intZookeeper::getClientId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'identifiant de session client en cas de succès, et false en cas d'échec. - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le client n'a pas pu obtenir l'identifiant de session. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - Zookeeper::getState - États de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getconfig.xml b/reference/zookeeper/zookeeper/getconfig.xml deleted file mode 100644 index 334640af8d..0000000000 --- a/reference/zookeeper/zookeeper/getconfig.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - Zookeeper::getConfig - Renvoie l'instance de ZookeeperConfig - - - - &reftitle.description; - - public - ZookeeperConfigZookeeper::getConfig - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'instance de ZookeeperConfig. - - - - - &reftitle.seealso; - - ZookeeperConfig - - - - - - diff --git a/reference/zookeeper/zookeeper/getrecvtimeout.xml b/reference/zookeeper/zookeeper/getrecvtimeout.xml deleted file mode 100644 index f35b5cb758..0000000000 --- a/reference/zookeeper/zookeeper/getrecvtimeout.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Zookeeper::getRecvTimeout - Renvoie le délai d'attente pour cette session, uniquement valide si la connexion est actuellement établie (c'est-à-dire si le dernier état de l'observateur est ZOO_CONNECTED_STATE). Cette valeur peut changer après une reconnexion au serveur - - - - &reftitle.description; - - public - intZookeeper::getRecvTimeout - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie le délai d'attente pour cette session en cas de succès, et false en cas d'échec. - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque l'opération échoue. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getstate.xml b/reference/zookeeper/zookeeper/getstate.xml deleted file mode 100644 index 1d59c31fb7..0000000000 --- a/reference/zookeeper/zookeeper/getstate.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Zookeeper::getState - Renvoie l'état de la connexion zookeeper - - - - &reftitle.description; - - public - intZookeeper::getState - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie l'état de la connexion zookeeper en cas de succès, et false en cas d'échec. - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque l'état de la connexion zookeeper n'a pas pu être obtenu. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - Zookeeper::getClientId - État de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/isrecoverable.xml b/reference/zookeeper/zookeeper/isrecoverable.xml deleted file mode 100644 index 1b254f52ad..0000000000 --- a/reference/zookeeper/zookeeper/isrecoverable.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Zookeeper::isRecoverable - Vérifie si l'état de connexion zookeeper actuel peut être récupéré - - - - &reftitle.description; - - public - boolZookeeper::isRecoverable - - - - L'application doit fermer le gestionnaire et essayer de se reconnecter. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Renvoie true/false en cas de succès, et false en cas d'échec. - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque l'opération échoue. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - Zookeeper::getClientId - État de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/set.xml b/reference/zookeeper/zookeeper/set.xml deleted file mode 100644 index 973adef286..0000000000 --- a/reference/zookeeper/zookeeper/set.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - Zookeeper::set - Définit les données associées à un nœud - - - - &reftitle.description; - - public - boolZookeeper::set - stringpath - stringvalue - intversion-1 - arraystat&null; - - - - - &reftitle.parameters; - - - path - - - Le nom du nœud. Exprimé sous la forme d'un nom de fichier avec des barres obliques séparant les ancêtres du nœud. - - - - - value - - - Les données à stocker dans le nœud. - - - - - version - - - La version attendue du nœud. La fonction échouera si la version actuelle du nœud ne correspond pas à la version attendue. Si -1 est utilisé, la vérification de version ne sera pas effectuée. - - - - - stat - - - Si différent de NULL, contiendra la valeur de stat pour le chemin lors du retour. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou que la sauvegarde de la valeur dans le nœud a échoué. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.examples; - - Exemple de <methodname>Zookeeper::set</methodname> - - Sauvegarde une valeur dans un nœud. - - -set($path, $value); -if ($r) - echo 'SUCCESS'; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::get - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setacl.xml b/reference/zookeeper/zookeeper/setacl.xml deleted file mode 100644 index 9aa97e29bc..0000000000 --- a/reference/zookeeper/zookeeper/setacl.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - Zookeeper::setAcl - Définit l'ACL associé à un nœud de manière synchrone - - - - &reftitle.description; - - public - boolZookeeper::setAcl - stringpath - intversion - arrayacl - - - - - &reftitle.parameters; - - - path - - - Le nom du nœud. Exprimé sous la forme d'un nom de fichier avec des barres obliques séparant les ancêtres du nœud. - - - - - version - - - Le numéro de version attendu du chemin. - - - - - acl - - - L'ACL à définir sur le chemin. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou que l'ACL n'a pas pu être définie pour un nœud. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.examples; - - Exemple de <methodname>Zookeeper::setAcl</methodname> - - Définit l'ACL pour un nœud. - - - Zookeeper::PERM_ALL, - 'scheme' => 'world', - 'id' => 'anyone', - ) -); -$path = '/path/to/newnode'; -$zookeeper->setAcl($path, $aclArray); - -$r = $zookeeper->getAcl($path); -if ($r) - var_dump($r); -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - array(3) { - ["perms"]=> - int(31) - ["scheme"]=> - string(5) "world" - ["id"]=> - string(6) "anyone" - } -} -]]> - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::getAcl - Permissions de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setdebuglevel.xml b/reference/zookeeper/zookeeper/setdebuglevel.xml deleted file mode 100644 index f5d659e21d..0000000000 --- a/reference/zookeeper/zookeeper/setdebuglevel.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Zookeeper::setDebugLevel - Définit le niveau de débogage pour la bibliothèque - - - - &reftitle.description; - - public - static - boolZookeeper::setDebugLevel - intlogLevel - - - - - &reftitle.parameters; - - - logLevel - - - Constantes de niveau de débogage ZooKeeper. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou échouent à définir le niveau de débogage. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.examples; - - Exemple de <methodname>Zookeeper::setDebugLevel</methodname> - - Définit le niveau de débogage. - - - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Niveaux de journalisation ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setdeterministicconnorder.xml b/reference/zookeeper/zookeeper/setdeterministicconnorder.xml deleted file mode 100644 index 1d4a84e61b..0000000000 --- a/reference/zookeeper/zookeeper/setdeterministicconnorder.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Zookeeper::setDeterministicConnOrder - Active/désactive la randomisation de l'ordre des points de terminaison du quorum - - - - &reftitle.description; - - public - static - boolZookeeper::setDeterministicConnOrder - boolyesOrNo - - - Si passé à une valeur vraie, fera en sorte que le client se connecte aux pairs du quorum dans l'ordre tel que spécifié dans l'appel à zookeeper_init(). Une valeur fausse fait en sorte que zookeeper_init() permute les points de terminaison des pairs du quorum, ce qui est bon pour une distribution plus uniforme des connexions client parmi les pairs du quorum. - Le client C ZooKeeper utilise false par défaut. - - - - - &reftitle.parameters; - - - yesOrNo - - - Active/désactive la randomisation de l'ordre des points de terminaison du quorum. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou l'opération échoue. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setlogstream.xml b/reference/zookeeper/zookeeper/setlogstream.xml deleted file mode 100644 index 497b9a2fef..0000000000 --- a/reference/zookeeper/zookeeper/setlogstream.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Zookeeper::setLogStream - Définit le flux à utiliser par la bibliothèque pour le journal - - - - &reftitle.description; - - public - boolZookeeper::setLogStream - resourcestream - - - La bibliothèque zookeeper utilise stderr comme flux de journalisation par défaut. L'application doit s'assurer que le flux est inscriptible. Passer NULL réinitialise le flux à sa valeur par défaut (stderr). - - - - - &reftitle.parameters; - - - stream - - - Le flux à utiliser par la bibliothèque pour le journal. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou l'opération échoue. - - - - Depuis la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.seealso; - - Zookeeper::setDebugLevel - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setwatcher.xml b/reference/zookeeper/zookeeper/setwatcher.xml deleted file mode 100644 index 9df973bbac..0000000000 --- a/reference/zookeeper/zookeeper/setwatcher.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Zookeeper::setWatcher - Définit une fonction d'observation - - - - &reftitle.description; - - public - boolZookeeper::setWatcher - callablewatcher_cb - - - - - &reftitle.parameters; - - - watcher_cb - - - Un observateur qui sera appelé chaque fois que le nœud change. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Cette méthode émet une erreur/warning PHP lorsque le nombre de paramètres ou les types sont incorrects ou impossible de changer l'observateur. - - - - À partir de la version 0.3.0, cette méthode émet ZookeeperException et ses dérivés. - - - - - - &reftitle.seealso; - - Zookeeper::exists - Zookeeper::get - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperauthenticationexception.xml b/reference/zookeeper/zookeeperauthenticationexception.xml deleted file mode 100644 index 3fd6aea4cd..0000000000 --- a/reference/zookeeper/zookeeperauthenticationexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - La classe ZookeeperAuthenticationException - ZookeeperAuthenticationException - - - - -
    - &reftitle.intro; - - La classe d'exception d'authentification ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperAuthenticationException - - - - - ZookeeperAuthenticationException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - -
    - -     - -     - - diff --git a/reference/zookeeper/zookeeperconfig.xml b/reference/zookeeper/zookeeperconfig.xml deleted file mode 100644 index e51b60400b..0000000000 --- a/reference/zookeeper/zookeeperconfig.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - La classe ZookeeperConfig - ZookeeperConfig - - - - -
    - &reftitle.intro; - - La classe de gestion de configuration ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperConfig - - - - - ZookeeperConfig - - - - - - &Methods; - - - - - - - - -
    - -     - - &reference.zookeeper.entities.zookeeperconfig; - -     - - diff --git a/reference/zookeeper/zookeeperconfig/add.xml b/reference/zookeeper/zookeeperconfig/add.xml deleted file mode 100644 index 7c1f8d6769..0000000000 --- a/reference/zookeeper/zookeeperconfig/add.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - ZookeeperConfig::add - Ajoute des serveurs à l'ensemble - - - - &reftitle.description; - - public - voidZookeeperConfig::add - stringmembers - intversion-1 - arraystat&null; - - - - - &reftitle.parameters; - - - members - - - La liste séparée par des virgules des serveurs à rajouter à l'ensemble. Chacun a une ligne de configuration pour un serveur à rajouter (comme cela apparaîtrait - dans un fichier de configuration), seulement pour les quorums majoritaires. - - - - - version - - - La version attendue du nœud. La fonction échouera si la version actuelle du nœud ne correspond pas à la version attendue. Si -1 est utilisé, la vérification de version ne sera pas effectuée. - - - - - stat - - - Si non NULL, contiendra la valeur de stat pour le chemin sur le retour. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Cette méthode émet ZookeeperException et ses dérivés lorsque le nombre ou le type des paramètres est incorrect ou que la valeur ne peut pas être sauvegardée dans le nœud. - - - - - &reftitle.examples; - - Exemple de <methodname>ZookeeperConfig::add</methodname> - - Ajoute des membres. - - -connect('localhost:2181'); -$client->addAuth('digest', 'timandes:timandes'); -$zkConfig = $client->getConfig(); -$zkConfig->set("server.1=localhost:2888:3888:participant;0.0.0.0:2181"); -$zkConfig->add("server.2=localhost:2889:3889:participant;0.0.0.0:2182"); -$r = $zkConfig->get(); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - ZookeeperConfig::get - ZookeeperConfig::set - ZookeeperConfig::remove - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperconfig/get.xml b/reference/zookeeper/zookeeperconfig/get.xml deleted file mode 100644 index c3868ade65..0000000000 --- a/reference/zookeeper/zookeeperconfig/get.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - ZookeeperConfig::get - Renvoie la dernière configuration validée du cluster ZooKeeper telle qu'elle est connue du serveur auquel le client est connecté, de manière synchrone - - - - &reftitle.description; - - public - stringZookeeperConfig::get - callablewatcher_cb&null; - arraystat&null; - - - - - &reftitle.parameters; - - - watcher_cb - - - Si différent de zéro, un observateur sera placé sur le serveur pour notifier le client si le nœud change. - - - - - stat - - - Si non NULL, contiendra la valeur de stat pour le chemin sur le retour. - - - - - - - - &reftitle.returnvalues; - - Renvoie la chaîne de configuration en cas de succès, et false en cas d'échec. - - - - - &reftitle.errors; - - Cette méthode émet ZookeeperException et ses dérivés lorsque le nombre ou le type des paramètres est incorrect ou si la récupération de la configuration échoue. - - - - - &reftitle.examples; - - Exemple de <methodname>ZookeeperConfig::get</methodname> - - Obtenir la configuration. - - -connect('localhost:2181'); -$zk->addAuth('digest', 'timandes:timandes'); -$zkConfig = $zk->getConfig(); -$r = $zkConfig->get(); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - ZookeeperConfig::set - ZookeeperConfig::add - ZookeeperConfig::remove - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperconfig/remove.xml b/reference/zookeeper/zookeeperconfig/remove.xml deleted file mode 100644 index 31a69f0a58..0000000000 --- a/reference/zookeeper/zookeeperconfig/remove.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - ZookeeperConfig::remove - Enlève des serveurs de l'ensemble - - - - &reftitle.description; - - public - voidZookeeperConfig::remove - stringid_list - intversion-1 - arraystat&null; - - - - - &reftitle.parameters; - - - id_list - - - La liste séparée par des virgules des identifiants des serveurs à enlever de l'ensemble. Chacun a un identifiant d'un serveur à enlever, seulement pour les quorums majoritaires. - - - - - version - - - La version attendue du nœud. La fonction échouera si la version actuelle du nœud ne correspond pas à la version attendue. Si -1 est utilisé, la vérification de version ne sera pas effectuée. - - - - - stat - - - Si non NULL, contiendra la valeur de stat pour le chemin sur le retour. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Cette méthode émet ZookeeperException et ses dérivés lorsque le nombre ou le type des paramètres est incorrect ou si la suppression de la valeur du nœud échoue. - - - - - &reftitle.examples; - - Exemple de <methodname>ZookeeperConfig::remove</methodname> - - Enlève des membres. - - -connect('localhost:2181'); -$client->addAuth('digest', 'timandes:timandes'); -$zkConfig = $client->getConfig(); -$zkConfig->set("server.1=localhost:2888:3888:participant;0.0.0.0:2181,server.2=localhost:2889:3889:participant;0.0.0.0:2182"); -$zkConfig->remove("2"); -echo $zkConfig->get(); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - ZookeeperConfig::get - ZookeeperConfig::add - ZookeeperConfig::set - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperconfig/set.xml b/reference/zookeeper/zookeeperconfig/set.xml deleted file mode 100644 index d6128aa403..0000000000 --- a/reference/zookeeper/zookeeperconfig/set.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - ZookeeperConfig::set - Change le membership de l'ensemble du cluster ZK et les rôles des pairs de l'ensemble - - - - &reftitle.description; - - public - voidZookeeperConfig::set - stringmembers - intversion-1 - arraystat&null; - - - - - &reftitle.parameters; - - - members - - - La liste séparée par des virgules des nouveaux membres (par exemple, le contenu d'un fichier de configuration de membres) - à utiliser uniquement avec une reconfiguration non incrémentielle. - - - - - version - - - La version attendue du nœud. La fonction échouera si la version actuelle du nœud ne correspond pas à la version attendue. Si -1 est utilisé, la vérification de version ne sera pas effectuée. - - - - - stat - - - Si non NULL, contiendra la valeur de stat pour le chemin sur le retour. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Cette méthode émet ZookeeperException et ses dérivés lorsque le nombre ou le type des paramètres est incorrect ou si la sauvegarde de la valeur dans le nœud échoue. - - - - - &reftitle.examples; - - Exemple de <methodname>ZookeeperConfig::set</methodname> - - Reconfiguration. - - -connect('localhost:2181'); -$client->addAuth('digest', 'timandes:timandes'); -$zkConfig = $client->getConfig(); -$zkConfig->set("server.1=localhost:2888:3888:participant;0.0.0.0:2181"); -?> -]]> - - - - - - &reftitle.seealso; - - ZookeeperConfig::get - ZookeeperConfig::add - ZookeeperConfig::remove - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperconnectionexception.xml b/reference/zookeeper/zookeeperconnectionexception.xml deleted file mode 100644 index 6072685823..0000000000 --- a/reference/zookeeper/zookeeperconnectionexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La classe ZookeeperConnectionException - ZookeeperConnectionException - - - - -
    - &reftitle.intro; - - La classe d'exception de gestion de connexion ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperConnectionException - - - - - ZookeeperConnectionException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/zookeeper/zookeeperexception.xml b/reference/zookeeper/zookeeperexception.xml deleted file mode 100644 index bfb75113af..0000000000 --- a/reference/zookeeper/zookeeperexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La classe ZookeeperException - ZookeeperException - - - - -
    - &reftitle.intro; - - La classe de gestion d'exception ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperException - - - - - ZookeeperException - - - extends - Exception - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/zookeeper/zookeepermarshallingexception.xml b/reference/zookeeper/zookeepermarshallingexception.xml deleted file mode 100644 index b5e02946cf..0000000000 --- a/reference/zookeeper/zookeepermarshallingexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La classe ZookeeperMarshallingException - ZookeeperMarshallingException - - - - -
    - &reftitle.intro; - - La classe d'exception ZooKeeper (pendant la sérialisation ou la désérialisation des données). - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperMarshallingException - - - - - ZookeeperMarshallingException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/zookeeper/zookeepernonodeexception.xml b/reference/zookeeper/zookeepernonodeexception.xml deleted file mode 100644 index f2d65e7aa8..0000000000 --- a/reference/zookeeper/zookeepernonodeexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La classe ZookeeperNoNodeException - ZookeeperNoNodeException - - - - -
    - &reftitle.intro; - - La classe d'exception ZooKeeper (lorsque le nœud n'existe pas). - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperNoNodeException - - - - - ZookeeperNoNodeException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/zookeeper/zookeeperoperationtimeoutexception.xml b/reference/zookeeper/zookeeperoperationtimeoutexception.xml deleted file mode 100644 index a5fae495c4..0000000000 --- a/reference/zookeeper/zookeeperoperationtimeoutexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La classe ZookeeperOperationTimeoutException - ZookeeperOperationTimeoutException - - - - -
    - &reftitle.intro; - - La classe de gestion d'exception de délai d'opération ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperOperationTimeoutException - - - - - ZookeeperOperationTimeoutException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -     - -     - - diff --git a/reference/zookeeper/zookeepersessionexception.xml b/reference/zookeeper/zookeepersessionexception.xml deleted file mode 100644 index 3004c0bfe4..0000000000 --- a/reference/zookeeper/zookeepersessionexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La classe ZookeeperSessionException - ZookeeperSessionException - - - - -
    - &reftitle.intro; - - La classe de gestion d'exception de session ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperSessionException - - - - - ZookeeperSessionException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -     - -     - -